Update index.rst
authorOrakaro <nhatminh_179@hotmail.com>
Sun, 27 Jul 2014 02:27:10 +0000 (11:27 +0900)
committerOrakaro <nhatminh_179@hotmail.com>
Sun, 27 Jul 2014 02:27:10 +0000 (11:27 +0900)
docs/index.rst

index dab891a..f4ed3ae 100644 (file)
@@ -307,6 +307,24 @@ You can view or set a new value of every config key by ``config`` command (See *
 \r
 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
 \r
+-  ``FORMAT``: display format for tweet and message.\r
+\r
+  + `CLOCK_FORMAT`: time format, see `Python's strftime format`_.\r
+  + `DISPLAY`: decide how tweet will be printed.\r
\r
+    + `#name`: Twitter's name\r
+    + `#nick`: Twitter's screen name\r
+    + `#clock`: Datetime\r
+    + `#id`: ID\r
+    + `#fav`: favorited symbol\r
+    + `#tweet`: Tweet's content\r
+    + `#sender_name`: Message's sender name\r
+    + `#sender_nick`: Message's sender screen name\r
+    + `#to`: '>>>' symbol\r
+    + `#recipient_name`: Message's recipient name\r
+    + `#recipient_nick`: Message's recipient screen name\r
+\r
+\r
 Development\r
 -----------\r
 \r
@@ -345,4 +363,6 @@ steps
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
+.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
+\r
 \r