Merge pull request #25 from d2dyno/patch-2

Add qBittorrent info; overhaul readme into markdown.

README.rst

@@ -76,51 +76,58 @@ must reside in the same folder as autotorrent is executed from.
 general
 ~~~~~~~
 
--  db - Path to the database file
--  store\_path - Folder where the virtual folders seeded, resides
--  ignore\_files - A comma seperated list of files that should be
+-  ``db`` - Path to the database file
+-  ``store_path`` - Folder where the virtual folders seeded, resides
+-  ``ignore_files`` - A comma seperated list of files that should be
    ignored (supports wildcards)
--  add\_limit\_size - Max size, in bytes, the total torrent size is
+-  ``add_limit_size`` - Max size, in bytes, the total torrent size is
    allowed to vary
--  add\_limit\_percent - Max percent the total torrent size is allowed
+-  ``add_limit_percent`` - Max percent the total torrent size is allowed
    to vary
--  link\_type - What kind of link should AutoTorrent make? the options are
+-  ``link_type`` - What kind of link should AutoTorrent make? the options are
    hard and soft.
--  scan_mode - options are unsplitable, normal and exact. These can be used
+-  ``scan_mode`` - options are unsplitable, normal and exact. These can be used
    in combination. See the scan_mode section for more information.
 
-the add\_limit\_\* variables allow for downloading of e.g. different
+the ``add_limit_*`` variables allow for downloading of e.g. different
 NFOs and other small files that makes a difference in the torrents.
 
 client
 ~~~~~~
 
--  client - torrent client to use, choices are: rtorrent, deluge and transmission
+-  ``client`` - torrent client to use, choices are: rtorrent, deluge and transmission
 
 rtorrent settings
 *****************
