1 .\" Copyright (c) 2021, 2022 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: January 05 2022$
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
37 .It Fl C , Fl -colours
38 Show all available colors and exit.
39 This option can also be spelled
42 Specify an alternative configuration file.
44 .Pa ~/.config/telescope/config
47 Display version, usage and exit.
50 Only check the configuration file for validity.
57 from writing files to the disk and to acquire the lock, allowing to
58 run multiple instances at the same time.
60 still loads the session file and the custom about pages.
61 .It Fl v , Fl -version
62 Display version and exit.
66 interface is divided into four areas: the tabline, the body, the
67 modeline and the echoarea/minibuffer.
69 The tabline is always at the top of the screen and displays the tabs
70 separated by a vertical line.
71 When there are more tabs than the size of the window allow to display,
76 are shown at the start/end of the tabline to indicate that there are
77 more tabs in that direction.
79 The body occupies the majority of the visible area.
80 It contains the current page and optionally a side window.
82 The modeline is the second to last row of the screen.
83 It shows some information about the page: a spinner when the page is
84 loading, the trust level, the document type, the scroll offset and the
87 The echoarea is usually the last line of the screen.
88 Messages are often showed there, and link addresses too.
89 The echoarea is also used to obtain input from the user.
94 are invoked, the minibuffer area grows to show possible completions.
98 .Dq Trust, but Verify Pq where appropriate
101 .Pq Dq Trust On First Use .
102 The idea is to define three level of verification for a certificate:
106 the server fingerprint does NOT match the stored value.
109 the server fingerprint matches the store one.
112 the fingerprint matches and has been verified out-of-band.
115 The trust level of the page is indicated in the modeline with the
120 level is enough, but where is appropriate users should be able to
121 verify out-of-band the certificate.
123 At the moment, there is no built-in support for an out-of-band
125 .Sh SUPPORTED PROTOCOLS
126 The following protocols are supported:
127 .Bl -tag -width gemini://
132 See about:about for a list of all these pages.
136 such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
137 viewed inside the application.
138 Types of local files are detected solely based on the file extension.
139 On some systems, such as
141 only files inside special directories
142 .Pq like Pa /tmp No or Pa ~/Downloads
145 Finger URLs are interpreted as follows:
148 the host is determined by the host name portion of the URL
150 if the user portion of the URL is provided, it's interpreted as the
151 user to finger, otherwise the path component will be used
154 .Lk finger://user@hostname
156 .Lk finger://hostname/user
157 are treated as the same URL.
159 Gemini is fully supported, with the exception of client-certificates.
161 Gopher support is limited to items type 0, 1 and 7.
162 All text is assumed to be encoded in UTF-8 (or ASCII).
165 User-entered URLs, given as argument on the command line or entered
168 are intepreted with a simple heuristic:
171 if it's a proper absolute URL then use it as-is,
177 assume it's a file:// URL,
179 otherwise assume it's a Gemini URL.
181 .Sh CONFIGURATION FILE
184 reads the configuration file at
185 .Pa ~/.config/telescope/config
187 .Pa ~/.telescope/config .
189 It's possible to load a custom configuration file using the
194 will also load a file called
198 is the name of the terminal type
199 .Pq i.e. the TERM environment variable ,
202 The format of the configuration file is fairly flexible.
203 The current line can be extended over multiple ones using a
206 Comments can be put anywhere in the file using a hash mark
208 and extend to the end of the current line, but backslashes can't be
209 used to extend comments over multiple lines.
211 The following constructs are available:
213 .It Ic bind Ar map Ar key Ar cmd
220 Valid values for map are
222 .Pq i.e. when the user is viewing a page
225 .Pq i.e. when the minibuffer has the focus.
227 follows the same syntax described in
228 .Sx DEFAULT KEY BINDINGS
229 and all the possible functions are listed in
230 .Sx INTERACTIVE COMMANDS .
231 .It Ic proxy Ar proto Ic via Ar url
234 as proxy for all URLs with
238 must be a Gemini URI without path, query and fragment component.
239 .It Ic set Ar opt No = Ar val
246 .Bl -tag -width twelveletters -compact
249 If greater than zero, save the session after the specified amount of
250 seconds after some events happens
251 .Pq new or closed tabs, visited a link ...
255 If nonzero, don't wrap preformatted blocks.
259 The default download path.
264 If nonzero, when the text of a link starts with an emoji followed by a
265 space, use that emoji as line prefix.
269 If nonzero, enable colours.
275 If greater than zero, lines of text will be formatted in a way that
276 don't exceed the given number of columns.
280 If nonzero, hide by default the body of the preformatted blocks.
283 can be used to toggle the visibility per-block.
284 .It hide-pre-closing-line
286 If nonzero, hide the closing line of preformatted blocks.
290 If nonzero, hide the start and end line of the preformatted blocks.
291 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
292 blocks are irremediably hidden.
296 URL for the new tab page.
301 The maximum number of closed tabs to keep track of, defaults to 10.
302 Must be a positive number; if zero, don't save closed tabs at all.
310 If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
312 If it's 1, show the bar only when there is more than one tab.
316 If nonzero, set the terminal title to the page title.
319 .It Ic style Ar name Ar option
320 Change the styling of the element identified by
322 Multiple options may be specified within curly braces.
323 Valid style identifiers are:
324 .Bl -tag -width line.download.ongoing -compact -offset Ds
326 the area outside the lines in the body of the page.
329 .It line.compl.current
330 the current completion.
332 text in the *Help* buffer.
333 .It line.download.ongoing
335 .It line.download.done
337 .It line.download.info
338 informational text in the *Downloads* buffer.
341 lines draw after the end of a buffer.
353 the heading of a preformatted block.
355 the content of a preformatted block.
357 the closing line of a preformatted block.
367 the non-focused tabs.
374 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
375 Sets the text attributes.
376 If only one value is given,
380 default to that; if two values are given then
384 Each attribute is a comma-separated list of keywords:
385 .Bl -tag -width underline -compact -offset Ds
389 best highlighting mode for the terminal.
393 reverses background/foreground colors.
395 makes the text blinking.
399 extra bright or bold.
402 Only the style identifiers with the
404 prefix accept up to three attributes.
405 The other will only use the first one given.
406 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
407 Sets the background color.
408 Follows the same behaviour as
410 regarding the optional parameters.
411 The colour is one of black, red, green, yellow, blue,
412 magenta, cyan and white; colour0 to colour255
413 .Pq or color0 to color255
414 from the 256-colour set;
415 default for the default colour.
416 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
417 Sets the foreground color.
420 .It Ic prefix Ar prfx Op Ar cont
421 Sets the prefix for the current line type to
425 as the prefix for the continuation lines
426 .Pq i.e. when a long line gets wrapped.
429 is not given its value will be the same of
433 .Sh DEFAULT KEY BINDINGS
434 The default key bindings are very similar to GNU Emacs, but care has
435 been taken to include also bindings familiar for
440 In the following examples, C-x means Control-x, M-x means Meta-x,
441 where the Meta key may be either a special key on the keyboard or the
442 ALT key; otherwise ESC followed by the key X works as well, and C-M-x
443 means to press the key X together with both Control and Meta.
445 Keys are usually a single character, like
449 but some special keys are accepted as well.
451 .Bl -tag -width 16m -offset indent -compact
461 Previous page/Page up
481 Depends on the configuration of the terminal emulator; usually shift
484 .Ss GNU Emacs-like keys
485 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
499 move-beginning-of-line
515 execute-extended-command
559 .Ss Xr vi 1 Ns -like keys
560 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
574 move-beginning-of-line
608 execute-extended-command
611 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
621 move-beginning-of-line
647 .Ss Neither Emacs nor vi specific
648 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
676 .Ss Minibuffer-specific keys
677 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
679 mini-complete-and-exit
687 mini-delete-backward-char
689 mini-delete-backward-char
691 mini-delete-backward-char
703 move-beginning-of-line
707 move-beginning-of-line
711 mini-previous-history-element
713 mini-next-history-element
723 insert-current-candidate
729 .Sh INTERACTIVE COMMANDS
730 Follows the documentation for the interactive commands.
731 These commands can be bound to a key or executed with
732 .Ic execute-extended-command .
733 .Ss Movement commands
734 .Bl -tag -width execute-extended-command -compact
736 Move point one character backward.
737 .It Ic backward-paragraph
738 Move point one paragraph backward.
739 .It Ic beginning-of-buffer
740 Move point to the beginning of the buffer.
742 Move point to the end of the buffer.
744 Move point one character forward.
745 .It Ic forward-paragraph
746 Move point one paragraph forward.
747 .It Ic insert-current-candidate
748 Copy the current selection text as minibuffer input.
749 .It Ic move-beginning-of-line
750 Move point at the beginning of the current (visual) line.
751 .It Ic move-end-of-line
752 Move point at the end of the current (visual) line.
754 Move point to the next link.
755 .It Ic next-completion
756 Select the next completion.
758 Move point to the next heading.
760 Move point to the next (visual) line, in the same column if possible.
761 .It Ic previous-button
762 Move point to the previous link.
763 .It Ic previous-completion
764 Select the previous completion.
765 .It Ic previous-heading
766 Move point to the previous heading.
768 Move point to the previous (visual) line.
770 .Ss Bookmark-related commands
771 .Bl -tag -width execute-extended-command -compact
773 Save a page in the bookmark file.
774 It preloads the minibuffer with the current URL.
775 .It Ic list-bookmarks
776 Load the bookmarks page.
778 .Ss Tab-related commands
779 .Bl -tag -width execute-extended-command -compact
781 Close the current tab.
782 .It Ic tab-close-other
783 Close all tabs but the current one.
785 Move the current tab after the next one, wrapping around if
788 Move the current tab before the previous one, wrapping around if needed.
792 Focus next tab, wrapping around eventually.
794 Focus the previous tab, wrapping around eventually.
796 Switch to a tab using the minibuffer.
797 .It Ic tab-undo-close
798 Re-open the most recently closed tab, if any.
801 .Bl -tag -width execute-extended-command -compact
804 .It Ic dec-fill-column
805 Decrement fill-column by two.
806 .It Ic execute-extended-command
807 Execute an internal command.
808 .It Ic kill-telescope
811 .It Ic inc-fill-column
812 Increment fill-column by two.
814 Select and visit a link using the minibuffer.
815 .It Ic load-current-url
816 Edit the current URL.
820 Go forward in the page history.
822 Toggle olivetti mode (i.e. horizontal centering of the lines of the
825 Select the other window.
827 Go backward in the page history.
829 Follow link at point, or toggle the visibility of the following
830 preformatted block if called when the cursor is on the heading of the block.
831 .It Ic push-button-new-tab
832 Follow link at point in a new tab.
834 Redraw the screen, useful if some background program messed up the
837 Reload the current page.
839 Scroll down by one visual page.
840 .It Ic scroll-line-down
841 Scroll down by one line.
842 .It Ic scroll-line-up
843 Scroll up by one line.
845 Scroll up by one visual page.
846 .It Ic suspend-telescope
851 Jump to a line using the minibuffer.
853 Jump to a heading using the minibuffer.
855 Toggle side window with help about available keys and their associated
857 .It Ic toggle-pre-wrap
858 Toggle the wrapping of preformatted blocks.
860 .Ss Minibuffer commands
861 .Bl -tag -width execute-extended-command -compact
863 Abort the current minibuffer action.
864 .It Ic mini-complete-and-exit
865 Complete the current minibuffer action.
866 .It Ic mini-delete-backward-char
867 Delete the character before the point.
868 .It Ic mini-delete-char
869 Delete the character after the point.
870 .It Ic mini-goto-beginning
871 Select the first completion, if any.
873 Select the last completion, if any.
874 .It Ic mini-kill-line
875 Delete from point until the end of the line.
876 .It Ic mini-next-history-element
877 Load the previous history element.
878 .It Ic mini-previous-history-element
879 Load the next history element.
882 The following aliases are available during
883 .Ic execute-extended-command :
884 .Bl -tag -width 16m -compact
891 .It Ic q No and Ic wq
897 is started, it inspects the following environment variables:
898 .Bl -tag -width NO_COLORS
900 The user's login directory.
902 To decide whether to use colors or not.
903 The content of the variable doesn't matter.
905 The user's terminal name.
906 .It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
907 If defined can alter the default location of the files used.
912 follows the XDG Base Directory Specification.
915 exists, XDG is ignored and all the files are stored inside it.
921 can further alter the location of these files.
923 .Bl -tag -width Ds -compact
924 .It Pa ~/.config/telescope/config
925 Default configuration file.
926 .It Pa ~/.local/share/telescope/pages/about_*.gmi
927 Overrides for built-in about: pages.
928 .It Pa ~/.local/share/telescope/bookmarks.gmi
930 .It Pa ~/.local/share/telescope/known_hosts
931 Hash of the certificates for all the known hosts.
932 Each line contains three fields: hostname with optional port number,
933 hash of the certificate and a numeric flag.
934 .It Pa ~/.cache/telescope/lock
935 Lock file used to prevent multiple instance of
937 from running at the same time.
938 .It Pa ~/.cache/telescope/session
939 The list of tabs from the last session.
942 It's possible to browse
944 .Pq i.e. simple websites
945 by using programs like the duckling-proxy by defining a proxy in
946 .Pa ~/.config/telescope/config :
947 .Bd -literal -offset indent
948 proxy http via "gemini://127.0.0.1:1965"
949 proxy https via "gemini://127.0.0.1:1965"
954 without any configuration
955 .Bd -literal -offset indent
956 telescope -c /dev/null
960 .%B XDG Base Directory Specification
961 .%U https://specifications.freedesktop.org/basedir-spec/latest/
967 program was written by
968 .An Omar Polo Aq Mt op@omarpolo.com .
971 assumes a UTF-8 environment and doesn't try to cope with other encodings.
972 This can cause strange rendering issues if you're lucky, or possibly
973 weird thing happening depending on your locale and terminal emulator.
975 There's no UI for out-of-band certificates validation.
