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$
27 is an interactive browser for the Gemini protocol.
28 It is able to process text/gemini and more in general every text/* file.
30 also features tabs, bookmarks and out-of-band TOFU verification.
33 aims to use the "Trust, but Verify (where appropriate)" approach.
34 The idea is to define three level of verification for a certificate:
37 the server fingerprint does NOT match the stored value
39 the server fingerprint matches the store one
41 the fingerprint matches and has been verified out-of-band
46 level is enough, but where is appropriate users should be able to
47 verify out-of-band the certificate.
49 At the moment, there is no built-in support for an out-of-band
52 Known certificates are store in
53 .Pa ~/.telescope/known_hosts
54 with a format similar to the
58 Each line is a record and it's made up by three fields, separated by a
59 single space, according to the following format:
67 is the hash of the certificate, as outputted by
68 .Xr tls_peer_cert_hash 3 Ns .
71 0 means trusted, 1 verified.
73 .Sh DEFAULT KEY BINDINGS
74 The default key bindings are very similar to GNU Emacs, but care has
75 been taken to include also bindings familiar for
80 In the following examples, C-x means Control-x, M-x means Meta-x,
81 where the Meta key may be either a special key on the keyboard or the
82 ALT key; otherwise ESC followed by the key X works as well, and C-M-x
83 means to press the key X together with both Control and Meta.
85 Keys are usually a single character, like
89 but some special keys are accepted as well.
91 .Bl -tag -width 16m -offset indent -compact
101 Previous page/Page up
121 .Ss GNU Emacs-like keys
122 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
132 .Ic backward-paragraph
134 .Ic forward-paragraph
136 .Ic move-beginning-of-line
144 .Ic beginning-of-buffer
152 .Ic execute-extended-command
180 .Ss Xr vi 1 Ns -like keys
181 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
191 .Ic backward-paragraph
193 .Ic forward-paragraph
195 .Ic move-beginning-of-line
203 .Ic beginning-of-buffer
227 .Ic execute-extended-command
230 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
248 .Ss Neither Emacs nor vi specific
249 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
253 .Ic push-button-new-tab
259 .Ss Minibuffer-specific keys
260 .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
262 .Ic mini-complete-and-exit
270 .Ic mini-delete-backward-char
272 .Ic mini-delete-backward-char
274 .Ic mini-delete-backward-char
286 .Ic move-beginning-of-line
290 .Ic move-beginning-of-line
294 .Ic mini-previous-history-element
296 .Ic mini-next-history-element
298 .Ic mini-previous-history-element
300 .Ic mini-next-history-element
302 .Sh INTERACTIVE COMMANDS
303 Follows the documentation for the interactive commands.
304 These commands can be bound to a key or executed with
305 .Ic execute-extended-command .
306 .Ss Movement commands
307 .Bl -tag -width execute-extended-command -compact
309 Move point one character backward.
310 .It Ic backward-paragraph
311 Move point one paragraph backward.
312 .It Ic beginning-of-buffer
313 Move point to the beginning of the buffer.
315 Move point to the end of the buffer.
317 Move point one character forward.
318 .It Ic forward-paragraph
319 Move point one paragraph forward.
320 .It Ic move-beginning-of-line
321 Move point at the beginning of the current (visual) line.
322 .It Ic move-end-of-line
323 Move point at the end of the current (visual) line.
325 Move point to the next link.
327 Move point to the next (visual) line, in the same column if possible.
328 .It Ic previous-button
329 Move point to the previous link.
331 Move point to the previous (visual) line.
333 .Ss Bookmark-related commands
335 .Bl -tag -width execute-extended-command -compact
337 Add a link to the bookmark file.
338 It preloads the minibuffer with the current URL.
339 .It Ic goto-bookmarks
340 Load the bookmarks page.
342 .Ss Tab-related commands
343 .Bl -tag -width execute-extended-command -compact
345 Close the current tab.
346 .It Ic tab-close-other
347 Close all tabs but the current one.
349 Move the current tab after the next one, wrapping around if
352 Move the current tab before the previous one, wrapping around if needed.
356 Focus next tab, wrapping around eventually.
358 Focus the previous tab, wrapping around eventually.
361 .Bl -tag -width execute-extended-command -compact
363 Clears the echo area.
364 .It Ic execute-extended-command
365 Prompts for a command name using the minibuffer.
366 .It Ic kill-telescope
369 .It Ic load-current-url
370 Prompts for an URL, the minibuffer is preloaded with the current
375 Load the next item in the history list.
377 Load the previous item in the history list.
379 Follow the link on the current line.
380 .It Ic push-button-new-tab
381 Follow the link on the current line on a new tab.
383 Redraws the screen, useful if some background program messed up the
386 Scroll down by one visual page.
387 .It Ic scroll-line-down
388 Scroll down by one line.
389 .It Ic scroll-line-up
390 Scroll up by one line.
392 Scroll up by one visual page.
394 .Ss Minibuffer commands
395 .Bl -tag -width execute-extended-command -compact
397 Abort the current minibuffer action.
398 .It Ic mini-complete-and-exit
399 Complete the current minibuffer action.
400 .It Ic mini-delete-backward-char
401 Delete the character before the point.
402 .It Ic mini-delete-char
403 Delete the character after the point.
404 .It Ic mini-kill-line
405 Delete from the point until the end of the line.
406 .It Ic mini-next-history-element
407 Load the previous history element.
408 .It Ic mini-previous-history-element
409 Load the next history element.
412 .Bl -tag -width Ds -compact
413 .It Pa ~/.telescope/bookmarks.gmi
415 .It Pa ~/.telescope/known_hosts
416 Contains a list of host keys for all the hosts the user has visited.
417 See the TOFU section for more info.
422 program was written by
423 .An Omar Polo Aq Mt op@omarpolo.com .
