sudacode/aniwrapper
1
1
Fork 0
mirror of https://github.com/ksyasuda/aniwrapper.git synced 2024-11-22 03:19:53 -08:00
Code Issues Projects Releases Wiki Activity

update readme and manpage to reflect latest changes

Browse Source
This commit is contained in:
ksyasuda 2022-02-06 19:43:24 -08:00
parent 86acb7d731
commit 49cf4f3ecc
3 changed files with 48 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
aniwrapper
View File

@ -38,8 +38,9 @@ help_text() {
printf "%s\n" "$line" printf "%s\n" "$line"
done <<< " done <<< "
Usage: Usage:
aniwrapper [-cdhpqvS] [-t <theme> or -T <config_path>] aniwrapper [-dhpqSv] [-t <theme> | -T <config_path>] [<query>]
aniwrapper [-cvS] [-t <theme> or -T <config_path>] -f <path_to_directory> aniwrapper -f <directory_path> [-t <theme> | -T <config_path>] [-pSv] [<query>]\
aniwrapper -c [-dhqSv] [<query>]
aniwrapper -Q <query> aniwrapper -Q <query>
aniwrapper -C aniwrapper -C
Options: Options:

34
docs/man/aniwrapper.1
View File

@ -8,13 +8,17 @@ 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] [-cdhpqvS] [-t \f[I]theme\f[R] | -T \f[B]aniwrapper\f[R] [-dhpqSv] [-t \f[I]theme\f[R] | -T
\f[I]config_path\f[R]] [\f[I]query\f[R]] \f[I]config_path\f[R]] [\f[I]query\f[R]]
.PD 0 .PD 0
.P .P
.PD .PD
\f[B]aniwrapper\f[R] [-cvS] [-t \f[I]theme\f[R] | -T \f[B]aniwrapper\f[R] -f \f[I]directory_path\f[R] [-t \f[I]theme\f[R] |
\f[I]config_path\f[R]] -f \f[I]path_to_directory\f[R] -T \f[I]config_path\f[R]] [-pSv] [\f[I]query\f[R]]
.PD 0
.P
.PD
\f[B]aniwrapper\f[R] -c [-dhqSv] [\f[I]query\f[R]]
.PD 0 .PD 0
.P .P
.PD .PD
@ -85,28 +89,30 @@ Verbose output
Launch main menu with default options Launch main menu with default options
.TP .TP
\f[B]aniwrapper konosuba\f[R] \f[B]aniwrapper konosuba\f[R]
Run in stream mode with a search query: \[lq]konosuba\[rq] Run in \f[I]stream\f[R] mode with a \f[I]search query\f[R] =
\[lq]konosuba\[rq]
.TP .TP
\f[B]aniwrapper -qd naruto\f[R] \f[B]aniwrapper -qd naruto\f[R]
Run in download mode with quality selection enabled and a search query: Run in \f[I]download\f[R] mode with \f[I]quality selection enabled\f[R]
\[lq]naruto\[rq] and a \f[I]search query\f[R] = \[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 \f[I]quality selection enabled\f[R] and the \f[I]doomone\f[R]
theme
.TP .TP
\f[B]aniwrapper -cd\f[R] \f[B]aniwrapper -cqd\f[R]
Enable downloading an anime in command-line mode (\f[B]rofi\f[R] Run in \f[I]command-line\f[R] \f[I]download\f[R] mode with \f[I]quality
disabled) selection enabled\f[R] (\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
.TP .TP
\f[B]aniwrapper -f /media/videos\f[R] \f[B]aniwrapper -f /media/videos -t dracula\f[R]
Run in \[lq]Play from File\[rq] mode starting the search from the Run in \f[I]Play from File\f[R] mode, using the \f[I]dracula\f[R] theme,
\f[I]/media/videos\f[R] directory and with the \f[I]search\f[R] starting from \f[I]/media/videos\f[R]
.TP .TP
\f[B]aniwrapper -S\f[R] \f[B]aniwrapper -S\f[R]
Run in quiet mode (suppress all output to stdout and disable Run in \f[I]silent\f[R] mode (suppress all output to stdout and disable
notifications) notifications)
.SH SEE ALSO .SH SEE ALSO
.PP .PP

21
docs/man/aniwrapper.1.md
View File

@ -12,8 +12,9 @@ aniwrapper - A rofi wrapper around ani-cli: a command-line tool to browser, down
# SYNOPSIS # SYNOPSIS
**aniwrapper** [-cdhpqvS] [-t _theme_ | -T *config_path*] [*query*]\ **aniwrapper** [-dhpqSv] [-t _theme_ | -T *config_path*] [*query*]\
**aniwrapper** [-cvS] [-t *theme* | -T *config_path*] -f _path_to_directory_\ **aniwrapper** -f _directory_path_ [-t _theme_ | -T *config_path*] [-pSv] [*query*]\
**aniwrapper** -c [-dhqSv] [*query*]\
**aniwrapper** -Q _query_\ **aniwrapper** -Q _query_\
**aniwrapper** -C\ **aniwrapper** -C\
@ -73,26 +74,26 @@ Defaults:
: Launch main menu with default options : Launch main menu with default options
**aniwrapper konosuba** **aniwrapper konosuba**
: Run in stream mode with a search query: "konosuba" : Run in _stream_ mode with a _search query_ = "konosuba"
**aniwrapper -qd naruto** **aniwrapper -qd naruto**
: Run in download mode with quality selection enabled and a search query: : Run in _download_ mode with _quality selection enabled_ and a _search query_ =
"naruto" "naruto"
**aniwrapper -vqt doomone** **aniwrapper -vqt doomone**
: Run with quality selection menu and _doomone_ theme : Run with _quality selection enabled_ and the _doomone_ theme
**aniwrapper -cd** **aniwrapper -cqd**
: Enable downloading an anime in command-line mode (**rofi** disabled) : Run in _command-line_ _download_ mode with _quality selection enabled_ (**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
**aniwrapper -f /media/videos** **aniwrapper -f /media/videos -t dracula**
: Run in "Play from File" mode starting the search from the _/media/videos_ directory : Run in _Play from File_ mode, using the _dracula_ theme, and with the _search_ starting from _/media/videos_
**aniwrapper -S** **aniwrapper -S**
: Run in quiet mode (suppress all output to stdout and disable notifications) : Run in _silent_ mode (suppress all output to stdout and disable notifications)
# SEE ALSO # SEE ALSO