References
==========

.. _cli-usage:

PyroScope CLI Tools Usage
-------------------------

This section is automatically generated and shows the options available
in the *development* version of the code (git HEAD).
See :doc:`usage` for more details on how to use these commands.

.. include:: references-cli-usage.rst


.. _RtXmlRpcReference:

rTorrent XMLRPC
---------------

See the `Commands Reference`_ in the *rTorrent Handbook* for a list of available commands and what they do.
The `Scripting Guide`_ explains how all these fit together.

.. _`Commands Reference`: https://rtorrent-docs.readthedocs.io/en/latest/cmd-ref.html
.. _`Scripting Guide`: https://rtorrent-docs.readthedocs.io/en/latest/scripting.html

XMLRPC Migration
----------------

The syntax of XMLRPC commands changed with rTorrent version 0.8.9,
and continues to change. The old command names and behavior were
replaced with aliases and marked for deprecation, so they still work for now,
but don't rely on that and use the new names instead.

See `XMLRPC Migration`_ in the GitHub wiki for details.

.. _`XMLRPC Migration`: https://github.com/rakshasa/rtorrent/wiki/RPC-Migration-0.9


Books & Other Knowledge Sources
-------------------------------

This and related documentation cannot teach all you need to know in order
to run a torrent client and manage the server it is installed on.

So here are a few references to either books or web resources that help you
to improve your basic know-how, in case you have trouble following some parts of the docs.

**Linux / CLI / Administration**

* `The Debian Administrator's Handbook`_
* `The Linux Command Line`_
* `The Art of Command Line`_
* `Ansible Documentation`_

**Python**

* `The Hitchhiker’s Guide to Python`_
* `Free Python Books`_

.. _The Debian Administrator's Handbook: https://debian-handbook.info/browse/stable/
.. _The Linux Command Line: http://linuxcommand.org/tlcl.php
.. _The Art of Command Line: https://github.com/jlevy/the-art-of-command-line#the-art-of-command-line
.. _Ansible Documentation: https://docs.ansible.com/#ansible-documentation

.. _`The Hitchhiker’s Guide to Python`: http://docs.python-guide.org/
.. _`Free Python Books`: https://github.com/TechBookHunter/Free-Python-Books#free-python-books


External Links
--------------

* `User Mailing List <http://groups.google.com/group/pyroscope-users>`_
* The `rTorrent <https://github.com/rakshasa/rtorrent>`_
  and `libtorrent <https://github.com/rakshasa/libtorrent>`_ projects
* `rTorrent Community Wiki <https://github.com/rtorrent-community/rtorrent-community.github.io/wiki>`_
  and the `rTorrent Handbook <http://rtorrent-docs.rtfd.io/>`_
* `Open HUB <https://www.openhub.net/p/pyroscope/>`_
* `free(code) <http://freecode.com/projects/pyrocore>`_
* `Bintray <https://bintray.com/pkg/show/general/pyroscope/rtorrent-ps/rtorrent-ps>`_
* `pyrobase <https://github.com/pyroscope/pyrobase/wiki>`_


.. _bt-protocol:

BitTorrent Protocol
-------------------

Wikipedia:

* `Protocol <http://en.wikipedia.org/wiki/BitTorrent_(protocol)>`_
* `bencode <http://en.wikipedia.org/wiki/Bencode>`_

BitTorrent standards:

* `Index of BitTorrent Enhancement Proposals <http://www.bittorrent.org/beps/bep_0000.html>`_
