Updated the inline help page to match CONTROLS.md

CHANGELOG.rst

@@ -50,6 +50,7 @@ Features
   message chains and replying to messages, marking messages as read/unread, and
   opening the context of a comment.
 * Added the ability to compose new private messages with the ``C`` key.
+* Updated and enhanced the help ``?`` page.
 
 Bugfixes
 
@@ -60,7 +61,7 @@ Bugfixes
 
 Configuration Changes
 
-* Renamed the following keybindings to be more generic:
+* Renamed the following keybindings to better represent their usage:
 
   * ``SORT_HOT`` -> ``SORT_1``
   * ``SORT_TOP`` -> ``SORT_2``

CONTROLS.md

@@ -26,13 +26,13 @@ The <kbd>/</kbd> key opens a text prompt at the bottom of the screen. You can us
 this to type in the name of the subreddit that you want to open. The following text
 formats are recognized:
 
-- ``python`` - Open a subreddit, shorthand
+- ``/python`` - Open a subreddit, shorthand
 - ``/r/python`` - Open a subreddit
 - ``/r/python/new`` - Open a subreddit, sorted by category
-- ``/r/python/controversial-year`` - Open a subreddit, sorted by category and time period
+- ``/r/python/controversial-year`` - Open a subreddit, sorted by category and time
 - ``/r/python+linux+commandline`` - Open multiple subreddits merged together
-- ``/r/python/comments/30rwj2`` - Open the comments page for a submission
+- ``/comments/30rwj2`` - Open a submission, shorthand
-- ``/comments/30rwj2`` - Open the comments page for a submission, shorthand
+- ``/r/python/comments/30rwj2`` - Open a submission
 - ``/r/front`` - Open your front page
 - ``/u/me`` - View your submissions
 - ``/u/me/saved`` - View your saved content
@@ -48,8 +48,8 @@ formats are recognized:
 ## Authenticated Commands
 
 Some actions require that you be logged in to your reddit account. You can login
-by pressing <kbd>u</kbd> while inside of the program. Once you are logged in,
+by pressing the <kbd>u</kbd> key. Once you are logged in, your username will
-your username will appear in the top-right corner of the screen.
+appear in the top-right corner of the screen.
 
 - <kbd>a</kbd> - Upvote
 - <kbd>z</kbd> - Downvote
@@ -65,36 +65,36 @@ your username will appear in the top-right corner of the screen.
 
 # Subreddit Mode
 
