add detail of share command to document
[rainbowstream.git] / docs / index.rst
index 2cf43517d6aa018c4d84b4f5c5d347f225c62eca..0e9dfea9ee6a23626876dd852816ef9af4b69c6c 100644 (file)
@@ -112,34 +112,27 @@ Here is full list of supported command:
 \r
 **Explore Commands**\r
 \r
--  ``trend`` will show global trending topics. ``trend US`` will show\r
-   trends in United States while ``trend JP Tokyo`` will show trends in\r
-   Tokyo/Japan.\r
+-  ``trend`` will show global trending topics. ``trend US`` will show trends in United States while ``trend JP Tokyo`` will show trends in Tokyo/Japan.\r
 \r
--  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
-   tweets.\r
+-  ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets.\r
 \r
--  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
-   mention tweets.\r
+-  ``notification`` will show your notification from the time you started RainbowStream.\r
+\r
+-  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets.\r
 \r
 -  ``whois @dtvd88`` will show profile of @dtvd88.\r
 \r
--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
-   exactly 9 tweets.\r
+-  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print exactly 9 tweets.\r
 \r
--  ``s noah`` will search the word *‘noah’*. Result will come back with\r
-   highlight. Search can be performed with or without hashtag.\r
+-  ``s noah`` will search the word *‘noah’*. Result will come back with highlight. Search can be performed with or without hashtag.\r
 \r
 **Tweet Commands**\r
 \r
--  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
-   rainbow is god’s promise to noah’*.\r
+-  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the rainbow is god’s promise to noah’*.\r
 \r
--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
-   each tweet beside the time.\r
+-  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.\r
 \r
--  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
-   the quote will be cancelled.\r
+-  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added, the quote will be cancelled.\r
 \r
 -  ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
 \r
@@ -151,21 +144,19 @@ Here is full list of supported command:
 \r
 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
 \r
+-  ``share 12`` will copy link to tweet with *[id=12]* to your clipboard if you are on a Mac, or display it directly if you are on Linux.\r
+\r
 -  ``del 12`` will delete tweet with *[id=12]*.\r
 \r
--  ``show image 12`` will show the image in tweet with *[id=12]* in your\r
-   OS’s image viewer.\r
+-  ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.\r
 \r
--  ``open 12`` will open url in tweet with *[id=12]* in your\r
-   OS’s default browser.\r
+-  ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser.\r
 \r
 **Direct Messages Commands**\r
 \r
--  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
-   messages.\r
+-  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.\r
 \r
--  ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
-   messages.\r
+-  ``thread 2`` will show full thread with [id=2].\r
 \r
 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
 \r
@@ -173,8 +164,7 @@ Here is full list of supported command:
 \r
 **Friends and followers Commands**\r
 \r
--  ``ls fl`` will list all your followers (people who are following\r
-   you).\r
+-  ``ls fl`` will list all your followers (people who are following you).\r
 \r
 -  ``ls fr`` will list all your friends (people who you are following).\r
 \r
@@ -222,21 +212,19 @@ Here is full list of supported command:
 \r
 **Switching Stream Commands**\r
 \r
--  ``switch public #AKB48`` will switch current stream to public stream\r
-   and track keyword ``AKB48``\r
+-  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
 \r
--  ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
-   to provide 2 list:\r
+-  ``switch public #AKB48 -f`` will do exactly as above but will ask you to provide 2 list:\r
 \r
    ``Only nicks`` decide what nicks will be include only.\r
 \r
    ``Ignore nicks``\ decide what nicks will be exclude.\r
 \r
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
-   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+-  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+\r
+-  ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well.\r
 \r
--  ``switch mine`` will switch current stream to personal stream. ``-f``\r
-   and ``-d`` will work as well.\r
+-  ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.\r
 \r
 **Smart shell**\r
 \r
@@ -321,6 +309,8 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``PREFIX``: display string of prompt.\r
 \r
+-  ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
+\r
 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
 \r
 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
@@ -335,6 +325,14 @@ You also can view or set a new value of every config key by ``config`` command (
     + ``#owner``: owner's username with '@'\r
     + ``#tweet``: original tweet\r
 \r
+-  ``THREAD_META_LEFT``: format for meta information of messages from partner which is display in the left of screen.\r
+\r
+-  ``THREAD_META_RIGHT``: format for meta information of messages from you which is display in the right of screen.\r
+\r
+-  ``THREAD_MIN_WIDTH``: minimum width of a message frame.\r
+\r
+-  ``NOTIFY_FORMAT``: format of a notification.\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
@@ -377,6 +375,9 @@ You also can view or set a new value of every config key by ``config`` command (
     + ``#recipient_name``: Message's recipient name\r
     + ``#recipient_nick``: Message's recipient screen name\r
 \r
+In every format, you can use unicode characters like ``\u2665``.\r
+Mac users also can use emoji characters as well (Ex: ``::zap::``).\r
+See `Emoji cheatsheet`_ for details.\r
 \r
 Development\r
 -----------\r
@@ -405,7 +406,6 @@ steps
        source venv/bin/activate\r
        pip install -e .\r
        which rainbowstream # /this-directory/venv/bin/rainbowstream\r
-       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
        # Remove ~/.rainbow_oauth if exists\r
        rainbowstream # local version of rainbowstream\r
 \r
@@ -420,4 +420,4 @@ steps
 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
 .. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
-\r
+.. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/\r