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