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
210 .Ss Xr vi 1 Ns -like keys
211 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
225 move-beginning-of-line
257 execute-extended-command
260 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
286 .Ss Neither Emacs nor vi specific
287 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
301 .Ss Minibuffer-specific keys
302 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
304 mini-complete-and-exit
312 mini-delete-backward-char
314 mini-delete-backward-char
316 mini-delete-backward-char
328 move-beginning-of-line
332 move-beginning-of-line
336 mini-previous-history-element
338 mini-next-history-element
348 insert-current-candidate
350 .Sh INTERACTIVE COMMANDS
351 Follows the documentation for the interactive commands.
352 These commands can be bound to a key or executed with
353 .Ic execute-extended-command .
354 .Ss Movement commands
355 .Bl -tag -width execute-extended-command -compact
357 Move point one character backward.
358 .It Ic backward-paragraph
359 Move point one paragraph backward.
360 .It Ic beginning-of-buffer
361 Move point to the beginning of the buffer.
363 Move point to the end of the buffer.
365 Move point one character forward.
366 .It Ic forward-paragraph
367 Move point one paragraph forward.
368 .It Ic insert-current-candidate
369 Copy the current selection text as minibuffer input.
370 .It Ic move-beginning-of-line
371 Move point at the beginning of the current (visual) line.
372 .It Ic move-end-of-line
373 Move point at the end of the current (visual) line.
375 Move point to the next link.
376 .It Ic next-completion
377 Select the next completion.
379 Move point to the next heading.
381 Move point to the next (visual) line, in the same column if possible.
382 .It Ic previous-button
383 Move point to the previous link.
384 .It Ic previous-completion
385 Select the previous completion.
386 .It Ic previous-heading
387 Move point to the previous heading.
389 Move point to the previous (visual) line.
391 .Ss Bookmark-related commands
392 .Bl -tag -width execute-extended-command -compact
394 Add a link to the bookmark file.
395 It preloads the minibuffer with the current URL.
396 .It Ic list-bookmarks
397 Load the bookmarks page.
399 .Ss Tab-related commands
400 .Bl -tag -width execute-extended-command -compact
402 Close the current tab.
403 .It Ic tab-close-other
404 Close all tabs but the current one.
406 Move the current tab after the next one, wrapping around if
409 Move the current tab before the previous one, wrapping around if needed.
413 Focus next tab, wrapping around eventually.
415 Focus the previous tab, wrapping around eventually.
418 .Bl -tag -width execute-extended-command -compact
420 Clears the echo area.
421 .It Ic dec-fill-column
422 Decrements fill-column by two.
423 .It Ic execute-extended-command
424 Prompts for a command name using the minibuffer.
425 .It Ic kill-telescope
428 .It Ic inc-fill-column
429 Increments fill-column by two.
430 .It Ic load-current-url
431 Prompts for an URL, the minibuffer is preloaded with the current
436 Load the next item in the history list.
438 Toggle olivetti mode (i.e. horizontal centering of the lines of the
441 Load the previous item in the history list.
443 Follow the link on the current line, or toggle the visibility of the
444 following preformatted block if called when the cursor is on the
445 heading of the block.
446 .It Ic push-button-new-tab
447 Follow the link on the current line on a new tab.
449 Redraw the screen, useful if some background program messed up the
452 Scroll down by one visual page.
453 .It Ic scroll-line-down
454 Scroll down by one line.
455 .It Ic scroll-line-up
456 Scroll up by one line.
458 Scroll up by one visual page.
460 Toggle side window with help about available keys and their associated
463 .Ss Minibuffer commands
464 .Bl -tag -width execute-extended-command -compact
466 Abort the current minibuffer action.
467 .It Ic mini-complete-and-exit
468 Complete the current minibuffer action.
469 .It Ic mini-delete-backward-char
470 Delete the character before the point.
471 .It Ic mini-delete-char
472 Delete the character after the point.
473 .It Ic mini-kill-line
474 Delete from the point until the end of the line.
475 .It Ic mini-next-history-element
476 Load the previous history element.
477 .It Ic mini-previous-history-element
478 Load the next history element.
481 The following aliases are available during
482 .Ic execute-extended-command :
483 .Bl -tag -width 16m -compact
490 .It Ic q No and Ic wq
493 .Sh CONFIGURATION FILE
496 reads the configuration file at
497 .Pa ~/.telescope/config
498 or the one given with the
502 The format of the configuration file is fairly flexible.
503 The current line can be extended over multiple ones using a
506 Comments can be put anywhere in the file using a hash mark
508 and extend to the end of the current line, but backslashes can't be
509 used to extend comments over multiple lines.
511 The following constructs are available:
513 .It Ic bind Ar map Ar key Ar cmd
520 Valid values for map are
522 .Pq i.e. when the user is viewing a page
525 .Pq i.e. when the minibuffer has the focus.
527 follows the same syntax described in
528 .Sx DEFAULT KEY BINDINGS
529 and all the possible functions are listed in
530 .Sx INTERACTIVE COMMANDS .
531 .It Ic proxy Ar proto Ic via Ar url
534 as proxy for all URLs with
538 must be a Gemini URI without path, query and fragment component.
539 .It Ic set Ar opt No = Ar val
546 .Bl -tag -width twelveletters -compact
549 If not zero, enable colours.
552 is not set, 0 otherwise.
555 If greater than zero, lines of text will be formatted in a way that
556 don't exceed the given number of columns.
560 If nonzero, hide by default the body of the preformatted blocks.
563 can be used to toggle the visibility per-block.
566 If nonzero, hide the start and end line of the preformatted blocks.
567 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
568 blocks are irremediably hidden.
572 URL for the new tab page.
582 .It Ic style Ar name Ar option
583 Change the styling of the element identified by
585 Multiple options may be specified within curly braces.
586 Valid style identifiers are:
587 .Bl -tag -width 16m -compact -offset Ds
589 for the area outside the lines in the body of the page.
601 for the heading of a preformatted block.
603 for the content of a preformatted block.
605 for the closing line of a preformatted block.
608 .Dq i.e. the last line of the window
611 .Dq i.e. the info line right above the minibuffer
615 for the non-focused tabs.
622 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
623 Sets the text attributes.
624 If only one value is given,
628 default to that; if two values are given then
632 Each attribute is a comma-separated list of keywords:
633 .Bl -tag -width underline -compact -offset Ds
637 best highlighting mode for the terminal.
641 reverses background/foreground colors.
643 makes the text blinking.
647 extra bright or bold.
650 Only the styles under the
652 prefix accept up to three attributes.
653 The other will only use the first one given.
654 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
655 Sets the background color.
656 Follows the same behaviour as
658 regarding the optional parameters.
659 The colour is one of black, red, green, yellow, blue,
660 magenta, cyan and white; colour0 to colour255
661 .Pq or color0 to color255
662 from the 256-colour set;
663 default for the default colour.
664 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
665 Sets the foreground color.
668 .It Ic prefix Ar prfx Op Ar cont
669 Sets the prefix for the current line type to
673 as the prefix for the continuation lines
674 .Pq i.e. when a long line gets wrapped.
677 is not given its value will be the same of
682 .Bl -tag -width Ds -compact
683 .It Pa ~/.telescope/bookmarks.gmi
685 .It Pa ~/.telescope/config
686 Default configuration file.
687 .It Pa ~/.telescope/known_hosts
688 Contains a list of host keys for all the hosts the user has visited.
689 See the TOFU section for more info.
690 .It Pa ~/.telescope/session
691 Contains the list of opened tabs in the last session, one per line.
694 and loaded on startup.
697 The following is my config file:
698 .Bd -literal -offset indent
699 # enable colors regardless of $NO_COLOR
700 set enable-colors = 1
715 It's possible to browse
717 .Pq i.e. simple websites
718 by using programs like the duckling-proxy by defining a proxy in
719 .Pa ~/.telescope/config :
720 .Bd -literal -offset indent
721 proxy http via "gemini://localhost:1965"
722 proxy https via "gemini://localhost:1965"
727 without any configuration use
728 .Bd -literal -offset indent
729 telescope -c /dev/null
735 program was written by
736 .An Omar Polo Aq Mt op@omarpolo.com .
