| blob | fa5477f2e106a4a5de6fa48d6c92b02229a29841 |
1 .\" This manpage has been automatically generated by docbook2man
2 .\" from a DocBook document. This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
4 .\" Please send any bug reports, improvements, comments, patches,
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "RTORRENT" "1" "14 May 2009" "BitTorrent client for ncurses" ""
8 .SH NAME
9 rtorrent \- a BitTorrent client for ncurses
10 .SH SYNOPSIS
12 \fBrtorrent\fR [ \fB-h\fR ] [ \fB-n\fR ] [ \fB-o key1=opt1,...\fR ] [ \fB-O key=opt\fR ] [ \fBURL | FILE\fR\fI ...\fR ]
14 .SH "DESCRIPTION"
15 .PP
16 \fBrtorrent\fR is a BitTorrent client for ncurses, using
17 the \fBlibtorrent\fR library. The client and library is
18 written in C++ with emphasis on speed and efficiency, while delivering
19 equivalent features to those found in GUI based clients in an ncurses
20 client.
21 .PP
22 Most of the options below have their own default unit in addition to
23 supporting B, K, M and G suffixes.
24 .SH "KEYBOARD CONTROL"
25 .PP
26 .SS "GLOBAL KEYS"
27 .TP
28 \fB^q\fR
29 Initiate shutdown, press again to force the shutdown and
30 skip sending the stop signal to trackers.
31 .TP
32 \fBup | down | left | right arrow keys\fR
33 .TP
34 \fB^P | ^N | ^B | ^F\fR
35 Select entries or change windows. The right arrow key or ^F is often
36 used for viewing details about the selected entry, while the left
37 arrow key or ^B often returns to the previous screen.
38 .TP
39 \fBa | s | d\fR
40 Increase the upload throttle by 1/5/50 KB.
41 .TP
42 \fBA | S | D\fR
43 Increase the download throttle by 1/5/50 KB.
44 .TP
45 \fBz | x | c\fR
46 Decrease the upload throttle by 1/5/50 KB.
47 .TP
48 \fBZ | X | C\fR
49 Decrease the download throttle by 1/5/50 KB.
50 .SS "MAIN VIEW KEYS"
51 .TP
52 \fB->\fR
53 View download.
54 .TP
55 \fB1 - 7\fR
56 Change view.
57 .TP
58 \fB^S\fR
59 Start download.
60 .TP
61 \fB^D\fR
62 Stop an active download, or remove a stopped download.
63 .TP
64 \fB^K\fR
65 Close a torrent and its files.
66 .TP
67 \fB^E\fR
68 Set the 'create/resize queued' flags on all files in a torrent. This
69 is necessary if the underlying files in a torrent have been deleted or
70 truncated, and thus rtorrent must recreate them.
71 .TP
72 \fB^R\fR
73 Initiate hash check of torrent.
74 .TP
75 \fB^O\fR
76 Change the destination directory of the download. The torrent must be
77 closed.
78 .TP
79 \fB^X\fR
80 Call commands or change settings.
81 .TP
82 \fB^B\fR
83 Set download to perform initial seeding. Only use when
84 you are the first and only seeder so far for the download.
85 .TP
86 \fB+ | -\fR
87 Change the priority of the download.
88 .TP
89 \fBbackspace\fR
90 Add torrent using an URL or file path. Use
91 \fBtab\fR to view directory content and do
92 auto-complete.
93 .TP
94 \fBl\fR
95 View log. Exit by pressing the space-bar.
96 .TP
97 \fBU\fR
98 Delete the file the torrent is tied to, and clear the association.
99 .TP
100 \fBI\fR
101 Toggle whether torrent ignores ratio settings.
102 .SS "DOWNLOAD VIEW KEYS"
103 .TP
104 \fB->\fR
105 View torrent file list. Use the space-bar to change the file priority
106 and \fB*\fR to change the priority of all
107 files. Use \fB/\fR to collapse the directories. OUTDATED
108 .TP
109 \fB1 | 2\fR
110 Adjust max uploads.
111 .TP
112 \fB3 | 4\fR
113 Adjust min peers.
114 .TP
115 \fB5 | 6\fR
116 Adjust max peers.
117 .TP
118 \fBu\fR
119 Display transfering blocks.
120 .TP
121 \fBi\fR
122 Display chunk rarity.
123 .TP
124 \fBo\fR
125 Display the tracker list. Cycle the trackers in a group with the
126 space-bar.
127 .TP
128 \fBp\fR
129 View peer and torrent information.
130 .TP
131 \fBt | T\fR
132 Initiate tracker request. Use capital T to force the request, ignoring
133 the "min interval" set by the tracker.
134 .TP
135 \fBk\fR
136 Disconnect peer.
137 .TP
138 \fB*\fR
139 Choke/Snub peer.
140 .SH "OPTIONS"
141 .TP
142 \fB-b \fIa.b.c.d\fB\fR
143 Bind listening socket and outgoing connections to this network
144 interface address.
145 .TP
146 \fB-d \fIdirectory\fB\fR
147 Set the default download directory. Defaults to "./".
148 .TP
149 \fB-h\fR
150 Display help and exit.
151 .TP
152 \fB-i \fIa.b.c.d\fB\fR
153 Set the address reported to the tracker.
154 .TP
155 \fB-n\fR
156 Don't load ~/.rtorrent.rc on startup.
157 .TP
158 \fB-o key1=opt1,...\fR
159 .TP
160 \fB-O key=opt\fR
161 Set any number of options, see the SETTINGS section. The options given
162 here override the resource files. Use capital \fB-O\fR
163 to allow comma in the option.
164 .TP
165 \fB-p \fIa-b\fB\fR
166 Try to open a listening port in the range \fBa\fR up to
167 and including \fBb\fR\&.
168 .TP
169 \fB-s \fIdirectory\fB\fR
170 Session management will be enabled and the torrent files for all open
171 downloads will be stored in this directory. Only one instance of
172 rtorrent should be used with each session directory, though at the
173 moment no locking is done. An empty string will disable the session
174 directory.
175 .SH "GENERAL SETTINGS"
176 .PP
177 .TP
178 \fBbind = \fIa.b.c.d\fB\fR
179 Bind listening socket and outgoing connections to this network
180 interface address.
181 .TP
182 \fBip = \fIa.b.c.d\fB\fR
183 .TP
184 \fBip = \fIhostname\fB\fR
185 Set the address reported to the tracker.
186 .TP
187 \fBport_range = \fIa-b\fB\fR
188 Try to open a listening port in the range \fBa\fR up to
189 and including \fBb\fR\&.
190 .TP
191 \fBport_random = \fIyes | no\fB\fR
192 Open the listening port at a random position in the port range.
193 .TP
194 \fBcheck_hash = \fIyes | no\fB\fR
195 Perform hash check on torrents that have finished downloading.
196 .TP
197 \fBdirectory = \fIdirectory\fB\fR
198 Set the default download directory. Defaults to "./".
199 .TP
200 \fBsession = \fIdirectory\fB\fR
201 Session management will be enabled and the torrent files for all open
202 downloads will be stored in this directory. Only one instance of
203 rtorrent can be used per session directory. An empty string will
204 disable the session directory.
205 .TP
206 \fBhttp_proxy = \fIurl\fB\fR
207 Use a http proxy. Use an empty string to disable.
208 .TP
209 \fBencoding_list = \fIencoding\fB\fR
210 Add a preferred filename encoding to the list. The encodings are
211 attempted in the order they are inserted, if none match the torrent
212 default is used.
213 .TP
214 \fBencryption = \fIoption\fB,\fI\&...\fB\fR
215 Set how rtorrent should deal with encrypted Bittorrent connections. By
216 default, encryption is disabled, equivalent to specifying the option
217 \fBnone\fR\&. Alternatively, any number of the following
218 options may be specified:
220 \fBallow_incoming\fR (allow incoming encrypted connections),
221 \fBtry_outgoing\fR (use encryption for outgoing connections),
222 \fBrequire\fR (disable unencrypted handshakes),
223 \fBrequire_RC4\fR (also disable plaintext transmission after the
224 initial encrypted handshake),
225 \fBenable_retry\fR (if the initial outgoing connection fails, retry
226 with encryption turned on if it was off or off if it was on),
227 \fBprefer_plaintext\fR (choose plaintext when peer offers a choice
228 between plaintext transmission and RC4 encryption, otherwise RC4 will be used).
229 .TP
230 \fBpeer_exchange = \fIyes | no\fB\fR
231 Enable/disable peer exchange for torrents that aren't marked private. Disabled by default.
232 .TP
233 \fBschedule = \fIid\fB,\fIstart\fB,\fIinterval\fB,\fIcommand\fB\fR
234 Call \fBcommand\fR every \fBinterval\fR
235 seconds, starting from \fBstart\fR\&. An
236 \fBinterval\fR of zero calls the task once, while a
237 \fBstart\fR of zero calls it immediately. Currently
238 \fBcommand\fR is forwarded to the option handler.
239 \fBstart\fR and \fBinterval\fR may
240 optionally use a time format, \fBdd:hh:mm:ss\fR\&. F.ex to
241 start a task every day at \fB18:00\fR, use
242 \fB18:00:00,24:00:00\fR\&.
243 .TP
244 \fBschedule_remove = \fIid\fB\fR
245 Delete \fBid\fR from the scheduler.
246 .TP
247 \fBstart_tied =\fR
248 Start torrents that are tied to filenames that have been re-added.
249 .TP
250 \fBstop_untied =\fR
251 .TP
252 \fBclose_untied =\fR
253 .TP
254 \fBremove_untied =\fR
255 Stop, close or remove the torrents that are tied to filenames that
256 have been deleted. Clear the association with the 'U' key.
257 .TP
258 \fBclose_low_diskspace = \fIspace\fB\fR
259 Close any active torrents on filesystems with less than
260 \fBspace\fR diskspace left. Use with
261 the \fBschedule\fR option. A default scheduled event
262 with id \fBlow_diskspace\fR is set to 500Mb.
263 .TP
264 \fBload = \fIfile\fB\fR
265 .TP
266 \fBload_verbose = \fIfile\fB\fR
267 .TP
268 \fBload_start = \fIfile\fB\fR
269 .TP
270 \fBload_start_verbose = \fIfile\fB\fR
271 Load and possibly start a file, or possibly multiple files by using the
272 wild-card "*". This is meant for use with
273 \fBschedule\fR, though ensure that the
274 \fBstart\fR is non-zero. The loaded file will be tied
275 to the filename provided.
276 .TP
277 \fBimport = \fIfile\fB\fR
278 .TP
279 \fBtry_import = \fIfile\fB\fR
280 Load a resource file. \fBtry_import\fR does not throw
281 torrent::input_error exception on bad input.
282 .TP
283 \fBstop_on_ratio = \fImin_ratio\fB\fR
284 .TP
285 \fBstop_on_ratio = \fImin_ratio\fB,\fImin_upload\fB\fR
286 .TP
287 \fBstop_on_ratio = \fImin_ratio\fB,\fImin_upload\fB,\fImax_ratio\fB\fR
288 Stop torrents when they reach the given upload ratio
289 \fBmin_ratio\fR in percent. If the optional
290 \fBmin_upload\fR is given, require a total
291 upload amount of this many bytes as well. If the optional
292 \fBmax_ratio\fR is given, stop the torrent
293 when reaching this ratio regardless of the total upload
294 amount. Exclude certain torrent by pressing
295 \fBShift+I\fR in the downlist list.
296 Use with the \fBschedule\fR option.
297 .TP
298 \fBon_insert = \fIid\fB,\fIcommand\fB\fR
299 .TP
300 \fBon_erase = \fIid\fB,\fIcommand\fB\fR
301 .TP
302 \fBon_open = \fIid\fB,\fIcommand\fB\fR
303 .TP
304 \fBon_close = \fIid\fB,\fIcommand\fB\fR
305 .TP
306 \fBon_start = \fIid\fB,\fIcommand\fB\fR
307 .TP
308 \fBon_stop = \fIid\fB,\fIcommand\fB\fR
309 .TP
310 \fBon_hash_queued = \fIid\fB,\fIcommand\fB\fR
311 .TP
312 \fBon_hash_removed = \fIid\fB,\fIcommand\fB\fR
313 .TP
314 \fBon_hash_done = \fIid\fB,\fIcommand\fB\fR
315 .TP
316 \fBon_finished = \fIid\fB,\fIcommand\fB\fR
317 Call a command on a download when its state changes. Only a subset of
318 commands are available.
319 .SH "THROTTLE SETTINGS"
320 .TP
321 \fBupload_rate = \fIKB\fB\fR
322 .TP
323 \fBdownload_rate = \fIKB\fB\fR
324 Set the maximum global uploand and download rates.
325 .TP
326 \fBmin_peers = \fIvalue\fB\fR
327 .TP
328 \fBmax_peers = \fIvalue\fB\fR
329 Set the minimum and maximum number of peers to allow in each download.
330 .TP
331 \fBmin_peers_seed = \fIvalue\fB\fR
332 .TP
333 \fBmax_peers_seed = \fIvalue\fB\fR
334 Set the minimum nad maximum number of peers to allow while seeding, or
335 -1 (default) to use max_peers.
336 .TP
337 \fBmax_uploads = \fIvalue\fB\fR
338 Set the maximum number of simultaneous uploads per download.
339 .TP
340 \fBmax_uploads_div = \fIvalue\fB\fR
341 .TP
342 \fBmax_downloads_div = \fIvalue\fB\fR
343 Change the divider used to calculate the max upload and download slots
344 to use when the throttle is changed. Disable by
345 setting \fB0\fR\&.
346 .TP
347 \fBmax_uploads_global = \fIvalue\fB\fR
348 .TP
349 \fBmax_downloads_global = \fIvalue\fB\fR
350 Max upload and download slots allowed. Disable by
351 setting \fB0\fR\&.
352 .TP
353 \fBthrottle_up = \fIname\fB, \fIupload_rate\fB\fR
354 .TP
355 \fBthrottle_down = \fIname\fB, \fIdownload_rate\fB\fR
356 Define secondary throttle and/or set the given upload or download rate. Attach to a download with the d.set_throttle_name=name command
357 or switch throttles with Ctrl-T. Download must be stopped when changing throttles. Note that secondary throttles only work if the
358 global upload/download is throttled. Setting a download to use the \fBNULL\fR throttle makes the download unthrottled
359 even when there is a global throttle. Note that this special case bypasses the global throttle entirely, and as such its rate and
360 transfer amounts are not included in the global statistics.
361 .TP
362 \fBthrottle_ip = \fIname\fB, \fIhost\fB\fR
363 .TP
364 \fBthrottle_ip = \fIname\fB, \fInetwork/prefix\fB\fR
365 .TP
366 \fBthrottle_ip = \fIname\fB, \fIstart\fB, \fIend\fB\fR
367 Use the given secondary throttle for a host, CIDR network or IP range. All peers with a matching IP will use this throttle instead
368 of the global throttle or a custom download throttle. The name may be \fBNULL\fR to make these peers unthrottled, with
369 the same caveats as explained above.
370 .SH "TRACKER RELATED SETTINGS"
371 .PP
372 Tracker related settings.
373 .TP
374 \fBenable_trackers = \fIyes\fB\fR
375 Set to \fBno\fR to disable all tracker requests. Useful
376 for disabling rtorrent with the \fBschedule\fR command.
377 .TP
378 \fBtracker_dump = \fIfilename\fB\fR
379 Dump tracker requests to \fBfilename\fR, disable by
380 supplying an empty string. Only torrents loaded while
381 \fBtracker_dump\fR contains a non-empty string will be
382 logged at the moment, although disabling it will work as expected.
383 .TP
384 \fBtracker_numwant = \fInumber\fB\fR
385 Set the numwant field sent to the tracker, which indicates how many
386 peers we want. A negative value disables this feature.
387 .TP
388 \fBuse_udp_trackers = \fIyes\fB\fR
389 Use UDP trackers. Disable if you are behind a firewall, etc, that does
390 not allow connections to UDP trackers.
391 .TP
392 \fBdht = \fIdisabled|off|auto|on\fB\fR
393 Support for querying the distributed hash table (DHT) to find peers for trackerless
394 torrents or when all trackers are down. Set to \fBdisable\fR to completely
395 disable DHT, \fBoff\fR (default) to enable DHT but to not start the
396 DHT server, \fBauto\fR to automatically start and stop the DHT server
397 as needed or \fBon\fR for permanently keeping the DHT server running.
398 When set to automatic, the DHT server will start up when the first non-private torrent
399 is started, and will stop 15-30 minutes after the last non-private torrent is
400 stopped (or when rTorrent quits). For DHT to work, a session directory must be set (for
401 saving the DHT cache).
402 .TP
403 \fBdht_port = \fInumber\fB\fR
404 Set the UDP listen port for DHT. Defaults to 6881.
405 .TP
406 \fBdht_add_node = \fIhost[:port]\fB\fR
407 Not intended for use in the configuration file but as one-time option in the
408 client or on the command line to bootstrap an empty DHT node table. Contacts
409 the given node and attempts to bootstrap from it if it replies.
410 The port is optional, with port 6881 being used by default.
411 .TP
412 \fBhttp_capath = \fIpath\fB\fR
413 .TP
414 \fBhttp_cacert = \fIfilename\fB\fR
415 Set the certificates to use in http requests. See Curl's
416 CURLOPT_CAPATH and CURLOPT_CAINFO options for further information.
417 .SH "USER-INTERFACE SETTINGS"
418 .PP
419 Display related settings.
420 .TP
421 \fBview_add = \fIname\fB\fR
422 Create a new view.
423 .TP
424 \fBview_sort = \fIname\fB\fR
425 .TP
426 \fBview_sort = \fIname\fB,\fIseconds\fB\fR
427 Sort a view according the the criteria set by
428 \fBview_sort_current\fR\&. If the optional argument is
429 supplied, the view is not sorted if a change happened during the last
430 \fBseconds\fR\&. This command is meant to be used with
431 \fBschedule\fR\&.
432 .TP
433 \fBview_sort_new = \fIname\fB,\fI\&...\fB\fR
434 .TP
435 \fBview_sort_current = \fIname\fB,\fI\&...\fB\fR
436 Set the sorting criteria for when new elements inserted or
437 \fBview_sort\fR is called. The list can contain any
438 number of criteria, including zero, from the following:
440 \fBname\fR, \fBname_reverse\fR,
441 \fBstopped\fR, \fBstarted\fR,
442 \fBcomplete\fR, \fBincomplete\fR,
443 \fBstate_changed\fR,
444 \fBstate_changed_reverse\fR
445 .TP
446 \fBkey_layout = \fIqwerty|azerty|qwertz|dvorak\fB\fR
447 Change the key-bindings.
448 .SH "FILE-SYSTEM SETTINGS"
449 .PP
450 File-system related settings.
451 .TP
452 \fBmax_file_size = \fIsize\fB\fR
453 Set the maximum size a file can have. Disable by
454 passing \fB-1\fR\&.
455 .TP
456 \fBsplit_file_size = \fIsize\fB\fR
457 Split files in a torrent larger than \fBsize\fR into
458 seperate files. Disable by passing \fB-1\fR\&.
459 .TP
460 \fBsplit_suffix = \fIstring\fB\fR
461 Set the suffix used on split files. Defaults
462 to \fB\&.part\fR\&.
463 .SH "DOWNLOAD SETTINGS"
464 .PP
465 Settings that require a download as a target, the options need to be
466 called through f.ex \fBon_finished\fR\&.
467 .TP
468 \fBcreate_link = \fItype\fB,\fIpath\fB,\fIsuffix\fB\fR
469 .TP
470 \fBdelete_link = \fItype\fB,\fIpath\fB,\fIsuffix\fB\fR
471 Create or delete a symbolic link. The link path is the concatenation
472 of \fBpath\fR, the result of
473 the \fBtype\fR on the download,
474 and \fBsuffix\fR\&.
476 Available types are; \fBbase_path\fR uses the base path
477 of the download, \fBbase_filename\fR uses the base
478 filename of the download, \fBtied\fR uses the path of
479 the file the download is tied to, see \fBstart_tied\fR\&.
480 .SH "ADVANCED SETTINGS"
481 .PP
482 This list contains settings users shouldn't need to touch, some may
483 even cause crashes or similar if incorrectly set.
484 .TP
485 \fBhash_read_ahead = \fIMB\fB\fR
486 Configure how far ahead we ask the kernel to read when doing hash
487 checking. The hash checker uses madvise(..., MADV_WILLNEED) for the
488 requests.
489 .TP
490 \fBhash_interval = \fIms\fB\fR
491 Interval between attempts to check the hash when the chunk is not in
492 memory, in milliseconds.
493 .TP
494 \fBhash_max_tries = \fItries\fB\fR
495 Number of attempts to check the hash while using the mincore status,
496 before forcing. Overworked systems might need lower values to get a
497 decent hash checking rate.
498 .TP
499 \fBsafe_sync = \fIyes|no\fB\fR
500 Always use MS_SYNC rather than MS_ASYNC when syncing chunks. This may
501 be nessesary in case of filesystem bugs like NFS in linux ~2.6.13.
502 .TP
503 \fBmax_open_files = \fIvalue\fB\fR
504 Number of files to simultaneously keep open. LibTorrent dynamically
505 opens and closes files as necessary when mapping files to
506 memory. Default is based on sysconf(_SC_OPEN_MAX).
507 You probably only think you know what this option does, so don't touch
508 it.
509 .TP
510 \fBmax_open_sockets = \fIvalue\fB\fR
511 Number of network sockets to simultaneously keep open. This value is
512 set to a reasonable value based on \fBsysconf(_SC_OPEN_MAX)\fR\&.
513 .TP
514 \fBmax_open_http = \fIvalue\fB\fR
515 Number of sockets to simultaneously keep open. This value is set
516 to \fB32\fR by default.
517 .TP
518 \fBmax_memory_usage = \fIbytes\fB\fR
519 Set the max amount of memory space used to mapping file chunks. This
520 may also be set using \fBulimit -m\fR where 3/4 will be
521 allocated to file chunks.
522 .TP
523 \fBsend_buffer_size = \fIvalue\fB\fR
524 .TP
525 \fBreceive_buffer_size = \fIvalue\fB\fR
526 Adjust the send and receive buffer size for socket.
527 .TP
528 \fBumask = \fI0022\fB\fR
529 Set the umask for this process, which is applied to all files created
530 by the program.
531 .TP
532 \fBcwd = \fIdirectory\fB\fR
533 Changes the working directory of the process using
534 \fBchdir\fR\&.
535 .TP
536 \fBsession_on_completion = \fIyes\fB\fR
537 Controls if the session torrent is saved when a torrent finishes. By
538 default on.
539 .TP
540 \fBsession_lock = \fIyes\fB\fR
541 Controls if a lock file is created in the session directory on startup.
542 .TP
543 \fBsession_save = \fR
544 Save the session files for all downloads.
545 .TP
546 \fBtos = \fIdefault|lowdelay|throughput|reliability|mincost\fB\fR
547 .TP
548 \fBtos = \fIhex\fB\fR
549 Change the TOS of peer connections, by default set to
550 \fBthroughput\fR\&. If the option is set to
551 \fBdefault\fR then the system default TOS is used. A
552 hex value may be used for non-standard settings.
553 .TP
554 \fBhandshake_log = \fIyes\fB\fR
555 Enable logging of the peer handshake. This generates a large number of
556 log messages, but may be useful to debug connection problems.
557 .SH "AUTHORS"
558 .PP
560 Jari "Rakshasa" Sundell <jaris@ifi.uio.no>