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 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 4a52e6fe 2021-08-03 op .Sh FINGER SUPPORT
115 4a52e6fe 2021-08-03 op has native support for querying finger servers.
116 4a52e6fe 2021-08-03 op While this is easily doable using the
118 4a52e6fe 2021-08-03 op utility, given that finger URLs do appear on occasion in the
119 4a52e6fe 2021-08-03 op gopherspace and in the geminispace, it's nice to be able to open them
123 4a52e6fe 2021-08-03 op interprets finger:// URLs as follows:
124 4a52e6fe 2021-08-03 op .Bl -bullet -compact
126 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
128 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
129 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
132 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
134 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
135 4a52e6fe 2021-08-03 op are equivalent.
136 4a52e6fe 2021-08-03 op .Sh GOPHER SUPPORT
137 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
138 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
139 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
140 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
141 bba111bc 2021-03-28 op been taken to include also bindings familiar for
146 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
147 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
148 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
149 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
151 bba111bc 2021-03-28 op Keys are usually a single character, like
155 bba111bc 2021-03-28 op but some special keys are accepted as well.
157 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
167 bba111bc 2021-03-28 op Previous page/Page up
169 bba111bc 2021-03-28 op Next page/Page down
174 bba111bc 2021-03-28 op .It <f0> thru <f63>
175 bba111bc 2021-03-28 op Function keys
176 bba111bc 2021-03-28 op .It del or backspace
180 bba111bc 2021-03-28 op .It space or spc
182 bba111bc 2021-03-28 op .It enter or ret
187 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
190 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
191 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
193 7dbaef94 2021-04-22 op previous-line
199 7dbaef94 2021-04-22 op backward-char
201 7dbaef94 2021-04-22 op backward-paragraph
203 7dbaef94 2021-04-22 op forward-paragraph
205 7dbaef94 2021-04-22 op move-beginning-of-line
207 7dbaef94 2021-04-22 op move-end-of-line
208 bba111bc 2021-03-28 op .It M-v, M-space
210 bba111bc 2021-03-28 op .It C-v, space
213 7dbaef94 2021-04-22 op beginning-of-buffer
215 7dbaef94 2021-04-22 op end-of-buffer
217 7dbaef94 2021-04-22 op kill-telescope
219 7dbaef94 2021-04-22 op clear-minibuf
221 7dbaef94 2021-04-22 op execute-extended-command
223 61251035 2021-06-26 op dec-fill-column
225 61251035 2021-06-26 op inc-fill-column
227 1c412d48 2021-06-25 op previous-heading
233 f2ab2540 2021-07-14 op load-current-url
237 7dbaef94 2021-04-22 op load-current-url
243 7dbaef94 2021-04-22 op tab-close-other
255 7dbaef94 2021-04-22 op previous-page
259 7dbaef94 2021-04-22 op bookmark-page
260 bba111bc 2021-03-28 op .It <f7> <f7>
261 7dbaef94 2021-04-22 op list-bookmarks
263 12cf7d80 2021-07-15 op suspend-telescope
265 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
266 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
268 7dbaef94 2021-04-22 op previous-line
274 7dbaef94 2021-04-22 op backward-char
276 7dbaef94 2021-04-22 op backward-paragraph
278 7dbaef94 2021-04-22 op forward-paragraph
280 7dbaef94 2021-04-22 op move-beginning-of-line
282 7dbaef94 2021-04-22 op move-end-of-line
284 7dbaef94 2021-04-22 op scroll-line-up
286 7dbaef94 2021-04-22 op scroll-line-down
288 7dbaef94 2021-04-22 op beginning-of-buffer
290 7dbaef94 2021-04-22 op end-of-buffer
304 7dbaef94 2021-04-22 op previous-page
308 7dbaef94 2021-04-22 op kill-telescope
310 7dbaef94 2021-04-22 op clear-minibuf
312 7dbaef94 2021-04-22 op execute-extended-command
314 bba111bc 2021-03-28 op .Ss CUA-like keys
315 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
317 7dbaef94 2021-04-22 op previous-line
323 7dbaef94 2021-04-22 op backward-char
325 12cf7d80 2021-07-15 op move-beginning-of-line
327 12cf7d80 2021-07-15 op move-end-of-line
336 3c3af0fd 2021-07-08 op .It M-<prior>
341 7dbaef94 2021-04-22 op previous-page
342 bba111bc 2021-03-28 op .It M-<right>
349 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
350 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
356 7dbaef94 2021-04-22 op push-button-new-tab
358 7dbaef94 2021-04-22 op previous-button
360 8dc60352 2021-06-15 op previous-button
374 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
375 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
377 7dbaef94 2021-04-22 op mini-complete-and-exit
383 7dbaef94 2021-04-22 op mini-delete-char
385 7dbaef94 2021-04-22 op mini-delete-backward-char
386 bba111bc 2021-03-28 op .It backspace
387 7dbaef94 2021-04-22 op mini-delete-backward-char
389 7dbaef94 2021-04-22 op mini-delete-backward-char
391 7dbaef94 2021-04-22 op backward-char
395 7dbaef94 2021-04-22 op backward-char
399 7dbaef94 2021-04-22 op move-end-of-line
401 7dbaef94 2021-04-22 op move-beginning-of-line
403 7dbaef94 2021-04-22 op move-end-of-line
405 7dbaef94 2021-04-22 op move-beginning-of-line
407 7dbaef94 2021-04-22 op mini-kill-line
409 7dbaef94 2021-04-22 op mini-previous-history-element
411 7dbaef94 2021-04-22 op mini-next-history-element
413 e7b982f4 2021-07-14 op previous-completion
415 dffb2592 2021-07-14 op next-completion
417 dffb2592 2021-07-14 op previous-completion
419 e7b982f4 2021-07-14 op next-completion
421 e7b982f4 2021-07-14 op insert-current-candidate
423 7ee780fa 2021-07-21 op mini-goto-beginning
425 7ee780fa 2021-07-21 op mini-goto-end
427 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
428 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
429 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
430 bba111bc 2021-03-28 op .Ic execute-extended-command .
431 bba111bc 2021-03-28 op .Ss Movement commands
432 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
433 bba111bc 2021-03-28 op .It Ic backward-char
434 bba111bc 2021-03-28 op Move point one character backward.
435 bba111bc 2021-03-28 op .It Ic backward-paragraph
436 bba111bc 2021-03-28 op Move point one paragraph backward.
437 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
438 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
439 bba111bc 2021-03-28 op .It Ic end-of-buffer
440 bba111bc 2021-03-28 op Move point to the end of the buffer.
441 bba111bc 2021-03-28 op .It Ic forward-char
442 bba111bc 2021-03-28 op Move point one character forward.
443 bba111bc 2021-03-28 op .It Ic forward-paragraph
444 bba111bc 2021-03-28 op Move point one paragraph forward.
445 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
446 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
447 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
448 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
449 bba111bc 2021-03-28 op .It Ic move-end-of-line
450 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
451 bba111bc 2021-03-28 op .It Ic next-button
452 bba111bc 2021-03-28 op Move point to the next link.
453 e7b982f4 2021-07-14 op .It Ic next-completion
454 e7b982f4 2021-07-14 op Select the next completion.
455 1c412d48 2021-06-25 op .It Ic next-heading
456 1c412d48 2021-06-25 op Move point to the next heading.
457 bba111bc 2021-03-28 op .It Ic next-line
458 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
459 bba111bc 2021-03-28 op .It Ic previous-button
460 bba111bc 2021-03-28 op Move point to the previous link.
461 e7b982f4 2021-07-14 op .It Ic previous-completion
462 e7b982f4 2021-07-14 op Select the previous completion.
463 1c412d48 2021-06-25 op .It Ic previous-heading
464 1c412d48 2021-06-25 op Move point to the previous heading.
465 bba111bc 2021-03-28 op .It Ic previous-line
466 bba111bc 2021-03-28 op Move point to the previous (visual) line.
468 bba111bc 2021-03-28 op .Ss Bookmark-related commands
469 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
470 bba111bc 2021-03-28 op .It Ic bookmark-page
471 b3be07ea 2021-07-18 op Save a page in the bookmark file.
472 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
473 63875195 2021-04-01 op .It Ic list-bookmarks
474 bba111bc 2021-03-28 op Load the bookmarks page.
476 bba111bc 2021-03-28 op .Ss Tab-related commands
477 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
478 bba111bc 2021-03-28 op .It Ic tab-close
479 bba111bc 2021-03-28 op Close the current tab.
480 bba111bc 2021-03-28 op .It Ic tab-close-other
481 bba111bc 2021-03-28 op Close all tabs but the current one.
482 bba111bc 2021-03-28 op .It Ic tab-move
483 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
485 bba111bc 2021-03-28 op .It Ic tab-move-to
486 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
487 bba111bc 2021-03-28 op .It Ic tab-new
488 bba111bc 2021-03-28 op Open a new tab.
489 bba111bc 2021-03-28 op .It Ic tab-next
490 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
491 bba111bc 2021-03-28 op .It Ic tab-previous
492 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
493 3360ef1b 2021-07-14 op .It Ic tab-select
494 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
496 bba111bc 2021-03-28 op .Ss Misc commands
497 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
498 bba111bc 2021-03-28 op .It Ic clear-minibuf
499 b3be07ea 2021-07-18 op Clear the echo area.
500 61251035 2021-06-26 op .It Ic dec-fill-column
501 b3be07ea 2021-07-18 op Decrement fill-column by two.
502 bba111bc 2021-03-28 op .It Ic execute-extended-command
503 b3be07ea 2021-07-18 op Execute an internal command.
504 bba111bc 2021-03-28 op .It Ic kill-telescope
507 61251035 2021-06-26 op .It Ic inc-fill-column
508 b3be07ea 2021-07-18 op Increment fill-column by two.
509 753c6ac7 2021-07-14 op .It Ic link-select
510 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
511 bba111bc 2021-03-28 op .It Ic load-current-url
512 b3be07ea 2021-07-18 op Edit the current URL.
513 bba111bc 2021-03-28 op .It Ic load-url
514 b3be07ea 2021-07-18 op Prompt for an URL.
515 bba111bc 2021-03-28 op .It Ic next-page
516 b3be07ea 2021-07-18 op Go forward in the page history.
517 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
518 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
520 9a7d62cb 2021-07-21 op .It Ic other-window
521 9a7d62cb 2021-07-21 op Select the other window.
522 bba111bc 2021-03-28 op .It Ic previous-page
523 b3be07ea 2021-07-18 op Go backward in the page history.
524 bba111bc 2021-03-28 op .It Ic push-button
525 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
526 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
527 bba111bc 2021-03-28 op .It Ic push-button-new-tab
528 b3be07ea 2021-07-18 op Follow link at point in a new tab.
529 bba111bc 2021-03-28 op .It Ic redraw
530 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
532 661233ed 2021-07-14 op .It Ic reload-page
533 661233ed 2021-07-14 op Reload the current page.
534 bba111bc 2021-03-28 op .It Ic scroll-down
535 bba111bc 2021-03-28 op Scroll down by one visual page.
536 bba111bc 2021-03-28 op .It Ic scroll-line-down
537 bba111bc 2021-03-28 op Scroll down by one line.
538 bba111bc 2021-03-28 op .It Ic scroll-line-up
539 bba111bc 2021-03-28 op Scroll up by one line.
540 bba111bc 2021-03-28 op .It Ic scroll-up
541 bba111bc 2021-03-28 op Scroll up by one visual page.
542 12cf7d80 2021-07-15 op .It Ic suspend-telescope
543 12cf7d80 2021-07-15 op Suspend the current
546 753c6ac7 2021-07-14 op .It Ic swiper
547 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
549 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
550 7a014cef 2021-04-01 op .It Ic toggle-help
551 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
552 7a014cef 2021-04-01 op interactive command.
553 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
554 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
556 bba111bc 2021-03-28 op .Ss Minibuffer commands
557 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
558 bba111bc 2021-03-28 op .It Ic mini-abort
559 bba111bc 2021-03-28 op Abort the current minibuffer action.
560 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
561 bba111bc 2021-03-28 op Complete the current minibuffer action.
562 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
563 bba111bc 2021-03-28 op Delete the character before the point.
564 bba111bc 2021-03-28 op .It Ic mini-delete-char
565 bba111bc 2021-03-28 op Delete the character after the point.
566 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
567 de190a2b 2021-07-17 op Select the first completion, if any.
568 de190a2b 2021-07-17 op .It Ic mini-goto-end
569 de190a2b 2021-07-17 op Select the last completion, if any.
570 bba111bc 2021-03-28 op .It Ic mini-kill-line
571 b3be07ea 2021-07-18 op Delete from point until the end of the line.
572 bba111bc 2021-03-28 op .It Ic mini-next-history-element
573 bba111bc 2021-03-28 op Load the previous history element.
574 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
575 bba111bc 2021-03-28 op Load the next history element.
578 7d2d15f5 2021-04-30 op The following aliases are available during
579 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
580 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
583 c82b3fd6 2021-05-12 op .It Ic tabnew
586 c82b3fd6 2021-05-12 op .Ic tab-previous
587 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
588 7d2d15f5 2021-04-30 op .Ic kill-telescope
590 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
591 74ca8ef4 2021-06-19 op During the startup,
593 74ca8ef4 2021-06-19 op reads the configuration file at
594 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
595 74ca8ef4 2021-06-19 op or the one given with the
600 21404dd9 2021-07-15 op will also load a file called
601 21404dd9 2021-07-15 op .Pa config-TERM ,
604 21404dd9 2021-07-15 op is the name of the terminal type
605 7ee780fa 2021-07-21 op .Pq i.e. the TERM environment variable ,
606 7ee780fa 2021-07-21 op if it exists.
608 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
609 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
612 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
614 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
615 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
617 74ca8ef4 2021-06-19 op The following constructs are available:
618 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
619 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
622 138421e8 2021-06-25 op to the function
624 138421e8 2021-06-25 op in the keymap
626 138421e8 2021-06-25 op Valid values for map are
627 138421e8 2021-06-25 op .Dq global-map
628 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
630 138421e8 2021-06-25 op .Dq minibuffer-map
631 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
633 138421e8 2021-06-25 op follows the same syntax described in
634 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
635 138421e8 2021-06-25 op and all the possible functions are listed in
636 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
637 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
640 90d8329a 2021-06-25 op as proxy for all URLs with
644 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
645 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
646 74ca8ef4 2021-06-19 op Set the option
650 74ca8ef4 2021-06-19 op Valid options are:
652 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
653 88693f61 2021-07-15 op .It dont-wrap-pre
655 88693f61 2021-07-15 op If nonzero, don't wrap preformatted blocks.
656 7ee780fa 2021-07-21 op Defaults to 0.
657 59ae0cdc 2021-07-16 op .It emojify-link
659 7ee780fa 2021-07-21 op If nonzero, when the text of a link starts with an emoji followed by a
660 7ee780fa 2021-07-21 op space, use that emoji as line prefix.
661 59ae0cdc 2021-07-16 op Defaults to 1.
662 2c748a1f 2021-06-21 op .It enable-colors
664 7ee780fa 2021-07-21 op If nonzero, enable colours.
665 7ee780fa 2021-07-21 op Defaults to 0 if
666 2c748a1f 2021-06-21 op .Ev NO_COLORS
667 7ee780fa 2021-07-21 op is set, 1 otherwise.
668 74ca8ef4 2021-06-19 op .It fill-column
670 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
671 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
672 7ee780fa 2021-07-21 op Defaults to 80.
673 b1379f34 2021-07-05 op .It hide-pre-blocks
675 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
676 7ee780fa 2021-07-21 op Defaults to zero.
677 b1379f34 2021-07-05 op .Ic push-button
678 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
679 144733a7 2021-07-15 op .It hide-pre-closing-line
681 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
682 7ee780fa 2021-07-21 op Defaults to 0.
683 b1379f34 2021-07-05 op .It hide-pre-context
685 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
686 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
687 b1379f34 2021-07-05 op blocks are irremediably hidden.
688 7ee780fa 2021-07-21 op Defaults to zero.
689 74ca8ef4 2021-06-19 op .It new-tab-url
691 41a9ae40 2021-06-20 op URL for the new tab page.
693 41a9ae40 2021-06-20 op .Dq about:new .
694 74ca8ef4 2021-06-19 op .It olivetti-mode
696 7ee780fa 2021-07-21 op If nonzero, enable
697 74ca8ef4 2021-06-19 op .Ic olivetti-mode
698 7ee780fa 2021-07-21 op Defaults to 1.
699 9886bf97 2021-07-17 op .It set-title
701 7ee780fa 2021-07-21 op If nonzero, set the terminal title to the page title.
702 9886bf97 2021-07-17 op Defaults to 1.
704 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
705 74ca8ef4 2021-06-19 op Change the styling of the element identified by
707 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
708 74ca8ef4 2021-06-19 op Valid style identifiers are:
709 7ee780fa 2021-07-21 op .Bl -tag -width line.compl.current -compact -offset Ds
711 7ee780fa 2021-07-21 op the area outside the lines in the body of the page.
712 45fe2472 2021-07-14 op .It line.compl
713 7ee780fa 2021-07-21 op the completions.
714 45fe2472 2021-07-14 op .It line.compl.current
715 7ee780fa 2021-07-21 op the current completion.
716 75fd746b 2021-07-21 op .It line.help
717 75fd746b 2021-07-21 op text in the *Help* buffer.
718 74ca8ef4 2021-06-19 op .It line.text
720 74bc52e8 2021-06-25 op .It line.link
722 74ca8ef4 2021-06-19 op .It line.title1..3
724 74ca8ef4 2021-06-19 op .It line.item
726 74ca8ef4 2021-06-19 op .It line.quote
728 74ca8ef4 2021-06-19 op .It line.pre.start
729 7ee780fa 2021-07-21 op the heading of a preformatted block.
731 7ee780fa 2021-07-21 op the content of a preformatted block.
732 74ca8ef4 2021-06-19 op .It line.pre.end
733 7ee780fa 2021-07-21 op the closing line of a preformatted block.
734 eaf1a84b 2021-06-25 op .It minibuffer
735 7ee780fa 2021-07-21 op the minibuffer.
737 7ee780fa 2021-07-21 op the modeline.
740 74bc52e8 2021-06-25 op .It tabline.tab
741 7ee780fa 2021-07-21 op the non-focused tabs.
742 74bc52e8 2021-06-25 op .It tabline.current
743 7ee780fa 2021-07-21 op the focused tab.
746 74ca8ef4 2021-06-19 op Valid options are:
747 ab728b01 2021-06-22 op .Bl -tag -width Ds
748 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
749 ab728b01 2021-06-22 op Sets the text attributes.
750 ab728b01 2021-06-22 op If only one value is given,
754 ab728b01 2021-06-22 op default to that; if two values are given then
758 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
759 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
760 ab728b01 2021-06-22 op .It Ic normal
761 ab728b01 2021-06-22 op no attributes.
762 ab728b01 2021-06-22 op .It Ic standout
763 ab728b01 2021-06-22 op best highlighting mode for the terminal.
764 ab728b01 2021-06-22 op .It Ic underline
765 ab728b01 2021-06-22 op underlines the text.
766 ab728b01 2021-06-22 op .It Ic reverse
767 ab728b01 2021-06-22 op reverses background/foreground colors.
769 ab728b01 2021-06-22 op makes the text blinking.
773 ab728b01 2021-06-22 op extra bright or bold.
776 7ee780fa 2021-07-21 op Only the style identifiers with the
778 74bc52e8 2021-06-25 op prefix accept up to three attributes.
779 74bc52e8 2021-06-25 op The other will only use the first one given.
780 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
781 ab728b01 2021-06-22 op Sets the background color.
782 ab728b01 2021-06-22 op Follows the same behaviour as
784 ab728b01 2021-06-22 op regarding the optional parameters.
785 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
786 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
787 ae844a00 2021-06-25 op .Pq or color0 to color255
788 ae844a00 2021-06-25 op from the 256-colour set;
789 ae844a00 2021-06-25 op default for the default colour.
790 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
791 ab728b01 2021-06-22 op Sets the foreground color.
792 ab728b01 2021-06-22 op It behaves just like
794 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
795 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
799 ab728b01 2021-06-22 op as the prefix for the continuation lines
800 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
803 ab728b01 2021-06-22 op is not given its value will be the same of
807 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
810 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
811 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
813 7ee780fa 2021-07-21 op The user's login directory.
814 7ee780fa 2021-07-21 op .It Ev NO_COLORS
815 7ee780fa 2021-07-21 op To decide whether to use colors or not.
816 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
818 7ee780fa 2021-07-21 op The user's terminal name.
821 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
822 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
823 7ee780fa 2021-07-21 op Bookmarks file.
824 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
825 dca97b00 2021-06-19 op Default configuration file.
826 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
827 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
828 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
829 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
830 d0fd368a 2021-07-15 op .It Pa ~/.telescope/lock
831 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
833 d0fd368a 2021-07-15 op from running at the same time.
834 56e7efb4 2021-07-21 op .It Pa ~/.telescope/pages/about_*.gmi
835 56e7efb4 2021-07-21 op Overrides for built-in about: pages.
836 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
837 7ee780fa 2021-07-21 op The list of tabs from the last session.
838 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
839 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
841 87e3e801 2021-07-17 op Is written by
842 e9b1e094 2021-04-01 op .Ic kill-telescope
843 7ee780fa 2021-07-21 op and loaded during startup.
846 984245ce 2021-06-23 op It's possible to browse
847 984245ce 2021-06-23 op .Dq the small web
848 984245ce 2021-06-23 op .Pq i.e. simple websites
849 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
850 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
851 984245ce 2021-06-23 op .Bd -literal -offset indent
852 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
853 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
858 7ee780fa 2021-07-21 op without any configuration
859 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
860 19f9cf0f 2021-06-24 op telescope -c /dev/null
866 bba111bc 2021-03-28 op program was written by
867 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
869 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.
