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 xxxxxxxxxxxxx
37 Show all available colors and exit.
39 Specify an alternative configuration file.
41 .Pa $HOME/.telescope/config
44 Display version and usage.
47 Only check the configuration file for validity.
48 .It Fl v , Fl -version
53 aims to use the "Trust, but Verify (where appropriate)" approach.
54 The idea is to define three level of verification for a certificate:
57 the server fingerprint does NOT match the stored value
59 the server fingerprint matches the store one
61 the fingerprint matches and has been verified out-of-band
66 level is enough, but where is appropriate users should be able to
67 verify out-of-band the certificate.
69 At the moment, there is no built-in support for an out-of-band
72 Known certificates are store in
73 .Pa ~/.telescope/known_hosts
74 with a format similar to the
78 Each line is a record and it's made up by three fields, separated by a
79 single space, according to the following format:
84 the hostname, optionally followed by a colon (":") and a port number.
86 is the hash of the certificate, as outputted by
87 .Xr tls_peer_cert_hash 3 .
90 0 means trusted, 1 verified.
92 .Sh DEFAULT KEY BINDINGS
93 The default key bindings are very similar to GNU Emacs, but care has
94 been taken to include also bindings familiar for
99 In the following examples, C-x means Control-x, M-x means Meta-x,
100 where the Meta key may be either a special key on the keyboard or the
101 ALT key; otherwise ESC followed by the key X works as well, and C-M-x
102 means to press the key X together with both Control and Meta.
104 Keys are usually a single character, like
108 but some special keys are accepted as well.
110 .Bl -tag -width 16m -offset indent -compact
120 Previous page/Page up
140 Depends on the configuration of the terminal emulator.
141 Usually is shift tab though.
143 .Ss GNU Emacs-like keys
144 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
158 move-beginning-of-line
174 execute-extended-command
216 .Ss Xr vi 1 Ns -like keys
217 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
231 move-beginning-of-line
263 execute-extended-command
266 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
276 move-beginning-of-line
300 .Ss Neither Emacs nor vi specific
301 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
325 .Ss Minibuffer-specific keys
326 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
328 mini-complete-and-exit
336 mini-delete-backward-char
338 mini-delete-backward-char
340 mini-delete-backward-char
352 move-beginning-of-line
356 move-beginning-of-line
360 mini-previous-history-element
362 mini-next-history-element
372 insert-current-candidate
374 .Sh INTERACTIVE COMMANDS
375 Follows the documentation for the interactive commands.
376 These commands can be bound to a key or executed with
377 .Ic execute-extended-command .
378 .Ss Movement commands
379 .Bl -tag -width execute-extended-command -compact
381 Move point one character backward.
382 .It Ic backward-paragraph
383 Move point one paragraph backward.
384 .It Ic beginning-of-buffer
385 Move point to the beginning of the buffer.
387 Move point to the end of the buffer.
389 Move point one character forward.
390 .It Ic forward-paragraph
391 Move point one paragraph forward.
392 .It Ic insert-current-candidate
393 Copy the current selection text as minibuffer input.
394 .It Ic move-beginning-of-line
395 Move point at the beginning of the current (visual) line.
396 .It Ic move-end-of-line
397 Move point at the end of the current (visual) line.
399 Move point to the next link.
400 .It Ic next-completion
401 Select the next completion.
403 Move point to the next heading.
405 Move point to the next (visual) line, in the same column if possible.
406 .It Ic previous-button
407 Move point to the previous link.
408 .It Ic previous-completion
409 Select the previous completion.
410 .It Ic previous-heading
411 Move point to the previous heading.
413 Move point to the previous (visual) line.
415 .Ss Bookmark-related commands
416 .Bl -tag -width execute-extended-command -compact
418 Add a link to the bookmark file.
419 It preloads the minibuffer with the current URL.
420 .It Ic list-bookmarks
421 Load the bookmarks page.
423 .Ss Tab-related commands
424 .Bl -tag -width execute-extended-command -compact
426 Close the current tab.
427 .It Ic tab-close-other
428 Close all tabs but the current one.
430 Move the current tab after the next one, wrapping around if
433 Move the current tab before the previous one, wrapping around if needed.
437 Focus next tab, wrapping around eventually.
439 Focus the previous tab, wrapping around eventually.
441 Switch to a tab using the minibuffer.
444 .Bl -tag -width execute-extended-command -compact
446 Clears the echo area.
447 .It Ic dec-fill-column
448 Decrements fill-column by two.
449 .It Ic execute-extended-command
450 Prompts for a command name using the minibuffer.
451 .It Ic kill-telescope
454 .It Ic inc-fill-column
455 Increments fill-column by two.
457 Select and visit a link using the minibuffer.
458 .It Ic load-current-url
459 Prompts for an URL, the minibuffer is preloaded with the current
464 Load the next item in the history list.
466 Toggle olivetti mode (i.e. horizontal centering of the lines of the
469 Load the previous item in the history list.
471 Follow the link on the current line, or toggle the visibility of the
472 following preformatted block if called when the cursor is on the
473 heading of the block.
474 .It Ic push-button-new-tab
475 Follow the link on the current line on a new tab.
477 Redraw the screen, useful if some background program messed up the
480 Reload the current page.
482 Scroll down by one visual page.
483 .It Ic scroll-line-down
484 Scroll down by one line.
485 .It Ic scroll-line-up
486 Scroll up by one line.
488 Scroll up by one visual page.
489 .It Ic suspend-telescope
494 Jump to a line using the minibuffer.
496 Select and jump to a heading of the page using the minibuffer.
498 Toggle side window with help about available keys and their associated
500 .It Ic toggle-pre-wrap
501 Toggle the wrapping of preformatted blocks.
503 .Ss Minibuffer commands
504 .Bl -tag -width execute-extended-command -compact
506 Abort the current minibuffer action.
507 .It Ic mini-complete-and-exit
508 Complete the current minibuffer action.
509 .It Ic mini-delete-backward-char
510 Delete the character before the point.
511 .It Ic mini-delete-char
512 Delete the character after the point.
513 .It Ic mini-kill-line
514 Delete from the point until the end of the line.
515 .It Ic mini-next-history-element
516 Load the previous history element.
517 .It Ic mini-previous-history-element
518 Load the next history element.
521 The following aliases are available during
522 .Ic execute-extended-command :
523 .Bl -tag -width 16m -compact
530 .It Ic q No and Ic wq
533 .Sh CONFIGURATION FILE
536 reads the configuration file at
537 .Pa ~/.telescope/config
538 or the one given with the
543 will also load a file called
547 is the name of the terminal type
548 .Pq i.e. the TERM variable ,
551 The format of the configuration file is fairly flexible.
552 The current line can be extended over multiple ones using a
555 Comments can be put anywhere in the file using a hash mark
557 and extend to the end of the current line, but backslashes can't be
558 used to extend comments over multiple lines.
560 The following constructs are available:
562 .It Ic bind Ar map Ar key Ar cmd
569 Valid values for map are
571 .Pq i.e. when the user is viewing a page
574 .Pq i.e. when the minibuffer has the focus.
576 follows the same syntax described in
577 .Sx DEFAULT KEY BINDINGS
578 and all the possible functions are listed in
579 .Sx INTERACTIVE COMMANDS .
580 .It Ic proxy Ar proto Ic via Ar url
583 as proxy for all URLs with
587 must be a Gemini URI without path, query and fragment component.
588 .It Ic set Ar opt No = Ar val
595 .Bl -tag -width twelveletters -compact
598 If nonzero, don't wrap preformatted blocks.
601 If not zero, when the text of a link starts with an emoji followed by
602 a space, use that emoji as line prefix.
606 If not zero, enable colours.
609 is not set, 0 otherwise.
612 If greater than zero, lines of text will be formatted in a way that
613 don't exceed the given number of columns.
617 If nonzero, hide by default the body of the preformatted blocks.
620 can be used to toggle the visibility per-block.
621 .It hide-pre-closing-line
623 If nonzero, hide the closing line of preformatted blocks.
626 If nonzero, hide the start and end line of the preformatted blocks.
627 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
628 blocks are irremediably hidden.
632 URL for the new tab page.
642 .It Ic style Ar name Ar option
643 Change the styling of the element identified by
645 Multiple options may be specified within curly braces.
646 Valid style identifiers are:
647 .Bl -tag -width 16m -compact -offset Ds
649 for the area outside the lines in the body of the page.
651 for the completion in the minibuffer
652 .It line.compl.current
653 for the current completion
665 for the heading of a preformatted block.
667 for the content of a preformatted block.
669 for the closing line of a preformatted block.
672 .Dq i.e. the last line of the window
675 .Dq i.e. the info line right above the minibuffer
679 for the non-focused tabs.
686 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
687 Sets the text attributes.
688 If only one value is given,
692 default to that; if two values are given then
696 Each attribute is a comma-separated list of keywords:
697 .Bl -tag -width underline -compact -offset Ds
701 best highlighting mode for the terminal.
705 reverses background/foreground colors.
707 makes the text blinking.
711 extra bright or bold.
714 Only the styles under the
716 prefix accept up to three attributes.
717 The other will only use the first one given.
718 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
719 Sets the background color.
720 Follows the same behaviour as
722 regarding the optional parameters.
723 The colour is one of black, red, green, yellow, blue,
724 magenta, cyan and white; colour0 to colour255
725 .Pq or color0 to color255
726 from the 256-colour set;
727 default for the default colour.
728 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
729 Sets the foreground color.
732 .It Ic prefix Ar prfx Op Ar cont
733 Sets the prefix for the current line type to
737 as the prefix for the continuation lines
738 .Pq i.e. when a long line gets wrapped.
741 is not given its value will be the same of
746 .Bl -tag -width Ds -compact
747 .It Pa ~/.telescope/bookmarks.gmi
749 .It Pa ~/.telescope/config
750 Default configuration file.
751 .It Pa ~/.telescope/known_hosts
752 Contains a list of host keys for all the hosts the user has visited.
753 See the TOFU section for more info.
754 .It Pa ~/.telescope/lock
755 Lock file used to prevent multiple instance of
757 from running at the same time.
758 .It Pa ~/.telescope/session
759 Contains the list of opened tabs in the last session, one per line.
762 and loaded on startup.
765 The following is my config file:
766 .Bd -literal -offset indent
767 # enable colors regardless of $NO_COLOR
768 set enable-colors = 1
783 It's possible to browse
785 .Pq i.e. simple websites
786 by using programs like the duckling-proxy by defining a proxy in
787 .Pa ~/.telescope/config :
788 .Bd -literal -offset indent
789 proxy http via "gemini://localhost:1965"
790 proxy https via "gemini://localhost:1965"
795 without any configuration use
796 .Bd -literal -offset indent
797 telescope -c /dev/null
803 program was written by
804 .An Omar Polo Aq Mt op@omarpolo.com .
