update manpage

This commit is contained in:
ksyasuda 2022-02-05 23:06:01 -08:00
parent 5c7af5c36d
commit 42db51371b
2 changed files with 49 additions and 14 deletions

View File

@ -8,8 +8,8 @@ aniwrapper - A rofi wrapper around ani-cli: a command-line tool to
browser, download, and stream anime browser, download, and stream anime
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[B]aniwrapper\f[R] [-cdhvqS] [-t \f[I]theme\f[R] | -T \f[B]aniwrapper\f[R] [-cdhpqvS] [-t \f[I]theme\f[R] | -T
\f[I]config_path\f[R]] \f[I]config_path\f[R]] [\f[I]query\f[R]]
.PD 0 .PD 0
.P .P
.PD .PD
@ -33,6 +33,14 @@ browser, download, and stream anime
control the program flow, as well as a a \f[B]sqlite3\f[R] database for control the program flow, as well as a a \f[B]sqlite3\f[R] database for
tracking search/watch history. tracking search/watch history.
.SH OPTIONS .SH OPTIONS
.PP
Defaults:
.IP \[bu] 2
\f[B]rofi\f[R] enabled
.IP \[bu] 2
aniwrapper.rasi theme
.IP \[bu] 2
best quality
.TP .TP
\f[B]-c\f[R] \f[B]-c\f[R]
Enable command-line mode (disable \f[B]rofi\f[R]) Enable command-line mode (disable \f[B]rofi\f[R])
@ -50,6 +58,9 @@ Specify the starting search directory for \[lq]Play from File\[rq] mode
\f[B]-h\f[R] \f[B]-h\f[R]
Display the help message Display the help message
.TP .TP
\f[B]-p\f[R]
Enable video player selection menu
.TP
\f[B]-q\f[R] \f[B]-q\f[R]
Enable quality selection Enable quality selection
.TP .TP
@ -60,7 +71,7 @@ Run a query on the history databse
Enable silent mode (suppress all output) [cannot be used with Enable silent mode (suppress all output) [cannot be used with
\f[B]-v\f[R]] \f[B]-v\f[R]]
.TP .TP
\f[B]-t\f[R] \f[I]<aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>\f[R] \f[B]-t\f[R] \f[I]aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark\f[R]
Choose theme from presets Choose theme from presets
.TP .TP
\f[B]-T\f[R] \f[I]path_to_theme\f[R] \f[B]-T\f[R] \f[I]path_to_theme\f[R]
@ -71,17 +82,21 @@ Verbose output
.SH EXAMPLES .SH EXAMPLES
.TP .TP
\f[B]aniwrapper\f[R] \f[B]aniwrapper\f[R]
Run with default options (rofi enabled, best video quality, default Launch main menu with default options
theme)
.TP .TP
\f[B]aniwrapper -q\f[R] \f[B]aniwrapper konosuba\f[R]
Run with quality selection enabled Run in stream mode with a search query: \[lq]konosuba\[rq]
.TP
\f[B]aniwrapper -qd naruto\f[R]
Run in download mode with quality selection enabled and a search query:
\[lq]naruto\[rq]
.TP .TP
\f[B]aniwrapper -vqt doomone\f[R] \f[B]aniwrapper -vqt doomone\f[R]
Run with quality selection menu and \f[I]doomone\f[R] theme Run with quality selection menu and \f[I]doomone\f[R] theme
.TP .TP
\f[B]aniwrapper -cd\f[R] \f[B]aniwrapper -cd\f[R]
Download an anime in command-line mode (\f[B]rofi\f[R] disabled) Enable downloading an anime in command-line mode (\f[B]rofi\f[R]
disabled)
.TP .TP
\f[B]aniwrapper -Q \[lq]SELECT * FROM watch_history ORDER BY watch_date DESC LIMIT 10;\[rq]\f[R] \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 Query history database for your 10 most recently watched anime
@ -89,6 +104,10 @@ Query history database for your 10 most recently watched anime
\f[B]aniwrapper -f /media/videos\f[R] \f[B]aniwrapper -f /media/videos\f[R]
Run in \[lq]Play from File\[rq] mode starting the search from the Run in \[lq]Play from File\[rq] mode starting the search from the
\f[I]/media/videos\f[R] directory \f[I]/media/videos\f[R] directory
.TP
\f[B]aniwrapper -S\f[R]
Run in quiet mode (suppress all output to stdout and disable
notifications)
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[B]rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)\f[R] \f[B]rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)\f[R]

