1 .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .Dd $Mdocdate: March 28 2021$
29 is an interactive browser for the Gemini protocol.
30 It is able to process text/gemini and more in general every text/* file.
32 also features tabs, bookmarks and out-of-band TOFU verification.
34 The arguments are as follows:
35 .Bl -tag -width tenletters
37 Display version and usage.
40 Only check the configuration file for validity.
42 Specify an alternative configuration file.
44 .Pa $HOME/.telescope/config
49 aims to use the "Trust, but Verify (where appropriate)" approach.
50 The idea is to define three level of verification for a certificate:
53 the server fingerprint does NOT match the stored value
55 the server fingerprint matches the store one
57 the fingerprint matches and has been verified out-of-band
62 level is enough, but where is appropriate users should be able to
63 verify out-of-band the certificate.
65 At the moment, there is no built-in support for an out-of-band
68 Known certificates are store in
69 .Pa ~/.telescope/known_hosts
70 with a format similar to the
74 Each line is a record and it's made up by three fields, separated by a
75 single space, according to the following format:
80 the hostname, optionally followed by a colon (":") and a port number.
82 is the hash of the certificate, as outputted by
83 .Xr tls_peer_cert_hash 3 .
86 0 means trusted, 1 verified.
88 .Sh DEFAULT KEY BINDINGS
89 The default key bindings are very similar to GNU Emacs, but care has
90 been taken to include also bindings familiar for
95 In the following examples, C-x means Control-x, M-x means Meta-x,
96 where the Meta key may be either a special key on the keyboard or the
97 ALT key; otherwise ESC followed by the key X works as well, and C-M-x
98 means to press the key X together with both Control and Meta.
100 Keys are usually a single character, like
104 but some special keys are accepted as well.
106 .Bl -tag -width 16m -offset indent -compact
116 Previous page/Page up
136 Depends on the configuration of the terminal emulator.
137 Usually is shift tab though.
139 .Ss GNU Emacs-like keys
140 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
154 move-beginning-of-line
170 execute-extended-command
208 .Ss Xr vi 1 Ns -like keys
209 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
223 move-beginning-of-line
255 execute-extended-command
258 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
284 .Ss Neither Emacs nor vi specific
285 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
299 .Ss Minibuffer-specific keys
300 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
302 mini-complete-and-exit
310 mini-delete-backward-char
312 mini-delete-backward-char
314 mini-delete-backward-char
326 move-beginning-of-line
330 move-beginning-of-line
334 mini-previous-history-element
336 mini-next-history-element
338 mini-previous-history-element
340 mini-next-history-element
342 .Sh INTERACTIVE COMMANDS
343 Follows the documentation for the interactive commands.
344 These commands can be bound to a key or executed with
345 .Ic execute-extended-command .
346 .Ss Movement commands
347 .Bl -tag -width execute-extended-command -compact
349 Move point one character backward.
350 .It Ic backward-paragraph
351 Move point one paragraph backward.
352 .It Ic beginning-of-buffer
353 Move point to the beginning of the buffer.
355 Move point to the end of the buffer.
357 Move point one character forward.
358 .It Ic forward-paragraph
359 Move point one paragraph forward.
360 .It Ic move-beginning-of-line
361 Move point at the beginning of the current (visual) line.
362 .It Ic move-end-of-line
363 Move point at the end of the current (visual) line.
365 Move point to the next link.
367 Move point to the next heading.
369 Move point to the next (visual) line, in the same column if possible.
370 .It Ic previous-button
371 Move point to the previous link.
372 .It Ic previous-heading
373 Move point to the previous heading.
375 Move point to the previous (visual) line.
377 .Ss Bookmark-related commands
378 .Bl -tag -width execute-extended-command -compact
380 Add a link to the bookmark file.
381 It preloads the minibuffer with the current URL.
382 .It Ic list-bookmarks
383 Load the bookmarks page.
385 .Ss Tab-related commands
386 .Bl -tag -width execute-extended-command -compact
388 Close the current tab.
389 .It Ic tab-close-other
390 Close all tabs but the current one.
392 Move the current tab after the next one, wrapping around if
395 Move the current tab before the previous one, wrapping around if needed.
399 Focus next tab, wrapping around eventually.
401 Focus the previous tab, wrapping around eventually.
404 .Bl -tag -width execute-extended-command -compact
406 Clears the echo area.
407 .It Ic dec-fill-column
408 Decrements fill-column by two.
409 .It Ic execute-extended-command
410 Prompts for a command name using the minibuffer.
411 .It Ic kill-telescope
414 .It Ic inc-fill-column
415 Increments fill-column by two.
416 .It Ic load-current-url
417 Prompts for an URL, the minibuffer is preloaded with the current
422 Load the next item in the history list.
424 Toggle olivetti mode (i.e. horizontal centering of the lines of the
427 Load the previous item in the history list.
429 Follow the link on the current line, or toggle the visibility of the
430 following preformatted block if called when the cursor is on the
431 heading of the block.
432 .It Ic push-button-new-tab
433 Follow the link on the current line on a new tab.
435 Redraw the screen, useful if some background program messed up the
438 Scroll down by one visual page.
439 .It Ic scroll-line-down
440 Scroll down by one line.
441 .It Ic scroll-line-up
442 Scroll up by one line.
444 Scroll up by one visual page.
446 Toggle side window with help about available keys and their associated
449 .Ss Minibuffer commands
450 .Bl -tag -width execute-extended-command -compact
452 Abort the current minibuffer action.
453 .It Ic mini-complete-and-exit
454 Complete the current minibuffer action.
455 .It Ic mini-delete-backward-char
456 Delete the character before the point.
457 .It Ic mini-delete-char
458 Delete the character after the point.
459 .It Ic mini-kill-line
460 Delete from the point until the end of the line.
461 .It Ic mini-next-history-element
462 Load the previous history element.
463 .It Ic mini-previous-history-element
464 Load the next history element.
467 The following aliases are available during
468 .Ic execute-extended-command :
469 .Bl -tag -width 16m -compact
476 .It Ic q No and Ic wq
479 .Sh CONFIGURATION FILE
482 reads the configuration file at
483 .Pa ~/.telescope/config
484 or the one given with the
488 The format of the configuration file is fairly flexible.
489 The current line can be extended over multiple ones using a
492 Comments can be put anywhere in the file using a hash mark
494 and extend to the end of the current line, but backslashes can't be
495 used to extend comments over multiple lines.
497 The following constructs are available:
499 .It Ic bind Ar map Ar key Ar cmd
506 Valid values for map are
508 .Pq i.e. when the user is viewing a page
511 .Pq i.e. when the minibuffer has the focus.
513 follows the same syntax described in
514 .Sx DEFAULT KEY BINDINGS
515 and all the possible functions are listed in
516 .Sx INTERACTIVE COMMANDS .
517 .It Ic proxy Ar proto Ic via Ar url
520 as proxy for all URLs with
524 must be a Gemini URI without path, query and fragment component.
525 .It Ic set Ar opt No = Ar val
532 .Bl -tag -width twelveletters -compact
535 If not zero, enable colours.
538 is not set, 0 otherwise.
541 If greater than zero, lines of text will be formatted in a way that
542 don't exceed the given number of columns.
546 If nonzero, hide by default the body of the preformatted blocks.
549 can be used to toggle the visibility per-block.
552 If nonzero, hide the start and end line of the preformatted blocks.
553 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
554 blocks are irremediably hidden.
558 URL for the new tab page.
568 .It Ic style Ar name Ar option
569 Change the styling of the element identified by
571 Multiple options may be specified within curly braces.
572 Valid style identifiers are:
573 .Bl -tag -width 16m -compact -offset Ds
575 for the area outside the lines in the body of the page.
587 for the heading of a preformatted block.
589 for the content of a preformatted block.
591 for the closing line of a preformatted block.
594 .Dq i.e. the last line of the window
597 .Dq i.e. the info line right above the minibuffer
601 for the non-focused tabs.
608 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
609 Sets the text attributes.
610 If only one value is given,
614 default to that; if two values are given then
618 Each attribute is a comma-separated list of keywords:
619 .Bl -tag -width underline -compact -offset Ds
623 best highlighting mode for the terminal.
627 reverses background/foreground colors.
629 makes the text blinking.
633 extra bright or bold.
636 Only the styles under the
638 prefix accept up to three attributes.
639 The other will only use the first one given.
640 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
641 Sets the background color.
642 Follows the same behaviour as
644 regarding the optional parameters.
645 The colour is one of black, red, green, yellow, blue,
646 magenta, cyan and white; colour0 to colour255
647 .Pq or color0 to color255
648 from the 256-colour set;
649 default for the default colour.
650 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
651 Sets the foreground color.
654 .It Ic prefix Ar prfx Op Ar cont
655 Sets the prefix for the current line type to
659 as the prefix for the continuation lines
660 .Pq i.e. when a long line gets wrapped.
663 is not given its value will be the same of
668 .Bl -tag -width Ds -compact
669 .It Pa ~/.telescope/bookmarks.gmi
671 .It Pa ~/.telescope/config
672 Default configuration file.
673 .It Pa ~/.telescope/known_hosts
674 Contains a list of host keys for all the hosts the user has visited.
675 See the TOFU section for more info.
676 .It Pa ~/.telescope/session
677 Contains the list of opened tabs in the last session, one per line.
680 and loaded on startup.
683 The following is my config file:
684 .Bd -literal -offset indent
685 # enable colors regardless of $NO_COLOR
686 set enable-colors = 1
701 It's possible to browse
703 .Pq i.e. simple websites
704 by using programs like the duckling-proxy by defining a proxy in
705 .Pa ~/.telescope/config :
706 .Bd -literal -offset indent
707 proxy http via "gemini://localhost:1965"
708 proxy https via "gemini://localhost:1965"
713 without any configuration use
714 .Bd -literal -offset indent
715 telescope -c /dev/null
721 program was written by
722 .An Omar Polo Aq Mt op@omarpolo.com .
