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
282 .Ss Neither Emacs nor vi specific
283 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
297 .Ss Minibuffer-specific keys
298 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
300 mini-complete-and-exit
308 mini-delete-backward-char
310 mini-delete-backward-char
312 mini-delete-backward-char
324 move-beginning-of-line
328 move-beginning-of-line
332 mini-previous-history-element
334 mini-next-history-element
336 mini-previous-history-element
338 mini-next-history-element
340 .Sh INTERACTIVE COMMANDS
341 Follows the documentation for the interactive commands.
342 These commands can be bound to a key or executed with
343 .Ic execute-extended-command .
344 .Ss Movement commands
345 .Bl -tag -width execute-extended-command -compact
347 Move point one character backward.
348 .It Ic backward-paragraph
349 Move point one paragraph backward.
350 .It Ic beginning-of-buffer
351 Move point to the beginning of the buffer.
353 Move point to the end of the buffer.
355 Move point one character forward.
356 .It Ic forward-paragraph
357 Move point one paragraph forward.
358 .It Ic move-beginning-of-line
359 Move point at the beginning of the current (visual) line.
360 .It Ic move-end-of-line
361 Move point at the end of the current (visual) line.
363 Move point to the next link.
365 Move point to the next heading.
367 Move point to the next (visual) line, in the same column if possible.
368 .It Ic previous-button
369 Move point to the previous link.
370 .It Ic previous-heading
371 Move point to the previous heading.
373 Move point to the previous (visual) line.
375 .Ss Bookmark-related commands
376 .Bl -tag -width execute-extended-command -compact
378 Add a link to the bookmark file.
379 It preloads the minibuffer with the current URL.
380 .It Ic list-bookmarks
381 Load the bookmarks page.
383 .Ss Tab-related commands
384 .Bl -tag -width execute-extended-command -compact
386 Close the current tab.
387 .It Ic tab-close-other
388 Close all tabs but the current one.
390 Move the current tab after the next one, wrapping around if
393 Move the current tab before the previous one, wrapping around if needed.
397 Focus next tab, wrapping around eventually.
399 Focus the previous tab, wrapping around eventually.
402 .Bl -tag -width execute-extended-command -compact
404 Clears the echo area.
405 .It Ic dec-fill-column
406 Decrements fill-column by two.
407 .It Ic execute-extended-command
408 Prompts for a command name using the minibuffer.
409 .It Ic kill-telescope
412 .It Ic inc-fill-column
413 Increments fill-column by two.
414 .It Ic load-current-url
415 Prompts for an URL, the minibuffer is preloaded with the current
420 Load the next item in the history list.
422 Toggle olivetti mode (i.e. horizontal centering of the lines of the
425 Load the previous item in the history list.
427 Follow the link on the current line, or toggle the visibility of the
428 following preformatted block if called when the cursor is on the
429 heading of the block.
430 .It Ic push-button-new-tab
431 Follow the link on the current line on a new tab.
433 Redraw the screen, useful if some background program messed up the
436 Scroll down by one visual page.
437 .It Ic scroll-line-down
438 Scroll down by one line.
439 .It Ic scroll-line-up
440 Scroll up by one line.
442 Scroll up by one visual page.
444 Toggle side window with help about available keys and their associated
447 .Ss Minibuffer commands
448 .Bl -tag -width execute-extended-command -compact
450 Abort the current minibuffer action.
451 .It Ic mini-complete-and-exit
452 Complete the current minibuffer action.
453 .It Ic mini-delete-backward-char
454 Delete the character before the point.
455 .It Ic mini-delete-char
456 Delete the character after the point.
457 .It Ic mini-kill-line
458 Delete from the point until the end of the line.
459 .It Ic mini-next-history-element
460 Load the previous history element.
461 .It Ic mini-previous-history-element
462 Load the next history element.
465 The following aliases are available during
466 .Ic execute-extended-command :
467 .Bl -tag -width 16m -compact
474 .It Ic q No and Ic wq
477 .Sh CONFIGURATION FILE
480 reads the configuration file at
481 .Pa ~/.telescope/config
482 or the one given with the
486 The format of the configuration file is fairly flexible.
487 The current line can be extended over multiple ones using a
490 Comments can be put anywhere in the file using a hash mark
492 and extend to the end of the current line, but backslashes can't be
493 used to extend comments over multiple lines.
495 The following constructs are available:
497 .It Ic bind Ar map Ar key Ar cmd
504 Valid values for map are
506 .Pq i.e. when the user is viewing a page
509 .Pq i.e. when the minibuffer has the focus.
511 follows the same syntax described in
512 .Sx DEFAULT KEY BINDINGS
513 and all the possible functions are listed in
514 .Sx INTERACTIVE COMMANDS .
515 .It Ic proxy Ar proto Ic via Ar url
518 as proxy for all URLs with
522 must be a Gemini URI without path, query and fragment component.
523 .It Ic set Ar opt No = Ar val
530 .Bl -tag -width twelveletters -compact
533 If not zero, enable colours.
536 is not set, 0 otherwise.
539 If greater than zero, lines of text will be formatted in a way that
540 don't exceed the given number of columns.
544 If nonzero, hide by default the body of the preformatted blocks.
547 can be used to toggle the visibility per-block.
550 If nonzero, hide the start and end line of the preformatted blocks.
551 If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
552 blocks are irremediably hidden.
556 URL for the new tab page.
566 .It Ic style Ar name Ar option
567 Change the styling of the element identified by
569 Multiple options may be specified within curly braces.
570 Valid style identifiers are:
571 .Bl -tag -width 16m -compact -offset Ds
573 for the area outside the lines in the body of the page.
585 for the heading of a preformatted block.
587 for the content of a preformatted block.
589 for the closing line of a preformatted block.
592 .Dq i.e. the last line of the window
595 .Dq i.e. the info line right above the minibuffer
599 for the non-focused tabs.
606 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
607 Sets the text attributes.
608 If only one value is given,
612 default to that; if two values are given then
616 Each attribute is a comma-separated list of keywords:
617 .Bl -tag -width underline -compact -offset Ds
621 best highlighting mode for the terminal.
625 reverses background/foreground colors.
627 makes the text blinking.
631 extra bright or bold.
634 Only the styles under the
636 prefix accept up to three attributes.
637 The other will only use the first one given.
638 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
639 Sets the background color.
640 Follows the same behaviour as
642 regarding the optional parameters.
643 The colour is one of black, red, green, yellow, blue,
644 magenta, cyan and white; colour0 to colour255
645 .Pq or color0 to color255
646 from the 256-colour set;
647 default for the default colour.
648 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
649 Sets the foreground color.
652 .It Ic prefix Ar prfx Op Ar cont
653 Sets the prefix for the current line type to
657 as the prefix for the continuation lines
658 .Pq i.e. when a long line gets wrapped.
661 is not given its value will be the same of
666 .Bl -tag -width Ds -compact
667 .It Pa ~/.telescope/bookmarks.gmi
669 .It Pa ~/.telescope/config
670 Default configuration file.
671 .It Pa ~/.telescope/known_hosts
672 Contains a list of host keys for all the hosts the user has visited.
673 See the TOFU section for more info.
674 .It Pa ~/.telescope/session
675 Contains the list of opened tabs in the last session, one per line.
678 and loaded on startup.
681 The following is my config file:
682 .Bd -literal -offset indent
683 # enable colors regardless of $NO_COLOR
684 set enable-colors = 1
699 It's possible to browse
701 .Pq i.e. simple websites
702 by using programs like the duckling-proxy by defining a proxy in
703 .Pa ~/.telescope/config :
704 .Bd -literal -offset indent
705 proxy http via "gemini://localhost:1965"
706 proxy https via "gemini://localhost:1965"
711 without any configuration use
712 .Bd -literal -offset indent
713 telescope -c /dev/null
719 program was written by
720 .An Omar Polo Aq Mt op@omarpolo.com .
