From 461e05f16f4b92e241fbdbd7fe65a378cd995c25 Mon Sep 17 00:00:00 2001 From: Nick Loadholtes Date: Mon, 8 Oct 2018 10:23:42 -0400 Subject: [PATCH] Updating the docs with information about and commands for the curses UI --- docs/usage.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/usage.rst b/docs/usage.rst index b958bbc..97f098f 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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.*