Skip to content

Commit

Permalink
std config cmds, and a few canvas_v2 ones
Browse files Browse the repository at this point in the history
  • Loading branch information
pyroscope committed Jun 1, 2018
1 parent 705a2cc commit 21bc1bc
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 52 deletions.
105 changes: 105 additions & 0 deletions docs/cmd-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,4 +209,109 @@ These are called *intermediate:*
* ``group.‹name›.ratio.upload.set`` → ``group2.‹name›.ratio.upload.set``


Standard Configuration Sets
---------------------------

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

The `CONFIG Template`_ wiki page defines a few commands in its configuration snippet.

**TODO**


.. _`CONFIG Template`: https://github.com/rakshasa/rtorrent/wiki/CONFIG-Template


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

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

.. glossary::

d.data_path

Return path to an item's data – this is never empty, unlike :term:`d.base_path`.
Multi-file items return a path ending with a ``/``.

Definition:

.. code-block:: ini
method.insert = d.data_path, simple,\
"if=(d.is_multi_file),\
(cat, (d.directory), /),\
(cat, (d.directory), /, (d.name))"
d.session_file

Return path to session file.

Definition:

.. code-block:: ini
method.insert = d.session_file, simple, "cat=(session.path), (d.hash), .torrent"
d.tracker.bump_scrape

Send a scrape request for an item, set its ``tm_last_scrape`` custom attribute to now,
and save the session data. Part of `auto-scrape.rc`_, and bound to the ``&`` key
in *rTorrent-PS*, to manually request a scrape update.


d.timestamp.downloaded
d.last_active

**TODO**

d.watch.start
d.watch.startable
cfg.watch.start
cfg.watch.start.set

**TODO**

``d.watch.startable`` is private.

d.category.set
load.category
load.category.normal
load.category.start

**TODO**

The `load` commands are private.

d.last_xfer
d.last_xfer.is_active

**TODO**

event.download.finished_delayed
event.download.finished_delayed.interval
event.download.finished_delayed.interval.set

**TODO**

quit

**TODO**

startup_time

**TODO**

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


`pimp-my-box` Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^

**TODO**


.. END cmd-ref
56 changes: 6 additions & 50 deletions docs/include-cmd-items.rst
Original file line number Diff line number Diff line change
Expand Up @@ -705,14 +705,10 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i
**TODO**


.. note::

The following are only available in *rTorrent-PS*!

.. glossary::

d.tracker_domain

**rTorrent-PS only**

Returns the (shortened) tracker domain of the given download item. The
chosen tracker is the first HTTP one with active peers (seeders or
leechers), or else the first one.
Expand All @@ -725,55 +721,15 @@ When called within configuration methods or in a ``Ctrl-X`` prompt, the target i
view.sort_new = trackers, "compare=,d.tracker_domain=,d.name="
view.sort_current = trackers, "compare=,d.tracker_domain=,d.name="
d.tracker_scrape.complete
d.tracker_scrape.downloaded
d.tracker_scrape.incomplete

.. note::

The following commands are part of the default ``pyrocore`` configuration!

.. glossary::

d.data_path

Return path to an item's data – this is never empty, unlike :term:`d.base_path`.
Multi-file items return a path ending with a ``/``.

Definition:

.. code-block:: ini
method.insert = d.data_path, simple,\
"if=(d.is_multi_file),\
(cat, (d.directory), /),\
(cat, (d.directory), /, (d.name))"
d.session_file

Return path to session file.

Definition:

.. code-block:: ini
method.insert = d.session_file, simple, "cat=(session.path), (d.hash), .torrent"
d.tracker.bump_scrape

Send a scrape request for an item, set its ``tm_last_scrape`` custom attribute to now,
and save the session data. Part of `auto-scrape.rc`_, and bound to the ``&`` key
in *rTorrent-PS*, to manually request a scrape update.


d.timestamp.downloaded
d.last_active
**rTorrent-PS 1.1+ only**

**TODO**


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


.. _f-commands:

`f.*` commands
Expand Down
18 changes: 16 additions & 2 deletions docs/include-cmd-ui.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _ui-commands:

`ui.*` commands
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^

Commands in this group control aspects of the ‘curses’ UI.

Expand Down Expand Up @@ -75,6 +75,7 @@ Commands in this group control aspects of the ‘curses’ UI.
"ui.bind_key = download_list, ^, ui.current_view.set=rtcontrol"
ui.color.custom1…9
ui.color.alarm
ui.color.complete
ui.color.even
Expand Down Expand Up @@ -121,6 +122,19 @@ Commands in this group control aspects of the ‘curses’ UI.
See the `color scheme for 256 xterm colors`_ for an example.


ui.canvas_color
ui.canvas_color.set

**rTorrent-PS 1.1+ only**

**TODO**

ui.column.render

**rTorrent-PS 1.1+ only**

**TODO**

ui.focus.end
ui.focus.home
ui.focus.pgdn
Expand All @@ -141,7 +155,7 @@ Commands in this group control aspects of the ‘curses’ UI.

.. code-block:: ini
# rTorrent-PS 0.*+ only
# rTorrent-PS 0.*+ only, obsolete with 1.1+
**TODO**

Expand Down

0 comments on commit 21bc1bc

Please sign in to comment.