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: November 29 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
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 and usage.
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
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.
306 If nonzero, set the terminal title to the page title.
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.
315 .It Ic style Ar name Ar option
316 Change the styling of the element identified by
318 Multiple options may be specified within curly braces.
319 Valid style identifiers are:
320 .Bl -tag -width line.download.ongoing -compact -offset Ds
322 the area outside the lines in the body of the page.
325 .It line.compl.current
326 the current completion.
328 text in the *Help* buffer.
329 .It line.download.ongoing
331 .It line.download.done
333 .It line.download.info
334 informational text in the *Downloads* buffer.
346 the heading of a preformatted block.
348 the content of a preformatted block.
350 the closing line of a preformatted block.
360 the non-focused tabs.
367 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
368 Sets the text attributes.
369 If only one value is given,
373 default to that; if two values are given then
377 Each attribute is a comma-separated list of keywords:
378 .Bl -tag -width underline -compact -offset Ds
382 best highlighting mode for the terminal.
386 reverses background/foreground colors.
388 makes the text blinking.
392 extra bright or bold.
395 Only the style identifiers with the
397 prefix accept up to three attributes.
398 The other will only use the first one given.
399 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
400 Sets the background color.
401 Follows the same behaviour as
403 regarding the optional parameters.
404 The colour is one of black, red, green, yellow, blue,
405 magenta, cyan and white; colour0 to colour255
406 .Pq or color0 to color255
407 from the 256-colour set;
408 default for the default colour.
409 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
410 Sets the foreground color.
413 .It Ic prefix Ar prfx Op Ar cont
414 Sets the prefix for the current line type to
418 as the prefix for the continuation lines
419 .Pq i.e. when a long line gets wrapped.
422 is not given its value will be the same of
426 .Sh DEFAULT KEY BINDINGS
427 The default key bindings are very similar to GNU Emacs, but care has
428 been taken to include also bindings familiar for
433 In the following examples, C-x means Control-x, M-x means Meta-x,
434 where the Meta key may be either a special key on the keyboard or the
435 ALT key; otherwise ESC followed by the key X works as well, and C-M-x
436 means to press the key X together with both Control and Meta.
438 Keys are usually a single character, like
442 but some special keys are accepted as well.
444 .Bl -tag -width 16m -offset indent -compact
454 Previous page/Page up
474 Depends on the configuration of the terminal emulator; usually shift
477 .Ss GNU Emacs-like keys
478 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
492 move-beginning-of-line
508 execute-extended-command
552 .Ss Xr vi 1 Ns -like keys
553 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
567 move-beginning-of-line
599 execute-extended-command
602 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
612 move-beginning-of-line
636 .Ss Neither Emacs nor vi specific
637 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
665 .Ss Minibuffer-specific keys
666 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
668 mini-complete-and-exit
676 mini-delete-backward-char
678 mini-delete-backward-char
680 mini-delete-backward-char
692 move-beginning-of-line
696 move-beginning-of-line
700 mini-previous-history-element
702 mini-next-history-element
712 insert-current-candidate
718 .Sh INTERACTIVE COMMANDS
719 Follows the documentation for the interactive commands.
720 These commands can be bound to a key or executed with
721 .Ic execute-extended-command .
722 .Ss Movement commands
723 .Bl -tag -width execute-extended-command -compact
725 Move point one character backward.
726 .It Ic backward-paragraph
727 Move point one paragraph backward.
728 .It Ic beginning-of-buffer
729 Move point to the beginning of the buffer.
731 Move point to the end of the buffer.
733 Move point one character forward.
734 .It Ic forward-paragraph
735 Move point one paragraph forward.
736 .It Ic insert-current-candidate
737 Copy the current selection text as minibuffer input.
738 .It Ic move-beginning-of-line
739 Move point at the beginning of the current (visual) line.
740 .It Ic move-end-of-line
741 Move point at the end of the current (visual) line.
743 Move point to the next link.
744 .It Ic next-completion
745 Select the next completion.
747 Move point to the next heading.
749 Move point to the next (visual) line, in the same column if possible.
750 .It Ic previous-button
751 Move point to the previous link.
752 .It Ic previous-completion
753 Select the previous completion.
754 .It Ic previous-heading
755 Move point to the previous heading.
757 Move point to the previous (visual) line.
759 .Ss Bookmark-related commands
760 .Bl -tag -width execute-extended-command -compact
762 Save a page in the bookmark file.
763 It preloads the minibuffer with the current URL.
764 .It Ic list-bookmarks
765 Load the bookmarks page.
767 .Ss Tab-related commands
768 .Bl -tag -width execute-extended-command -compact
770 Close the current tab.
771 .It Ic tab-close-other
772 Close all tabs but the current one.
774 Move the current tab after the next one, wrapping around if
777 Move the current tab before the previous one, wrapping around if needed.
781 Focus next tab, wrapping around eventually.
783 Focus the previous tab, wrapping around eventually.
785 Switch to a tab using the minibuffer.
788 .Bl -tag -width execute-extended-command -compact
791 .It Ic dec-fill-column
792 Decrement fill-column by two.
793 .It Ic execute-extended-command
794 Execute an internal command.
795 .It Ic kill-telescope
798 .It Ic inc-fill-column
799 Increment fill-column by two.
801 Select and visit a link using the minibuffer.
802 .It Ic load-current-url
803 Edit the current URL.
807 Go forward in the page history.
809 Toggle olivetti mode (i.e. horizontal centering of the lines of the
812 Select the other window.
814 Go backward in the page history.
816 Follow link at point, or toggle the visibility of the following
817 preformatted block if called when the cursor is on the heading of the block.
818 .It Ic push-button-new-tab
819 Follow link at point in a new tab.
821 Redraw the screen, useful if some background program messed up the
824 Reload the current page.
826 Scroll down by one visual page.
827 .It Ic scroll-line-down
828 Scroll down by one line.
829 .It Ic scroll-line-up
830 Scroll up by one line.
832 Scroll up by one visual page.
833 .It Ic suspend-telescope
838 Jump to a line using the minibuffer.
840 Jump to a heading using the minibuffer.
842 Toggle side window with help about available keys and their associated
844 .It Ic toggle-pre-wrap
845 Toggle the wrapping of preformatted blocks.
847 .Ss Minibuffer commands
848 .Bl -tag -width execute-extended-command -compact
850 Abort the current minibuffer action.
851 .It Ic mini-complete-and-exit
852 Complete the current minibuffer action.
853 .It Ic mini-delete-backward-char
854 Delete the character before the point.
855 .It Ic mini-delete-char
856 Delete the character after the point.
857 .It Ic mini-goto-beginning
858 Select the first completion, if any.
860 Select the last completion, if any.
861 .It Ic mini-kill-line
862 Delete from point until the end of the line.
863 .It Ic mini-next-history-element
864 Load the previous history element.
865 .It Ic mini-previous-history-element
866 Load the next history element.
869 The following aliases are available during
870 .Ic execute-extended-command :
871 .Bl -tag -width 16m -compact
878 .It Ic q No and Ic wq
884 is started, it inspects the following environment variables:
885 .Bl -tag -width NO_COLORS
887 The user's login directory.
889 To decide whether to use colors or not.
890 The content of the variable doesn't matter.
892 The user's terminal name.
893 .It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
894 If defined can alter the default location of the files used.
899 follows the XDG Base Directory Specification.
902 exists, XDG is ignored and all the files are stored inside it.
908 can further alter the location of these files.
910 .Bl -tag -width Ds -compact
911 .It Pa ~/.config/telescope/config
912 Default configuration file.
913 .It Pa ~/.local/share/telescope/pages/about_*.gmi
914 Overrides for built-in about: pages.
915 .It Pa ~/.local/share/telescope/bookmarks.gmi
917 .It Pa ~/.local/share/telescope/known_hosts
918 Hash of the certificates for all the known hosts.
919 Each line contains three fields: hostname with optional port number,
920 hash of the certificate and a numeric flag.
921 .It Pa ~/.cache/telescope/lock
922 Lock file used to prevent multiple instance of
924 from running at the same time.
925 .It Pa ~/.cache/telescope/session
926 The list of tabs from the last session.
927 Every line identifies a tab and contains three space-separated fields:
928 the full URL, a comma-separated list of attributes and the cached
932 and loaded during startup.
935 It's possible to browse
937 .Pq i.e. simple websites
938 by using programs like the duckling-proxy by defining a proxy in
939 .Pa ~/.config/telescope/config :
940 .Bd -literal -offset indent
941 proxy http via "gemini://127.0.0.1:1965"
942 proxy https via "gemini://127.0.0.1:1965"
947 without any configuration
948 .Bd -literal -offset indent
949 telescope -c /dev/null
953 .%B XDG Base Directory Specification
954 .%U https://specifications.freedesktop.org/basedir-spec/latest/
960 program was written by
961 .An Omar Polo Aq Mt op@omarpolo.com .
964 assumes a UTF-8 environment and doesn't do anything to cope with other
966 This can cause weird rendering issues if you're lucky, or possibly
967 worst things depending on your locale and terminal emulator.
969 There's no UI for out-of-band certificates validation.
