Merge 9a03cd6 into 1f96d87

README.rst

@@ -67,10 +67,23 @@ Upgrading from Github (develop)
 
     autotorrent-env/bin/pip install git+https://github.com/JohnDoee/autotorrent.git#develop --upgrade --force-reinstall
 
+Flags
+-------------
+- ``-a FILE, --addfile FILE`` - Add a new torrent file to the client. Wildcards can be used to expand to all files in a folder (eg: ``-a /some/folder/*.torrent``)
+- ``-c  CONFIG_FILE, --config CONFIG_FILE`` - Path to config file. Defaults to current terminal folder.
+- ``--create_config`` - Creates a new configuration file.
+- ``-d, --delete_torrents`` - Delete .torrent files when they are added to the client succesfully.
+- ``--dry-run`` - Don't add any torrents to client, just scan for files needed for torrents.
+- ``-h, --help`` - Shows help message and exits.
+- ``-l CLIENT, --client CLIENT`` - Name of client to use (when multiple configured). Read more here: clients_
+- ``-r, --rebuild`` - Rebuilds the database (necessary for new files/file changes on disk).
+- ``-t, --test-connection`` - Test the connection to the torrent client.
+- ``--verbose`` - Increase output verbosity.
+
 Configuration
 -------------
 
-All settings can be found and changed in autotorrent.conf, this file
+All settings can be found and changed in ``autotorrent.conf``, this file
 must reside in the same folder as autotorrent is executed from.
 
 general
@@ -111,7 +124,7 @@ To use unix socket for scgi, make an url with no `ip:port` and instead a path, e
 
 deluge settings
 ***************
-- ``host`` - an ip:port pair, e.g. `127.0.0.1:12345`
+- ``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
@@ -208,14 +221,14 @@ And you're good to go.
 FAQ
 ---
 
-**Q: How are files with relative path in the configuration file, found?**
-
+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/``.
 
 
-**Q: I have three sites I cross-seed between, how do you suggest I structure it?**
-
+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.
 
@@ -234,33 +247,34 @@ disks paths can be:
 - ``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?**
-
+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.
 
-**Q: What problems can occur?**
-
+Q: What problems can occur?
+~~~~~~~~~~~~~~~
 One big problem is that the files are not checked for their actual content, just if their filename matches and size matches.
 If AutoTorrent tries to use a file that is not complete, then you can end up sending loads of garbage to innocent peers,
 alhough they should blackball you quite fast.
 
-**Q: I want to cross-seed RARed scene releases, what do you think about that?**
-
+Q: I want to cross-seed RARed scene releases, what do you think about that?
+~~~~~~~~~~~~~~~
 The actual .rar files must be completely downloaded and the same size. Things that can vary are: nfos, sfvs, samples and subs.
 
 The releases must also have an sfv in the same folder as the rar files files.
 
-**Q: What are hardlinks and what are the risks or problems associated with using them?**
-
+Q: What are hardlinks and what are the risks or problems associated with using them?
+~~~~~~~~~~~~~~~
 See: http://www.cyberciti.biz/tips/understanding-unixlinux-symbolic-soft-and-hard-links.html
 
-**Q: Can I have multiple clients configured simultaneously?**
-
+.. _clients:
+Q: Can I have multiple clients configured simultaneously?
+~~~~~~~~~~~~~~~
 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
 -------
 
-MIT, see LICENSE
+MIT, see [LICENSE](../blob/master/LICENSE)