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
307 .Ss Minibuffer-specific keys
308 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
310 mini-complete-and-exit
318 mini-delete-backward-char
320 mini-delete-backward-char
322 mini-delete-backward-char
334 move-beginning-of-line
338 move-beginning-of-line
342 mini-previous-history-element
344 mini-next-history-element
354 insert-current-candidate
356 .Sh INTERACTIVE COMMANDS
357 Follows the documentation for the interactive commands.
358 These commands can be bound to a key or executed with
359 .Ic execute-extended-command .
360 .Ss Movement commands
361 .Bl -tag -width execute-extended-command -compact
363 Move point one character backward.
364 .It Ic backward-paragraph
365 Move point one paragraph backward.
366 .It Ic beginning-of-buffer
367 Move point to the beginning of the buffer.
369 Move point to the end of the buffer.
371 Move point one character forward.
372 .It Ic forward-paragraph
373 Move point one paragraph forward.
374 .It Ic insert-current-candidate
375 Copy the current selection text as minibuffer input.
376 .It Ic move-beginning-of-line
377 Move point at the beginning of the current (visual) line.
378 .It Ic move-end-of-line
379 Move point at the end of the current (visual) line.
381 Move point to the next link.
382 .It Ic next-completion
383 Select the next completion.
385 Move point to the next heading.
387 Move point to the next (visual) line, in the same column if possible.
388 .It Ic previous-button
389 Move point to the previous link.
390 .It Ic previous-completion
391 Select the previous completion.
392 .It Ic previous-heading
393 Move point to the previous heading.
395 Move point to the previous (visual) line.
397 .Ss Bookmark-related commands
398 .Bl -tag -width execute-extended-command -compact
400 Add a link to the bookmark file.
401 It preloads the minibuffer with the current URL.
402 .It Ic list-bookmarks
403 Load the bookmarks page.
405 .Ss Tab-related commands
406 .Bl -tag -width execute-extended-command -compact
408 Close the current tab.
409 .It Ic tab-close-other
410 Close all tabs but the current one.
412 Move the current tab after the next one, wrapping around if
415 Move the current tab before the previous one, wrapping around if needed.
419 Focus next tab, wrapping around eventually.
421 Focus the previous tab, wrapping around eventually.
423 Switch to a tab using the minibuffer.
426 .Bl -tag -width execute-extended-command -compact
428 Clears the echo area.
429 .It Ic dec-fill-column
430 Decrements fill-column by two.
431 .It Ic execute-extended-command
432 Prompts for a command name using the minibuffer.
433 .It Ic kill-telescope
436 .It Ic inc-fill-column
437 Increments fill-column by two.
438 .It Ic load-current-url
439 Prompts for an URL, the minibuffer is preloaded with the current
444 Load the next item in the history list.
446 Toggle olivetti mode (i.e. horizontal centering of the lines of the
449 Load the previous item in the history list.
451 Follow the link on the current line, or toggle the visibility of the
452 following preformatted block if called when the cursor is on the
453 heading of the block.
454 .It Ic push-button-new-tab
455 Follow the link on the current line on a new tab.
457 Redraw the screen, useful if some background program messed up the
460 Reload the current page.
462 Scroll down by one visual page.
463 .It Ic scroll-line-down
464 Scroll down by one line.
465 .It Ic scroll-line-up
466 Scroll up by one line.
468 Scroll up by one visual page.
470 Toggle side window with help about available keys and their associated
473 .Ss Minibuffer commands
474 .Bl -tag -width execute-extended-command -compact
476 Abort the current minibuffer action.
477 .It Ic mini-complete-and-exit
478 Complete the current minibuffer action.
479 .It Ic mini-delete-backward-char
480 Delete the character before the point.
481 .It Ic mini-delete-char
482 Delete the character after the point.
483 .It Ic mini-kill-line
484 Delete from the point until the end of the line.
485 .It Ic mini-next-history-element
486 Load the previous history element.
487 .It Ic mini-previous-history-element
488 Load the next history element.
491 The following aliases are available during
492 .Ic execute-extended-command :
493 .Bl -tag -width 16m -compact
500 .It Ic q No and Ic wq
503 .Sh CONFIGURATION FILE
506 reads the configuration file at
507 .Pa ~/.telescope/config
508 or the one given with the
512 The format of the configuration file is fairly flexible.
513 The current line can be extended over multiple ones using a
516 Comments can be put anywhere in the file using a hash mark
518 and extend to the end of the current line, but backslashes can't be
519 used to extend comments over multiple lines.
521 The following constructs are available:
523 .It Ic bind Ar map Ar key Ar cmd
530 Valid values for map are
532 .Pq i.e. when the user is viewing a page
535 .Pq i.e. when the minibuffer has the focus.
537 follows the same syntax described in
538 .Sx DEFAULT KEY BINDINGS
539 and all the possible functions are listed in
540 .Sx INTERACTIVE COMMANDS .
541 .It Ic proxy Ar proto Ic via Ar url
544 as proxy for all URLs with
548 must be a Gemini URI without path, query and fragment component.
549 .It Ic set Ar opt No = Ar val
556 .Bl -tag -width twelveletters -compact
559 If not zero, enable colours.
562 is not set, 0 otherwise.
565 If greater than zero, lines of text will be formatted in a way that
566 don't exceed the given number of columns.
570 If nonzero, hide by default the body of the preformatted blocks.
573 can be used to toggle the visibility per-block.
576 If nonzero, hide the start and end line of the preformatted blocks.
577 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
578 blocks are irremediably hidden.
582 URL for the new tab page.
592 .It Ic style Ar name Ar option
593 Change the styling of the element identified by
595 Multiple options may be specified within curly braces.
596 Valid style identifiers are:
597 .Bl -tag -width 16m -compact -offset Ds
599 for the area outside the lines in the body of the page.
611 for the heading of a preformatted block.
613 for the content of a preformatted block.
615 for the closing line of a preformatted block.
618 .Dq i.e. the last line of the window
621 .Dq i.e. the info line right above the minibuffer
625 for the non-focused tabs.
632 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
633 Sets the text attributes.
634 If only one value is given,
638 default to that; if two values are given then
642 Each attribute is a comma-separated list of keywords:
643 .Bl -tag -width underline -compact -offset Ds
647 best highlighting mode for the terminal.
651 reverses background/foreground colors.
653 makes the text blinking.
657 extra bright or bold.
660 Only the styles under the
662 prefix accept up to three attributes.
663 The other will only use the first one given.
664 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
665 Sets the background color.
666 Follows the same behaviour as
668 regarding the optional parameters.
669 The colour is one of black, red, green, yellow, blue,
670 magenta, cyan and white; colour0 to colour255
671 .Pq or color0 to color255
672 from the 256-colour set;
673 default for the default colour.
674 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
675 Sets the foreground color.
678 .It Ic prefix Ar prfx Op Ar cont
679 Sets the prefix for the current line type to
683 as the prefix for the continuation lines
684 .Pq i.e. when a long line gets wrapped.
687 is not given its value will be the same of
692 .Bl -tag -width Ds -compact
693 .It Pa ~/.telescope/bookmarks.gmi
695 .It Pa ~/.telescope/config
696 Default configuration file.
697 .It Pa ~/.telescope/known_hosts
698 Contains a list of host keys for all the hosts the user has visited.
699 See the TOFU section for more info.
700 .It Pa ~/.telescope/session
701 Contains the list of opened tabs in the last session, one per line.
704 and loaded on startup.
707 The following is my config file:
708 .Bd -literal -offset indent
709 # enable colors regardless of $NO_COLOR
710 set enable-colors = 1
725 It's possible to browse
727 .Pq i.e. simple websites
728 by using programs like the duckling-proxy by defining a proxy in
729 .Pa ~/.telescope/config :
730 .Bd -literal -offset indent
731 proxy http via "gemini://localhost:1965"
732 proxy https via "gemini://localhost:1965"
737 without any configuration use
738 .Bd -literal -offset indent
739 telescope -c /dev/null
745 program was written by
746 .An Omar Polo Aq Mt op@omarpolo.com .
