Update the CONTROLS documentation and move from rst to md
This commit is contained in:
Michael Lazar
103
CONTROLS.md
Normal file
103
CONTROLS.md
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
# Controls
|
||||||
|
|
||||||
|
## Basic Commands
|
||||||
|
|
||||||
|
- <kbd>j</kbd> or <kbd>▲</kbd> - Move the cursor up
|
||||||
|
- <kbd>k</kbd> or <kbd>▼</kbd> - Move the cursor down
|
||||||
|
- <kbd>l</kbd> or <kbd>►</kbd> - View the currently selected item
|
||||||
|
- <kbd>h</kbd> or <kbd>◄</kbd> - Return to the previous view
|
||||||
|
- <kbd>m</kbd> or <kbd>PgUp</kbd> - Move the cursor up one page
|
||||||
|
- <kbd>n</kbd> or <kbd>PgDn</kbd> - Move the cursor down one page
|
||||||
|
- <kbd>gg</kbd> - Jump to the top of the page
|
||||||
|
- <kbd>G</kbd> - Jump to the bottom of the page
|
||||||
|
- <kbd>1</kbd> to <kbd>7</kbd> - Sort submissions by category
|
||||||
|
- <kbd>r</kbd> or <kbd>F5</kbd> - Refresh the content on the current page
|
||||||
|
- <kbd>u</kbd> - Login to your reddit account
|
||||||
|
- <kbd>q</kbd> - Quit
|
||||||
|
- <kbd>Q</kbd> - Force quit
|
||||||
|
- <kbd>y</kbd> - Copy submission permalink to clipboard
|
||||||
|
- <kbd>Y</kbd> - Copy submission link to clipboard
|
||||||
|
- <kbd>F2</kbd> - Cycle to the previous color theme
|
||||||
|
- <kbd>F3</kbd> - Cycle to the next color theme
|
||||||
|
- <kbd>?</kbd> - Show the help screen
|
||||||
|
- <kbd>/</kbd> - Open a prompt to select a subreddit
|
||||||
|
|
||||||
|
The <kbd>/</kbd> 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 <kbd>u</kbd> while inside of the program. Once you are logged in,
|
||||||
|
your username will appear in the top-right corner of the screen.
|
||||||
|
|
||||||
|
- <kbd>a</kbd> - Upvote
|
||||||
|
- <kbd>z</kbd> - Downvote
|
||||||
|
- <kbd>c</kbd> - Compose a new submission or comment
|
||||||
|
- <kbd>C</kbd> - Compose a new private message
|
||||||
|
- <kbd>e</kbd> - Edit the selected submission or comment
|
||||||
|
- <kbd>d</kbd> - Delete the selected submission or comment
|
||||||
|
- <kbd>i</kbd> - View your inbox (see [inbox mode](#inbox-mode))
|
||||||
|
- <kbd>s</kbd> - View your subscribed subreddits (see [subscription mode](#subscription-mode))
|
||||||
|
- <kbd>S</kbd> - View your subscribed multireddits (see [subscription mode](#subscription-mode))
|
||||||
|
- <kbd>u</kbd> - Logout of your reddit account
|
||||||
|
- <kbd>w</kbd> - Save the selected submission or comment
|
||||||
|
|
||||||
|
# Subreddit Mode
|
||||||
|
|
||||||
|
The following actions can only be performed when you're 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
|
||||||
|
|
||||||
|
# Submission Mode
|
||||||
|
|
||||||
|
The following actions can be performed when you're 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>o</kbd> or <kbd>ENTER</kbd> - Open a link in the comment using your web browser or ``.mailcap`` config
|
||||||
|
- <kbd>SPACE</kbd> - Hide the selected comment tree, or show the comment tree if it is hidden
|
||||||
|
- <kbd>b</kbd> - Send the comment text to the system's ``$URLVIEWER`` application
|
||||||
|
- <kbd>J</kbd> - Move the cursor down the the next comment that is at the same level as the current selection
|
||||||
|
- <kbd>K</kbd> - 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:
|
||||||
|
|
||||||
|
- <kbd>h</kbd> or <kbd>◄</kbd> - Close the 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:
|
||||||
|
|
||||||
|
- <kbd>h</kbd> or <kbd>◄</kbd> - Close your inbox and return to the previous page
|
||||||
|
- <kbd>l</kbd> or <kbd>►</kbd> - Open the context for the selected comment reply
|
||||||
|
- <kbd>o</kbd> or <kbd>Enter</kbd> - Open the submission for the selected comment reply
|
||||||
|
- <kbd>c</kbd> - Reply to the selected comment or private message
|
||||||
|
- <kbd>w</kbd> - Mark that you have read the selected message
|
||||||
80
CONTROLS.rst
80
CONTROLS.rst
@@ -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
|
|
||||||
@@ -114,7 +114,7 @@ Press <kbd>/</kbd> to open the navigation prompt, where you can type things like
|
|||||||
- ``/u/multi-mod/m/art``
|
- ``/u/multi-mod/m/art``
|
||||||
- ``/domain/github.com``
|
- ``/domain/github.com``
|
||||||
|
|
||||||
See [CONTROLS](CONTROLS.rst) for the full list of commands.
|
See [CONTROLS](CONTROLS.md) for the full list of commands.
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user