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 a74a9f2c 2021-10-08 op .Sh CONFIGURATION FILE
180 a74a9f2c 2021-10-08 op During the startup,
182 a74a9f2c 2021-10-08 op reads the configuration file at
183 a74a9f2c 2021-10-08 op .Pa ~/.config/telescope/config
185 a74a9f2c 2021-10-08 op .Pa ~/.telescope/config .
187 a74a9f2c 2021-10-08 op It's possible to load a custom configuration file using the
192 a74a9f2c 2021-10-08 op will also load a file called
193 a74a9f2c 2021-10-08 op .Pa config-TERM ,
196 a74a9f2c 2021-10-08 op is the name of the terminal type
197 a74a9f2c 2021-10-08 op .Pq i.e. the TERM environment variable ,
198 a74a9f2c 2021-10-08 op if it exists.
200 a74a9f2c 2021-10-08 op The format of the configuration file is fairly flexible.
201 a74a9f2c 2021-10-08 op The current line can be extended over multiple ones using a
204 a74a9f2c 2021-10-08 op Comments can be put anywhere in the file using a hash mark
206 a74a9f2c 2021-10-08 op and extend to the end of the current line, but backslashes can't be
207 a74a9f2c 2021-10-08 op used to extend comments over multiple lines.
209 a74a9f2c 2021-10-08 op The following constructs are available:
210 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
211 a74a9f2c 2021-10-08 op .It Ic bind Ar map Ar key Ar cmd
214 a74a9f2c 2021-10-08 op to the function
216 a74a9f2c 2021-10-08 op in the keymap
218 a74a9f2c 2021-10-08 op Valid values for map are
219 a74a9f2c 2021-10-08 op .Dq global-map
220 a74a9f2c 2021-10-08 op .Pq i.e. when the user is viewing a page
222 a74a9f2c 2021-10-08 op .Dq minibuffer-map
223 a74a9f2c 2021-10-08 op .Pq i.e. when the minibuffer has the focus.
225 a74a9f2c 2021-10-08 op follows the same syntax described in
226 a74a9f2c 2021-10-08 op .Sx DEFAULT KEY BINDINGS
227 a74a9f2c 2021-10-08 op and all the possible functions are listed in
228 a74a9f2c 2021-10-08 op .Sx INTERACTIVE COMMANDS .
229 a74a9f2c 2021-10-08 op .It Ic proxy Ar proto Ic via Ar url
232 a74a9f2c 2021-10-08 op as proxy for all URLs with
236 a74a9f2c 2021-10-08 op must be a Gemini URI without path, query and fragment component.
237 a74a9f2c 2021-10-08 op .It Ic set Ar opt No = Ar val
238 a74a9f2c 2021-10-08 op Set the option
242 a74a9f2c 2021-10-08 op Valid options are:
244 a74a9f2c 2021-10-08 op .Bl -tag -width twelveletters -compact
247 a74a9f2c 2021-10-08 op If greater than zero, save the session after the specified amount of
248 a74a9f2c 2021-10-08 op seconds after some events happens
249 a74a9f2c 2021-10-08 op .Pq new or closed tabs, visited a link ...
250 a74a9f2c 2021-10-08 op Defaults to 20.
251 a74a9f2c 2021-10-08 op .It dont-wrap-pre
253 a74a9f2c 2021-10-08 op If nonzero, don't wrap preformatted blocks.
254 a74a9f2c 2021-10-08 op Defaults to 0.
255 a74a9f2c 2021-10-08 op .It download-path
257 a74a9f2c 2021-10-08 op The default download path.
260 a74a9f2c 2021-10-08 op .It emojify-link
262 a74a9f2c 2021-10-08 op If nonzero, when the text of a link starts with an emoji followed by a
263 a74a9f2c 2021-10-08 op space, use that emoji as line prefix.
264 a74a9f2c 2021-10-08 op Defaults to 1.
265 a74a9f2c 2021-10-08 op .It enable-colors
267 a74a9f2c 2021-10-08 op If nonzero, enable colours.
268 a74a9f2c 2021-10-08 op Defaults to 0 if
269 a74a9f2c 2021-10-08 op .Ev NO_COLORS
270 a74a9f2c 2021-10-08 op is set, 1 otherwise.
271 a74a9f2c 2021-10-08 op .It fill-column
273 a74a9f2c 2021-10-08 op If greater than zero, lines of text will be formatted in a way that
274 a74a9f2c 2021-10-08 op don't exceed the given number of columns.
275 a74a9f2c 2021-10-08 op Defaults to 80.
276 a74a9f2c 2021-10-08 op .It hide-pre-blocks
278 a74a9f2c 2021-10-08 op If nonzero, hide by default the body of the preformatted blocks.
279 a74a9f2c 2021-10-08 op Defaults to zero.
280 a74a9f2c 2021-10-08 op .Ic push-button
281 a74a9f2c 2021-10-08 op can be used to toggle the visibility per-block.
282 a74a9f2c 2021-10-08 op .It hide-pre-closing-line
284 a74a9f2c 2021-10-08 op If nonzero, hide the closing line of preformatted blocks.
285 a74a9f2c 2021-10-08 op Defaults to 0.
286 a74a9f2c 2021-10-08 op .It hide-pre-context
288 a74a9f2c 2021-10-08 op If nonzero, hide the start and end line of the preformatted blocks.
289 a74a9f2c 2021-10-08 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
290 a74a9f2c 2021-10-08 op blocks are irremediably hidden.
291 a74a9f2c 2021-10-08 op Defaults to zero.
292 a74a9f2c 2021-10-08 op .It new-tab-url
294 a74a9f2c 2021-10-08 op URL for the new tab page.
296 a74a9f2c 2021-10-08 op .Dq about:new .
297 a74a9f2c 2021-10-08 op .It olivetti-mode
299 a74a9f2c 2021-10-08 op If nonzero, enable
300 a74a9f2c 2021-10-08 op .Ic olivetti-mode
301 a74a9f2c 2021-10-08 op Defaults to 1.
302 a74a9f2c 2021-10-08 op .It set-title
304 a74a9f2c 2021-10-08 op If nonzero, set the terminal title to the page title.
305 a74a9f2c 2021-10-08 op Defaults to 1.
306 a74a9f2c 2021-10-08 op .It tab-bar-show
308 a74a9f2c 2021-10-08 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
309 a74a9f2c 2021-10-08 op unconditionally.
310 a74a9f2c 2021-10-08 op If it's 1, show the bar only when there is more than one tab.
311 a74a9f2c 2021-10-08 op Defaults to 1.
313 a74a9f2c 2021-10-08 op .It Ic style Ar name Ar option
314 a74a9f2c 2021-10-08 op Change the styling of the element identified by
316 a74a9f2c 2021-10-08 op Multiple options may be specified within curly braces.
317 a74a9f2c 2021-10-08 op Valid style identifiers are:
318 a74a9f2c 2021-10-08 op .Bl -tag -width line.compl.current -compact -offset Ds
320 a74a9f2c 2021-10-08 op the area outside the lines in the body of the page.
321 a74a9f2c 2021-10-08 op .It line.compl
322 a74a9f2c 2021-10-08 op the completions.
323 a74a9f2c 2021-10-08 op .It line.compl.current
324 a74a9f2c 2021-10-08 op the current completion.
325 a74a9f2c 2021-10-08 op .It line.help
326 a74a9f2c 2021-10-08 op text in the *Help* buffer.
327 a74a9f2c 2021-10-08 op .It line.text
329 a74a9f2c 2021-10-08 op .It line.link
331 a74a9f2c 2021-10-08 op .It line.title1..3
333 a74a9f2c 2021-10-08 op .It line.item
335 a74a9f2c 2021-10-08 op .It line.quote
337 a74a9f2c 2021-10-08 op .It line.pre.start
338 a74a9f2c 2021-10-08 op the heading of a preformatted block.
340 a74a9f2c 2021-10-08 op the content of a preformatted block.
341 a74a9f2c 2021-10-08 op .It line.pre.end
342 a74a9f2c 2021-10-08 op the closing line of a preformatted block.
343 a74a9f2c 2021-10-08 op .It minibuffer
344 a74a9f2c 2021-10-08 op the minibuffer.
346 a74a9f2c 2021-10-08 op the modeline.
349 a74a9f2c 2021-10-08 op .It tabline.tab
350 a74a9f2c 2021-10-08 op the non-focused tabs.
351 a74a9f2c 2021-10-08 op .It tabline.current
352 a74a9f2c 2021-10-08 op the focused tab.
355 a74a9f2c 2021-10-08 op Valid options are:
356 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
357 a74a9f2c 2021-10-08 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
358 a74a9f2c 2021-10-08 op Sets the text attributes.
359 a74a9f2c 2021-10-08 op If only one value is given,
363 a74a9f2c 2021-10-08 op default to that; if two values are given then
367 a74a9f2c 2021-10-08 op Each attribute is a comma-separated list of keywords:
368 a74a9f2c 2021-10-08 op .Bl -tag -width underline -compact -offset Ds
369 a74a9f2c 2021-10-08 op .It Ic normal
370 a74a9f2c 2021-10-08 op no attributes.
371 a74a9f2c 2021-10-08 op .It Ic standout
372 a74a9f2c 2021-10-08 op best highlighting mode for the terminal.
373 a74a9f2c 2021-10-08 op .It Ic underline
374 a74a9f2c 2021-10-08 op underlines the text.
375 a74a9f2c 2021-10-08 op .It Ic reverse
376 a74a9f2c 2021-10-08 op reverses background/foreground colors.
378 a74a9f2c 2021-10-08 op makes the text blinking.
382 a74a9f2c 2021-10-08 op extra bright or bold.
385 a74a9f2c 2021-10-08 op Only the style identifiers with the
387 a74a9f2c 2021-10-08 op prefix accept up to three attributes.
388 a74a9f2c 2021-10-08 op The other will only use the first one given.
389 a74a9f2c 2021-10-08 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
390 a74a9f2c 2021-10-08 op Sets the background color.
391 a74a9f2c 2021-10-08 op Follows the same behaviour as
393 a74a9f2c 2021-10-08 op regarding the optional parameters.
394 a74a9f2c 2021-10-08 op The colour is one of black, red, green, yellow, blue,
395 a74a9f2c 2021-10-08 op magenta, cyan and white; colour0 to colour255
396 a74a9f2c 2021-10-08 op .Pq or color0 to color255
397 a74a9f2c 2021-10-08 op from the 256-colour set;
398 a74a9f2c 2021-10-08 op default for the default colour.
399 a74a9f2c 2021-10-08 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
400 a74a9f2c 2021-10-08 op Sets the foreground color.
401 a74a9f2c 2021-10-08 op It behaves just like
403 a74a9f2c 2021-10-08 op .It Ic prefix Ar prfx Op Ar cont
404 a74a9f2c 2021-10-08 op Sets the prefix for the current line type to
408 a74a9f2c 2021-10-08 op as the prefix for the continuation lines
409 a74a9f2c 2021-10-08 op .Pq i.e. when a long line gets wrapped.
412 a74a9f2c 2021-10-08 op is not given its value will be the same of
416 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
417 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
418 bba111bc 2021-03-28 op been taken to include also bindings familiar for
423 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
424 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
425 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
426 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
428 bba111bc 2021-03-28 op Keys are usually a single character, like
432 bba111bc 2021-03-28 op but some special keys are accepted as well.
434 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
444 bba111bc 2021-03-28 op Previous page/Page up
446 bba111bc 2021-03-28 op Next page/Page down
451 bba111bc 2021-03-28 op .It <f0> thru <f63>
452 bba111bc 2021-03-28 op Function keys
453 bba111bc 2021-03-28 op .It del or backspace
457 bba111bc 2021-03-28 op .It space or spc
459 bba111bc 2021-03-28 op .It enter or ret
464 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
467 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
468 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
470 7dbaef94 2021-04-22 op previous-line
476 7dbaef94 2021-04-22 op backward-char
478 7dbaef94 2021-04-22 op backward-paragraph
480 7dbaef94 2021-04-22 op forward-paragraph
482 7dbaef94 2021-04-22 op move-beginning-of-line
484 7dbaef94 2021-04-22 op move-end-of-line
485 bba111bc 2021-03-28 op .It M-v, M-space
487 bba111bc 2021-03-28 op .It C-v, space
490 7dbaef94 2021-04-22 op beginning-of-buffer
492 7dbaef94 2021-04-22 op end-of-buffer
494 7dbaef94 2021-04-22 op kill-telescope
496 7dbaef94 2021-04-22 op clear-minibuf
498 7dbaef94 2021-04-22 op execute-extended-command
500 61251035 2021-06-26 op dec-fill-column
502 61251035 2021-06-26 op inc-fill-column
504 1c412d48 2021-06-25 op previous-heading
510 f2ab2540 2021-07-14 op load-current-url
514 7dbaef94 2021-04-22 op load-current-url
520 7dbaef94 2021-04-22 op tab-close-other
532 7dbaef94 2021-04-22 op previous-page
536 7dbaef94 2021-04-22 op bookmark-page
537 bba111bc 2021-03-28 op .It <f7> <f7>
538 7dbaef94 2021-04-22 op list-bookmarks
540 12cf7d80 2021-07-15 op suspend-telescope
542 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
543 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
545 7dbaef94 2021-04-22 op previous-line
551 7dbaef94 2021-04-22 op backward-char
553 7dbaef94 2021-04-22 op backward-paragraph
555 7dbaef94 2021-04-22 op forward-paragraph
557 7dbaef94 2021-04-22 op move-beginning-of-line
559 7dbaef94 2021-04-22 op move-end-of-line
561 7dbaef94 2021-04-22 op scroll-line-up
563 7dbaef94 2021-04-22 op scroll-line-down
565 7dbaef94 2021-04-22 op beginning-of-buffer
567 7dbaef94 2021-04-22 op end-of-buffer
581 7dbaef94 2021-04-22 op previous-page
585 7dbaef94 2021-04-22 op kill-telescope
587 7dbaef94 2021-04-22 op clear-minibuf
589 7dbaef94 2021-04-22 op execute-extended-command
591 bba111bc 2021-03-28 op .Ss CUA-like keys
592 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
594 7dbaef94 2021-04-22 op previous-line
600 7dbaef94 2021-04-22 op backward-char
602 12cf7d80 2021-07-15 op move-beginning-of-line
604 12cf7d80 2021-07-15 op move-end-of-line
613 3c3af0fd 2021-07-08 op .It M-<prior>
618 7dbaef94 2021-04-22 op previous-page
619 bba111bc 2021-03-28 op .It M-<right>
626 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
627 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
633 7dbaef94 2021-04-22 op push-button-new-tab
635 7dbaef94 2021-04-22 op previous-button
637 8dc60352 2021-06-15 op previous-button
655 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
656 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
658 7dbaef94 2021-04-22 op mini-complete-and-exit
664 7dbaef94 2021-04-22 op mini-delete-char
666 7dbaef94 2021-04-22 op mini-delete-backward-char
667 bba111bc 2021-03-28 op .It backspace
668 7dbaef94 2021-04-22 op mini-delete-backward-char
670 7dbaef94 2021-04-22 op mini-delete-backward-char
672 7dbaef94 2021-04-22 op backward-char
676 7dbaef94 2021-04-22 op backward-char
680 7dbaef94 2021-04-22 op move-end-of-line
682 7dbaef94 2021-04-22 op move-beginning-of-line
684 7dbaef94 2021-04-22 op move-end-of-line
686 7dbaef94 2021-04-22 op move-beginning-of-line
688 7dbaef94 2021-04-22 op mini-kill-line
690 7dbaef94 2021-04-22 op mini-previous-history-element
692 7dbaef94 2021-04-22 op mini-next-history-element
694 e7b982f4 2021-07-14 op previous-completion
696 dffb2592 2021-07-14 op next-completion
698 dffb2592 2021-07-14 op previous-completion
700 e7b982f4 2021-07-14 op next-completion
702 e7b982f4 2021-07-14 op insert-current-candidate
704 7ee780fa 2021-07-21 op mini-goto-beginning
706 7ee780fa 2021-07-21 op mini-goto-end
708 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
709 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
710 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
711 bba111bc 2021-03-28 op .Ic execute-extended-command .
712 bba111bc 2021-03-28 op .Ss Movement commands
713 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
714 bba111bc 2021-03-28 op .It Ic backward-char
715 bba111bc 2021-03-28 op Move point one character backward.
716 bba111bc 2021-03-28 op .It Ic backward-paragraph
717 bba111bc 2021-03-28 op Move point one paragraph backward.
718 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
719 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
720 bba111bc 2021-03-28 op .It Ic end-of-buffer
721 bba111bc 2021-03-28 op Move point to the end of the buffer.
722 bba111bc 2021-03-28 op .It Ic forward-char
723 bba111bc 2021-03-28 op Move point one character forward.
724 bba111bc 2021-03-28 op .It Ic forward-paragraph
725 bba111bc 2021-03-28 op Move point one paragraph forward.
726 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
727 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
728 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
729 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
730 bba111bc 2021-03-28 op .It Ic move-end-of-line
731 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
732 bba111bc 2021-03-28 op .It Ic next-button
733 bba111bc 2021-03-28 op Move point to the next link.
734 e7b982f4 2021-07-14 op .It Ic next-completion
735 e7b982f4 2021-07-14 op Select the next completion.
736 1c412d48 2021-06-25 op .It Ic next-heading
737 1c412d48 2021-06-25 op Move point to the next heading.
738 bba111bc 2021-03-28 op .It Ic next-line
739 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
740 bba111bc 2021-03-28 op .It Ic previous-button
741 bba111bc 2021-03-28 op Move point to the previous link.
742 e7b982f4 2021-07-14 op .It Ic previous-completion
743 e7b982f4 2021-07-14 op Select the previous completion.
744 1c412d48 2021-06-25 op .It Ic previous-heading
745 1c412d48 2021-06-25 op Move point to the previous heading.
746 bba111bc 2021-03-28 op .It Ic previous-line
747 bba111bc 2021-03-28 op Move point to the previous (visual) line.
749 bba111bc 2021-03-28 op .Ss Bookmark-related commands
750 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
751 bba111bc 2021-03-28 op .It Ic bookmark-page
752 b3be07ea 2021-07-18 op Save a page in the bookmark file.
753 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
754 63875195 2021-04-01 op .It Ic list-bookmarks
755 bba111bc 2021-03-28 op Load the bookmarks page.
757 bba111bc 2021-03-28 op .Ss Tab-related commands
758 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
759 bba111bc 2021-03-28 op .It Ic tab-close
760 bba111bc 2021-03-28 op Close the current tab.
761 bba111bc 2021-03-28 op .It Ic tab-close-other
762 bba111bc 2021-03-28 op Close all tabs but the current one.
763 bba111bc 2021-03-28 op .It Ic tab-move
764 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
766 bba111bc 2021-03-28 op .It Ic tab-move-to
767 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
768 bba111bc 2021-03-28 op .It Ic tab-new
769 bba111bc 2021-03-28 op Open a new tab.
770 bba111bc 2021-03-28 op .It Ic tab-next
771 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
772 bba111bc 2021-03-28 op .It Ic tab-previous
773 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
774 3360ef1b 2021-07-14 op .It Ic tab-select
775 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
777 bba111bc 2021-03-28 op .Ss Misc commands
778 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
779 bba111bc 2021-03-28 op .It Ic clear-minibuf
780 b3be07ea 2021-07-18 op Clear the echo area.
781 61251035 2021-06-26 op .It Ic dec-fill-column
782 b3be07ea 2021-07-18 op Decrement fill-column by two.
783 bba111bc 2021-03-28 op .It Ic execute-extended-command
784 b3be07ea 2021-07-18 op Execute an internal command.
785 bba111bc 2021-03-28 op .It Ic kill-telescope
788 61251035 2021-06-26 op .It Ic inc-fill-column
789 b3be07ea 2021-07-18 op Increment fill-column by two.
790 753c6ac7 2021-07-14 op .It Ic link-select
791 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
792 bba111bc 2021-03-28 op .It Ic load-current-url
793 b3be07ea 2021-07-18 op Edit the current URL.
794 bba111bc 2021-03-28 op .It Ic load-url
795 b3be07ea 2021-07-18 op Prompt for an URL.
796 bba111bc 2021-03-28 op .It Ic next-page
797 b3be07ea 2021-07-18 op Go forward in the page history.
798 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
799 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
801 9a7d62cb 2021-07-21 op .It Ic other-window
802 9a7d62cb 2021-07-21 op Select the other window.
803 bba111bc 2021-03-28 op .It Ic previous-page
804 b3be07ea 2021-07-18 op Go backward in the page history.
805 bba111bc 2021-03-28 op .It Ic push-button
806 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
807 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
808 bba111bc 2021-03-28 op .It Ic push-button-new-tab
809 b3be07ea 2021-07-18 op Follow link at point in a new tab.
810 bba111bc 2021-03-28 op .It Ic redraw
811 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
813 661233ed 2021-07-14 op .It Ic reload-page
814 661233ed 2021-07-14 op Reload the current page.
815 bba111bc 2021-03-28 op .It Ic scroll-down
816 bba111bc 2021-03-28 op Scroll down by one visual page.
817 bba111bc 2021-03-28 op .It Ic scroll-line-down
818 bba111bc 2021-03-28 op Scroll down by one line.
819 bba111bc 2021-03-28 op .It Ic scroll-line-up
820 bba111bc 2021-03-28 op Scroll up by one line.
821 bba111bc 2021-03-28 op .It Ic scroll-up
822 bba111bc 2021-03-28 op Scroll up by one visual page.
823 12cf7d80 2021-07-15 op .It Ic suspend-telescope
824 12cf7d80 2021-07-15 op Suspend the current
827 753c6ac7 2021-07-14 op .It Ic swiper
828 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
830 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
831 7a014cef 2021-04-01 op .It Ic toggle-help
832 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
833 7a014cef 2021-04-01 op interactive command.
834 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
835 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
837 bba111bc 2021-03-28 op .Ss Minibuffer commands
838 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
839 bba111bc 2021-03-28 op .It Ic mini-abort
840 bba111bc 2021-03-28 op Abort the current minibuffer action.
841 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
842 bba111bc 2021-03-28 op Complete the current minibuffer action.
843 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
844 bba111bc 2021-03-28 op Delete the character before the point.
845 bba111bc 2021-03-28 op .It Ic mini-delete-char
846 bba111bc 2021-03-28 op Delete the character after the point.
847 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
848 de190a2b 2021-07-17 op Select the first completion, if any.
849 de190a2b 2021-07-17 op .It Ic mini-goto-end
850 de190a2b 2021-07-17 op Select the last completion, if any.
851 bba111bc 2021-03-28 op .It Ic mini-kill-line
852 b3be07ea 2021-07-18 op Delete from point until the end of the line.
853 bba111bc 2021-03-28 op .It Ic mini-next-history-element
854 bba111bc 2021-03-28 op Load the previous history element.
855 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
856 bba111bc 2021-03-28 op Load the next history element.
859 7d2d15f5 2021-04-30 op The following aliases are available during
860 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
861 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
864 c82b3fd6 2021-05-12 op .It Ic tabnew
867 c82b3fd6 2021-05-12 op .Ic tab-previous
868 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
869 7d2d15f5 2021-04-30 op .Ic kill-telescope
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.