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
200 .Ss Xr vi 1 Ns -like keys
201 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
215 move-beginning-of-line
247 execute-extended-command
250 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
268 .Ss Neither Emacs nor vi specific
269 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
283 .Ss Minibuffer-specific keys
284 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
286 mini-complete-and-exit
294 mini-delete-backward-char
296 mini-delete-backward-char
298 mini-delete-backward-char
310 move-beginning-of-line
314 move-beginning-of-line
318 mini-previous-history-element
320 mini-next-history-element
322 mini-previous-history-element
324 mini-next-history-element
326 .Sh INTERACTIVE COMMANDS
327 Follows the documentation for the interactive commands.
328 These commands can be bound to a key or executed with
329 .Ic execute-extended-command .
330 .Ss Movement commands
331 .Bl -tag -width execute-extended-command -compact
333 Move point one character backward.
334 .It Ic backward-paragraph
335 Move point one paragraph backward.
336 .It Ic beginning-of-buffer
337 Move point to the beginning of the buffer.
339 Move point to the end of the buffer.
341 Move point one character forward.
342 .It Ic forward-paragraph
343 Move point one paragraph forward.
344 .It Ic move-beginning-of-line
345 Move point at the beginning of the current (visual) line.
346 .It Ic move-end-of-line
347 Move point at the end of the current (visual) line.
349 Move point to the next link.
351 Move point to the next (visual) line, in the same column if possible.
352 .It Ic previous-button
353 Move point to the previous link.
355 Move point to the previous (visual) line.
357 .Ss Bookmark-related commands
358 .Bl -tag -width execute-extended-command -compact
360 Add a link to the bookmark file.
361 It preloads the minibuffer with the current URL.
362 .It Ic list-bookmarks
363 Load the bookmarks page.
365 .Ss Tab-related commands
366 .Bl -tag -width execute-extended-command -compact
368 Close the current tab.
369 .It Ic tab-close-other
370 Close all tabs but the current one.
372 Move the current tab after the next one, wrapping around if
375 Move the current tab before the previous one, wrapping around if needed.
379 Focus next tab, wrapping around eventually.
381 Focus the previous tab, wrapping around eventually.
384 .Bl -tag -width execute-extended-command -compact
386 Clears the echo area.
387 .It Ic execute-extended-command
388 Prompts for a command name using the minibuffer.
389 .It Ic kill-telescope
392 .It Ic load-current-url
393 Prompts for an URL, the minibuffer is preloaded with the current
398 Load the next item in the history list.
400 Toggle olivetti mode (i.e. horizontal centering of the lines of the
403 Load the previous item in the history list.
405 Follow the link on the current line.
406 .It Ic push-button-new-tab
407 Follow the link on the current line on a new tab.
409 Redraw the screen, useful if some background program messed up the
412 Scroll down by one visual page.
413 .It Ic scroll-line-down
414 Scroll down by one line.
415 .It Ic scroll-line-up
416 Scroll up by one line.
418 Scroll up by one visual page.
420 Toggle side window with help about available keys and their associated
423 .Ss Minibuffer commands
424 .Bl -tag -width execute-extended-command -compact
426 Abort the current minibuffer action.
427 .It Ic mini-complete-and-exit
428 Complete the current minibuffer action.
429 .It Ic mini-delete-backward-char
430 Delete the character before the point.
431 .It Ic mini-delete-char
432 Delete the character after the point.
433 .It Ic mini-kill-line
434 Delete from the point until the end of the line.
435 .It Ic mini-next-history-element
436 Load the previous history element.
437 .It Ic mini-previous-history-element
438 Load the next history element.
441 The following aliases are available during
442 .Ic execute-extended-command :
443 .Bl -tag -width 16m -compact
450 .It Ic q No and Ic wq
453 .Sh CONFIGURATION FILE
456 reads the configuration file at
457 .Pa ~/.telescope/config
458 or the one given with the
462 The format of the configuration file is fairly flexible.
463 The current line can be extended over multiple ones using a
466 Comments can be put anywhere in the file using a hash mark
468 and extend to the end of the current line, but backslashes can't be
469 used to extend comments over multiple lines.
471 The following constructs are available:
473 .It Ic set Ar opt No = Ar val
480 .Bl -tag -width twelveletters -compact
483 If not zero, enable colours.
486 is not set, 0 otherwise.
489 If greater than zero, lines of text will be formatted in a way that
490 don't exceed the given number of columns.
494 URL for the new tab page.
504 .It Ic proxy Ar proto Ic via Ar url
507 as proxy for all URLs with
511 must be a Gemini URI without path, query and fragment component.
512 .It Ic style Ar name Ar option
513 Change the styling of the element identified by
515 Multiple options may be specified within curly braces.
516 Valid style identifiers are:
517 .Bl -tag -width 14m -compact -offset Ds
529 for the heading of a preformatted block
531 for the content of a preformatted block
533 for the closing line of a preformatted block
538 .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
539 Sets the text attributes.
540 If only one value is given,
544 default to that; if two values are given then
548 Each attribute is a comma-separated list of keywords:
549 .Bl -tag -width underline -compact -offset Ds
553 best highlighting mode for the terminal.
557 reverses background/foreground colors.
559 makes the text blinking.
563 extra bright or bold.
565 .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
566 Sets the background color.
567 Follows the same behaviour as
569 regarding the optional parameters.
570 Supported colors are: default, black, red, green, yellow, blue,
571 magenta, cyan and white
572 .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
573 Sets the foreground color.
576 .It Ic prefix Ar prfx Op Ar cont
577 Sets the prefix for the given line to
581 as the prefix for the continuation lines
582 .Pq i.e. when a long line gets wrapped.
585 is not given its value will be the same of
590 .Bl -tag -width Ds -compact
591 .It Pa ~/.telescope/bookmarks.gmi
593 .It Pa ~/.telescope/config
594 Default configuration file.
595 .It Pa ~/.telescope/known_hosts
596 Contains a list of host keys for all the hosts the user has visited.
597 See the TOFU section for more info.
598 .It Pa ~/.telescope/session
599 Contains the list of opened tabs in the last session, one per line.
602 and loaded on startup.
605 The following is my config file:
606 .Bd -literal -offset indent
607 # ignore the NO_COLOR environment variable
608 set enable-colors = 1
617 attr normal underline
625 It's possible to browse
627 .Pq i.e. simple websites
628 using programs like the duckling-proxy by defining a proxy in
629 .Pa ~/.telescope/config :
630 .Bd -literal -offset indent
631 proxy http via "gemini://localhost:1965"
632 proxy https via "gemini://localhost:1965"
637 without any configuration use
638 .Bd -literal -offset indent
639 telescope -c /dev/null
645 program was written by
646 .An Omar Polo Aq Mt op@omarpolo.com .
