Skip to content

Commit

Permalink
cmd-ref: some 'Standard Configuration Sets' stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
pyroscope committed Jun 1, 2018
1 parent f9ff369 commit 3088337
Showing 1 changed file with 59 additions and 6 deletions.
65 changes: 59 additions & 6 deletions docs/cmd-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,23 +212,35 @@ These are called *intermediate:*
Standard Configuration Sets
---------------------------

The following sections explain some core commands added by well-known configuration sets.

If you want other setups (`rtinst`, `QuickBox`, …) to be documented, we accept pull requests.


`rTorrent` Wiki Template
^^^^^^^^^^^^^^^^^^^^^^^^

The `CONFIG Template`_ wiki page defines a few commands in its configuration snippet.
See :ref:`config-deconstructed` for a detailed tour.

**TODO**

.. glossary::

.. _`CONFIG Template`: https://github.com/rakshasa/rtorrent/wiki/CONFIG-Template
cfg.basedir
cfg.watch
cfg.logs

These define important base paths in the file system layout of a `rTorrent` instance,
and are all private. They are used where appropriate to define further paths
like the session directory, and allow easy changes at just one place.

`pyrocore` Configuration
^^^^^^^^^^^^^^^^^^^^^^^^
By default, ``cfg.watch`` and ``cfg.logs`` are sub-dirs of ``cfg.basedir``.

**TODO** check if they belong with "p-m-b"

.. glossary::
system.startup_time

A constant value that holds the :term:`system.time` when the client was started.


d.data_path

Expand All @@ -245,6 +257,21 @@ The `CONFIG Template`_ wiki page defines a few commands in its configuration sni
(cat, (d.directory), /, (d.name))"
.. _`CONFIG Template`: https://github.com/rakshasa/rtorrent/wiki/CONFIG-Template


.. _pyrocore-cfg:

`pyrocore` Configuration
^^^^^^^^^^^^^^^^^^^^^^^^

**TODO** check if they belong with "p-m-b"

In addition to the commands listed here, `pyrocore` also defines :term:`d.data_path`.


.. glossary::

d.session_file

Return path to session file.
Expand Down Expand Up @@ -305,6 +332,7 @@ The `CONFIG Template`_ wiki page defines a few commands in its configuration sni

**TODO**


.. _`auto-scrape.rc`: https://github.com/pyroscope/pyrocore/blob/master/src/pyrocore/data/config/rtorrent.d/auto-scrape.rc


Expand All @@ -313,5 +341,30 @@ The `CONFIG Template`_ wiki page defines a few commands in its configuration sni

**TODO**

In addition to the commands listed here, `pimp-my-box` also defines
:term:`cfg.basedir`, :term:`cfg.watch`, and :term:`cfg.logs`,
and includes anything from :ref:`pyrocore-cfg`.


.. glossary::

pyro.extended

Set ``pyro.extended`` to ``1`` to activate `rTorrent-PS` features.
Note that this *tells* the rest of the configuration that it can
safely use the extended command set – it *won't* magically make a
vanilla `rTorrent` an extended one.

Starting with `rTorrent-PS 1.1+`, this setting is detected automatically,
thanks to :term:`system.has`.

pyro.bin_dir

A constant that should be set to the ``bin`` directory
where you installed the `pyrocore` tools.

Make sure you end it with a ``/``;
if this is left empty, then the shell's path is searched.


.. END cmd-ref

0 comments on commit 3088337

Please sign in to comment.