Blame


1 cc9bf8f2 2021-11-05 op TELESCOPE(1) General Commands Manual TELESCOPE(1)
2 cc9bf8f2 2021-11-05 op
3 cc9bf8f2 2021-11-05 op NAME
4 cc9bf8f2 2021-11-05 op telescope multi-protocol browser
5 cc9bf8f2 2021-11-05 op
6 cc9bf8f2 2021-11-05 op SYNOPSIS
7 bfd29c14 2021-12-01 op telescope [-ChnSv] [-c config] [URL]
8 cc9bf8f2 2021-11-05 op
9 cc9bf8f2 2021-11-05 op DESCRIPTION
10 cc9bf8f2 2021-11-05 op telescope is an interactive browser that supports the Finger, Gemini and
11 cc9bf8f2 2021-11-05 op Gopher protocols. telescope features tabs, a minibuffer, interactive
12 cc9bf8f2 2021-11-05 op completions, bookmarks and out-of-band TOFU verification.
13 cc9bf8f2 2021-11-05 op
14 cc9bf8f2 2021-11-05 op The arguments are as follows:
15 cc9bf8f2 2021-11-05 op
16 d9bfe90a 2022-01-13 op -C, --colours Show all available colors and exit. This option can also
17 d9bfe90a 2022-01-13 op be spelled --colors.
18 cc9bf8f2 2021-11-05 op
19 cc9bf8f2 2021-11-05 op -c config Specify an alternative configuration file. By default
20 ca5a29bf 2021-12-30 op ~/.config/telescope/config is loaded.
21 cc9bf8f2 2021-11-05 op
22 d9bfe90a 2022-01-13 op -h, --help Display version, usage and exit.
23 cc9bf8f2 2021-11-05 op
24 cc9bf8f2 2021-11-05 op -n Configtest mode. Only check the configuration file for
25 cc9bf8f2 2021-11-05 op validity.
26 cc9bf8f2 2021-11-05 op
27 bfd29c14 2021-12-01 op -S, --safe Safe (or sandbox) mode. Prevent telescope from
28 bfd29c14 2021-12-01 op writing files to the disk and to acquire the lock,
29 bfd29c14 2021-12-01 op allowing to run multiple instances at the same time.
30 bfd29c14 2021-12-01 op telescope still loads the session file and the custom
31 bfd29c14 2021-12-01 op about pages.
32 bfd29c14 2021-12-01 op
33 d9bfe90a 2022-01-13 op -v, --version Display version and exit.
34 cc9bf8f2 2021-11-05 op
35 cc9bf8f2 2021-11-05 op UI CONCEPTS
36 cc9bf8f2 2021-11-05 op telescope interface is divided into four areas: the tabline, the body,
37 cc9bf8f2 2021-11-05 op the modeline and the echoarea/minibuffer.
38 cc9bf8f2 2021-11-05 op
39 cc9bf8f2 2021-11-05 op The tabline is always at the top of the screen and displays the tabs
40 cc9bf8f2 2021-11-05 op separated by a vertical line. When there are more tabs than the size of
41 cc9bf8f2 2021-11-05 op the window allow to display, the characters < or > are shown at the
42 cc9bf8f2 2021-11-05 op start/end of the tabline to indicate that there are more tabs in that
43 cc9bf8f2 2021-11-05 op direction.
44 cc9bf8f2 2021-11-05 op
45 cc9bf8f2 2021-11-05 op The body occupies the majority of the visible area. It contains the
46 cc9bf8f2 2021-11-05 op current page and optionally a side window.
47 cc9bf8f2 2021-11-05 op
48 cc9bf8f2 2021-11-05 op The modeline is the second to last row of the screen. It shows some
49 cc9bf8f2 2021-11-05 op information about the page: a spinner when the page is loading, the trust
50 cc9bf8f2 2021-11-05 op level, the document type, the scroll offset and the URL.
51 cc9bf8f2 2021-11-05 op
52 cc9bf8f2 2021-11-05 op The echoarea is usually the last line of the screen. Messages are often
53 cc9bf8f2 2021-11-05 op showed there, and link addresses too. The echoarea is also used to
54 cc9bf8f2 2021-11-05 op obtain input from the user. When commands like swiper or link-select are
55 cc9bf8f2 2021-11-05 op invoked, the minibuffer area grows to show possible completions.
56 cc9bf8f2 2021-11-05 op
57 cc9bf8f2 2021-11-05 op TOFU
58 cc9bf8f2 2021-11-05 op telescope aims to use the Trust, but Verify (where appropriate)
59 cc9bf8f2 2021-11-05 op approach for TOFU (Trust On First Use). The idea is to define three
60 cc9bf8f2 2021-11-05 op level of verification for a certificate:
61 cc9bf8f2 2021-11-05 op
62 cc9bf8f2 2021-11-05 op untrusted (!) the server fingerprint does NOT match the stored
63 cc9bf8f2 2021-11-05 op value.
64 cc9bf8f2 2021-11-05 op
65 cc9bf8f2 2021-11-05 op trusted (v) the server fingerprint matches the store one.
66 cc9bf8f2 2021-11-05 op
67 cc9bf8f2 2021-11-05 op verified (V) the fingerprint matches and has been verified out-of-
68 cc9bf8f2 2021-11-05 op band.
69 cc9bf8f2 2021-11-05 op
70 cc9bf8f2 2021-11-05 op The trust level of the page is indicated in the modeline with the
71 cc9bf8f2 2021-11-05 op indicated character.
72 cc9bf8f2 2021-11-05 op
73 cc9bf8f2 2021-11-05 op Most of the time the trusted level is enough, but where is appropriate
74 cc9bf8f2 2021-11-05 op users should be able to verify out-of-band the certificate.
75 cc9bf8f2 2021-11-05 op
76 cc9bf8f2 2021-11-05 op At the moment, there is no built-in support for an out-of-band
77 cc9bf8f2 2021-11-05 op verification though.
78 cc9bf8f2 2021-11-05 op
79 cc9bf8f2 2021-11-05 op SUPPORTED PROTOCOLS
80 cc9bf8f2 2021-11-05 op The following protocols are supported:
81 cc9bf8f2 2021-11-05 op
82 cc9bf8f2 2021-11-05 op about: About pages are telescope internal page. See about:about for
83 cc9bf8f2 2021-11-05 op a list of all these pages.
84 cc9bf8f2 2021-11-05 op
85 cc9bf8f2 2021-11-05 op file:// File types know to telescope, such as .gmi, .gemini, .txt,
86 cc9bf8f2 2021-11-05 op .md, .markdown, .diff or .patch, can be viewed inside the
87 cc9bf8f2 2021-11-05 op application. Types of local files are detected solely based
88 cc9bf8f2 2021-11-05 op on the file extension. On some systems, such as OpenBSD, only
89 cc9bf8f2 2021-11-05 op files inside special directories (like /tmp or ~/Downloads)
90 cc9bf8f2 2021-11-05 op are available.
91 cc9bf8f2 2021-11-05 op
92 cc9bf8f2 2021-11-05 op finger:// Finger URLs are interpreted as follows:
93 cc9bf8f2 2021-11-05 op the host is determined by the host name portion of the URL
94 cc9bf8f2 2021-11-05 op if the user portion of the URL is provided, it's
95 cc9bf8f2 2021-11-05 op interpreted as the user to finger, otherwise the path
96 cc9bf8f2 2021-11-05 op component will be used
97 cc9bf8f2 2021-11-05 op thus finger://user@hostname and finger://hostname/user are
98 cc9bf8f2 2021-11-05 op treated as the same URL.
99 cc9bf8f2 2021-11-05 op
100 cc9bf8f2 2021-11-05 op gemini:// Gemini is fully supported, with the exception of client-
101 cc9bf8f2 2021-11-05 op certificates.
102 cc9bf8f2 2021-11-05 op
103 cc9bf8f2 2021-11-05 op gopher:// Gopher support is limited to items type 0, 1 and 7. All text
104 cc9bf8f2 2021-11-05 op is assumed to be encoded in UTF-8 (or ASCII).
105 cc9bf8f2 2021-11-05 op
106 cc9bf8f2 2021-11-05 op User-entered URLs, given as argument on the command line or entered with
107 cc9bf8f2 2021-11-05 op load-url, are intepreted with a simple heuristic:
108 cc9bf8f2 2021-11-05 op if it's a proper absolute URL then use it as-is,
109 cc9bf8f2 2021-11-05 op if it starts with ./ or / assume it's a file:// URL,
110 cc9bf8f2 2021-11-05 op otherwise assume it's a Gemini URL.
111 cc9bf8f2 2021-11-05 op
112 bfd29c14 2021-12-01 op CONFIGURATION FILE
113 bfd29c14 2021-12-01 op During the startup, telescope reads the configuration file at
114 bfd29c14 2021-12-01 op ~/.config/telescope/config or ~/.telescope/config.
115 bfd29c14 2021-12-01 op
116 bfd29c14 2021-12-01 op It's possible to load a custom configuration file using the -c flag.
117 bfd29c14 2021-12-01 op
118 bfd29c14 2021-12-01 op telescope will also load a file called config-TERM, where TERM is the
119 bfd29c14 2021-12-01 op name of the terminal type (i.e. the TERM environment variable), if it
120 bfd29c14 2021-12-01 op exists.
121 bfd29c14 2021-12-01 op
122 bfd29c14 2021-12-01 op The format of the configuration file is fairly flexible. The current
123 bfd29c14 2021-12-01 op line can be extended over multiple ones using a backslash (\).
124 bfd29c14 2021-12-01 op Comments can be put anywhere in the file using a hash mark (#), and
125 bfd29c14 2021-12-01 op extend to the end of the current line, but backslashes can't be used to
126 bfd29c14 2021-12-01 op extend comments over multiple lines.
127 bfd29c14 2021-12-01 op
128 bfd29c14 2021-12-01 op The following constructs are available:
129 bfd29c14 2021-12-01 op
130 bfd29c14 2021-12-01 op bind map key cmd
131 bfd29c14 2021-12-01 op Bind key to the function cmd in the keymap map. Valid values for
132 bfd29c14 2021-12-01 op map are global-map (i.e. when the user is viewing a page) and
133 bfd29c14 2021-12-01 op minibuffer-map (i.e. when the minibuffer has the focus.) key
134 bfd29c14 2021-12-01 op follows the same syntax described in DEFAULT KEY BINDINGS and all
135 bfd29c14 2021-12-01 op the possible functions are listed in INTERACTIVE COMMANDS.
136 bfd29c14 2021-12-01 op
137 bfd29c14 2021-12-01 op proxy proto via url
138 bfd29c14 2021-12-01 op Use url as proxy for all URLs with protocol proto. url must be a
139 bfd29c14 2021-12-01 op Gemini URI without path, query and fragment component.
140 bfd29c14 2021-12-01 op
141 bfd29c14 2021-12-01 op set opt = val
142 bfd29c14 2021-12-01 op Set the option opt to the value val. Valid options are:
143 bfd29c14 2021-12-01 op
144 bfd29c14 2021-12-01 op autosave (integer) If greater than zero, save the session
145 bfd29c14 2021-12-01 op after the specified amount of seconds after some
146 bfd29c14 2021-12-01 op events happens (new or closed tabs, visited a link
147 bfd29c14 2021-12-01 op ...) Defaults to 20.
148 bfd29c14 2021-12-01 op dont-wrap-pre (integer) If nonzero, don't wrap preformatted
149 bfd29c14 2021-12-01 op blocks. Defaults to 0.
150 bfd29c14 2021-12-01 op download-path (string) The default download path. Defaults to
151 bfd29c14 2021-12-01 op /tmp.
152 bfd29c14 2021-12-01 op emojify-link (integer) If nonzero, when the text of a link
153 bfd29c14 2021-12-01 op starts with an emoji followed by a space, use that
154 bfd29c14 2021-12-01 op emoji as line prefix. Defaults to 1.
155 bfd29c14 2021-12-01 op enable-colors (integer) If nonzero, enable colours. Defaults to
156 bfd29c14 2021-12-01 op 0 if NO_COLORS is set, 1 otherwise.
157 bfd29c14 2021-12-01 op fill-column (integer) If greater than zero, lines of text will
158 bfd29c14 2021-12-01 op be formatted in a way that don't exceed the given
159 bfd29c14 2021-12-01 op number of columns. Defaults to 80.
160 d9bfe90a 2022-01-13 op fringe-ignore-offset
161 d9bfe90a 2022-01-13 op (integer) If nonzero, the fringe doesn't obey to
162 d9bfe90a 2022-01-13 op olivetti-mode. Defaults to 1.
163 bfd29c14 2021-12-01 op hide-pre-blocks
164 bfd29c14 2021-12-01 op (integer) If nonzero, hide by default the body of
165 bfd29c14 2021-12-01 op the preformatted blocks. Defaults to zero.
166 bfd29c14 2021-12-01 op push-button can be used to toggle the visibility
167 bfd29c14 2021-12-01 op per-block.
168 bfd29c14 2021-12-01 op hide-pre-closing-line
169 bfd29c14 2021-12-01 op (integer) If nonzero, hide the closing line of
170 bfd29c14 2021-12-01 op preformatted blocks. Defaults to 0.
171 bfd29c14 2021-12-01 op hide-pre-context
172 bfd29c14 2021-12-01 op (integer) If nonzero, hide the start and end line
173 bfd29c14 2021-12-01 op of the preformatted blocks. If both hide-pre-
174 bfd29c14 2021-12-01 op context and hide-pre-blocks are nonzero,
175 bfd29c14 2021-12-01 op preformatted blocks are irremediably hidden.
176 bfd29c14 2021-12-01 op Defaults to zero.
177 bfd29c14 2021-12-01 op new-tab-url (string) URL for the new tab page. Defaults to
178 bfd29c14 2021-12-01 op about:new.
179 d9bfe90a 2022-01-13 op max-killed-tabs
180 d9bfe90a 2022-01-13 op (integer) The maximum number of closed tabs to
181 d9bfe90a 2022-01-13 op keep track of, defaults to 10. Must be a positive
182 d9bfe90a 2022-01-13 op number; if zero, don't save closed tabs at all.
183 bfd29c14 2021-12-01 op olivetti-mode (integer) If nonzero, enable olivetti-mode
184 bfd29c14 2021-12-01 op Defaults to 1.
185 bfd29c14 2021-12-01 op tab-bar-show (integer) If tab-bar-show is -1 hide the tab bar
186 bfd29c14 2021-12-01 op permanently, if 0 show it unconditionally. If
187 bfd29c14 2021-12-01 op it's 1, show the bar only when there is more than
188 bfd29c14 2021-12-01 op one tab. Defaults to 1.
189 d9bfe90a 2022-01-13 op update-title (integer) If nonzero, set the terminal title to
190 d9bfe90a 2022-01-13 op the page title. Defaults to 1.
191 bfd29c14 2021-12-01 op
192 bfd29c14 2021-12-01 op style name option
193 bfd29c14 2021-12-01 op Change the styling of the element identified by name. Multiple
194 bfd29c14 2021-12-01 op options may be specified within curly braces. Valid style
195 bfd29c14 2021-12-01 op identifiers are:
196 bfd29c14 2021-12-01 op line the area outside the lines in the
197 bfd29c14 2021-12-01 op body of the page.
198 bfd29c14 2021-12-01 op line.compl the completions.
199 bfd29c14 2021-12-01 op line.compl.current the current completion.
200 bfd29c14 2021-12-01 op line.help text in the *Help* buffer.
201 bfd29c14 2021-12-01 op line.download.ongoing an ongoing download
202 bfd29c14 2021-12-01 op line.download.done a completed download
203 bfd29c14 2021-12-01 op line.download.info informational text in the
204 bfd29c14 2021-12-01 op *Downloads* buffer.
205 d9bfe90a 2022-01-13 op line.fringe (virtual) lines draw after the end
206 d9bfe90a 2022-01-13 op of a buffer.
207 bfd29c14 2021-12-01 op line.text text lines.
208 bfd29c14 2021-12-01 op line.link link lines.
209 bfd29c14 2021-12-01 op line.title1..3 headings
210 bfd29c14 2021-12-01 op line.item item lines.
211 bfd29c14 2021-12-01 op line.quote quotes.
212 bfd29c14 2021-12-01 op line.pre.start the heading of a preformatted block.
213 bfd29c14 2021-12-01 op line.pre the content of a preformatted block.
214 bfd29c14 2021-12-01 op line.pre.end the closing line of a preformatted
215 bfd29c14 2021-12-01 op block.
216 bfd29c14 2021-12-01 op download the download pane
217 bfd29c14 2021-12-01 op minibuffer the minibuffer.
218 bfd29c14 2021-12-01 op modeline the modeline.
219 bfd29c14 2021-12-01 op tabline the tabline.
220 bfd29c14 2021-12-01 op tabline.tab the non-focused tabs.
221 bfd29c14 2021-12-01 op tabline.current the focused tab.
222 bfd29c14 2021-12-01 op
223 bfd29c14 2021-12-01 op Valid options are:
224 bfd29c14 2021-12-01 op
225 bfd29c14 2021-12-01 op attr prefix [line [trail]]
226 bfd29c14 2021-12-01 op Sets the text attributes. If only one value is given,
227 bfd29c14 2021-12-01 op line and trail default to that; if two values are given
228 bfd29c14 2021-12-01 op then trail defaults to prefix. Each attribute is a
229 bfd29c14 2021-12-01 op comma-separated list of keywords:
230 bfd29c14 2021-12-01 op normal no attributes.
231 bfd29c14 2021-12-01 op standout best highlighting mode for the terminal.
232 bfd29c14 2021-12-01 op underline underlines the text.
233 bfd29c14 2021-12-01 op reverse reverses background/foreground colors.
234 bfd29c14 2021-12-01 op blink makes the text blinking.
235 bfd29c14 2021-12-01 op dim half bright.
236 bfd29c14 2021-12-01 op bold extra bright or bold.
237 bfd29c14 2021-12-01 op
238 bfd29c14 2021-12-01 op Only the style identifiers with the line. prefix accept
239 bfd29c14 2021-12-01 op up to three attributes. The other will only use the
240 bfd29c14 2021-12-01 op first one given.
241 bfd29c14 2021-12-01 op
242 bfd29c14 2021-12-01 op bg prefix [line [trail]]
243 bfd29c14 2021-12-01 op Sets the background color. Follows the same behaviour as
244 bfd29c14 2021-12-01 op attr regarding the optional parameters. The colour is
245 bfd29c14 2021-12-01 op one of black, red, green, yellow, blue, magenta, cyan and
246 bfd29c14 2021-12-01 op white; colour0 to colour255 (or color0 to color255) from
247 bfd29c14 2021-12-01 op the 256-colour set; default for the default colour.
248 bfd29c14 2021-12-01 op
249 bfd29c14 2021-12-01 op fg prefix [line [trail]]
250 bfd29c14 2021-12-01 op Sets the foreground color. It behaves just like bg.
251 bfd29c14 2021-12-01 op
252 bfd29c14 2021-12-01 op prefix prfx [cont]
253 bfd29c14 2021-12-01 op Sets the prefix for the current line type to prfx and
254 bfd29c14 2021-12-01 op cont as the prefix for the continuation lines (i.e. when
255 bfd29c14 2021-12-01 op a long line gets wrapped.) If cont is not given its value
256 bfd29c14 2021-12-01 op will be the same of prfx.
257 bfd29c14 2021-12-01 op
258 cc9bf8f2 2021-11-05 op DEFAULT KEY BINDINGS
259 cc9bf8f2 2021-11-05 op The default key bindings are very similar to GNU Emacs, but care has been
260 cc9bf8f2 2021-11-05 op taken to include also bindings familiar for vi(1) and CUA users. In
261 cc9bf8f2 2021-11-05 op the following examples, C-x means Control-x, M-x means Meta-x, where the
262 cc9bf8f2 2021-11-05 op Meta key may be either a special key on the keyboard or the ALT key;
263 cc9bf8f2 2021-11-05 op otherwise ESC followed by the key X works as well, and C-M-x means to
264 cc9bf8f2 2021-11-05 op press the key X together with both Control and Meta.
265 cc9bf8f2 2021-11-05 op
266 cc9bf8f2 2021-11-05 op Keys are usually a single character, like p or n, but some special
267 cc9bf8f2 2021-11-05 op keys are accepted as well.
268 cc9bf8f2 2021-11-05 op
269 cc9bf8f2 2021-11-05 op <up> Up arrow
270 cc9bf8f2 2021-11-05 op <down> Down arrow
271 cc9bf8f2 2021-11-05 op <left> Left arrow
272 cc9bf8f2 2021-11-05 op <right> Right arrow
273 cc9bf8f2 2021-11-05 op <prior> Previous page/Page up
274 cc9bf8f2 2021-11-05 op <next> Next page/Page down
275 cc9bf8f2 2021-11-05 op <home> Home
276 cc9bf8f2 2021-11-05 op <end> End
277 cc9bf8f2 2021-11-05 op <f0> thru <f63> Function keys
278 cc9bf8f2 2021-11-05 op del or backspace Backspace
279 cc9bf8f2 2021-11-05 op esc Escape
280 cc9bf8f2 2021-11-05 op space or spc Space
281 cc9bf8f2 2021-11-05 op enter or ret Enter
282 cc9bf8f2 2021-11-05 op tab Tab
283 cc9bf8f2 2021-11-05 op backtab Depends on the configuration of the terminal
284 cc9bf8f2 2021-11-05 op emulator; usually shift tab.
285 cc9bf8f2 2021-11-05 op
286 cc9bf8f2 2021-11-05 op GNU Emacs-like keys
287 cc9bf8f2 2021-11-05 op C-p previous-line
288 cc9bf8f2 2021-11-05 op C-n next-line
289 cc9bf8f2 2021-11-05 op C-f forward-char
290 cc9bf8f2 2021-11-05 op C-b backward-char
291 cc9bf8f2 2021-11-05 op M-{ backward-paragraph
292 cc9bf8f2 2021-11-05 op M-} forward-paragraph
293 cc9bf8f2 2021-11-05 op C-a move-beginning-of-line
294 cc9bf8f2 2021-11-05 op C-e move-end-of-line
295 cc9bf8f2 2021-11-05 op M-v, M-space scroll-up
296 cc9bf8f2 2021-11-05 op C-v, space scroll-down
297 cc9bf8f2 2021-11-05 op M-< beginning-of-buffer
298 cc9bf8f2 2021-11-05 op M-> end-of-buffer
299 cc9bf8f2 2021-11-05 op C-x C-c kill-telescope
300 cc9bf8f2 2021-11-05 op C-g clear-minibuf
301 cc9bf8f2 2021-11-05 op M-x execute-extended-command
302 cc9bf8f2 2021-11-05 op C-c { dec-fill-column
303 cc9bf8f2 2021-11-05 op C-c } inc-fill-column
304 cc9bf8f2 2021-11-05 op C-c p previous-heading
305 cc9bf8f2 2021-11-05 op C-c n next-heading
306 cc9bf8f2 2021-11-05 op > load-url
307 cc9bf8f2 2021-11-05 op < load-current-url
308 cc9bf8f2 2021-11-05 op C-x C-f load-url
309 cc9bf8f2 2021-11-05 op C-x M-f load-current-url
310 cc9bf8f2 2021-11-05 op C-x o other-window
311 cc9bf8f2 2021-11-05 op C-x t 0 tab-close
312 cc9bf8f2 2021-11-05 op C-x t 1 tab-close-other
313 cc9bf8f2 2021-11-05 op C-x t 2 tab-new
314 cc9bf8f2 2021-11-05 op C-x t o tab-next
315 cc9bf8f2 2021-11-05 op C-x t O tab-previous
316 cc9bf8f2 2021-11-05 op C-x t m tab-move
317 cc9bf8f2 2021-11-05 op C-x t M tab-move-to
318 cc9bf8f2 2021-11-05 op B, C-M-b previous-page
319 cc9bf8f2 2021-11-05 op F, C-M-f next-page
320 cc9bf8f2 2021-11-05 op <f7> a bookmark-page
321 cc9bf8f2 2021-11-05 op <f7> <f7> list-bookmarks
322 cc9bf8f2 2021-11-05 op C-z suspend-telescope
323 cc9bf8f2 2021-11-05 op
324 cc9bf8f2 2021-11-05 op vi(1)-like keys
325 cc9bf8f2 2021-11-05 op k previous-line
326 cc9bf8f2 2021-11-05 op j next-line
327 cc9bf8f2 2021-11-05 op l forward-char
328 cc9bf8f2 2021-11-05 op h backward-char
329 cc9bf8f2 2021-11-05 op { backward-paragraph
330 cc9bf8f2 2021-11-05 op } forward-paragraph
331 cc9bf8f2 2021-11-05 op ^ move-beginning-of-line
332 cc9bf8f2 2021-11-05 op $ move-end-of-line
333 cc9bf8f2 2021-11-05 op K scroll-line-up
334 cc9bf8f2 2021-11-05 op J scroll-line-down
335 cc9bf8f2 2021-11-05 op g g beginning-of-buffer
336 cc9bf8f2 2021-11-05 op G end-of-buffer
337 cc9bf8f2 2021-11-05 op g D tab-close
338 cc9bf8f2 2021-11-05 op g N tab-new
339 cc9bf8f2 2021-11-05 op g t tab-next
340 cc9bf8f2 2021-11-05 op g T tab-previous
341 cc9bf8f2 2021-11-05 op g M-t tab-move
342 cc9bf8f2 2021-11-05 op g M-T tab-move-to
343 cc9bf8f2 2021-11-05 op H previous-page
344 cc9bf8f2 2021-11-05 op L next-page
345 d9bfe90a 2022-01-13 op u tab-undo-close
346 cc9bf8f2 2021-11-05 op q kill-telescope
347 cc9bf8f2 2021-11-05 op ESC clear-minibuf
348 cc9bf8f2 2021-11-05 op : execute-extended-command
349 cc9bf8f2 2021-11-05 op
350 cc9bf8f2 2021-11-05 op CUA-like keys
351 cc9bf8f2 2021-11-05 op <up> previous-line
352 cc9bf8f2 2021-11-05 op <down> next-line
353 cc9bf8f2 2021-11-05 op <right> forward-char
354 cc9bf8f2 2021-11-05 op <left> backward-char
355 cc9bf8f2 2021-11-05 op <home> move-beginning-of-line
356 cc9bf8f2 2021-11-05 op <end> move-end-of-line
357 cc9bf8f2 2021-11-05 op <prior> scroll-up
358 cc9bf8f2 2021-11-05 op <next> scroll-down
359 cc9bf8f2 2021-11-05 op C-w tab-close
360 cc9bf8f2 2021-11-05 op C-t tab-new
361 cc9bf8f2 2021-11-05 op M-<prior> tab-previous
362 cc9bf8f2 2021-11-05 op M-<next> tab-next
363 d9bfe90a 2022-01-13 op del previous-page
364 cc9bf8f2 2021-11-05 op M-<left> previous-page
365 cc9bf8f2 2021-11-05 op M-<right> next-page
366 cc9bf8f2 2021-11-05 op <f5> reload-page
367 cc9bf8f2 2021-11-05 op r reload-page
368 cc9bf8f2 2021-11-05 op
369 cc9bf8f2 2021-11-05 op Neither Emacs nor vi specific
370 cc9bf8f2 2021-11-05 op <f1> toggle-help
371 cc9bf8f2 2021-11-05 op enter push-button
372 cc9bf8f2 2021-11-05 op M-enter push-button-new-tab
373 cc9bf8f2 2021-11-05 op M-tab previous-button
374 cc9bf8f2 2021-11-05 op backtab previous-button
375 cc9bf8f2 2021-11-05 op tab next-button
376 cc9bf8f2 2021-11-05 op M-t tab-select
377 cc9bf8f2 2021-11-05 op [ tab-previous
378 cc9bf8f2 2021-11-05 op ] tab-next
379 cc9bf8f2 2021-11-05 op M-[ tab-move-to
380 cc9bf8f2 2021-11-05 op M-] tab-move
381 cc9bf8f2 2021-11-05 op M-l link-select
382 cc9bf8f2 2021-11-05 op M-/ swiper
383 4b495710 2022-04-13 op M-r reply-last-input
384 cc9bf8f2 2021-11-05 op
385 cc9bf8f2 2021-11-05 op Minibuffer-specific keys
386 cc9bf8f2 2021-11-05 op enter mini-complete-and-exit
387 cc9bf8f2 2021-11-05 op C-g mini-abort
388 cc9bf8f2 2021-11-05 op ESC mini-abort
389 cc9bf8f2 2021-11-05 op C-d mini-delete-char
390 cc9bf8f2 2021-11-05 op del mini-delete-backward-char
391 cc9bf8f2 2021-11-05 op backspace mini-delete-backward-char
392 cc9bf8f2 2021-11-05 op C-h mini-delete-backward-char
393 cc9bf8f2 2021-11-05 op C-b backward-char
394 cc9bf8f2 2021-11-05 op C-f forward-char
395 cc9bf8f2 2021-11-05 op <left> backward-char
396 cc9bf8f2 2021-11-05 op <right> forward-char
397 cc9bf8f2 2021-11-05 op C-e move-end-of-line
398 cc9bf8f2 2021-11-05 op C-a move-beginning-of-line
399 cc9bf8f2 2021-11-05 op <end> move-end-of-line
400 cc9bf8f2 2021-11-05 op <home> move-beginning-of-line
401 cc9bf8f2 2021-11-05 op C-k mini-kill-line
402 cc9bf8f2 2021-11-05 op M-p mini-previous-history-element
403 cc9bf8f2 2021-11-05 op M-n mini-next-history-element
404 cc9bf8f2 2021-11-05 op C-p previous-completion
405 cc9bf8f2 2021-11-05 op C-n next-completion
406 cc9bf8f2 2021-11-05 op <up> previous-completion
407 cc9bf8f2 2021-11-05 op <down> next-completion
408 cc9bf8f2 2021-11-05 op tab insert-current-candidate
409 cc9bf8f2 2021-11-05 op M-< mini-goto-beginning
410 cc9bf8f2 2021-11-05 op M-> mini-goto-end
411 cc9bf8f2 2021-11-05 op
412 cc9bf8f2 2021-11-05 op INTERACTIVE COMMANDS
413 cc9bf8f2 2021-11-05 op Follows the documentation for the interactive commands. These commands
414 cc9bf8f2 2021-11-05 op can be bound to a key or executed with execute-extended-command.
415 cc9bf8f2 2021-11-05 op
416 cc9bf8f2 2021-11-05 op Movement commands
417 cc9bf8f2 2021-11-05 op backward-char Move point one character backward.
418 cc9bf8f2 2021-11-05 op backward-paragraph Move point one paragraph backward.
419 cc9bf8f2 2021-11-05 op beginning-of-buffer Move point to the beginning of the buffer.
420 cc9bf8f2 2021-11-05 op end-of-buffer Move point to the end of the buffer.
421 cc9bf8f2 2021-11-05 op forward-char Move point one character forward.
422 cc9bf8f2 2021-11-05 op forward-paragraph Move point one paragraph forward.
423 cc9bf8f2 2021-11-05 op insert-current-candidate Copy the current selection text as minibuffer
424 cc9bf8f2 2021-11-05 op input.
425 cc9bf8f2 2021-11-05 op move-beginning-of-line Move point at the beginning of the current
426 cc9bf8f2 2021-11-05 op (visual) line.
427 cc9bf8f2 2021-11-05 op move-end-of-line Move point at the end of the current (visual)
428 cc9bf8f2 2021-11-05 op line.
429 cc9bf8f2 2021-11-05 op next-button Move point to the next link.
430 cc9bf8f2 2021-11-05 op next-completion Select the next completion.
431 cc9bf8f2 2021-11-05 op next-heading Move point to the next heading.
432 cc9bf8f2 2021-11-05 op next-line Move point to the next (visual) line, in the
433 cc9bf8f2 2021-11-05 op same column if possible.
434 cc9bf8f2 2021-11-05 op previous-button Move point to the previous link.
435 cc9bf8f2 2021-11-05 op previous-completion Select the previous completion.
436 cc9bf8f2 2021-11-05 op previous-heading Move point to the previous heading.
437 cc9bf8f2 2021-11-05 op previous-line Move point to the previous (visual) line.
438 cc9bf8f2 2021-11-05 op
439 cc9bf8f2 2021-11-05 op Bookmark-related commands
440 cc9bf8f2 2021-11-05 op bookmark-page Save a page in the bookmark file. It preloads
441 cc9bf8f2 2021-11-05 op the minibuffer with the current URL.
442 cc9bf8f2 2021-11-05 op list-bookmarks Load the bookmarks page.
443 cc9bf8f2 2021-11-05 op
444 cc9bf8f2 2021-11-05 op Tab-related commands
445 cc9bf8f2 2021-11-05 op tab-close Close the current tab.
446 cc9bf8f2 2021-11-05 op tab-close-other Close all tabs but the current one.
447 cc9bf8f2 2021-11-05 op tab-move Move the current tab after the next one,
448 cc9bf8f2 2021-11-05 op wrapping around if needed.
449 cc9bf8f2 2021-11-05 op tab-move-to Move the current tab before the previous one,
450 cc9bf8f2 2021-11-05 op wrapping around if needed.
451 cc9bf8f2 2021-11-05 op tab-new Open a new tab.
452 cc9bf8f2 2021-11-05 op tab-next Focus next tab, wrapping around eventually.
453 cc9bf8f2 2021-11-05 op tab-previous Focus the previous tab, wrapping around
454 cc9bf8f2 2021-11-05 op eventually.
455 cc9bf8f2 2021-11-05 op tab-select Switch to a tab using the minibuffer.
456 d9bfe90a 2022-01-13 op tab-undo-close Re-open the most recently closed tab, if any.
457 cc9bf8f2 2021-11-05 op
458 cc9bf8f2 2021-11-05 op Misc commands
459 d9bfe90a 2022-01-13 op cache-info Show cache stats.
460 cc9bf8f2 2021-11-05 op clear-minibuf Clear the echo area.
461 cc9bf8f2 2021-11-05 op dec-fill-column Decrement fill-column by two.
462 cc9bf8f2 2021-11-05 op execute-extended-command Execute an internal command.
463 cc9bf8f2 2021-11-05 op kill-telescope Quit telescope.
464 cc9bf8f2 2021-11-05 op inc-fill-column Increment fill-column by two.
465 cc9bf8f2 2021-11-05 op link-select Select and visit a link using the minibuffer.
466 cc9bf8f2 2021-11-05 op load-current-url Edit the current URL.
467 cc9bf8f2 2021-11-05 op load-url Prompt for an URL.
468 cc9bf8f2 2021-11-05 op next-page Go forward in the page history.
469 cc9bf8f2 2021-11-05 op olivetti-mode Toggle olivetti mode (i.e. horizontal centering
470 cc9bf8f2 2021-11-05 op of the lines of the window.)
471 cc9bf8f2 2021-11-05 op other-window Select the other window.
472 cc9bf8f2 2021-11-05 op previous-page Go backward in the page history.
473 cc9bf8f2 2021-11-05 op push-button Follow link at point, or toggle the visibility
474 cc9bf8f2 2021-11-05 op of the following preformatted block if called
475 cc9bf8f2 2021-11-05 op when the cursor is on the heading of the block.
476 cc9bf8f2 2021-11-05 op push-button-new-tab Follow link at point in a new tab.
477 cc9bf8f2 2021-11-05 op redraw Redraw the screen, useful if some background
478 cc9bf8f2 2021-11-05 op program messed up the display.
479 cc9bf8f2 2021-11-05 op reload-page Reload the current page.
480 4b495710 2022-04-13 op reply-last-input Reply the last input request.
481 cc9bf8f2 2021-11-05 op scroll-down Scroll down by one visual page.
482 cc9bf8f2 2021-11-05 op scroll-line-down Scroll down by one line.
483 cc9bf8f2 2021-11-05 op scroll-line-up Scroll up by one line.
484 cc9bf8f2 2021-11-05 op scroll-up Scroll up by one visual page.
485 cc9bf8f2 2021-11-05 op suspend-telescope Suspend the current telescope session.
486 cc9bf8f2 2021-11-05 op swiper Jump to a line using the minibuffer.
487 cc9bf8f2 2021-11-05 op toc Jump to a heading using the minibuffer.
488 cc9bf8f2 2021-11-05 op toggle-help Toggle side window with help about available
489 cc9bf8f2 2021-11-05 op keys and their associated interactive command.
490 cc9bf8f2 2021-11-05 op toggle-pre-wrap Toggle the wrapping of preformatted blocks.
491 cc9bf8f2 2021-11-05 op
492 cc9bf8f2 2021-11-05 op Minibuffer commands
493 cc9bf8f2 2021-11-05 op mini-abort Abort the current minibuffer action.
494 cc9bf8f2 2021-11-05 op mini-complete-and-exit Complete the current minibuffer action.
495 cc9bf8f2 2021-11-05 op mini-delete-backward-char
496 cc9bf8f2 2021-11-05 op Delete the character before the point.
497 cc9bf8f2 2021-11-05 op mini-delete-char Delete the character after the point.
498 cc9bf8f2 2021-11-05 op mini-goto-beginning Select the first completion, if any.
499 cc9bf8f2 2021-11-05 op mini-goto-end Select the last completion, if any.
500 cc9bf8f2 2021-11-05 op mini-kill-line Delete from point until the end of the line.
501 cc9bf8f2 2021-11-05 op mini-next-history-element
502 cc9bf8f2 2021-11-05 op Load the previous history element.
503 cc9bf8f2 2021-11-05 op mini-previous-history-element
504 cc9bf8f2 2021-11-05 op Load the next history element.
505 cc9bf8f2 2021-11-05 op
506 cc9bf8f2 2021-11-05 op Aliases
507 cc9bf8f2 2021-11-05 op The following aliases are available during execute-extended-command:
508 4b495710 2022-04-13 op open load-url
509 cc9bf8f2 2021-11-05 op tabn tab-next
510 cc9bf8f2 2021-11-05 op tabnew tab-new
511 cc9bf8f2 2021-11-05 op tabp tab-previous
512 cc9bf8f2 2021-11-05 op q and wq kill-telescope
513 cc9bf8f2 2021-11-05 op
514 cc9bf8f2 2021-11-05 op ENVIRONMENT
515 cc9bf8f2 2021-11-05 op When telescope is started, it inspects the following environment
516 cc9bf8f2 2021-11-05 op variables:
517 cc9bf8f2 2021-11-05 op
518 cc9bf8f2 2021-11-05 op HOME The user's login directory.
519 cc9bf8f2 2021-11-05 op
520 cc9bf8f2 2021-11-05 op NO_COLORS To decide whether to use colors or not. The content of the
521 cc9bf8f2 2021-11-05 op variable doesn't matter.
522 cc9bf8f2 2021-11-05 op
523 cc9bf8f2 2021-11-05 op TERM The user's terminal name.
524 cc9bf8f2 2021-11-05 op
525 bfd29c14 2021-12-01 op XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME
526 bfd29c14 2021-12-01 op If defined can alter the default location of the files used.
527 bfd29c14 2021-12-01 op
528 cc9bf8f2 2021-11-05 op FILES
529 bfd29c14 2021-12-01 op By default telescope follows the XDG Base Directory Specification.
530 bfd29c14 2021-12-01 op However, if ~/.telescope exists, XDG is ignored and all the files are
531 bfd29c14 2021-12-01 op stored inside it. The usage of XDG_CACHE_HOME, XDG_CONFIG_HOME and
532 bfd29c14 2021-12-01 op XDG_DATA_HOME can further alter the location of these files.
533 bfd29c14 2021-12-01 op
534 bfd29c14 2021-12-01 op ~/.config/telescope/config
535 cc9bf8f2 2021-11-05 op Default configuration file.
536 bfd29c14 2021-12-01 op ~/.local/share/telescope/pages/about_*.gmi
537 bfd29c14 2021-12-01 op Overrides for built-in about: pages.
538 bfd29c14 2021-12-01 op ~/.local/share/telescope/bookmarks.gmi
539 bfd29c14 2021-12-01 op Bookmarks file.
540 bfd29c14 2021-12-01 op ~/.local/share/telescope/known_hosts
541 cc9bf8f2 2021-11-05 op Hash of the certificates for all the known hosts. Each line
542 cc9bf8f2 2021-11-05 op contains three fields: hostname with optional port number, hash
543 cc9bf8f2 2021-11-05 op of the certificate and a numeric flag.
544 bfd29c14 2021-12-01 op ~/.cache/telescope/lock
545 cc9bf8f2 2021-11-05 op Lock file used to prevent multiple instance of telescope from
546 cc9bf8f2 2021-11-05 op running at the same time.
547 bfd29c14 2021-12-01 op ~/.cache/telescope/session
548 d9bfe90a 2022-01-13 op The list of tabs from the last session.
549 cc9bf8f2 2021-11-05 op
550 cc9bf8f2 2021-11-05 op EXAMPLES
551 cc9bf8f2 2021-11-05 op It's possible to browse the small web (i.e. simple websites) by using
552 cc9bf8f2 2021-11-05 op programs like the duckling-proxy by defining a proxy in
553 bfd29c14 2021-12-01 op ~/.config/telescope/config:
554 cc9bf8f2 2021-11-05 op
555 cc9bf8f2 2021-11-05 op proxy http via "gemini://127.0.0.1:1965"
556 cc9bf8f2 2021-11-05 op proxy https via "gemini://127.0.0.1:1965"
557 cc9bf8f2 2021-11-05 op
558 cc9bf8f2 2021-11-05 op To load telescope without any configuration
559 cc9bf8f2 2021-11-05 op
560 cc9bf8f2 2021-11-05 op telescope -c /dev/null
561 cc9bf8f2 2021-11-05 op
562 bfd29c14 2021-12-01 op STANDARDS
563 bfd29c14 2021-12-01 op XDG Base Directory Specification,
564 bfd29c14 2021-12-01 op https://specifications.freedesktop.org/basedir-spec/latest/.
565 bfd29c14 2021-12-01 op
566 d9bfe90a 2022-01-13 op ACKNOWLEDGEMENTS
567 d9bfe90a 2022-01-13 op The Trust, but verify (where appropriate) TOFU scheme was firstly
568 d9bfe90a 2022-01-13 op suggested by thfr: gemini://thfr.info/gemini/modified-trust-verify.gmi.
569 d9bfe90a 2022-01-13 op
570 cc9bf8f2 2021-11-05 op AUTHORS
571 cc9bf8f2 2021-11-05 op The telescope program was written by Omar Polo <op@omarpolo.com>.
572 cc9bf8f2 2021-11-05 op
573 bfd29c14 2021-12-01 op CAVEATS
574 d9bfe90a 2022-01-13 op telescope assumes a UTF-8 environment and doesn't try to cope with other
575 d9bfe90a 2022-01-13 op encodings. This can cause strange rendering issues if you're lucky, or
576 d9bfe90a 2022-01-13 op possibly weird thing happening depending on your locale and terminal
577 bfd29c14 2021-12-01 op emulator.
578 bfd29c14 2021-12-01 op
579 d9bfe90a 2022-01-13 op The algorithm used for text-wrapping is naive and doesn't really work for
580 d9bfe90a 2022-01-13 op languages that make heavily use of glyphs composed by multiple UNICODE
581 d9bfe90a 2022-01-13 op codepoints.
582 d9bfe90a 2022-01-13 op
583 cc9bf8f2 2021-11-05 op BUGS
584 cc9bf8f2 2021-11-05 op There's no UI for out-of-band certificates validation.
585 cc9bf8f2 2021-11-05 op
586 4b495710 2022-04-13 op OpenBSD 7.1 January 5, 2022 OpenBSD 7.1