rtv.1

.TH "RTV" "1" "April 06, 2016" "Version 1.9.0" "Usage and Commands"
.SH NAME
RTV - Reddit Terminal Viewer
.SH SYNOPSIS
rtv [\-h] [\-V] [\-s SUBREDDIT] [\-l LINK] [\-\-log FILE] [\-\-config FILE] [\-\-ascii] [\-\-non\-persistent] [\-\-clear\-auth] [\-\-copy\-config]
.SH DESCRIPTION
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\-V\fR, \fB\-\-version\fR
show program's version number and exit

.TP
\fB\-s SUBREDDIT\fR
name of the subreddit that will be opened on start

.TP
\fB\-l LINK\fR
full URL of a submission that will be opened on start

.TP
\fB\-\-log FILE\fR
log HTTP requests to the given file

.TP
\fB\-\-config FILE\fR
Load configuration settings from the given file

.TP
\fB\-\-ascii\fR
enable ascii\-only mode

.TP
\fB\-\-non\-persistent\fR
Forget the authenticated user when the program exits

.TP
\fB\-\-clear\-auth\fR
Remove any saved user data before launching

.TP
\fB\-\-copy\-config\fR
Copy the default configuration to {HOME}/.config/rtv/rtv.cfg


.SH CONTROLS
Move the cursor using either the arrow keys or Vim-style movement.
- Press \fBup\fR and \fBdown\fR to scroll through submissions.
- Press \fBright\fR to view the selected submission and \fBleft\fR to return.
- Press \fB?\fR to open the help screen.
.SH FILES
.TP
.BR $XDG_CONFIG_HOME/rtv/rtv.cfg
The configuration file can be used to customize default program settings, see
README.rst for more information.
.TP
.BR $XDG_CONFIG_HOME/rtv/refresh-token
After you login to reddit, your most recent OAuth refresh token will be stored
for future sessions. You can disable this behavior by setting the option
\fBpersistent=False\fR in your configuration file.
.SH ENVIRONMENT
.TP
.BR RTV_EDITOR
Text editor to use when editing comments and submissions. Will fallback to
\fI$EDITOR\fR. 
.TP
.BR BROWSER
Web browser to use when opening links.
.TP
.BR PAGER
Pager to use when expanding individual comments and submissions. 
.SH AUTHOR
Michael Lazar <lazar.michael22@gmail.com> (2016).
.SH BUGS
Report bugs to \fIhttps://github.com/michael-lazar/rtv/issues\fR
.SH LICENSE
The MIT License (MIT)