1 bba111bc 2021-03-28 op .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
3 bba111bc 2021-03-28 op .\" Permission to use, copy, modify, and distribute this software for any
4 bba111bc 2021-03-28 op .\" purpose with or without fee is hereby granted, provided that the above
5 bba111bc 2021-03-28 op .\" copyright notice and this permission notice appear in all copies.
7 bba111bc 2021-03-28 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 bba111bc 2021-03-28 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 bba111bc 2021-03-28 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 bba111bc 2021-03-28 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 bba111bc 2021-03-28 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 bba111bc 2021-03-28 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 bba111bc 2021-03-28 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 bba111bc 2021-03-28 op .Dd $Mdocdate: March 28 2021$
15 bba111bc 2021-03-28 op .Dt TELESCOPE 1
19 bba111bc 2021-03-28 op .Nd Gemini client
24 c92e529c 2021-06-15 op .Op Fl c Pa config
27 bba111bc 2021-03-28 op .Sh DESCRIPTION
29 bba111bc 2021-03-28 op is an interactive browser for the Gemini protocol.
30 bba111bc 2021-03-28 op It is able to process text/gemini and more in general every text/* file.
32 7ee780fa 2021-07-21 op also features tabs, a minibuffer, bookmarks and out-of-band TOFU
35 c92e529c 2021-06-15 op The arguments are as follows:
36 dc761924 2021-07-15 op .Bl -tag -width xxxxxxxxxxxxx
37 97870a34 2021-07-15 op .It Fl C , Fl -colors
38 97870a34 2021-07-15 op Show all available colors and exit.
39 c92e529c 2021-06-15 op .It Fl c Pa config
40 c92e529c 2021-06-15 op Specify an alternative configuration file.
42 c92e529c 2021-06-15 op .Pa $HOME/.telescope/config
44 ccc5591f 2021-07-15 op .It Fl h , Fl -help
45 ccc5591f 2021-07-15 op Display version and usage.
47 ccc5591f 2021-07-15 op Configtest mode.
48 ccc5591f 2021-07-15 op Only check the configuration file for validity.
49 dc761924 2021-07-15 op .It Fl v , Fl -version
50 dc761924 2021-07-15 op Display version.
52 7ee780fa 2021-07-21 op .Sh UI CONCEPTS
54 7ee780fa 2021-07-21 op interface is divided into four areas: the tabline, the body, the
55 7ee780fa 2021-07-21 op modeline and the echoarea/minibuffer.
57 7ee780fa 2021-07-21 op The tabline is always at the top of the screen and displays the tabs
58 7ee780fa 2021-07-21 op separated by a vertical line.
59 7ee780fa 2021-07-21 op When there are more tabs than the size of the window allow to display,
60 7ee780fa 2021-07-21 op the characters
64 7ee780fa 2021-07-21 op are shown at the start/end of the tabline to indicate that there are
65 7ee780fa 2021-07-21 op more tabs in that direction.
67 7ee780fa 2021-07-21 op The body occupies the majority of the visible area.
68 7ee780fa 2021-07-21 op It contains the current page and optionally a side window.
70 7ee780fa 2021-07-21 op The modeline is the second to last row of the screen.
71 7ee780fa 2021-07-21 op It shows some information about the page: a spinner when the page is
72 7ee780fa 2021-07-21 op loading, the trust level, the document type, the scroll offset and the
75 7ee780fa 2021-07-21 op The echoarea is usually the last line of the screen.
76 7ee780fa 2021-07-21 op Messages are often showed there, and link addresses too.
77 7ee780fa 2021-07-21 op The echoarea is also used to obtain input from the user.
78 7ee780fa 2021-07-21 op When commands like
81 7ee780fa 2021-07-21 op .Ic link-select
82 7ee780fa 2021-07-21 op are invoked, the minibuffer area grows to show possible completions
83 7ee780fa 2021-07-21 op and navigate through them.
86 7ee780fa 2021-07-21 op aims to use the
87 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
90 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
91 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
92 bba111bc 2021-03-28 op .Bl -tag -width 12m
95 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
98 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
101 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
104 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
105 7ee780fa 2021-07-21 op indicated character.
107 bba111bc 2021-03-28 op Most of the time the
109 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
110 bba111bc 2021-03-28 op verify out-of-band the certificate.
112 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
113 bba111bc 2021-03-28 op verification though.
114 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
115 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
116 bba111bc 2021-03-28 op been taken to include also bindings familiar for
121 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
122 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
123 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
124 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
126 bba111bc 2021-03-28 op Keys are usually a single character, like
130 bba111bc 2021-03-28 op but some special keys are accepted as well.
132 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
142 bba111bc 2021-03-28 op Previous page/Page up
144 bba111bc 2021-03-28 op Next page/Page down
149 bba111bc 2021-03-28 op .It <f0> thru <f63>
150 bba111bc 2021-03-28 op Function keys
151 bba111bc 2021-03-28 op .It del or backspace
155 bba111bc 2021-03-28 op .It space or spc
157 bba111bc 2021-03-28 op .It enter or ret
162 8dc60352 2021-06-15 op Depends on the configuration of the terminal emulator.
163 8dc60352 2021-06-15 op Usually is shift tab though.
165 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
166 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
168 7dbaef94 2021-04-22 op previous-line
174 7dbaef94 2021-04-22 op backward-char
176 7dbaef94 2021-04-22 op backward-paragraph
178 7dbaef94 2021-04-22 op forward-paragraph
180 7dbaef94 2021-04-22 op move-beginning-of-line
182 7dbaef94 2021-04-22 op move-end-of-line
183 bba111bc 2021-03-28 op .It M-v, M-space
185 bba111bc 2021-03-28 op .It C-v, space
188 7dbaef94 2021-04-22 op beginning-of-buffer
190 7dbaef94 2021-04-22 op end-of-buffer
192 7dbaef94 2021-04-22 op kill-telescope
194 7dbaef94 2021-04-22 op clear-minibuf
196 7dbaef94 2021-04-22 op execute-extended-command
198 61251035 2021-06-26 op dec-fill-column
200 61251035 2021-06-26 op inc-fill-column
202 1c412d48 2021-06-25 op previous-heading
208 f2ab2540 2021-07-14 op load-current-url
212 7dbaef94 2021-04-22 op load-current-url
218 7dbaef94 2021-04-22 op tab-close-other
230 7dbaef94 2021-04-22 op previous-page
234 7dbaef94 2021-04-22 op bookmark-page
235 bba111bc 2021-03-28 op .It <f7> <f7>
236 7dbaef94 2021-04-22 op list-bookmarks
238 12cf7d80 2021-07-15 op suspend-telescope
240 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
241 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
243 7dbaef94 2021-04-22 op previous-line
249 7dbaef94 2021-04-22 op backward-char
251 7dbaef94 2021-04-22 op backward-paragraph
253 7dbaef94 2021-04-22 op forward-paragraph
255 7dbaef94 2021-04-22 op move-beginning-of-line
257 7dbaef94 2021-04-22 op move-end-of-line
259 7dbaef94 2021-04-22 op scroll-line-up
261 7dbaef94 2021-04-22 op scroll-line-down
263 7dbaef94 2021-04-22 op beginning-of-buffer
265 7dbaef94 2021-04-22 op end-of-buffer
279 7dbaef94 2021-04-22 op previous-page
283 7dbaef94 2021-04-22 op kill-telescope
285 7dbaef94 2021-04-22 op clear-minibuf
287 7dbaef94 2021-04-22 op execute-extended-command
289 bba111bc 2021-03-28 op .Ss CUA-like keys
290 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
292 7dbaef94 2021-04-22 op previous-line
298 7dbaef94 2021-04-22 op backward-char
300 12cf7d80 2021-07-15 op move-beginning-of-line
302 12cf7d80 2021-07-15 op move-end-of-line
311 3c3af0fd 2021-07-08 op .It M-<prior>
316 7dbaef94 2021-04-22 op previous-page
317 bba111bc 2021-03-28 op .It M-<right>
324 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
325 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
331 7dbaef94 2021-04-22 op push-button-new-tab
333 7dbaef94 2021-04-22 op previous-button
335 8dc60352 2021-06-15 op previous-button
349 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
350 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
352 7dbaef94 2021-04-22 op mini-complete-and-exit
358 7dbaef94 2021-04-22 op mini-delete-char
360 7dbaef94 2021-04-22 op mini-delete-backward-char
361 bba111bc 2021-03-28 op .It backspace
362 7dbaef94 2021-04-22 op mini-delete-backward-char
364 7dbaef94 2021-04-22 op mini-delete-backward-char
366 7dbaef94 2021-04-22 op backward-char
370 7dbaef94 2021-04-22 op backward-char
374 7dbaef94 2021-04-22 op move-end-of-line
376 7dbaef94 2021-04-22 op move-beginning-of-line
378 7dbaef94 2021-04-22 op move-end-of-line
380 7dbaef94 2021-04-22 op move-beginning-of-line
382 7dbaef94 2021-04-22 op mini-kill-line
384 7dbaef94 2021-04-22 op mini-previous-history-element
386 7dbaef94 2021-04-22 op mini-next-history-element
388 e7b982f4 2021-07-14 op previous-completion
390 dffb2592 2021-07-14 op next-completion
392 dffb2592 2021-07-14 op previous-completion
394 e7b982f4 2021-07-14 op next-completion
396 e7b982f4 2021-07-14 op insert-current-candidate
398 7ee780fa 2021-07-21 op mini-goto-beginning
400 7ee780fa 2021-07-21 op mini-goto-end
402 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
403 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
404 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
405 bba111bc 2021-03-28 op .Ic execute-extended-command .
406 bba111bc 2021-03-28 op .Ss Movement commands
407 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
408 bba111bc 2021-03-28 op .It Ic backward-char
409 bba111bc 2021-03-28 op Move point one character backward.
410 bba111bc 2021-03-28 op .It Ic backward-paragraph
411 bba111bc 2021-03-28 op Move point one paragraph backward.
412 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
413 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
414 bba111bc 2021-03-28 op .It Ic end-of-buffer
415 bba111bc 2021-03-28 op Move point to the end of the buffer.
416 bba111bc 2021-03-28 op .It Ic forward-char
417 bba111bc 2021-03-28 op Move point one character forward.
418 bba111bc 2021-03-28 op .It Ic forward-paragraph
419 bba111bc 2021-03-28 op Move point one paragraph forward.
420 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
421 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
422 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
423 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
424 bba111bc 2021-03-28 op .It Ic move-end-of-line
425 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
426 bba111bc 2021-03-28 op .It Ic next-button
427 bba111bc 2021-03-28 op Move point to the next link.
428 e7b982f4 2021-07-14 op .It Ic next-completion
429 e7b982f4 2021-07-14 op Select the next completion.
430 1c412d48 2021-06-25 op .It Ic next-heading
431 1c412d48 2021-06-25 op Move point to the next heading.
432 bba111bc 2021-03-28 op .It Ic next-line
433 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
434 bba111bc 2021-03-28 op .It Ic previous-button
435 bba111bc 2021-03-28 op Move point to the previous link.
436 e7b982f4 2021-07-14 op .It Ic previous-completion
437 e7b982f4 2021-07-14 op Select the previous completion.
438 1c412d48 2021-06-25 op .It Ic previous-heading
439 1c412d48 2021-06-25 op Move point to the previous heading.
440 bba111bc 2021-03-28 op .It Ic previous-line
441 bba111bc 2021-03-28 op Move point to the previous (visual) line.
443 bba111bc 2021-03-28 op .Ss Bookmark-related commands
444 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
445 bba111bc 2021-03-28 op .It Ic bookmark-page
446 b3be07ea 2021-07-18 op Save a page in the bookmark file.
447 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
448 63875195 2021-04-01 op .It Ic list-bookmarks
449 bba111bc 2021-03-28 op Load the bookmarks page.
451 bba111bc 2021-03-28 op .Ss Tab-related commands
452 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
453 bba111bc 2021-03-28 op .It Ic tab-close
454 bba111bc 2021-03-28 op Close the current tab.
455 bba111bc 2021-03-28 op .It Ic tab-close-other
456 bba111bc 2021-03-28 op Close all tabs but the current one.
457 bba111bc 2021-03-28 op .It Ic tab-move
458 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
460 bba111bc 2021-03-28 op .It Ic tab-move-to
461 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
462 bba111bc 2021-03-28 op .It Ic tab-new
463 bba111bc 2021-03-28 op Open a new tab.
464 bba111bc 2021-03-28 op .It Ic tab-next
465 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
466 bba111bc 2021-03-28 op .It Ic tab-previous
467 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
468 3360ef1b 2021-07-14 op .It Ic tab-select
469 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
471 bba111bc 2021-03-28 op .Ss Misc commands
472 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
473 bba111bc 2021-03-28 op .It Ic clear-minibuf
474 b3be07ea 2021-07-18 op Clear the echo area.
475 61251035 2021-06-26 op .It Ic dec-fill-column
476 b3be07ea 2021-07-18 op Decrement fill-column by two.
477 bba111bc 2021-03-28 op .It Ic execute-extended-command
478 b3be07ea 2021-07-18 op Execute an internal command.
479 bba111bc 2021-03-28 op .It Ic kill-telescope
482 61251035 2021-06-26 op .It Ic inc-fill-column
483 b3be07ea 2021-07-18 op Increment fill-column by two.
484 753c6ac7 2021-07-14 op .It Ic link-select
485 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
486 bba111bc 2021-03-28 op .It Ic load-current-url
487 b3be07ea 2021-07-18 op Edit the current URL.
488 bba111bc 2021-03-28 op .It Ic load-url
489 b3be07ea 2021-07-18 op Prompt for an URL.
490 bba111bc 2021-03-28 op .It Ic next-page
491 b3be07ea 2021-07-18 op Go forward in the page history.
492 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
493 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
495 9a7d62cb 2021-07-21 op .It Ic other-window
496 9a7d62cb 2021-07-21 op Select the other window.
497 bba111bc 2021-03-28 op .It Ic previous-page
498 b3be07ea 2021-07-18 op Go backward in the page history.
499 bba111bc 2021-03-28 op .It Ic push-button
500 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
501 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
502 bba111bc 2021-03-28 op .It Ic push-button-new-tab
503 b3be07ea 2021-07-18 op Follow link at point in a new tab.
504 bba111bc 2021-03-28 op .It Ic redraw
505 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
507 661233ed 2021-07-14 op .It Ic reload-page
508 661233ed 2021-07-14 op Reload the current page.
509 bba111bc 2021-03-28 op .It Ic scroll-down
510 bba111bc 2021-03-28 op Scroll down by one visual page.
511 bba111bc 2021-03-28 op .It Ic scroll-line-down
512 bba111bc 2021-03-28 op Scroll down by one line.
513 bba111bc 2021-03-28 op .It Ic scroll-line-up
514 bba111bc 2021-03-28 op Scroll up by one line.
515 bba111bc 2021-03-28 op .It Ic scroll-up
516 bba111bc 2021-03-28 op Scroll up by one visual page.
517 12cf7d80 2021-07-15 op .It Ic suspend-telescope
518 12cf7d80 2021-07-15 op Suspend the current
521 753c6ac7 2021-07-14 op .It Ic swiper
522 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
524 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
525 7a014cef 2021-04-01 op .It Ic toggle-help
526 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
527 7a014cef 2021-04-01 op interactive command.
528 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
529 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
531 bba111bc 2021-03-28 op .Ss Minibuffer commands
532 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
533 bba111bc 2021-03-28 op .It Ic mini-abort
534 bba111bc 2021-03-28 op Abort the current minibuffer action.
535 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
536 bba111bc 2021-03-28 op Complete the current minibuffer action.
537 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
538 bba111bc 2021-03-28 op Delete the character before the point.
539 bba111bc 2021-03-28 op .It Ic mini-delete-char
540 bba111bc 2021-03-28 op Delete the character after the point.
541 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
542 de190a2b 2021-07-17 op Select the first completion, if any.
543 de190a2b 2021-07-17 op .It Ic mini-goto-end
544 de190a2b 2021-07-17 op Select the last completion, if any.
545 bba111bc 2021-03-28 op .It Ic mini-kill-line
546 b3be07ea 2021-07-18 op Delete from point until the end of the line.
547 bba111bc 2021-03-28 op .It Ic mini-next-history-element
548 bba111bc 2021-03-28 op Load the previous history element.
549 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
550 bba111bc 2021-03-28 op Load the next history element.
553 7d2d15f5 2021-04-30 op The following aliases are available during
554 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
555 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
558 c82b3fd6 2021-05-12 op .It Ic tabnew
561 c82b3fd6 2021-05-12 op .Ic tab-previous
562 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
563 7d2d15f5 2021-04-30 op .Ic kill-telescope
565 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
566 74ca8ef4 2021-06-19 op During the startup,
568 74ca8ef4 2021-06-19 op reads the configuration file at
569 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
570 74ca8ef4 2021-06-19 op or the one given with the
575 21404dd9 2021-07-15 op will also load a file called
576 21404dd9 2021-07-15 op .Pa config-TERM ,
579 21404dd9 2021-07-15 op is the name of the terminal type
580 7ee780fa 2021-07-21 op .Pq i.e. the TERM environment variable ,
581 7ee780fa 2021-07-21 op if it exists.
583 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
584 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
587 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
589 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
590 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
592 74ca8ef4 2021-06-19 op The following constructs are available:
593 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
594 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
597 138421e8 2021-06-25 op to the function
599 138421e8 2021-06-25 op in the keymap
601 138421e8 2021-06-25 op Valid values for map are
602 138421e8 2021-06-25 op .Dq global-map
603 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
605 138421e8 2021-06-25 op .Dq minibuffer-map
606 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
608 138421e8 2021-06-25 op follows the same syntax described in
609 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
610 138421e8 2021-06-25 op and all the possible functions are listed in
611 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
612 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
615 90d8329a 2021-06-25 op as proxy for all URLs with
619 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
620 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
621 74ca8ef4 2021-06-19 op Set the option
625 74ca8ef4 2021-06-19 op Valid options are:
627 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
628 88693f61 2021-07-15 op .It dont-wrap-pre
630 88693f61 2021-07-15 op If nonzero, don't wrap preformatted blocks.
631 7ee780fa 2021-07-21 op Defaults to 0.
632 59ae0cdc 2021-07-16 op .It emojify-link
634 7ee780fa 2021-07-21 op If nonzero, when the text of a link starts with an emoji followed by a
635 7ee780fa 2021-07-21 op space, use that emoji as line prefix.
636 59ae0cdc 2021-07-16 op Defaults to 1.
637 2c748a1f 2021-06-21 op .It enable-colors
639 7ee780fa 2021-07-21 op If nonzero, enable colours.
640 7ee780fa 2021-07-21 op Defaults to 0 if
641 2c748a1f 2021-06-21 op .Ev NO_COLORS
642 7ee780fa 2021-07-21 op is set, 1 otherwise.
643 74ca8ef4 2021-06-19 op .It fill-column
645 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
646 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
647 7ee780fa 2021-07-21 op Defaults to 80.
648 b1379f34 2021-07-05 op .It hide-pre-blocks
650 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
651 7ee780fa 2021-07-21 op Defaults to zero.
652 b1379f34 2021-07-05 op .Ic push-button
653 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
654 144733a7 2021-07-15 op .It hide-pre-closing-line
656 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
657 7ee780fa 2021-07-21 op Defaults to 0.
658 b1379f34 2021-07-05 op .It hide-pre-context
660 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
661 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
662 b1379f34 2021-07-05 op blocks are irremediably hidden.
663 7ee780fa 2021-07-21 op Defaults to zero.
664 74ca8ef4 2021-06-19 op .It new-tab-url
666 41a9ae40 2021-06-20 op URL for the new tab page.
668 41a9ae40 2021-06-20 op .Dq about:new .
669 74ca8ef4 2021-06-19 op .It olivetti-mode
671 7ee780fa 2021-07-21 op If nonzero, enable
672 74ca8ef4 2021-06-19 op .Ic olivetti-mode
673 7ee780fa 2021-07-21 op Defaults to 1.
674 9886bf97 2021-07-17 op .It set-title
676 7ee780fa 2021-07-21 op If nonzero, set the terminal title to the page title.
677 9886bf97 2021-07-17 op Defaults to 1.
679 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
680 74ca8ef4 2021-06-19 op Change the styling of the element identified by
682 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
683 74ca8ef4 2021-06-19 op Valid style identifiers are:
684 7ee780fa 2021-07-21 op .Bl -tag -width line.compl.current -compact -offset Ds
686 7ee780fa 2021-07-21 op the area outside the lines in the body of the page.
687 45fe2472 2021-07-14 op .It line.compl
688 7ee780fa 2021-07-21 op the completions.
689 45fe2472 2021-07-14 op .It line.compl.current
690 7ee780fa 2021-07-21 op the current completion.
691 75fd746b 2021-07-21 op .It line.help
692 75fd746b 2021-07-21 op text in the *Help* buffer.
693 74ca8ef4 2021-06-19 op .It line.text
695 74bc52e8 2021-06-25 op .It line.link
697 74ca8ef4 2021-06-19 op .It line.title1..3
699 74ca8ef4 2021-06-19 op .It line.item
701 74ca8ef4 2021-06-19 op .It line.quote
703 74ca8ef4 2021-06-19 op .It line.pre.start
704 7ee780fa 2021-07-21 op the heading of a preformatted block.
706 7ee780fa 2021-07-21 op the content of a preformatted block.
707 74ca8ef4 2021-06-19 op .It line.pre.end
708 7ee780fa 2021-07-21 op the closing line of a preformatted block.
709 eaf1a84b 2021-06-25 op .It minibuffer
710 7ee780fa 2021-07-21 op the minibuffer.
712 7ee780fa 2021-07-21 op the modeline.
715 74bc52e8 2021-06-25 op .It tabline.tab
716 7ee780fa 2021-07-21 op the non-focused tabs.
717 74bc52e8 2021-06-25 op .It tabline.current
718 7ee780fa 2021-07-21 op the focused tab.
721 74ca8ef4 2021-06-19 op Valid options are:
722 ab728b01 2021-06-22 op .Bl -tag -width Ds
723 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
724 ab728b01 2021-06-22 op Sets the text attributes.
725 ab728b01 2021-06-22 op If only one value is given,
729 ab728b01 2021-06-22 op default to that; if two values are given then
733 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
734 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
735 ab728b01 2021-06-22 op .It Ic normal
736 ab728b01 2021-06-22 op no attributes.
737 ab728b01 2021-06-22 op .It Ic standout
738 ab728b01 2021-06-22 op best highlighting mode for the terminal.
739 ab728b01 2021-06-22 op .It Ic underline
740 ab728b01 2021-06-22 op underlines the text.
741 ab728b01 2021-06-22 op .It Ic reverse
742 ab728b01 2021-06-22 op reverses background/foreground colors.
744 ab728b01 2021-06-22 op makes the text blinking.
748 ab728b01 2021-06-22 op extra bright or bold.
751 7ee780fa 2021-07-21 op Only the style identifiers with the
753 74bc52e8 2021-06-25 op prefix accept up to three attributes.
754 74bc52e8 2021-06-25 op The other will only use the first one given.
755 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
756 ab728b01 2021-06-22 op Sets the background color.
757 ab728b01 2021-06-22 op Follows the same behaviour as
759 ab728b01 2021-06-22 op regarding the optional parameters.
760 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
761 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
762 ae844a00 2021-06-25 op .Pq or color0 to color255
763 ae844a00 2021-06-25 op from the 256-colour set;
764 ae844a00 2021-06-25 op default for the default colour.
765 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
766 ab728b01 2021-06-22 op Sets the foreground color.
767 ab728b01 2021-06-22 op It behaves just like
769 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
770 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
774 ab728b01 2021-06-22 op as the prefix for the continuation lines
775 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
778 ab728b01 2021-06-22 op is not given its value will be the same of
782 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
785 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
786 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
788 7ee780fa 2021-07-21 op The user's login directory.
789 7ee780fa 2021-07-21 op .It Ev NO_COLORS
790 7ee780fa 2021-07-21 op To decide whether to use colors or not.
791 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
793 7ee780fa 2021-07-21 op The user's terminal name.
796 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
797 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
798 7ee780fa 2021-07-21 op Bookmarks file.
799 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
800 dca97b00 2021-06-19 op Default configuration file.
801 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
802 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
803 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
804 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
805 d0fd368a 2021-07-15 op .It Pa ~/.telescope/lock
806 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
808 d0fd368a 2021-07-15 op from running at the same time.
809 56e7efb4 2021-07-21 op .It Pa ~/.telescope/pages/about_*.gmi
810 56e7efb4 2021-07-21 op Overrides for built-in about: pages.
811 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
812 7ee780fa 2021-07-21 op The list of tabs from the last session.
813 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
814 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
816 87e3e801 2021-07-17 op Is written by
817 e9b1e094 2021-04-01 op .Ic kill-telescope
818 7ee780fa 2021-07-21 op and loaded during startup.
821 984245ce 2021-06-23 op It's possible to browse
822 984245ce 2021-06-23 op .Dq the small web
823 984245ce 2021-06-23 op .Pq i.e. simple websites
824 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
825 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
826 984245ce 2021-06-23 op .Bd -literal -offset indent
827 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
828 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
833 7ee780fa 2021-07-21 op without any configuration
834 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
835 19f9cf0f 2021-06-24 op telescope -c /dev/null
841 bba111bc 2021-03-28 op program was written by
842 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
844 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.