3 <!-- This is an automatically generated file. Do not edit.
4 Copyright (c) 2021, 2022 Omar Polo <op@omarpolo.com>
6 Permission to use, copy, modify, and distribute this software for any
7 purpose with or without fee is hereby granted, provided that the above
8 copyright notice and this permission notice appear in all copies.
10 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 <meta charset="utf-8"/>
20 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
32 table.head, table.foot { width: 100%; }
33 td.head-rtitle, td.foot-os { text-align: right; }
34 td.head-vol { text-align: center; }
35 .Nd, .Bf, .Op { display: inline; }
36 .Pa, .Ad { font-style: italic; }
37 .Ms { font-weight: bold; }
38 .Bl-diag > dt { font-weight: bold; }
39 code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd { font-weight: bold;
40 font-family: inherit; }
42 <title>TELESCOPE(1)</title>
47 <td class="head-ltitle">TELESCOPE(1)</td>
48 <td class="head-vol">General Commands Manual</td>
49 <td class="head-rtitle">TELESCOPE(1)</td>
52 <div class="manual-text">
54 <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
55 <p class="Pp"><code class="Nm">telescope</code> —
56 <span class="Nd">multi-protocol browser</span></p>
59 <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
62 <td><code class="Nm">telescope</code></td>
63 <td>[<code class="Fl">-ChnSv</code>]
64 [<code class="Fl">-c</code> <var class="Ar">config</var>]
65 [<var class="Ar">URL</var>]</td>
70 <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
71 <p class="Pp"><code class="Nm">telescope</code> is an interactive browser that
72 supports the Finger, Gemini and Gopher protocols.
73 <code class="Nm">telescope</code> features tabs, a minibuffer, interactive
74 completions, bookmarks and out-of-band TOFU verification.</p>
75 <p class="Pp">The arguments are as follows:</p>
77 <dt id="C"><a class="permalink" href="#C"><code class="Fl">-C</code></a>,
78 <code class="Fl">--colours</code></dt>
79 <dd>Show all available colors and exit. This option can also be spelled
80 <code class="Fl">--colors</code>.</dd>
81 <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>
82 <var class="Ar">config</var></dt>
83 <dd>Specify an alternative configuration file. By default
84 <span class="Pa">~/.config/telescope/config</span> is loaded.</dd>
85 <dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a>,
86 <code class="Fl">--help</code></dt>
87 <dd>Display version, usage and exit.</dd>
88 <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
89 <dd>Configtest mode. Only check the configuration file for validity.</dd>
90 <dt id="S"><a class="permalink" href="#S"><code class="Fl">-S</code></a>,
91 <code class="Fl">--safe</code></dt>
92 <dd>“Safe” (or “sandbox”) mode. Prevent
93 <code class="Nm">telescope</code> from writing files to the disk and to
94 acquire the lock, allowing to run multiple instances at the same time.
95 <code class="Nm">telescope</code> still loads the session file and the
96 custom about pages.</dd>
97 <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a>,
98 <code class="Fl">--version</code></dt>
99 <dd>Display version and exit.</dd>
103 <h1 class="Sh" id="UI_CONCEPTS"><a class="permalink" href="#UI_CONCEPTS">UI
105 <p class="Pp"><code class="Nm">telescope</code> interface is divided into four
106 areas: the tabline, the body, the modeline and the echoarea/minibuffer.</p>
107 <p class="Pp">The tabline is always at the top of the screen and displays the
108 tabs separated by a vertical line. When there are more tabs than the size of
109 the window allow to display, the characters ‘<’ or
110 ‘>’ are shown at the start/end of the tabline to indicate
111 that there are more tabs in that direction.</p>
112 <p class="Pp">The body occupies the majority of the visible area. It contains
113 the current page and optionally a side window.</p>
114 <p class="Pp">The modeline is the second to last row of the screen. It shows
115 some information about the page: a spinner when the page is loading, the
116 trust level, the document type, the scroll offset and the URL.</p>
117 <p class="Pp">The echoarea is usually the last line of the screen. Messages are
118 often showed there, and link addresses too. The echoarea is also used to
119 obtain input from the user. When commands like
120 <code class="Ic">swiper</code> or <code class="Ic">link-select</code> are
121 invoked, the minibuffer area grows to show possible completions.</p>
124 <h1 class="Sh" id="TOFU"><a class="permalink" href="#TOFU">TOFU</a></h1>
125 <p class="Pp"><code class="Nm">telescope</code> aims to use the “Trust,
126 but Verify (where appropriate)” approach for TOFU (“Trust On
127 First Use”). The idea is to define three level of verification for a
131 <dd>(‘!’) the server fingerprint does NOT match the stored
134 <dd>(‘v’) the server fingerprint matches the store one.</dd>
136 <dd>(‘V’) the fingerprint matches and has been verified
139 <p class="Pp">The trust level of the page is indicated in the modeline with the
140 indicated character.</p>
141 <p class="Pp">Most of the time the “trusted” level is enough, but
142 where is appropriate users should be able to verify out-of-band the
144 <p class="Pp">At the moment, there is no built-in support for an out-of-band
145 verification though.</p>
148 <h1 class="Sh" id="SUPPORTED_PROTOCOLS"><a class="permalink" href="#SUPPORTED_PROTOCOLS">SUPPORTED
150 <p class="Pp">The following protocols are supported:</p>
153 <dd>About pages are <code class="Nm">telescope</code> internal page. See
154 about:about for a list of all these pages.</dd>
156 <dd>File types know to <code class="Nm">telescope</code>, such as .gmi,
157 .gemini, .txt, .md, .markdown, .diff or .patch, can be viewed inside the
158 application. Types of local files are detected solely based on the file
159 extension. On some systems, such as <span class="Ux">OpenBSD</span>, only
160 files inside special directories (like <span class="Pa">/tmp</span>
161 <span class="No">or</span> <span class="Pa">~/Downloads</span>) are
164 <dd>Finger URLs are interpreted as follows:
165 <ul class="Bl-bullet Bl-compact">
166 <li>the host is determined by the host name portion of the URL</li>
167 <li>if the user portion of the URL is provided, it's interpreted as the
168 user to finger, otherwise the path component will be used</li>
170 thus <a class="Lk" href="finger://user@hostname">finger://user@hostname</a>
171 and <a class="Lk" href="finger://hostname/user">finger://hostname/user</a>
172 are treated as the same URL.</dd>
174 <dd>Gemini is fully supported, with the exception of client-certificates.</dd>
176 <dd>Gopher support is limited to items type 0, 1 and 7. All text is assumed to
177 be encoded in UTF-8 (or ASCII).</dd>
179 <p class="Pp">User-entered URLs, given as argument on the command line or
180 entered with <code class="Ic">load-url</code>, are intepreted with a simple
182 <ul class="Bl-bullet Bl-compact">
183 <li>if it's a proper absolute URL then use it as-is,</li>
184 <li>if it starts with “./” or “/” assume it's a
186 <li>otherwise assume it's a Gemini URL.</li>
190 <h1 class="Sh" id="CONFIGURATION_FILE"><a class="permalink" href="#CONFIGURATION_FILE">CONFIGURATION
192 <p class="Pp">During the startup, <code class="Nm">telescope</code> reads the
193 configuration file at <span class="Pa">~/.config/telescope/config</span> or
194 <span class="Pa">~/.telescope/config</span>.</p>
195 <p class="Pp">It's possible to load a custom configuration file using the
196 <code class="Fl">-c</code> flag.</p>
197 <p class="Pp"><code class="Nm">telescope</code> will also load a file called
198 <span class="Pa">config-TERM</span>, where “TERM” is the name
199 of the terminal type (i.e. the TERM environment variable), if it exists.</p>
200 <p class="Pp">The format of the configuration file is fairly flexible. The
201 current line can be extended over multiple ones using a backslash
202 (‘\’). Comments can be put anywhere in the file using a hash
203 mark (‘#’), and extend to the end of the current line, but
204 backslashes can't be used to extend comments over multiple lines.</p>
205 <p class="Pp">The following constructs are available:</p>
207 <dt id="bind"><a class="permalink" href="#bind"><code class="Ic">bind</code></a>
208 <var class="Ar">map</var> <var class="Ar">key</var>
209 <var class="Ar">cmd</var></dt>
210 <dd>Bind <var class="Ar">key</var> to the function <var class="Ar">cmd</var>
211 in the keymap <var class="Ar">map</var>. Valid values for map are
212 “global-map” (i.e. when the user is viewing a page) and
213 “minibuffer-map” (i.e. when the minibuffer has the focus.)
214 <var class="Ar">key</var> follows the same syntax described in
215 <a class="Sx" href="#DEFAULT_KEY_BINDINGS">DEFAULT KEY BINDINGS</a> and
216 all the possible functions are listed in
217 <a class="Sx" href="#INTERACTIVE_COMMANDS">INTERACTIVE COMMANDS</a>.</dd>
218 <dt id="proxy"><a class="permalink" href="#proxy"><code class="Ic">proxy</code></a>
219 <var class="Ar">proto</var> <code class="Ic">via</code>
220 <var class="Ar">url</var></dt>
221 <dd>Use <var class="Ar">url</var> as proxy for all URLs with protocol
222 <var class="Ar">proto</var>. <var class="Ar">url</var> must be a Gemini
223 URI without path, query and fragment component.</dd>
224 <dt id="set"><a class="permalink" href="#set"><code class="Ic">set</code></a>
225 <var class="Ar">opt</var> <span class="No">=</span>
226 <var class="Ar">val</var></dt>
227 <dd>Set the option <var class="Ar">opt</var> to the value
228 <var class="Ar">val</var>. Valid options are:
230 <dl class="Bl-tag Bl-compact">
231 <dt id="autosave"><a class="permalink" href="#autosave"><code class="Ic">autosave</code></a></dt>
232 <dd>(integer) If greater than zero, save the session after the specified
233 amount of seconds after some events happens (new or closed tabs,
234 visited a link ...) Defaults to 20.</dd>
235 <dt id="dont-wrap-pre"><a class="permalink" href="#dont-wrap-pre"><code class="Ic">dont-wrap-pre</code></a></dt>
236 <dd>(integer) If nonzero, don't wrap preformatted blocks. Defaults to
238 <dt id="download-path"><a class="permalink" href="#download-path"><code class="Ic">download-path</code></a></dt>
239 <dd>(string) The default download path. Defaults to
240 <span class="Pa">/tmp</span>.</dd>
241 <dt id="emojify-link"><a class="permalink" href="#emojify-link"><code class="Ic">emojify-link</code></a></dt>
242 <dd>(integer) If nonzero, when the text of a link starts with an emoji
243 followed by a space, use that emoji as line prefix. Defaults to
245 <dt id="enable-colors"><a class="permalink" href="#enable-colors"><code class="Ic">enable-colors</code></a></dt>
246 <dd>(integer) If nonzero, enable colours. Defaults to 0 if
247 <code class="Ev">NO_COLORS</code> is set, 1 otherwise.</dd>
248 <dt id="fill-column"><a class="permalink" href="#fill-column"><code class="Ic">fill-column</code></a></dt>
249 <dd>(integer) If greater than zero, lines of text will be formatted in a
250 way that don't exceed the given number of columns. Defaults to
252 <dt id="fringe-ignore-offset"><a class="permalink" href="#fringe-ignore-offset"><code class="Ic">fringe-ignore-offset</code></a></dt>
253 <dd>(integer) If nonzero, the fringe doesn't obey to
254 <code class="Ic">olivetti-mode</code>. Defaults to 1.</dd>
255 <dt id="hide-pre-blocks"><a class="permalink" href="#hide-pre-blocks"><code class="Ic">hide-pre-blocks</code></a></dt>
256 <dd>(integer) If nonzero, hide by default the body of the preformatted
257 blocks. Defaults to zero. <code class="Ic">push-button</code> can be
258 used to toggle the visibility per-block.</dd>
259 <dt id="hide-pre-closing-line"><a class="permalink" href="#hide-pre-closing-line"><code class="Ic">hide-pre-closing-line</code></a></dt>
260 <dd>(integer) If nonzero, hide the closing line of preformatted blocks.
262 <dt id="hide-pre-context"><a class="permalink" href="#hide-pre-context"><code class="Ic">hide-pre-context</code></a></dt>
263 <dd>(integer) If nonzero, hide the start and end line of the preformatted
264 blocks. If both hide-pre-context and hide-pre-blocks are nonzero,
265 preformatted blocks are irremediably hidden. Defaults to zero.</dd>
266 <dt id="new-tab-url"><a class="permalink" href="#new-tab-url"><code class="Ic">new-tab-url</code></a></dt>
267 <dd>(string) URL for the new tab page. Defaults to
268 “about:new”.</dd>
269 <dt id="max-killed-tabs"><a class="permalink" href="#max-killed-tabs"><code class="Ic">max-killed-tabs</code></a></dt>
270 <dd>(integer) The maximum number of closed tabs to keep track of, defaults
271 to 10. Must be a positive number; if zero, don't save closed tabs at
273 <dt id="olivetti-mode"><a class="permalink" href="#olivetti-mode"><code class="Ic">olivetti-mode</code></a></dt>
274 <dd>(integer) If nonzero, enable <code class="Ic">olivetti-mode</code>
276 <dt id="tab-bar-show"><a class="permalink" href="#tab-bar-show"><code class="Ic">tab-bar-show</code></a></dt>
277 <dd>(integer) If tab-bar-show is -1 hide the tab bar permanently, if 0
278 show it unconditionally. If it's 1, show the bar only when there is
279 more than one tab. Defaults to 1.</dd>
280 <dt id="update-title"><a class="permalink" href="#update-title"><code class="Ic">update-title</code></a></dt>
281 <dd>(integer) If nonzero, set the terminal title to the page title.
285 <dt id="style"><a class="permalink" href="#style"><code class="Ic">style</code></a>
286 <var class="Ar">name</var> <var class="Ar">option</var></dt>
287 <dd>Change the styling of the element identified by
288 <var class="Ar">name</var>. Multiple options may be specified within curly
289 braces. Valid style identifiers are:
290 <div class="Bd-indent">
291 <dl class="Bl-tag Bl-compact">
293 <dd>the area outside the lines in the body of the page.</dd>
295 <dd>the completions.</dd>
296 <dt>line.compl.current</dt>
297 <dd>the current completion.</dd>
299 <dd>text in the *Help* buffer.</dd>
300 <dt>line.download.ongoing</dt>
301 <dd>an ongoing download</dd>
302 <dt>line.download.done</dt>
303 <dd>a completed download</dd>
304 <dt>line.download.info</dt>
305 <dd>informational text in the *Downloads* buffer.</dd>
307 <dd>(virtual) lines draw after the end of a buffer.</dd>
312 <dt>line.title1..3</dt>
318 <dt>line.pre.start</dt>
319 <dd>the heading of a preformatted block.</dd>
321 <dd>the content of a preformatted block.</dd>
322 <dt>line.pre.end</dt>
323 <dd>the closing line of a preformatted block.</dd>
325 <dd>the download pane</dd>
327 <dd>the minibuffer.</dd>
329 <dd>the modeline.</dd>
331 <dd>the tabline.</dd>
333 <dd>the non-focused tabs.</dd>
334 <dt>tabline.current</dt>
335 <dd>the focused tab.</dd>
338 <p class="Pp">Valid options are:</p>
340 <dt id="attr"><a class="permalink" href="#attr"><code class="Ic">attr</code></a>
341 <var class="Ar">prefix</var> [<var class="Ar">line</var>
342 [<var class="Ar">trail</var>]]</dt>
343 <dd>Sets the text attributes. If only one value is given,
344 <var class="Ar">line</var> and <var class="Ar">trail</var> default to
345 that; if two values are given then <var class="Ar">trail</var>
346 defaults to <var class="Ar">prefix</var>. Each attribute is a
347 comma-separated list of keywords:
348 <div class="Bd-indent">
349 <dl class="Bl-tag Bl-compact">
350 <dt id="normal"><a class="permalink" href="#normal"><code class="Ic">normal</code></a></dt>
351 <dd>no attributes.</dd>
352 <dt id="standout"><a class="permalink" href="#standout"><code class="Ic">standout</code></a></dt>
353 <dd>best highlighting mode for the terminal.</dd>
354 <dt id="underline"><a class="permalink" href="#underline"><code class="Ic">underline</code></a></dt>
355 <dd>underlines the text.</dd>
356 <dt id="reverse"><a class="permalink" href="#reverse"><code class="Ic">reverse</code></a></dt>
357 <dd>reverses background/foreground colors.</dd>
358 <dt id="blink"><a class="permalink" href="#blink"><code class="Ic">blink</code></a></dt>
359 <dd>makes the text blinking.</dd>
360 <dt id="dim"><a class="permalink" href="#dim"><code class="Ic">dim</code></a></dt>
361 <dd>half bright.</dd>
362 <dt id="bold"><a class="permalink" href="#bold"><code class="Ic">bold</code></a></dt>
363 <dd>extra bright or bold.</dd>
366 <p class="Pp">Only the style identifiers with the “line.”
367 prefix accept up to three attributes. The other will only use the
370 <dt id="bg"><a class="permalink" href="#bg"><code class="Ic">bg</code></a>
371 <var class="Ar">prefix</var> [<var class="Ar">line</var>
372 [<var class="Ar">trail</var>]]</dt>
373 <dd>Sets the background color. Follows the same behaviour as
374 <code class="Ic">attr</code> regarding the optional parameters. The
375 colour is one of black, red, green, yellow, blue, magenta, cyan and
376 white; colour0 to colour255 (or color0 to color255) from the
377 256-colour set; default for the default colour.</dd>
378 <dt id="fg"><a class="permalink" href="#fg"><code class="Ic">fg</code></a>
379 <var class="Ar">prefix</var> [<var class="Ar">line</var>
380 [<var class="Ar">trail</var>]]</dt>
381 <dd>Sets the foreground color. It behaves just like
382 <code class="Ic">bg</code>.</dd>
383 <dt id="prefix"><a class="permalink" href="#prefix"><code class="Ic">prefix</code></a>
384 <var class="Ar">prfx</var> [<var class="Ar">cont</var>]</dt>
385 <dd>Sets the prefix for the current line type to
386 <var class="Ar">prfx</var> and <var class="Ar">cont</var> as the
387 prefix for the continuation lines (i.e. when a long line gets
388 wrapped.) If <var class="Ar">cont</var> is not given its value will be
389 the same of <var class="Ar">prfx</var>.</dd>
395 <h1 class="Sh" id="DEFAULT_KEY_BINDINGS"><a class="permalink" href="#DEFAULT_KEY_BINDINGS">DEFAULT
396 KEY BINDINGS</a></h1>
397 <p class="Pp">The default key bindings are very similar to GNU Emacs, but care
398 has been taken to include also bindings familiar for <a class="Xr">vi(1)</a>
399 and “CUA” users. In the following examples, C-x means
400 Control-x, M-x means Meta-x, where the Meta key may be either a special key
401 on the keyboard or the ALT key; otherwise ESC followed by the key X works as
402 well, and C-M-x means to press the key X together with both Control and
404 <p class="Pp">Keys are usually a single character, like ‘p’ or
405 ‘n’, but some special keys are accepted as well.</p>
407 <div class="Bd-indent">
408 <dl class="Bl-tag Bl-compact">
411 <dt><down></dt>
413 <dt><left></dt>
415 <dt><right></dt>
417 <dt><prior></dt>
418 <dd>Previous page/Page up</dd>
419 <dt><next></dt>
420 <dd>Next page/Page down</dd>
421 <dt><home></dt>
425 <dt><f0> thru <f63></dt>
426 <dd>Function keys</dd>
427 <dt>del or backspace</dt>
431 <dt>space or spc</dt>
433 <dt>enter or ret</dt>
438 <dd>Depends on the configuration of the terminal emulator; usually shift
443 <h2 class="Ss" id="GNU_Emacs-like_keys"><a class="permalink" href="#GNU_Emacs-like_keys">GNU
444 Emacs-like keys</a></h2>
445 <div class="Bd-indent">
446 <dl class="Bl-tag Bl-compact">
448 <dd>previous-line</dd>
452 <dd>forward-char</dd>
454 <dd>backward-char</dd>
456 <dd>backward-paragraph</dd>
458 <dd>forward-paragraph</dd>
460 <dd>move-beginning-of-line</dd>
462 <dd>move-end-of-line</dd>
463 <dt>M-v, M-space</dt>
468 <dd>beginning-of-buffer</dd>
470 <dd>end-of-buffer</dd>
472 <dd>kill-telescope</dd>
474 <dd>clear-minibuf</dd>
476 <dd>execute-extended-command</dd>
478 <dd>dec-fill-column</dd>
480 <dd>inc-fill-column</dd>
482 <dd>previous-heading</dd>
484 <dd>next-heading</dd>
488 <dd>load-current-url</dd>
492 <dd>load-current-url</dd>
494 <dd>other-window</dd>
498 <dd>tab-close-other</dd>
504 <dd>tab-previous</dd>
510 <dd>previous-page</dd>
513 <dt><f7> a</dt>
514 <dd>bookmark-page</dd>
515 <dt><f7> <f7></dt>
516 <dd>list-bookmarks</dd>
518 <dd>suspend-telescope</dd>
523 <h2 class="Ss" id="vi_1_-like_keys"><a class="permalink" href="#vi_1_-like_keys"><a class="Xr">vi(1)</a>-like
525 <div class="Bd-indent">
526 <dl class="Bl-tag Bl-compact">
528 <dd>previous-line</dd>
532 <dd>forward-char</dd>
534 <dd>backward-char</dd>
536 <dd>backward-paragraph</dd>
538 <dd>forward-paragraph</dd>
540 <dd>move-beginning-of-line</dd>
542 <dd>move-end-of-line</dd>
544 <dd>scroll-line-up</dd>
546 <dd>scroll-line-down</dd>
548 <dd>beginning-of-buffer</dd>
550 <dd>end-of-buffer</dd>
558 <dd>tab-previous</dd>
564 <dd>previous-page</dd>
568 <dd>tab-undo-close</dd>
570 <dd>kill-telescope</dd>
572 <dd>clear-minibuf</dd>
574 <dd>execute-extended-command</dd>
579 <h2 class="Ss" id="CUA-like_keys"><a class="permalink" href="#CUA-like_keys">CUA-like
581 <div class="Bd-indent">
582 <dl class="Bl-tag Bl-compact">
584 <dd>previous-line</dd>
585 <dt><down></dt>
587 <dt><right></dt>
588 <dd>forward-char</dd>
589 <dt><left></dt>
590 <dd>backward-char</dd>
591 <dt><home></dt>
592 <dd>move-beginning-of-line</dd>
594 <dd>move-end-of-line</dd>
595 <dt><prior></dt>
597 <dt><next></dt>
603 <dt>M-<prior></dt>
604 <dd>tab-previous</dd>
605 <dt>M-<next></dt>
608 <dd>previous-page</dd>
609 <dt>M-<left></dt>
610 <dd>previous-page</dd>
611 <dt>M-<right></dt>
621 <h2 class="Ss" id="Neither_Emacs_nor_vi_specific"><a class="permalink" href="#Neither_Emacs_nor_vi_specific">Neither
622 Emacs nor vi specific</a></h2>
623 <div class="Bd-indent">
624 <dl class="Bl-tag Bl-compact">
630 <dd>push-button-new-tab</dd>
632 <dd>previous-button</dd>
634 <dd>previous-button</dd>
640 <dd>tab-previous</dd>
652 <dd>reply-last-input</dd>
657 <h2 class="Ss" id="Minibuffer-specific_keys"><a class="permalink" href="#Minibuffer-specific_keys">Minibuffer-specific
659 <div class="Bd-indent">
660 <dl class="Bl-tag Bl-compact">
662 <dd>mini-complete-and-exit</dd>
668 <dd>mini-delete-char</dd>
670 <dd>mini-delete-backward-char</dd>
672 <dd>mini-delete-backward-char</dd>
674 <dd>mini-delete-backward-char</dd>
676 <dd>backward-char</dd>
678 <dd>forward-char</dd>
679 <dt><left></dt>
680 <dd>backward-char</dd>
681 <dt><right></dt>
682 <dd>forward-char</dd>
684 <dd>move-end-of-line</dd>
686 <dd>move-beginning-of-line</dd>
688 <dd>move-end-of-line</dd>
689 <dt><home></dt>
690 <dd>move-beginning-of-line</dd>
692 <dd>mini-kill-line</dd>
694 <dd>mini-previous-history-element</dd>
696 <dd>mini-next-history-element</dd>
698 <dd>previous-completion</dd>
700 <dd>next-completion</dd>
702 <dd>previous-completion</dd>
703 <dt><down></dt>
704 <dd>next-completion</dd>
706 <dd>insert-current-candidate</dd>
708 <dd>mini-goto-beginning</dd>
710 <dd>mini-goto-end</dd>
716 <h1 class="Sh" id="INTERACTIVE_COMMANDS"><a class="permalink" href="#INTERACTIVE_COMMANDS">INTERACTIVE
718 <p class="Pp">Follows the documentation for the interactive commands. These
719 commands can be bound to a key or executed with
720 <code class="Ic">execute-extended-command</code>.</p>
722 <h2 class="Ss" id="Movement_commands"><a class="permalink" href="#Movement_commands">Movement
724 <dl class="Bl-tag Bl-compact">
725 <dt id="backward-char"><a class="permalink" href="#backward-char"><code class="Ic">backward-char</code></a></dt>
726 <dd>Move point one character backward.</dd>
727 <dt id="backward-paragraph"><a class="permalink" href="#backward-paragraph"><code class="Ic">backward-paragraph</code></a></dt>
728 <dd>Move point one paragraph backward.</dd>
729 <dt id="beginning-of-buffer"><a class="permalink" href="#beginning-of-buffer"><code class="Ic">beginning-of-buffer</code></a></dt>
730 <dd>Move point to the beginning of the buffer.</dd>
731 <dt id="end-of-buffer"><a class="permalink" href="#end-of-buffer"><code class="Ic">end-of-buffer</code></a></dt>
732 <dd>Move point to the end of the buffer.</dd>
733 <dt id="forward-char"><a class="permalink" href="#forward-char"><code class="Ic">forward-char</code></a></dt>
734 <dd>Move point one character forward.</dd>
735 <dt id="forward-paragraph"><a class="permalink" href="#forward-paragraph"><code class="Ic">forward-paragraph</code></a></dt>
736 <dd>Move point one paragraph forward.</dd>
737 <dt id="insert-current-candidate"><a class="permalink" href="#insert-current-candidate"><code class="Ic">insert-current-candidate</code></a></dt>
738 <dd>Copy the current selection text as minibuffer input.</dd>
739 <dt id="move-beginning-of-line"><a class="permalink" href="#move-beginning-of-line"><code class="Ic">move-beginning-of-line</code></a></dt>
740 <dd>Move point at the beginning of the current (visual) line.</dd>
741 <dt id="move-end-of-line"><a class="permalink" href="#move-end-of-line"><code class="Ic">move-end-of-line</code></a></dt>
742 <dd>Move point at the end of the current (visual) line.</dd>
743 <dt id="next-button"><a class="permalink" href="#next-button"><code class="Ic">next-button</code></a></dt>
744 <dd>Move point to the next link.</dd>
745 <dt id="next-completion"><a class="permalink" href="#next-completion"><code class="Ic">next-completion</code></a></dt>
746 <dd>Select the next completion.</dd>
747 <dt id="next-heading"><a class="permalink" href="#next-heading"><code class="Ic">next-heading</code></a></dt>
748 <dd>Move point to the next heading.</dd>
749 <dt id="next-line"><a class="permalink" href="#next-line"><code class="Ic">next-line</code></a></dt>
750 <dd>Move point to the next (visual) line, in the same column if possible.</dd>
751 <dt id="previous-button"><a class="permalink" href="#previous-button"><code class="Ic">previous-button</code></a></dt>
752 <dd>Move point to the previous link.</dd>
753 <dt id="previous-completion"><a class="permalink" href="#previous-completion"><code class="Ic">previous-completion</code></a></dt>
754 <dd>Select the previous completion.</dd>
755 <dt id="previous-heading"><a class="permalink" href="#previous-heading"><code class="Ic">previous-heading</code></a></dt>
756 <dd>Move point to the previous heading.</dd>
757 <dt id="previous-line"><a class="permalink" href="#previous-line"><code class="Ic">previous-line</code></a></dt>
758 <dd>Move point to the previous (visual) line.</dd>
762 <h2 class="Ss" id="Bookmark-related_commands"><a class="permalink" href="#Bookmark-related_commands">Bookmark-related
764 <dl class="Bl-tag Bl-compact">
765 <dt id="bookmark-page"><a class="permalink" href="#bookmark-page"><code class="Ic">bookmark-page</code></a></dt>
766 <dd>Save a page in the bookmark file. It preloads the minibuffer with the
768 <dt id="list-bookmarks"><a class="permalink" href="#list-bookmarks"><code class="Ic">list-bookmarks</code></a></dt>
769 <dd>Load the bookmarks page.</dd>
773 <h2 class="Ss" id="Tab-related_commands"><a class="permalink" href="#Tab-related_commands">Tab-related
775 <dl class="Bl-tag Bl-compact">
776 <dt id="tab-close"><a class="permalink" href="#tab-close"><code class="Ic">tab-close</code></a></dt>
777 <dd>Close the current tab.</dd>
778 <dt id="tab-close-other"><a class="permalink" href="#tab-close-other"><code class="Ic">tab-close-other</code></a></dt>
779 <dd>Close all tabs but the current one.</dd>
780 <dt id="tab-move"><a class="permalink" href="#tab-move"><code class="Ic">tab-move</code></a></dt>
781 <dd>Move the current tab after the next one, wrapping around if needed.</dd>
782 <dt id="tab-move-to"><a class="permalink" href="#tab-move-to"><code class="Ic">tab-move-to</code></a></dt>
783 <dd>Move the current tab before the previous one, wrapping around if
785 <dt id="tab-new"><a class="permalink" href="#tab-new"><code class="Ic">tab-new</code></a></dt>
786 <dd>Open a new tab.</dd>
787 <dt id="tab-next"><a class="permalink" href="#tab-next"><code class="Ic">tab-next</code></a></dt>
788 <dd>Focus next tab, wrapping around eventually.</dd>
789 <dt id="tab-previous"><a class="permalink" href="#tab-previous"><code class="Ic">tab-previous</code></a></dt>
790 <dd>Focus the previous tab, wrapping around eventually.</dd>
791 <dt id="tab-select"><a class="permalink" href="#tab-select"><code class="Ic">tab-select</code></a></dt>
792 <dd>Switch to a tab using the minibuffer.</dd>
793 <dt id="tab-undo-close"><a class="permalink" href="#tab-undo-close"><code class="Ic">tab-undo-close</code></a></dt>
794 <dd>Re-open the most recently closed tab, if any.</dd>
798 <h2 class="Ss" id="Misc_commands"><a class="permalink" href="#Misc_commands">Misc
800 <dl class="Bl-tag Bl-compact">
801 <dt id="cache-info"><a class="permalink" href="#cache-info"><code class="Ic">cache-info</code></a></dt>
802 <dd>Show cache stats.</dd>
803 <dt id="clear-minibuf"><a class="permalink" href="#clear-minibuf"><code class="Ic">clear-minibuf</code></a></dt>
804 <dd>Clear the echo area.</dd>
805 <dt id="dec-fill-column"><a class="permalink" href="#dec-fill-column"><code class="Ic">dec-fill-column</code></a></dt>
806 <dd>Decrement fill-column by two.</dd>
807 <dt id="execute-extended-command"><a class="permalink" href="#execute-extended-command"><code class="Ic">execute-extended-command</code></a></dt>
808 <dd>Execute an internal command.</dd>
809 <dt id="kill-telescope"><a class="permalink" href="#kill-telescope"><code class="Ic">kill-telescope</code></a></dt>
810 <dd>Quit <code class="Nm">telescope</code>.</dd>
811 <dt id="inc-fill-column"><a class="permalink" href="#inc-fill-column"><code class="Ic">inc-fill-column</code></a></dt>
812 <dd>Increment fill-column by two.</dd>
813 <dt id="link-select"><a class="permalink" href="#link-select"><code class="Ic">link-select</code></a></dt>
814 <dd>Select and visit a link using the minibuffer.</dd>
815 <dt id="load-current-url"><a class="permalink" href="#load-current-url"><code class="Ic">load-current-url</code></a></dt>
816 <dd>Edit the current URL.</dd>
817 <dt id="load-url"><a class="permalink" href="#load-url"><code class="Ic">load-url</code></a></dt>
818 <dd>Prompt for an URL.</dd>
819 <dt id="next-page"><a class="permalink" href="#next-page"><code class="Ic">next-page</code></a></dt>
820 <dd>Go forward in the page history.</dd>
821 <dt id="olivetti-mode~2"><a class="permalink" href="#olivetti-mode~2"><code class="Ic">olivetti-mode</code></a></dt>
822 <dd>Toggle olivetti mode (i.e. horizontal centering of the lines of the
824 <dt id="other-window"><a class="permalink" href="#other-window"><code class="Ic">other-window</code></a></dt>
825 <dd>Select the other window.</dd>
826 <dt id="previous-page"><a class="permalink" href="#previous-page"><code class="Ic">previous-page</code></a></dt>
827 <dd>Go backward in the page history.</dd>
828 <dt id="push-button"><a class="permalink" href="#push-button"><code class="Ic">push-button</code></a></dt>
829 <dd>Follow link at point, or toggle the visibility of the following
830 preformatted block if called when the cursor is on the heading of the
832 <dt id="push-button-new-tab"><a class="permalink" href="#push-button-new-tab"><code class="Ic">push-button-new-tab</code></a></dt>
833 <dd>Follow link at point in a new tab.</dd>
834 <dt id="redraw"><a class="permalink" href="#redraw"><code class="Ic">redraw</code></a></dt>
835 <dd>Redraw the screen, useful if some background program messed up the
837 <dt id="reload-page"><a class="permalink" href="#reload-page"><code class="Ic">reload-page</code></a></dt>
838 <dd>Reload the current page.</dd>
839 <dt id="reply-last-input"><a class="permalink" href="#reply-last-input"><code class="Ic">reply-last-input</code></a></dt>
840 <dd>Reply the last input request.</dd>
841 <dt id="scroll-down"><a class="permalink" href="#scroll-down"><code class="Ic">scroll-down</code></a></dt>
842 <dd>Scroll down by one visual page.</dd>
843 <dt id="scroll-line-down"><a class="permalink" href="#scroll-line-down"><code class="Ic">scroll-line-down</code></a></dt>
844 <dd>Scroll down by one line.</dd>
845 <dt id="scroll-line-up"><a class="permalink" href="#scroll-line-up"><code class="Ic">scroll-line-up</code></a></dt>
846 <dd>Scroll up by one line.</dd>
847 <dt id="scroll-up"><a class="permalink" href="#scroll-up"><code class="Ic">scroll-up</code></a></dt>
848 <dd>Scroll up by one visual page.</dd>
849 <dt id="suspend-telescope"><a class="permalink" href="#suspend-telescope"><code class="Ic">suspend-telescope</code></a></dt>
850 <dd>Suspend the current <code class="Nm">telescope</code> session.</dd>
851 <dt id="swiper"><a class="permalink" href="#swiper"><code class="Ic">swiper</code></a></dt>
852 <dd>Jump to a line using the minibuffer.</dd>
853 <dt id="toc"><a class="permalink" href="#toc"><code class="Ic">toc</code></a></dt>
854 <dd>Jump to a heading using the minibuffer.</dd>
855 <dt id="toggle-help"><a class="permalink" href="#toggle-help"><code class="Ic">toggle-help</code></a></dt>
856 <dd>Toggle side window with help about available keys and their associated
857 interactive command.</dd>
858 <dt id="toggle-pre-wrap"><a class="permalink" href="#toggle-pre-wrap"><code class="Ic">toggle-pre-wrap</code></a></dt>
859 <dd>Toggle the wrapping of preformatted blocks.</dd>
863 <h2 class="Ss" id="Minibuffer_commands"><a class="permalink" href="#Minibuffer_commands">Minibuffer
865 <dl class="Bl-tag Bl-compact">
866 <dt id="mini-abort"><a class="permalink" href="#mini-abort"><code class="Ic">mini-abort</code></a></dt>
867 <dd>Abort the current minibuffer action.</dd>
868 <dt id="mini-complete-and-exit"><a class="permalink" href="#mini-complete-and-exit"><code class="Ic">mini-complete-and-exit</code></a></dt>
869 <dd>Complete the current minibuffer action.</dd>
870 <dt id="mini-delete-backward-char"><a class="permalink" href="#mini-delete-backward-char"><code class="Ic">mini-delete-backward-char</code></a></dt>
871 <dd>Delete the character before the point.</dd>
872 <dt id="mini-delete-char"><a class="permalink" href="#mini-delete-char"><code class="Ic">mini-delete-char</code></a></dt>
873 <dd>Delete the character after the point.</dd>
874 <dt id="mini-goto-beginning"><a class="permalink" href="#mini-goto-beginning"><code class="Ic">mini-goto-beginning</code></a></dt>
875 <dd>Select the first completion, if any.</dd>
876 <dt id="mini-goto-end"><a class="permalink" href="#mini-goto-end"><code class="Ic">mini-goto-end</code></a></dt>
877 <dd>Select the last completion, if any.</dd>
878 <dt id="mini-kill-line"><a class="permalink" href="#mini-kill-line"><code class="Ic">mini-kill-line</code></a></dt>
879 <dd>Delete from point until the end of the line.</dd>
880 <dt id="mini-next-history-element"><a class="permalink" href="#mini-next-history-element"><code class="Ic">mini-next-history-element</code></a></dt>
881 <dd>Load the previous history element.</dd>
882 <dt id="mini-previous-history-element"><a class="permalink" href="#mini-previous-history-element"><code class="Ic">mini-previous-history-element</code></a></dt>
883 <dd>Load the next history element.</dd>
887 <h2 class="Ss" id="Aliases"><a class="permalink" href="#Aliases">Aliases</a></h2>
888 <p class="Pp">The following aliases are available during
889 <code class="Ic">execute-extended-command</code>:</p>
890 <dl class="Bl-tag Bl-compact">
891 <dt id="open"><a class="permalink" href="#open"><code class="Ic">open</code></a></dt>
892 <dd><a class="permalink" href="#load-url~2"><code class="Ic" id="load-url~2">load-url</code></a></dd>
893 <dt id="tabn"><a class="permalink" href="#tabn"><code class="Ic">tabn</code></a></dt>
894 <dd><a class="permalink" href="#tab-next~2"><code class="Ic" id="tab-next~2">tab-next</code></a></dd>
895 <dt id="tabnew"><a class="permalink" href="#tabnew"><code class="Ic">tabnew</code></a></dt>
896 <dd><a class="permalink" href="#tab-new~2"><code class="Ic" id="tab-new~2">tab-new</code></a></dd>
897 <dt id="tabp"><a class="permalink" href="#tabp"><code class="Ic">tabp</code></a></dt>
898 <dd><a class="permalink" href="#tab-previous~2"><code class="Ic" id="tab-previous~2">tab-previous</code></a></dd>
899 <dt id="q"><a class="permalink" href="#q"><code class="Ic">q</code></a>
900 <span class="No">and</span> <code class="Ic">wq</code></dt>
901 <dd><a class="permalink" href="#kill-telescope~2"><code class="Ic" id="kill-telescope~2">kill-telescope</code></a></dd>
906 <h1 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h1>
907 <p class="Pp">When <code class="Nm">telescope</code> is started, it inspects the
908 following environment variables:</p>
910 <dt id="HOME"><a class="permalink" href="#HOME"><code class="Ev">HOME</code></a></dt>
911 <dd>The user's login directory.</dd>
912 <dt id="NO_COLORS"><a class="permalink" href="#NO_COLORS"><code class="Ev">NO_COLORS</code></a></dt>
913 <dd>To decide whether to use colors or not. The content of the variable
915 <dt id="TERM"><a class="permalink" href="#TERM"><code class="Ev">TERM</code></a></dt>
916 <dd>The user's terminal name.</dd>
917 <dt id="XDG_CACHE_HOME"><a class="permalink" href="#XDG_CACHE_HOME"><code class="Ev">XDG_CACHE_HOME</code></a>,
918 <code class="Ev">XDG_CONFIG_HOME</code>,
919 <code class="Ev">XDG_DATA_HOME</code></dt>
920 <dd>If defined can alter the default location of the files used.</dd>
924 <h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
925 <p class="Pp">By default <code class="Nm">telescope</code> follows the XDG Base
926 Directory Specification. However, if <span class="Pa">~/.telescope</span>
927 exists, XDG is ignored and all the files are stored inside it. The usage of
928 <code class="Ev">XDG_CACHE_HOME</code>,
929 <code class="Ev">XDG_CONFIG_HOME</code> and
930 <code class="Ev">XDG_DATA_HOME</code> can further alter the location of
933 <dl class="Bl-tag Bl-compact">
934 <dt><span class="Pa">~/.config/telescope/config</span></dt>
935 <dd>Default configuration file.</dd>
936 <dt><span class="Pa">~/.local/share/telescope/pages/about_*.gmi</span></dt>
937 <dd>Overrides for built-in about: pages.</dd>
938 <dt><span class="Pa">~/.local/share/telescope/bookmarks.gmi</span></dt>
939 <dd>Bookmarks file.</dd>
940 <dt><span class="Pa">~/.local/share/telescope/known_hosts</span></dt>
941 <dd>Hash of the certificates for all the known hosts. Each line contains three
942 fields: hostname with optional port number, hash of the certificate and a
944 <dt><span class="Pa">~/.cache/telescope/lock</span></dt>
945 <dd>Lock file used to prevent multiple instance of
946 <code class="Nm">telescope</code> from running at the same time.</dd>
947 <dt><span class="Pa">~/.cache/telescope/session</span></dt>
948 <dd>The list of tabs from the last session.</dd>
952 <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
953 <p class="Pp">It's possible to browse “the small web” (i.e. simple
954 websites) by using programs like the duckling-proxy by defining a proxy in
955 <span class="Pa">~/.config/telescope/config</span>:</p>
956 <div class="Bd Pp Bd-indent Li">
957 <pre>proxy http via "gemini://127.0.0.1:1965"
958 proxy https via "gemini://127.0.0.1:1965"</pre>
960 <p class="Pp">To load <code class="Nm">telescope</code> without any
962 <div class="Bd Pp Bd-indent Li">
963 <pre>telescope -c /dev/null</pre>
967 <h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
968 <p class="Pp"><cite class="Rs"><i class="RsB">XDG Base Directory
970 <a class="RsU" href="https://specifications.freedesktop.org/basedir-spec/latest/">https://specifications.freedesktop.org/basedir-spec/latest/</a>.</cite></p>
973 <h1 class="Sh" id="ACKNOWLEDGEMENTS"><a class="permalink" href="#ACKNOWLEDGEMENTS">ACKNOWLEDGEMENTS</a></h1>
974 <p class="Pp">The “Trust, but verify (where appropriate)” TOFU
975 scheme was firstly suggested by thfr:
976 <a class="Lk" href="gemini://thfr.info/gemini/modified-trust-verify.gmi">gemini://thfr.info/gemini/modified-trust-verify.gmi</a>.</p>
979 <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
980 <p class="Pp">The <code class="Nm">telescope</code> program was written by
981 <span class="An">Omar Polo</span>
982 <<a class="Mt" href="mailto:op@omarpolo.com">op@omarpolo.com</a>>.</p>
985 <h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
986 <p class="Pp"><code class="Nm">telescope</code> assumes a UTF-8 environment and
987 doesn't try to cope with other encodings. This can cause strange rendering
988 issues if you're lucky, or possibly weird thing happening depending on your
989 locale and terminal emulator.</p>
990 <p class="Pp">The algorithm used for text-wrapping is naive and doesn't really
991 work for languages that make heavily use of glyphs composed by multiple
992 UNICODE codepoints.</p>
995 <h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
996 <p class="Pp">There's no UI for out-of-band certificates validation.</p>
1001 <td class="foot-date">January 5, 2022</td>
1002 <td class="foot-os">OpenBSD 7.1</td>
