rtorrent
1
June 25th, 2005
BitTorrent client for ncurses
rtorrent
a BitTorrent client for ncurses
rtorrent
-h
-o key1=opt1,...
-O key=opt
URL | FILE
DESCRIPTION
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.
KEYBOARD CONTROL
Global Keys
^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.
Main View Keys
->
View download.
^s
Start download.
^d
Stop an active download, or remove a stopped download.
^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.
Download View Keys
->
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.
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/Snubb peer.
OPTIONS
-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,...
-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.
GENERAL SETTINGS
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.
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.
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 have been
deleted, the association is then cleared.
ADVANCED SETTINGS
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.
working_directory = directory
Changes the working directory of the process using
chdir.
session_on_completion = yes
Controls whetever the session torrent is updated when a torrent
finishes. By default on.
session_lock = yes
Controls whetever a lock file is created in the session directory.
AUTHORS
Jari "Rakshasa" Sundell jaris@ifi.uio.no