summaryrefslogtreecommitdiffstats
path: root/pancake.1
blob: 3467e09572f47a43dd2626b256cc5f1aa5fbf70d (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
.TH pancake 1

.SH NAME
pancake - a CLI/Emacs web/gopher/file browser

.SH SYNOPSIS
pancake [\fIoption ...\fR]

.SH DESCRIPTION
Pancake utilizes pandoc and external downloaders such as curl, adding
support for Gopher directories and plain text files, and invoking
external applications (e.g., image and PDF viewers) depending on its
configuration.

User interaction capabilities are rather basic, as it is intended to
be combined with software that provides better user interfaces -- such
as emacs, rlwrap, tmux, screen.

.SH OPTIONS
.IP "\fB\-\-version\fR"
Print version and exit.
.IP "\fB\-\-help\fR"
Print a help message.
.IP "\fB\-\-embedded\fR"
Run in the embedded mode.

.SH COMMANDS
.IP "\fBquit\fR or EOF"
quit pancake, cleaning the cache
.IP "\fB[\fR"
back
.IP "\fB]\fR"
forward
.IP "\fBreload config\fR"
reload config
.IP "\fBhelp\fR"
show a help message
.IP "\fB?\fR"
show current URI
.IP "RET (empty)"
show the next 2/3 of a page, if pagination is enabled
.IP "\fIURI\fR"
follow an URI, possibly relative to the current one
.IP "\fItype\fR \fIURI\fR"
same as above, but explicitly set a document type (html, txt, org,
markdown, etc)
.IP "[\fB,\fR]\fInumber\fR"
follow a link
.IP "\fB,\fR"
reload current document
.IP "\fBsave\fR \fIURI\fR[ \fIpath\fR]"
retrieve data and save it
.IP "\fBsave\fR [\fB,\fR]\fInumber\fR[ \fIpath\fR]"
save linked data
.IP "\fBsave\fR \fB,\fR[ \fIpath\fR]"
save current document
.IP "\fIshortcut\fR \fIquery\fR"
run a query using a shortcut defined in the configuration (e.g.,
search)
.IP "\fBset width\fR[ \fIcolumns\fR]"
set terminal/window width manually
.IP "\fBredisplay\fR"
redisplay current document

.SH DEFAULT SHORTCUTS
.IP "\fBg\fR"
gutenberg.org
.IP "\fBddg\fR"
duckduckgo.com
.IP "\fBwt\fR"
wiktionary.org
.IP "\fBwp\fR"
wikipedia.org
.IP "\fBwa\fR"
web.archive.org
.IP "\fBxiph\fR"
xiph.org
.IP "\fBgp\fR"
gopherpedia.com
.IP "\fBvs\fR"
gopher.floodgap.com

.SH SIGNALS
.IP "\fBSIGINT\fR"
Pass SIGINT to the child process, if it's active. Otherwise, quit if
it's the second SIGINT in a row (without any input between those).