Skip to content

Commit

Permalink
Merge pull request #77 from nloadholtes/curses-docs
Browse files Browse the repository at this point in the history
Updating the docs with information about and commands for the curses UI
  • Loading branch information
ihabunek committed Dec 30, 2018
2 parents 7195a05 + 56ede74 commit 5e7b4d3
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`` to move up the list of tweets
* ``j`` or ``down arrow`` 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.*

0 comments on commit 5e7b4d3

Please sign in to comment.