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 14071a5a 2021-08-14 op .Dd $Mdocdate: August 14 2021$
15 bba111bc 2021-03-28 op .Dt TELESCOPE 1
19 a19dd818 2021-08-03 op .Nd multi-protocol browser
24 c92e529c 2021-06-15 op .Op Fl c Pa config
27 bba111bc 2021-03-28 op .Sh DESCRIPTION
29 a19dd818 2021-08-03 op is an interactive browser that supports the Finger, Gemini and Gopher
32 a19dd818 2021-08-03 op features tabs, a minibuffer, interactive completions, bookmarks and
33 a19dd818 2021-08-03 op out-of-band TOFU verification.
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 9eb0c887 2021-08-03 op are invoked, the minibuffer area grows to show possible completions.
85 7ee780fa 2021-07-21 op aims to use the
86 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
89 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
90 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
91 bba111bc 2021-03-28 op .Bl -tag -width 12m
94 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
97 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
100 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
103 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
104 7ee780fa 2021-07-21 op indicated character.
106 bba111bc 2021-03-28 op Most of the time the
108 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
109 bba111bc 2021-03-28 op verify out-of-band the certificate.
111 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
112 bba111bc 2021-03-28 op verification though.
113 f1279523 2021-08-13 op .Sh SUPPORTED PROTOCOLS
114 f1279523 2021-08-13 op The following protocols are supported:
115 f1279523 2021-08-13 op .Bl -tag -width gemini://
117 f1279523 2021-08-13 op About pages are
119 f1279523 2021-08-13 op internal page.
120 f1279523 2021-08-13 op See about:about for a list of all these pages.
122 f1279523 2021-08-13 op File types know to
124 f1279523 2021-08-13 op such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
125 f1279523 2021-08-13 op viewed inside the application.
126 f1279523 2021-08-13 op Types of local files are detected solely based on the file extension.
127 f1279523 2021-08-13 op On some systems, such as
129 f1279523 2021-08-13 op only files inside special directories
130 f1279523 2021-08-13 op .Pq like Pa /tmp No or Pa ~/Downloads
131 f1279523 2021-08-13 op are available.
132 f1279523 2021-08-13 op .It finger://
133 f1279523 2021-08-13 op Finger URLs are interpreted as follows:
134 4a52e6fe 2021-08-03 op .Bl -bullet -compact
136 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
138 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
139 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
142 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
144 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
145 f1279523 2021-08-13 op are treated as the same URL.
146 f1279523 2021-08-13 op .It gemini://
147 f1279523 2021-08-13 op Gemini is fully supported, with the exception of client-certificates.
148 f1279523 2021-08-13 op .It gopher://
149 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
150 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
152 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
153 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
154 bba111bc 2021-03-28 op been taken to include also bindings familiar for
159 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
160 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
161 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
162 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
164 bba111bc 2021-03-28 op Keys are usually a single character, like
168 bba111bc 2021-03-28 op but some special keys are accepted as well.
170 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
180 bba111bc 2021-03-28 op Previous page/Page up
182 bba111bc 2021-03-28 op Next page/Page down
187 bba111bc 2021-03-28 op .It <f0> thru <f63>
188 bba111bc 2021-03-28 op Function keys
189 bba111bc 2021-03-28 op .It del or backspace
193 bba111bc 2021-03-28 op .It space or spc
195 bba111bc 2021-03-28 op .It enter or ret
200 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
203 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
204 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
206 7dbaef94 2021-04-22 op previous-line
212 7dbaef94 2021-04-22 op backward-char
214 7dbaef94 2021-04-22 op backward-paragraph
216 7dbaef94 2021-04-22 op forward-paragraph
218 7dbaef94 2021-04-22 op move-beginning-of-line
220 7dbaef94 2021-04-22 op move-end-of-line
221 bba111bc 2021-03-28 op .It M-v, M-space
223 bba111bc 2021-03-28 op .It C-v, space
226 7dbaef94 2021-04-22 op beginning-of-buffer
228 7dbaef94 2021-04-22 op end-of-buffer
230 7dbaef94 2021-04-22 op kill-telescope
232 7dbaef94 2021-04-22 op clear-minibuf
234 7dbaef94 2021-04-22 op execute-extended-command
236 61251035 2021-06-26 op dec-fill-column
238 61251035 2021-06-26 op inc-fill-column
240 1c412d48 2021-06-25 op previous-heading
246 f2ab2540 2021-07-14 op load-current-url
250 7dbaef94 2021-04-22 op load-current-url
256 7dbaef94 2021-04-22 op tab-close-other
268 7dbaef94 2021-04-22 op previous-page
272 7dbaef94 2021-04-22 op bookmark-page
273 bba111bc 2021-03-28 op .It <f7> <f7>
274 7dbaef94 2021-04-22 op list-bookmarks
276 12cf7d80 2021-07-15 op suspend-telescope
278 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
279 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
281 7dbaef94 2021-04-22 op previous-line
287 7dbaef94 2021-04-22 op backward-char
289 7dbaef94 2021-04-22 op backward-paragraph
291 7dbaef94 2021-04-22 op forward-paragraph
293 7dbaef94 2021-04-22 op move-beginning-of-line
295 7dbaef94 2021-04-22 op move-end-of-line
297 7dbaef94 2021-04-22 op scroll-line-up
299 7dbaef94 2021-04-22 op scroll-line-down
301 7dbaef94 2021-04-22 op beginning-of-buffer
303 7dbaef94 2021-04-22 op end-of-buffer
317 7dbaef94 2021-04-22 op previous-page
321 7dbaef94 2021-04-22 op kill-telescope
323 7dbaef94 2021-04-22 op clear-minibuf
325 7dbaef94 2021-04-22 op execute-extended-command
327 bba111bc 2021-03-28 op .Ss CUA-like keys
328 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
330 7dbaef94 2021-04-22 op previous-line
336 7dbaef94 2021-04-22 op backward-char
338 12cf7d80 2021-07-15 op move-beginning-of-line
340 12cf7d80 2021-07-15 op move-end-of-line
349 3c3af0fd 2021-07-08 op .It M-<prior>
354 7dbaef94 2021-04-22 op previous-page
355 bba111bc 2021-03-28 op .It M-<right>
362 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
363 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
369 7dbaef94 2021-04-22 op push-button-new-tab
371 7dbaef94 2021-04-22 op previous-button
373 8dc60352 2021-06-15 op previous-button
387 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
388 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
390 7dbaef94 2021-04-22 op mini-complete-and-exit
396 7dbaef94 2021-04-22 op mini-delete-char
398 7dbaef94 2021-04-22 op mini-delete-backward-char
399 bba111bc 2021-03-28 op .It backspace
400 7dbaef94 2021-04-22 op mini-delete-backward-char
402 7dbaef94 2021-04-22 op mini-delete-backward-char
404 7dbaef94 2021-04-22 op backward-char
408 7dbaef94 2021-04-22 op backward-char
412 7dbaef94 2021-04-22 op move-end-of-line
414 7dbaef94 2021-04-22 op move-beginning-of-line
416 7dbaef94 2021-04-22 op move-end-of-line
418 7dbaef94 2021-04-22 op move-beginning-of-line
420 7dbaef94 2021-04-22 op mini-kill-line
422 7dbaef94 2021-04-22 op mini-previous-history-element
424 7dbaef94 2021-04-22 op mini-next-history-element
426 e7b982f4 2021-07-14 op previous-completion
428 dffb2592 2021-07-14 op next-completion
430 dffb2592 2021-07-14 op previous-completion
432 e7b982f4 2021-07-14 op next-completion
434 e7b982f4 2021-07-14 op insert-current-candidate
436 7ee780fa 2021-07-21 op mini-goto-beginning
438 7ee780fa 2021-07-21 op mini-goto-end
440 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
441 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
442 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
443 bba111bc 2021-03-28 op .Ic execute-extended-command .
444 bba111bc 2021-03-28 op .Ss Movement commands
445 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
446 bba111bc 2021-03-28 op .It Ic backward-char
447 bba111bc 2021-03-28 op Move point one character backward.
448 bba111bc 2021-03-28 op .It Ic backward-paragraph
449 bba111bc 2021-03-28 op Move point one paragraph backward.
450 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
451 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
452 bba111bc 2021-03-28 op .It Ic end-of-buffer
453 bba111bc 2021-03-28 op Move point to the end of the buffer.
454 bba111bc 2021-03-28 op .It Ic forward-char
455 bba111bc 2021-03-28 op Move point one character forward.
456 bba111bc 2021-03-28 op .It Ic forward-paragraph
457 bba111bc 2021-03-28 op Move point one paragraph forward.
458 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
459 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
460 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
461 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
462 bba111bc 2021-03-28 op .It Ic move-end-of-line
463 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
464 bba111bc 2021-03-28 op .It Ic next-button
465 bba111bc 2021-03-28 op Move point to the next link.
466 e7b982f4 2021-07-14 op .It Ic next-completion
467 e7b982f4 2021-07-14 op Select the next completion.
468 1c412d48 2021-06-25 op .It Ic next-heading
469 1c412d48 2021-06-25 op Move point to the next heading.
470 bba111bc 2021-03-28 op .It Ic next-line
471 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
472 bba111bc 2021-03-28 op .It Ic previous-button
473 bba111bc 2021-03-28 op Move point to the previous link.
474 e7b982f4 2021-07-14 op .It Ic previous-completion
475 e7b982f4 2021-07-14 op Select the previous completion.
476 1c412d48 2021-06-25 op .It Ic previous-heading
477 1c412d48 2021-06-25 op Move point to the previous heading.
478 bba111bc 2021-03-28 op .It Ic previous-line
479 bba111bc 2021-03-28 op Move point to the previous (visual) line.
481 bba111bc 2021-03-28 op .Ss Bookmark-related commands
482 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
483 bba111bc 2021-03-28 op .It Ic bookmark-page
484 b3be07ea 2021-07-18 op Save a page in the bookmark file.
485 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
486 63875195 2021-04-01 op .It Ic list-bookmarks
487 bba111bc 2021-03-28 op Load the bookmarks page.
489 bba111bc 2021-03-28 op .Ss Tab-related commands
490 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
491 bba111bc 2021-03-28 op .It Ic tab-close
492 bba111bc 2021-03-28 op Close the current tab.
493 bba111bc 2021-03-28 op .It Ic tab-close-other
494 bba111bc 2021-03-28 op Close all tabs but the current one.
495 bba111bc 2021-03-28 op .It Ic tab-move
496 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
498 bba111bc 2021-03-28 op .It Ic tab-move-to
499 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
500 bba111bc 2021-03-28 op .It Ic tab-new
501 bba111bc 2021-03-28 op Open a new tab.
502 bba111bc 2021-03-28 op .It Ic tab-next
503 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
504 bba111bc 2021-03-28 op .It Ic tab-previous
505 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
506 3360ef1b 2021-07-14 op .It Ic tab-select
507 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
509 bba111bc 2021-03-28 op .Ss Misc commands
510 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
511 bba111bc 2021-03-28 op .It Ic clear-minibuf
512 b3be07ea 2021-07-18 op Clear the echo area.
513 61251035 2021-06-26 op .It Ic dec-fill-column
514 b3be07ea 2021-07-18 op Decrement fill-column by two.
515 bba111bc 2021-03-28 op .It Ic execute-extended-command
516 b3be07ea 2021-07-18 op Execute an internal command.
517 bba111bc 2021-03-28 op .It Ic kill-telescope
520 61251035 2021-06-26 op .It Ic inc-fill-column
521 b3be07ea 2021-07-18 op Increment fill-column by two.
522 753c6ac7 2021-07-14 op .It Ic link-select
523 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
524 bba111bc 2021-03-28 op .It Ic load-current-url
525 b3be07ea 2021-07-18 op Edit the current URL.
526 bba111bc 2021-03-28 op .It Ic load-url
527 b3be07ea 2021-07-18 op Prompt for an URL.
528 bba111bc 2021-03-28 op .It Ic next-page
529 b3be07ea 2021-07-18 op Go forward in the page history.
530 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
531 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
533 9a7d62cb 2021-07-21 op .It Ic other-window
534 9a7d62cb 2021-07-21 op Select the other window.
535 bba111bc 2021-03-28 op .It Ic previous-page
536 b3be07ea 2021-07-18 op Go backward in the page history.
537 bba111bc 2021-03-28 op .It Ic push-button
538 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
539 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
540 bba111bc 2021-03-28 op .It Ic push-button-new-tab
541 b3be07ea 2021-07-18 op Follow link at point in a new tab.
542 bba111bc 2021-03-28 op .It Ic redraw
543 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
545 661233ed 2021-07-14 op .It Ic reload-page
546 661233ed 2021-07-14 op Reload the current page.
547 bba111bc 2021-03-28 op .It Ic scroll-down
548 bba111bc 2021-03-28 op Scroll down by one visual page.
549 bba111bc 2021-03-28 op .It Ic scroll-line-down
550 bba111bc 2021-03-28 op Scroll down by one line.
551 bba111bc 2021-03-28 op .It Ic scroll-line-up
552 bba111bc 2021-03-28 op Scroll up by one line.
553 bba111bc 2021-03-28 op .It Ic scroll-up
554 bba111bc 2021-03-28 op Scroll up by one visual page.
555 12cf7d80 2021-07-15 op .It Ic suspend-telescope
556 12cf7d80 2021-07-15 op Suspend the current
559 753c6ac7 2021-07-14 op .It Ic swiper
560 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
562 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
563 7a014cef 2021-04-01 op .It Ic toggle-help
564 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
565 7a014cef 2021-04-01 op interactive command.
566 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
567 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
569 bba111bc 2021-03-28 op .Ss Minibuffer commands
570 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
571 bba111bc 2021-03-28 op .It Ic mini-abort
572 bba111bc 2021-03-28 op Abort the current minibuffer action.
573 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
574 bba111bc 2021-03-28 op Complete the current minibuffer action.
575 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
576 bba111bc 2021-03-28 op Delete the character before the point.
577 bba111bc 2021-03-28 op .It Ic mini-delete-char
578 bba111bc 2021-03-28 op Delete the character after the point.
579 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
580 de190a2b 2021-07-17 op Select the first completion, if any.
581 de190a2b 2021-07-17 op .It Ic mini-goto-end
582 de190a2b 2021-07-17 op Select the last completion, if any.
583 bba111bc 2021-03-28 op .It Ic mini-kill-line
584 b3be07ea 2021-07-18 op Delete from point until the end of the line.
585 bba111bc 2021-03-28 op .It Ic mini-next-history-element
586 bba111bc 2021-03-28 op Load the previous history element.
587 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
588 bba111bc 2021-03-28 op Load the next history element.
591 7d2d15f5 2021-04-30 op The following aliases are available during
592 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
593 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
596 c82b3fd6 2021-05-12 op .It Ic tabnew
599 c82b3fd6 2021-05-12 op .Ic tab-previous
600 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
601 7d2d15f5 2021-04-30 op .Ic kill-telescope
603 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
604 74ca8ef4 2021-06-19 op During the startup,
606 74ca8ef4 2021-06-19 op reads the configuration file at
607 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
608 74ca8ef4 2021-06-19 op or the one given with the
613 21404dd9 2021-07-15 op will also load a file called
614 21404dd9 2021-07-15 op .Pa config-TERM ,
617 21404dd9 2021-07-15 op is the name of the terminal type
618 7ee780fa 2021-07-21 op .Pq i.e. the TERM environment variable ,
619 7ee780fa 2021-07-21 op if it exists.
621 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
622 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
625 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
627 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
628 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
630 74ca8ef4 2021-06-19 op The following constructs are available:
631 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
632 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
635 138421e8 2021-06-25 op to the function
637 138421e8 2021-06-25 op in the keymap
639 138421e8 2021-06-25 op Valid values for map are
640 138421e8 2021-06-25 op .Dq global-map
641 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
643 138421e8 2021-06-25 op .Dq minibuffer-map
644 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
646 138421e8 2021-06-25 op follows the same syntax described in
647 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
648 138421e8 2021-06-25 op and all the possible functions are listed in
649 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
650 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
653 90d8329a 2021-06-25 op as proxy for all URLs with
657 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
658 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
659 74ca8ef4 2021-06-19 op Set the option
663 74ca8ef4 2021-06-19 op Valid options are:
665 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
668 5c6ed3a9 2021-08-14 op If greater than zero, save the session after the specified amount of
669 5c6ed3a9 2021-08-14 op seconds after some events happens
670 5c6ed3a9 2021-08-14 op .Pq new or closed tabs, visited a link ...
671 5c6ed3a9 2021-08-14 op Defaults to 20.
672 88693f61 2021-07-15 op .It dont-wrap-pre
674 88693f61 2021-07-15 op If nonzero, don't wrap preformatted blocks.
675 7ee780fa 2021-07-21 op Defaults to 0.
676 59ae0cdc 2021-07-16 op .It emojify-link
678 7ee780fa 2021-07-21 op If nonzero, when the text of a link starts with an emoji followed by a
679 7ee780fa 2021-07-21 op space, use that emoji as line prefix.
680 59ae0cdc 2021-07-16 op Defaults to 1.
681 2c748a1f 2021-06-21 op .It enable-colors
683 7ee780fa 2021-07-21 op If nonzero, enable colours.
684 7ee780fa 2021-07-21 op Defaults to 0 if
685 2c748a1f 2021-06-21 op .Ev NO_COLORS
686 7ee780fa 2021-07-21 op is set, 1 otherwise.
687 74ca8ef4 2021-06-19 op .It fill-column
689 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
690 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
691 7ee780fa 2021-07-21 op Defaults to 80.
692 b1379f34 2021-07-05 op .It hide-pre-blocks
694 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
695 7ee780fa 2021-07-21 op Defaults to zero.
696 b1379f34 2021-07-05 op .Ic push-button
697 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
698 144733a7 2021-07-15 op .It hide-pre-closing-line
700 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
701 7ee780fa 2021-07-21 op Defaults to 0.
702 b1379f34 2021-07-05 op .It hide-pre-context
704 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
705 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
706 b1379f34 2021-07-05 op blocks are irremediably hidden.
707 7ee780fa 2021-07-21 op Defaults to zero.
708 74ca8ef4 2021-06-19 op .It new-tab-url
710 41a9ae40 2021-06-20 op URL for the new tab page.
712 41a9ae40 2021-06-20 op .Dq about:new .
713 74ca8ef4 2021-06-19 op .It olivetti-mode
715 7ee780fa 2021-07-21 op If nonzero, enable
716 74ca8ef4 2021-06-19 op .Ic olivetti-mode
717 7ee780fa 2021-07-21 op Defaults to 1.
718 9886bf97 2021-07-17 op .It set-title
720 7ee780fa 2021-07-21 op If nonzero, set the terminal title to the page title.
721 9886bf97 2021-07-17 op Defaults to 1.
723 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
724 74ca8ef4 2021-06-19 op Change the styling of the element identified by
726 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
727 74ca8ef4 2021-06-19 op Valid style identifiers are:
728 7ee780fa 2021-07-21 op .Bl -tag -width line.compl.current -compact -offset Ds
730 7ee780fa 2021-07-21 op the area outside the lines in the body of the page.
731 45fe2472 2021-07-14 op .It line.compl
732 7ee780fa 2021-07-21 op the completions.
733 45fe2472 2021-07-14 op .It line.compl.current
734 7ee780fa 2021-07-21 op the current completion.
735 75fd746b 2021-07-21 op .It line.help
736 75fd746b 2021-07-21 op text in the *Help* buffer.
737 74ca8ef4 2021-06-19 op .It line.text
739 74bc52e8 2021-06-25 op .It line.link
741 74ca8ef4 2021-06-19 op .It line.title1..3
743 74ca8ef4 2021-06-19 op .It line.item
745 74ca8ef4 2021-06-19 op .It line.quote
747 74ca8ef4 2021-06-19 op .It line.pre.start
748 7ee780fa 2021-07-21 op the heading of a preformatted block.
750 7ee780fa 2021-07-21 op the content of a preformatted block.
751 74ca8ef4 2021-06-19 op .It line.pre.end
752 7ee780fa 2021-07-21 op the closing line of a preformatted block.
753 eaf1a84b 2021-06-25 op .It minibuffer
754 7ee780fa 2021-07-21 op the minibuffer.
756 7ee780fa 2021-07-21 op the modeline.
759 74bc52e8 2021-06-25 op .It tabline.tab
760 7ee780fa 2021-07-21 op the non-focused tabs.
761 74bc52e8 2021-06-25 op .It tabline.current
762 7ee780fa 2021-07-21 op the focused tab.
765 74ca8ef4 2021-06-19 op Valid options are:
766 ab728b01 2021-06-22 op .Bl -tag -width Ds
767 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
768 ab728b01 2021-06-22 op Sets the text attributes.
769 ab728b01 2021-06-22 op If only one value is given,
773 ab728b01 2021-06-22 op default to that; if two values are given then
777 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
778 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
779 ab728b01 2021-06-22 op .It Ic normal
780 ab728b01 2021-06-22 op no attributes.
781 ab728b01 2021-06-22 op .It Ic standout
782 ab728b01 2021-06-22 op best highlighting mode for the terminal.
783 ab728b01 2021-06-22 op .It Ic underline
784 ab728b01 2021-06-22 op underlines the text.
785 ab728b01 2021-06-22 op .It Ic reverse
786 ab728b01 2021-06-22 op reverses background/foreground colors.
788 ab728b01 2021-06-22 op makes the text blinking.
792 ab728b01 2021-06-22 op extra bright or bold.
795 7ee780fa 2021-07-21 op Only the style identifiers with the
797 74bc52e8 2021-06-25 op prefix accept up to three attributes.
798 74bc52e8 2021-06-25 op The other will only use the first one given.
799 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
800 ab728b01 2021-06-22 op Sets the background color.
801 ab728b01 2021-06-22 op Follows the same behaviour as
803 ab728b01 2021-06-22 op regarding the optional parameters.
804 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
805 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
806 ae844a00 2021-06-25 op .Pq or color0 to color255
807 ae844a00 2021-06-25 op from the 256-colour set;
808 ae844a00 2021-06-25 op default for the default colour.
809 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
810 ab728b01 2021-06-22 op Sets the foreground color.
811 ab728b01 2021-06-22 op It behaves just like
813 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
814 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
818 ab728b01 2021-06-22 op as the prefix for the continuation lines
819 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
822 ab728b01 2021-06-22 op is not given its value will be the same of
826 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
829 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
830 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
832 7ee780fa 2021-07-21 op The user's login directory.
833 7ee780fa 2021-07-21 op .It Ev NO_COLORS
834 7ee780fa 2021-07-21 op To decide whether to use colors or not.
835 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
837 7ee780fa 2021-07-21 op The user's terminal name.
840 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
841 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
842 7ee780fa 2021-07-21 op Bookmarks file.
843 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
844 dca97b00 2021-06-19 op Default configuration file.
845 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
846 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
847 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
848 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
849 d0fd368a 2021-07-15 op .It Pa ~/.telescope/lock
850 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
852 d0fd368a 2021-07-15 op from running at the same time.
853 56e7efb4 2021-07-21 op .It Pa ~/.telescope/pages/about_*.gmi
854 56e7efb4 2021-07-21 op Overrides for built-in about: pages.
855 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
856 7ee780fa 2021-07-21 op The list of tabs from the last session.
857 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
858 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
860 87e3e801 2021-07-17 op Is written by
861 e9b1e094 2021-04-01 op .Ic kill-telescope
862 7ee780fa 2021-07-21 op and loaded during startup.
865 984245ce 2021-06-23 op It's possible to browse
866 984245ce 2021-06-23 op .Dq the small web
867 984245ce 2021-06-23 op .Pq i.e. simple websites
868 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
869 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
870 984245ce 2021-06-23 op .Bd -literal -offset indent
871 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
872 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
877 7ee780fa 2021-07-21 op without any configuration
878 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
879 19f9cf0f 2021-06-24 op telescope -c /dev/null
885 bba111bc 2021-03-28 op program was written by
886 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
888 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.