View File

@ -12,7 +12,7 @@ aniwrapper - A rofi wrapper around ani-cli: a command-line tool to browser, down
# SYNOPSIS # SYNOPSIS
**aniwrapper** [-cdhvqS] [-t _theme_ | -T *config_path*]\ **aniwrapper** [-cdhpqvS] [-t _theme_ | -T *config_path*] [*query*]\
**aniwrapper** [-cvS] [-t *theme* | -T *config_path*] -f _path_to_directory_\ **aniwrapper** [-cvS] [-t *theme* | -T *config_path*] -f _path_to_directory_\
**aniwrapper** -Q _query_\ **aniwrapper** -Q _query_\
**aniwrapper** -C\ **aniwrapper** -C\
@ -25,6 +25,12 @@ a **sqlite3** database for tracking search/watch history.
# OPTIONS # OPTIONS
Defaults:
- **rofi** enabled
- aniwrapper.rasi theme
- best quality
**-c** **-c**
: Enable command-line mode (disable **rofi**) : Enable command-line mode (disable **rofi**)
@ -40,6 +46,9 @@ a **sqlite3** database for tracking search/watch history.
**-h** **-h**
: Display the help message : Display the help message
**-p**
: Enable video player selection menu
**-q** **-q**
: Enable quality selection : Enable quality selection
@ -49,7 +58,7 @@ a **sqlite3** database for tracking search/watch history.
**-S** **-S**
: Enable silent mode (suppress all output) [cannot be used with **-v**] : Enable silent mode (suppress all output) [cannot be used with **-v**]
**-t** _<aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>_ **-t** _aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark_
: Choose theme from presets : Choose theme from presets
**-T** _path_to_theme_ **-T** _path_to_theme_
@ -61,16 +70,20 @@ a **sqlite3** database for tracking search/watch history.
# EXAMPLES # EXAMPLES
**aniwrapper** **aniwrapper**
: Run with default options (rofi enabled, best video quality, default theme) : Launch main menu with default options
**aniwrapper -q** **aniwrapper konosuba**
: Run with quality selection enabled : Run in stream mode with a search query: "konosuba"
**aniwrapper -qd naruto**
: Run in download mode with quality selection enabled and a search query:
"naruto"
**aniwrapper -vqt doomone** **aniwrapper -vqt doomone**
: Run with quality selection menu and _doomone_ theme : Run with quality selection menu and _doomone_ theme
**aniwrapper -cd** **aniwrapper -cd**
: Download an anime in command-line mode (**rofi** disabled) : Enable downloading an anime in command-line mode (**rofi** disabled)
**aniwrapper -Q "SELECT \* FROM watch_history ORDER BY watch_date DESC LIMIT 10;"** **aniwrapper -Q "SELECT \* FROM watch_history ORDER BY watch_date DESC LIMIT 10;"**
: Query history database for your 10 most recently watched anime : Query history database for your 10 most recently watched anime
@ -78,6 +91,9 @@ a **sqlite3** database for tracking search/watch history.
**aniwrapper -f /media/videos** **aniwrapper -f /media/videos**
: Run in "Play from File" mode starting the search from the _/media/videos_ directory : Run in "Play from File" mode starting the search from the _/media/videos_ directory
**aniwrapper -S**
: Run in quiet mode (suppress all output to stdout and disable notifications)
# SEE ALSO # SEE ALSO
**rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)** **rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)**