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
198 .Ss Xr vi 1 Ns -like keys
199 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
213 move-beginning-of-line
245 execute-extended-command
248 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
266 .Ss Neither Emacs nor vi specific
267 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
281 .Ss Minibuffer-specific keys
282 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
284 mini-complete-and-exit
292 mini-delete-backward-char
294 mini-delete-backward-char
296 mini-delete-backward-char
308 move-beginning-of-line
312 move-beginning-of-line
316 mini-previous-history-element
318 mini-next-history-element
320 mini-previous-history-element
322 mini-next-history-element
324 .Sh INTERACTIVE COMMANDS
325 Follows the documentation for the interactive commands.
326 These commands can be bound to a key or executed with
327 .Ic execute-extended-command .
328 .Ss Movement commands
329 .Bl -tag -width execute-extended-command -compact
331 Move point one character backward.
332 .It Ic backward-paragraph
333 Move point one paragraph backward.
334 .It Ic beginning-of-buffer
335 Move point to the beginning of the buffer.
337 Move point to the end of the buffer.
339 Move point one character forward.
340 .It Ic forward-paragraph
341 Move point one paragraph forward.
342 .It Ic move-beginning-of-line
343 Move point at the beginning of the current (visual) line.
344 .It Ic move-end-of-line
345 Move point at the end of the current (visual) line.
347 Move point to the next link.
349 Move point to the next (visual) line, in the same column if possible.
350 .It Ic previous-button
351 Move point to the previous link.
353 Move point to the previous (visual) line.
355 .Ss Bookmark-related commands
356 .Bl -tag -width execute-extended-command -compact
358 Add a link to the bookmark file.
359 It preloads the minibuffer with the current URL.
360 .It Ic list-bookmarks
361 Load the bookmarks page.
363 .Ss Tab-related commands
364 .Bl -tag -width execute-extended-command -compact
366 Close the current tab.
367 .It Ic tab-close-other
368 Close all tabs but the current one.
370 Move the current tab after the next one, wrapping around if
373 Move the current tab before the previous one, wrapping around if needed.
377 Focus next tab, wrapping around eventually.
379 Focus the previous tab, wrapping around eventually.
382 .Bl -tag -width execute-extended-command -compact
384 Clears the echo area.
385 .It Ic execute-extended-command
386 Prompts for a command name using the minibuffer.
387 .It Ic kill-telescope
390 .It Ic load-current-url
391 Prompts for an URL, the minibuffer is preloaded with the current
396 Load the next item in the history list.
398 Toggle olivetti mode (i.e. horizontal centering of the lines of the
401 Load the previous item in the history list.
403 Follow the link on the current line.
404 .It Ic push-button-new-tab
405 Follow the link on the current line on a new tab.
407 Redraw the screen, useful if some background program messed up the
410 Scroll down by one visual page.
411 .It Ic scroll-line-down
412 Scroll down by one line.
413 .It Ic scroll-line-up
414 Scroll up by one line.
416 Scroll up by one visual page.
418 Toggle side window with help about available keys and their associated
421 .Ss Minibuffer commands
422 .Bl -tag -width execute-extended-command -compact
424 Abort the current minibuffer action.
425 .It Ic mini-complete-and-exit
426 Complete the current minibuffer action.
427 .It Ic mini-delete-backward-char
428 Delete the character before the point.
429 .It Ic mini-delete-char
430 Delete the character after the point.
431 .It Ic mini-kill-line
432 Delete from the point until the end of the line.
433 .It Ic mini-next-history-element
434 Load the previous history element.
435 .It Ic mini-previous-history-element
436 Load the next history element.
439 The following aliases are available during
440 .Ic execute-extended-command :
441 .Bl -tag -width 16m -compact
448 .It Ic q No and Ic wq
451 .Sh CONFIGURATION FILE
454 reads the configuration file at
455 .Pa ~/.telescope/config
456 or the one given with the
460 The format of the configuration file is fairly flexible.
461 The current line can be extended over multiple ones using a
464 Comments can be put anywhere in the file using a hash mark
466 and extend to the end of the current line, but backslashes can't be
467 used to extend comments over multiple lines.
469 The following constructs are available:
471 .It Ic set Ar opt No = Ar val
478 .Bl -tag -width twelveletters -compact
481 If not zero, enable colours.
484 is not set, 0 otherwise.
487 If greater than zero, lines of text will be formatted in a way that
488 don't exceed the given number of columns.
492 URL for the new tab page.
502 .It Ic proxy Ar proto Ic via Ar url
505 as proxy for all URLs with
509 must be a Gemini URI without path, query and fragment component.
510 .It Ic style Ar name Ar option
511 Change the styling of the element identified by
513 Multiple options may be specified within curly braces.
514 Valid style identifiers are:
515 .Bl -tag -width 14m -compact -offset Ds
527 for the heading of a preformatted block
529 for the content of a preformatted block
531 for the closing line of a preformatted block
536 .It Ic attr Ar prefix Oo Ar line Op Ar trail Oc
537 Sets the text attributes.
538 If only one value is given,
542 default to that; if two values are given then
546 Each attribute is a comma-separated list of keywords:
547 .Bl -tag -width underline -compact -offset Ds
551 best highlighting mode for the terminal.
555 reverses background/foreground colors.
557 makes the text blinking.
561 extra bright or bold.
563 .It Ic bg Ar prefix Oo Ar line Op Ar trail Oc
564 Sets the background color.
565 Follows the same behaviour as
567 regarding the optional parameters.
568 Supported colors are: default, black, red, green, yellow, blue,
569 magenta, cyan and white
570 .It Ic fg Ar prefix Oo Ar line Op Ar trail Oc
571 Sets the foreground color.
574 .It Ic prefix Ar prfx Op Ar cont
575 Sets the prefix for the given line to
579 as the prefix for the continuation lines
580 .Pq i.e. when a long line gets wrapped.
583 is not given its value will be the same of
588 .Bl -tag -width Ds -compact
589 .It Pa ~/.telescope/bookmarks.gmi
591 .It Pa ~/.telescope/config
592 Default configuration file.
593 .It Pa ~/.telescope/known_hosts
594 Contains a list of host keys for all the hosts the user has visited.
595 See the TOFU section for more info.
596 .It Pa ~/.telescope/session
597 Contains the list of opened tabs in the last session, one per line.
600 and loaded on startup.
603 The following is my config file:
604 .Bd -literal -offset indent
605 # ignore the NO_COLOR environment variable
606 set enable-colors = 1
615 attr normal underline
623 It's possible to browse
625 .Pq i.e. simple websites
626 using programs like the duckling-proxy by defining a proxy in
627 .Pa ~/.telescope/config Ns :
628 .Bd -literal -offset indent
629 proxy http via "gemini://localhost:1965"
630 proxy https via "gemini://localhost:1965"
636 program was written by
637 .An Omar Polo Aq Mt op@omarpolo.com .