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: August 14 2021$
19 .Nd multi-protocol browser
29 is an interactive browser that supports the Finger, Gemini and Gopher
32 features tabs, a minibuffer, interactive completions, bookmarks and
33 out-of-band TOFU verification.
35 The arguments are as follows:
36 .Bl -tag -width xxxxxxxxxxxxx
38 Show all available colors and exit.
40 Specify an alternative configuration file.
42 .Pa $HOME/.telescope/config
45 Display version and usage.
48 Only check the configuration file for validity.
49 .It Fl v , Fl -version
54 interface is divided into four areas: the tabline, the body, the
55 modeline and the echoarea/minibuffer.
57 The tabline is always at the top of the screen and displays the tabs
58 separated by a vertical line.
59 When there are more tabs than the size of the window allow to display,
64 are shown at the start/end of the tabline to indicate that there are
65 more tabs in that direction.
67 The body occupies the majority of the visible area.
68 It contains the current page and optionally a side window.
70 The modeline is the second to last row of the screen.
71 It shows some information about the page: a spinner when the page is
72 loading, the trust level, the document type, the scroll offset and the
75 The echoarea is usually the last line of the screen.
76 Messages are often showed there, and link addresses too.
77 The echoarea is also used to obtain input from the user.
82 are invoked, the minibuffer area grows to show possible completions.
86 .Dq Trust, but Verify Pq where appropriate
89 .Pq Dq Trust On First Use .
90 The idea is to define three level of verification for a certificate:
94 the server fingerprint does NOT match the stored value.
97 the server fingerprint matches the store one.
100 the fingerprint matches and has been verified out-of-band.
103 The trust level of the page is indicated in the modeline with the
108 level is enough, but where is appropriate users should be able to
109 verify out-of-band the certificate.
111 At the moment, there is no built-in support for an out-of-band
113 .Sh SUPPORTED PROTOCOLS
114 The following protocols are supported:
115 .Bl -tag -width gemini://
120 See about:about for a list of all these pages.
124 such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
125 viewed inside the application.
126 Types of local files are detected solely based on the file extension.
127 On some systems, such as
129 only files inside special directories
130 .Pq like Pa /tmp No or Pa ~/Downloads
133 Finger URLs are interpreted as follows:
136 the host is determined by the host name portion of the URL
138 if the user portion of the URL is provided, it's interpreted as the
139 user to finger, otherwise the path component will be used
142 .Lk finger://user@hostname
144 .Lk finger://hostname/user
145 are treated as the same URL.
147 Gemini is fully supported, with the exception of client-certificates.
149 Gopher support is limited to items type 0, 1 and 7.
150 All text is assumed to be encoded in UTF-8 (or ASCII).
153 User-entered URLs, given as argument on the command line or entered
156 are intepreted with a simple heuristic:
159 if it's a proper absolute URL then use it as-is,
165 assume it's a file:// URL,
167 otherwise assume it's a Gemini URL.
169 .Sh DEFAULT KEY BINDINGS
170 The default key bindings are very similar to GNU Emacs, but care has
171 been taken to include also bindings familiar for
176 In the following examples, C-x means Control-x, M-x means Meta-x,
177 where the Meta key may be either a special key on the keyboard or the
178 ALT key; otherwise ESC followed by the key X works as well, and C-M-x
179 means to press the key X together with both Control and Meta.
181 Keys are usually a single character, like
185 but some special keys are accepted as well.
187 .Bl -tag -width 16m -offset indent -compact
197 Previous page/Page up
217 Depends on the configuration of the terminal emulator; usually shift
220 .Ss GNU Emacs-like keys
221 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
235 move-beginning-of-line
251 execute-extended-command
295 .Ss Xr vi 1 Ns -like keys
296 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
310 move-beginning-of-line
342 execute-extended-command
345 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
355 move-beginning-of-line
379 .Ss Neither Emacs nor vi specific
380 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
404 .Ss Minibuffer-specific keys
405 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
407 mini-complete-and-exit
415 mini-delete-backward-char
417 mini-delete-backward-char
419 mini-delete-backward-char
431 move-beginning-of-line
435 move-beginning-of-line
439 mini-previous-history-element
441 mini-next-history-element
451 insert-current-candidate
457 .Sh INTERACTIVE COMMANDS
458 Follows the documentation for the interactive commands.
459 These commands can be bound to a key or executed with
460 .Ic execute-extended-command .
461 .Ss Movement commands
462 .Bl -tag -width execute-extended-command -compact
464 Move point one character backward.
465 .It Ic backward-paragraph
466 Move point one paragraph backward.
467 .It Ic beginning-of-buffer
468 Move point to the beginning of the buffer.
470 Move point to the end of the buffer.
472 Move point one character forward.
473 .It Ic forward-paragraph
474 Move point one paragraph forward.
475 .It Ic insert-current-candidate
476 Copy the current selection text as minibuffer input.
477 .It Ic move-beginning-of-line
478 Move point at the beginning of the current (visual) line.
479 .It Ic move-end-of-line
480 Move point at the end of the current (visual) line.
482 Move point to the next link.
483 .It Ic next-completion
484 Select the next completion.
486 Move point to the next heading.
488 Move point to the next (visual) line, in the same column if possible.
489 .It Ic previous-button
490 Move point to the previous link.
491 .It Ic previous-completion
492 Select the previous completion.
493 .It Ic previous-heading
494 Move point to the previous heading.
496 Move point to the previous (visual) line.
498 .Ss Bookmark-related commands
499 .Bl -tag -width execute-extended-command -compact
501 Save a page in the bookmark file.
502 It preloads the minibuffer with the current URL.
503 .It Ic list-bookmarks
504 Load the bookmarks page.
506 .Ss Tab-related commands
507 .Bl -tag -width execute-extended-command -compact
509 Close the current tab.
510 .It Ic tab-close-other
511 Close all tabs but the current one.
513 Move the current tab after the next one, wrapping around if
516 Move the current tab before the previous one, wrapping around if needed.
520 Focus next tab, wrapping around eventually.
522 Focus the previous tab, wrapping around eventually.
524 Switch to a tab using the minibuffer.
527 .Bl -tag -width execute-extended-command -compact
530 .It Ic dec-fill-column
531 Decrement fill-column by two.
532 .It Ic execute-extended-command
533 Execute an internal command.
534 .It Ic kill-telescope
537 .It Ic inc-fill-column
538 Increment fill-column by two.
540 Select and visit a link using the minibuffer.
541 .It Ic load-current-url
542 Edit the current URL.
546 Go forward in the page history.
548 Toggle olivetti mode (i.e. horizontal centering of the lines of the
551 Select the other window.
553 Go backward in the page history.
555 Follow link at point, or toggle the visibility of the following
556 preformatted block if called when the cursor is on the heading of the block.
557 .It Ic push-button-new-tab
558 Follow link at point in a new tab.
560 Redraw the screen, useful if some background program messed up the
563 Reload the current page.
565 Scroll down by one visual page.
566 .It Ic scroll-line-down
567 Scroll down by one line.
568 .It Ic scroll-line-up
569 Scroll up by one line.
571 Scroll up by one visual page.
572 .It Ic suspend-telescope
577 Jump to a line using the minibuffer.
579 Jump to a heading using the minibuffer.
581 Toggle side window with help about available keys and their associated
583 .It Ic toggle-pre-wrap
584 Toggle the wrapping of preformatted blocks.
586 .Ss Minibuffer commands
587 .Bl -tag -width execute-extended-command -compact
589 Abort the current minibuffer action.
590 .It Ic mini-complete-and-exit
591 Complete the current minibuffer action.
592 .It Ic mini-delete-backward-char
593 Delete the character before the point.
594 .It Ic mini-delete-char
595 Delete the character after the point.
596 .It Ic mini-goto-beginning
597 Select the first completion, if any.
599 Select the last completion, if any.
600 .It Ic mini-kill-line
601 Delete from point until the end of the line.
602 .It Ic mini-next-history-element
603 Load the previous history element.
604 .It Ic mini-previous-history-element
605 Load the next history element.
608 The following aliases are available during
609 .Ic execute-extended-command :
610 .Bl -tag -width 16m -compact
617 .It Ic q No and Ic wq
620 .Sh CONFIGURATION FILE
623 reads the configuration file at
624 .Pa ~/.telescope/config
625 or the one given with the
630 will also load a file called
634 is the name of the terminal type
635 .Pq i.e. the TERM environment variable ,
638 The format of the configuration file is fairly flexible.
639 The current line can be extended over multiple ones using a
642 Comments can be put anywhere in the file using a hash mark
644 and extend to the end of the current line, but backslashes can't be
645 used to extend comments over multiple lines.
647 The following constructs are available:
649 .It Ic bind Ar map Ar key Ar cmd
656 Valid values for map are
658 .Pq i.e. when the user is viewing a page
661 .Pq i.e. when the minibuffer has the focus.
663 follows the same syntax described in
664 .Sx DEFAULT KEY BINDINGS
665 and all the possible functions are listed in
666 .Sx INTERACTIVE COMMANDS .
667 .It Ic proxy Ar proto Ic via Ar url
670 as proxy for all URLs with
674 must be a Gemini URI without path, query and fragment component.
675 .It Ic set Ar opt No = Ar val
682 .Bl -tag -width twelveletters -compact
685 If greater than zero, save the session after the specified amount of
686 seconds after some events happens
687 .Pq new or closed tabs, visited a link ...
691 If nonzero, don't wrap preformatted blocks.
695 If nonzero, when the text of a link starts with an emoji followed by a
696 space, use that emoji as line prefix.
700 If nonzero, enable colours.
706 If greater than zero, lines of text will be formatted in a way that
707 don't exceed the given number of columns.
711 If nonzero, hide by default the body of the preformatted blocks.
714 can be used to toggle the visibility per-block.
715 .It hide-pre-closing-line
717 If nonzero, hide the closing line of preformatted blocks.
721 If nonzero, hide the start and end line of the preformatted blocks.
722 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
723 blocks are irremediably hidden.
727 URL for the new tab page.
737 If nonzero, set the terminal title to the page title.
740 .It Ic style Ar name Ar option
741 Change the styling of the element identified by
743 Multiple options may be specified within curly braces.
744 Valid style identifiers are:
745 .Bl -tag -width line.compl.current -compact -offset Ds
747 the area outside the lines in the body of the page.
750 .It line.compl.current
751 the current completion.
753 text in the *Help* buffer.
765 the heading of a preformatted block.
767 the content of a preformatted block.
769 the closing line of a preformatted block.
777 the non-focused tabs.
784 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
785 Sets the text attributes.
786 If only one value is given,
790 default to that; if two values are given then
794 Each attribute is a comma-separated list of keywords:
795 .Bl -tag -width underline -compact -offset Ds
799 best highlighting mode for the terminal.
803 reverses background/foreground colors.
805 makes the text blinking.
809 extra bright or bold.
812 Only the style identifiers with the
814 prefix accept up to three attributes.
815 The other will only use the first one given.
816 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
817 Sets the background color.
818 Follows the same behaviour as
820 regarding the optional parameters.
821 The colour is one of black, red, green, yellow, blue,
822 magenta, cyan and white; colour0 to colour255
823 .Pq or color0 to color255
824 from the 256-colour set;
825 default for the default colour.
826 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
827 Sets the foreground color.
830 .It Ic prefix Ar prfx Op Ar cont
831 Sets the prefix for the current line type to
835 as the prefix for the continuation lines
836 .Pq i.e. when a long line gets wrapped.
839 is not given its value will be the same of
846 is started, it inspects the following environment variables:
847 .Bl -tag -width NO_COLORS
849 The user's login directory.
851 To decide whether to use colors or not.
852 The content of the variable doesn't matter.
854 The user's terminal name.
857 .Bl -tag -width Ds -compact
858 .It Pa ~/.telescope/bookmarks.gmi
860 .It Pa ~/.telescope/config
861 Default configuration file.
862 .It Pa ~/.telescope/known_hosts
863 Hash of the certificates for all the known hosts.
864 Each line contains three fields: hostname with optional port number,
865 hash of the certificate and a numeric flag.
866 .It Pa ~/.telescope/lock
867 Lock file used to prevent multiple instance of
869 from running at the same time.
870 .It Pa ~/.telescope/pages/about_*.gmi
871 Overrides for built-in about: pages.
872 .It Pa ~/.telescope/session
873 The list of tabs from the last session.
874 Every line identifies a tab and contains three space-separated fields:
875 the full URL, a comma-separated list of attributes and the cached
879 and loaded during startup.
882 It's possible to browse
884 .Pq i.e. simple websites
885 by using programs like the duckling-proxy by defining a proxy in
886 .Pa ~/.telescope/config :
887 .Bd -literal -offset indent
888 proxy http via "gemini://127.0.0.1:1965"
889 proxy https via "gemini://127.0.0.1:1965"
894 without any configuration
895 .Bd -literal -offset indent
896 telescope -c /dev/null
902 program was written by
903 .An Omar Polo Aq Mt op@omarpolo.com .
905 There's no UI for out-of-band certificates validation.
