1RTORRENT(1) RTORRENT(1)
2
6 rtorrent - a BitTorrent client for ncurses
7
9 rtorrent [ -h ] [ -n ] [ -o key1=opt1,... ] [ -O key=opt ] [ URL | FILE
10 ... ]
11
14 rtorrent is a BitTorrent client for ncurses, using the libtorrent
15 library. The client and library is written in C++ with emphasis on
16 speed and efficiency, while delivering equivalent features to those
17 found in GUI based clients in an ncurses client.
18 Most of the options below have their own default unit in addition to
20 supporting B, K, M and G suffixes.
21
23 GLOBAL KEYS
24 ^q Initiate shutdown, press again to force the shutdown and skip
25 sending the stop signal to trackers.
26 up | down | left | right arrow keys
28 ^P | ^N | ^B | ^F
30 Select entries or change windows. The right arrow key or ^F is
31 often used for viewing details about the selected entry, while
32 the left arrow key or ^B often returns to the previous screen.
33 a | s | d
35 Increase the upload throttle by 1/5/50 KB.
36 A | S | D
38 Increase the download throttle by 1/5/50 KB.
39 z | x | c
41 Decrease the upload throttle by 1/5/50 KB.
42 Z | X | C
44 Decrease the download throttle by 1/5/50 KB.
45 MAIN VIEW KEYS
47 -> View download.
48 1 - 7 Change view.
50 ^S Start download.
52 ^D Stop an active download, or remove a stopped download.
54 ^K Close a torrent and its files.
56 ^R Initiate hash check of torrent.
58 ^O Change the destination directory of the download. The torrent
60 must be closed.
61 ^X Call commands or change settings.
63 + | - Change the priority of the download.
65 backspace
67 Add torrent using an URL or file path. Use tab to view directory
68 content and do auto-complete.
69 l View log. Exit by pressing the space-bar.
71 U Delete the file the torrent is tied to, and clear the associa‐
73 tion.
74 I Toggle whether torrent ignores ratio settings.
76 DOWNLOAD VIEW KEYS
78 -> View torrent file list. Use the space-bar to change the file
79 priority and * to change the priority of all files. Use / to
80 collapse the directories. OUTDATED
81 1 | 2 Adjust max uploads.
83 3 | 4 Adjust min peers.
85 5 | 6 Adjust max peers.
87 u Display transfering blocks.
89 i Display chunk rarity.
91 o Display the tracker list. Cycle the trackers in a group with the
93 space-bar.
94 p View peer and torrent information.
96 t | T Initiate tracker request. Use capital T to force the request,
98 ignoring the "min interval" set by the tracker.
99 k Disconnect peer.
101 * Choke/Snub peer.
103
105 -b a.b.c.d
106 Bind listening socket and outgoing connections to this network
107 interface address.
108 -d directory
110 Set the default download directory. Defaults to "./".
111 -h Display help and exit.
113 -i a.b.c.d
115 Set the address reported to the tracker.
116 -n Don't load ~/.rtorrent.rc on startup.
118 -o key1=opt1,...
120 -O key=opt
122 Set any number of options, see the SETTINGS section. The options
123 given here override the resource files. Use capital -O to allow
124 comma in the option.
125 -p a-b Try to open a listening port in the range a up to and including
127 b.
128 -s directory
130 Session management will be enabled and the torrent files for all
131 open downloads will be stored in this directory. Only one
132 instance of rtorrent should be used with each session directory,
133 though at the moment no locking is done. An empty string will
134 disable the session directory.
135
137 bind = a.b.c.d
138 Bind listening socket and outgoing connections to this network
139 interface address.
140 ip = a.b.c.d
142 ip = hostname
144 Set the address reported to the tracker.
145 port_range = a-b
147 Try to open a listening port in the range a up to and including
148 b.
149 port_random = yes | no
151 Open the listening port at a random position in the port range.
152 check_hash = yes | no
154 Perform hash check on torrents that have finished downloading.
155 directory = directory
157 Set the default download directory. Defaults to "./".
158 session = directory
160 Session management will be enabled and the torrent files for all
161 open downloads will be stored in this directory. Only one
162 instance of rtorrent should be used with each session directory,
163 though at the moment no locking is done. An empty string will
164 disable the session directory.
165 http_proxy = url
167 Use a http proxy. Use an empty string to disable.
168 encoding_list = encoding
170 Add a preferred filename encoding to the list. The encodings are
171 attempted in the order they are inserted, if none match the tor‐
172 rent default is used.
173 encryption = option,...
175 Set how rtorrent should deal with encrypted Bittorrent connec‐
176 tions. By default, encryption is disabled, equivalent to speci‐
177 fying the option none. Alternatively, any number of the follow‐
178 ing options may be specified:
179 allow_incoming (allow incoming encrypted connections), try_out‐
181 going (use encryption for outgoing connections), require (dis‐
182 able unencrypted handshakes), require_RC4 (also disable plain‐
183 text transmission after the initial encrypted handshake),
184 enable_retry (if the initial outgoing connection fails, retry
185 with encryption turned on if it was off or off if it was on),
186 prefer_plaintext (choose plaintext when peer offers a choice
187 between plaintext transmission and RC4 encryption, otherwise RC4
188 will be used).
189 schedule = id,start,interval,command
191 Call command every interval seconds, starting from start. An
192 interval of zero calls the task once, while a start of zero
193 calls it immediately. Currently command is forwarded to the
194 option handler. start and interval may optionally use a time
195 format, dd:hh:mm:ss. F.ex to start a task every day at 18:00,
196 use 18:00:00,24:00:00.
197 schedule_remove = id
199 Delete id from the scheduler.
200 start_tied =
202 Start torrents that are tied to filenames that have been re-
203 added.
204 stop_untied =
206 close_untied =
208 remove_untied =
210 Stop, close or remove the torrents that are tied to filenames
211 that have been deleted. Clear the association with the 'U' key.
212 close_low_diskspace = space
214 Close any active torrents on filesystems with less than space
215 diskspace left. Use with the schedule option.
216 load = file
218 load_verbose = file
220 load_start = file
222 load_start_verbose = file
224 Load and possibly start a file, or possibly multiple files by
225 using the wild-card "*". This is meant for use with schedule,
226 though ensure that the start is non-zero. The loaded file will
227 be tied to the filename provided.
228 import = file
230 try_import = file
232 Load a resource file. try_import does not throw tor‐
233 rent::input_error exception on bad input.
234 stop_on_ratio = min_ratio
236 stop_on_ratio = min_ratio,min_upload
238 stop_on_ratio = min_ratio,min_upload,max_ratio
240 Stop torrents when they reach the given upload ratio min_ratio
241 in percent. If the optional min_upload is given, require a total
242 upload amount of this many bytes as well. If the optional
243 max_ratio is given, stop the torrent when reaching this ratio
244 regardless of the total upload amount. Exclude certain torrent
245 by pressing Shift+I in the downlist list. Use with the schedule
246 option.
247 on_insert = id,command
249 on_erase = id,command
251 on_open = id,command
253 on_close = id,command
255 on_start = id,command
257 on_stop = id,command
259 on_hash_queued = id,command
261 on_hash_removed = id,command
263 on_hash_done = id,command
265 on_finished = id,command
267 Call a command on a download when its state changes. Only a sub‐
268 set of commands are available.
269
271 upload_rate = KB
272 download_rate = KB
274 Set the maximum global uploand and download rates.
275 min_peers = value
277 max_peers = value
279 Set the minimum and maximum number of peers to allow in each
280 download.
281 min_peers_seed = value
283 max_peers_seed = value
285 Set the minimum nad maximum number of peers to allow while seed‐
286 ing, or -1 (default) to use max_peers.
287 max_uploads = value
289 Set the maximum number of simultaneous uploads per download.
290 max_uploads_div = value
292 max_downloads_div = value
294 Change the divider used to calculate the max upload and download
295 slots to use when the throttle is changed. Disable by setting 0.
296 max_uploads_global = value
298 max_downloads_global = value
300 Max upload and download slots allowed. Disable by setting 0.
301
303 Tracker related settings.
304 enable_trackers = yes
306 Set to no to disable all tracker requests. Useful for disabling
307 rtorrent with the schedule command.
308 tracker_dump = filename
310 Dump tracker requests to filename, disable by supplying an empty
311 string. Only torrents loaded while tracker_dump contains a non-
312 empty string will be logged at the moment, although disabling it
313 will work as expected.
314 tracker_numwant = number
316 Set the numwant field sent to the tracker, which indicates how
317 many peers we want. A negative value disables this feature.
318 use_udp_trackers = yes
320 Use UDP trackers. Disable if you are behind a firewall, etc,
321 that does not allow connections to UDP trackers.
322
324 Display related settings.
325 view_add = name
327 Create a new view.
328 view_sort = name
330 view_sort = name,seconds
332 Sort a view according the the criteria set by view_sort_current.
333 If the optional argument is supplied, the view is not sorted if
334 a change happened during the last seconds. This command is meant
335 to be used with schedule.
336 view_sort_new = name,...
338 view_sort_current = name,...
340 Set the sorting criteria for when new elements inserted or
341 view_sort is called. The list can contain any number of crite‐
342 ria, including zero, from the following:
343 name, name_reverse, stopped, started, complete, incomplete,
345 state_changed, state_changed_reverse
346 view_filter = name,...
348 Set a list of filter to apply when new new downloads are added
349 and when view_sort is called. All filters must match for the
350 download to be included.
351 stopped, started, complete, incomplete,
353 key_layout = qwerty|azerty|qwertz|dvorak
355 Change the key-bindings.
356
358 File-system related settings.
359 max_file_size = size
361 Set the maximum size a file can have. Disable by passing -1.
362 split_file_size = size
364 Split files in a torrent larger than size into seperate files.
365 Disable by passing -1.
366 split_suffix = string
368 Set the suffix used on split files. Defaults to .part.
369
371 Settings that require a download as a target, the options need to be
372 called through f.ex on_finished.
373 create_link = type,path,suffix
375 delete_link = type,path,suffix
377 Create or delete a symbolic link. The link path is the concate‐
378 nation of path, the result of the type on the download, and suf‐
379 fix.
380 Available types are; base_path uses the base path of the down‐
382 load, base_filename uses the base filename of the download, tied
383 uses the path of the file the download is tied to, see
384 start_tied.
385
387 This list contains settings users shouldn't need to touch, some may
388 even cause crashes or similar if incorrectly set.
389 hash_read_ahead = MB
391 Configure how far ahead we ask the kernel to read when doing
392 hash checking. The hash checker uses madvise(..., MADV_WILLNEED)
393 for the requests.
394 hash_interval = ms
396 Interval between attempts to check the hash when the chunk is
397 not in memory, in milliseconds.
398 hash_max_tries = tries
400 Number of attempts to check the hash while using the mincore
401 status, before forcing. Overworked systems might need lower val‐
402 ues to get a decent hash checking rate.
403 safe_sync = yes|no
405 Always use MS_SYNC rather than MS_ASYNC when syncing chunks.
406 This may be nessesary in case of filesystem bugs like NFS in
407 linux ~2.6.13.
408 max_open_files = value
410 Number of files to simultaneously keep open. LibTorrent dynami‐
411 cally opens and closes files as necessary when mapping files to
412 memory. Default is based on sysconf(_SC_OPEN_MAX). You probably
413 only think you know what this option does, so don't touch it.
414 max_open_sockets = value
416 Number of network sockets to simultaneously keep open. This
417 value is set to a reasonable value based on
418 sysconf(_SC_OPEN_MAX).
419 max_open_http = value
421 Number of sockets to simultaneously keep open. This value is set
422 to 32 by default.
423 max_memory_usage = bytes
425 Set the max amount of memory space used to mapping file chunks.
426 This may also be set using ulimit -m where 3/4 will be allocated
427 to file chunks.
428 send_buffer_size = value
430 receive_buffer_size = value
432 Adjust the send and receive buffer size for socket.
433 umask = 0644
435 Set the umask for this process, which is applied to all files
436 created by the program.
437 working_directory = directory
439 Changes the working directory of the process using chdir.
440 session_on_completion = yes
442 Controls if the session torrent is saved when a torrent fin‐
443 ishes. By default on.
444 session_lock = yes
446 Controls if a lock file is created in the session directory on
447 startup.
448 session_save =
450 Save the session files for all downloads.
451 tos = default|lowdelay|throughput|reliability|mincost
453 tos = hex
455 Change the TOS of peer connections, by default set to through‐
456 put. If the option is set to default then the system default TOS
457 is used. A hex value may be used for non-standard settings.
458 handshake_log = yes
460 Enable logging of the peer handshake. This generates a large
461 number of log messages, but may be useful to debug connection
462 problems.
463
465 Jari "Rakshasa" Sundell <jaris@ifi.uio.no>
466BitTorrent client for ncurses 24 March 2007 RTORRENT(1)