cmdref: using includes, and added the first command lists

docs/cmd-ref.rst

@@ -5,102 +5,43 @@ The reference chapter lists all relevant XMLRPC and ‘private’ commands
 of *rTorrent* with a short explanation.
 See :doc:`scripting` on how to use these commands.
 
+**Use the search box** in the sidebar to find specific commands,
+or the :ref:`search`.
+The :ref:`generated index <genindex>` also lists all the commmand names.
+
+
 .. contents:: List of Command Groups
     :local:
 
 
-
 Download Items and Attributes
 -----------------------------
 
-`d.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`f.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`p.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`t.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`load.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
+.. include:: include-cmd-items.rst
 
 
 Scripting
 ------------------
 
-`method.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`event.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
+.. include:: include-cmd-scripting.rst
 
 
 Logging, Files, and OS
 ----------------------
 
-`execute.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`system.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`log.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
+.. include:: include-cmd-system.rst
 
 
 Bittorrent Protocol
 -------------------
 
-`throttle.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
+.. include:: include-cmd-bt.rst
 
 
 User Interface
 --------------
 
-`ui.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
-
-
-`view.*` commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-**TODO**
+.. include:: include-cmd-ui.rst
 
 
 Miscellaneous

docs/include-cmd-bt.rst

@@ -0,0 +1,6 @@
+.. _throttle-commands:
+
+`throttle.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**

docs/include-cmd-items.rst

@@ -0,0 +1,38 @@
+.. _d-commands:
+
+`d.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+.. _f-commands:
+
+`f.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+.. _p-commands:
+
+`p.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+.. _t-commands:
+
+`t.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+.. _load-commands:
+
+`load.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**

docs/include-cmd-scripting.rst

@@ -0,0 +1,14 @@
+.. _method-commands:
+
+`method.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+.. _event-commands:
+
+`event.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**

docs/include-cmd-system.rst

@@ -0,0 +1,158 @@
+.. _execute-commands:
+
+`execute.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. glossary::
+
+    execute2
+
+        **TODO**
+
+    execute.capture
+    execute.capture_nothrow
+
+        **TODO**
+
+    execute.nothrow
+    execute.nothrow.bg
+    execute.throw
+    execute.throw.bg
+
+        **TODO**
+
+    execute.raw
+    execute.raw.bg
+    execute.raw_nothrow
+    execute.raw_nothrow.bg
+
+        **TODO**
+
+
+.. _system-commands:
+
+`system.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. glossary::
+
+    system.listMethods
+    system.methodExist
+    system.methodHelp
+    system.methodSignature
+    system.capabilities
+    system.getCapabilities
+
+        **TODO**
+
+    system.multicall
+
+        **TODO**
+
+    system.shutdown
+
+        **TODO**
+
+    system.api_version
+    system.client_version
+    system.library_version
+
+        **TODO**
+
+    system.colors.enabled
+    system.colors.max
+    system.colors.rgb
+
+        **TODO**
+
+    system.cwd
+    system.cwd.set
+
+        **TODO**
+
+    system.env
+
+        **TODO**
+
+    system.file.allocate
+    system.file.allocate.set
+
+        **TODO**
+
+    system.file.max_size
+    system.file.max_size.set
+
+        **TODO**
+
+    system.file.split_size
+    system.file.split_size.set
+    system.file.split_suffix
+    system.file.split_suffix.set
+
+        **TODO**
+
+    system.file_status_cache.prune
+    system.file_status_cache.size
+
+        **TODO**
+
+    system.files.closed_counter
+    system.files.failed_counter
+    system.files.opened_counter
+
+        **TODO**
+
+    system.hostname
+
+        **TODO**
+
+    system.pid
+
+        **TODO**
+
+    system.random
+
+        **TODO**
+
+    system.time
+    system.time_seconds
+    system.time_usec
+
+        **TODO**
+
+    system.umask.set
+
+        **TODO**
+
+
+.. _log-commands:
+
+`log.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. glossary::
+
+    log.add_output
+
+        **TODO**
+
+    log.execute
+    log.xmlrpc
+
+        **TODO**
+
+    log.open_file
+    log.open_gz_file
+
+        **TODO**
+
+    log.open_file_pid
+    log.open_gz_file_pid
+
+        **TODO**
+
+    log.vmmap.dump
+
+        **TODO**
+
+.. END cmd-system

docs/include-cmd-ui.rst

@@ -0,0 +1,14 @@
+.. _ui-commands:
+
+`ui.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+.. _view-commands:
+
+`view.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**