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
276 .Ss Neither Emacs nor vi specific
277 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
291 .Ss Minibuffer-specific keys
292 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
294 mini-complete-and-exit
302 mini-delete-backward-char
304 mini-delete-backward-char
306 mini-delete-backward-char
318 move-beginning-of-line
322 move-beginning-of-line
326 mini-previous-history-element
328 mini-next-history-element
330 mini-previous-history-element
332 mini-next-history-element
334 .Sh INTERACTIVE COMMANDS
335 Follows the documentation for the interactive commands.
336 These commands can be bound to a key or executed with
337 .Ic execute-extended-command .
338 .Ss Movement commands
339 .Bl -tag -width execute-extended-command -compact
341 Move point one character backward.
342 .It Ic backward-paragraph
343 Move point one paragraph backward.
344 .It Ic beginning-of-buffer
345 Move point to the beginning of the buffer.
347 Move point to the end of the buffer.
349 Move point one character forward.
350 .It Ic forward-paragraph
351 Move point one paragraph forward.
352 .It Ic move-beginning-of-line
353 Move point at the beginning of the current (visual) line.
354 .It Ic move-end-of-line
355 Move point at the end of the current (visual) line.
357 Move point to the next link.
359 Move point to the next heading.
361 Move point to the next (visual) line, in the same column if possible.
362 .It Ic previous-button
363 Move point to the previous link.
364 .It Ic previous-heading
365 Move point to the previous heading.
367 Move point to the previous (visual) line.
369 .Ss Bookmark-related commands
370 .Bl -tag -width execute-extended-command -compact
372 Add a link to the bookmark file.
373 It preloads the minibuffer with the current URL.
374 .It Ic list-bookmarks
375 Load the bookmarks page.
377 .Ss Tab-related commands
378 .Bl -tag -width execute-extended-command -compact
380 Close the current tab.
381 .It Ic tab-close-other
382 Close all tabs but the current one.
384 Move the current tab after the next one, wrapping around if
387 Move the current tab before the previous one, wrapping around if needed.
391 Focus next tab, wrapping around eventually.
393 Focus the previous tab, wrapping around eventually.
396 .Bl -tag -width execute-extended-command -compact
398 Clears the echo area.
399 .It Ic dec-fill-column
400 Decrements fill-column by two.
401 .It Ic execute-extended-command
402 Prompts for a command name using the minibuffer.
403 .It Ic kill-telescope
406 .It Ic inc-fill-column
407 Increments fill-column by two.
408 .It Ic load-current-url
409 Prompts for an URL, the minibuffer is preloaded with the current
414 Load the next item in the history list.
416 Toggle olivetti mode (i.e. horizontal centering of the lines of the
419 Load the previous item in the history list.
421 Follow the link on the current line, or toggle the visibility of the
422 following preformatted block if called when the cursor is on the
423 heading of the block.
424 .It Ic push-button-new-tab
425 Follow the link on the current line on a new tab.
427 Redraw the screen, useful if some background program messed up the
430 Scroll down by one visual page.
431 .It Ic scroll-line-down
432 Scroll down by one line.
433 .It Ic scroll-line-up
434 Scroll up by one line.
436 Scroll up by one visual page.
438 Toggle side window with help about available keys and their associated
441 .Ss Minibuffer commands
442 .Bl -tag -width execute-extended-command -compact
444 Abort the current minibuffer action.
445 .It Ic mini-complete-and-exit
446 Complete the current minibuffer action.
447 .It Ic mini-delete-backward-char
448 Delete the character before the point.
449 .It Ic mini-delete-char
450 Delete the character after the point.
451 .It Ic mini-kill-line
452 Delete from the point until the end of the line.
453 .It Ic mini-next-history-element
454 Load the previous history element.
455 .It Ic mini-previous-history-element
456 Load the next history element.
459 The following aliases are available during
460 .Ic execute-extended-command :
461 .Bl -tag -width 16m -compact
468 .It Ic q No and Ic wq
471 .Sh CONFIGURATION FILE
474 reads the configuration file at
475 .Pa ~/.telescope/config
476 or the one given with the
480 The format of the configuration file is fairly flexible.
481 The current line can be extended over multiple ones using a
484 Comments can be put anywhere in the file using a hash mark
486 and extend to the end of the current line, but backslashes can't be
487 used to extend comments over multiple lines.
489 The following constructs are available:
491 .It Ic bind Ar map Ar key Ar cmd
498 Valid values for map are
500 .Pq i.e. when the user is viewing a page
503 .Pq i.e. when the minibuffer has the focus.
505 follows the same syntax described in
506 .Sx DEFAULT KEY BINDINGS
507 and all the possible functions are listed in
508 .Sx INTERACTIVE COMMANDS .
509 .It Ic proxy Ar proto Ic via Ar url
512 as proxy for all URLs with
516 must be a Gemini URI without path, query and fragment component.
517 .It Ic set Ar opt No = Ar val
524 .Bl -tag -width twelveletters -compact
527 If not zero, enable colours.
530 is not set, 0 otherwise.
533 If greater than zero, lines of text will be formatted in a way that
534 don't exceed the given number of columns.
538 If nonzero, hide by default the body of the preformatted blocks.
541 can be used to toggle the visibility per-block.
544 If nonzero, hide the start and end line of the preformatted blocks.
545 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
546 blocks are irremediably hidden.
550 URL for the new tab page.
560 .It Ic style Ar name Ar option
561 Change the styling of the element identified by
563 Multiple options may be specified within curly braces.
564 Valid style identifiers are:
565 .Bl -tag -width 16m -compact -offset Ds
567 for the area outside the lines in the body of the page.
579 for the heading of a preformatted block.
581 for the content of a preformatted block.
583 for the closing line of a preformatted block.
586 .Dq i.e. the last line of the window
589 .Dq i.e. the info line right above the minibuffer
593 for the non-focused tabs.
600 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
601 Sets the text attributes.
602 If only one value is given,
606 default to that; if two values are given then
610 Each attribute is a comma-separated list of keywords:
611 .Bl -tag -width underline -compact -offset Ds
615 best highlighting mode for the terminal.
619 reverses background/foreground colors.
621 makes the text blinking.
625 extra bright or bold.
628 Only the styles under the
630 prefix accept up to three attributes.
631 The other will only use the first one given.
632 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
633 Sets the background color.
634 Follows the same behaviour as
636 regarding the optional parameters.
637 The colour is one of black, red, green, yellow, blue,
638 magenta, cyan and white; colour0 to colour255
639 .Pq or color0 to color255
640 from the 256-colour set;
641 default for the default colour.
642 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
643 Sets the foreground color.
646 .It Ic prefix Ar prfx Op Ar cont
647 Sets the prefix for the current line type to
651 as the prefix for the continuation lines
652 .Pq i.e. when a long line gets wrapped.
655 is not given its value will be the same of
660 .Bl -tag -width Ds -compact
661 .It Pa ~/.telescope/bookmarks.gmi
663 .It Pa ~/.telescope/config
664 Default configuration file.
665 .It Pa ~/.telescope/known_hosts
666 Contains a list of host keys for all the hosts the user has visited.
667 See the TOFU section for more info.
668 .It Pa ~/.telescope/session
669 Contains the list of opened tabs in the last session, one per line.
672 and loaded on startup.
675 The following is my config file:
676 .Bd -literal -offset indent
677 # enable colors regardless of $NO_COLOR
678 set enable-colors = 1
693 It's possible to browse
695 .Pq i.e. simple websites
696 by using programs like the duckling-proxy by defining a proxy in
697 .Pa ~/.telescope/config :
698 .Bd -literal -offset indent
699 proxy http via "gemini://localhost:1965"
700 proxy https via "gemini://localhost:1965"
705 without any configuration use
706 .Bd -literal -offset indent
707 telescope -c /dev/null
713 program was written by
714 .An Omar Polo Aq Mt op@omarpolo.com .
