John ShaggyTwoDope Jenkins
178 lines
4.3 KiB
Groff
178 lines
4.3 KiB
Groff
.TH "rtv" "1" "September 2015" "Version 20150919" "Usage and Commands"
|
|
.SH NAME
|
|
rtv - Browse Reddit from your terminal
|
|
.SH SYNOPSIS
|
|
rtv [-h] [-s SUBREDDIT] [-l LINK] [--ascii] [--log FILE] [-u USERNAME]
|
|
.SH DESCRIPTION
|
|
.B Reddit Terminal Viewer
|
|
is a lightweight browser for www.reddit.com built into a
|
|
terminal window.
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
show this help message and exit
|
|
.TP
|
|
\fB\-s\fR SUBREDDIT
|
|
subreddit name
|
|
.TP
|
|
\fB\-l\fR LINK
|
|
full link to a submission
|
|
.TP
|
|
\fB\-\-ascii\fR
|
|
enable ascii\-only mode
|
|
.TP
|
|
\fB\-\-log\fR FILE
|
|
Log HTTP requests
|
|
.SS "authentication (optional):"
|
|
.IP
|
|
Authenticating is required to vote and leave comments. If only a username is
|
|
given, the program will display a secure prompt to enter a password.
|
|
.TP
|
|
\fB\-u\fR USERNAME
|
|
reddit username
|
|
.TP
|
|
\fB\-p\fR PASSWORD
|
|
reddit password
|
|
.PP
|
|
.SS "Controls"
|
|
RTV currently supports browsing both subreddits and individual submissions.
|
|
In each mode the controls are slightly different. In subreddit mode you can
|
|
browse through the top submissions on either the front page or a specific
|
|
subreddit. In submission mode you can view the self text for a submission and
|
|
browse comments.
|
|
.PP
|
|
Basic Commands
|
|
.TP
|
|
\fBj\fR/\fBk\fR or \fBUP\fR/\fBDOWN\fR
|
|
: Move the cursor up/down
|
|
.TP
|
|
\fBm\fR/\fBn\fR or \fBPgUp\fR/\fBPgDn\fR
|
|
: Jump to the previous/next page
|
|
.TP
|
|
\fBo\fR or \fBENTER\fR
|
|
: Open the selected item as a webpage
|
|
.TP
|
|
\fBr\fR or \fBF5\fR
|
|
: Refresh page content
|
|
.TP
|
|
\fBu\fR
|
|
: Log in or switch accounts
|
|
.TP
|
|
\fB?\fR
|
|
: Show the help screen
|
|
.TP
|
|
\fBq\fR
|
|
: Quit
|
|
.PP
|
|
Authenticated Commands
|
|
.TP
|
|
\fBa\fR/\fBz\fR
|
|
: Upvote/downvote
|
|
.TP
|
|
\fBc\fR
|
|
: Compose a new post or comment
|
|
.TP
|
|
\fBe\fR
|
|
: Edit an existing post or comment
|
|
.TP
|
|
\fBd\fR
|
|
: Delete an existing post or comment
|
|
.TP
|
|
\fBi\fR
|
|
: Display new messages prompt
|
|
.TP
|
|
\fBs\fR
|
|
: Open/close subscribed subreddits list
|
|
.PP
|
|
Subreddit Mode
|
|
.TP
|
|
\fBl\fR or \fBRIGHT\fR
|
|
: Enter the selected submission
|
|
.TP
|
|
\fB/\fR
|
|
: Open a prompt to switch subreddits
|
|
.TP
|
|
\fBf\fR
|
|
: Open a prompt to search the current subreddit
|
|
.PP
|
|
Submission Mode
|
|
.TP
|
|
\fBh\fR or \fBLEFT\fR
|
|
: Return to subreddit mode
|
|
.TP
|
|
\fBSPACE\fR
|
|
: Fold the selected comment, or load additional comments
|
|
.SH FILES
|
|
.TP
|
|
All config files can make use of $XDG_CONFIG_HOME which allows you to place them in other places then the given example paths.
|
|
.TP
|
|
~/.config/rtv/rtv.cfg
|
|
Personal configuration file.
|
|
.TP
|
|
~/.config/rtv/refresh-token
|
|
Session token for OAuth login, if you do not wish to have a persisent login you can set the option \fBpersistent=False\fR in the config file. But some features will not be available.
|
|
|
|
.SH CONFIG FILE EXAMPLE
|
|
.B RTV
|
|
has many options that can be set in a configuration file. Here is a simple example configuration.
|
|
|
|
.nf
|
|
[rtv]
|
|
# Log file location
|
|
log=/tmp/rtv.log
|
|
|
|
# Default subreddit
|
|
subreddit=CollegeBasketball
|
|
|
|
# Default submission link - will be opened every time the program starts
|
|
link=http://www.reddit.com/r/CollegeBasketball/comments/31irjq
|
|
|
|
# Turn on ascii-only mode and disable all unicode characters
|
|
# This may be necessary for compatibility with some terminal browsers
|
|
ascii=True
|
|
|
|
# Enable persistent storage of your authentication token
|
|
# This allows you to remain logged in when you restart the program
|
|
persistent=True
|
|
|
|
.SH ENVIROMENT VARIABLES
|
|
.B RTV
|
|
Supports enviroment variables that can help improve your experience. These options can be set in the current shell. Or placed in your configuration file for your shell of choice. Such as
|
|
.IR ~/.bashrc
|
|
or
|
|
.IR ~/.zshrc
|
|
, restarting your session will make these settings persisent for future use of
|
|
.B RTV.
|
|
.TP
|
|
.BR RTV_EDITOR
|
|
Setting
|
|
.IR export
|
|
.IR RTV_EDITOR=gedit
|
|
will open gedit as your editor when composing comments and replies.
|
|
If no editor is set,
|
|
.B RTV
|
|
will fall back to the enviroments default
|
|
.IR $EDITOR
|
|
, and as an extra fall back nano.
|
|
|
|
.TP
|
|
.BR BROWSER
|
|
.B RTV
|
|
can open links in any browser you wish to use. Most system's will open the default such as Firefox or Chrome. But if you prefer to enjoy a terminal only experience, you can use
|
|
.IR $BROWSER
|
|
to set a browser such as w3m, lynx, and elinks. For example w3m would be
|
|
.IR export
|
|
.IR BROWSER=w3m
|
|
|
|
|
|
.PP
|
|
.SH AUTHOR
|
|
Written by Johnathan "ShaggyTwoDope" Jenkins <twodopeshaggy@gmail.com> (2015).
|
|
.SH REPORTING BUGS
|
|
Report bugs to
|
|
.I https://github.com/michael-lazar/rtv/issues
|
|
.SH COPYRIGHT
|
|
Copyright \(co 2015 michael-lazar
|
|
License MIT.
|
|
.PP
|