-
Notifications
You must be signed in to change notification settings - Fork 7
/
toru.1
194 lines (194 loc) · 4.96 KB
/
toru.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "toru" "1" "" "" "General Commands Manual"
.SH NAME
Toru \- stream anime using torrents without waiting for downloads
.SH SYNOPSIS
\f[CR]toru [options] [command] [command\-options] [optional\-query]\f[R]
.SH DESCRIPTION
toru allows you to stream torrents from the terminal.
You must specify a base command and then can optionally add flags to
modify the behavior.
By default toru stores torrents and data in XDG_CACHE_HOME.
toru uses nyaa.si to provide search capabilities for anime.
You can also use toru to download torrents using their magnet/url/path
or you can stream any torrent that you have the link to (not just anime)
.SH OPTIONS
.TP
\f[CR]\-h, \-\-help\f[R]
Show the help message and exit
.TP
\f[CR]\-V, \-\-version\f[R]
Show version info and exit
.TP
\f[CR]\-v, \-\-verbose\f[R]
Verbose output
.TP
\f[CR]\-p, \-\-player PLAYER_CMD...\f[R]
Set a special player for toru to use for playing torrent video files
.TP
\f[CR]\-P, \-\-port PORT...\f[R]
Specify the port that toru serves videos on.
.SH COMMANDS
.SS download
download torrents
.PP
download torrent from .torrent file, magnet or URL to a .torrent file
.PP
\f[B]Usage: toru [OPTIONS] download [download\-OPTIONS]\f[R]
.TP
\f[B]Aliases: dl, d\f[R]
.SS download torrents
.PP
download torrent from .torrent file, magnet or URL to a .torrent file
.TP
\f[B]\-d\f[R], \f[B]\-\-dir\f[R]
parent directory to download torrents to
.SS Help Options
.TP
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
Show this help message
.SS run
run an interactive terminal session
.PP
run an interactive terminal session with toru
.PP
\f[B]Usage: toru [OPTIONS] run [run\-OPTIONS]\f[R]
.TP
\f[B]Aliases: , r\f[R]
.SS run an interactive terminal session
.PP
run an interactive terminal session with toru
.TP
\f[B]\-v\f[R], \f[B]\-\-verbose\f[R]
Verbose output
.TP
\f[B]\-V\f[R], \f[B]\-\-version\f[R]
display version info and exit
.TP
\f[B]\-p\f[R], \f[B]\-\-player\f[R]
set a custom video player.
Use {url} as a placeholder if the url is not the last argument in the
string
.TP
\f[B]\-P\f[R], \f[B]\-\-port\f[R]
set the port that torrents are streamed over
.SS Help Options
.TP
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
Show this help message
.SS search
search torrents and output them in a given format
.PP
search Nyaa.si for content
.PP
\f[B]Usage: toru [OPTIONS] search [search\-OPTIONS]\f[R]
.TP
\f[B]Aliases: se, q\f[R]
.SS search torrents and output them in a given format
.PP
search Nyaa.si for content
.TP
\f[B]\-b\f[R], \f[B]\-\-sort\-by\f[R]
sort results by a category [size|date|seeders|leechers|downloads]
.TP
\f[B]\-o\f[R], \f[B]\-\-sort\-order\f[R]
sort by ascending or descending: options [asc|desc]
.TP
\f[B]\-u\f[R], \f[B]\-\-user\f[R]
search for content by a user
.TP
\f[B]\-f\f[R], \f[B]\-\-filter\f[R]
filter content.
Options: [no\-remakes|trusted]
.TP
\f[B]\-p\f[R], \f[B]\-\-page\f[R]
which results page to display [default 1]
.TP
\f[B]\-s\f[R], \f[B]\-\-stream\f[R]
stream selected torrents after search
.TP
\f[B]\-d\f[R], \f[B]\-\-download\f[R]
download selected torrents after search
.TP
\f[B]\-m\f[R], \f[B]\-\-multi\f[R]
choose multiple torrents to queue for downloading or streaming
.TP
\f[B]\-n\f[R], \f[B]\-\-latest\f[R]
view the latest anime
.TP
\f[B]\-c\f[R], \f[B]\-\-category\f[R]
f
.TP
\f[B]\-l\f[R], \f[B]\-\-list\f[R]
list all accepted arguments for searching by categories
.TP
\f[B]\-j\f[R], \f[B]\-\-json\f[R]
output search results as Json
.TP
\f[B]\-P\f[R], \f[B]\-\-print\f[R]
output search results in a pretty and readable format to stdout
.TP
\f[B]\-i\f[R], \f[B]\-\-fzf\f[R]
interact with the search results using fzf
.SS Help Options
.TP
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
Show this help message
.SS stream
stream torrents
.PP
stream torrents
.PP
\f[B]Usage: toru [OPTIONS] stream [stream\-OPTIONS]\f[R]
.TP
\f[B]Aliases: s, play\f[R]
.SS stream torrents
.PP
stream torrents
.TP
\f[B]\-m\f[R], \f[B]\-\-magnet\f[R]
stream directly from the provided torrent magnet link
.TP
\f[B]\-t\f[R], \f[B]\-\-torrent\f[R]
stream directly from the provided torrent file or torrent URL
.TP
\f[B]\-\-rm\f[R]
remove cached files after exiting
.TP
\f[B]\-l\f[R], \f[B]\-\-latest\f[R]
view the latest anime and select an episode
.TP
\f[B]\-j\f[R], \f[B]\-\-from\-json\f[R]
resume selection from prior search saved as json [see: toru search
\-\-help]
.SS Help Options
.TP
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
Show this help message
.SS version
print version and debugging info
.PP
print version and debugging info
.PP
\f[B]Usage: toru [OPTIONS] version [version\-OPTIONS]\f[R]
.SS print version and debugging info
print version and debugging info
.TP
\f[B]\-v\f[R], \f[B]\-\-verbose\f[R]
Verbose output
.TP
\f[B]\-V\f[R], \f[B]\-\-version\f[R]
display version info and exit
.TP
\f[B]\-p\f[R], \f[B]\-\-player\f[R]
set a custom video player.
Use {url} as a placeholder if the url is not the last argument in the
string
.TP
\f[B]\-P\f[R], \f[B]\-\-port\f[R]
set the port that torrents are streamed over
.SS Help Options
.TP
\f[B]\-h\f[R], \f[B]\-\-help\f[R]
Show this help message