Skip to content

eg rTorrent

Jump to bottom
pyroscope edited this page May 4, 2018 · 16 revisions

rTorrent

Terminal Interface

Also see

https://github.com/rakshasa/rtorrent/wiki/User-Guide

General Key Combinations

Loading torrents (metafiles)

‹enter› – Load an item in stopped state (`load.normal`).
‹backspace› – Load an item started (`load.start`).

Control start / stopped state

^s – Start download item. Runs hash first unless already done.
^d – Stop an active download item, or remove a stopped one.
^k – Stop item and close all files, also set 'ignore commands' flag.

Global throttling

a┆s┆d – Increase the upload throttle by 1/5/50 KiB.
z┆x┆c – Decrease the upload throttle by 1/5/50 KiB.
A┆S┆D – Increase the download throttle by 1/5/50 KiB.
Z┆X┆C – Decrease the download throttle by 1/5/50 KiB.

Other general keys

‹up›┆‹down› – Select an item.
‹left› – Go back to the previous screen.
^o – Set new download directory on a closed item.
^x – Open a prompt for rTorrent commands.
^q – Exit rTorrent (press twice to skip 'stop' tracker announces).

'downloads' Panel ('main' and other views)

General keys

‹right› – Switch to download detail panels.
^x – Open the prompt for command execution.
^e – Set a flag on all files in an item, that (re-)creates them if removed or of the wrong size.
^r – Initiate hash check of torrent, without starting to download┆upload.
+┆- – Rotate priority of torrent.
l – View console log, go back by pressing ‹space› or ‹left›.
I – Toggle whether torrent ignores or heeds commands.
U – Clear tied-to file association, and delete the metafile.

Switching between standard views

1 – Show all downloads.
2 – Show all downloads, ordered by name.
3 – Show started downloads.
4 – Show stopped downloads.
5 – Show complete downloads.
6 – Show incomplete downloads.
7 – Show hashing downloads.
8 – Show seeding downloads.
9 – Show leeching downloads.
0 – Show active downloads.

Keys only available with rTorrent-PS (standard configuration)

‹pgup›┆‹pgdn› – Quick paging up and down.
‹home›┆‹end› – Jump to first / last item.
# – Show hashing downloads (same as '7').
^ – Show 'rtcontrol' result view.
! – Show 'messages' view.
t – Show 'trackers' view (sorted by tracker + name).
? – Show 'indemand' view (last active items on top).
: – Show 'tagged' view.
T – Clear tagged view (untag all items).
. – Toggle current item's ‘tagged’ state.
<┆> – Show previous / next category view.
| – Update category view (refilter).
Q – Show internal 'pyrotorque' view (for debugging).
* – Toggle between collapsed and expanded display.
~ – Rotate through activated color themes.
^g – Shows tags of current item (custom field 'tags').
u - Print uptime and other client info.
‹F2› – Show quick help resources (documentation links).
= – Change scaling of network history.
& – Manually send scrape for current iten.

Download Item Panels

Top-level keys

‹right› – Switch to selected view, for changing / selecting.
‹left› – Back to upper level or downloads view.
1┆2 – Adjust max. uploads.
3┆4 – Adjust min. peers.
5┆6 – Adjust max. peers.
t┆T – Initiate tracker request ('T' is forced, ignoring "min interval").

Quick panel selection

p – Display peer list.
o – Display torrent info.
i – Display file list.
u – Display tracker list.

'Peer list' panel

‹left› – Back to upper level.
‹up›┆‹down› – Select a peer.
‹right› – Show details of selected peer.
* – Snub peer (stop uploading to this peer).
k – Kick peer (disconnect from peer).
B – Ban peer (no unbanning is possible).

'File list' panel

‹left› – Back to upper level.
‹up› ┆ ‹down› – Select a file / folder.
‹right› – Show details of selected file.
‹space› – Change the file priority; applies recursively for directories.
* – Change the priority of all files.
/ – Collapse directories; to expand, press ‹right› on collapsed directory.

'Tracker list' panel

‹left› – Back to upper level.
‹up›┆‹down› – Select a tracker.
‹space› – Rotate trackers in a group.
* – Toggle selected tracker on / off.

Errors & Warnings

A tracker returns a HTTP 5xx status page, or a similar HTML response

Tracker: [Could not parse bencoded data]

When trying to load corrupt metafiles

Could not create download, the input is not a valid torrent

Data of an item is changed or removed, after it is marked as complete; recover by pressing ^K ^E ^R, then possibly ^S to re-download.

Download registered as completed, but hash check returned unfinished chunks.

Command Line

Update this example page

wget -O "$HOME/.config/eg/examples/rtorrent.md" \
     "https://raw.githubusercontent.com/wiki/rtorrent-community/rtorrent-community.github.io/eg-rTorrent.md"

Calling rTorrent with typical options

# Disable any legacy commands, and use an alternative config file
rtorrent -D -K -n -o import=~/rtorent/rtorrent.rc

Loading a metafile from the prompt with a specific data path

# DATADIR is the data directory of a multi-file torrent,
# or holds the data file of single-file one; paths MUST
# be absolute
rtxmlrpc -q load.verbose '' "$PWD/‹DATA›.torrent" \
    "d.directory_base.set=\"‹DATADIR›\"" "d.custom1.set=‹LABEL›"

Configuration

These are typical snippets that are added after initial configuration. For an initial configuration reference, see below.

Watch directory schedules

# Schedules: UNIQUE name, offset from client start [sec], repeat [sec], "command"
schedule2 = watch_directory_foo, 20, 10, "load.start_verbose=~/watch_foo/*.torrent"
schedule2 = watch_directory_bar, 21, 10, "load.verbose=~/watch_bar/*.torrent"
schedule2 = watch_directory_baz, 22, 10, "load.verbose=~/watch_baz/*.torrent,d.directory.set=~/baz/"

Opening a log file

# log.open_file = "log name", "file path"
log.open_file = "log", (cat,/tmp/rtorrent.log.,(system.pid))

Adding logging channels

# Levels = critical error warn notice info debug
# Groups = connection_* dht_* peer_* rpc_* storage_* thread_* tracker_* torrent_*
log.add_output = "info", "log"
#log.add_output = "tracker_debug", "log"

Reference Information

©️ The content in this repository and associated wiki is licensed CC-BY-SA-4.0. By contributing, you grant this project and its members the right to publish your contribution under the terms of that license.
Clone this wiki locally