aniwrapper/docs/man/aniwrapper.1.md

113 lines
2.6 KiB
Markdown
Raw Normal View History

2022-02-04 22:54:16 -08:00
---
title: ANIWRAPPER
section: 1
header: Man Page
footer: aniwrapper 1.0.0
date: February 4, 2022
---
# NAME
2022-02-16 23:57:43 -08:00
aniwrapper - A rofi wrapper around ani-cli: a command-line tool to stream, download, and play anime
2022-02-04 22:54:16 -08:00
# SYNOPSIS
2022-06-04 16:24:06 -07:00
**aniwrapper** [-adhpqrSv] [-t _theme_ | -T _config_path_] [_query_]\
2022-02-16 23:57:43 -08:00
**aniwrapper** -f _directory_path_ [-t _theme_ | -T _config_path_] [-pSv] [_query_]\
2022-03-03 18:57:18 -08:00
**aniwrapper** -c [-dhpqrSv] [_query_]\
2022-02-04 22:54:16 -08:00
**aniwrapper** -Q _query_\
2022-02-16 23:57:43 -08:00
**aniwrapper** -C
2022-02-04 22:54:16 -08:00
# 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
2022-02-16 23:57:43 -08:00
a **sqlite3** database for tracking search/watch history
2022-02-04 22:54:16 -08:00
# OPTIONS
2022-02-05 23:06:01 -08:00
Defaults:
2022-02-16 23:57:43 -08:00
- **rofi** enabled
- aniwrapper.rasi theme
- best quality
2022-02-05 23:06:01 -08:00
2022-06-04 16:24:06 -07:00
**-a**
: Enable autoplay in streaming mode
2022-02-04 22:54:16 -08:00
**-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
2022-02-05 23:06:01 -08:00
**-p**
: Enable video player selection menu
2022-02-04 22:54:16 -08:00
**-q**
: Enable quality selection
2022-03-03 18:57:18 -08:00
**-r**
: Start script at episode selection for the most recently watched anime
2022-02-04 22:54:16 -08:00
**-Q** _query_
: Run a query on the history databse
**-S**
: Enable silent mode (suppress all output) [cannot be used with **-v**]
2022-02-19 01:36:37 -08:00
**-t** _alter|aniwrapper (default)|dracula|doomone|fancy|flamingo|material|monokai|nord|onedark_
2022-02-04 22:54:16 -08:00
: Choose theme from presets
**-T** _path_to_theme_
: Provide custom **rofi** theme
**-v**
: Verbose output
# EXAMPLES
**aniwrapper**
2022-02-05 23:06:01 -08:00
: Launch main menu with default options
2022-02-04 22:54:16 -08:00
2022-02-05 23:06:01 -08:00
**aniwrapper konosuba**
: Run in _stream_ mode with a _search query_ = "konosuba"
2022-02-05 23:06:01 -08:00
**aniwrapper -qd naruto**
: Run in _download_ mode with _quality selection enabled_ and a _search query_ =
2022-02-05 23:06:01 -08:00
"naruto"
2022-02-04 22:54:16 -08:00
**aniwrapper -vqt doomone**
: Run with _quality selection enabled_ and the _doomone_ theme
2022-02-04 22:54:16 -08:00
**aniwrapper -cqd**
: Run in _command-line_ _download_ mode with _quality selection enabled_ (**rofi** disabled)
2022-02-04 22:54:16 -08:00
**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 -t dracula**
: Run in _Play from File_ mode, using the _dracula_ theme, and with the _search_ starting from _/media/videos_
2022-02-04 22:54:16 -08:00
2022-02-05 23:06:01 -08:00
**aniwrapper -S**
: Run in _silent_ mode (suppress all output to stdout and disable notifications)
2022-02-05 23:06:01 -08:00
2022-02-04 22:54:16 -08:00
# SEE ALSO
**rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)**
# AUTHOR
Written by Kyle Yasuda <ksyasuda@umich.edu>
2022-02-16 23:57:43 -08:00
Original code based on pystardust's _ani-cli_ (<https://github.com/pystardust/ani-cli>)