_images/logo.png

Welcome to pyrocore’s documentation!

pyrocore is a collection of tools for the BitTorrent protocol and especially the rTorrent client. They enable you to filter rTorrent’s item list for displaying or changing selected items, also creating, inspecting and changing .torrent files, and much more.

An optional daemon process named pyrotorque can add flexible queue management for rTorrent, starting items added in bulk slowly over time according to customizable rules.

It can also watch a directory tree recursively for new metafiles using inotify. That means .torrent files you drop anywhere into that watched tree are loaded instantaneously, without any polling and no extra configuration for nested directories.

Note

The PyroScope command line utilities (i.e. pyrocore) are not the same as `rTorrent-PS`_, and they work perfectly fine without it; the same is true the other way ‘round. It’s just that both projects unsurprisingly have synergies if used together, and some features do only work when both are present.

You absolutely must read the first three chapters Overview, Installation Guide, and Configuration Guide, and follow their instructions. Otherwise pyrocore utilities won’t work at all or not properly, if you do not provide an adequate config.ini file, and also modify the rTorrent one to provide some essential data and commands.

Once you got everything basically working, User’s Manual will show you all the common commands and use-cases. Further chapters then explain more complex use-cases and features that might not appeal or apply to you.

https://raw.githubusercontent.com/pyroscope/pyrocore/master/docs/_static/img/help.png

To get in contact and share your experiences with other users of PyroScope, join the rtorrent-community channel pyroscope-tools on Gitter.

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.

Contents of This Manual

Indices & Tables