Skip to content

Commit 1e04919

Browse files
Derisis13archeiteport19xCoolnsXjustchokingaround
committed
docs: manpage
+ docs: remove v3.4 stuff + docs: dmenu -> rofi dmenu (dmenu doesn't support multi) + docs: remove "new in v4" Co-authored-by: archeite <121004047+archeite@users.noreply.github.com> Co-authored-by: port19 <port19@port19.xyz> Co-authored-by: Derisis13 <email.felhasznalasra@gmail.com> Co-authored-by: CoolnsX <ansari.tan20@gmail.com> Co-authored-by: chokerman <44473782+justchokingaround@users.noreply.github.com> Co-authored-by: zenith71 <71zenith@protonmail.com>
1 parent 4faa1c8 commit 1e04919

5 files changed

Lines changed: 57 additions & 49 deletions

File tree

‎.assets/ani-cli-spec.png‎

-53.1 KB
Binary file not shown.

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
/.assets/ @justchokingaround
33
README.md @justchokingaround
44
hist_transition.sh @Derisis13
5+
ani-cli.1 @Derisis13

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,3 @@
2020
- Take part in troubleshooting and testing
2121
- Star the repo
2222
- Follow the maintainers
23-
24-
## Architecture
25-
26-
![spec](https://github.com/pystardust/ani-cli/blob/spec/.assets/ani-cli-spec.png)

‎README.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ https://user-images.githubusercontent.com/44473782/160729779-41fe207c-b5aa-4fed-
3131
## Table of Contents
3232

3333
- [Fixing errors](#Fixing-errors)
34-
- [New in v4](#New-in-v4)
3534
- [Install](#Install)
3635
- [Linux](#Linux)
3736
- [Debian](#Debian)
@@ -57,12 +56,6 @@ If after this the issue persists then open an issue.
5756

5857
History has been reworked and relocated. We're working on a transition script, please be patient. Old history can be viewed with `less ${XDG_CACHE_HOME:-$HOME/.cache}/ani-hsts`
5958

60-
## New in v4
61-
62-
V4 was a complete rewrite, which is why it took so long.
63-
64-
The user interface is now powered by [fzf](https://github.com/junegunn/fzf), tho it may be changed to [gum](https://github.com/charmbracelet/gum) in an upcoming version.
65-
6659
## Install
6760

6861
#### Users of V3.2 or the v3.2.x series should uninstall before upgrading

‎ani-cli.1‎

Lines changed: 56 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "ANI-CLI" "1" "December 2022" "ani-cli" "User Commands"
1+
.TH "ANI-CLI" "1" "January 2023" "ani-cli" "User Commands"
22
.SH NAME
33
ani-cli \- watch anime from the commandline
44
.SH SYNOPSIS
@@ -9,63 +9,81 @@ A shell script to browse and search anime from the command-line.
99
.PD 0
1010
.P
1111
.PD
12-
This tool scrapes the site animixplay.
12+
This tool scrapes the site allanime.
1313
.PD 0
1414
.P
1515
.PD
16-
\f[B]ani-cli\f[R] without options defaults to the mpv media player.
16+
\f[B]ani-cli\f[R] without options defaults to iina on macOS, flatpak mpv on Steamdeck, mpv apk on android and mpv media player everywhere else.
1717
.SH OPTIONS
1818
.TP
19-
\fB\-a\fR \fI\,<episode>\/\fR
20-
Specify the episode number to watch.
19+
\fB\-e | --episode | -r | --range\fR \fI\,<episode>\/\fR
20+
Specify the episode numbers to watch. If range is specified it should be quoted or separated by a non-numeric character (eg. -).
2121
.TP
22-
\fB\-c\fR
23-
continue watching anime from history.
22+
\fB\-c | --continue\fR
23+
Continue watching anime from history.
2424
.TP
25-
\fB\-d\fR
26-
download episode.
25+
\fB\-d | --download\fR
26+
Download episode.
2727
.TP
28-
\fB\-D\fR
29-
delete history.
28+
\fB\-h | --help\fR
29+
Show summary of options.
3030
.TP
31-
\fB\-f\fR
32-
use fzf for anime selection.
31+
\fB\-q | --quality\fR \fI\,<best|worst|360|480|720|1080>\/\fR
32+
Set the video quality. Default quality is best.
3333
.TP
34-
\fB\-h\fR
35-
Show summary of options.
34+
\fB\-s | --syncplay\fR
35+
Watch anime together with friends, using Syncplay (works with mpv only).
36+
.TP
37+
\fB\-U | --update\fR
38+
Fetch update from github.
3639
.TP
37-
\fB\-p\fR \fI\,DIRECTORY\/\fR
38-
download episode to the specified DIRECTORY.
40+
\fB\-v | --vlc\fR
41+
Use VLC as the media player.
3942
.TP
40-
\fB\-q\fR \fI\,<best|worst|360|480|720|1080>\/\fR
41-
set the video quality.
43+
\fB\-V | --version\fR
44+
Print version number and exit.
4245
.TP
43-
\fB\-r\fR
44-
select provider to scrape first.
46+
\fB\--dub\fR
47+
Play the dubbed version. Without this flag, it'll always play the subbed version.
48+
.PP
49+
.SH
50+
ENVIRONMENT VARIABLES
51+
.PP
52+
ani-cli v4 uses environment variables to control unstable/untested and niche features in addition to everything that has an option. Command-line options take precedence over env vars. Note that these are all subject to change.
4553
.TP
46-
\fB\-s\fR
47-
watch anime together with friends, using Syncplay (works with mpv only).
54+
\fBANI_CLI_MODE\fR
55+
Controlls the scraped media's mode, valid options are sub or dub. Default is sub.
4856
.TP
49-
\fB\-U\fR
50-
fetch update from github.
57+
\fBANI_CLI_MEDIA_LOCALE\fR
58+
Controlls the scraped media's locale, check allanime for valid options. Default is en-US.
5159
.TP
52-
\fB\-v\fR
53-
use VLC as the media player.
60+
\fBANI_CLI_DOWNLOAD_DIR\fR
61+
Controlls the directory where files are downloaded. Default is the current dir.
5462
.TP
55-
\fB\-V\fR
56-
print version number and exit.
63+
\fBANI_CLI_QUALITY\fR
64+
Controlls the scraped media's quality, check allanime for valid options or set to worst/best. Default is best.
5765
.TP
58-
\fB\-x\fR
59-
print all video links from all providers to stdout (for debugging
60-
purpose).
61-
.SH EPISODE SELECTION
66+
\fBANI_CLI_PLAYER\fR
67+
Sets the player ani-cli uses. Can be debug (print links), download (equivalent to -d), android_mpv (apk and am start), android_vlc (apk and am start), flatpak_mpv (for flatpak) or any player that can play urls. For defaults see working without arguments.
68+
.TP
69+
\fBANI_CLI_EXTERNAL_MENU\fR
70+
Controlls the frontend of ani-cli. Can be 0 (uses fzf) or 1 (uses rofi dmenu). Default is 0.
71+
.TP
72+
\fBANI_CLI_MULTI_SELECTION\fR
73+
Controlls the multi flag for the chosen frontend. Default is -m for fzf and --multi-select for rofi dmenu.
74+
.TP
75+
\fBANI_CLI_CACHE_DIR\fR
76+
Controlls the directory ani-cli uses for caching results. A /ani-cli subfolder is created there for the cache files if doesn't exists. Default is $XDG_CACHE_HOME if set, $HOME/.cache/ if not.
77+
.TP
78+
\fBANI_CLI_HIST_DIR\fR
79+
Controls the directory ani-cli uses for storing history. A /ani-cli subfolder is created there for the histfile if doesn't exists. Default is $XDG_STATE_HOME if set, $HOME/.local/state if not.
80+
.TP
81+
\fBANI_CLI_DEFAULT_SOURCE\fR
82+
Controlls the default source. Valid is history (equivalent to -c), everything else means search. Default is search.
6283
.PP
63-
Episode selection: Multiple episodes can be chosen given a range Choose
64-
episode [1-13]: 1 6 This would choose episodes 1 2 3 4 5 6 To select the
65-
last episode use -1
84+
.SH EPISODE SELECTION
6685
.PP
67-
When selecting non-interactively, the first result will be selected, if
68-
anime is passed
86+
Multiple episodes can be chosen using fzf (or alternative frontend's) multi-selection mode. For this refer to their instructions.
6987
.SH BUGS
7088
.PP
7189
Use the GitHub issue tracker:

0 commit comments

Comments
 (0)