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
290 .Ss Neither Emacs nor vi specific
291 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
305 .Ss Minibuffer-specific keys
306 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
308 mini-complete-and-exit
316 mini-delete-backward-char
318 mini-delete-backward-char
320 mini-delete-backward-char
332 move-beginning-of-line
336 move-beginning-of-line
340 mini-previous-history-element
342 mini-next-history-element
352 insert-current-candidate
354 .Sh INTERACTIVE COMMANDS
355 Follows the documentation for the interactive commands.
356 These commands can be bound to a key or executed with
357 .Ic execute-extended-command .
358 .Ss Movement commands
359 .Bl -tag -width execute-extended-command -compact
361 Move point one character backward.
362 .It Ic backward-paragraph
363 Move point one paragraph backward.
364 .It Ic beginning-of-buffer
365 Move point to the beginning of the buffer.
367 Move point to the end of the buffer.
369 Move point one character forward.
370 .It Ic forward-paragraph
371 Move point one paragraph forward.
372 .It Ic insert-current-candidate
373 Copy the current selection text as minibuffer input.
374 .It Ic move-beginning-of-line
375 Move point at the beginning of the current (visual) line.
376 .It Ic move-end-of-line
377 Move point at the end of the current (visual) line.
379 Move point to the next link.
380 .It Ic next-completion
381 Select the next completion.
383 Move point to the next heading.
385 Move point to the next (visual) line, in the same column if possible.
386 .It Ic previous-button
387 Move point to the previous link.
388 .It Ic previous-completion
389 Select the previous completion.
390 .It Ic previous-heading
391 Move point to the previous heading.
393 Move point to the previous (visual) line.
395 .Ss Bookmark-related commands
396 .Bl -tag -width execute-extended-command -compact
398 Add a link to the bookmark file.
399 It preloads the minibuffer with the current URL.
400 .It Ic list-bookmarks
401 Load the bookmarks page.
403 .Ss Tab-related commands
404 .Bl -tag -width execute-extended-command -compact
406 Close the current tab.
407 .It Ic tab-close-other
408 Close all tabs but the current one.
410 Move the current tab after the next one, wrapping around if
413 Move the current tab before the previous one, wrapping around if needed.
417 Focus next tab, wrapping around eventually.
419 Focus the previous tab, wrapping around eventually.
422 .Bl -tag -width execute-extended-command -compact
424 Clears the echo area.
425 .It Ic dec-fill-column
426 Decrements fill-column by two.
427 .It Ic execute-extended-command
428 Prompts for a command name using the minibuffer.
429 .It Ic kill-telescope
432 .It Ic inc-fill-column
433 Increments fill-column by two.
434 .It Ic load-current-url
435 Prompts for an URL, the minibuffer is preloaded with the current
440 Load the next item in the history list.
442 Toggle olivetti mode (i.e. horizontal centering of the lines of the
445 Load the previous item in the history list.
447 Follow the link on the current line, or toggle the visibility of the
448 following preformatted block if called when the cursor is on the
449 heading of the block.
450 .It Ic push-button-new-tab
451 Follow the link on the current line on a new tab.
453 Redraw the screen, useful if some background program messed up the
456 Reload the current page.
458 Scroll down by one visual page.
459 .It Ic scroll-line-down
460 Scroll down by one line.
461 .It Ic scroll-line-up
462 Scroll up by one line.
464 Scroll up by one visual page.
466 Toggle side window with help about available keys and their associated
469 .Ss Minibuffer commands
470 .Bl -tag -width execute-extended-command -compact
472 Abort the current minibuffer action.
473 .It Ic mini-complete-and-exit
474 Complete the current minibuffer action.
475 .It Ic mini-delete-backward-char
476 Delete the character before the point.
477 .It Ic mini-delete-char
478 Delete the character after the point.
479 .It Ic mini-kill-line
480 Delete from the point until the end of the line.
481 .It Ic mini-next-history-element
482 Load the previous history element.
483 .It Ic mini-previous-history-element
484 Load the next history element.
487 The following aliases are available during
488 .Ic execute-extended-command :
489 .Bl -tag -width 16m -compact
496 .It Ic q No and Ic wq
499 .Sh CONFIGURATION FILE
502 reads the configuration file at
503 .Pa ~/.telescope/config
504 or the one given with the
508 The format of the configuration file is fairly flexible.
509 The current line can be extended over multiple ones using a
512 Comments can be put anywhere in the file using a hash mark
514 and extend to the end of the current line, but backslashes can't be
515 used to extend comments over multiple lines.
517 The following constructs are available:
519 .It Ic bind Ar map Ar key Ar cmd
526 Valid values for map are
528 .Pq i.e. when the user is viewing a page
531 .Pq i.e. when the minibuffer has the focus.
533 follows the same syntax described in
534 .Sx DEFAULT KEY BINDINGS
535 and all the possible functions are listed in
536 .Sx INTERACTIVE COMMANDS .
537 .It Ic proxy Ar proto Ic via Ar url
540 as proxy for all URLs with
544 must be a Gemini URI without path, query and fragment component.
545 .It Ic set Ar opt No = Ar val
552 .Bl -tag -width twelveletters -compact
555 If not zero, enable colours.
558 is not set, 0 otherwise.
561 If greater than zero, lines of text will be formatted in a way that
562 don't exceed the given number of columns.
566 If nonzero, hide by default the body of the preformatted blocks.
569 can be used to toggle the visibility per-block.
572 If nonzero, hide the start and end line of the preformatted blocks.
573 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
574 blocks are irremediably hidden.
578 URL for the new tab page.
588 .It Ic style Ar name Ar option
589 Change the styling of the element identified by
591 Multiple options may be specified within curly braces.
592 Valid style identifiers are:
593 .Bl -tag -width 16m -compact -offset Ds
595 for the area outside the lines in the body of the page.
607 for the heading of a preformatted block.
609 for the content of a preformatted block.
611 for the closing line of a preformatted block.
614 .Dq i.e. the last line of the window
617 .Dq i.e. the info line right above the minibuffer
621 for the non-focused tabs.
628 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
629 Sets the text attributes.
630 If only one value is given,
634 default to that; if two values are given then
638 Each attribute is a comma-separated list of keywords:
639 .Bl -tag -width underline -compact -offset Ds
643 best highlighting mode for the terminal.
647 reverses background/foreground colors.
649 makes the text blinking.
653 extra bright or bold.
656 Only the styles under the
658 prefix accept up to three attributes.
659 The other will only use the first one given.
660 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
661 Sets the background color.
662 Follows the same behaviour as
664 regarding the optional parameters.
665 The colour is one of black, red, green, yellow, blue,
666 magenta, cyan and white; colour0 to colour255
667 .Pq or color0 to color255
668 from the 256-colour set;
669 default for the default colour.
670 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
671 Sets the foreground color.
674 .It Ic prefix Ar prfx Op Ar cont
675 Sets the prefix for the current line type to
679 as the prefix for the continuation lines
680 .Pq i.e. when a long line gets wrapped.
683 is not given its value will be the same of
688 .Bl -tag -width Ds -compact
689 .It Pa ~/.telescope/bookmarks.gmi
691 .It Pa ~/.telescope/config
692 Default configuration file.
693 .It Pa ~/.telescope/known_hosts
694 Contains a list of host keys for all the hosts the user has visited.
695 See the TOFU section for more info.
696 .It Pa ~/.telescope/session
697 Contains the list of opened tabs in the last session, one per line.
700 and loaded on startup.
703 The following is my config file:
704 .Bd -literal -offset indent
705 # enable colors regardless of $NO_COLOR
706 set enable-colors = 1
721 It's possible to browse
723 .Pq i.e. simple websites
724 by using programs like the duckling-proxy by defining a proxy in
725 .Pa ~/.telescope/config :
726 .Bd -literal -offset indent
727 proxy http via "gemini://localhost:1965"
728 proxy https via "gemini://localhost:1965"
733 without any configuration use
734 .Bd -literal -offset indent
735 telescope -c /dev/null
741 program was written by
742 .An Omar Polo Aq Mt op@omarpolo.com .
