This chapter describes the additional features in rTorrent-PS, and other differences to a vanilla rTorrent build.
Using the right default configuration (more on that below), you will get the following additional features in your rTorrent-PS installation:
tkey is bound to a
trackersview that shows all items sorted by tracker and then by name.
!key is bound to a
messagesview, listing all items that currently have a non-empty message, sorted in order of the message text.
^key is bound to the
rtcontrolsearch result view, so you can easily return to your last search.
?key is bound to the
indemandview, which sorts all open items by their activity, with the most recently active on top.
%key is bound to the
ratioview, which sorts all open items by their ratio (descending).
°key is bound to the
uploadedview, which sorts all open items by their total upload amount (descending).
"key is bound to the
datasizeview, which sorts all open items by the size of their content data (descending).
- Add even more views, see Additional Views for details.
Page ↓scroll by 50 items at a time (or whatever other value
Endjump to the first / last item in the current view.
Ctrl-Fopens a prompt where you can enter a search term, and
F3jump to the next hit for that term. If nothing matches, a message is shown on the console.
~key rotates through all available color themes, or a user-selected subset. See Color Themes for details.
>keys rotate through all added category views (
pyro.category.add=‹name›), with filtering based on the ruTorrent label (
custom_1=‹name›). See Category Views for details.
|reapplies the category filter and thus updates the current category view.
ukey shows the uptime and some other essential data of your rTorrent instance.
F2shows some important help resources (web links) in the console log.
*toggles between the collapsed (as described on Extended Canvas Explained) and the expanded display of the current view.
/toggles the visibility of ‘sacrificial’ columns – normally, they’re only hidden when the terminal width gets too small.
activeview is changed to include all incomplete items regardless of whether they have any traffic, and then groups the list into complete, incomplete, and queued items, in that order. Within each group, they’re sorted by download and then upload speed.
- Some canvas v2 columns are added in the pimp-my-box configuration –
the selected throttle (⋉), a download’s chunk size (≣),
and the expected time of arrival (⟲ ◥◤) on the active and leeching displays only.
The visibility of the chunk size column can be toggled using the
- The commands
f=«filter_condition»are pre-defined for searching using a Ctrl-X prompt.
.key toggles the membership in the
taggedview for the item in focus,
Tclears that view (i.e. removes the tagged state on all items). This can be very useful to manually select a few items and then run
rtcontrolon them, or alternatively use
--to-view taggedto populate the
taggedview, then deselect some items interactively with the
.key, and finally mass-control the rest. See Additional Views for details.
- You can use the
cull=commands (on a Ctrl-X prompt) for deleting the current item and its (incomplete) data.
Ctrl-gshows the tags of an item (as managed by
tag.rm=‹tag›can be used to change the set of tags, both also show the new set of tags after changing them.
- Time-stamped log files with rotation, archival (compression), and pruning – with a setting for the number of days to keep logs in uncompressed form, or at all.
- Trackers are scraped regularly (active items relatively often,
inactive items including closed ones seldomly), so that the display
of downloads / seeders / leechers is not totally outdated.
&key can be used to manually scrape the item in focus.
- A watchdog for the
pyrotorquedaemon process (checks every 5 minutes, and starts it when not running if the ~/.pyroscope/run/pyrotorque file exists).
With regards to using the ‘right’ configuration to get the above, you need
*.rc.default files in the
provided by pyrocore.
Standard Configuration Explained has details on these.
Some more features are defined by the pimp-my-box configuration templates.
To get there, perform the Manual Turn-Key System Setup as described in this manual, or use the pimp-my-box project for an automatic remote installation. The instructions in the Extending your ‘.rtorrent.rc’ section of the pyrocore manual only cover half of it, and you might miss some described features.
Extended Canvas Explained¶
The following is an explanation of the collapsed display of rTorrent-PS (canvas v2).
In case your screen looks broken compared to this, see Setting up Your Terminal Emulator for necessary pre-conditions and settings regarding your terminal emulator application and operating system.
In older builds, you need to remember to press the
* key while showing a view,
or change the state of new views after adding them (by calling the view.collapsed.toggle command),
else you won’t ever see it.
The following is an overview of the default columns, and what the values and icons in them mean.
⍰ after the column title indicates a ‘sacrificial’ column, which disappear when the display
gets too narrow to display all the columns. When even that does not provide enough space,
columns are omitted beginning on the right side (Name is always included).
Sacrificial columns can also be toggled using the
– note they’re toggled as a whole group,
so other dynamic states like the
≣ column toggle are ignored.
⪮ are provided by a pimp-my-box configuration include
(i.e. loaded from
and ones carrying
All others are built-in.
- Message or alert indicator (♺ = Tracker cycle complete, i.e. “Tried all trackers”; ʘ = item’s data path does not exist (needs support by a cron job); ⚡ = establishing connection; ↯ = data transfer problem; ◔ = timeout; ¿? = unknown torrent / info hash; ⨂ = authorization problem (possibly temporary); ⋫ = tracker downtime; ☡ = DNS problems; ⚠ = other)
- Item state (▹ = started, ╍ = paused, ▪ = stopped)
- Tied item? [⚯]
- Command lock-out? (⚒ = heed commands, ◌ = ignore commands)
- Number of completions from last scrape info
- Number of seeds from last scrape info
- Number of leeches from last scrape info
- Transfer direction indicator [⇅ ↡ ↟]
- Number of connected peers
- ∆⋮ ⟲
- Upload rate, or when inactive, time the download took (only after completion).
- ∇⋮ ◷
- Approximate time since completion (units are «”’hdwmy» from seconds to years); for incomplete items the download rate or, if there’s no traffic, the time since the item was started or loaded
- ⟲ ◥◤
- Expected time of arrival (only on the active and leeching views)
- Throttle selected for this item (∞ is the special
NULLthrottle; ⓪…⑨ for ruTorrent‘s
- Total sum of uploaded data
- Completion status (✔ = done; else up to 8 dots [⣿] and ❚, i.e. progress in 10% steps);
ui.style.progress.setcommand is deprecated, see Defining Your Own Columns for the new way to get a different set of glyphs or an ASCII version
- Ratio (☹ plus color indication for < 1, ➀ — ➉ : >= the number, ⊛ : >= 11);
ui.style.ratio.setcommand is deprecated, see Defining Your Own Columns for the new way to get a different set of number glyphs or an ASCII version
- ☯ ‰
- Detailed ratio, in promille and as a number (only on the ratio view).
- Data size
- Chunk size – this column can be toggled on / off using the
- ◷ ↑↓
- Time of last data transfer (only on the last_xfer view).
- ◷ ↺⤴⤵
- Time of last tracker scrape (only on the trackers view).
- 15 characters of the unmapped tracker domain name (only on the trackers view).
- ◷ ℞
- Time a peer was last connected, or the number of peers connected right now (only on the indemand view).
- Priority (✖ = off, ⇣ = low, nothing for normal, ⇡ = high)
- A ⚑ indicates this item is on the
- Name of the download item – either the name contained in the metafile,
or else the value of the
displaynamecustom field when set on an item
- Domain of the first HTTP tracker with seeds or leeches, or else the first one altogether – note that you can define nicer aliases using the trackers.alias.set_key command in your configuration
For the various time displays to work, you need the pyrocore standard configuration for rtorrent.rc.
The scrape info and peer numbers are exact only for values below 100, else they indicate the order of magnitude using roman numerals (c = 10², m = 10³, X = 10⁴, C = 10⁵, M = 10⁶). For up-to-date scrape info, you need the Tracker Auto-Scraping configuration from pyrocore.
The following new commands are available. Note that the links point to the Commands Reference chapter in the rTorrent Handbook.