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 73389b00 2021-10-08 op .Dd $Mdocdate: October 8 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 eb2ed626 2021-10-07 op .Pa $HOME/.config/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 d0971653 2021-09-15 op .It Fl S , Fl -safe
51 d0971653 2021-09-15 op .Pq or Dq sandbox
55 d34a1873 2021-09-15 op from writing files to the disk and to acquire the lock, allowing to
56 d34a1873 2021-09-15 op run multiple instances at the same time.
58 d34a1873 2021-09-15 op still loads the session file and the custom about pages.
59 dc761924 2021-07-15 op .It Fl v , Fl -version
60 dc761924 2021-07-15 op Display version.
62 7ee780fa 2021-07-21 op .Sh UI CONCEPTS
64 7ee780fa 2021-07-21 op interface is divided into four areas: the tabline, the body, the
65 7ee780fa 2021-07-21 op modeline and the echoarea/minibuffer.
67 7ee780fa 2021-07-21 op The tabline is always at the top of the screen and displays the tabs
68 7ee780fa 2021-07-21 op separated by a vertical line.
69 7ee780fa 2021-07-21 op When there are more tabs than the size of the window allow to display,
70 7ee780fa 2021-07-21 op the characters
74 7ee780fa 2021-07-21 op are shown at the start/end of the tabline to indicate that there are
75 7ee780fa 2021-07-21 op more tabs in that direction.
77 7ee780fa 2021-07-21 op The body occupies the majority of the visible area.
78 7ee780fa 2021-07-21 op It contains the current page and optionally a side window.
80 7ee780fa 2021-07-21 op The modeline is the second to last row of the screen.
81 7ee780fa 2021-07-21 op It shows some information about the page: a spinner when the page is
82 7ee780fa 2021-07-21 op loading, the trust level, the document type, the scroll offset and the
85 7ee780fa 2021-07-21 op The echoarea is usually the last line of the screen.
86 7ee780fa 2021-07-21 op Messages are often showed there, and link addresses too.
87 7ee780fa 2021-07-21 op The echoarea is also used to obtain input from the user.
88 7ee780fa 2021-07-21 op When commands like
91 7ee780fa 2021-07-21 op .Ic link-select
92 9eb0c887 2021-08-03 op are invoked, the minibuffer area grows to show possible completions.
95 7ee780fa 2021-07-21 op aims to use the
96 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
99 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
100 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
101 bba111bc 2021-03-28 op .Bl -tag -width 12m
102 bba111bc 2021-03-28 op .It untrusted
104 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
107 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
110 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
113 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
114 7ee780fa 2021-07-21 op indicated character.
116 bba111bc 2021-03-28 op Most of the time the
118 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
119 bba111bc 2021-03-28 op verify out-of-band the certificate.
121 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
122 bba111bc 2021-03-28 op verification though.
123 f1279523 2021-08-13 op .Sh SUPPORTED PROTOCOLS
124 f1279523 2021-08-13 op The following protocols are supported:
125 f1279523 2021-08-13 op .Bl -tag -width gemini://
127 f1279523 2021-08-13 op About pages are
129 f1279523 2021-08-13 op internal page.
130 f1279523 2021-08-13 op See about:about for a list of all these pages.
132 f1279523 2021-08-13 op File types know to
134 f1279523 2021-08-13 op such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
135 f1279523 2021-08-13 op viewed inside the application.
136 f1279523 2021-08-13 op Types of local files are detected solely based on the file extension.
137 f1279523 2021-08-13 op On some systems, such as
139 f1279523 2021-08-13 op only files inside special directories
140 f1279523 2021-08-13 op .Pq like Pa /tmp No or Pa ~/Downloads
141 f1279523 2021-08-13 op are available.
142 f1279523 2021-08-13 op .It finger://
143 f1279523 2021-08-13 op Finger URLs are interpreted as follows:
144 4a52e6fe 2021-08-03 op .Bl -bullet -compact
146 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
148 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
149 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
152 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
154 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
155 f1279523 2021-08-13 op are treated as the same URL.
156 f1279523 2021-08-13 op .It gemini://
157 f1279523 2021-08-13 op Gemini is fully supported, with the exception of client-certificates.
158 f1279523 2021-08-13 op .It gopher://
159 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
160 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
163 eb6e7b8a 2021-08-16 op User-entered URLs, given as argument on the command line or entered
165 eb6e7b8a 2021-08-16 op .Ic load-url ,
166 eb6e7b8a 2021-08-16 op are intepreted with a simple heuristic:
167 eb6e7b8a 2021-08-16 op .Bl -bullet -compact
169 eb6e7b8a 2021-08-16 op if it's a proper absolute URL then use it as-is,
171 eb6e7b8a 2021-08-16 op if it starts with
175 eb6e7b8a 2021-08-16 op assume it's a file:// URL,
177 eb6e7b8a 2021-08-16 op otherwise assume it's a Gemini URL.
179 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
180 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
181 bba111bc 2021-03-28 op been taken to include also bindings familiar for
186 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
187 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
188 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
189 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
191 bba111bc 2021-03-28 op Keys are usually a single character, like
195 bba111bc 2021-03-28 op but some special keys are accepted as well.
197 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
207 bba111bc 2021-03-28 op Previous page/Page up
209 bba111bc 2021-03-28 op Next page/Page down
214 bba111bc 2021-03-28 op .It <f0> thru <f63>
215 bba111bc 2021-03-28 op Function keys
216 bba111bc 2021-03-28 op .It del or backspace
220 bba111bc 2021-03-28 op .It space or spc
222 bba111bc 2021-03-28 op .It enter or ret
227 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
230 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
231 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
233 7dbaef94 2021-04-22 op previous-line
239 7dbaef94 2021-04-22 op backward-char
241 7dbaef94 2021-04-22 op backward-paragraph
243 7dbaef94 2021-04-22 op forward-paragraph
245 7dbaef94 2021-04-22 op move-beginning-of-line
247 7dbaef94 2021-04-22 op move-end-of-line
248 bba111bc 2021-03-28 op .It M-v, M-space
250 bba111bc 2021-03-28 op .It C-v, space
253 7dbaef94 2021-04-22 op beginning-of-buffer
255 7dbaef94 2021-04-22 op end-of-buffer
257 7dbaef94 2021-04-22 op kill-telescope
259 7dbaef94 2021-04-22 op clear-minibuf
261 7dbaef94 2021-04-22 op execute-extended-command
263 61251035 2021-06-26 op dec-fill-column
265 61251035 2021-06-26 op inc-fill-column
267 1c412d48 2021-06-25 op previous-heading
273 f2ab2540 2021-07-14 op load-current-url
277 7dbaef94 2021-04-22 op load-current-url
283 7dbaef94 2021-04-22 op tab-close-other
295 7dbaef94 2021-04-22 op previous-page
299 7dbaef94 2021-04-22 op bookmark-page
300 bba111bc 2021-03-28 op .It <f7> <f7>
301 7dbaef94 2021-04-22 op list-bookmarks
303 12cf7d80 2021-07-15 op suspend-telescope
305 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
306 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
308 7dbaef94 2021-04-22 op previous-line
314 7dbaef94 2021-04-22 op backward-char
316 7dbaef94 2021-04-22 op backward-paragraph
318 7dbaef94 2021-04-22 op forward-paragraph
320 7dbaef94 2021-04-22 op move-beginning-of-line
322 7dbaef94 2021-04-22 op move-end-of-line
324 7dbaef94 2021-04-22 op scroll-line-up
326 7dbaef94 2021-04-22 op scroll-line-down
328 7dbaef94 2021-04-22 op beginning-of-buffer
330 7dbaef94 2021-04-22 op end-of-buffer
344 7dbaef94 2021-04-22 op previous-page
348 7dbaef94 2021-04-22 op kill-telescope
350 7dbaef94 2021-04-22 op clear-minibuf
352 7dbaef94 2021-04-22 op execute-extended-command
354 bba111bc 2021-03-28 op .Ss CUA-like keys
355 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
357 7dbaef94 2021-04-22 op previous-line
363 7dbaef94 2021-04-22 op backward-char
365 12cf7d80 2021-07-15 op move-beginning-of-line
367 12cf7d80 2021-07-15 op move-end-of-line
376 3c3af0fd 2021-07-08 op .It M-<prior>
381 7dbaef94 2021-04-22 op previous-page
382 bba111bc 2021-03-28 op .It M-<right>
389 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
390 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
396 7dbaef94 2021-04-22 op push-button-new-tab
398 7dbaef94 2021-04-22 op previous-button
400 8dc60352 2021-06-15 op previous-button
418 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
419 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
421 7dbaef94 2021-04-22 op mini-complete-and-exit
427 7dbaef94 2021-04-22 op mini-delete-char
429 7dbaef94 2021-04-22 op mini-delete-backward-char
430 bba111bc 2021-03-28 op .It backspace
431 7dbaef94 2021-04-22 op mini-delete-backward-char
433 7dbaef94 2021-04-22 op mini-delete-backward-char
435 7dbaef94 2021-04-22 op backward-char
439 7dbaef94 2021-04-22 op backward-char
443 7dbaef94 2021-04-22 op move-end-of-line
445 7dbaef94 2021-04-22 op move-beginning-of-line
447 7dbaef94 2021-04-22 op move-end-of-line
449 7dbaef94 2021-04-22 op move-beginning-of-line
451 7dbaef94 2021-04-22 op mini-kill-line
453 7dbaef94 2021-04-22 op mini-previous-history-element
455 7dbaef94 2021-04-22 op mini-next-history-element
457 e7b982f4 2021-07-14 op previous-completion
459 dffb2592 2021-07-14 op next-completion
461 dffb2592 2021-07-14 op previous-completion
463 e7b982f4 2021-07-14 op next-completion
465 e7b982f4 2021-07-14 op insert-current-candidate
467 7ee780fa 2021-07-21 op mini-goto-beginning
469 7ee780fa 2021-07-21 op mini-goto-end
471 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
472 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
473 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
474 bba111bc 2021-03-28 op .Ic execute-extended-command .
475 bba111bc 2021-03-28 op .Ss Movement commands
476 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
477 bba111bc 2021-03-28 op .It Ic backward-char
478 bba111bc 2021-03-28 op Move point one character backward.
479 bba111bc 2021-03-28 op .It Ic backward-paragraph
480 bba111bc 2021-03-28 op Move point one paragraph backward.
481 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
482 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
483 bba111bc 2021-03-28 op .It Ic end-of-buffer
484 bba111bc 2021-03-28 op Move point to the end of the buffer.
485 bba111bc 2021-03-28 op .It Ic forward-char
486 bba111bc 2021-03-28 op Move point one character forward.
487 bba111bc 2021-03-28 op .It Ic forward-paragraph
488 bba111bc 2021-03-28 op Move point one paragraph forward.
489 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
490 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
491 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
492 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
493 bba111bc 2021-03-28 op .It Ic move-end-of-line
494 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
495 bba111bc 2021-03-28 op .It Ic next-button
496 bba111bc 2021-03-28 op Move point to the next link.
497 e7b982f4 2021-07-14 op .It Ic next-completion
498 e7b982f4 2021-07-14 op Select the next completion.
499 1c412d48 2021-06-25 op .It Ic next-heading
500 1c412d48 2021-06-25 op Move point to the next heading.
501 bba111bc 2021-03-28 op .It Ic next-line
502 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
503 bba111bc 2021-03-28 op .It Ic previous-button
504 bba111bc 2021-03-28 op Move point to the previous link.
505 e7b982f4 2021-07-14 op .It Ic previous-completion
506 e7b982f4 2021-07-14 op Select the previous completion.
507 1c412d48 2021-06-25 op .It Ic previous-heading
508 1c412d48 2021-06-25 op Move point to the previous heading.
509 bba111bc 2021-03-28 op .It Ic previous-line
510 bba111bc 2021-03-28 op Move point to the previous (visual) line.
512 bba111bc 2021-03-28 op .Ss Bookmark-related commands
513 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
514 bba111bc 2021-03-28 op .It Ic bookmark-page
515 b3be07ea 2021-07-18 op Save a page in the bookmark file.
516 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
517 63875195 2021-04-01 op .It Ic list-bookmarks
518 bba111bc 2021-03-28 op Load the bookmarks page.
520 bba111bc 2021-03-28 op .Ss Tab-related commands
521 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
522 bba111bc 2021-03-28 op .It Ic tab-close
523 bba111bc 2021-03-28 op Close the current tab.
524 bba111bc 2021-03-28 op .It Ic tab-close-other
525 bba111bc 2021-03-28 op Close all tabs but the current one.
526 bba111bc 2021-03-28 op .It Ic tab-move
527 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
529 bba111bc 2021-03-28 op .It Ic tab-move-to
530 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
531 bba111bc 2021-03-28 op .It Ic tab-new
532 bba111bc 2021-03-28 op Open a new tab.
533 bba111bc 2021-03-28 op .It Ic tab-next
534 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
535 bba111bc 2021-03-28 op .It Ic tab-previous
536 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
537 3360ef1b 2021-07-14 op .It Ic tab-select
538 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
540 bba111bc 2021-03-28 op .Ss Misc commands
541 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
542 bba111bc 2021-03-28 op .It Ic clear-minibuf
543 b3be07ea 2021-07-18 op Clear the echo area.
544 61251035 2021-06-26 op .It Ic dec-fill-column
545 b3be07ea 2021-07-18 op Decrement fill-column by two.
546 bba111bc 2021-03-28 op .It Ic execute-extended-command
547 b3be07ea 2021-07-18 op Execute an internal command.
548 bba111bc 2021-03-28 op .It Ic kill-telescope
551 61251035 2021-06-26 op .It Ic inc-fill-column
552 b3be07ea 2021-07-18 op Increment fill-column by two.
553 753c6ac7 2021-07-14 op .It Ic link-select
554 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
555 bba111bc 2021-03-28 op .It Ic load-current-url
556 b3be07ea 2021-07-18 op Edit the current URL.
557 bba111bc 2021-03-28 op .It Ic load-url
558 b3be07ea 2021-07-18 op Prompt for an URL.
559 bba111bc 2021-03-28 op .It Ic next-page
560 b3be07ea 2021-07-18 op Go forward in the page history.
561 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
562 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
564 9a7d62cb 2021-07-21 op .It Ic other-window
565 9a7d62cb 2021-07-21 op Select the other window.
566 bba111bc 2021-03-28 op .It Ic previous-page
567 b3be07ea 2021-07-18 op Go backward in the page history.
568 bba111bc 2021-03-28 op .It Ic push-button
569 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
570 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
571 bba111bc 2021-03-28 op .It Ic push-button-new-tab
572 b3be07ea 2021-07-18 op Follow link at point in a new tab.
573 bba111bc 2021-03-28 op .It Ic redraw
574 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
576 661233ed 2021-07-14 op .It Ic reload-page
577 661233ed 2021-07-14 op Reload the current page.
578 bba111bc 2021-03-28 op .It Ic scroll-down
579 bba111bc 2021-03-28 op Scroll down by one visual page.
580 bba111bc 2021-03-28 op .It Ic scroll-line-down
581 bba111bc 2021-03-28 op Scroll down by one line.
582 bba111bc 2021-03-28 op .It Ic scroll-line-up
583 bba111bc 2021-03-28 op Scroll up by one line.
584 bba111bc 2021-03-28 op .It Ic scroll-up
585 bba111bc 2021-03-28 op Scroll up by one visual page.
586 12cf7d80 2021-07-15 op .It Ic suspend-telescope
587 12cf7d80 2021-07-15 op Suspend the current
590 753c6ac7 2021-07-14 op .It Ic swiper
591 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
593 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
594 7a014cef 2021-04-01 op .It Ic toggle-help
595 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
596 7a014cef 2021-04-01 op interactive command.
597 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
598 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
600 bba111bc 2021-03-28 op .Ss Minibuffer commands
601 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
602 bba111bc 2021-03-28 op .It Ic mini-abort
603 bba111bc 2021-03-28 op Abort the current minibuffer action.
604 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
605 bba111bc 2021-03-28 op Complete the current minibuffer action.
606 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
607 bba111bc 2021-03-28 op Delete the character before the point.
608 bba111bc 2021-03-28 op .It Ic mini-delete-char
609 bba111bc 2021-03-28 op Delete the character after the point.
610 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
611 de190a2b 2021-07-17 op Select the first completion, if any.
612 de190a2b 2021-07-17 op .It Ic mini-goto-end
613 de190a2b 2021-07-17 op Select the last completion, if any.
614 bba111bc 2021-03-28 op .It Ic mini-kill-line
615 b3be07ea 2021-07-18 op Delete from point until the end of the line.
616 bba111bc 2021-03-28 op .It Ic mini-next-history-element
617 bba111bc 2021-03-28 op Load the previous history element.
618 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
619 bba111bc 2021-03-28 op Load the next history element.
622 7d2d15f5 2021-04-30 op The following aliases are available during
623 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
624 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
627 c82b3fd6 2021-05-12 op .It Ic tabnew
630 c82b3fd6 2021-05-12 op .Ic tab-previous
631 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
632 7d2d15f5 2021-04-30 op .Ic kill-telescope
634 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
635 74ca8ef4 2021-06-19 op During the startup,
637 74ca8ef4 2021-06-19 op reads the configuration file at
638 eb2ed626 2021-10-07 op .Pa ~/.config/telescope/config
640 73389b00 2021-10-08 op .Pa ~/.telescope/config .
642 73389b00 2021-10-08 op It's possible to load a custom configuration file using the
647 21404dd9 2021-07-15 op will also load a file called
648 21404dd9 2021-07-15 op .Pa config-TERM ,
651 21404dd9 2021-07-15 op is the name of the terminal type
652 7ee780fa 2021-07-21 op .Pq i.e. the TERM environment variable ,
653 7ee780fa 2021-07-21 op if it exists.
655 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
656 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
659 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
661 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
662 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
664 74ca8ef4 2021-06-19 op The following constructs are available:
665 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
666 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
669 138421e8 2021-06-25 op to the function
671 138421e8 2021-06-25 op in the keymap
673 138421e8 2021-06-25 op Valid values for map are
674 138421e8 2021-06-25 op .Dq global-map
675 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
677 138421e8 2021-06-25 op .Dq minibuffer-map
678 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
680 138421e8 2021-06-25 op follows the same syntax described in
681 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
682 138421e8 2021-06-25 op and all the possible functions are listed in
683 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
684 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
687 90d8329a 2021-06-25 op as proxy for all URLs with
691 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
692 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
693 74ca8ef4 2021-06-19 op Set the option
697 74ca8ef4 2021-06-19 op Valid options are:
699 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
702 5c6ed3a9 2021-08-14 op If greater than zero, save the session after the specified amount of
703 5c6ed3a9 2021-08-14 op seconds after some events happens
704 5c6ed3a9 2021-08-14 op .Pq new or closed tabs, visited a link ...
705 5c6ed3a9 2021-08-14 op Defaults to 20.
706 88693f61 2021-07-15 op .It dont-wrap-pre
708 88693f61 2021-07-15 op If nonzero, don't wrap preformatted blocks.
709 7ee780fa 2021-07-21 op Defaults to 0.
710 638cbf21 2021-08-29 op .It download-path
712 638cbf21 2021-08-29 op The default download path.
715 59ae0cdc 2021-07-16 op .It emojify-link
717 7ee780fa 2021-07-21 op If nonzero, when the text of a link starts with an emoji followed by a
718 7ee780fa 2021-07-21 op space, use that emoji as line prefix.
719 59ae0cdc 2021-07-16 op Defaults to 1.
720 2c748a1f 2021-06-21 op .It enable-colors
722 7ee780fa 2021-07-21 op If nonzero, enable colours.
723 7ee780fa 2021-07-21 op Defaults to 0 if
724 2c748a1f 2021-06-21 op .Ev NO_COLORS
725 7ee780fa 2021-07-21 op is set, 1 otherwise.
726 74ca8ef4 2021-06-19 op .It fill-column
728 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
729 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
730 7ee780fa 2021-07-21 op Defaults to 80.
731 b1379f34 2021-07-05 op .It hide-pre-blocks
733 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
734 7ee780fa 2021-07-21 op Defaults to zero.
735 b1379f34 2021-07-05 op .Ic push-button
736 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
737 144733a7 2021-07-15 op .It hide-pre-closing-line
739 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
740 7ee780fa 2021-07-21 op Defaults to 0.
741 b1379f34 2021-07-05 op .It hide-pre-context
743 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
744 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
745 b1379f34 2021-07-05 op blocks are irremediably hidden.
746 7ee780fa 2021-07-21 op Defaults to zero.
747 74ca8ef4 2021-06-19 op .It new-tab-url
749 41a9ae40 2021-06-20 op URL for the new tab page.
751 41a9ae40 2021-06-20 op .Dq about:new .
752 74ca8ef4 2021-06-19 op .It olivetti-mode
754 7ee780fa 2021-07-21 op If nonzero, enable
755 74ca8ef4 2021-06-19 op .Ic olivetti-mode
756 7ee780fa 2021-07-21 op Defaults to 1.
757 9886bf97 2021-07-17 op .It set-title
759 7ee780fa 2021-07-21 op If nonzero, set the terminal title to the page title.
760 b3c59b13 2021-08-18 op Defaults to 1.
761 b3c59b13 2021-08-18 op .It tab-bar-show
763 b3c59b13 2021-08-18 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
764 b3c59b13 2021-08-18 op unconditionally.
765 b3c59b13 2021-08-18 op If it's 1, show the bar only when there is more than one tab.
766 9886bf97 2021-07-17 op Defaults to 1.
768 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
769 74ca8ef4 2021-06-19 op Change the styling of the element identified by
771 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
772 74ca8ef4 2021-06-19 op Valid style identifiers are:
773 7ee780fa 2021-07-21 op .Bl -tag -width line.compl.current -compact -offset Ds
775 7ee780fa 2021-07-21 op the area outside the lines in the body of the page.
776 45fe2472 2021-07-14 op .It line.compl
777 7ee780fa 2021-07-21 op the completions.
778 45fe2472 2021-07-14 op .It line.compl.current
779 7ee780fa 2021-07-21 op the current completion.
780 75fd746b 2021-07-21 op .It line.help
781 75fd746b 2021-07-21 op text in the *Help* buffer.
782 74ca8ef4 2021-06-19 op .It line.text
784 74bc52e8 2021-06-25 op .It line.link
786 74ca8ef4 2021-06-19 op .It line.title1..3
788 74ca8ef4 2021-06-19 op .It line.item
790 74ca8ef4 2021-06-19 op .It line.quote
792 74ca8ef4 2021-06-19 op .It line.pre.start
793 7ee780fa 2021-07-21 op the heading of a preformatted block.
795 7ee780fa 2021-07-21 op the content of a preformatted block.
796 74ca8ef4 2021-06-19 op .It line.pre.end
797 7ee780fa 2021-07-21 op the closing line of a preformatted block.
798 eaf1a84b 2021-06-25 op .It minibuffer
799 7ee780fa 2021-07-21 op the minibuffer.
801 7ee780fa 2021-07-21 op the modeline.
804 74bc52e8 2021-06-25 op .It tabline.tab
805 7ee780fa 2021-07-21 op the non-focused tabs.
806 74bc52e8 2021-06-25 op .It tabline.current
807 7ee780fa 2021-07-21 op the focused tab.
810 74ca8ef4 2021-06-19 op Valid options are:
811 ab728b01 2021-06-22 op .Bl -tag -width Ds
812 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
813 ab728b01 2021-06-22 op Sets the text attributes.
814 ab728b01 2021-06-22 op If only one value is given,
818 ab728b01 2021-06-22 op default to that; if two values are given then
822 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
823 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
824 ab728b01 2021-06-22 op .It Ic normal
825 ab728b01 2021-06-22 op no attributes.
826 ab728b01 2021-06-22 op .It Ic standout
827 ab728b01 2021-06-22 op best highlighting mode for the terminal.
828 ab728b01 2021-06-22 op .It Ic underline
829 ab728b01 2021-06-22 op underlines the text.
830 ab728b01 2021-06-22 op .It Ic reverse
831 ab728b01 2021-06-22 op reverses background/foreground colors.
833 ab728b01 2021-06-22 op makes the text blinking.
837 ab728b01 2021-06-22 op extra bright or bold.
840 7ee780fa 2021-07-21 op Only the style identifiers with the
842 74bc52e8 2021-06-25 op prefix accept up to three attributes.
843 74bc52e8 2021-06-25 op The other will only use the first one given.
844 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
845 ab728b01 2021-06-22 op Sets the background color.
846 ab728b01 2021-06-22 op Follows the same behaviour as
848 ab728b01 2021-06-22 op regarding the optional parameters.
849 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
850 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
851 ae844a00 2021-06-25 op .Pq or color0 to color255
852 ae844a00 2021-06-25 op from the 256-colour set;
853 ae844a00 2021-06-25 op default for the default colour.
854 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
855 ab728b01 2021-06-22 op Sets the foreground color.
856 ab728b01 2021-06-22 op It behaves just like
858 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
859 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
863 ab728b01 2021-06-22 op as the prefix for the continuation lines
864 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
867 ab728b01 2021-06-22 op is not given its value will be the same of
871 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
874 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
875 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
877 7ee780fa 2021-07-21 op The user's login directory.
878 7ee780fa 2021-07-21 op .It Ev NO_COLORS
879 7ee780fa 2021-07-21 op To decide whether to use colors or not.
880 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
882 7ee780fa 2021-07-21 op The user's terminal name.
883 73389b00 2021-10-08 op .It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
884 73389b00 2021-10-08 op If defined can alter the default location of the files used.
889 73389b00 2021-10-08 op follows the XDG Base Directory Specification.
891 73389b00 2021-10-08 op .Pa ~/.telescope
892 73389b00 2021-10-08 op exists, XDG is ignored and all the files are stored inside it.
894 73389b00 2021-10-08 op .Ev XDG_CACHE_HOME ,
895 73389b00 2021-10-08 op .Ev XDG_CONFIG_HOME
897 73389b00 2021-10-08 op .Ev XDG_DATA_HOME
898 73389b00 2021-10-08 op can further alter the location of these files.
900 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
901 eb2ed626 2021-10-07 op .It Pa ~/.config/telescope/config
902 dca97b00 2021-06-19 op Default configuration file.
903 eb2ed626 2021-10-07 op .It Pa ~/.config/telescope/pages/about_*.gmi
904 eb2ed626 2021-10-07 op Overrides for built-in about: pages.
905 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/bookmarks.gmi
906 eb2ed626 2021-10-07 op Bookmarks file.
907 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/known_hosts
908 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
909 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
910 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
911 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/lock
912 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
914 d0fd368a 2021-07-15 op from running at the same time.
915 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/session
916 7ee780fa 2021-07-21 op The list of tabs from the last session.
917 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
918 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
920 87e3e801 2021-07-17 op Is written by
921 e9b1e094 2021-04-01 op .Ic kill-telescope
922 7ee780fa 2021-07-21 op and loaded during startup.
925 984245ce 2021-06-23 op It's possible to browse
926 984245ce 2021-06-23 op .Dq the small web
927 984245ce 2021-06-23 op .Pq i.e. simple websites
928 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
929 eb2ed626 2021-10-07 op .Pa ~/.config/telescope/config :
930 984245ce 2021-06-23 op .Bd -literal -offset indent
931 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
932 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
937 7ee780fa 2021-07-21 op without any configuration
938 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
939 19f9cf0f 2021-06-24 op telescope -c /dev/null
941 73389b00 2021-10-08 op .Sh STANDARDS
943 73389b00 2021-10-08 op .%B XDG Base Directory Specification
944 73389b00 2021-10-08 op .%U https://specifications.freedesktop.org/basedir-spec/latest/
950 bba111bc 2021-03-28 op program was written by
951 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
953 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.