index.rst
[rainbowstream.git] / docs / index.rst
index b36f201..019909c 100644 (file)
@@ -260,13 +260,37 @@ For detaile information, see `theme usage and customization`_.
 Config explanation\r
 ^^^^^^^^^^^^^^^^^^\r
 \r
--  ``THEME`` theme.\r
+-  ``THEME``: current theme.\r
 \r
--  ``ASCII_ART`` Boolen value, decide to diplay your twitter name by ascii art at stream begin or not.\r
+-  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
 \r
--  ``SEARCH_MAX_RECORD`` : max tweets can display on a 'search' command.\r
+-  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
--  ``HOME_TWEET_NUM`` : default tweets to display on a 'home' command.\r
+-  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
+\r
+-  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
+\r
+-  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
+\r
+-  ``TREND_MAX``: default trends to display on 'trend' command.\r
+\r
+-  ``LIST_MAX``: default tweets to display on 'list home' command.\r
+\r
+-  ``ONLY_LIST``: filter list on 'switch' command.\r
+\r
+-  ``IGNORE_LIST``: ignore list on 'switch' command.\r
+\r
+-  ``HISTORY_FILENAME``: name of file which stores input history.\r
+\r
+-  ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
+\r
+-  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
+\r
+-  ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
+\r
+-  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
+\r
+-  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
 \r
 Development\r
 -----------\r