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
346 insert-current-candidate
348 .Sh INTERACTIVE COMMANDS
349 Follows the documentation for the interactive commands.
350 These commands can be bound to a key or executed with
351 .Ic execute-extended-command .
352 .Ss Movement commands
353 .Bl -tag -width execute-extended-command -compact
355 Move point one character backward.
356 .It Ic backward-paragraph
357 Move point one paragraph backward.
358 .It Ic beginning-of-buffer
359 Move point to the beginning of the buffer.
361 Move point to the end of the buffer.
363 Move point one character forward.
364 .It Ic forward-paragraph
365 Move point one paragraph forward.
366 .It Ic insert-current-candidate
367 Copy the current selection text as minibuffer input.
368 .It Ic move-beginning-of-line
369 Move point at the beginning of the current (visual) line.
370 .It Ic move-end-of-line
371 Move point at the end of the current (visual) line.
373 Move point to the next link.
374 .It Ic next-completion
375 Select the next completion.
377 Move point to the next heading.
379 Move point to the next (visual) line, in the same column if possible.
380 .It Ic previous-button
381 Move point to the previous link.
382 .It Ic previous-completion
383 Select the previous completion.
384 .It Ic previous-heading
385 Move point to the previous heading.
387 Move point to the previous (visual) line.
389 .Ss Bookmark-related commands
390 .Bl -tag -width execute-extended-command -compact
392 Add a link to the bookmark file.
393 It preloads the minibuffer with the current URL.
394 .It Ic list-bookmarks
395 Load the bookmarks page.
397 .Ss Tab-related commands
398 .Bl -tag -width execute-extended-command -compact
400 Close the current tab.
401 .It Ic tab-close-other
402 Close all tabs but the current one.
404 Move the current tab after the next one, wrapping around if
407 Move the current tab before the previous one, wrapping around if needed.
411 Focus next tab, wrapping around eventually.
413 Focus the previous tab, wrapping around eventually.
416 .Bl -tag -width execute-extended-command -compact
418 Clears the echo area.
419 .It Ic dec-fill-column
420 Decrements fill-column by two.
421 .It Ic execute-extended-command
422 Prompts for a command name using the minibuffer.
423 .It Ic kill-telescope
426 .It Ic inc-fill-column
427 Increments fill-column by two.
428 .It Ic load-current-url
429 Prompts for an URL, the minibuffer is preloaded with the current
434 Load the next item in the history list.
436 Toggle olivetti mode (i.e. horizontal centering of the lines of the
439 Load the previous item in the history list.
441 Follow the link on the current line, or toggle the visibility of the
442 following preformatted block if called when the cursor is on the
443 heading of the block.
444 .It Ic push-button-new-tab
445 Follow the link on the current line on a new tab.
447 Redraw the screen, useful if some background program messed up the
450 Scroll down by one visual page.
451 .It Ic scroll-line-down
452 Scroll down by one line.
453 .It Ic scroll-line-up
454 Scroll up by one line.
456 Scroll up by one visual page.
458 Toggle side window with help about available keys and their associated
461 .Ss Minibuffer commands
462 .Bl -tag -width execute-extended-command -compact
464 Abort the current minibuffer action.
465 .It Ic mini-complete-and-exit
466 Complete the current minibuffer action.
467 .It Ic mini-delete-backward-char
468 Delete the character before the point.
469 .It Ic mini-delete-char
470 Delete the character after the point.
471 .It Ic mini-kill-line
472 Delete from the point until the end of the line.
473 .It Ic mini-next-history-element
474 Load the previous history element.
475 .It Ic mini-previous-history-element
476 Load the next history element.
479 The following aliases are available during
480 .Ic execute-extended-command :
481 .Bl -tag -width 16m -compact
488 .It Ic q No and Ic wq
491 .Sh CONFIGURATION FILE
494 reads the configuration file at
495 .Pa ~/.telescope/config
496 or the one given with the
500 The format of the configuration file is fairly flexible.
501 The current line can be extended over multiple ones using a
504 Comments can be put anywhere in the file using a hash mark
506 and extend to the end of the current line, but backslashes can't be
507 used to extend comments over multiple lines.
509 The following constructs are available:
511 .It Ic bind Ar map Ar key Ar cmd
518 Valid values for map are
520 .Pq i.e. when the user is viewing a page
523 .Pq i.e. when the minibuffer has the focus.
525 follows the same syntax described in
526 .Sx DEFAULT KEY BINDINGS
527 and all the possible functions are listed in
528 .Sx INTERACTIVE COMMANDS .
529 .It Ic proxy Ar proto Ic via Ar url
532 as proxy for all URLs with
536 must be a Gemini URI without path, query and fragment component.
537 .It Ic set Ar opt No = Ar val
544 .Bl -tag -width twelveletters -compact
547 If not zero, enable colours.
550 is not set, 0 otherwise.
553 If greater than zero, lines of text will be formatted in a way that
554 don't exceed the given number of columns.
558 If nonzero, hide by default the body of the preformatted blocks.
561 can be used to toggle the visibility per-block.
564 If nonzero, hide the start and end line of the preformatted blocks.
565 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
566 blocks are irremediably hidden.
570 URL for the new tab page.
580 .It Ic style Ar name Ar option
581 Change the styling of the element identified by
583 Multiple options may be specified within curly braces.
584 Valid style identifiers are:
585 .Bl -tag -width 16m -compact -offset Ds
587 for the area outside the lines in the body of the page.
599 for the heading of a preformatted block.
601 for the content of a preformatted block.
603 for the closing line of a preformatted block.
606 .Dq i.e. the last line of the window
609 .Dq i.e. the info line right above the minibuffer
613 for the non-focused tabs.
620 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
621 Sets the text attributes.
622 If only one value is given,
626 default to that; if two values are given then
630 Each attribute is a comma-separated list of keywords:
631 .Bl -tag -width underline -compact -offset Ds
635 best highlighting mode for the terminal.
639 reverses background/foreground colors.
641 makes the text blinking.
645 extra bright or bold.
648 Only the styles under the
650 prefix accept up to three attributes.
651 The other will only use the first one given.
652 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
653 Sets the background color.
654 Follows the same behaviour as
656 regarding the optional parameters.
657 The colour is one of black, red, green, yellow, blue,
658 magenta, cyan and white; colour0 to colour255
659 .Pq or color0 to color255
660 from the 256-colour set;
661 default for the default colour.
662 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
663 Sets the foreground color.
666 .It Ic prefix Ar prfx Op Ar cont
667 Sets the prefix for the current line type to
671 as the prefix for the continuation lines
672 .Pq i.e. when a long line gets wrapped.
675 is not given its value will be the same of
680 .Bl -tag -width Ds -compact
681 .It Pa ~/.telescope/bookmarks.gmi
683 .It Pa ~/.telescope/config
684 Default configuration file.
685 .It Pa ~/.telescope/known_hosts
686 Contains a list of host keys for all the hosts the user has visited.
687 See the TOFU section for more info.
688 .It Pa ~/.telescope/session
689 Contains the list of opened tabs in the last session, one per line.
692 and loaded on startup.
695 The following is my config file:
696 .Bd -literal -offset indent
697 # enable colors regardless of $NO_COLOR
698 set enable-colors = 1
713 It's possible to browse
715 .Pq i.e. simple websites
716 by using programs like the duckling-proxy by defining a proxy in
717 .Pa ~/.telescope/config :
718 .Bd -literal -offset indent
719 proxy http via "gemini://localhost:1965"
720 proxy https via "gemini://localhost:1965"
725 without any configuration use
726 .Bd -literal -offset indent
727 telescope -c /dev/null
733 program was written by
734 .An Omar Polo Aq Mt op@omarpolo.com .
