diff --git a/CONTROLS.md b/CONTROLS.md new file mode 100644 index 0000000..faa836f --- /dev/null +++ b/CONTROLS.md @@ -0,0 +1,103 @@ +# Controls + +## Basic Commands + +- j or ▲ - Move the cursor up +- k or ▼ - Move the cursor down +- l or ► - View the currently selected item +- h or ◄ - Return to the previous view +- m or PgUp - Move the cursor up one page +- n or PgDn - Move the cursor down one page +- gg - Jump to the top of the page +- G - Jump to the bottom of the page +- 1 to 7 - Sort submissions by category +- r or F5 - Refresh the content on the current page +- u - Login to your reddit account +- 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 + +The / key opens a command prompt at the bottom of the screen that +can be used to navigate to specific subreddits or other pages. The following +formats are recognized: + +- ``python`` - Open a subreddit, shorthand +- ``/r/python`` - Open a subreddit +- ``/r/python/new`` - Open a subreddit, sort by category +- ``/r/python/controversial-year`` - Open a subreddit, sort by category and time period +- ``/r/python+linux+commandline`` - Open multiple subreddits merged together +- ``/r/python/comments/30rwj2`` - Open the comments page for a submission +- ``/comments/30rwj2`` - Open the comments page for a submission, shorthand +- ``/r/front`` - Open your front page +- ``/u/me`` - View your submissions +- ``/u/me/saved`` - View your saved content +- ``/u/me/hidden`` - View your hidden content +- ``/u/me/upvoted`` - View your upvoted content +- ``/u/me/downvoted`` - View your downvoted content +- ``/u/spez`` - View a user's submissions and comments +- ``/u/spez/submitted`` - View a user's submissions +- ``/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 + +## Authenticated Commands + +Some actions require that you be logged in to your reddit account. You can login +by pressing u while inside of the program. Once you are logged in, +your username will appear in the top-right corner of the screen. + +- a - Upvote +- z - Downvote +- c - Compose a new submission or comment +- C - Compose a new private message +- e - Edit the selected submission or comment +- d - Delete the selected submission or comment +- i - View your inbox (see [inbox mode](#inbox-mode)) +- s - View your subscribed subreddits (see [subscription mode](#subscription-mode)) +- S - View your subscribed multireddits (see [subscription mode](#subscription-mode)) +- u - Logout of your reddit account +- w - Save the selected submission or comment + +# Subreddit Mode + +The following actions can only be performed when you're viewing a subreddit: + +- l or ► - View the comments for the selected submission (see [submission mode](#submission-mode)) +- o or ENTER - Open the selected submission link using your web browser or ``.mailcap`` config +- SPACE - Mark the selected submission as *hidden* +- p - Toggle between the currently viewed subreddit and ``/r/front`` +- f - Open a prompt to search the current subreddit for a given text string + +# Submission Mode + +The following actions can be performed when you're viewing a submission: + +- h or ◄ - Close the submission and return to the previous page +- l or ► - View the selected comment using the system's ``$PAGER`` +- o or ENTER - Open a link in the comment using your web browser or ``.mailcap`` config +- SPACE - Hide the selected comment tree, or show the comment tree if it is hidden +- b - Send the comment text to the system's ``$URLVIEWER`` application +- J - Move the cursor down the the next comment that is at the same level as the current selection +- K - Move the cursor up to the parent comment of the current selection + +# Subscription Mode + +The following actions can be performed when you're viewing your subscriptions or multireddits: + +- h or ◄ - Close the subscriptions and return to the previous page +- l or ► - Open the selected subreddit or multireddit + +# Inbox Mode + +The following actions can be performed when you're viewing your inbox: + +- h or ◄ - Close your inbox and return to the previous page +- l or ► - Open the context for the selected comment reply +- o or Enter - Open the submission for the selected comment reply +- c - Reply to the selected comment or private message +- w - Mark that you have read the selected message diff --git a/CONTROLS.rst b/CONTROLS.rst deleted file mode 100644 index 442d49f..0000000 --- a/CONTROLS.rst +++ /dev/null @@ -1,80 +0,0 @@ -======== -Controls -======== - --------------- -Basic Commands --------------- - -:``j``/``k`` or ``▲``/``▼``: Move the cursor up/down -:``m``/``n`` or ``PgUp``/``PgDn``: Jump to the previous/next page -:``gg``/``G``: Jump to the top/bottom of the page -:``1-6``: Toggle post order (*hot*, *top*, *rising*, *new*, *controversial*, *gilded*) -:``r`` or ``F5``: Refresh page content -:``u``: Log in or switch accounts -:``/``: Open a prompt to switch subreddits -:``?``: Show the help screen -:``q``/``Q``: Quit/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 - ----------------------- -Authenticated Commands ----------------------- - -Some actions require that you be logged in to your reddit account. -You can log in by pressing ``u`` while inside of the program. -Once you are logged in, your username will appear in the top-right corner of the screen. - -:``a``/``z``: Upvote/downvote -:``c``: Compose a new post or comment -:``e``: Edit an existing post or comment -:``d``: Delete an existing post or comment -:``i``: Check if you have any unread messages -:``s``: View a list of subscribed subreddits -:``S``: View a list of subscribed multireddits -:``w``: Save a submission - --------------- -Subreddit Mode --------------- - -In addition to the basic commands, the following actions can be performed when you're viewing a subreddit . - -:``l`` or ``►``: Enter the selected submission -:``o`` or ``ENTER``: Open the submission link with your web browser -:``SPACE``: Hide the selected submission -:``p``: Toggle between the front page and the last visited subreddit -:``f``: Open a prompt to search the current subreddit -:``/``: Open a prompt to switch subreddits - -The ``/`` prompt accepts subreddits in the following formats - -* ``python`` -* ``/r/python`` -* ``/r/python/new`` -* ``/r/python/controversial-year`` -* ``/r/python/gilded`` -* ``/r/python+linux`` supports multireddits -* ``/r/front`` will redirect to the front page -* ``/u/me`` will display your submissions -* ``/u/saved`` will display your saved submissions -* ``/u/spez`` will display submissions from any other user -* ``/u/multi-mod/m/android`` will display a multireddit curated by a user -* ``/domain/python.org`` will display submissions to the stated domain - ---------------- -Submission Mode ---------------- - -In addition to the basic commands, the following actions can be performed when you're viewing a submission. - -:``h`` or ``◄``: Return to the subreddit -:``l`` or ``►``: Open the selected comment in a new window -:``o`` or ``ENTER``: Open the comment permalink with your web browser -:``SPACE``: Fold the selected comment, or load additional comments -:``b``: Display URLs with urlview -:``J``: Move cursor to next sibling comment -:``K``: Move cursor to parent comment diff --git a/README.md b/README.md index f22fbd6..7288dee 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ Press / to open the navigation prompt, where you can type things like - ``/u/multi-mod/m/art`` - ``/domain/github.com`` -See [CONTROLS](CONTROLS.rst) for the full list of commands. +See [CONTROLS](CONTROLS.md) for the full list of commands. ## Settings