# RTorrent and LibTorrent Wiki

[![Download](https://img.shields.io/badge/download-v0.16.2-0000ff.svg)](https://github.com/rakshasa/rtorrent/wiki#download-links)

The **rTorrent** bittorrent client uses ncurses and is ideal for use with [tmux](https://tmux.github.io/), [screen](http://www.gnu.org/software/screen/) or  [dtach](http://dtach.sourceforge.net/). Alternatively, version 0.9.7+ has a [[built-in daemon mode|Daemon_Mode]] disabling the user interface, so you can only control it via XMLRPC. It supports saving of sessions, allows the user to add/remove torrents, and much more.

Community documentation is available on the [rtorrent-docs](https://github.com/kannibalox/rtorrent-docs) repository and on [ReadTheDocs](https://kannibalox.github.io/rtorrent-docs/).

:busts_in_silhouette: :pencil: | This wiki is editable by any GitHub user, and thus the often-expressed wish for a complete and current manual depends on *YOU*. See [Mastering Wikis](https://guides.github.com/features/wikis/) and [Mastering Markdown](https://guides.github.com/features/mastering-markdown/), it's *NOT* :rocket: science. :wink: The [[TODO]] page has a list of pending work items.

[Donate](https://rakshasa.github.io/rtorrent/donate.html) to help keep the creators working on this project.

**Page Contents**

 * [User's Manual](#users-manual)
 * [Modernized Configuration and Commands](#modernized-configuration-and-commands)
 * [Other Information](#other-information)
 * [Download Links](#download-links)
 * [Installation](#installation)
 * [Packages](#packages)
 * [Disclaimer](#disclaimer)

## User's Manual
 * the [[User Guide|User-Guide]] explains how to use the ‘curses’ UI, and what the displayed information actually means.
 * the [[Configuration Guide|Config-Guide]] helps you to adapt rTorrent to serve your needs.
   * [[rTorrent Configuration Template|CONFIG-Template]]
   * [[Watch Directories|TORRENT-Watch-directories]]
   * [[Ratio Handling|RTorrentRatioHandling]]
   * [[Proxy Configuration|Proxy-Configuration]]
   * [[Tor Proxying|Tor-based-Proxying-Guide]]
   * [[Using DHT|Using-DHT]]
   * [[Using XMLRPC with rTorrent|RPC-Setup-XMLRPC]]
   * [[Socket Categories|Socket-Manager-and-Resource-Allocation]]
   * [[Performance Tuning|Performance-Tuning]]
   * [[Favoring one group of torrents over the rest of them|Favoring-group-of-torrents]]
   * [[Auto-Scraping|Auto-Scraping]]
   * [[Logging|LOG-Logging]]
   * [[Migration to the 0.9.x command syntax|RPC-Migration-0.9]]
   * [[Common Tasks in rTorrent|Common-Tasks-in-rTorrent]]
   * [[Choke Groups|Choke-Groups]]
   * [[IP filtering|IP-filtering]]
   * [[rTorrent 0.9 Comprehensive Command list|rTorrent-0.9-Comprehensive-Command-list-(WIP)]]
   * [[Using initial seeding|Using-initial-seeding]]
 * the [[Scripting Guide|Scripting-Guide]] allows ‘power users’ to extend rTorrent's configuration with more complex logic, and control it remotely via XMLRPC.
 * the [[Vagrant|Vagrant]] repository allows easy creation of a test environment for the client.

## Modernized Configuration and Commands

In preparation for `1.0` release, a lot of commands are being updated. Below are some wiki pages for the changes.

 * [[Protocol Encryption Configuration|Protocol-Encryption-Configuration]]
 * [[Socket Manager and Resource Allocation|Socket-Manager-and-Resource-Allocation]]
 * [[Parentheses and Braces Syntax|Parentheses-and-Braces-Syntax]]


## Other Information

 * List of [[Known Issues|Issues]]
 * List of [[Todos|TODO]]

## Download Links

### Release Source Code

#### Stable
 * https://github.com/rakshasa/rtorrent/releases/latest

### All versions
 * https://rakshasa.github.io/rtorrent/

### Static Builds

 * In this [gist](https://gist.github.com/Trogious/8c506cbcecae13415c799fd2b1858085).

## Installation

See the [[Installing]] wiki page for more information on how to compile it, or check the [[Docker]] wiki page for a quick deploy.

## Packages

Please report any package related problems to the package maintainers. Listing of a package here does not imply it has been tested or approved by the author.

rTorrent and libTorrent packages are both available for the following operating systems and distributions:

 * [Debian](https://www.debian.org/) and [Ubuntu](https://ubuntu.com) : Run `apt-get install rtorrent`.
 * [Fedora](https://fedoraproject.org/wiki/Fedora_Project_Wiki) : Run `dnf install rtorrent`.
 * [Gentoo](https://gentoo.org/) : in Portage; see latest version on [libTorrent](https://packages.gentoo.org/packages/net-libs/libtorrent) and [rTorrent](https://packages.gentoo.org/packages/net-p2p/rtorrent).
 * [ROSA](http://wiki.rosalab.ru/en/index.php/Main_Page) : Run `urpmi rtorrent`.
 * [SUSE Linux](http://suse.com/) : latest packages available from Packman for [libTorrent](http://packman.links2linux.de/package/libtorrent) and [rTorrent](http://packman.links2linux.de/package/rtorrent).

 * [Arch Linux](https://www.archlinux.org/) : The latest packages are available by installing with `pacman -S rtorrent`
 * [Void Linux](https://voidlinux.org) : maintained version available in the x86-64 repository. Run `xbps-install -S rtorrent`
 * [Crux](https://crux.nu/) : in the [Crux Ports DB](https://crux.nu/portdb/?command=viewport&name=libtorrent&repo=contrib); see latest version on [libTorrent](https://crux.nu/gitweb/?p=ports/contrib.git;a=tree;f=libtorrent) and [rTorrent](https://crux.nu/gitweb/?p=ports/contrib.git;a=tree;f=rtorrent).
 * [Lunar-Linux](http://www.lunar-linux.org/) : in the moonbase; to install just `lin rtorrent`
 * [Sourcemage GNU/Linux](http://sourcemage.org/) : do a `cast rtorrent` or `cast libtorrent`
 * [NixOS/Nixpkgs](https://www.nixos.org/) : The latest packages are available in Nixpkgs tree, you can using it by doing `nix-shell -p rtorrent` to open a shell with `rtorrent` environment.

 * [FreeBSD](http://www.freebsd.org/) : in [FreshPorts](http://www.freshports.org/); see latest version on [libTorrent](http://www.freshports.org/net-p2p/libtorrent) and [rTorrent](http://www.freshports.org/net-p2p/rtorrent).
 * [NetBSD](http://www.netbsd.org/) : in [pkgsrc](http://www.pkgsrc.org/); `net/rtorrent`.
 * [OpenBSD](http://www.openbsd.org/) : in ports; [net/libtorrent](http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/net/libtorrent/) and [net/rtorrent](http://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/net/rtorrent/) respectively.
 * [OpenDarwin](https://en.wikipedia.org/wiki/Darwin_%28operating_system%29#OpenDarwin) : in ports; `net/libtorrent` and `net/rtorrent` respectively.
 * [macOS](https://en.wikipedia.org/wiki/macOS) : via [HomeBrew](https://brew.sh); `brew install rtorrent`.


## Disclaimer

rTorrent's `libtorrent` is not the same project as the one used by Deluge and some other clients.
If you want to be precise and avoid confusion, refer to *this project's*
library as [``libtorrent-rakshasa``](https://github.com/rakshasa/libtorrent/), and the other one as [``libtorrent-rasterbar``](https://www.libtorrent.org/).

## 

Other related repositories

[rakshasa repositories](https://github.com/rakshasa?tab=repositories)

* [libtorrent](https://github.com/rakshasa/libtorrent)
* [rtorrent](https://github.com/rakshasa/rtorrent)
* [rtorrent-archive](https://github.com/rakshasa/rtorrent-archive)
* [rtorrent-docker](https://github.com/rakshasa/rtorrent-docker)
* [rtorrent-cli](https://github.com/rakshasa/rtorrent-cli)
* [rtgui](https://github.com/rakshasa/rtgui)
* [rtorrent-vagrant](https://github.com/rakshasa/rtorrent-vagrant)
* [rtorrent-doc](https://github.com/rakshasa/rtorrent-doc)
* [bencode-go](https://github.com/rakshasa/bencode-go)
* [rbedit](https://github.com/rakshasa/rbedit)


## Stuff

Feel free to add content as I'm probably not going to write much ATM. Some kind of user guide would be really nice. By committing tickets, wiki changes, etc. you agree to license them under the GNU GPL. Remember to add a short comment describing the changes.