aniwrapper/docs/man/aniwrapper.1

.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.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
stream, download, and play anime
.SH SYNOPSIS
.PP
\f[B]aniwrapper\f[R] [-adhpqrSv] [-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] -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 [-dhpqrSv] [\f[I]query\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
.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
.PP
Defaults:
.IP \[bu] 2
\f[B]rofi\f[R] enabled
.IP \[bu] 2
aniwrapper.rasi theme
.IP \[bu] 2
best quality
.TP
\f[B]-a\f[R]
Enable autoplay in streaming mode
.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]-e\f[R] \f[I]episode\f[R] \f[B]or\f[R] \f[I]begin_episode - end_episode\f[R]
Select episode(s) to stream/download
.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]-p\f[R]
Enable video player selection menu
.TP
\f[B]-P\f[R]
Enable provider selection menu
.TP
\f[B]-q\f[R]
Enable quality selection
.TP
\f[B]-r\f[R]
Start script at episode selection for the most recently watched anime
.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]alter|aniwrapper (default)|dracula|doomone|fancy|flamingo|material|monokai|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]
Launch main menu with default options
.TP
\f[B]aniwrapper konosuba\f[R]
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 \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 \f[I]quality selection enabled\f[R] and the \f[I]doomone\f[R]
theme
.TP
\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 -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 \f[I]silent\f[R] mode (suppress all output to stdout and disable
notifications)
.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>)