-The following actions can only be performed when you're viewing a subreddit:
+The following actions can be performed when viewing a subreddit:
 
 - <kbd>l</kbd> or <kbd>►</kbd> - View the comments for the selected submission (see [submission mode](#submission-mode))
 - <kbd>o</kbd> or <kbd>ENTER</kbd> - Open the selected submission link using your web browser or ``.mailcap`` config
 - <kbd>SPACE</kbd> - Mark the selected submission as *hidden*
 - <kbd>p</kbd> - Toggle between the currently viewed subreddit and ``/r/front``
-- <kbd>f</kbd> - Open a prompt to search the current subreddit for a given text string
+- <kbd>f</kbd> - Open a prompt to search the current subreddit for a text string
 
 # Submission Mode
 
-The following actions can be performed when you're viewing a submission:
+The following actions can be performed when viewing a submission:
 
 - <kbd>h</kbd> or <kbd>◄</kbd> - Close the submission and return to the previous page
-- <kbd>l</kbd> or <kbd>►</kbd> - View the selected comment using the system's ``$PAGER``
+- <kbd>l</kbd> or <kbd>►</kbd> - View the selected comment using the system's pager
 - <kbd>o</kbd> or <kbd>ENTER</kbd> - Open a link in the comment using your web browser or ``.mailcap`` config
 - <kbd>SPACE</kbd> - Fold or expand the selected comment and its children
-- <kbd>b</kbd> - Send the comment text to the system's ``$URLVIEWER`` application
+- <kbd>b</kbd> - Send the comment text to the system's urlviewer application
-- <kbd>J</kbd> - Move the cursor down the the next comment at the same indentation level
+- <kbd>J</kbd> - Move the cursor down the the next comment at the same indentation
 - <kbd>K</kbd> - Move the cursor up to the parent comment
 
 # Subscription Mode
 
-The following actions can be performed when you're viewing your subscriptions or multireddits:
+The following actions can be performed when viewing your subscriptions or multireddits:
 
-- <kbd>h</kbd> or <kbd>◄</kbd> - Close the subscriptions and return to the previous page
+- <kbd>h</kbd> or <kbd>◄</kbd> - Close your subscriptions and return to the previous page
 - <kbd>l</kbd> or <kbd>►</kbd> - Open the selected subreddit or multireddit
 
 # Inbox Mode
 
-The following actions can be performed when you're viewing your inbox:
+The following actions can be performed when viewing your inbox:
 
 - <kbd>h</kbd> or <kbd>◄</kbd> - Close your inbox and return to the previous page
 - <kbd>l</kbd> or <kbd>►</kbd> - View the context of the selected comment

rtv/docs.py

@@ -29,69 +29,90 @@ Reddit Terminal Viewer
 https://github.com/michael-lazar/rtv
 ====================================
 
-[Commands]
+[Basic Commands]
-  j     : Move the cursor down
+  j     : Move the cursor up
-  k     : Move the cursor up
+  k     : Move the cursor down
-  n     : Move down one page
+  l     : View the currently selected item
-  m     : Move up one page
+  h     : Return to the previous view
-  gg    : Jump to the first post
+  m     : Move the cursor up one page
-  G     : Jump to the last post
+  n     : Move the cursor down one page
-  J     : Jump to the next sibling comment
+  gg    : Jump to the top of the page
-  K     : Jump to the parent comment
+  G     : Jump to the bottom of the page
-  1     : Sort by category 1
+  1-7   : Sort submissions by category
-  2     : Sort by category 2
+  r     : Refresh the content on the current page
-  3     : Sort by category 3
+  u     : Login to your reddit account
-  4     : Sort by category 4
-  5     : Sort by category 5
-  6     : Sort by category 6
-  7     : Sort by category 7
-  p     : Return to the front page
-  r     : Refresh page
-  u     : Login or logout
-  /     : Open the subreddit prompt
-  f     : Open the search prompt
-  ?     : Show the help screen
   q     : Quit
   Q     : Force quit
+  y     : Copy submission permalink to clipboard
+  Y     : Copy submission link to clipboard
+  F2    : Cycle to the previous color theme
+  F3    : Cycle to the next color theme
+  ?     : Show the help screen
+  /     : Open a prompt to select a subreddit
+
+[Authenticated Commands]
   a     : Upvote
   z     : Downvote
-  c     : Compose a new submission/comment/reply
+  c     : Compose a new submission or comment
   C     : Compose a new private message
-  e     : Edit a submission/comment
+  e     : Edit the selected submission or comment
-  d     : Delete a submission/comment
+  d     : Delete the selected submission or comment
-  i     : View inbox
+  i     : View your inbox (see Inbox Mode)
-  s     : Show subscribed subreddits
+  s     : View your subscribed subreddits (see Subscription Mode)
-  S     : Show subscribed multireddits
+  S     : View your subscribed multireddits (see Subscription Mode)
-  w     : Save submission/comment, or mark message as read
+  u     : Logout of your reddit account
-  l     : View comments, or open comment in pager
+  w     : Save the selected submission or comment
-  h     : Return to the previous page
+
-  o     : Open the submission/comment URL
+[Subreddit Mode]
-  SPACE : Hide submission, or fold/expand the selected comment tree
+  l     : View the comments for the selected submission (see Submission Mode)
-  b     : Send submission/comment URLs to a urlview program
+  o     : Open the selected submission link using your web browser
-  y     : Copy submission permalink to the clipboard
+  SPACE : Mark the selected submission as hidden
-  Y     : Copy submission/comment URLs to the clipboard
+  p     : Toggle between the currently viewed subreddit and /r/front
-  F2    : Cycle to previous theme
+  f     : Open a prompt to search the current subreddit for a text string
-  F3    : Cycle to next theme
+
+[Submission Mode]
+  h     : Close the submission and return to the previous page
+  l     : View the selected comment using the system's pager
+  o     : Open a link in the comment using your web browser
+  SPACE : Fold or expand the selected comment and its children
+  b     : Send the comment text to the system's urlviewer application
+  J     : Move the cursor down the the next comment at the same indentation
+  K     : Move the cursor up to the parent comment
+
+[Subscription Mode]
+  h     : Close your subscriptions and return to the previous page
+  l     : Open the selected subreddit or multireddit
+
+[Inbox Mode]
+  h     : Close your inbox and return to the previous page
+  l     : View the context of the selected comment
+  o     : Open the submission of the selected comment
+  c     : Reply to the selected comment or message
+  w     : Mark the selected comment or message as seen
 
 [Prompt]
-  The `/` prompt accepts subreddits in the following formats
+  The / key opens a text prompt at the bottom of the screen. You can use this
+  to type in the name of the subreddit that you want to open. The following
+  text formats are recognized:
 
-  - python
+  /python                      - Open a subreddit, shorthand
-  - /r/python
+  /r/python                    - Open a subreddit
-  - /r/python/new                (sort)
+  /r/python/new                - Open a subreddit, sorted by category
-  - /r/python/controversial-year (sort and order)
+  /r/python/controversial-year - Open a subreddit, sorted by category and time
-  - /r/python/gilded             (gilded within subreddit)
+  /r/python+linux+commandline  - Open multiple subreddits merged together
-  - /r/python+linux              (multireddit)
+  /comments/30rwj2             - Open a submission, shorthand
-  - /r/python/comments/30rwj2    (submission comments)
+  /r/python/comments/30rwj2    - Open a submission
-  - /comments/30rwj2             (submission comments shorthand)
+  /r/front                     - Open your front page
-  - /r/front                     (front page)
+  /u/me                        - View your submissions
-  - /u/me                        (your submissions overview)
+  /u/me/saved                  - View your saved content
-  - /u/me/{saved,hidden}         (your saved or hidden posts)
+  /u/me/hidden                 - View your hidden content
-  - /u/me/{upvoted,downvoted}    (your voted posts)
+  /u/me/upvoted                - View your upvoted content
-  - /u/spez                      (a user's submissions overview)
+  /u/me/downvoted              - View your downvoted content
-  - /u/spez/{submitted,comments} (a user's posts or comments)
+  /u/spez                      - View a user's submissions and comments
-  - /u/multi-mod/m/android       (curated multireddit)
+  /u/spez/submitted            - View a user's submissions
-  - /domain/python.org           (search by domain)
+  /u/spez/comments             - View a user's comments
+  /u/multi-mod/m/android       - Open a user's curated multireddit
+  /domain/python.org           - Search for links for the given domain
 """
 
 BANNER_SUBREDDIT = """