Welcome to the “rtorrent-ps” Manual!

rTorrent-PS is an extended rTorrent distribution with UI enhancements, colorization, some added features, and a comprehensive standard configuration.

See Overview for a more detailed description and a feature overview, and the rTorrent Handbook for general information regarding rTorrent, its configuration, and XMLRPC commands. The latter includes custom command extensions from rTorrent-PS.

Hint

Community Contacts and Solving Problems

To get in contact and share your experiences with other users of PyroScope, join the pyroscope-users mailing list or the inofficial ##rtorrent channel on irc.freenode.net.

This is also the way to resolve any problems with or questions about your configuration and software installation. Always look into the Trouble-Shooting Guide as a first measure, which is often the fastest way to get back to a working system. That guide also explains how to efficiently report your problem when you cannot fix it yourself.

Full Contents

• Overview
  • Feature Overview
  • Supported Platforms
  • Launching a Demo in Docker
• Installation Guide
  • General Installation Options
  • OS-Specific Installation Options
    • Installation Using Debian Packages
    • Installation on Arch Linux
    • Homebrew Tap for Mac OSX
  • Manual Turn-Key System Setup
    • Introduction
    • Preparatory Steps
    • rTorrent Installation
    • PyroScope Installation
    • rTorrent Instance Setup
    • CLI Tools Configuration
    • First Start and Testing
• Setup & Configuration
  • Setting up Your Terminal Emulator
    • General Concerns
    • Font Selection & Encoding Issues
    • Terminal Setup on Windows
    • Terminal Setup on Linux
  • Color Scheme Configuration
    • Supporting 256 or More Colors
    • Showing a Terminal’s Palette
    • Working With Color Schemes
    • Adding Your Own Color Schemes
  • Customizing the Display Layout
    • Canvas v2 Overview
    • Inspecting Your Display
    • Column Layout Definitions
    • Defining Your Own Columns
    • Disabling Columns
    • Adding Traffic Graphs
• User’s Manual
  • Additional Features
  • Extended Canvas Explained
  • Command Extensions
• Tips & How-Tos
  • Checking Details of the Standard Configuration
  • Validate Self-Signed Certs
• Development Guide
  • Running Integration Tests
  • The Build Script
  • Creating a Release
  • Building the Debian Package
  • Building git HEAD of rTorrent
  • Using Docker for Building Packages
• Trouble-Shooting Guide
  • Reporting Problems
  • Common Problems & Solutions
    • Error in option file: …/05-rt-ps-columns.rc:…: Invalid key
    • Startup Failure: ‘your terminal only supports 8 colors’
    • Startup Failure: ‘libxmlrpc_*.so cannot open shared object file’
• Change History
  • 2018-07-01 v1.1 “Design Your Canvas”
  • 2017-03-12 v1.0 “First version-tagged release”

Indices & Tables

• Index
• Module Index
• Search Page