rTorrent Community Wiki
rTorrent User Interface
This page describes how to use rTorrent's native ncurses user interface in much more detail than the man page does.
Contents
1. Introduction
TODO Some blurb on using SSH, tmux/screen, and that rTorrent is a client that works without any web interface (duh!).
The following paragraphs explain what the various keyboard commands (bindings) do, and the meaning of the information shown in the different displays (views).
See also http://cheat.errtheblog.com/s/rtorrent/
2. Global key bindings
Key mappings |
|
Key |
Description |
^q |
Initiate shutdown, press again to force the shutdown and skip sending the stop signal to trackers |
⇧ | ⇩ | ⇨ | ⇦ |
Select entries or change windows. The right arrow key or ^F is often used for viewing details about the selected entry, while the left arrow key or ^B often returns to the previous screen |
a | s | d |
Increase the global upload throttle by 1/5/50 KiB |
A | S | D |
Increase the global download throttle by 1/5/50 KiB |
z | x | c |
Decrease the global upload throttle by 1/5/50 KiB |
Z | X | C |
Decrease the global download throttle by 1/5/50 KiB |
TODO Are these really global?
3. The main panel
TODO
Key mappings |
|
Key |
Description |
^Q |
Exit rTorrent normally (the same effect can be achieved by typing execute=kill,-INT,$system.pid= into a ^X prompt) |
l |
Show the log, exit using ⇦ or ␣ |
⇨ |
Show detail panels for item in focus |
⇧ | ⇩ |
Change focus item |
0 - 9 |
Change view |
^S |
Start download |
^D |
Stop an active download, or remove a stopped download |
^K |
Stop a torrent and close its files |
^E |
Set the 'create/resize queued' flags on all files in a torrent. This is necessary if the underlying files in a torrent have been deleted or truncated, and thus rTorrent must restore them |
^R |
Recheck torrent hash |
^O |
Change the destination directory of the download. The torrent must be closed. |
^X |
Call commands or change settings (command prompt) |
+ | - |
Change the priority of the download |
↤ |
Add torrent using a (magnet) URL or file path. Use ⇥ to view directory contents and do auto-complete. |
⏎ |
Same as ↤, but load in stopped state |
U |
Delete the torrent file the item is tied to, and clear the association |
I |
Toggle whether torrent ignores "try" commands |
4. The log panel
TODO
Key mappings |
|
Key |
Description |
⇦ |
Back to main panel |
5. The torrent detail panels
If you press ⇨ on the item in focus, the main panel is replaced by the details of that item. By default, the Peer list panel is shown. You can use ⇧ and ⇩ to switch to the other panel menu items.
Key mappings |
|
Key |
Description |
⇨ |
View torrent file list. Use the space-bar to change the file priority and * to change the priority of all files. Use / to collapse the directories. |
1 | 2 |
Adjust max uploads |
3 | 4 |
Adjust min peers |
5 | 6 |
Adjust max peers |
u |
Display transfering blocks |
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 |
5.1. Peer list
The peer list displays the status of each peer that is connected to you. It is one line per connected peer and all general stats for that peer, including the client the peer is using to connect into the swarm. You can set the focus by pressing ⇧ and ⇩ (indicated by an * in front of the peer). If you press ⇨ on the peer in focus, the peer list panel is replaced by the details of the connection to that peer.
Fields & Columns |
|
Name |
Description |
IP |
The IP address of the peer connecting to your tracker |
UP |
Your upload rate to peers in KiB/s |
DOWN |
Your download rate from peers in KiB/s |
PEER |
Peer's reported traffic (unreliable, and some clients don't send this) |
C/RE/LO |
|
QS |
Queue size for outgoing / incoming packets (U/D) |
DONE |
Peer's completion in percent |
REQ |
Chunk requested from peer |
SNUB |
|
FAILED |
|
unnamed |
Peer's client name and version |
Key mappings |
|
Key |
Description |
⇨ |
Show detail for peer in focus |
⇧ / ⇩ |
Change focus item |
⇦ |
Back to peer list menu item |
5.2. Info
The Info panel gives detailed information about the torrent, local files, memory and disk usage, and connection statistics.
Fields & Columns |
|
Name |
Description |
Name |
The base name of this torrent |
Local id |
rTorrent's client ID for this session |
Info hash |
The torrent's info hash |
Created |
The date the torrent was created |
Directory |
The current directory being read/written to |
Base Path |
The path to the file(s) being read/written to |
Tied to file |
|
Chunks |
Math showing how the chunks create the file size |
Priority |
How this torrent compares to other torrents being downloaded in download preference |
Peer exchange |
Shows enabled or disabled, active or inactive, and the number |
State changed |
How long ago was last change in connection status |
Memory usage |
Current memory consumed by torrent hashes |
Max memory usage |
Maximum memory consumed while processing this torrent |
Free diskspace |
Free space on the volume rtorrent is writing to |
Safe diskspace |
|
Connection type |
If your rtorrent is a seed or downloader |
Safe sync |
Make sure that writes are flushed to disk |
Send buffer |
Buffers which handle flow instability when sending |
Receive buffer |
Buffers which handle flow instability when receiving |
Throttle |
Mode which throttling bandwidth is applied |
Upload |
Current upload bandwidth |
Download |
Current download bandwidth |
Skipped |
How much was skipped |
Preload |
|
Key mappings |
|
Key |
Description |
|
N/A |
5.3. File list
Shows files in the torrent, and their status. If you press ⇨ once, the key bindings described below become active and you can control the contained files.
Fields & Columns |
|
Name |
Description |
Cmp |
Percent completion of this file |
Pri |
Priority when downloading |
Size |
Size of this file |
Filename |
The filename |
Key mappings |
|
Key |
Description |
⇨ |
Show detail for file in focus (as usual, go back using ⇦) |
⇧ / ⇩ |
Change file in focus |
␣ |
Cycle priority of file in focus |
* |
Cycle priority of all files at once |
/ |
Collapse or expand directory tree |
⇦ |
Back to File list menu item |
5.4. Tracker list
This is a list of trackers that are seeding this hive.
Fields & Columns |
|
Name |
Description |
Key mappings |
|
Key |
Description |
|
N/A |
5.5. Chunks seen
This gives a summary of the chunk distribution between all connected peers in the hive (excludes you and the trackers, this is just peers).
Fields & Columns |
|
Name |
Description |
Key mappings |
|
Key |
Description |
⇨ |
Show chunk detail for current torrent |
⇧ / ⇩ |
Move up and down the list if bigger than current screen size |
⇦ |
Back to Chunks seen menu item |
5.6. Transfer list
TODO
Fields & Columns |
|
Name |
Description |
Key mappings |
|
Key |
Description |