mirror of
https://github.com/ksyasuda/aniwrapper.git
synced 2024-10-28 04:44:11 -07:00
add manpage
This commit is contained in:
ksyasuda
parent
d8b5f2b94a
commit
14dee88f11
10
Makefile
10
Makefile
@ -3,10 +3,12 @@ PREFIX := /usr
|
|||||||
all: install
|
all: install
|
||||||
|
|
||||||
install: uninstall
|
install: uninstall
|
||||||
cp ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli
|
install -m0755 ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli
|
||||||
cp aniwrapper $(DESTDIR)$(PREFIX)/bin/aniwrapper
|
install -m0755 aniwrapper $(DESTDIR)$(PREFIX)/bin/aniwrapper
|
||||||
chmod 0755 $(DESTDIR)$(PREFIX)/bin/ani-cli
|
mkdir -p /usr/local/man/man1
|
||||||
chmod 0755 $(DESTDIR)$(PREFIX)/bin/aniwrapper
|
install -m0644 docs/man/aniwrapper.1 /usr/local/man/man1/
|
||||||
|
gzip -qf /usr/local/man/man1/aniwrapper.1
|
||||||
|
mandb -q
|
||||||
|
|
||||||
dev: uninstall
|
dev: uninstall
|
||||||
ln -sr ./ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli
|
ln -sr ./ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli
|
||||||
|
|||||||
100
docs/man/aniwrapper.1
Normal file
100
docs/man/aniwrapper.1
Normal file
@ -0,0 +1,100 @@
|
|||||||
|
.\" Automatically generated by Pandoc 2.14.2
|
||||||
|
.\"
|
||||||
|
.TH "ANIWRAPPER" "1" "February 4, 2022" "aniwrapper 1.0.0" "Man Page"
|
||||||
|
.hy
|
||||||
|
.SH NAME
|
||||||
|
.PP
|
||||||
|
aniwrapper - A rofi wrapper around ani-cli: a command-line tool to
|
||||||
|
browser, download, and stream anime
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.PP
|
||||||
|
\f[B]aniwrapper\f[R] [-cdhvqS] [-t \f[I]theme\f[R] | -T
|
||||||
|
\f[I]config_path\f[R]]
|
||||||
|
.PD 0
|
||||||
|
.P
|
||||||
|
.PD
|
||||||
|
\f[B]aniwrapper\f[R] [-cvS] [-t \f[I]theme\f[R] | -T
|
||||||
|
\f[I]config_path\f[R]] -f \f[I]path_to_directory\f[R]
|
||||||
|
.PD 0
|
||||||
|
.P
|
||||||
|
.PD
|
||||||
|
\f[B]aniwrapper\f[R] -Q \f[I]query\f[R]
|
||||||
|
.PD 0
|
||||||
|
.P
|
||||||
|
.PD
|
||||||
|
\f[B]aniwrapper\f[R] -C
|
||||||
|
.PD 0
|
||||||
|
.P
|
||||||
|
.PD
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.PP
|
||||||
|
\f[B]aniwrapper\f[R] is a wrapper around a modified version of
|
||||||
|
\f[B]ani-cli\f[R], which uses \f[B]rofi\f[R] to get user input and
|
||||||
|
control the program flow, as well as a a \f[B]sqlite3\f[R] database for
|
||||||
|
tracking search/watch history.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
\f[B]-c\f[R]
|
||||||
|
Enable command-line mode (disable \f[B]rofi\f[R])
|
||||||
|
.TP
|
||||||
|
\f[B]-C\f[R]
|
||||||
|
Connect to the history database
|
||||||
|
\f[I]$XDG_CONFIG_HOME/aniwrapper/history.sqlite3\f[R]
|
||||||
|
.TP
|
||||||
|
\f[B]-d\f[R]
|
||||||
|
Enable downloading anime in command-line mode
|
||||||
|
.TP
|
||||||
|
\f[B]-f\f[R]
|
||||||
|
Specify the starting search directory for \[lq]Play from File\[rq] mode
|
||||||
|
.TP
|
||||||
|
\f[B]-h\f[R]
|
||||||
|
Display the help message
|
||||||
|
.TP
|
||||||
|
\f[B]-q\f[R]
|
||||||
|
Enable quality selection
|
||||||
|
.TP
|
||||||
|
\f[B]-Q\f[R] \f[I]query\f[R]
|
||||||
|
Run a query on the history databse
|
||||||
|
.TP
|
||||||
|
\f[B]-S\f[R]
|
||||||
|
Enable silent mode (suppress all output) [cannot be used with
|
||||||
|
\f[B]-v\f[R]]
|
||||||
|
.TP
|
||||||
|
\f[B]-t\f[R] \f[I]<aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>\f[R]
|
||||||
|
Choose theme from presets
|
||||||
|
.TP
|
||||||
|
\f[B]-T\f[R] \f[I]path_to_theme\f[R]
|
||||||
|
Provide custom \f[B]rofi\f[R] theme
|
||||||
|
.TP
|
||||||
|
\f[B]-v\f[R]
|
||||||
|
Verbose output
|
||||||
|
.SH EXAMPLES
|
||||||
|
.TP
|
||||||
|
\f[B]aniwrapper\f[R]
|
||||||
|
Run with default options (rofi enabled, best video quality, default
|
||||||
|
theme)
|
||||||
|
.TP
|
||||||
|
\f[B]aniwrapper -q\f[R]
|
||||||
|
Run with quality selection enabled
|
||||||
|
.TP
|
||||||
|
\f[B]aniwrapper -vqt doomone\f[R]
|
||||||
|
Run with quality selection menu and \f[I]doomone\f[R] theme
|
||||||
|
.TP
|
||||||
|
\f[B]aniwrapper -cd\f[R]
|
||||||
|
Download an anime in command-line mode (\f[B]rofi\f[R] disabled)
|
||||||
|
.TP
|
||||||
|
\f[B]aniwrapper -Q \[lq]SELECT * FROM watch_history ORDER BY watch_date DESC LIMIT 10;\[rq]\f[R]
|
||||||
|
Query history database for your 10 most recently watched anime
|
||||||
|
.TP
|
||||||
|
\f[B]aniwrapper -f /media/videos\f[R]
|
||||||
|
Run in \[lq]Play from File\[rq] mode starting the search from the
|
||||||
|
\f[I]/media/videos\f[R] directory
|
||||||
|
.SH SEE ALSO
|
||||||
|
.PP
|
||||||
|
\f[B]rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)\f[R]
|
||||||
|
.SH AUTHOR
|
||||||
|
.PP
|
||||||
|
Written by Kyle Yasuda <ksyasuda@umich.edu>
|
||||||
|
.PP
|
||||||
|
Original code based on pystardust\[cq]s \f[I]ani-cli\f[R]
|
||||||
|
(https://github.com/pystardust/ani-cli)
|
||||||
89
docs/man/aniwrapper.1.md
Normal file
89
docs/man/aniwrapper.1.md
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
---
|
||||||
|
title: ANIWRAPPER
|
||||||
|
section: 1
|
||||||
|
header: Man Page
|
||||||
|
footer: aniwrapper 1.0.0
|
||||||
|
date: February 4, 2022
|
||||||
|
---
|
||||||
|
|
||||||
|
# NAME
|
||||||
|
|
||||||
|
aniwrapper - A rofi wrapper around ani-cli: a command-line tool to browser, download, and stream anime
|
||||||
|
|
||||||
|
# SYNOPSIS
|
||||||
|
|
||||||
|
**aniwrapper** [-cdhvqS] [-t _theme_ | -T *config_path*]\
|
||||||
|
**aniwrapper** [-cvS] [-t *theme* | -T *config_path*] -f _path_to_directory_\
|
||||||
|
**aniwrapper** -Q _query_\
|
||||||
|
**aniwrapper** -C\
|
||||||
|
|
||||||
|
# DESCRIPTION
|
||||||
|
|
||||||
|
**aniwrapper** is a wrapper around a modified version of **ani-cli**, which uses
|
||||||
|
**rofi** to get user input and control the program flow, as well as a
|
||||||
|
a **sqlite3** database for tracking search/watch history.
|
||||||
|
|
||||||
|
# OPTIONS
|
||||||
|
|
||||||
|
**-c**
|
||||||
|
: Enable command-line mode (disable **rofi**)
|
||||||
|
|
||||||
|
**-C**
|
||||||
|
: Connect to the history database _$XDG_CONFIG_HOME/aniwrapper/history.sqlite3_
|
||||||
|
|
||||||
|
**-d**
|
||||||
|
: Enable downloading anime in command-line mode
|
||||||
|
|
||||||
|
**-f**
|
||||||
|
: Specify the starting search directory for "Play from File" mode
|
||||||
|
|
||||||
|
**-h**
|
||||||
|
: Display the help message
|
||||||
|
|
||||||
|
**-q**
|
||||||
|
: Enable quality selection
|
||||||
|
|
||||||
|
**-Q** _query_
|
||||||
|
: Run a query on the history databse
|
||||||
|
|
||||||
|
**-S**
|
||||||
|
: Enable silent mode (suppress all output) [cannot be used with **-v**]
|
||||||
|
|
||||||
|
**-t** _<aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>_
|
||||||
|
: Choose theme from presets
|
||||||
|
|
||||||
|
**-T** _path_to_theme_
|
||||||
|
: Provide custom **rofi** theme
|
||||||
|
|
||||||
|
**-v**
|
||||||
|
: Verbose output
|
||||||
|
|
||||||
|
# EXAMPLES
|
||||||
|
|
||||||
|
**aniwrapper**
|
||||||
|
: Run with default options (rofi enabled, best video quality, default theme)
|
||||||
|
|
||||||
|
**aniwrapper -q**
|
||||||
|
: Run with quality selection enabled
|
||||||
|
|
||||||
|
**aniwrapper -vqt doomone**
|
||||||
|
: Run with quality selection menu and _doomone_ theme
|
||||||
|
|
||||||
|
**aniwrapper -cd**
|
||||||
|
: Download an anime in command-line mode (**rofi** disabled)
|
||||||
|
|
||||||
|
**aniwrapper -Q "SELECT \* FROM watch_history ORDER BY watch_date DESC LIMIT 10;"**
|
||||||
|
: Query history database for your 10 most recently watched anime
|
||||||
|
|
||||||
|
**aniwrapper -f /media/videos**
|
||||||
|
: Run in "Play from File" mode starting the search from the _/media/videos_ directory
|
||||||
|
|
||||||
|
# SEE ALSO
|
||||||
|
|
||||||
|
**rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)**
|
||||||
|
|
||||||
|
# AUTHOR
|
||||||
|
|
||||||
|
Written by Kyle Yasuda <ksyasuda@umich.edu>
|
||||||
|
|
||||||
|
Original code based on pystardust's _ani-cli_ (https://github.com/pystardust/ani-cli)
|
||||||
Loading…
Reference in New Issue
Block a user