rtorrent - a BitTorrent client for ncurses

rtorrent [ -h ] [ -o key1=opt1,... ] [ 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.

GLOBAL KEYS

MAIN VIEW KEYS

DOWNLOAD VIEW KEYS

-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.

-o key1=opt1,...

Set any number of options, see the SETTINGS section. The options given here override the resource files.

-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

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.

schedule_remove = id

Delete id from the scheduler.

load = file

load_start = file

Load and possibly start a file, or possibly mutiple files by using the wildcard "*". 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.

stop_untied =

remove_untied =

Stop or remove the torrents that are tied to filenames that has been deleted, the association is then cleared. Don't use remove_untied as it crashes the client.

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.

umask = 0644

Set the umask for this process, which is applied to all files created by the program.

Jari "Rakshasa" Sundell <jaris@ifi.uio.no>