forked from michael-lazar/rtv
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rtv.1
73 lines (64 loc) · 2.08 KB
/
rtv.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.TH "RTV" "1" "October 20, 2015" "Version 1.6.1" "Usage and Commands"
.SH NAME
RTV - Reddit Terminal Viewer
.SH SYNOPSIS
rtv [\-h] [\-V] [\-s SUBREDDIT] [\-l LINK] [\-\-ascii] [\-\-log FILE] [\-\-non\-persistent] [\-\-clear\-auth]
.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\-\-ascii\fR
enable ascii\-only mode
.TP
\fB\-\-log FILE\fR
log HTTP requests to a file
.TP
\fB\-\-non\-persistent\fR
Forget all authenticated users when the program exits
.TP
\fB\-\-clear\-auth\fR
Remove any saved OAuth tokens before starting
.SH CONTROLS
Navigate between posts by using the arrow keys or vim-style `hjkl` movement.
You can view the full list of commands by pressing the \fB?\fR key inside of the program.
.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
Specifies which text editor RTV will attempt to use when editing comments and
posts. RTV will fallback to \fI$EDITOR\fR if the editor is unspecified.
.TP
.BR BROWSER
Specifies which webbrowser RTV will attempt to use when opening links.
This can be set to a terminal browser (w3m, lynx, elinks, etc.) for a true
terminal experience. RTV will fallback to the system's default browser.
.SH AUTHOR
Man page written by Johnathan "ShaggyTwoDope" Jenkins <[email protected]> (2015).
.SH BUGS
Report bugs to \fIhttps://github.com/michael-lazar/rtv/issues\fR
.SH LICENSE
The MIT License (MIT)
.PP
(c) 2015 Michael Lazar