1+ <!DOCTYPE html>
2+ < html lang ="en ">
3+ < head >
4+
5+
6+ < meta charset ="utf-8 ">
7+ < meta http-equiv ="X-UA-Compatible " content ="IE=edge ">
8+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
9+
10+
11+ < link rel ="canonical " href ="https://alexpdev.github.io/torrentfile/cli/ ">
12+ < link rel ="shortcut icon " href ="../img/favicon.ico ">
13+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0 " />
14+ < title > CLI - TorrentFile</ title >
15+ < link href ="../css/bootstrap-3.3.7.min.css " rel ="stylesheet ">
16+ < link href ="../css/font-awesome-4.7.0.css " rel ="stylesheet ">
17+ < link href ="../css/base.css " rel ="stylesheet ">
18+ < link rel ="stylesheet " href ="../css/highlight.css ">
19+ < link href ="//use.fontawesome.com/releases/v5.8.1/css/all.css " rel ="stylesheet ">
20+ < link href ="//use.fontawesome.com/releases/v5.8.1/css/v4-shims.css " rel ="stylesheet ">
21+ < link href ="../css/mkapi-common.css " rel ="stylesheet ">
22+ < link href ="../assets/_mkdocstrings.css " rel ="stylesheet ">
23+ < link href ="../stylesheets/extra.css " rel ="stylesheet ">
24+ <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
25+ <!--[if lt IE 9]>
26+ <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
27+ <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
28+ <![endif]-->
29+
30+ < script src ="../js/jquery-3.2.1.min.js "> </ script >
31+ < script src ="../js/bootstrap-3.3.7.min.js "> </ script >
32+ < script src ="../js/highlight.pack.js "> </ script >
33+
34+ < base target ="_top ">
35+ < script >
36+ var base_url = '..' ;
37+ var is_top_frame = false ;
38+
39+ var pageToc = [
40+ { title : "TorrentFile CLI Menu" , url : "#_top" , children : [
41+ { title : "torrentfile -h" , url : "#torrentfile-h" } ,
42+ { title : "torrentfile e -h" , url : "#torrentfile-e-h" } ,
43+ ] } ,
44+ ] ;
45+
46+ </ script >
47+ < script src ="../js/base.js "> </ script >
48+ < script src ="../js/mkapi.js "> </ script >
49+ </ head >
50+
51+ < body >
52+ < script >
53+ if ( is_top_frame ) { $ ( 'body' ) . addClass ( 'wm-top-page' ) ; }
54+ </ script >
55+
56+
57+
58+ < div class ="container-fluid wm-page-content ">
59+ < a name ="_top "> </ a >
60+
61+
62+
63+
64+
65+
66+
67+ < div class ="row wm-article-nav-buttons " role ="navigation " aria-label ="navigation ">
68+
69+ < div class ="wm-article-nav pull-right ">
70+ < a href ="../examples/ " class ="btn btn-xs btn-default pull-right ">
71+ Next
72+ < i class ="fa fa-chevron-right " aria-hidden ="true "> </ i >
73+ </ a >
74+ < a href ="../examples/ " class ="btn btn-xs btn-link ">
75+ Examples
76+ </ a >
77+ </ div >
78+
79+ < div class ="wm-article-nav ">
80+ < a href ="../api/ " class ="btn btn-xs btn-default pull-left ">
81+ < i class ="fa fa-chevron-left " aria-hidden ="true "> </ i >
82+ Previous</ a > < a href ="../api/ " class ="btn btn-xs btn-link ">
83+ API
84+ </ a >
85+ </ div >
86+
87+ </ div >
88+
89+
90+
91+ < h1 id ="torrentfile-cli-menu "> TorrentFile CLI Menu</ h1 >
92+ < h2 id ="torrentfile-h "> < code > torrentfile -h</ code > </ h2 >
93+ < p > ```bash:
94+ usage: TorrentFile [-h][-i] [-V][-v]
95+ {c,create,new,e,edit,m,magnet,r,recheck,check} ...</ p >
96+ < p > CLI Tool for creating, checking and editing Bittorrent meta files. Supports all meta file versions including hybrid files.</ p >
97+ < p > optional arguments:
98+ -h, --help show this help message and exit
99+ -i, --interactive select program options interactively
100+ -V, --version show program version and exit
101+ -v, --verbose output debug information</ p >
102+ < p > Actions:
103+ Each sub-command triggers a specific action.</ p >
104+ < p > {c,create,new,e,edit,m,magnet,r,recheck,check}
105+ c (create, new) Create a torrent meta file.</ p >
106+ < pre > < code > e (edit) Edit existing torrent meta file.
107+
108+ m (magnet) Create magnet url from an existing Bittorrent meta file.
109+
110+ r (recheck, check) Calculate amount of torrent meta file's content is found on disk.
111+ </ code > </ pre >
112+ < pre > < code >
113+ ## `torrentfile c -h`
114+
115+ ```bash:
116+ usage: TorrentFile c [-h] [-a <url> [<url> ...]] [-p] [-s <source>] [-m]
117+ [-c <comment>] [-o <path>] [-t <url> [<url> ...]]
118+ [--progress] [--meta-version <int>]
119+ [--piece-length <int>] [-w <url> [<url> ...]]
120+ <content>
121+
122+ positional arguments:
123+ <content> path to content file or directory
124+
125+ optional arguments:
126+ -h, --help show this help message and exit
127+ -a <url> [<url> ...], --announce <url> [<url> ...] Alias for -t/--tracker
128+ -p, --private Create a private torrent meta file
129+ -s <source>, --source <source> specify source tracker
130+ -m, --magnet output Magnet Link after creation completes
131+ -c <comment>, --comment <comment> include a comment in file metadata
132+ -o <path>, --out <path> Output path for created .torrent file
133+ -t <url> [<url> ...], --tracker <url> [<url> ...] One or more Bittorrent tracker announce url(s).
134+ --progress Enable showing the progress bar during torrent creation.
135+ (Minimially impacts the duration of torrent file creation.)
136+
137+ --meta-version <int> Bittorrent metafile version.
138+ Options = 1, 2 or 3.
139+ (1) = Bittorrent v1 (Default)
140+ (2) = Bittorrent v2
141+ (3) = Bittorrent v1 & v2 hybrid
142+
143+ --piece-length <int> Fixed amount of bytes for each chunk of data. (Default: None)
144+ Acceptable input values include integers 14-24, which
145+ will be interpreted as the exponent for 2^n, or any perfect
146+ power of two integer between 16Kib and 16MiB (inclusive).
147+ Examples:: [--piece-length 14] [-l 20] [-l 16777216]
148+
149+ -w <url> [<url> ...], --web-seed <url> [<url> ...] One or more url(s) linking to a http server hosting
150+ the torrent contents. This is useful if the torrent
151+ tracker is ever unreachable. Example:: [-w url1 [url2 [url3]]]
152+ </ code > </ pre >
153+ < h2 id ="torrentfile-e-h "> < code > torrentfile e -h</ code > </ h2 >
154+ < p > ```bash:
155+ usage: TorrentFile e [-h] [--tracker < url > [< url > ...]]
156+ [--web-seed < url > [< url > ...]][--private]
157+ [--comment < comment > ] [--source < source > ]
158+ <*.torrent></ p >
159+ < p > positional arguments:
160+ << em > .torrent> path to </ em > .torrent file</ p >
161+ < p > optional arguments:
162+ -h, --help show this help message and exit
163+ --tracker < url > [< url > ...] replace current list of tracker/announce urls with one or more space
164+ seperated Bittorrent tracker announce url(s).</ p >
165+ < p > --web-seed < url > [< url > ...] replace current list of web-seed urls with one or more space seperated url(s)</ p >
166+ < p > --private If currently private, will make it public, if public then private.
167+ --comment < comment > replaces any existing comment with < comment >
168+ --source < source > replaces current source with < source > </ p >
169+ < pre > < code >
170+ ## `torrentfile m -h`
171+
172+ ```bash:
173+ usage: TorrentFile m [-h] <*.torrent>
174+
175+ positional arguments:
176+ <*.torrent> path to Bittorrent meta file.
177+
178+ optional arguments:
179+ -h, --help show this help message and exit
180+ usage: TorrentFile r [-h] <*.torrent> content
181+ </ code > </ pre >
182+
183+ < br >
184+
185+
186+
187+
188+
189+
190+
191+ < div class ="row wm-article-nav-buttons " role ="navigation " aria-label ="navigation ">
192+
193+ < div class ="wm-article-nav pull-right ">
194+ < a href ="../examples/ " class ="btn btn-xs btn-default pull-right ">
195+ Next
196+ < i class ="fa fa-chevron-right " aria-hidden ="true "> </ i >
197+ </ a >
198+ < a href ="../examples/ " class ="btn btn-xs btn-link ">
199+ Examples
200+ </ a >
201+ </ div >
202+
203+ < div class ="wm-article-nav ">
204+ < a href ="../api/ " class ="btn btn-xs btn-default pull-left ">
205+ < i class ="fa fa-chevron-left " aria-hidden ="true "> </ i >
206+ Previous</ a > < a href ="../api/ " class ="btn btn-xs btn-link ">
207+ API
208+ </ a >
209+ </ div >
210+
211+ </ div >
212+
213+ < br >
214+ </ div >
215+
216+ < footer class ="container-fluid wm-page-content ">
217+ < p >
218+ < a href ="https://github.com/alexpdev/torrentfile/edit/master/docs/cli.md "> < i class ="fa fa-github "> </ i >
219+ Edit on GitHub</ a >
220+ </ p > < p > alexpdev 2021</ p >
221+ < p > Documentation built with < a href ="http://www.mkdocs.org/ "> MkDocs</ a > using < a href ="https://github.com/gristlabs/mkdocs-windmill "> Windmill</ a > theme by Grist Labs.</ p >
222+ </ footer >
223+
224+ </ body >
225+ </ html >
0 commit comments