xarvos/witchie
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updating the docs with information about and commands for the curses UI

Browse source
This commit is contained in:
Nick Loadholtes 2018-10-08 10:23:42 -04:00
parent c2af5a879c
commit 461e05f16f
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/usage.rst
View file

@ -99,3 +99,20 @@ It is possible to pipe in the status text:
echo "Text to post" | toot post
cat post.txt | toot post
toot post < post.txt
Using the Curses UI
~~~~~~~
toot has an expimental curses based console UI. The command to start it is ``toot curses``.
To navigate the UI use these commands:
* ``k`` or ``up arrow`` or ``A`` to move up the list of tweets
* ``j`` or ``down arrow`` or ``B`` to move down the list of tweets
* ``h`` to show a help screen
* ``v`` to view the current toot in a browser (this is great for seeing the comment thread on a toot)
* ``q`` to quit the curses interface and return to the command line
* ``s`` to show sensitive content. (This is per-toot, and there will be a read bar in the toot to indicate that it is there.)
*Note that the curses UI is not available on Windows.*