requirements for repeatable install

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 44cc06852dd3f5875b0ec643e1acc786c79dd928..f740f10bd25300b478cb314de7d0bfb35b2c86eb 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -113,6 +113,16 @@ provided as follows:
 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default
 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.
 
+If you would like to specify an alternate location for storing the OAuth credential files for both twitter and pocket you can do so with the ``--twitter-auth`` and ``--pocket-auth`` settings. This is also useful if you wish to have multiple accounts for rainbowstream. Specify a location as follows:
+
+.. code:: bash
+
+    rainbowstream --twitter-auth /path/to/twitter_oauth
+    # or using the short form:
+    rainbowstream -ta /path/to/twitter_oauth
+
+If the oauth file doesn't exist at the location you specified then a new one will be created and you'll be required to autenticate with Twitter again.
+
 The interactive mode
 ^^^^^^^^^^^^^^^^^^^^
 
@@ -315,9 +325,11 @@ For detaile information, see `theme usage and customization`_.
 Config explanation
 ^^^^^^^^^^^^^^^^^^
 
-Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the `default config`_ to solve format problems.
+Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config. If you mess up the JSON format the app will still work but you'll need to overwrite your custom config with the `default config`_ to solve format problems.
+
+If you would like to specify a different location for your custom config you can set the ``RAINBOW_CONFIG`` environment variable to the location of your custom config.
 
-You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
+You also can view or set a new value of every config key with the ``config`` command (See **Interactive mode** section above).
 
 -  ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.
 
@@ -351,8 +363,9 @@ You also can view or set a new value of every config key by ``config`` command (
 -  ``QUOTE_FORMAT``: format when quote a tweet
 
     + ``#comment``: Your own comment about the tweet
-    + ``#owner``: owner's username with '@'
+    + ``#owner``: owner's username *without* '@'
     + ``#tweet``: original tweet
+    + ``#tid``: the tweet id on Twitter
 
 -  ``THREAD_META_LEFT``: format for meta information of messages from partner which is display in the left of screen.