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).
153 eb6e7b8a 2021-08-16 op User-entered URLs, given as argument on the command line or entered
155 eb6e7b8a 2021-08-16 op .Ic load-url ,
156 eb6e7b8a 2021-08-16 op are intepreted with a simple heuristic:
157 eb6e7b8a 2021-08-16 op .Bl -bullet -compact
159 eb6e7b8a 2021-08-16 op if it's a proper absolute URL then use it as-is,
161 eb6e7b8a 2021-08-16 op if it starts with
165 eb6e7b8a 2021-08-16 op assume it's a file:// URL,
167 eb6e7b8a 2021-08-16 op otherwise assume it's a Gemini URL.
169 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
170 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
171 bba111bc 2021-03-28 op been taken to include also bindings familiar for
176 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
177 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
178 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
179 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
181 bba111bc 2021-03-28 op Keys are usually a single character, like
185 bba111bc 2021-03-28 op but some special keys are accepted as well.
187 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
197 bba111bc 2021-03-28 op Previous page/Page up
199 bba111bc 2021-03-28 op Next page/Page down
204 bba111bc 2021-03-28 op .It <f0> thru <f63>
205 bba111bc 2021-03-28 op Function keys
206 bba111bc 2021-03-28 op .It del or backspace
210 bba111bc 2021-03-28 op .It space or spc
212 bba111bc 2021-03-28 op .It enter or ret
217 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
220 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
221 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
223 7dbaef94 2021-04-22 op previous-line
229 7dbaef94 2021-04-22 op backward-char
231 7dbaef94 2021-04-22 op backward-paragraph
233 7dbaef94 2021-04-22 op forward-paragraph
235 7dbaef94 2021-04-22 op move-beginning-of-line
237 7dbaef94 2021-04-22 op move-end-of-line
238 bba111bc 2021-03-28 op .It M-v, M-space
240 bba111bc 2021-03-28 op .It C-v, space
243 7dbaef94 2021-04-22 op beginning-of-buffer
245 7dbaef94 2021-04-22 op end-of-buffer
247 7dbaef94 2021-04-22 op kill-telescope
249 7dbaef94 2021-04-22 op clear-minibuf
251 7dbaef94 2021-04-22 op execute-extended-command
253 61251035 2021-06-26 op dec-fill-column
255 61251035 2021-06-26 op inc-fill-column
257 1c412d48 2021-06-25 op previous-heading
263 f2ab2540 2021-07-14 op load-current-url
267 7dbaef94 2021-04-22 op load-current-url
273 7dbaef94 2021-04-22 op tab-close-other
285 7dbaef94 2021-04-22 op previous-page
289 7dbaef94 2021-04-22 op bookmark-page
290 bba111bc 2021-03-28 op .It <f7> <f7>
291 7dbaef94 2021-04-22 op list-bookmarks
293 12cf7d80 2021-07-15 op suspend-telescope
295 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
296 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
298 7dbaef94 2021-04-22 op previous-line
304 7dbaef94 2021-04-22 op backward-char
306 7dbaef94 2021-04-22 op backward-paragraph
308 7dbaef94 2021-04-22 op forward-paragraph
310 7dbaef94 2021-04-22 op move-beginning-of-line
312 7dbaef94 2021-04-22 op move-end-of-line
314 7dbaef94 2021-04-22 op scroll-line-up
316 7dbaef94 2021-04-22 op scroll-line-down
318 7dbaef94 2021-04-22 op beginning-of-buffer
320 7dbaef94 2021-04-22 op end-of-buffer
334 7dbaef94 2021-04-22 op previous-page
338 7dbaef94 2021-04-22 op kill-telescope
340 7dbaef94 2021-04-22 op clear-minibuf
342 7dbaef94 2021-04-22 op execute-extended-command
344 bba111bc 2021-03-28 op .Ss CUA-like keys
345 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
347 7dbaef94 2021-04-22 op previous-line
353 7dbaef94 2021-04-22 op backward-char
355 12cf7d80 2021-07-15 op move-beginning-of-line
357 12cf7d80 2021-07-15 op move-end-of-line
366 3c3af0fd 2021-07-08 op .It M-<prior>
371 7dbaef94 2021-04-22 op previous-page
372 bba111bc 2021-03-28 op .It M-<right>
379 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
380 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
386 7dbaef94 2021-04-22 op push-button-new-tab
388 7dbaef94 2021-04-22 op previous-button
390 8dc60352 2021-06-15 op previous-button
408 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
409 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
411 7dbaef94 2021-04-22 op mini-complete-and-exit
417 7dbaef94 2021-04-22 op mini-delete-char
419 7dbaef94 2021-04-22 op mini-delete-backward-char
420 bba111bc 2021-03-28 op .It backspace
421 7dbaef94 2021-04-22 op mini-delete-backward-char
423 7dbaef94 2021-04-22 op mini-delete-backward-char
425 7dbaef94 2021-04-22 op backward-char
429 7dbaef94 2021-04-22 op backward-char
433 7dbaef94 2021-04-22 op move-end-of-line
435 7dbaef94 2021-04-22 op move-beginning-of-line
437 7dbaef94 2021-04-22 op move-end-of-line
439 7dbaef94 2021-04-22 op move-beginning-of-line
441 7dbaef94 2021-04-22 op mini-kill-line
443 7dbaef94 2021-04-22 op mini-previous-history-element
445 7dbaef94 2021-04-22 op mini-next-history-element
447 e7b982f4 2021-07-14 op previous-completion
449 dffb2592 2021-07-14 op next-completion
451 dffb2592 2021-07-14 op previous-completion
453 e7b982f4 2021-07-14 op next-completion
455 e7b982f4 2021-07-14 op insert-current-candidate
457 7ee780fa 2021-07-21 op mini-goto-beginning
459 7ee780fa 2021-07-21 op mini-goto-end
461 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
462 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
463 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
464 bba111bc 2021-03-28 op .Ic execute-extended-command .
465 bba111bc 2021-03-28 op .Ss Movement commands
466 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
467 bba111bc 2021-03-28 op .It Ic backward-char
468 bba111bc 2021-03-28 op Move point one character backward.
469 bba111bc 2021-03-28 op .It Ic backward-paragraph
470 bba111bc 2021-03-28 op Move point one paragraph backward.
471 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
472 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
473 bba111bc 2021-03-28 op .It Ic end-of-buffer
474 bba111bc 2021-03-28 op Move point to the end of the buffer.
475 bba111bc 2021-03-28 op .It Ic forward-char
476 bba111bc 2021-03-28 op Move point one character forward.
477 bba111bc 2021-03-28 op .It Ic forward-paragraph
478 bba111bc 2021-03-28 op Move point one paragraph forward.
479 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
480 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
481 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
482 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
483 bba111bc 2021-03-28 op .It Ic move-end-of-line
484 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
485 bba111bc 2021-03-28 op .It Ic next-button
486 bba111bc 2021-03-28 op Move point to the next link.
487 e7b982f4 2021-07-14 op .It Ic next-completion
488 e7b982f4 2021-07-14 op Select the next completion.
489 1c412d48 2021-06-25 op .It Ic next-heading
490 1c412d48 2021-06-25 op Move point to the next heading.
491 bba111bc 2021-03-28 op .It Ic next-line
492 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
493 bba111bc 2021-03-28 op .It Ic previous-button
494 bba111bc 2021-03-28 op Move point to the previous link.
495 e7b982f4 2021-07-14 op .It Ic previous-completion
496 e7b982f4 2021-07-14 op Select the previous completion.
497 1c412d48 2021-06-25 op .It Ic previous-heading
498 1c412d48 2021-06-25 op Move point to the previous heading.
499 bba111bc 2021-03-28 op .It Ic previous-line
500 bba111bc 2021-03-28 op Move point to the previous (visual) line.
502 bba111bc 2021-03-28 op .Ss Bookmark-related commands
503 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
504 bba111bc 2021-03-28 op .It Ic bookmark-page
505 b3be07ea 2021-07-18 op Save a page in the bookmark file.
506 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
507 63875195 2021-04-01 op .It Ic list-bookmarks
508 bba111bc 2021-03-28 op Load the bookmarks page.
510 bba111bc 2021-03-28 op .Ss Tab-related commands
511 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
512 bba111bc 2021-03-28 op .It Ic tab-close
513 bba111bc 2021-03-28 op Close the current tab.
514 bba111bc 2021-03-28 op .It Ic tab-close-other
515 bba111bc 2021-03-28 op Close all tabs but the current one.
516 bba111bc 2021-03-28 op .It Ic tab-move
517 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
519 bba111bc 2021-03-28 op .It Ic tab-move-to
520 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
521 bba111bc 2021-03-28 op .It Ic tab-new
522 bba111bc 2021-03-28 op Open a new tab.
523 bba111bc 2021-03-28 op .It Ic tab-next
524 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
525 bba111bc 2021-03-28 op .It Ic tab-previous
526 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
527 3360ef1b 2021-07-14 op .It Ic tab-select
528 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
530 bba111bc 2021-03-28 op .Ss Misc commands
531 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
532 bba111bc 2021-03-28 op .It Ic clear-minibuf
533 b3be07ea 2021-07-18 op Clear the echo area.
534 61251035 2021-06-26 op .It Ic dec-fill-column
535 b3be07ea 2021-07-18 op Decrement fill-column by two.
536 bba111bc 2021-03-28 op .It Ic execute-extended-command
537 b3be07ea 2021-07-18 op Execute an internal command.
538 bba111bc 2021-03-28 op .It Ic kill-telescope
541 61251035 2021-06-26 op .It Ic inc-fill-column
542 b3be07ea 2021-07-18 op Increment fill-column by two.
543 753c6ac7 2021-07-14 op .It Ic link-select
544 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
545 bba111bc 2021-03-28 op .It Ic load-current-url
546 b3be07ea 2021-07-18 op Edit the current URL.
547 bba111bc 2021-03-28 op .It Ic load-url
548 b3be07ea 2021-07-18 op Prompt for an URL.
549 bba111bc 2021-03-28 op .It Ic next-page
550 b3be07ea 2021-07-18 op Go forward in the page history.
551 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
552 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
554 9a7d62cb 2021-07-21 op .It Ic other-window
555 9a7d62cb 2021-07-21 op Select the other window.
556 bba111bc 2021-03-28 op .It Ic previous-page
557 b3be07ea 2021-07-18 op Go backward in the page history.
558 bba111bc 2021-03-28 op .It Ic push-button
559 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
560 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
561 bba111bc 2021-03-28 op .It Ic push-button-new-tab
562 b3be07ea 2021-07-18 op Follow link at point in a new tab.
563 bba111bc 2021-03-28 op .It Ic redraw
564 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
566 661233ed 2021-07-14 op .It Ic reload-page
567 661233ed 2021-07-14 op Reload the current page.
568 bba111bc 2021-03-28 op .It Ic scroll-down
569 bba111bc 2021-03-28 op Scroll down by one visual page.
570 bba111bc 2021-03-28 op .It Ic scroll-line-down
571 bba111bc 2021-03-28 op Scroll down by one line.
572 bba111bc 2021-03-28 op .It Ic scroll-line-up
573 bba111bc 2021-03-28 op Scroll up by one line.
574 bba111bc 2021-03-28 op .It Ic scroll-up
575 bba111bc 2021-03-28 op Scroll up by one visual page.
576 12cf7d80 2021-07-15 op .It Ic suspend-telescope
577 12cf7d80 2021-07-15 op Suspend the current
580 753c6ac7 2021-07-14 op .It Ic swiper
581 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
583 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
584 7a014cef 2021-04-01 op .It Ic toggle-help
585 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
586 7a014cef 2021-04-01 op interactive command.
587 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
588 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
590 bba111bc 2021-03-28 op .Ss Minibuffer commands
591 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
592 bba111bc 2021-03-28 op .It Ic mini-abort
593 bba111bc 2021-03-28 op Abort the current minibuffer action.
594 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
595 bba111bc 2021-03-28 op Complete the current minibuffer action.
596 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
597 bba111bc 2021-03-28 op Delete the character before the point.
598 bba111bc 2021-03-28 op .It Ic mini-delete-char
599 bba111bc 2021-03-28 op Delete the character after the point.
600 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
601 de190a2b 2021-07-17 op Select the first completion, if any.
602 de190a2b 2021-07-17 op .It Ic mini-goto-end
603 de190a2b 2021-07-17 op Select the last completion, if any.
604 bba111bc 2021-03-28 op .It Ic mini-kill-line
605 b3be07ea 2021-07-18 op Delete from point until the end of the line.
606 bba111bc 2021-03-28 op .It Ic mini-next-history-element
607 bba111bc 2021-03-28 op Load the previous history element.
608 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
609 bba111bc 2021-03-28 op Load the next history element.
612 7d2d15f5 2021-04-30 op The following aliases are available during
613 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
614 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
617 c82b3fd6 2021-05-12 op .It Ic tabnew
620 c82b3fd6 2021-05-12 op .Ic tab-previous
621 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
622 7d2d15f5 2021-04-30 op .Ic kill-telescope
624 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
625 74ca8ef4 2021-06-19 op During the startup,
627 74ca8ef4 2021-06-19 op reads the configuration file at
628 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
629 74ca8ef4 2021-06-19 op or the one given with the
634 21404dd9 2021-07-15 op will also load a file called
635 21404dd9 2021-07-15 op .Pa config-TERM ,
638 21404dd9 2021-07-15 op is the name of the terminal type
639 7ee780fa 2021-07-21 op .Pq i.e. the TERM environment variable ,
640 7ee780fa 2021-07-21 op if it exists.
642 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
643 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
646 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
648 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
649 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
651 74ca8ef4 2021-06-19 op The following constructs are available:
652 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
653 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
656 138421e8 2021-06-25 op to the function
658 138421e8 2021-06-25 op in the keymap
660 138421e8 2021-06-25 op Valid values for map are
661 138421e8 2021-06-25 op .Dq global-map
662 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
664 138421e8 2021-06-25 op .Dq minibuffer-map
665 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
667 138421e8 2021-06-25 op follows the same syntax described in
668 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
669 138421e8 2021-06-25 op and all the possible functions are listed in
670 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
671 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
674 90d8329a 2021-06-25 op as proxy for all URLs with
678 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
679 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
680 74ca8ef4 2021-06-19 op Set the option
684 74ca8ef4 2021-06-19 op Valid options are:
686 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
689 5c6ed3a9 2021-08-14 op If greater than zero, save the session after the specified amount of
690 5c6ed3a9 2021-08-14 op seconds after some events happens
691 5c6ed3a9 2021-08-14 op .Pq new or closed tabs, visited a link ...
692 5c6ed3a9 2021-08-14 op Defaults to 20.
693 88693f61 2021-07-15 op .It dont-wrap-pre
695 88693f61 2021-07-15 op If nonzero, don't wrap preformatted blocks.
696 7ee780fa 2021-07-21 op Defaults to 0.
697 59ae0cdc 2021-07-16 op .It emojify-link
699 7ee780fa 2021-07-21 op If nonzero, when the text of a link starts with an emoji followed by a
700 7ee780fa 2021-07-21 op space, use that emoji as line prefix.
701 59ae0cdc 2021-07-16 op Defaults to 1.
702 2c748a1f 2021-06-21 op .It enable-colors
704 7ee780fa 2021-07-21 op If nonzero, enable colours.
705 7ee780fa 2021-07-21 op Defaults to 0 if
706 2c748a1f 2021-06-21 op .Ev NO_COLORS
707 7ee780fa 2021-07-21 op is set, 1 otherwise.
708 74ca8ef4 2021-06-19 op .It fill-column
710 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
711 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
712 7ee780fa 2021-07-21 op Defaults to 80.
713 b1379f34 2021-07-05 op .It hide-pre-blocks
715 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
716 7ee780fa 2021-07-21 op Defaults to zero.
717 b1379f34 2021-07-05 op .Ic push-button
718 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
719 144733a7 2021-07-15 op .It hide-pre-closing-line
721 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
722 7ee780fa 2021-07-21 op Defaults to 0.
723 b1379f34 2021-07-05 op .It hide-pre-context
725 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
726 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
727 b1379f34 2021-07-05 op blocks are irremediably hidden.
728 7ee780fa 2021-07-21 op Defaults to zero.
729 74ca8ef4 2021-06-19 op .It new-tab-url
731 41a9ae40 2021-06-20 op URL for the new tab page.
733 41a9ae40 2021-06-20 op .Dq about:new .
734 74ca8ef4 2021-06-19 op .It olivetti-mode
736 7ee780fa 2021-07-21 op If nonzero, enable
737 74ca8ef4 2021-06-19 op .Ic olivetti-mode
738 7ee780fa 2021-07-21 op Defaults to 1.
739 9886bf97 2021-07-17 op .It set-title
741 7ee780fa 2021-07-21 op If nonzero, set the terminal title to the page title.
742 b3c59b13 2021-08-18 op Defaults to 1.
743 b3c59b13 2021-08-18 op .It tab-bar-show
745 b3c59b13 2021-08-18 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
746 b3c59b13 2021-08-18 op unconditionally.
747 b3c59b13 2021-08-18 op If it's 1, show the bar only when there is more than one tab.
748 9886bf97 2021-07-17 op Defaults to 1.
750 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
751 74ca8ef4 2021-06-19 op Change the styling of the element identified by
753 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
754 74ca8ef4 2021-06-19 op Valid style identifiers are:
755 7ee780fa 2021-07-21 op .Bl -tag -width line.compl.current -compact -offset Ds
757 7ee780fa 2021-07-21 op the area outside the lines in the body of the page.
758 45fe2472 2021-07-14 op .It line.compl
759 7ee780fa 2021-07-21 op the completions.
760 45fe2472 2021-07-14 op .It line.compl.current
761 7ee780fa 2021-07-21 op the current completion.
762 75fd746b 2021-07-21 op .It line.help
763 75fd746b 2021-07-21 op text in the *Help* buffer.
764 74ca8ef4 2021-06-19 op .It line.text
766 74bc52e8 2021-06-25 op .It line.link
768 74ca8ef4 2021-06-19 op .It line.title1..3
770 74ca8ef4 2021-06-19 op .It line.item
772 74ca8ef4 2021-06-19 op .It line.quote
774 74ca8ef4 2021-06-19 op .It line.pre.start
775 7ee780fa 2021-07-21 op the heading of a preformatted block.
777 7ee780fa 2021-07-21 op the content of a preformatted block.
778 74ca8ef4 2021-06-19 op .It line.pre.end
779 7ee780fa 2021-07-21 op the closing line of a preformatted block.
780 eaf1a84b 2021-06-25 op .It minibuffer
781 7ee780fa 2021-07-21 op the minibuffer.
783 7ee780fa 2021-07-21 op the modeline.
786 74bc52e8 2021-06-25 op .It tabline.tab
787 7ee780fa 2021-07-21 op the non-focused tabs.
788 74bc52e8 2021-06-25 op .It tabline.current
789 7ee780fa 2021-07-21 op the focused tab.
792 74ca8ef4 2021-06-19 op Valid options are:
793 ab728b01 2021-06-22 op .Bl -tag -width Ds
794 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
795 ab728b01 2021-06-22 op Sets the text attributes.
796 ab728b01 2021-06-22 op If only one value is given,
800 ab728b01 2021-06-22 op default to that; if two values are given then
804 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
805 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
806 ab728b01 2021-06-22 op .It Ic normal
807 ab728b01 2021-06-22 op no attributes.
808 ab728b01 2021-06-22 op .It Ic standout
809 ab728b01 2021-06-22 op best highlighting mode for the terminal.
810 ab728b01 2021-06-22 op .It Ic underline
811 ab728b01 2021-06-22 op underlines the text.
812 ab728b01 2021-06-22 op .It Ic reverse
813 ab728b01 2021-06-22 op reverses background/foreground colors.
815 ab728b01 2021-06-22 op makes the text blinking.
819 ab728b01 2021-06-22 op extra bright or bold.
822 7ee780fa 2021-07-21 op Only the style identifiers with the
824 74bc52e8 2021-06-25 op prefix accept up to three attributes.
825 74bc52e8 2021-06-25 op The other will only use the first one given.
826 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
827 ab728b01 2021-06-22 op Sets the background color.
828 ab728b01 2021-06-22 op Follows the same behaviour as
830 ab728b01 2021-06-22 op regarding the optional parameters.
831 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
832 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
833 ae844a00 2021-06-25 op .Pq or color0 to color255
834 ae844a00 2021-06-25 op from the 256-colour set;
835 ae844a00 2021-06-25 op default for the default colour.
836 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
837 ab728b01 2021-06-22 op Sets the foreground color.
838 ab728b01 2021-06-22 op It behaves just like
840 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
841 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
845 ab728b01 2021-06-22 op as the prefix for the continuation lines
846 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
849 ab728b01 2021-06-22 op is not given its value will be the same of
853 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
856 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
857 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
859 7ee780fa 2021-07-21 op The user's login directory.
860 7ee780fa 2021-07-21 op .It Ev NO_COLORS
861 7ee780fa 2021-07-21 op To decide whether to use colors or not.
862 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
864 7ee780fa 2021-07-21 op The user's terminal name.
867 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
868 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
869 7ee780fa 2021-07-21 op Bookmarks file.
870 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
871 dca97b00 2021-06-19 op Default configuration file.
872 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
873 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
874 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
875 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
876 d0fd368a 2021-07-15 op .It Pa ~/.telescope/lock
877 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
879 d0fd368a 2021-07-15 op from running at the same time.
880 56e7efb4 2021-07-21 op .It Pa ~/.telescope/pages/about_*.gmi
881 56e7efb4 2021-07-21 op Overrides for built-in about: pages.
882 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
883 7ee780fa 2021-07-21 op The list of tabs from the last session.
884 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
885 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
887 87e3e801 2021-07-17 op Is written by
888 e9b1e094 2021-04-01 op .Ic kill-telescope
889 7ee780fa 2021-07-21 op and loaded during startup.
892 984245ce 2021-06-23 op It's possible to browse
893 984245ce 2021-06-23 op .Dq the small web
894 984245ce 2021-06-23 op .Pq i.e. simple websites
895 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
896 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
897 984245ce 2021-06-23 op .Bd -literal -offset indent
898 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
899 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
904 7ee780fa 2021-07-21 op without any configuration
905 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
906 19f9cf0f 2021-06-24 op telescope -c /dev/null
912 bba111bc 2021-03-28 op program was written by
913 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
915 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.
