initial draft of document structure done

docs/cmd-ref.rst

@@ -0,0 +1,135 @@
+Commands Reference
+==================
+
+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.
+
+.. 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**
+
+
+Scripting
+------------------
+
+`method.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+`event.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+Logging, Files, and OS
+----------------------
+
+`execute.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+`system.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+`log.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+Bittorrent Protocol
+-------------------
+
+`throttle.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+User Interface
+--------------
+
+`ui.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+`view.*` commands
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**TODO**
+
+
+Miscellaneous
+-------------
+
+**TODO (Groups)**
+
+ * choke_group
+ * convert
+ * dht
+ * directory
+ * elapsed
+ * encoding
+ * fi
+ * file
+ * group
+ * group2
+ * ip_tables
+ * ipv4_filter
+ * keys
+ * network
+ * pieces
+ * protocol
+ * ratio
+ * scheduler
+ * session
+ * strings
+ * trackers
+
+**TODO (singles)**
+
+``rtlistmethods . | grep -v \\.``

docs/contributing.rst

@@ -0,0 +1 @@
+../CONTRIBUTING.rst

docs/cookbook.rst

@@ -0,0 +1,20 @@
+Configuration Cookbook
+======================
+
+To help you with basic configuration tasks, this chapter contains a quick start
+into the ‘scripting language’ rTorrent uses for its configuration files.
+It then goes on showing how to solve some :ref:`common configuration use-cases <common-tasks>`.
+
+
+Quick Start
+-----------
+
+**TODO**
+
+
+.. _common-tasks:
+
+Common Tasks
+------------
+
+**TODO**

docs/index.rst

@@ -7,7 +7,24 @@
 Welcome to the “rTorrent Handbook”!
 ===================================
 
-**TODO**
+This is the handbook for the `rTorrent`_ bittorrent client, written by and for the community.
+See also the `homepage of the community project`_ and the `community wiki`_.
+
+The :doc:`overview` chapter offers you a guided tour through this manual,
+or browse through the table of contents below to find what you're looking for.
+
+If you like what is here but are missing something,
+the best way to fill that hole is to pour what you know into it.
+Every contribution counts, and instead of lamenting the situation,
+please go fix it by taking small steps in the right direction.
+If everyone chimes in, we all profit in the end.
+
+:doc:`contributing` tells you more about how to add your changes to the project.
+
+
+.. _`rTorrent`: https://github.com/rakshasa/rtorrent/wiki
+.. _`homepage of the community project`: https://rtorrent-community.github.io/
+.. _`community wiki`: https://github.com/rtorrent-community/rtorrent-community.github.io/wiki
 
 
 Contents of This Manual
@@ -18,6 +35,11 @@ Contents of This Manual
     :maxdepth: 4
 
     overview
+    installation
+    cookbook
+    scripting
+    cmd-ref
+    contributing
 
 
 Indices & Tables

docs/installation.rst

@@ -0,0 +1,33 @@
+Installation Guide
+==================
+
+This chapter has some pointers to common ways of installing
+*rTorrent* on your machine. It does not provide yet another way to do that,
+because there already are plentiful and redundant sources for that out there.
+
+
+Installation Using OS Packages
+------------------------------
+
+**TODO**
+
+ * the `rTorrent wiki <https://github.com/rakshasa/rtorrent/wiki#packages>`_ lists package names and installation commands for a lot of *Linux* distributions and other operating systems.
+
+
+Automated Installation
+----------------------
+
+**TODO**
+
+
+Installing from Source
+----------------------
+
+**TODO**
+
+
+rTorrent Distributions
+----------------------
+
+ * `rTorrent-PS <https://github.com/pyroscope/rtorrent-ps>`_ is a *rTorrent* distribution (not a fork of it), in form of a set of patches that improve the user experience and stability of official *rTorrent* releases. The notable additions are the more condensed ncurses UI with colorization and a network bandwidth graph, and a default configuration providing many new features, based in part on an extended command set.
+ * `rTorrent-PS-CH <https://github.com/chros73/rtorrent-ps_setup/wiki>`_ puts more patches and a different default configuration on top of *rTorrent-PS*. It also tries to work with the current git HEAD of *rTorrent*, which *rTorrent-PS* does not.

docs/overview.rst

@@ -1,7 +1,18 @@
 Overview
 ========
 
-Introduction
-------------
+The :doc:`installation` has some pointers to common ways of installing
+rTorrent on your machine. It does not provide yet another way to do that,
+because there already are plentiful and redundant sources for that out there.
 
-**TODO**
+To help you with basic configuration tasks, the :doc:`cookbook`
+contains a quick start into the ‘scripting language’ rTorrent uses
+for its configuration files.
+It then goes on showing how to solve some common configuration use-cases.
+
+Building on that, the :doc:`scripting` explains more complex commands and
+constructs of said language. It also helps with controlling rTorrent
+from the outside, via the XMLRPC protocol.
+
+The :doc:`cmd-ref` chapter lists all relevant XMLRPC and ‘private’ commands
+of *rTorrent* with a short explanation.

docs/scripting.rst

@@ -0,0 +1,27 @@
+Scripting Guide
+===============
+
+Building on the :doc:`cookbook`, this chapter explains more complex commands and
+constructs of the scripting language. It also helps with controlling rTorrent
+from the outside, via the XMLRPC protocol.
+
+See the :doc:`cmd-ref` chapter for a list of all relevant XMLRPC and ‘private’ commands
+of *rTorrent* with a short explanation.
+
+
+Introduction
+------------
+
+**TODO**
+
+
+Using XMLRPC for Remote Control
+-------------------------------
+
+**TODO**
+
+* TCP vs. Unix domain sockets
+* raw SCGI vs. HTTP gateways
+* XMLRPC buffer size
+* client libs
+* daemon mode