mirror of
https://github.com/ksyasuda/aniwrapper.git
synced 2024-10-28 04:44:11 -07:00
update readme and manpage to reflect latest changes
This commit is contained in:
parent
86acb7d731
commit
49cf4f3ecc
33
aniwrapper
33
aniwrapper
@ -38,23 +38,24 @@ help_text() {
|
||||
printf "%s\n" "$line"
|
||||
done <<< "
|
||||
Usage:
|
||||
aniwrapper [-cdhpqvS] [-t <theme> or -T <config_path>]
|
||||
aniwrapper [-cvS] [-t <theme> or -T <config_path>] -f <path_to_directory>
|
||||
aniwrapper -Q <query>
|
||||
aniwrapper -C
|
||||
aniwrapper [-dhpqSv] [-t <theme> | -T <config_path>] [<query>]
|
||||
aniwrapper -f <directory_path> [-t <theme> | -T <config_path>] [-pSv] [<query>]\
|
||||
aniwrapper -c [-dhqSv] [<query>]
|
||||
aniwrapper -Q <query>
|
||||
aniwrapper -C
|
||||
Options:
|
||||
-c enable command-line mode (rofi disabled)
|
||||
-C connect to history database
|
||||
-d download episode in command-line mode
|
||||
-f <path_to_directory> (no trailing slash) specify starting directory for play for file mode
|
||||
-h show this help text
|
||||
-p enable player selection menu
|
||||
-q enable quality selection
|
||||
-Q <query> query the history database
|
||||
-v verbose output
|
||||
-S silent mode (suppress output to stdout) [cannot be used with -v]
|
||||
-t <aniwrapper (default)|dracula|doomone|fancy|flamingo|material|onedark> change rofi theme
|
||||
-T <config_path> specify custom rofi theme
|
||||
-c enable command-line mode (rofi disabled)
|
||||
-C connect to history database
|
||||
-d download episode in command-line mode
|
||||
-f <path_to_directory> (no trailing slash) specify starting directory for play for file mode
|
||||
-h show this help text
|
||||
-p enable player selection menu
|
||||
-q enable quality selection
|
||||
-Q <query> query the history database
|
||||
-v verbose output
|
||||
-S silent mode (suppress output to stdout) [cannot be used with -v]
|
||||
-t <aniwrapper (default)|dracula|doomone|fancy|flamingo|material|onedark> change rofi theme
|
||||
-T <config_path> specify custom rofi theme
|
||||
"
|
||||
}
|
||||
|
||||
|
@ -8,13 +8,17 @@ 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] [-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]]
|
||||
.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]
|
||||
\f[B]aniwrapper\f[R] -f \f[I]directory_path\f[R] [-t \f[I]theme\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
|
||||
.P
|
||||
.PD
|
||||
@ -85,28 +89,30 @@ Verbose output
|
||||
Launch main menu with default options
|
||||
.TP
|
||||
\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
|
||||
\f[B]aniwrapper -qd naruto\f[R]
|
||||
Run in download mode with quality selection enabled and a search query:
|
||||
\[lq]naruto\[rq]
|
||||
Run in \f[I]download\f[R] mode with \f[I]quality selection enabled\f[R]
|
||||
and a \f[I]search query\f[R] = \[lq]naruto\[rq]
|
||||
.TP
|
||||
\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
|
||||
\f[B]aniwrapper -cd\f[R]
|
||||
Enable downloading an anime in command-line mode (\f[B]rofi\f[R]
|
||||
disabled)
|
||||
\f[B]aniwrapper -cqd\f[R]
|
||||
Run in \f[I]command-line\f[R] \f[I]download\f[R] mode with \f[I]quality
|
||||
selection enabled\f[R] (\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
|
||||
\f[B]aniwrapper -f /media/videos -t dracula\f[R]
|
||||
Run in \f[I]Play from File\f[R] mode, using the \f[I]dracula\f[R] theme,
|
||||
and with the \f[I]search\f[R] starting from \f[I]/media/videos\f[R]
|
||||
.TP
|
||||
\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)
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
|
@ -12,8 +12,9 @@ aniwrapper - A rofi wrapper around ani-cli: a command-line tool to browser, down
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
**aniwrapper** [-cdhpqvS] [-t _theme_ | -T *config_path*] [*query*]\
|
||||
**aniwrapper** [-cvS] [-t *theme* | -T *config_path*] -f _path_to_directory_\
|
||||
**aniwrapper** [-dhpqSv] [-t _theme_ | -T *config_path*] [*query*]\
|
||||
**aniwrapper** -f _directory_path_ [-t _theme_ | -T *config_path*] [-pSv] [*query*]\
|
||||
**aniwrapper** -c [-dhqSv] [*query*]\
|
||||
**aniwrapper** -Q _query_\
|
||||
**aniwrapper** -C\
|
||||
|
||||
@ -73,26 +74,26 @@ Defaults:
|
||||
: Launch main menu with default options
|
||||
|
||||
**aniwrapper konosuba**
|
||||
: Run in stream mode with a search query: "konosuba"
|
||||
: Run in _stream_ mode with a _search query_ = "konosuba"
|
||||
|
||||
**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"
|
||||
|
||||
**aniwrapper -vqt doomone**
|
||||
: Run with quality selection menu and _doomone_ theme
|
||||
: Run with _quality selection enabled_ and the _doomone_ theme
|
||||
|
||||
**aniwrapper -cd**
|
||||
: Enable downloading an anime in command-line mode (**rofi** disabled)
|
||||
**aniwrapper -cqd**
|
||||
: 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;"**
|
||||
: 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
|
||||
**aniwrapper -f /media/videos -t dracula**
|
||||
: Run in _Play from File_ mode, using the _dracula_ theme, and with the _search_ starting from _/media/videos_
|
||||
|
||||
**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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user