1 bba111bc 2021-03-28 op .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 bba111bc 2021-03-28 op .\" Permission to use, copy, modify, and distribute this software for any
4 bba111bc 2021-03-28 op .\" purpose with or without fee is hereby granted, provided that the above
5 bba111bc 2021-03-28 op .\" copyright notice and this permission notice appear in all copies.
7 bba111bc 2021-03-28 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 bba111bc 2021-03-28 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 bba111bc 2021-03-28 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 bba111bc 2021-03-28 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 bba111bc 2021-03-28 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 bba111bc 2021-03-28 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 bba111bc 2021-03-28 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 d0971653 2021-09-15 op .Dd $Mdocdate: September 15 2021$
15 bba111bc 2021-03-28 op .Dt TELESCOPE 1
19 a19dd818 2021-08-03 op .Nd multi-protocol browser
24 c92e529c 2021-06-15 op .Op Fl c Pa config
27 bba111bc 2021-03-28 op .Sh DESCRIPTION
29 a19dd818 2021-08-03 op is an interactive browser that supports the Finger, Gemini and Gopher
32 a19dd818 2021-08-03 op features tabs, a minibuffer, interactive completions, bookmarks and
33 a19dd818 2021-08-03 op out-of-band TOFU verification.
35 c92e529c 2021-06-15 op The arguments are as follows:
36 dc761924 2021-07-15 op .Bl -tag -width xxxxxxxxxxxxx
37 97870a34 2021-07-15 op .It Fl C , Fl -colors
38 97870a34 2021-07-15 op Show all available colors and exit.
39 c92e529c 2021-06-15 op .It Fl c Pa config
40 c92e529c 2021-06-15 op Specify an alternative configuration file.
42 c92e529c 2021-06-15 op .Pa $HOME/.telescope/config
44 ccc5591f 2021-07-15 op .It Fl h , Fl -help
45 ccc5591f 2021-07-15 op Display version and usage.
47 ccc5591f 2021-07-15 op Configtest mode.
48 ccc5591f 2021-07-15 op Only check the configuration file for validity.
49 d0971653 2021-09-15 op .It Fl S , Fl -safe
51 d0971653 2021-09-15 op .Pq or Dq sandbox
55 d0971653 2021-09-15 op from writing files to the disk.
56 dc761924 2021-07-15 op .It Fl v , Fl -version
57 dc761924 2021-07-15 op Display version.
59 7ee780fa 2021-07-21 op .Sh UI CONCEPTS
61 7ee780fa 2021-07-21 op interface is divided into four areas: the tabline, the body, the
62 7ee780fa 2021-07-21 op modeline and the echoarea/minibuffer.
64 7ee780fa 2021-07-21 op The tabline is always at the top of the screen and displays the tabs
65 7ee780fa 2021-07-21 op separated by a vertical line.
66 7ee780fa 2021-07-21 op When there are more tabs than the size of the window allow to display,
67 7ee780fa 2021-07-21 op the characters
71 7ee780fa 2021-07-21 op are shown at the start/end of the tabline to indicate that there are
72 7ee780fa 2021-07-21 op more tabs in that direction.
74 7ee780fa 2021-07-21 op The body occupies the majority of the visible area.
75 7ee780fa 2021-07-21 op It contains the current page and optionally a side window.
77 7ee780fa 2021-07-21 op The modeline is the second to last row of the screen.
78 7ee780fa 2021-07-21 op It shows some information about the page: a spinner when the page is
79 7ee780fa 2021-07-21 op loading, the trust level, the document type, the scroll offset and the
82 7ee780fa 2021-07-21 op The echoarea is usually the last line of the screen.
83 7ee780fa 2021-07-21 op Messages are often showed there, and link addresses too.
84 7ee780fa 2021-07-21 op The echoarea is also used to obtain input from the user.
85 7ee780fa 2021-07-21 op When commands like
88 7ee780fa 2021-07-21 op .Ic link-select
89 9eb0c887 2021-08-03 op are invoked, the minibuffer area grows to show possible completions.
92 7ee780fa 2021-07-21 op aims to use the
93 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
96 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
97 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
98 bba111bc 2021-03-28 op .Bl -tag -width 12m
101 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
104 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
107 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
110 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
111 7ee780fa 2021-07-21 op indicated character.
113 bba111bc 2021-03-28 op Most of the time the
115 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
116 bba111bc 2021-03-28 op verify out-of-band the certificate.
118 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
119 bba111bc 2021-03-28 op verification though.
120 f1279523 2021-08-13 op .Sh SUPPORTED PROTOCOLS
121 f1279523 2021-08-13 op The following protocols are supported:
122 f1279523 2021-08-13 op .Bl -tag -width gemini://
124 f1279523 2021-08-13 op About pages are
126 f1279523 2021-08-13 op internal page.
127 f1279523 2021-08-13 op See about:about for a list of all these pages.
129 f1279523 2021-08-13 op File types know to
131 f1279523 2021-08-13 op such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
132 f1279523 2021-08-13 op viewed inside the application.
133 f1279523 2021-08-13 op Types of local files are detected solely based on the file extension.
134 f1279523 2021-08-13 op On some systems, such as
136 f1279523 2021-08-13 op only files inside special directories
137 f1279523 2021-08-13 op .Pq like Pa /tmp No or Pa ~/Downloads
138 f1279523 2021-08-13 op are available.
139 f1279523 2021-08-13 op .It finger://
140 f1279523 2021-08-13 op Finger URLs are interpreted as follows:
141 4a52e6fe 2021-08-03 op .Bl -bullet -compact
143 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
145 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
146 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
149 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
151 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
152 f1279523 2021-08-13 op are treated as the same URL.
153 f1279523 2021-08-13 op .It gemini://
154 f1279523 2021-08-13 op Gemini is fully supported, with the exception of client-certificates.
155 f1279523 2021-08-13 op .It gopher://
156 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
157 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
160 eb6e7b8a 2021-08-16 op User-entered URLs, given as argument on the command line or entered
162 eb6e7b8a 2021-08-16 op .Ic load-url ,
163 eb6e7b8a 2021-08-16 op are intepreted with a simple heuristic:
164 eb6e7b8a 2021-08-16 op .Bl -bullet -compact
166 eb6e7b8a 2021-08-16 op if it's a proper absolute URL then use it as-is,
168 eb6e7b8a 2021-08-16 op if it starts with
172 eb6e7b8a 2021-08-16 op assume it's a file:// URL,
174 eb6e7b8a 2021-08-16 op otherwise assume it's a Gemini URL.
176 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
177 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
178 bba111bc 2021-03-28 op been taken to include also bindings familiar for
183 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
184 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
185 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
186 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
188 bba111bc 2021-03-28 op Keys are usually a single character, like
192 bba111bc 2021-03-28 op but some special keys are accepted as well.
194 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
204 bba111bc 2021-03-28 op Previous page/Page up
206 bba111bc 2021-03-28 op Next page/Page down
211 bba111bc 2021-03-28 op .It <f0> thru <f63>
212 bba111bc 2021-03-28 op Function keys
213 bba111bc 2021-03-28 op .It del or backspace
217 bba111bc 2021-03-28 op .It space or spc
219 bba111bc 2021-03-28 op .It enter or ret
224 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
227 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
228 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
230 7dbaef94 2021-04-22 op previous-line
236 7dbaef94 2021-04-22 op backward-char
238 7dbaef94 2021-04-22 op backward-paragraph
240 7dbaef94 2021-04-22 op forward-paragraph
242 7dbaef94 2021-04-22 op move-beginning-of-line
244 7dbaef94 2021-04-22 op move-end-of-line
245 bba111bc 2021-03-28 op .It M-v, M-space
247 bba111bc 2021-03-28 op .It C-v, space
250 7dbaef94 2021-04-22 op beginning-of-buffer
252 7dbaef94 2021-04-22 op end-of-buffer
254 7dbaef94 2021-04-22 op kill-telescope
256 7dbaef94 2021-04-22 op clear-minibuf
258 7dbaef94 2021-04-22 op execute-extended-command
260 61251035 2021-06-26 op dec-fill-column
262 61251035 2021-06-26 op inc-fill-column
264 1c412d48 2021-06-25 op previous-heading
270 f2ab2540 2021-07-14 op load-current-url
274 7dbaef94 2021-04-22 op load-current-url
280 7dbaef94 2021-04-22 op tab-close-other
292 7dbaef94 2021-04-22 op previous-page
296 7dbaef94 2021-04-22 op bookmark-page
297 bba111bc 2021-03-28 op .It <f7> <f7>
298 7dbaef94 2021-04-22 op list-bookmarks
300 12cf7d80 2021-07-15 op suspend-telescope
302 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
303 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
305 7dbaef94 2021-04-22 op previous-line
311 7dbaef94 2021-04-22 op backward-char
313 7dbaef94 2021-04-22 op backward-paragraph
315 7dbaef94 2021-04-22 op forward-paragraph
317 7dbaef94 2021-04-22 op move-beginning-of-line
319 7dbaef94 2021-04-22 op move-end-of-line
321 7dbaef94 2021-04-22 op scroll-line-up
323 7dbaef94 2021-04-22 op scroll-line-down
325 7dbaef94 2021-04-22 op beginning-of-buffer
327 7dbaef94 2021-04-22 op end-of-buffer
341 7dbaef94 2021-04-22 op previous-page
345 7dbaef94 2021-04-22 op kill-telescope
347 7dbaef94 2021-04-22 op clear-minibuf
349 7dbaef94 2021-04-22 op execute-extended-command
351 bba111bc 2021-03-28 op .Ss CUA-like keys
352 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
354 7dbaef94 2021-04-22 op previous-line
360 7dbaef94 2021-04-22 op backward-char
362 12cf7d80 2021-07-15 op move-beginning-of-line
364 12cf7d80 2021-07-15 op move-end-of-line
373 3c3af0fd 2021-07-08 op .It M-<prior>
378 7dbaef94 2021-04-22 op previous-page
379 bba111bc 2021-03-28 op .It M-<right>
386 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
387 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
393 7dbaef94 2021-04-22 op push-button-new-tab
395 7dbaef94 2021-04-22 op previous-button
397 8dc60352 2021-06-15 op previous-button
415 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
416 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
418 7dbaef94 2021-04-22 op mini-complete-and-exit
424 7dbaef94 2021-04-22 op mini-delete-char
426 7dbaef94 2021-04-22 op mini-delete-backward-char
427 bba111bc 2021-03-28 op .It backspace
428 7dbaef94 2021-04-22 op mini-delete-backward-char
430 7dbaef94 2021-04-22 op mini-delete-backward-char
432 7dbaef94 2021-04-22 op backward-char
436 7dbaef94 2021-04-22 op backward-char
440 7dbaef94 2021-04-22 op move-end-of-line
442 7dbaef94 2021-04-22 op move-beginning-of-line
444 7dbaef94 2021-04-22 op move-end-of-line
446 7dbaef94 2021-04-22 op move-beginning-of-line
448 7dbaef94 2021-04-22 op mini-kill-line
450 7dbaef94 2021-04-22 op mini-previous-history-element
452 7dbaef94 2021-04-22 op mini-next-history-element
454 e7b982f4 2021-07-14 op previous-completion
456 dffb2592 2021-07-14 op next-completion
458 dffb2592 2021-07-14 op previous-completion
460 e7b982f4 2021-07-14 op next-completion
462 e7b982f4 2021-07-14 op insert-current-candidate
464 7ee780fa 2021-07-21 op mini-goto-beginning
466 7ee780fa 2021-07-21 op mini-goto-end
468 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
469 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
470 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
471 bba111bc 2021-03-28 op .Ic execute-extended-command .
472 bba111bc 2021-03-28 op .Ss Movement commands
473 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
474 bba111bc 2021-03-28 op .It Ic backward-char
475 bba111bc 2021-03-28 op Move point one character backward.
476 bba111bc 2021-03-28 op .It Ic backward-paragraph
477 bba111bc 2021-03-28 op Move point one paragraph backward.
478 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
479 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
480 bba111bc 2021-03-28 op .It Ic end-of-buffer
481 bba111bc 2021-03-28 op Move point to the end of the buffer.
482 bba111bc 2021-03-28 op .It Ic forward-char
483 bba111bc 2021-03-28 op Move point one character forward.
484 bba111bc 2021-03-28 op .It Ic forward-paragraph
485 bba111bc 2021-03-28 op Move point one paragraph forward.
486 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
487 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
488 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
489 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
490 bba111bc 2021-03-28 op .It Ic move-end-of-line
491 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
492 bba111bc 2021-03-28 op .It Ic next-button
493 bba111bc 2021-03-28 op Move point to the next link.
494 e7b982f4 2021-07-14 op .It Ic next-completion
495 e7b982f4 2021-07-14 op Select the next completion.
496 1c412d48 2021-06-25 op .It Ic next-heading
497 1c412d48 2021-06-25 op Move point to the next heading.
498 bba111bc 2021-03-28 op .It Ic next-line
499 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
500 bba111bc 2021-03-28 op .It Ic previous-button
501 bba111bc 2021-03-28 op Move point to the previous link.
502 e7b982f4 2021-07-14 op .It Ic previous-completion
503 e7b982f4 2021-07-14 op Select the previous completion.
504 1c412d48 2021-06-25 op .It Ic previous-heading
505 1c412d48 2021-06-25 op Move point to the previous heading.
506 bba111bc 2021-03-28 op .It Ic previous-line
507 bba111bc 2021-03-28 op Move point to the previous (visual) line.
509 bba111bc 2021-03-28 op .Ss Bookmark-related commands
510 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
511 bba111bc 2021-03-28 op .It Ic bookmark-page
512 b3be07ea 2021-07-18 op Save a page in the bookmark file.
513 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
514 63875195 2021-04-01 op .It Ic list-bookmarks
515 bba111bc 2021-03-28 op Load the bookmarks page.
517 bba111bc 2021-03-28 op .Ss Tab-related commands
518 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
519 bba111bc 2021-03-28 op .It Ic tab-close
520 bba111bc 2021-03-28 op Close the current tab.
521 bba111bc 2021-03-28 op .It Ic tab-close-other
522 bba111bc 2021-03-28 op Close all tabs but the current one.
523 bba111bc 2021-03-28 op .It Ic tab-move
524 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
526 bba111bc 2021-03-28 op .It Ic tab-move-to
527 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
528 bba111bc 2021-03-28 op .It Ic tab-new
529 bba111bc 2021-03-28 op Open a new tab.
530 bba111bc 2021-03-28 op .It Ic tab-next
531 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
532 bba111bc 2021-03-28 op .It Ic tab-previous
533 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
534 3360ef1b 2021-07-14 op .It Ic tab-select
535 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
537 bba111bc 2021-03-28 op .Ss Misc commands
538 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
539 bba111bc 2021-03-28 op .It Ic clear-minibuf
540 b3be07ea 2021-07-18 op Clear the echo area.
541 61251035 2021-06-26 op .It Ic dec-fill-column
542 b3be07ea 2021-07-18 op Decrement fill-column by two.
543 bba111bc 2021-03-28 op .It Ic execute-extended-command
544 b3be07ea 2021-07-18 op Execute an internal command.
545 bba111bc 2021-03-28 op .It Ic kill-telescope
548 61251035 2021-06-26 op .It Ic inc-fill-column
549 b3be07ea 2021-07-18 op Increment fill-column by two.
550 753c6ac7 2021-07-14 op .It Ic link-select
551 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
552 bba111bc 2021-03-28 op .It Ic load-current-url
553 b3be07ea 2021-07-18 op Edit the current URL.
554 bba111bc 2021-03-28 op .It Ic load-url
555 b3be07ea 2021-07-18 op Prompt for an URL.
556 bba111bc 2021-03-28 op .It Ic next-page
557 b3be07ea 2021-07-18 op Go forward in the page history.
558 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
559 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
561 9a7d62cb 2021-07-21 op .It Ic other-window
562 9a7d62cb 2021-07-21 op Select the other window.
563 bba111bc 2021-03-28 op .It Ic previous-page
564 b3be07ea 2021-07-18 op Go backward in the page history.
565 bba111bc 2021-03-28 op .It Ic push-button
566 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
567 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
568 bba111bc 2021-03-28 op .It Ic push-button-new-tab
569 b3be07ea 2021-07-18 op Follow link at point in a new tab.
570 bba111bc 2021-03-28 op .It Ic redraw
571 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
573 661233ed 2021-07-14 op .It Ic reload-page
574 661233ed 2021-07-14 op Reload the current page.
575 bba111bc 2021-03-28 op .It Ic scroll-down
576 bba111bc 2021-03-28 op Scroll down by one visual page.
577 bba111bc 2021-03-28 op .It Ic scroll-line-down
578 bba111bc 2021-03-28 op Scroll down by one line.
579 bba111bc 2021-03-28 op .It Ic scroll-line-up
580 bba111bc 2021-03-28 op Scroll up by one line.
581 bba111bc 2021-03-28 op .It Ic scroll-up
582 bba111bc 2021-03-28 op Scroll up by one visual page.
583 12cf7d80 2021-07-15 op .It Ic suspend-telescope
584 12cf7d80 2021-07-15 op Suspend the current
587 753c6ac7 2021-07-14 op .It Ic swiper
588 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
590 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
591 7a014cef 2021-04-01 op .It Ic toggle-help
592 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
593 7a014cef 2021-04-01 op interactive command.
594 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
595 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
597 bba111bc 2021-03-28 op .Ss Minibuffer commands
598 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
599 bba111bc 2021-03-28 op .It Ic mini-abort
600 bba111bc 2021-03-28 op Abort the current minibuffer action.
601 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
602 bba111bc 2021-03-28 op Complete the current minibuffer action.
603 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
604 bba111bc 2021-03-28 op Delete the character before the point.
605 bba111bc 2021-03-28 op .It Ic mini-delete-char
606 bba111bc 2021-03-28 op Delete the character after the point.
607 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
608 de190a2b 2021-07-17 op Select the first completion, if any.
609 de190a2b 2021-07-17 op .It Ic mini-goto-end
610 de190a2b 2021-07-17 op Select the last completion, if any.
611 bba111bc 2021-03-28 op .It Ic mini-kill-line
612 b3be07ea 2021-07-18 op Delete from point until the end of the line.
613 bba111bc 2021-03-28 op .It Ic mini-next-history-element
614 bba111bc 2021-03-28 op Load the previous history element.
615 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
616 bba111bc 2021-03-28 op Load the next history element.
619 7d2d15f5 2021-04-30 op The following aliases are available during
620 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
621 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
624 c82b3fd6 2021-05-12 op .It Ic tabnew
627 c82b3fd6 2021-05-12 op .Ic tab-previous
628 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
629 7d2d15f5 2021-04-30 op .Ic kill-telescope
631 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
632 74ca8ef4 2021-06-19 op During the startup,
634 74ca8ef4 2021-06-19 op reads the configuration file at
635 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
636 74ca8ef4 2021-06-19 op or the one given with the
641 21404dd9 2021-07-15 op will also load a file called
642 21404dd9 2021-07-15 op .Pa config-TERM ,
645 21404dd9 2021-07-15 op is the name of the terminal type
646 7ee780fa 2021-07-21 op .Pq i.e. the TERM environment variable ,
647 7ee780fa 2021-07-21 op if it exists.
649 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
650 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
653 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
655 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
656 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
658 74ca8ef4 2021-06-19 op The following constructs are available:
659 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
660 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
663 138421e8 2021-06-25 op to the function
665 138421e8 2021-06-25 op in the keymap
667 138421e8 2021-06-25 op Valid values for map are
668 138421e8 2021-06-25 op .Dq global-map
669 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
671 138421e8 2021-06-25 op .Dq minibuffer-map
672 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
674 138421e8 2021-06-25 op follows the same syntax described in
675 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
676 138421e8 2021-06-25 op and all the possible functions are listed in
677 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
678 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
681 90d8329a 2021-06-25 op as proxy for all URLs with
685 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
686 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
687 74ca8ef4 2021-06-19 op Set the option
691 74ca8ef4 2021-06-19 op Valid options are:
693 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
696 5c6ed3a9 2021-08-14 op If greater than zero, save the session after the specified amount of
697 5c6ed3a9 2021-08-14 op seconds after some events happens
698 5c6ed3a9 2021-08-14 op .Pq new or closed tabs, visited a link ...
699 5c6ed3a9 2021-08-14 op Defaults to 20.
700 88693f61 2021-07-15 op .It dont-wrap-pre
702 88693f61 2021-07-15 op If nonzero, don't wrap preformatted blocks.
703 7ee780fa 2021-07-21 op Defaults to 0.
704 638cbf21 2021-08-29 op .It download-path
706 638cbf21 2021-08-29 op The default download path.
709 59ae0cdc 2021-07-16 op .It emojify-link
711 7ee780fa 2021-07-21 op If nonzero, when the text of a link starts with an emoji followed by a
712 7ee780fa 2021-07-21 op space, use that emoji as line prefix.
713 59ae0cdc 2021-07-16 op Defaults to 1.
714 2c748a1f 2021-06-21 op .It enable-colors
716 7ee780fa 2021-07-21 op If nonzero, enable colours.
717 7ee780fa 2021-07-21 op Defaults to 0 if
718 2c748a1f 2021-06-21 op .Ev NO_COLORS
719 7ee780fa 2021-07-21 op is set, 1 otherwise.
720 74ca8ef4 2021-06-19 op .It fill-column
722 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
723 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
724 7ee780fa 2021-07-21 op Defaults to 80.
725 b1379f34 2021-07-05 op .It hide-pre-blocks
727 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
728 7ee780fa 2021-07-21 op Defaults to zero.
729 b1379f34 2021-07-05 op .Ic push-button
730 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
731 144733a7 2021-07-15 op .It hide-pre-closing-line
733 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
734 7ee780fa 2021-07-21 op Defaults to 0.
735 b1379f34 2021-07-05 op .It hide-pre-context
737 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
738 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
739 b1379f34 2021-07-05 op blocks are irremediably hidden.
740 7ee780fa 2021-07-21 op Defaults to zero.
741 74ca8ef4 2021-06-19 op .It new-tab-url
743 41a9ae40 2021-06-20 op URL for the new tab page.
745 41a9ae40 2021-06-20 op .Dq about:new .
746 74ca8ef4 2021-06-19 op .It olivetti-mode
748 7ee780fa 2021-07-21 op If nonzero, enable
749 74ca8ef4 2021-06-19 op .Ic olivetti-mode
750 7ee780fa 2021-07-21 op Defaults to 1.
751 9886bf97 2021-07-17 op .It set-title
753 7ee780fa 2021-07-21 op If nonzero, set the terminal title to the page title.
754 b3c59b13 2021-08-18 op Defaults to 1.
755 b3c59b13 2021-08-18 op .It tab-bar-show
757 b3c59b13 2021-08-18 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
758 b3c59b13 2021-08-18 op unconditionally.
759 b3c59b13 2021-08-18 op If it's 1, show the bar only when there is more than one tab.
760 9886bf97 2021-07-17 op Defaults to 1.
762 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
763 74ca8ef4 2021-06-19 op Change the styling of the element identified by
765 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
766 74ca8ef4 2021-06-19 op Valid style identifiers are:
767 7ee780fa 2021-07-21 op .Bl -tag -width line.compl.current -compact -offset Ds
769 7ee780fa 2021-07-21 op the area outside the lines in the body of the page.
770 45fe2472 2021-07-14 op .It line.compl
771 7ee780fa 2021-07-21 op the completions.
772 45fe2472 2021-07-14 op .It line.compl.current
773 7ee780fa 2021-07-21 op the current completion.
774 75fd746b 2021-07-21 op .It line.help
775 75fd746b 2021-07-21 op text in the *Help* buffer.
776 74ca8ef4 2021-06-19 op .It line.text
778 74bc52e8 2021-06-25 op .It line.link
780 74ca8ef4 2021-06-19 op .It line.title1..3
782 74ca8ef4 2021-06-19 op .It line.item
784 74ca8ef4 2021-06-19 op .It line.quote
786 74ca8ef4 2021-06-19 op .It line.pre.start
787 7ee780fa 2021-07-21 op the heading of a preformatted block.
789 7ee780fa 2021-07-21 op the content of a preformatted block.
790 74ca8ef4 2021-06-19 op .It line.pre.end
791 7ee780fa 2021-07-21 op the closing line of a preformatted block.
792 eaf1a84b 2021-06-25 op .It minibuffer
793 7ee780fa 2021-07-21 op the minibuffer.
795 7ee780fa 2021-07-21 op the modeline.
798 74bc52e8 2021-06-25 op .It tabline.tab
799 7ee780fa 2021-07-21 op the non-focused tabs.
800 74bc52e8 2021-06-25 op .It tabline.current
801 7ee780fa 2021-07-21 op the focused tab.
804 74ca8ef4 2021-06-19 op Valid options are:
805 ab728b01 2021-06-22 op .Bl -tag -width Ds
806 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
807 ab728b01 2021-06-22 op Sets the text attributes.
808 ab728b01 2021-06-22 op If only one value is given,
812 ab728b01 2021-06-22 op default to that; if two values are given then
816 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
817 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
818 ab728b01 2021-06-22 op .It Ic normal
819 ab728b01 2021-06-22 op no attributes.
820 ab728b01 2021-06-22 op .It Ic standout
821 ab728b01 2021-06-22 op best highlighting mode for the terminal.
822 ab728b01 2021-06-22 op .It Ic underline
823 ab728b01 2021-06-22 op underlines the text.
824 ab728b01 2021-06-22 op .It Ic reverse
825 ab728b01 2021-06-22 op reverses background/foreground colors.
827 ab728b01 2021-06-22 op makes the text blinking.
831 ab728b01 2021-06-22 op extra bright or bold.
834 7ee780fa 2021-07-21 op Only the style identifiers with the
836 74bc52e8 2021-06-25 op prefix accept up to three attributes.
837 74bc52e8 2021-06-25 op The other will only use the first one given.
838 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
839 ab728b01 2021-06-22 op Sets the background color.
840 ab728b01 2021-06-22 op Follows the same behaviour as
842 ab728b01 2021-06-22 op regarding the optional parameters.
843 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
844 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
845 ae844a00 2021-06-25 op .Pq or color0 to color255
846 ae844a00 2021-06-25 op from the 256-colour set;
847 ae844a00 2021-06-25 op default for the default colour.
848 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
849 ab728b01 2021-06-22 op Sets the foreground color.
850 ab728b01 2021-06-22 op It behaves just like
852 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
853 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
857 ab728b01 2021-06-22 op as the prefix for the continuation lines
858 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
861 ab728b01 2021-06-22 op is not given its value will be the same of
865 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
868 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
869 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
871 7ee780fa 2021-07-21 op The user's login directory.
872 7ee780fa 2021-07-21 op .It Ev NO_COLORS
873 7ee780fa 2021-07-21 op To decide whether to use colors or not.
874 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
876 7ee780fa 2021-07-21 op The user's terminal name.
879 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
880 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
881 7ee780fa 2021-07-21 op Bookmarks file.
882 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
883 dca97b00 2021-06-19 op Default configuration file.
884 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
885 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
886 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
887 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
888 d0fd368a 2021-07-15 op .It Pa ~/.telescope/lock
889 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
891 d0fd368a 2021-07-15 op from running at the same time.
892 56e7efb4 2021-07-21 op .It Pa ~/.telescope/pages/about_*.gmi
893 56e7efb4 2021-07-21 op Overrides for built-in about: pages.
894 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
895 7ee780fa 2021-07-21 op The list of tabs from the last session.
896 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
897 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
899 87e3e801 2021-07-17 op Is written by
900 e9b1e094 2021-04-01 op .Ic kill-telescope
901 7ee780fa 2021-07-21 op and loaded during startup.
904 984245ce 2021-06-23 op It's possible to browse
905 984245ce 2021-06-23 op .Dq the small web
906 984245ce 2021-06-23 op .Pq i.e. simple websites
907 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
908 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
909 984245ce 2021-06-23 op .Bd -literal -offset indent
910 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
911 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
916 7ee780fa 2021-07-21 op without any configuration
917 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
918 19f9cf0f 2021-06-24 op telescope -c /dev/null
924 bba111bc 2021-03-28 op program was written by
925 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
927 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.