[http://libtorrent.rakshasa.no/ rTorrent] is a quick and efficient BitTorrent client that uses the libtorrent library. It is written in C++ and uses the [[Wikipedia:ncurses|ncurses]] programming library, which means it uses a text user interface. When combined with [[GNU Screen]] and [[Secure Shell]], it becomes a convenient remote [[Wikipedia:BitTorrent (protocol)#Operation|BitTorrent client]].

[http://libtorrent.rakshasa.no/ rTorrent] is a quick and efficient BitTorrent client that uses the libtorrent library. It is written in C++ and uses the [[Wikipedia:ncurses|ncurses]] programming library, which means it uses a text user interface. When combined with [[GNU Screen]] and [[Secure Shell]], it becomes a convenient remote [[Wikipedia:BitTorrent (protocol)#Operation|BitTorrent client]].

Line 8:

Line 9:

[[pacman|Install]] the {{Pkg|rtorrent}} package that is available in the [[Official Repositories|official repositories]].

[[pacman|Install]] the {{Pkg|rtorrent}} package that is available in the [[Official Repositories|official repositories]].

−

Alternatively, install {{AUR|rtorrent-svn}} or {{AUR|rtorrent-extended}} from the [[Arch User Repository|AUR]].

+

Alternatively, install {{AUR|rtorrent-git}} or {{AUR|rtorrent-extended}} from the [[Arch User Repository|AUR]].

== Configuration ==

== Configuration ==

Line 134:

Line 135:

== Additional Tips ==

== Additional Tips ==

−

=== Seperate session with Screen ===

+

=== Separate session with Screen ===

[[GNU Screen]] is a wrapper that allows separation between the text program and the shell from which it was launched.

[[GNU Screen]] is a wrapper that allows separation between the text program and the shell from which it was launched.

Screen flow-control interferes with the {{Keypress|Ctrl-q}} mapping (see: [[#Redundant mapping|Redundant mapping]]). To disable it add the following to {{ic|~/.screenrc}}:

Screen flow-control interferes with the {{Keypress|Ctrl-q}} mapping (see: [[#Redundant mapping|Redundant mapping]]). To disable it add the following to {{ic|~/.screenrc}}:

defflow off

defflow off

+

+

An alternative is to escape the command and send it directly to rTorrent. In other words, use {{Keypress|Ctrl-a}} {{Keypress|q}} to quit rTorrent within GNU Screen.

To automatically start rTorrent within Screen, add the following to the {{ic|~/.screenrc}} configuration file:

To automatically start rTorrent within Screen, add the following to the {{ic|~/.screenrc}} configuration file:

Line 146:

Line 149:

{{note|See the rTorrent wiki article on this subject for more information: [http://libtorrent.rakshasa.no/wiki/RTorrentCommonTasks#StartingrTorrentonSystemStartup Starting rTorrent on System Startup]}}

{{note|See the rTorrent wiki article on this subject for more information: [http://libtorrent.rakshasa.no/wiki/RTorrentCommonTasks#StartingrTorrentonSystemStartup Starting rTorrent on System Startup]}}

Make sure to change USER to the username that will be running rtorrent.

Make the file executable:

Make the file executable:

Line 203:

Line 208:

To connect to the daemon process on a remote machine use [[Secure Shell|SSH]]:

To connect to the daemon process on a remote machine use [[Secure Shell|SSH]]:

$ ssh -t rtorrent@192.168.1.10 'screen -r'

$ ssh -t rtorrent@192.168.1.10 'screen -r'

+

+

Or if you used [[tmux]] instead of [[screen]]:

+

$ ssh -t rtorrent@192.168.1.10 'tmux attach -t rtorrent'

For more information about daemon scripts see: [[Writing rc.d scripts]]

For more information about daemon scripts see: [[Writing rc.d scripts]]

−

This script can be found in [https://aur.archlinux.org/packages.php?ID=56458 rtorernt-daemon-git] from AUR.

+

This script can be found in {{aur|rtorrent-daemon}} from AUR.

Alternate scripts can be found on the [http://www.gentoo-wiki.info/Rtorrent#rtorrent Gentoo Wiki Archives], [http://codesnippets.joyent.com/posts/show/1947 Joyent CodeSnippets] and [http://www.bytetouch.com/blog/linux/how-to-rtorrent-with-screen-on-debian/ ByteTouch].

Alternate scripts can be found on the [http://www.gentoo-wiki.info/Rtorrent#rtorrent Gentoo Wiki Archives], [http://codesnippets.joyent.com/posts/show/1947 Joyent CodeSnippets] and [http://www.bytetouch.com/blog/linux/how-to-rtorrent-with-screen-on-debian/ ByteTouch].

It is possible to have rtorrent sort completed torrent data to specific folders based on which 'watch' folder you drop the *.torrent into while continuing to seed. Many examples show how to do this with torrents downloaded by rtorrent. The problem is when you try to drop in 100% done torrent data and then have rtorrent check the data and resume. It will not be sorted.

+

It is possible to have rtorrent sort completed torrent data to specific folders based on which 'watch' folder you drop the *.torrent into while continuing to seed. Many examples show how to do this with torrents downloaded by rtorrent. The problem is when you try to drop in 100% done torrent data and then have rtorrent check the data and resume, it will not be sorted.

As a solution, use the following example in your ~/.rtorrent.rc.

As a solution, use the following example in your ~/.rtorrent.rc.

Line 268:

Line 299:

# 2) when triggered, execute the 'movecheck1' method and check the return value.

# 2) when triggered, execute the 'movecheck1' method and check the return value.

If you use GNU Screen, update the {{ic|.screenrc}} configuration file to reflect this change:

If you use GNU Screen, update the {{ic|.screenrc}} configuration file to reflect this change:

−

screen -t rtorrent rtorrent -o http_capath=/etc/ssl/certs

+

$ screen -t rtorrent rtorrent -o http_capath=/etc/ssl/certs

In rTorrent 0.8.9, set {{ic|<nowiki>network.http.ssl_verify_peer.set=0</nowiki>}} to fix the problem.<sup>[https://bbs.archlinux.org/viewtopic.php?pid=981832#p981832]</sup>

In rTorrent 0.8.9, set {{ic|<nowiki>network.http.ssl_verify_peer.set=0</nowiki>}} to fix the problem.<sup>[https://bbs.archlinux.org/viewtopic.php?pid=981832#p981832]</sup>

Line 398:

Line 446:

* [http://projects.cyla.homeip.net/rtwi/ rTWi] is a simple rTorrent web interface written in PHP.

* [http://projects.cyla.homeip.net/rtwi/ rTWi] is a simple rTorrent web interface written in PHP.

* [[Rtgui]] is a web based front end for rTorrent written in PHP and uses XML-RPC to communicate with the rTorrent client.

* [[Rtgui]] is a web based front end for rTorrent written in PHP and uses XML-RPC to communicate with the rTorrent client.

−

* [http://code.google.com/p/rutorrent/ rutorrent] and [http://forums.rutorrent.org/ Forum] - A web-based front-end with an interface very similar to uTorrent which supports many plugins and advanced features (see also: [https://bbs.archlinux.org/viewtopic.php?pid=897577#p897577 Guide for rTorrent + ruTorrent Installation]).

+

* [http://code.google.com/p/rutorrent/ rutorrent] and [http://forums.rutorrent.org/ Forum] - A web-based front-end with an interface very similar to uTorrent which supports many plugins and advanced features (see also: [[ruTorrent]] and [https://bbs.archlinux.org/viewtopic.php?pid=897577#p897577 Guide on forum]).

{{note|rTorrent is currently built using [http://xmlrpc-c.sourceforge.net/ XML-RPC for C/C++], which is required for some web interfaces (e.g. ruTorrent).}}

{{note|rTorrent is currently built using [http://xmlrpc-c.sourceforge.net/ XML-RPC for C/C++], which is required for some web interfaces (e.g. ruTorrent).}}

Line 407:

Line 455:

For more information see: [http://libtorrent.rakshasa.no/wiki/RTorrentXMLRPCGuide Using XMLRPC with rtorrent]

For more information see: [http://libtorrent.rakshasa.no/wiki/RTorrentXMLRPCGuide Using XMLRPC with rtorrent]

+

+

=== Handling magnet links ===

+

If you wish to have magnet links automatically added to your watch folder, here is a script that will do the trick:

+

+

#!/bin/bash

+

watch_folder=~/.rtorrent/watch

+

cd $watch_folder

+

[[ "$1" =~ xt=urn:btih:([^&/]+) ]] || exit;

+

echo "d10:magnet-uri${#1}:${1}e" > "meta-${BASH_REMATCH[1]}.torrent"

+

+

(adapted from http://blog.gonzih.org/blog/2012/02/17/how-to-use-magnet-links-with-rtorrent/)

+

+

Save it, for instance as rtorrent-magnet, give it execution permission, and place it somewhere under your $PATH. Then in Firefox:

* Next time you click a magnet link you will be asked which application to open it with. Select the script we just created and you'll be done

+

+

(http://kb.mozillazine.org/Register_protocol)

== See also ==

== See also ==

Revision as of 07:26, 5 November 2012

rTorrent is a quick and efficient BitTorrent client that uses the libtorrent library. It is written in C++ and uses the ncurses programming library, which means it uses a text user interface. When combined with GNU Screen and Secure Shell, it becomes a convenient remote BitTorrent client.

The check_hash option executes a hash check when a torrent download is complete or rTorrent is started. When starting, it checks for errors in your completed files.

check_hash = yes

Create and manage files

The directory option will determine where your torrent data will be saved. Be sure to enter the absolute path, as rTorrent may not follow relative paths:

directory = /home/[user]/torrents/

The session option allows rTorrent to save the progess of your torrents. It is recommended to create a directory called .session (e.g. $ mkdir ~/.session).

session = /home/[user]/.session/

The schedule option has rTorrent watch a particular directory for new torrent files. Saving a torrent file to this directory will automatically start the download. Remember to create the directory that will be watched (e.g. $ mkdir ~/watch). Also, be careful when using this option as rTorrent will move the torrent file to your session folder and rename it to its hash value.

The following schedule option is intended to stop rTorrent from downloading data when disk space is low.

schedule = low_diskspace,5,60,close_low_diskspace=100M

Port configuration

The port_range option sets which port(s) to use for listening. It is recommended to use a port that is higher than 49152 (see: List of port numbers). Although, rTorrent allows a range of ports, a single port is recommended.

Additional settings

The encryption option enables or disables encryption. It is very important to enable this option, not only for yourself, but also for your peers in the torrent swarm. Some users need to obscure their bandwidth usage from their ISP. And it does not hurt to enable it even if you do not need the added security.

This final dht option enables DHT support. DHT is common among public trackers and will allow the client to acquire more peers.

dht = auto
dht_port = 6881
peer_exchange = yes

Note: See the rTorrent wiki article on this subject for more information: Using DHT

Key bindings

rTorrent relies exclusively on keyboard shortcuts for user input. A quick reference is available in the table below. A complete guide is available on the rTorrent wiki (see: rTorrent User Guide).

Note: Striking Template:Keypress twice in quick succession will make rTorrent shutdown without waiting to send a stop announce to the connected trackers.

Cmd

Action

Ctrl-q

Quit application

Ctrl-s

Start download. Runs hash first unless already done.

Ctrl-d

Stop an active download or remove a stopped download

Ctrl-k

Stop and close the files of an active download.

Ctrl-r

Initiate hash check of torrent. Without starting to download/upload.

Left

Returns to the previous screen

Right

Goes to the next screen

Backspace/Return

Adds the specified *.torrent

a|s|d

Increase global upload throttle about 1|5|50 KB/s

A|S|D

Increase global download throttle about 1|5|50 KB/s

z|x|c

Decrease global upload throttle about 1|5|50 KB/s

Z|X|C

Decrease global download throttle about 1|5|50 KB/s

Redundant mapping

Template:Keypress is often used for terminal control to stop screen output while Template:Keypress is used to start it. These mappings may interfere with rTorrent. Check to see if these terminal options are bound to a mapping:

Make sure to change USER to the username that will be running rtorrent.

Make the file executable:

# chmod +x /etc/rc.d/rtorrent

Creating a .rtorrent.rc file with relative paths in a user's home directory will break the rc.d script. To run multiple instances of rTorrent with relative paths under different users, replace line 9 in /etc/rc.d/rtorrent with the following:

Pre-allocation

The rTorrent package in the community repository lacks pre-allocation. Compiling rTorrent with pre-allocation allows files to be allocated before downloading the torrent. The major benefit is that it limits and avoids fragmentation of the filesystem. However, this introduces a delay during the pre-allocation if the filesystem does not support the fallocate syscall natively.

Therefore this switch is recommended for xfs, ext4 and btrfs filesystems, which have native fallocate syscall support. They will see no delay during preallocation and no fragmented filesystem. Pre-allocation on others filesystems will cause a delay but will not fragment the files.

To make pre-allocation available, recompile libtorrent from the ABS tree with the following new switch:

Manage completed files

Note: Currently, this part requires either the git version of rtorrent/libtorrent or having applied the patch to 0.8.6 that adds 'equal'.

Note: If you're having trouble with this tip, it's probably easier to follow this

It is possible to have rtorrent sort completed torrent data to specific folders based on which 'watch' folder you drop the *.torrent into while continuing to seed. Many examples show how to do this with torrents downloaded by rtorrent. The problem is when you try to drop in 100% done torrent data and then have rtorrent check the data and resume, it will not be sorted.

As a solution, use the following example in your ~/.rtorrent.rc.
Make sure to change the paths.

# location where new torrent data is placed, and where you should place your
# 'complete' data before you place your *.torrent file into the watch folder
directory = /home/user/torrents/incomplete
# schedule a timer event named 'watch_directory_1':
# 1) triggers 10 seconds after rtorrent starts
# 2) triggers at 10 second intervals thereafter
# 3) Upon trigger, attempt to load (and start) new *.torrent files found in /home/user/torrents/watch/
# 4) set a variable named 'custom1' with the value "/home/user/torrents/complete"
# NOTE: if you do not want it to automatically start the torrent, change 'load_start' to 'load'
schedule = watch_directory_1,10,10,"load_start=/home/user/torrents/watch/*.torrent,d.set_custom1=/home/user/torrents/complete"
# insert a method with the alias 'checkdirs1'
# 1) returns true if the current path of the torrent data is not equal to the value of custom1
# 2) otherwise, returns false
system.method.insert=checkdirs1,simple,"not=\"$equal={d.get_custom1=,d.get_base_path=}\""
# insert a method with the alias 'movecheck1'
# 1) returns true if all 3 commands return true ('result of checkdirs1' && 'torrent is 100% done', 'custom1 variable is set')
# 2) otherwise, returns false
system.method.insert=movecheck1,simple,"and={checkdirs1=,d.get_complete=,d.get_custom1=}"
# insert a method with the alias 'movedir1'
# (a series of commands, separated by ';')
# 1) "set path of torrent to equal the value of custom1";
# 2) "mv -u <current data path> <custom1 path>";
# 3) "clear custom1", "stop the torrent","resume the torrent"
# 4) stop the torrent
# 5) start the torrent (to get the torrent to update the 'base path')
system.method.insert=movedir1,simple,"d.set_directory=$d.get_custom1=;execute=mv,-u,$d.get_base_path=,$d.get_custom1=;d.set_custom1=;d.stop=;d.start="
# set a key with the name 'move_hashed1' that is triggered by the hash_done event.
# 1) When hashing of a torrent completes, this custom key will be triggered.
# 2) when triggered, execute the 'movecheck1' method and check the return value.
# 3) if the 'movecheck' method returns 'true', execute the 'movedir1' method we inserted above.
# NOTE-0: *Only* data that has had their hash checked manually with ^R [^R = Control r].
# Or on a rtorrent restart[which initiates a hash check]. Will the data move; ~/torrents/incomplete => ~/torrents/complete for example.
# NOTE-1: 'branch' is an 'if' conditional statement: if(movecheck1){movedir1}
system.method.set_key=event.download.hash_done,move_hashed1,"branch={$movecheck1=,movedir1=}"

You can add additional watch folders and rules should you like to sort your torrents into special folders.

For example, if you would like the torrents to download in:

/home/user/torrents/incomplete

and then sort the torrent data based on which folder you dropped the *.torrent into:

notify_me is the command id, which may be used by other commands, it can be just about anything you like, so long as it is unique.

execute= is the rtorrent command, in this case to execute a shell command.

/path/to/mail.sh is the name of our script (or whatever command you want to execute) followed by a comma separated list of all the switches/arguments to be passed.

$d.get_name= 'd' is an alias to whatever download triggered the command, get_name is a function which returns the name of our download, and the '$' tells rTorrent to replace the command with its output before it calls execute.

The end result? When that torrent, 'All Live Nudibranches', that we started before leaving for work finishes, we will be texted:

All Live Nudibranches: Done

Displaying active torrents

The rtorrent doesn't list the active tab properly by default, add this line to your .rtorrent.rc to show only active torrents

See also

rTorrent Community Wiki - A public place for information on rTorrent and any project related to rTorrent, regarding setup, configuration, operations, and development.

PyroScope - A collection of command line tools for rTorrent. It provides commands for creating and modifying torrent files, moving data on completion without having multiple watch folders, and mass-controlling download items via rTorrent's XML-RPC interface: searching, start/stop, deleting items with or without their data, etc. It also offers a documented Python API.