-
Notifications
You must be signed in to change notification settings - Fork 12
Additions
Contents
- Standard Views in rTorrent
- Extra Views in rTorrent
- Extra Keyboard shortcuts in rTorrent
-
Extra Variables in rTorrent config files
- cfg.inotify.use
- cfg.external_dnscache.use
- cfg.interface.bind
- cfg.scrape_interval.[active|idle]
- pyro.last_xfer.min_rate
- cfg.slowup.d.[peers_min|peers_max|uploads_max]
- cfg.[slowup|tardyup].uprate.[min|max]
- cfg.[slowup|tardyup].slots.[leech|seed].max
- cfg.global.downrate.[min|max], cfg.global.[upall|upmain].threshold
- cfg.global.slot.uprate.min
- cfg.dir.[main|sub|incomplete|meta_downl|meta_compl|delqueue|session|logs]
- cfg.postfix
- cfg.theme.[0|1|2]
- pyro.bin_dir
- pyro.[extended|extended.ch]
- pyro.[log_archival|log_retention].days
- Extra Attributes in rTorrent config files
-
Extra Commands in rTorrent config files
- d.move_to=category_name,special_group,unsafe_data
- d.move_meta_to=category_name
- d.data_path=
- d.session_file=
- d.remove_data=
- d.add_to_delqueue=
- d.remove_from_delqueue=[unsafe_data]
- d.fix_delqueue_flag=
- d.get_ratio_float=
- d.modify_slots_both=
- d.last_scrape.send_set=
- d.last_active=
- d.last_xfer=
- get_elapsed_time=
- pyro.print_help=
- pyro.ui.messages.show=
- pyro.view.toggle_visible=view_name
- ui.columns.enable=
- ui.columns.disable=
- ui.columns.toggle=
- uptime=
- hrf_time=timestamp
- get_uprate_main=
- get_total_rotating_size=
- pyro.import=rtconfig_filename
- quit=
- Extra Bash functions
- Extra Bash scripts
| Key | View | Updated | Collapsed | Sorting, filtering properties |
|---|---|---|---|---|
| 1 | main |
20 sec |
|
sorted by downloaded time desc |
| 2 | name |
20 sec |
|
sorted by name
|
| 3 | started |
20 sec |
|
sorted by last active desc, group by complete, throttle, download and upload speed desc |
| 4 | stopped |
|
sorted by downloaded time desc, group by complete, throttle
|
|
| 5 | complete |
|
sorted by completed time desc |
|
| 6 | incomplete |
|
sorted by download and upload speed desc, group by open desc, throttle
|
|
| 7 | hashing |
sorted by loaded time desc, group by throttle
|
||
| 8 | seeding |
20 sec |
|
sorted by upload speed desc, group by throttle, only torrents with peers are shown |
| 9 | leeching |
20 sec | sorted by download and upload speed desc, group by throttle, only torrents with peers are shown |
|
| 0 | active |
20 sec |
|
sorted by download and upload speed desc, group by open desc, throttle, complete desc, only active or incomplete torrents are shown |
| Key | View | Collapsed | Sorting, filtering properties |
|---|---|---|---|
| ^ | rtcontrol |
|
|
| ! | messages |
|
sorted by downloaded time, group by throttle, message
|
| t | trackers |
|
sorted by downloaded time desc, group by domain
|
| : | tagged |
|
|
| < | datasize |
|
sorted by selected data size desc |
| > | uploadeddata |
|
sorted by uploaded data desc, downloaded time desc |
| % | ratio |
|
sorted by ratio desc, uploaded data desc, downloaded time desc |
| @ | category |
|
sorted by category, name
|
| ? | deletable |
|
sorted by downloaded time, group by unsafe_data desc, throttle desc, only deletable torrents are shown |
| Key | Functionality |
|---|---|
| } | toggle unsafe_data for a download item |
| # | send manual scrape request for a download item |
| . | toggle tag for a download item |
| T | clear tag view |
| ^g | display tags for a download item |
| * | toggle collapsed/expanded display |
| / | toggle visibility of columns on collapsed display |
| | | toggle selectable themes |
| = | toggle autoscale network history |
| home | Home |
| end | End |
| pgup | Pageg Up |
| pgdn | Page Down |
| F2 | display quick help resources |
| ^q | DISABLED (used to exit rtorrent) |
The following variables are added in rTorrent config files.
Determines whether to use inotify for loading/removing torrent (meta) files from watch directories.
- values
[0|1],1means inotify will be used
Determines whether to use external DNS cache instead of the built-in one of CURL.
- values
[0|1],1means external DNS cache will be used.
Sets an interface with IPv4 address to bind to.
- values
[eth0|tun0|...]
Sets scrape intervals for active (580 ~10 mins) and idle items (43180 ~12 hours).
Sets the min uprate/downrate threshold for last_xfer custom field in Bytes.
Values used for min_peers / max_peers / max_uploads settings of downloads that belong to non-special groups and those values will be overridden by per torrent settings in Favouring section of main config file.
Values used for getting the upload rate limit for throttle groups in KB.
Values used for getting the max number of upload/download slots during leeching and seeding for choke groups.
Values used for getting the global download rate limit in KB.
Min value of uprate per upload slot (unchoked peers) in KB.
Directory constants.
Custom string that can help to use different config files, scripts with different setups based on naming. It can be an empty string as well.
Define selectable color theme configs.
Sets "pyro.bin_dir" to the "bin" directory where the pyrocore tools are installed. Make sure you end it with a "/". If this is left empty, then the shell's path is searched
Determines whether to activate rTorrent-PS / rTorrent-PS-CH features.
Sets archival and retention delay in days for log rotation if it's enabled.
The following custom field attributes are added in rTorrent config files.
Determines whether data of a torrent is deletable.
-
unsafe_data: values[|0|1|2],1meansunsafe_data,2meansunsafe_data in delete queue
Determines the sub-directory (category) for data of a torrent. It's used with watch directories and continously updated during the lifetime of a torrent.
-
data_dir: name of category, e.g.unsafe,rotating
Determines the sub-directory (category) for meta file of a torrent. It's used with watch directories and continously updated during the lifetime of a torrent.
-
meta_dir: name of category, e.g.unsafe,rotating
Name of category the download was originally assigned to.
Timestamp, time the torrent file was downloaded (created locally).
Timestamp, time the torrent was loaded into client.
Timestamp, first time the torrent was started.
Timestamp, time of completion of the torrent.
Timestamp, last time the torrent had peers.
Timestamp, last time the torrent had transfered data.
Activation intervals.
Timestamp, last time when a scrape request was sent for the torrent.
The following commands can be used in rtorrent with ^x.
Moves data (can be partially downloaded) and meta (.torrent) file of a torrent into another directories at the same time and updates all necessary attributes of it.
-
category_name: one of the category directories, e.g.unsafe,songs, etc -
special_group: boolean, values[|0|1],1means special group -
unsafe_data: values[|0|1|2],1meansunsafe_data,2meansunsafe_data in delete queue
Example usage: d.move_to=rotating,1,1, d.move_to=rotating,1,2, d.move_to=fullseed,1,, d.move_to=unsafe,,1, d.move_to=unsafe,,2, d.move_to=various,,
Moves a finished, stucked meta file from the downloading directory into its final place (thanks to the simetimes missing meta_dir custom field value, rtorrent bug on OpenWRT?). It can also be useful if a category name is changed.
-
category_name: one of the category directories, e.g.unsafe,songs, etc
Example usage: d.move_meta_to=rotating, d.move_meta_to=fullseed, d.move_meta_to=unsafe, d.move_meta_to=various
Gets the full path of data of a torrent (it's a workaround for the possibly empty d.base_path attribute).
Gets the full path of the session file of a torrent.
Deletes data of a torrent if data dir/file of a torrent exists and its data is not bogus and removes symlink for its metafile if it exists or prints out an error message.
Adds torrent to delete queue by creating a symlink in .delqueue dir to its metafile and setting unsafe_data custom variable to 2. This command is bind to } key.
Removes torrent from delete queue by deleting its symlink if it exists from .delqueue dir. This command is bind to } key.
-
unsafe_data: optional parameter, values[|0|1],1meansunsafe_data
Usage: d.remove_from_delqueue=, d.remove_from_delqueue=1
Fixes unsafe_data values depending on a symlink in .delqueue directory exists or not. Useful if symlinks are sometimes created manually or by a script in .delqueue dir.
Returns d.ratio as float formatted string.
Modifies the peers_min, peers_max, max_uploads values of a torrent for both downloading and uploading based on which group (special or not) it belongs to.
Sends scrape request for a torrent, sets its tm_last_scrape timestamp custom field and saves its session. This command is bind to # key.
It won't affect the operation of rtorrent, but nice to have these values updated. This info is only updated when rtorrent starts or a torrent is added by default. Although this setup regularly updates scrape information for all torrents (even stopped ones), sometimes this command can be useful.
Returns the value of last_active timestamp custom field of a torrent or current timestamp if it has peers.
Returns the value of last_xfer timestamp custom field of a torrent or current timestamp if it transfer data.
Returns elapsed time between 2 timestamps in the form of 6 years, 5 months, 18 days, 02:40:00. Year/month info isn't shown if their value is 0.
Displays quick help resources.
Switches current view to messages and prints the size of the view.
Sets view visible.
Enables the visibility of certain columns.
Disables the visibility of certain columns.
Toggles visibility of certain columns.
Returns uptime (with the help of getElapsedTime.sh script) in the form of Up: 6 years, 5 months, 18 days, 02:39:57. Year/month info isn't shown if their value is 0.
Displays any valid timestamp value in human readable format or print the value itself (e.g.: 30/06/2013 23:47:33).
Usage: hrf_time=$d.creation_date=, hrf_time=$d.custom=tm_last_scrape
Gets current uprate in KB for special group.
Gets total size of rotating and unsafe downloads.
Imports the specified config file from ~/.pyroscope/ directory.
-
rtconfig_filename: name of rtorrent config file in~/.pyroscope/directory, e.g.rtorrent-ps.rc,color_scheme256-happy_pastel.rc
Usage: pyro.import="color_scheme256-happy_pastel.rc"
Exits rTorrent gracefully.
List orphaned torrents.
Usage: rtlistOrphans
List orphaned torrent (meta) files.
Usage: rtlistOrphanMetas
List public torrents.
Usage: rtlistPublic
List stuck torrents in incomplete directory.
Usage: rtlistStuck
List torrents with unusual trackers messages.
Usage: rtlistMessages
List stopped torrents.
Usage: rtlistStopped
Get total size of rotating and unsafe torrents.
Usage: rtgetTotalRotatingSize
Creates a magnet torrent file from magnet URI into one of the watch directories of rTorrent.
Usage: addMagnetLink.sh "magnet:?xt=urn:btih:foobar..."
Backup session directory of rtorrent.
Usage: doBackup.sh
Calculates and prints elapsed time between 2 timestamps in the form of 6 years, 5 months, 18 days, 02:40:00. Year/month info isn't shown if their value is 0. It's used by get_elapsed_time= and uptime= methods in rtorrent.
Usage: getElapsedTime.sh <<current_timestamp>> <<startup_timestamp>>
Queue management script with rotating (deleting data) capability and category support (that can be included into a main script as well).
Usage: queueTorrent.sh or including in a main script: . "${BASH_SOURCE%/*}/queueTorrent.sh"
Send email report about any torrent with unusual tracker message.
Usage: reportMessages.sh
Send email report about any orphaned torrent.
Usage: reportOrphans.sh
Send email report about any orphaned meta files.
Usage: reportOrphanMetas.sh
Send email report about any public torrent.
Usage: reportPublic.sh
Send email report about any torrent that is stopped.
Usage: reportStopped.sh
Send email report about any stuck torrent in incomplete directory.
Usage: reportStuck.sh
Send email report about low rotating space (in rotating and unsafe directory, including free space).
Usage: reportLowRotatingSpace.sh
General script with helper functions that can be included into main scripts.
Usage: including in a main script: . "${BASH_SOURCE%/*}/rtUtils.sh"
Sample download script to demonstrate usage of inclusion of queue script inside a main script.
Usage: sampleDownload.sh
Init script. It can be installed and enabled by running: sudo update-rc.d rtorrent defaults 92 and sudo update-rc.d rtorrent enable.
Usage: sudo /etc/init.d/rtorrent [start|stop|restart|force-reload|status]