--  url - URL to rtorrent, must be to the XMLRPC server or SCGI server.
--  label - Label added to torrents when added to rtorrent (used in
+-  ``url`` - URL to rtorrent, must be to the XMLRPC server or SCGI server.
+-  ``label`` - Label added to torrents when added to rtorrent (used in
    rutorrent only)
 
 the url supports both SCGI directly and XMLRPC via HTTP.
 
-To use scgi, prefix the url with scgi instead of http, e.g. scgi://127.0.0.1:10000/
+To use scgi, prefix the url with scgi instead of http, e.g. ``scgi://127.0.0.1:10000/``
 
-To use unix socket for scgi, make an url with no ip:port and instead a path, e.g. scgi:///tmp/rtorrent.socket
+To use unix socket for scgi, make an url with no `ip:port` and instead a path, e.g. ``scgi:///tmp/rtorrent.socket``
 
 deluge settings
 ***************
-- host - an ip:port pair, e.g. 127.0.0.1:12345
-- username - deluge rpc username
-- password - deluge rpc password
-- label - label the torrent, remember to enable the label plugin
+- ``host`` - an ip:port pair, e.g. `127.0.0.1:12345`
+- ``username`` - deluge rpc username
+- ``password`` - deluge rpc password
+- ``label`` - label the torrent, remember to enable the label plugin
 
 transmission settings
 *********************
-- url - an url where transmission can be reached, e.g. http://username:password@127.0.0.1:9091
+- ``url`` - an url where transmission can be reached, e.g. ``http://username:password@127.0.0.1:9091``
 
-disks
+qbittorrent settings
+*********************
+- ``url`` - an url where qbittorrent web can be reached, e.g. ``http://127.0.0.1:8080``
+- ``username`` - qbittorrent webui username
+- ``password`` - qbittorrent webui password
+- ``category`` - category applied to torrents added by AutoTorrent (similar to label)
+
+`disks`
 ~~~~~
 
 A list of disks where to build the search database from.
@@ -134,40 +141,40 @@ used in combination and should all improve the end result.
 The modes are named normal, exact and unsplitable. They can be combined by adding a comma
 between them, e.g. ``scan_mode=normal,exact,unsplitable``
 
-Mode: normal
+Mode: ``normal``
 ~~~~~~~~~~~~
 
 It takes the filename and size and tries to find files with same name and size.
 
 This mode cannot handle duplicate filename/size pairs.
 
-Mode: exact
+Mode: ``exact``
 ~~~~~~~~~~~
 
 The perfect way to move torrent client as it tries to set the download path to the old path.
 
 This mode does not allow for missing files and is intended to re-add non-renamed back to a torrent client.
 
-Mode: unsplitable
+Mode: ``unsplitable``
 ~~~~~~~~~~~~~~~~~
 
 This mode takes scene releases and extracted dvd/bluray isos into consideration and relies on the folder it thinks
 is the main / head folder. Perfect for cross-seeding scene releases.
 
-Mode: hash_name
+Mode: ``hash_name``
 ~~~~~~~~~~~~~~~
 
 This mode tries to hashcheck files with the exact name as wanted, but the size might be different (up to 10% different).
 If pieces match, then it is resized to fit original size and written to the destination directory.
 
 Make sure there is enough space in the target directory.
 
-Mode: hash_size
+Mode: ``hash_size``
 ~~~~~~~~~~~~~~~
 
 This mode tries to hashcheck files with the exact size as wanted, but the name might be different.|
 
-Mode: hash_slow
+Mode: ``hash_slow``
 ~~~~~~~~~~~~~~~
 
 This mode tries to hashcheck files with a size within 10% of the original.
@@ -182,12 +189,19 @@ Instructions
 
 Start by installing and configuring.
 
-Step 1, build the database with ``autotorrent-env/bin/autotorrent -r``, this may take some
-time.
+Step 1
+~~~~~~~~~~~~~~~
+Build the database with
+:: 
+    autotorrent-env/bin/autotorrent -r
+this may take some time.
 
-Step 2, have some torrents ready and run
-``autotorrent-env/bin/autotorrent -a path/to/torrents/*.torrent``, this command will
-spit out how it went with adding the torrents.
+Step 2
+~~~~~~~~~~~~~~~
+Have some .torrent files ready and run
+::
+    autotorrent-env/bin/autotorrent -a path/to/torrents/*.torrent
+this command will spit out how it went with adding the torrents.
 
 And you're good to go.
 
@@ -196,33 +210,33 @@ FAQ
 
 **Q: How are files with relative path in the configuration file, found?**
 
-The paths should be relative to the configuration file, e.g. /home/user/autotorrent-env/autotorrent.conf,
-then store_path=store_paths/X/ resolves to /home/user/autotorrent-env/store_path/
+The paths should be relative to the configuration file, e.g. ``/home/user/autotorrent-env/autotorrent.conf``,
+then ``store_path=store_paths/X/`` resolves to ``/home/user/autotorrent-env/store_path/``.
 
 
 **Q: I have three sites I cross-seed between, how do you suggest I structure it?**
 
 Say, you have site X, Y and Z. You want to seed across the sites as they share lots of content.
 You download all your data into /home/user/downloads/. For this you will need three configuration file, one for each site.
 
-AutoTorrent is installed into /home/user/autotorrent-env/.
+AutoTorrent is installed into ``/home/user/autotorrent-env/``.
 
 Only store_path is recommended to vary between the configuration files (the others are optional).
 
-- store_path for site X - /home/user/autotorrent-env/store_paths/X/
-- store_path for site Y - /home/user/autotorrent-env/store_paths/Y/
-- store_path for site Z - /home/user/autotorrent-env/store_paths/Z/
+- ``store_path for site X - /home/user/autotorrent-env/store_paths/X/``
+- ``store_path for site Y - /home/user/autotorrent-env/store_paths/Y/``
+- ``store_path for site Z - /home/user/autotorrent-env/store_paths/Z/``
 
 disks paths can be:
 
-- disk1=/home/user/downloads/
-- disk2=/home/user/autotorrent-env/store_paths/X/
-- disk3=/home/user/autotorrent-env/store_paths/Y/
-- disk4=/home/user/autotorrent-env/store_paths/Z/
+- ``disk1=/home/user/downloads/``
+- ``disk2=/home/user/autotorrent-env/store_paths/X/``
+- ``disk3=/home/user/autotorrent-env/store_paths/Y/``
+- ``disk4=/home/user/autotorrent-env/store_paths/Z/``
 
 **Q: Can I use the same Database file for several configuration files?**
 
-Yes, if they have the same disks. Don't worry about adding the store_path to the disks, AutoTorrent will figure it out.
+Yes, if they have the same disks. Don't worry about adding the `store_path` to the disks, AutoTorrent will figure it out.
 
 **Q: What problems can occur?**
 
@@ -242,8 +256,9 @@ See: http://www.cyberciti.biz/tips/understanding-unixlinux-symbolic-soft-and-har
 
 **Q: Can I have multiple clients configured simultaneously?**
 
-Yes, you can name the section e.g. ``client-goodclient`` instead of just ``client`` and then specify you want to use that
-specific client using the commandline argument ``-l goodclient``
+Yes, this can be done by prefixing a name of your choosing, with ``client-``. For example, you can name the section ``client-goodclient`` instead of just ``client``. Then specify the new client/name without the prefix using the commandline argument 
+:: 
+    autotorrent -l goodclient
 
 License
 -------