From 14dee88f11e3cd22c1662eb8f35feaed5616f5a2 Mon Sep 17 00:00:00 2001 From: ksyasuda Date: Fri, 4 Feb 2022 22:54:16 -0800 Subject: [PATCH] add manpage --- Makefile | 10 ++-- docs/man/aniwrapper.1 | 100 +++++++++++++++++++++++++++++++++++++++ docs/man/aniwrapper.1.md | 89 ++++++++++++++++++++++++++++++++++ 3 files changed, 195 insertions(+), 4 deletions(-) create mode 100644 docs/man/aniwrapper.1 create mode 100644 docs/man/aniwrapper.1.md diff --git a/Makefile b/Makefile index 8165214..e006e6b 100644 --- a/Makefile +++ b/Makefile @@ -3,10 +3,12 @@ PREFIX := /usr all: install install: uninstall - cp ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli - cp aniwrapper $(DESTDIR)$(PREFIX)/bin/aniwrapper - chmod 0755 $(DESTDIR)$(PREFIX)/bin/ani-cli - chmod 0755 $(DESTDIR)$(PREFIX)/bin/aniwrapper + install -m0755 ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli + install -m0755 aniwrapper $(DESTDIR)$(PREFIX)/bin/aniwrapper + mkdir -p /usr/local/man/man1 + install -m0644 docs/man/aniwrapper.1 /usr/local/man/man1/ + gzip -qf /usr/local/man/man1/aniwrapper.1 + mandb -q dev: uninstall ln -sr ./ani-cli $(DESTDIR)$(PREFIX)/bin/ani-cli diff --git a/docs/man/aniwrapper.1 b/docs/man/aniwrapper.1 new file mode 100644 index 0000000..8b54e00 --- /dev/null +++ b/docs/man/aniwrapper.1 @@ -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]\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 +.PP +Original code based on pystardust\[cq]s \f[I]ani-cli\f[R] +(https://github.com/pystardust/ani-cli) diff --git a/docs/man/aniwrapper.1.md b/docs/man/aniwrapper.1.md new file mode 100644 index 0000000..1d46e11 --- /dev/null +++ b/docs/man/aniwrapper.1.md @@ -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** __ +: 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 + +Original code based on pystardust's _ani-cli_ (https://github.com/pystardust/ani-cli)