3 <!-- This is an automatically generated file. Do not edit.
4 Copyright (c) 2021 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"/>
26 font-family: monospace;
29 table.head, table.foot { width: 100%; }
30 td.head-rtitle, td.foot-os { text-align: right; }
31 td.head-vol { text-align: center; }
32 .Nd, .Bf, .Op { display: inline; }
33 .Pa, .Ad { font-style: italic; }
34 .Ms { font-weight: bold; }
35 .Bl-diag > dt { font-weight: bold; }
36 code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd { font-weight: bold;
37 font-family: inherit; }
39 <title>TELESCOPE(1)</title>
44 <td class="head-ltitle">TELESCOPE(1)</td>
45 <td class="head-vol">General Commands Manual</td>
46 <td class="head-rtitle">TELESCOPE(1)</td>
49 <div class="manual-text">
51 <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
52 <p class="Pp"><code class="Nm">telescope</code> —
53 <span class="Nd">multi-protocol browser</span></p>
56 <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
59 <td><code class="Nm">telescope</code></td>
60 <td>[<code class="Fl">-Chnv</code>]
61 [<code class="Fl">-c</code> <span class="Pa">config</span>]
62 [<var class="Ar">URL</var>]</td>
67 <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
68 <p class="Pp"><code class="Nm">telescope</code> is an interactive browser that
69 supports the Finger, Gemini and Gopher protocols.
70 <code class="Nm">telescope</code> features tabs, a minibuffer, interactive
71 completions, bookmarks and out-of-band TOFU verification.</p>
72 <p class="Pp">The arguments are as follows:</p>
74 <dt id="C"><a class="permalink" href="#C"><code class="Fl">-C</code></a>,
75 <code class="Fl">--colors</code></dt>
76 <dd>Show all available colors and exit.</dd>
77 <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>
78 <span class="Pa">config</span></dt>
79 <dd>Specify an alternative configuration file. By default
80 <span class="Pa">$HOME/.telescope/config</span> is loaded.</dd>
81 <dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a>,
82 <code class="Fl">--help</code></dt>
83 <dd>Display version and usage.</dd>
84 <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
85 <dd>Configtest mode. Only check the configuration file for validity.</dd>
86 <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a>,
87 <code class="Fl">--version</code></dt>
88 <dd>Display version.</dd>
92 <h1 class="Sh" id="UI_CONCEPTS"><a class="permalink" href="#UI_CONCEPTS">UI
94 <p class="Pp"><code class="Nm">telescope</code> interface is divided into four
95 areas: the tabline, the body, the modeline and the echoarea/minibuffer.</p>
96 <p class="Pp">The tabline is always at the top of the screen and displays the
97 tabs separated by a vertical line. When there are more tabs than the size of
98 the window allow to display, the characters ‘<’ or
99 ‘>’ are shown at the start/end of the tabline to indicate
100 that there are more tabs in that direction.</p>
101 <p class="Pp">The body occupies the majority of the visible area. It contains
102 the current page and optionally a side window.</p>
103 <p class="Pp">The modeline is the second to last row of the screen. It shows
104 some information about the page: a spinner when the page is loading, the
105 trust level, the document type, the scroll offset and the URL.</p>
106 <p class="Pp">The echoarea is usually the last line of the screen. Messages are
107 often showed there, and link addresses too. The echoarea is also used to
108 obtain input from the user. When commands like
109 <code class="Ic">swiper</code> or <code class="Ic">link-select</code> are
110 invoked, the minibuffer area grows to show possible completions.</p>
113 <h1 class="Sh" id="TOFU"><a class="permalink" href="#TOFU">TOFU</a></h1>
114 <p class="Pp"><code class="Nm">telescope</code> aims to use the “Trust,
115 but Verify (where appropriate)” approach for TOFU (“Trust On
116 First Use”). The idea is to define three level of verification for a
120 <dd>(‘!’) the server fingerprint does NOT match the stored
123 <dd>(‘v’) the server fingerprint matches the store one.</dd>
125 <dd>(‘V’) the fingerprint matches and has been verified
128 <p class="Pp">The trust level of the page is indicated in the modeline with the
129 indicated character.</p>
130 <p class="Pp">Most of the time the “trusted” level is enough, but
131 where is appropriate users should be able to verify out-of-band the
133 <p class="Pp">At the moment, there is no built-in support for an out-of-band
134 verification though.</p>
137 <h1 class="Sh" id="SUPPORTED_PROTOCOLS"><a class="permalink" href="#SUPPORTED_PROTOCOLS">SUPPORTED
139 <p class="Pp">The following protocols are supported:</p>
142 <dd>About pages are <code class="Nm">telescope</code> internal page. See
143 about:about for a list of all these pages.</dd>
145 <dd>File types know to <code class="Nm">telescope</code>, such as .gmi,
146 .gemini, .txt, .md, .markdown, .diff or .patch, can be viewed inside the
147 application. Types of local files are detected solely based on the file
148 extension. On some systems, such as <span class="Ux">OpenBSD</span>, only
149 files inside special directories (like <span class="Pa">/tmp</span>
150 <span class="No">or</span> <span class="Pa">~/Downloads</span>) are
153 <dd>Finger URLs are interpreted as follows:
154 <ul class="Bl-bullet Bl-compact">
155 <li>the host is determined by the host name portion of the URL</li>
156 <li>if the user portion of the URL is provided, it's interpreted as the
157 user to finger, otherwise the path component will be used</li>
159 thus <a class="Lk" href="finger://user@hostname">finger://user@hostname</a>
160 and <a class="Lk" href="finger://hostname/user">finger://hostname/user</a>
161 are treated as the same URL.</dd>
163 <dd>Gemini is fully supported, with the exception of client-certificates.</dd>
165 <dd>Gopher support is limited to items type 0, 1 and 7. All text is assumed to
166 be encoded in UTF-8 (or ASCII).</dd>
168 <p class="Pp">User-entered URLs, given as argument on the command line or
169 entered with <code class="Ic">load-url</code>, are intepreted with a simple
171 <ul class="Bl-bullet Bl-compact">
172 <li>if it's a proper absolute URL then use it as-is,</li>
173 <li>if it starts with “./” or “/” assume it's a
175 <li>otherwise assume it's a Gemini URL.</li>
179 <h1 class="Sh" id="DEFAULT_KEY_BINDINGS"><a class="permalink" href="#DEFAULT_KEY_BINDINGS">DEFAULT
180 KEY BINDINGS</a></h1>
181 <p class="Pp">The default key bindings are very similar to GNU Emacs, but care
182 has been taken to include also bindings familiar for <a class="Xr">vi(1)</a>
183 and “CUA” users. In the following examples, C-x means
184 Control-x, M-x means Meta-x, where the Meta key may be either a special key
185 on the keyboard or the ALT key; otherwise ESC followed by the key X works as
186 well, and C-M-x means to press the key X together with both Control and
188 <p class="Pp">Keys are usually a single character, like ‘p’ or
189 ‘n’, but some special keys are accepted as well.</p>
191 <div class="Bd-indent">
192 <dl class="Bl-tag Bl-compact">
195 <dt><down></dt>
197 <dt><left></dt>
199 <dt><right></dt>
201 <dt><prior></dt>
202 <dd>Previous page/Page up</dd>
203 <dt><next></dt>
204 <dd>Next page/Page down</dd>
205 <dt><home></dt>
209 <dt><f0> thru <f63></dt>
210 <dd>Function keys</dd>
211 <dt>del or backspace</dt>
215 <dt>space or spc</dt>
217 <dt>enter or ret</dt>
222 <dd>Depends on the configuration of the terminal emulator; usually shift
227 <h2 class="Ss" id="GNU_Emacs-like_keys"><a class="permalink" href="#GNU_Emacs-like_keys">GNU
228 Emacs-like keys</a></h2>
229 <div class="Bd-indent">
230 <dl class="Bl-tag Bl-compact">
232 <dd>previous-line</dd>
236 <dd>forward-char</dd>
238 <dd>backward-char</dd>
240 <dd>backward-paragraph</dd>
242 <dd>forward-paragraph</dd>
244 <dd>move-beginning-of-line</dd>
246 <dd>move-end-of-line</dd>
247 <dt>M-v, M-space</dt>
252 <dd>beginning-of-buffer</dd>
254 <dd>end-of-buffer</dd>
256 <dd>kill-telescope</dd>
258 <dd>clear-minibuf</dd>
260 <dd>execute-extended-command</dd>
262 <dd>dec-fill-column</dd>
264 <dd>inc-fill-column</dd>
266 <dd>previous-heading</dd>
268 <dd>next-heading</dd>
272 <dd>load-current-url</dd>
276 <dd>load-current-url</dd>
278 <dd>other-window</dd>
282 <dd>tab-close-other</dd>
288 <dd>tab-previous</dd>
294 <dd>previous-page</dd>
297 <dt><f7> a</dt>
298 <dd>bookmark-page</dd>
299 <dt><f7> <f7></dt>
300 <dd>list-bookmarks</dd>
302 <dd>suspend-telescope</dd>
307 <h2 class="Ss" id="vi_1_-like_keys"><a class="permalink" href="#vi_1_-like_keys"><a class="Xr">vi(1)</a>-like
309 <div class="Bd-indent">
310 <dl class="Bl-tag Bl-compact">
312 <dd>previous-line</dd>
316 <dd>forward-char</dd>
318 <dd>backward-char</dd>
320 <dd>backward-paragraph</dd>
322 <dd>forward-paragraph</dd>
324 <dd>move-beginning-of-line</dd>
326 <dd>move-end-of-line</dd>
328 <dd>scroll-line-up</dd>
330 <dd>scroll-line-down</dd>
332 <dd>beginning-of-buffer</dd>
334 <dd>end-of-buffer</dd>
342 <dd>tab-previous</dd>
348 <dd>previous-page</dd>
352 <dd>kill-telescope</dd>
354 <dd>clear-minibuf</dd>
356 <dd>execute-extended-command</dd>
361 <h2 class="Ss" id="CUA-like_keys"><a class="permalink" href="#CUA-like_keys">CUA-like
363 <div class="Bd-indent">
364 <dl class="Bl-tag Bl-compact">
366 <dd>previous-line</dd>
367 <dt><down></dt>
369 <dt><right></dt>
370 <dd>forward-char</dd>
371 <dt><left></dt>
372 <dd>backward-char</dd>
373 <dt><home></dt>
374 <dd>move-beginning-of-line</dd>
376 <dd>move-end-of-line</dd>
377 <dt><prior></dt>
379 <dt><next></dt>
385 <dt>M-<prior></dt>
386 <dd>tab-previous</dd>
387 <dt>M-<next></dt>
389 <dt>M-<left></dt>
390 <dd>previous-page</dd>
391 <dt>M-<right></dt>
401 <h2 class="Ss" id="Neither_Emacs_nor_vi_specific"><a class="permalink" href="#Neither_Emacs_nor_vi_specific">Neither
402 Emacs nor vi specific</a></h2>
403 <div class="Bd-indent">
404 <dl class="Bl-tag Bl-compact">
410 <dd>push-button-new-tab</dd>
412 <dd>previous-button</dd>
414 <dd>previous-button</dd>
420 <dd>tab-previous</dd>
435 <h2 class="Ss" id="Minibuffer-specific_keys"><a class="permalink" href="#Minibuffer-specific_keys">Minibuffer-specific
437 <div class="Bd-indent">
438 <dl class="Bl-tag Bl-compact">
440 <dd>mini-complete-and-exit</dd>
446 <dd>mini-delete-char</dd>
448 <dd>mini-delete-backward-char</dd>
450 <dd>mini-delete-backward-char</dd>
452 <dd>mini-delete-backward-char</dd>
454 <dd>backward-char</dd>
456 <dd>forward-char</dd>
457 <dt><left></dt>
458 <dd>backward-char</dd>
459 <dt><right></dt>
460 <dd>forward-char</dd>
462 <dd>move-end-of-line</dd>
464 <dd>move-beginning-of-line</dd>
466 <dd>move-end-of-line</dd>
467 <dt><home></dt>
468 <dd>move-beginning-of-line</dd>
470 <dd>mini-kill-line</dd>
472 <dd>mini-previous-history-element</dd>
474 <dd>mini-next-history-element</dd>
476 <dd>previous-completion</dd>
478 <dd>next-completion</dd>
480 <dd>previous-completion</dd>
481 <dt><down></dt>
482 <dd>next-completion</dd>
484 <dd>insert-current-candidate</dd>
486 <dd>mini-goto-beginning</dd>
488 <dd>mini-goto-end</dd>
494 <h1 class="Sh" id="INTERACTIVE_COMMANDS"><a class="permalink" href="#INTERACTIVE_COMMANDS">INTERACTIVE
496 <p class="Pp">Follows the documentation for the interactive commands. These
497 commands can be bound to a key or executed with
498 <code class="Ic">execute-extended-command</code>.</p>
500 <h2 class="Ss" id="Movement_commands"><a class="permalink" href="#Movement_commands">Movement
502 <dl class="Bl-tag Bl-compact">
503 <dt id="backward-char"><a class="permalink" href="#backward-char"><code class="Ic">backward-char</code></a></dt>
504 <dd>Move point one character backward.</dd>
505 <dt id="backward-paragraph"><a class="permalink" href="#backward-paragraph"><code class="Ic">backward-paragraph</code></a></dt>
506 <dd>Move point one paragraph backward.</dd>
507 <dt id="beginning-of-buffer"><a class="permalink" href="#beginning-of-buffer"><code class="Ic">beginning-of-buffer</code></a></dt>
508 <dd>Move point to the beginning of the buffer.</dd>
509 <dt id="end-of-buffer"><a class="permalink" href="#end-of-buffer"><code class="Ic">end-of-buffer</code></a></dt>
510 <dd>Move point to the end of the buffer.</dd>
511 <dt id="forward-char"><a class="permalink" href="#forward-char"><code class="Ic">forward-char</code></a></dt>
512 <dd>Move point one character forward.</dd>
513 <dt id="forward-paragraph"><a class="permalink" href="#forward-paragraph"><code class="Ic">forward-paragraph</code></a></dt>
514 <dd>Move point one paragraph forward.</dd>
515 <dt id="insert-current-candidate"><a class="permalink" href="#insert-current-candidate"><code class="Ic">insert-current-candidate</code></a></dt>
516 <dd>Copy the current selection text as minibuffer input.</dd>
517 <dt id="move-beginning-of-line"><a class="permalink" href="#move-beginning-of-line"><code class="Ic">move-beginning-of-line</code></a></dt>
518 <dd>Move point at the beginning of the current (visual) line.</dd>
519 <dt id="move-end-of-line"><a class="permalink" href="#move-end-of-line"><code class="Ic">move-end-of-line</code></a></dt>
520 <dd>Move point at the end of the current (visual) line.</dd>
521 <dt id="next-button"><a class="permalink" href="#next-button"><code class="Ic">next-button</code></a></dt>
522 <dd>Move point to the next link.</dd>
523 <dt id="next-completion"><a class="permalink" href="#next-completion"><code class="Ic">next-completion</code></a></dt>
524 <dd>Select the next completion.</dd>
525 <dt id="next-heading"><a class="permalink" href="#next-heading"><code class="Ic">next-heading</code></a></dt>
526 <dd>Move point to the next heading.</dd>
527 <dt id="next-line"><a class="permalink" href="#next-line"><code class="Ic">next-line</code></a></dt>
528 <dd>Move point to the next (visual) line, in the same column if possible.</dd>
529 <dt id="previous-button"><a class="permalink" href="#previous-button"><code class="Ic">previous-button</code></a></dt>
530 <dd>Move point to the previous link.</dd>
531 <dt id="previous-completion"><a class="permalink" href="#previous-completion"><code class="Ic">previous-completion</code></a></dt>
532 <dd>Select the previous completion.</dd>
533 <dt id="previous-heading"><a class="permalink" href="#previous-heading"><code class="Ic">previous-heading</code></a></dt>
534 <dd>Move point to the previous heading.</dd>
535 <dt id="previous-line"><a class="permalink" href="#previous-line"><code class="Ic">previous-line</code></a></dt>
536 <dd>Move point to the previous (visual) line.</dd>
540 <h2 class="Ss" id="Bookmark-related_commands"><a class="permalink" href="#Bookmark-related_commands">Bookmark-related
542 <dl class="Bl-tag Bl-compact">
543 <dt id="bookmark-page"><a class="permalink" href="#bookmark-page"><code class="Ic">bookmark-page</code></a></dt>
544 <dd>Save a page in the bookmark file. It preloads the minibuffer with the
546 <dt id="list-bookmarks"><a class="permalink" href="#list-bookmarks"><code class="Ic">list-bookmarks</code></a></dt>
547 <dd>Load the bookmarks page.</dd>
551 <h2 class="Ss" id="Tab-related_commands"><a class="permalink" href="#Tab-related_commands">Tab-related
553 <dl class="Bl-tag Bl-compact">
554 <dt id="tab-close"><a class="permalink" href="#tab-close"><code class="Ic">tab-close</code></a></dt>
555 <dd>Close the current tab.</dd>
556 <dt id="tab-close-other"><a class="permalink" href="#tab-close-other"><code class="Ic">tab-close-other</code></a></dt>
557 <dd>Close all tabs but the current one.</dd>
558 <dt id="tab-move"><a class="permalink" href="#tab-move"><code class="Ic">tab-move</code></a></dt>
559 <dd>Move the current tab after the next one, wrapping around if needed.</dd>
560 <dt id="tab-move-to"><a class="permalink" href="#tab-move-to"><code class="Ic">tab-move-to</code></a></dt>
561 <dd>Move the current tab before the previous one, wrapping around if
563 <dt id="tab-new"><a class="permalink" href="#tab-new"><code class="Ic">tab-new</code></a></dt>
564 <dd>Open a new tab.</dd>
565 <dt id="tab-next"><a class="permalink" href="#tab-next"><code class="Ic">tab-next</code></a></dt>
566 <dd>Focus next tab, wrapping around eventually.</dd>
567 <dt id="tab-previous"><a class="permalink" href="#tab-previous"><code class="Ic">tab-previous</code></a></dt>
568 <dd>Focus the previous tab, wrapping around eventually.</dd>
569 <dt id="tab-select"><a class="permalink" href="#tab-select"><code class="Ic">tab-select</code></a></dt>
570 <dd>Switch to a tab using the minibuffer.</dd>
574 <h2 class="Ss" id="Misc_commands"><a class="permalink" href="#Misc_commands">Misc
576 <dl class="Bl-tag Bl-compact">
577 <dt id="clear-minibuf"><a class="permalink" href="#clear-minibuf"><code class="Ic">clear-minibuf</code></a></dt>
578 <dd>Clear the echo area.</dd>
579 <dt id="dec-fill-column"><a class="permalink" href="#dec-fill-column"><code class="Ic">dec-fill-column</code></a></dt>
580 <dd>Decrement fill-column by two.</dd>
581 <dt id="execute-extended-command"><a class="permalink" href="#execute-extended-command"><code class="Ic">execute-extended-command</code></a></dt>
582 <dd>Execute an internal command.</dd>
583 <dt id="kill-telescope"><a class="permalink" href="#kill-telescope"><code class="Ic">kill-telescope</code></a></dt>
584 <dd>Quit <code class="Nm">telescope</code>.</dd>
585 <dt id="inc-fill-column"><a class="permalink" href="#inc-fill-column"><code class="Ic">inc-fill-column</code></a></dt>
586 <dd>Increment fill-column by two.</dd>
587 <dt id="link-select"><a class="permalink" href="#link-select"><code class="Ic">link-select</code></a></dt>
588 <dd>Select and visit a link using the minibuffer.</dd>
589 <dt id="load-current-url"><a class="permalink" href="#load-current-url"><code class="Ic">load-current-url</code></a></dt>
590 <dd>Edit the current URL.</dd>
591 <dt id="load-url"><a class="permalink" href="#load-url"><code class="Ic">load-url</code></a></dt>
592 <dd>Prompt for an URL.</dd>
593 <dt id="next-page"><a class="permalink" href="#next-page"><code class="Ic">next-page</code></a></dt>
594 <dd>Go forward in the page history.</dd>
595 <dt id="olivetti-mode"><a class="permalink" href="#olivetti-mode"><code class="Ic">olivetti-mode</code></a></dt>
596 <dd>Toggle olivetti mode (i.e. horizontal centering of the lines of the
598 <dt id="other-window"><a class="permalink" href="#other-window"><code class="Ic">other-window</code></a></dt>
599 <dd>Select the other window.</dd>
600 <dt id="previous-page"><a class="permalink" href="#previous-page"><code class="Ic">previous-page</code></a></dt>
601 <dd>Go backward in the page history.</dd>
602 <dt id="push-button"><a class="permalink" href="#push-button"><code class="Ic">push-button</code></a></dt>
603 <dd>Follow link at point, or toggle the visibility of the following
604 preformatted block if called when the cursor is on the heading of the
606 <dt id="push-button-new-tab"><a class="permalink" href="#push-button-new-tab"><code class="Ic">push-button-new-tab</code></a></dt>
607 <dd>Follow link at point in a new tab.</dd>
608 <dt id="redraw"><a class="permalink" href="#redraw"><code class="Ic">redraw</code></a></dt>
609 <dd>Redraw the screen, useful if some background program messed up the
611 <dt id="reload-page"><a class="permalink" href="#reload-page"><code class="Ic">reload-page</code></a></dt>
612 <dd>Reload the current page.</dd>
613 <dt id="scroll-down"><a class="permalink" href="#scroll-down"><code class="Ic">scroll-down</code></a></dt>
614 <dd>Scroll down by one visual page.</dd>
615 <dt id="scroll-line-down"><a class="permalink" href="#scroll-line-down"><code class="Ic">scroll-line-down</code></a></dt>
616 <dd>Scroll down by one line.</dd>
617 <dt id="scroll-line-up"><a class="permalink" href="#scroll-line-up"><code class="Ic">scroll-line-up</code></a></dt>
618 <dd>Scroll up by one line.</dd>
619 <dt id="scroll-up"><a class="permalink" href="#scroll-up"><code class="Ic">scroll-up</code></a></dt>
620 <dd>Scroll up by one visual page.</dd>
621 <dt id="suspend-telescope"><a class="permalink" href="#suspend-telescope"><code class="Ic">suspend-telescope</code></a></dt>
622 <dd>Suspend the current <code class="Nm">telescope</code> session.</dd>
623 <dt id="swiper"><a class="permalink" href="#swiper"><code class="Ic">swiper</code></a></dt>
624 <dd>Jump to a line using the minibuffer.</dd>
625 <dt id="toc"><a class="permalink" href="#toc"><code class="Ic">toc</code></a></dt>
626 <dd>Jump to a heading using the minibuffer.</dd>
627 <dt id="toggle-help"><a class="permalink" href="#toggle-help"><code class="Ic">toggle-help</code></a></dt>
628 <dd>Toggle side window with help about available keys and their associated
629 interactive command.</dd>
630 <dt id="toggle-pre-wrap"><a class="permalink" href="#toggle-pre-wrap"><code class="Ic">toggle-pre-wrap</code></a></dt>
631 <dd>Toggle the wrapping of preformatted blocks.</dd>
635 <h2 class="Ss" id="Minibuffer_commands"><a class="permalink" href="#Minibuffer_commands">Minibuffer
637 <dl class="Bl-tag Bl-compact">
638 <dt id="mini-abort"><a class="permalink" href="#mini-abort"><code class="Ic">mini-abort</code></a></dt>
639 <dd>Abort the current minibuffer action.</dd>
640 <dt id="mini-complete-and-exit"><a class="permalink" href="#mini-complete-and-exit"><code class="Ic">mini-complete-and-exit</code></a></dt>
641 <dd>Complete the current minibuffer action.</dd>
642 <dt id="mini-delete-backward-char"><a class="permalink" href="#mini-delete-backward-char"><code class="Ic">mini-delete-backward-char</code></a></dt>
643 <dd>Delete the character before the point.</dd>
644 <dt id="mini-delete-char"><a class="permalink" href="#mini-delete-char"><code class="Ic">mini-delete-char</code></a></dt>
645 <dd>Delete the character after the point.</dd>
646 <dt id="mini-goto-beginning"><a class="permalink" href="#mini-goto-beginning"><code class="Ic">mini-goto-beginning</code></a></dt>
647 <dd>Select the first completion, if any.</dd>
648 <dt id="mini-goto-end"><a class="permalink" href="#mini-goto-end"><code class="Ic">mini-goto-end</code></a></dt>
649 <dd>Select the last completion, if any.</dd>
650 <dt id="mini-kill-line"><a class="permalink" href="#mini-kill-line"><code class="Ic">mini-kill-line</code></a></dt>
651 <dd>Delete from point until the end of the line.</dd>
652 <dt id="mini-next-history-element"><a class="permalink" href="#mini-next-history-element"><code class="Ic">mini-next-history-element</code></a></dt>
653 <dd>Load the previous history element.</dd>
654 <dt id="mini-previous-history-element"><a class="permalink" href="#mini-previous-history-element"><code class="Ic">mini-previous-history-element</code></a></dt>
655 <dd>Load the next history element.</dd>
659 <h2 class="Ss" id="Aliases"><a class="permalink" href="#Aliases">Aliases</a></h2>
660 <p class="Pp">The following aliases are available during
661 <code class="Ic">execute-extended-command</code>:</p>
662 <dl class="Bl-tag Bl-compact">
663 <dt id="tabn"><a class="permalink" href="#tabn"><code class="Ic">tabn</code></a></dt>
664 <dd><a class="permalink" href="#tab-next~2"><code class="Ic" id="tab-next~2">tab-next</code></a></dd>
665 <dt id="tabnew"><a class="permalink" href="#tabnew"><code class="Ic">tabnew</code></a></dt>
666 <dd><a class="permalink" href="#tab-new~2"><code class="Ic" id="tab-new~2">tab-new</code></a></dd>
667 <dt id="tabp"><a class="permalink" href="#tabp"><code class="Ic">tabp</code></a></dt>
668 <dd><a class="permalink" href="#tab-previous~2"><code class="Ic" id="tab-previous~2">tab-previous</code></a></dd>
669 <dt id="q"><a class="permalink" href="#q"><code class="Ic">q</code></a>
670 <span class="No">and</span> <code class="Ic">wq</code></dt>
671 <dd><a class="permalink" href="#kill-telescope~2"><code class="Ic" id="kill-telescope~2">kill-telescope</code></a></dd>
676 <h1 class="Sh" id="CONFIGURATION_FILE"><a class="permalink" href="#CONFIGURATION_FILE">CONFIGURATION
678 <p class="Pp">During the startup, <code class="Nm">telescope</code> reads the
679 configuration file at <span class="Pa">~/.telescope/config</span> or the one
680 given with the <code class="Fl">-c</code> flag.</p>
681 <p class="Pp"><code class="Nm">telescope</code> will also load a file called
682 <span class="Pa">config-TERM</span>, where “TERM” is the name
683 of the terminal type (i.e. the TERM environment variable), if it exists.</p>
684 <p class="Pp">The format of the configuration file is fairly flexible. The
685 current line can be extended over multiple ones using a backslash
686 (‘\’). Comments can be put anywhere in the file using a hash
687 mark (‘#’), and extend to the end of the current line, but
688 backslashes can't be used to extend comments over multiple lines.</p>
689 <p class="Pp">The following constructs are available:</p>
691 <dt id="bind"><a class="permalink" href="#bind"><code class="Ic">bind</code></a>
692 <var class="Ar">map</var> <var class="Ar">key</var>
693 <var class="Ar">cmd</var></dt>
694 <dd>Bind <var class="Ar">key</var> to the function <var class="Ar">cmd</var>
695 in the keymap <var class="Ar">map</var>. Valid values for map are
696 “global-map” (i.e. when the user is viewing a page) and
697 “minibuffer-map” (i.e. when the minibuffer has the focus.)
698 <var class="Ar">key</var> follows the same syntax described in
699 <a class="Sx" href="#DEFAULT_KEY_BINDINGS">DEFAULT KEY BINDINGS</a> and
700 all the possible functions are listed in
701 <a class="Sx" href="#INTERACTIVE_COMMANDS">INTERACTIVE COMMANDS</a>.</dd>
702 <dt id="proxy"><a class="permalink" href="#proxy"><code class="Ic">proxy</code></a>
703 <var class="Ar">proto</var> <code class="Ic">via</code>
704 <var class="Ar">url</var></dt>
705 <dd>Use <var class="Ar">url</var> as proxy for all URLs with protocol
706 <var class="Ar">proto</var>. <var class="Ar">url</var> must be a Gemini
707 URI without path, query and fragment component.</dd>
708 <dt id="set"><a class="permalink" href="#set"><code class="Ic">set</code></a>
709 <var class="Ar">opt</var> <span class="No">=</span>
710 <var class="Ar">val</var></dt>
711 <dd>Set the option <var class="Ar">opt</var> to the value
712 <var class="Ar">val</var>. Valid options are:
714 <dl class="Bl-tag Bl-compact">
716 <dd>(integer) If greater than zero, save the session after the specified
717 amount of seconds after some events happens (new or closed tabs,
718 visited a link ...) Defaults to 20.</dd>
719 <dt>dont-wrap-pre</dt>
720 <dd>(integer) If nonzero, don't wrap preformatted blocks. Defaults to
722 <dt>emojify-link</dt>
723 <dd>(integer) If nonzero, when the text of a link starts with an emoji
724 followed by a space, use that emoji as line prefix. Defaults to
726 <dt>enable-colors</dt>
727 <dd>(integer) If nonzero, enable colours. Defaults to 0 if
728 <code class="Ev">NO_COLORS</code> is set, 1 otherwise.</dd>
730 <dd>(integer) If greater than zero, lines of text will be formatted in a
731 way that don't exceed the given number of columns. Defaults to
733 <dt>hide-pre-blocks</dt>
734 <dd>(integer) If nonzero, hide by default the body of the preformatted
735 blocks. Defaults to zero. <code class="Ic">push-button</code> can be
736 used to toggle the visibility per-block.</dd>
737 <dt>hide-pre-closing-line</dt>
738 <dd>(integer) If nonzero, hide the closing line of preformatted blocks.
740 <dt>hide-pre-context</dt>
741 <dd>(integer) If nonzero, hide the start and end line of the preformatted
742 blocks. If both hide-pre-context and hide-pre-blocks are nonzero,
743 preformatted blocks are irremediably hidden. Defaults to zero.</dd>
745 <dd>(string) URL for the new tab page. Defaults to
746 “about:new”.</dd>
747 <dt>olivetti-mode</dt>
748 <dd>(integer) If nonzero, enable <code class="Ic">olivetti-mode</code>
751 <dd>(integer) If nonzero, set the terminal title to the page title.
753 <dt>tab-bar-show</dt>
754 <dd>(integer) If tab-bar-show is -1 hide the tab bar permanently, if 0
755 show it unconditionally. If it's 1, show the bar only when there is
756 more than one tab. Defaults to 1.</dd>
759 <dt id="style"><a class="permalink" href="#style"><code class="Ic">style</code></a>
760 <var class="Ar">name</var> <var class="Ar">option</var></dt>
761 <dd>Change the styling of the element identified by
762 <var class="Ar">name</var>. Multiple options may be specified within curly
763 braces. Valid style identifiers are:
764 <div class="Bd-indent">
765 <dl class="Bl-tag Bl-compact">
767 <dd>the area outside the lines in the body of the page.</dd>
769 <dd>the completions.</dd>
770 <dt>line.compl.current</dt>
771 <dd>the current completion.</dd>
773 <dd>text in the *Help* buffer.</dd>
778 <dt>line.title1..3</dt>
784 <dt>line.pre.start</dt>
785 <dd>the heading of a preformatted block.</dd>
787 <dd>the content of a preformatted block.</dd>
788 <dt>line.pre.end</dt>
789 <dd>the closing line of a preformatted block.</dd>
791 <dd>the minibuffer.</dd>
793 <dd>the modeline.</dd>
795 <dd>the tabline.</dd>
797 <dd>the non-focused tabs.</dd>
798 <dt>tabline.current</dt>
799 <dd>the focused tab.</dd>
802 <p class="Pp">Valid options are:</p>
804 <dt id="attr"><a class="permalink" href="#attr"><code class="Ic">attr</code></a>
805 <var class="Ar">prefix</var> [<var class="Ar">line</var>
806 [<var class="Ar">trail</var>]]</dt>
807 <dd>Sets the text attributes. If only one value is given,
808 <var class="Ar">line</var> and <var class="Ar">trail</var> default to
809 that; if two values are given then <var class="Ar">trail</var>
810 defaults to <var class="Ar">prefix</var>. Each attribute is a
811 comma-separated list of keywords:
812 <div class="Bd-indent">
813 <dl class="Bl-tag Bl-compact">
814 <dt id="normal"><a class="permalink" href="#normal"><code class="Ic">normal</code></a></dt>
815 <dd>no attributes.</dd>
816 <dt id="standout"><a class="permalink" href="#standout"><code class="Ic">standout</code></a></dt>
817 <dd>best highlighting mode for the terminal.</dd>
818 <dt id="underline"><a class="permalink" href="#underline"><code class="Ic">underline</code></a></dt>
819 <dd>underlines the text.</dd>
820 <dt id="reverse"><a class="permalink" href="#reverse"><code class="Ic">reverse</code></a></dt>
821 <dd>reverses background/foreground colors.</dd>
822 <dt id="blink"><a class="permalink" href="#blink"><code class="Ic">blink</code></a></dt>
823 <dd>makes the text blinking.</dd>
824 <dt id="dim"><a class="permalink" href="#dim"><code class="Ic">dim</code></a></dt>
825 <dd>half bright.</dd>
826 <dt id="bold"><a class="permalink" href="#bold"><code class="Ic">bold</code></a></dt>
827 <dd>extra bright or bold.</dd>
830 <p class="Pp">Only the style identifiers with the “line.”
831 prefix accept up to three attributes. The other will only use the
834 <dt id="bg"><a class="permalink" href="#bg"><code class="Ic">bg</code></a>
835 <var class="Ar">prefix</var> [<var class="Ar">line</var>
836 [<var class="Ar">trail</var>]]</dt>
837 <dd>Sets the background color. Follows the same behaviour as
838 <code class="Ic">attr</code> regarding the optional parameters. The
839 colour is one of black, red, green, yellow, blue, magenta, cyan and
840 white; colour0 to colour255 (or color0 to color255) from the
841 256-colour set; default for the default colour.</dd>
842 <dt id="fg"><a class="permalink" href="#fg"><code class="Ic">fg</code></a>
843 <var class="Ar">prefix</var> [<var class="Ar">line</var>
844 [<var class="Ar">trail</var>]]</dt>
845 <dd>Sets the foreground color. It behaves just like
846 <code class="Ic">bg</code>.</dd>
847 <dt id="prefix"><a class="permalink" href="#prefix"><code class="Ic">prefix</code></a>
848 <var class="Ar">prfx</var> [<var class="Ar">cont</var>]</dt>
849 <dd>Sets the prefix for the current line type to
850 <var class="Ar">prfx</var> and <var class="Ar">cont</var> as the
851 prefix for the continuation lines (i.e. when a long line gets
852 wrapped.) If <var class="Ar">cont</var> is not given its value will be
853 the same of <var class="Ar">prfx</var>.</dd>
859 <h1 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h1>
860 <p class="Pp">When <code class="Nm">telescope</code> is started, it inspects the
861 following environment variables:</p>
863 <dt id="HOME"><a class="permalink" href="#HOME"><code class="Ev">HOME</code></a></dt>
864 <dd>The user's login directory.</dd>
865 <dt id="NO_COLORS"><a class="permalink" href="#NO_COLORS"><code class="Ev">NO_COLORS</code></a></dt>
866 <dd>To decide whether to use colors or not. The content of the variable
868 <dt id="TERM"><a class="permalink" href="#TERM"><code class="Ev">TERM</code></a></dt>
869 <dd>The user's terminal name.</dd>
873 <h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
874 <dl class="Bl-tag Bl-compact">
875 <dt><span class="Pa">~/.telescope/bookmarks.gmi</span></dt>
876 <dd>Bookmarks file.</dd>
877 <dt><span class="Pa">~/.telescope/config</span></dt>
878 <dd>Default configuration file.</dd>
879 <dt><span class="Pa">~/.telescope/known_hosts</span></dt>
880 <dd>Hash of the certificates for all the known hosts. Each line contains three
881 fields: hostname with optional port number, hash of the certificate and a
883 <dt><span class="Pa">~/.telescope/lock</span></dt>
884 <dd>Lock file used to prevent multiple instance of
885 <code class="Nm">telescope</code> from running at the same time.</dd>
886 <dt><span class="Pa">~/.telescope/pages/about_*.gmi</span></dt>
887 <dd>Overrides for built-in about: pages.</dd>
888 <dt><span class="Pa">~/.telescope/session</span></dt>
889 <dd>The list of tabs from the last session. Every line identifies a tab and
890 contains three space-separated fields: the full URL, a comma-separated
891 list of attributes and the cached title. Is written by
892 <code class="Ic">kill-telescope</code> and loaded during startup.</dd>
896 <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
897 <p class="Pp">It's possible to browse “the small web” (i.e. simple
898 websites) by using programs like the duckling-proxy by defining a proxy in
899 <span class="Pa">~/.telescope/config</span>:</p>
900 <div class="Bd Pp Bd-indent Li">
901 <pre>proxy http via "gemini://127.0.0.1:1965"
902 proxy https via "gemini://127.0.0.1:1965"</pre>
904 <p class="Pp">To load <code class="Nm">telescope</code> without any
906 <div class="Bd Pp Bd-indent Li">
907 <pre>telescope -c /dev/null</pre>
911 <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
912 <p class="Pp">The <code class="Nm">telescope</code> program was written by
913 <span class="An">Omar Polo</span>
914 <<a class="Mt" href="mailto:op@omarpolo.com">op@omarpolo.com</a>>.</p>
917 <h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
918 <p class="Pp">There's no UI for out-of-band certificates validation.</p>
923 <td class="foot-date">August 27, 2021</td>
924 <td class="foot-os">OpenBSD 7.0</td>
