rtorrent 1 June 25th, 2005 BitTorrent client for ncurses rtorrent a BitTorrent client for ncurses rtorrent -h -n -o key1=opt1,... -O key=opt URL | FILE rtorrent is a BitTorrent client for ncurses, using the libtorrent library. The client and library is written in C++ with emphasis on speed and efficiency, while delivering equivalent features to those found in GUI based clients in an ncurses client. ^q Initiate shutdown, press again to force the shutdown and skip sending the stop signal to trackers. up | down Select item. <- Go back to the previous screen. a | s | d Increase the upload throttle by 1/5/50 KB. A | S | D Increase the download throttle by 1/5/50 KB. z | x | c Decrease the upload throttle by 1/5/50 KB. Z | X | C Decrease the download throttle by 1/5/50 KB. -> View download. 1 - 7 Change view. ^S Start download. ^D Stop an active download, or remove a stopped download. ^K Close a torrent and its files. ^R Initiate hash check of torrent. ^O Change the destination directory of the download. The torrent must be closed. + | - Change the priority of the download. backspace Add torrent using an URL or file path. Use tab to view directory content and do auto-complete. l View log. Exit by pressing the space-bar. ^P Call commands or change settings. I Toggle whether torrent ignores ratio settings. -> View torrent file list. Use the space-bar to change the file priority and * to change the priority of all files. 1 | 2 Adjust max uploads. 3 | 4 Adjust min peers. 5 | 6 Adjust max peers. i Display chunk rarity. o Display the tracker list. Cycle the trackers in a group with the space-bar. p View peer and torrent information. t | T Initiate tracker request. Use capital T to force the request, ignoring the "min interval" set by the tracker. k Disconnect peer. * Choke/Snub peer. -b a.b.c.d Bind listening socket and outgoing connections to this network interface address. -d directory Set the default download directory. Defaults to "./". -h Display help and exit. -i a.b.c.d Set the address reported to the tracker. -n Don't load ~/.rtorrent.rc on startup. -o key1=opt1,... -O key=opt Set any number of options, see the SETTINGS section. The options given here override the resource files. Use capital -O to allow comma in the option. -p a-b Try to open a listening port in the range a up to and including b. -s directory Session management will be enabled and the torrent files for all open downloads will be stored in this directory. Only one instance of rtorrent should be used with each session directory, though at the moment no locking is done. An empty string will disable the session directory. max_peers = value Set the maximum number of peers to allow in each download. min_peers = value Set the minimum number of peers to try to connect to in each download. max_uploads = value Set the maximum number of simultaneous uploads per download. download_rate = KB Set the maximum global download rate. upload_rate = KB Set the maximum global upload rate. bind = a.b.c.d Bind listening socket and outgoing connections to this network interface address. ip = a.b.c.d ip = hostname Set the address reported to the tracker. port_range = a-b Try to open a listening port in the range a up to and including b. port_random = yes | no Open the listening port at a random position in the port range. check_hash = yes | no Perform hash check on finished downloads. directory = directory Set the default download directory. Defaults to "./". session = directory Session management will be enabled and the torrent files for all open downloads will be stored in this directory. Only one instance of rtorrent should be used with each session directory, though at the moment no locking is done. An empty string will disable the session directory. http_proxy = url Use a http proxy. Use an empty string to disable. encoding_list = encoding Add a preferred filename encoding to the list. The encodings are attempted in the order they are inserted, if none match the torrent default is used. schedule = id,start,interval,command Call command every interval seconds, starting from start. An interval of zero calls the task once, while a start of zero calls it immediately. Currently command is forwarded to the option handler. start and interval may optionally use a time format, dd:hh:mm:ss. F.ex to start a task every day at 18:00, use 18:00:00,24:00:00. schedule_remove = id Delete id from the scheduler. stop_untied = close_untied = remove_untied = Stop, close or remove the torrents that are tied to filenames that have been deleted, the association with the file is then cleared so the event will not trigger more than once. close_low_diskspace = space Close any active torrents on filesystems with less than space diskspace left. Use with schedule. stop_on_ratio = min_ratio stop_on_ratio = min_ratio,min_upload stop_on_ratio = min_ratio,min_upload,max_ratio Stop torrents when they reach the given upload ratio min_ratio in percent. If the optional min_upload is given, require a total upload amount of this many bytes as well. If the optional max_ratio> is given, stop the torrent when reaching this ratio regardless of the total upload amount. Exclude certain torrent by pressing Shift+I in the downlist list. Use with schedule. load = file load_verbose = file load_start = file load_start_verbose = file Load and possibly start a file, or possibly multiple files by using the wild-card "*". This is meant for use with schedule, though ensure that the start is non-zero. The loaded file will be tied to the filename provided. import = file try_import = file Load a resource file. try_import does not throw torrent::input_error exception on bad input. Display related settings. view_add = name Create a new view. view_sort = name view_sort = name,seconds Sort a view according the the criteria set by view_sort_current. If the optional argument is supplied, the view is not sorted if a change happened during the last seconds. This command is meant to be used with schedule. view_sort_new = name,... view_sort_current = name,... Set the sorting criteria for when new elements inserted or view_sort is called. The list can contain any number of criteria, including zero, from the following: name, name_reverse, stopped, started, complete, incomplete, state_changed, state_changed_reverse view_filter = name,... Set a list of filter to apply when new new downloads are added and when view_sort gets called. All filters must match for the download to be included. stopped, started, complete, incomplete, This list contains settings users shouldn't need to touch. hash_read_ahead = MB Configure how far ahead we ask the kernel to read when doing hash checking. The hash checker uses madvise(..., MADV_WILLNEED) for the requests. hash_interval = ms Interval between attempts to check the hash when the chunk is not in memory, in milliseconds. hash_max_tries = tries Number of attempts to check the hash while using the mincore status, before forcing. Overworked systems might need lower values to get a decent hash checking rate. max_open_files = value Number of files to simultaneously keep open. Libtorrent dynamically opens and closes files when mapping files to memory. Defaults to 128. max_open_sockets = value Number of sockets to simultaneously keep open. This value is set to be sysconf(_SC_OPEN_MAX) - 256 at startup. This gives the client 128 sockets to use as it wishes. send_buffer_size = value receive_buffer_size = value Adjust the send and receive buffer size for socket. umask = 0644 Set the umask for this process, which is applied to all files created by the program. working_directory = directory Changes the working directory of the process using chdir. session_on_completion = yes Controls if the session torrent is saved when a torrent finishes. By default on. session_lock = yes Controls if a lock file is created in the session directory on startup. session_save = Save the session files for all downloads. use_udp_trackers = yes Use UDP trackers. Disable if you are behind a firewall etc that does not allow connections to UDP trackers. enable_trackers = yes Set to no to disable tracker requests. tracker_dump = filename Dump tracker requests to filename, disable by supplying an empty string. Only torrents loaded while tracker_dump contains a non-empty string will be logged at the moment, although disabling it will work as expected. tos = default|lowdelay|throughput|reliability|mincost Change the TOS of peer connections, by default set to throughput. If the option is set to default then the system default TOS is used. Jari "Rakshasa" Sundell jaris@ifi.uio.no