1 4bb6a4fa 2024-01-15 op .\" Copyright (c) 2021, 2022, 2024 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 fd6c540b 2024-02-12 op .Dd $Mdocdate: February 12 2024$
15 bba111bc 2021-03-28 op .Dt TELESCOPE 1
19 a19dd818 2021-08-03 op .Nd multi-protocol browser
24 dee3a166 2021-11-29 op .Op Fl c Ar 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 dee3a166 2021-11-29 op .It Fl c Ar config
38 c92e529c 2021-06-15 op Specify an alternative configuration file.
40 dee3a166 2021-11-29 op .Pa ~/.config/telescope/config
42 ccc5591f 2021-07-15 op .It Fl h , Fl -help
43 d18cfb58 2022-01-06 op Display version, usage and exit.
45 ccc5591f 2021-07-15 op Configtest mode.
46 ccc5591f 2021-07-15 op Only check the configuration file for validity.
47 d0971653 2021-09-15 op .It Fl S , Fl -safe
49 d0971653 2021-09-15 op .Pq or Dq sandbox
53 d34a1873 2021-09-15 op from writing files to the disk and to acquire the lock, allowing to
54 d34a1873 2021-09-15 op run multiple instances at the same time.
56 d34a1873 2021-09-15 op still loads the session file and the custom about pages.
57 dc761924 2021-07-15 op .It Fl v , Fl -version
58 d18cfb58 2022-01-06 op Display version and exit.
60 7ee780fa 2021-07-21 op .Sh UI CONCEPTS
62 7ee780fa 2021-07-21 op interface is divided into four areas: the tabline, the body, the
63 7ee780fa 2021-07-21 op modeline and the echoarea/minibuffer.
65 7ee780fa 2021-07-21 op The tabline is always at the top of the screen and displays the tabs
66 7ee780fa 2021-07-21 op separated by a vertical line.
67 7ee780fa 2021-07-21 op When there are more tabs than the size of the window allow to display,
68 7ee780fa 2021-07-21 op the characters
72 7ee780fa 2021-07-21 op are shown at the start/end of the tabline to indicate that there are
73 7ee780fa 2021-07-21 op more tabs in that direction.
75 7ee780fa 2021-07-21 op The body occupies the majority of the visible area.
76 7ee780fa 2021-07-21 op It contains the current page and optionally a side window.
78 7ee780fa 2021-07-21 op The modeline is the second to last row of the screen.
79 7ee780fa 2021-07-21 op It shows some information about the page: a spinner when the page is
80 4c9aaf27 2024-02-06 op loading, the trust level, whether a client certificate is in use, the
81 4c9aaf27 2024-02-06 op document type, the scroll offset and the URL.
82 4c9aaf27 2024-02-06 op When a client certificate is in use, a
84 4c9aaf27 2024-02-06 op character is showed.
86 7ee780fa 2021-07-21 op The echoarea is usually the last line of the screen.
87 7ee780fa 2021-07-21 op Messages are often showed there, and link addresses too.
88 7ee780fa 2021-07-21 op The echoarea is also used to obtain input from the user.
89 7ee780fa 2021-07-21 op When commands like
92 7ee780fa 2021-07-21 op .Ic link-select
93 9eb0c887 2021-08-03 op are invoked, the minibuffer area grows to show possible completions.
96 7ee780fa 2021-07-21 op aims to use the
97 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
100 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
101 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
102 bba111bc 2021-03-28 op .Bl -tag -width 12m
103 bba111bc 2021-03-28 op .It untrusted
105 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
108 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
111 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
114 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
115 7ee780fa 2021-07-21 op indicated character.
117 bba111bc 2021-03-28 op Most of the time the
119 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
120 bba111bc 2021-03-28 op verify out-of-band the certificate.
122 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
123 bba111bc 2021-03-28 op verification though.
124 f1279523 2021-08-13 op .Sh SUPPORTED PROTOCOLS
125 f1279523 2021-08-13 op The following protocols are supported:
126 f1279523 2021-08-13 op .Bl -tag -width gemini://
128 f1279523 2021-08-13 op About pages are
130 f1279523 2021-08-13 op internal page.
131 f1279523 2021-08-13 op See about:about for a list of all these pages.
133 f1279523 2021-08-13 op File types know to
135 f1279523 2021-08-13 op such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
136 f1279523 2021-08-13 op viewed inside the application.
137 f1279523 2021-08-13 op Types of local files are detected solely based on the file extension.
138 f1279523 2021-08-13 op On some systems, such as
140 f1279523 2021-08-13 op only files inside special directories
141 f1279523 2021-08-13 op .Pq like Pa /tmp No or Pa ~/Downloads
142 f1279523 2021-08-13 op are available.
143 f1279523 2021-08-13 op .It finger://
144 f1279523 2021-08-13 op Finger URLs are interpreted as follows:
145 4a52e6fe 2021-08-03 op .Bl -bullet -compact
147 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
149 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
150 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
153 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
155 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
156 f1279523 2021-08-13 op are treated as the same URL.
157 f1279523 2021-08-13 op .It gemini://
158 f1279523 2021-08-13 op Gemini is fully supported, with the exception of client-certificates.
159 f1279523 2021-08-13 op .It gopher://
160 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
161 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
164 eb6e7b8a 2021-08-16 op User-entered URLs, given as argument on the command line or entered
166 eb6e7b8a 2021-08-16 op .Ic load-url ,
167 4bb6a4fa 2024-01-15 op by default are intepreted with a simple heuristic:
168 eb6e7b8a 2021-08-16 op .Bl -bullet -compact
170 eb6e7b8a 2021-08-16 op if it's a proper absolute URL then use it as-is,
172 eb6e7b8a 2021-08-16 op if it starts with
176 eb6e7b8a 2021-08-16 op assume it's a file:// URL,
178 cfcbc23c 2024-01-16 op otherwise treat it like a hostname with protocol
179 cfcbc23c 2024-01-16 op .Ic default-protocol
180 cfcbc23c 2024-01-16 op .Pq gemini by default .
184 449ea6fe 2024-01-16 op .Ic load-url-use-heuristic
185 449ea6fe 2024-01-16 op can be used to disable the use of heuristics.
186 a74a9f2c 2021-10-08 op .Sh CONFIGURATION FILE
187 a74a9f2c 2021-10-08 op During the startup,
189 a74a9f2c 2021-10-08 op reads the configuration file at
190 a74a9f2c 2021-10-08 op .Pa ~/.config/telescope/config
192 a74a9f2c 2021-10-08 op .Pa ~/.telescope/config .
194 a74a9f2c 2021-10-08 op It's possible to load a custom configuration file using the
199 a74a9f2c 2021-10-08 op will also load a file called
200 a74a9f2c 2021-10-08 op .Pa config-TERM ,
203 a74a9f2c 2021-10-08 op is the name of the terminal type
204 a74a9f2c 2021-10-08 op .Pq i.e. the TERM environment variable ,
205 a74a9f2c 2021-10-08 op if it exists.
207 a74a9f2c 2021-10-08 op The format of the configuration file is fairly flexible.
208 a74a9f2c 2021-10-08 op The current line can be extended over multiple ones using a
211 a74a9f2c 2021-10-08 op Comments can be put anywhere in the file using a hash mark
213 a74a9f2c 2021-10-08 op and extend to the end of the current line, but backslashes can't be
214 a74a9f2c 2021-10-08 op used to extend comments over multiple lines.
216 a74a9f2c 2021-10-08 op The following constructs are available:
217 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
218 a74a9f2c 2021-10-08 op .It Ic bind Ar map Ar key Ar cmd
221 a74a9f2c 2021-10-08 op to the function
223 a74a9f2c 2021-10-08 op in the keymap
225 a74a9f2c 2021-10-08 op Valid values for map are
226 a74a9f2c 2021-10-08 op .Dq global-map
227 a74a9f2c 2021-10-08 op .Pq i.e. when the user is viewing a page
229 a74a9f2c 2021-10-08 op .Dq minibuffer-map
230 a74a9f2c 2021-10-08 op .Pq i.e. when the minibuffer has the focus.
232 a74a9f2c 2021-10-08 op follows the same syntax described in
233 a74a9f2c 2021-10-08 op .Sx DEFAULT KEY BINDINGS
234 a74a9f2c 2021-10-08 op and all the possible functions are listed in
235 a74a9f2c 2021-10-08 op .Sx INTERACTIVE COMMANDS .
236 a74a9f2c 2021-10-08 op .It Ic proxy Ar proto Ic via Ar url
239 a74a9f2c 2021-10-08 op as proxy for all URLs with
243 a74a9f2c 2021-10-08 op must be a Gemini URI without path, query and fragment component.
244 a74a9f2c 2021-10-08 op .It Ic set Ar opt No = Ar val
245 a74a9f2c 2021-10-08 op Set the option
249 a74a9f2c 2021-10-08 op Valid options are:
251 a74a9f2c 2021-10-08 op .Bl -tag -width twelveletters -compact
252 b8044517 2022-02-26 op .It Ic autosave
254 a74a9f2c 2021-10-08 op If greater than zero, save the session after the specified amount of
255 a74a9f2c 2021-10-08 op seconds after some events happens
256 a74a9f2c 2021-10-08 op .Pq new or closed tabs, visited a link ...
257 a74a9f2c 2021-10-08 op Defaults to 20.
258 cfcbc23c 2024-01-16 op .It Ic default-protocol
260 cfcbc23c 2024-01-16 op The default protocol assumed for the
265 b8044517 2022-02-26 op .It Ic dont-wrap-pre
267 2513365f 2024-01-16 op If true, don't wrap preformatted blocks.
268 2513365f 2024-01-16 op Defaults to false.
269 b8044517 2022-02-26 op .It Ic download-path
271 a74a9f2c 2021-10-08 op The default download path.
274 b8044517 2022-02-26 op .It Ic emojify-link
276 2513365f 2024-01-16 op If true, when the text of a link starts with an emoji followed by a
277 2513365f 2024-01-16 op space, use that emoji as line prefix.
278 2513365f 2024-01-16 op Defaults to true.
279 b8044517 2022-02-26 op .It Ic enable-colors
281 2513365f 2024-01-16 op If true, enable colours.
282 2513365f 2024-01-16 op Defaults to false if
283 a74a9f2c 2021-10-08 op .Ev NO_COLORS
284 2513365f 2024-01-16 op is set, true otherwise.
285 b8044517 2022-02-26 op .It Ic fill-column
287 a74a9f2c 2021-10-08 op If greater than zero, lines of text will be formatted in a way that
288 a74a9f2c 2021-10-08 op don't exceed the given number of columns.
289 a74a9f2c 2021-10-08 op Defaults to 80.
290 b8044517 2022-02-26 op .It Ic fringe-ignore-offset
292 2513365f 2024-01-16 op If true, the fringe doesn't obey to
293 393dc10e 2022-01-10 op .Ic olivetti-mode .
294 2513365f 2024-01-16 op Defaults to false.
295 b8044517 2022-02-26 op .It Ic hide-pre-blocks
297 2513365f 2024-01-16 op If true, hide by default the body of the preformatted blocks.
298 2513365f 2024-01-16 op Defaults to false.
299 a74a9f2c 2021-10-08 op .Ic push-button
300 a74a9f2c 2021-10-08 op can be used to toggle the visibility per-block.
301 b8044517 2022-02-26 op .It Ic hide-pre-closing-line
303 2513365f 2024-01-16 op If true, hide the closing line of preformatted blocks.
304 2513365f 2024-01-16 op Defaults to false.
305 b8044517 2022-02-26 op .It Ic hide-pre-context
307 2513365f 2024-01-16 op If true, hide the start and end line of the preformatted blocks.
308 a74a9f2c 2021-10-08 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
309 a74a9f2c 2021-10-08 op blocks are irremediably hidden.
310 2513365f 2024-01-16 op Defaults to false.
311 b8044517 2022-02-26 op .It Ic new-tab-url
313 a74a9f2c 2021-10-08 op URL for the new tab page.
315 a74a9f2c 2021-10-08 op .Dq about:new .
316 4bb6a4fa 2024-01-15 op .It Ic load-url-use-heuristic
318 2513365f 2024-01-16 op If false, don't use euristics to resolve the URLs.
319 449ea6fe 2024-01-16 op Non-absolute URLs given as command line argument will be resolved as
320 449ea6fe 2024-01-16 op file system paths,
322 449ea6fe 2024-01-16 op will resolve as relative to the current URL.
323 2513365f 2024-01-16 op Defaults to true.
324 b8044517 2022-02-26 op .It Ic max-killed-tabs
326 4e5935f4 2022-01-05 op The maximum number of closed tabs to keep track of, defaults to 10.
327 4e5935f4 2022-01-05 op Must be a positive number; if zero, don't save closed tabs at all.
328 b8044517 2022-02-26 op .It Ic olivetti-mode
330 2513365f 2024-01-16 op If true, enable
331 a74a9f2c 2021-10-08 op .Ic olivetti-mode
332 2513365f 2024-01-16 op Defaults to true.
333 1d8cc689 2024-02-12 op .It Ic default-search-engine
335 50fd8b26 2024-02-12 op URL of the preferred search engine, used by the
338 50fd8b26 2024-02-12 op If it's a Gemini URI, the user query will be appended as query,
339 50fd8b26 2024-02-12 op replacing it if present.
340 50fd8b26 2024-02-12 op If it's a Gopher URI, the user query will be sent as gopher search
342 50fd8b26 2024-02-12 op No other URI scheme are allowed.
343 b8044517 2022-02-26 op .It Ic tab-bar-show
345 a74a9f2c 2021-10-08 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
346 a74a9f2c 2021-10-08 op unconditionally.
347 a74a9f2c 2021-10-08 op If it's 1, show the bar only when there is more than one tab.
348 fff512aa 2022-01-04 op Defaults to 1.
349 b8044517 2022-02-26 op .It Ic update-title
351 2513365f 2024-01-16 op If true, set the terminal title to the page title.
352 2513365f 2024-01-16 op Defaults to true.
354 a74a9f2c 2021-10-08 op .It Ic style Ar name Ar option
355 a74a9f2c 2021-10-08 op Change the styling of the element identified by
357 a74a9f2c 2021-10-08 op Multiple options may be specified within curly braces.
358 a74a9f2c 2021-10-08 op Valid style identifiers are:
359 399bd9a0 2021-11-05 op .Bl -tag -width line.download.ongoing -compact -offset Ds
361 a74a9f2c 2021-10-08 op the area outside the lines in the body of the page.
362 a74a9f2c 2021-10-08 op .It line.compl
363 a74a9f2c 2021-10-08 op the completions.
364 a74a9f2c 2021-10-08 op .It line.compl.current
365 a74a9f2c 2021-10-08 op the current completion.
366 a74a9f2c 2021-10-08 op .It line.help
367 a74a9f2c 2021-10-08 op text in the *Help* buffer.
368 399bd9a0 2021-11-05 op .It line.download.ongoing
369 399bd9a0 2021-11-05 op an ongoing download
370 399bd9a0 2021-11-05 op .It line.download.done
371 399bd9a0 2021-11-05 op a completed download
372 399bd9a0 2021-11-05 op .It line.download.info
373 399bd9a0 2021-11-05 op informational text in the *Downloads* buffer.
374 d3b39b65 2022-01-10 op .It line.fringe
376 d3b39b65 2022-01-10 op lines draw after the end of a buffer.
377 a74a9f2c 2021-10-08 op .It line.text
379 a74a9f2c 2021-10-08 op .It line.link
381 a74a9f2c 2021-10-08 op .It line.title1..3
383 a74a9f2c 2021-10-08 op .It line.item
385 a74a9f2c 2021-10-08 op .It line.quote
387 a74a9f2c 2021-10-08 op .It line.pre.start
388 a74a9f2c 2021-10-08 op the heading of a preformatted block.
390 a74a9f2c 2021-10-08 op the content of a preformatted block.
391 a74a9f2c 2021-10-08 op .It line.pre.end
392 a74a9f2c 2021-10-08 op the closing line of a preformatted block.
394 399bd9a0 2021-11-05 op the download pane
395 a74a9f2c 2021-10-08 op .It minibuffer
396 a74a9f2c 2021-10-08 op the minibuffer.
398 a74a9f2c 2021-10-08 op the modeline.
401 a74a9f2c 2021-10-08 op .It tabline.tab
402 a74a9f2c 2021-10-08 op the non-focused tabs.
403 a74a9f2c 2021-10-08 op .It tabline.current
404 a74a9f2c 2021-10-08 op the focused tab.
407 a74a9f2c 2021-10-08 op Valid options are:
408 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
409 a74a9f2c 2021-10-08 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
410 a74a9f2c 2021-10-08 op Sets the text attributes.
411 a74a9f2c 2021-10-08 op If only one value is given,
415 a74a9f2c 2021-10-08 op default to that; if two values are given then
419 a74a9f2c 2021-10-08 op Each attribute is a comma-separated list of keywords:
420 a74a9f2c 2021-10-08 op .Bl -tag -width underline -compact -offset Ds
421 a74a9f2c 2021-10-08 op .It Ic normal
422 a74a9f2c 2021-10-08 op no attributes.
423 a74a9f2c 2021-10-08 op .It Ic standout
424 a74a9f2c 2021-10-08 op best highlighting mode for the terminal.
425 a74a9f2c 2021-10-08 op .It Ic underline
426 a74a9f2c 2021-10-08 op underlines the text.
427 a74a9f2c 2021-10-08 op .It Ic reverse
428 a74a9f2c 2021-10-08 op reverses background/foreground colors.
430 a74a9f2c 2021-10-08 op makes the text blinking.
434 a74a9f2c 2021-10-08 op extra bright or bold.
437 a74a9f2c 2021-10-08 op Only the style identifiers with the
439 a74a9f2c 2021-10-08 op prefix accept up to three attributes.
440 a74a9f2c 2021-10-08 op The other will only use the first one given.
441 a74a9f2c 2021-10-08 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
442 a74a9f2c 2021-10-08 op Sets the background color.
443 a74a9f2c 2021-10-08 op Follows the same behaviour as
445 a74a9f2c 2021-10-08 op regarding the optional parameters.
446 a74a9f2c 2021-10-08 op The colour is one of black, red, green, yellow, blue,
447 a74a9f2c 2021-10-08 op magenta, cyan and white; colour0 to colour255
448 a74a9f2c 2021-10-08 op .Pq or color0 to color255
449 a74a9f2c 2021-10-08 op from the 256-colour set;
450 a74a9f2c 2021-10-08 op default for the default colour.
451 a74a9f2c 2021-10-08 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
452 a74a9f2c 2021-10-08 op Sets the foreground color.
453 a74a9f2c 2021-10-08 op It behaves just like
455 a74a9f2c 2021-10-08 op .It Ic prefix Ar prfx Op Ar cont
456 a74a9f2c 2021-10-08 op Sets the prefix for the current line type to
460 a74a9f2c 2021-10-08 op as the prefix for the continuation lines
461 a74a9f2c 2021-10-08 op .Pq i.e. when a long line gets wrapped.
464 a74a9f2c 2021-10-08 op is not given its value will be the same of
468 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
469 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
470 bba111bc 2021-03-28 op been taken to include also bindings familiar for
475 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
476 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
477 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
478 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
480 bba111bc 2021-03-28 op Keys are usually a single character, like
484 bba111bc 2021-03-28 op but some special keys are accepted as well.
486 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
496 bba111bc 2021-03-28 op Previous page/Page up
498 bba111bc 2021-03-28 op Next page/Page down
503 bba111bc 2021-03-28 op .It <f0> thru <f63>
504 bba111bc 2021-03-28 op Function keys
505 bba111bc 2021-03-28 op .It del or backspace
509 bba111bc 2021-03-28 op .It space or spc
511 bba111bc 2021-03-28 op .It enter or ret
516 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
519 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
520 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
522 7dbaef94 2021-04-22 op previous-line
528 7dbaef94 2021-04-22 op backward-char
530 7dbaef94 2021-04-22 op backward-paragraph
532 7dbaef94 2021-04-22 op forward-paragraph
534 7dbaef94 2021-04-22 op move-beginning-of-line
536 7dbaef94 2021-04-22 op move-end-of-line
537 bba111bc 2021-03-28 op .It M-v, M-space
539 bba111bc 2021-03-28 op .It C-v, space
542 7dbaef94 2021-04-22 op beginning-of-buffer
544 7dbaef94 2021-04-22 op end-of-buffer
546 7dbaef94 2021-04-22 op kill-telescope
550 7dbaef94 2021-04-22 op clear-minibuf
552 7dbaef94 2021-04-22 op execute-extended-command
554 61251035 2021-06-26 op dec-fill-column
556 61251035 2021-06-26 op inc-fill-column
558 1c412d48 2021-06-25 op previous-heading
564 f2ab2540 2021-07-14 op load-current-url
568 7dbaef94 2021-04-22 op load-current-url
574 7dbaef94 2021-04-22 op tab-close-other
586 7dbaef94 2021-04-22 op previous-page
590 7dbaef94 2021-04-22 op bookmark-page
591 bba111bc 2021-03-28 op .It <f7> <f7>
592 7dbaef94 2021-04-22 op list-bookmarks
594 12cf7d80 2021-07-15 op suspend-telescope
596 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
597 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
599 7dbaef94 2021-04-22 op previous-line
605 7dbaef94 2021-04-22 op backward-char
607 7dbaef94 2021-04-22 op backward-paragraph
609 7dbaef94 2021-04-22 op forward-paragraph
611 7dbaef94 2021-04-22 op move-beginning-of-line
613 7dbaef94 2021-04-22 op move-end-of-line
615 7dbaef94 2021-04-22 op scroll-line-up
617 7dbaef94 2021-04-22 op scroll-line-down
619 7dbaef94 2021-04-22 op beginning-of-buffer
621 7dbaef94 2021-04-22 op end-of-buffer
641 7dbaef94 2021-04-22 op previous-page
645 4e5935f4 2022-01-05 op tab-undo-close
647 7dbaef94 2021-04-22 op kill-telescope
649 7dbaef94 2021-04-22 op clear-minibuf
651 7dbaef94 2021-04-22 op execute-extended-command
653 bba111bc 2021-03-28 op .Ss CUA-like keys
654 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
656 7dbaef94 2021-04-22 op previous-line
662 7dbaef94 2021-04-22 op backward-char
664 12cf7d80 2021-07-15 op move-beginning-of-line
666 12cf7d80 2021-07-15 op move-end-of-line
675 3c3af0fd 2021-07-08 op .It M-<prior>
680 135e1a52 2021-01-02 op previous-page
682 7dbaef94 2021-04-22 op previous-page
683 bba111bc 2021-03-28 op .It M-<right>
690 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
691 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
697 7dbaef94 2021-04-22 op push-button-new-tab
699 7dbaef94 2021-04-22 op previous-button
701 8dc60352 2021-06-15 op previous-button
719 e95a7248 2022-02-08 op reply-last-input
723 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
724 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
726 7dbaef94 2021-04-22 op mini-complete-and-exit
732 7dbaef94 2021-04-22 op mini-delete-char
734 7dbaef94 2021-04-22 op mini-delete-backward-char
735 bba111bc 2021-03-28 op .It backspace
736 7dbaef94 2021-04-22 op mini-delete-backward-char
738 7dbaef94 2021-04-22 op mini-delete-backward-char
740 7dbaef94 2021-04-22 op backward-char
744 7dbaef94 2021-04-22 op backward-char
748 7dbaef94 2021-04-22 op move-end-of-line
750 7dbaef94 2021-04-22 op move-beginning-of-line
752 7dbaef94 2021-04-22 op move-end-of-line
754 7dbaef94 2021-04-22 op move-beginning-of-line
756 7dbaef94 2021-04-22 op mini-kill-line
758 067b7ffd 2022-04-15 op mini-kill-whole-line
760 7dbaef94 2021-04-22 op mini-previous-history-element
762 7dbaef94 2021-04-22 op mini-next-history-element
764 e7b982f4 2021-07-14 op previous-completion
766 dffb2592 2021-07-14 op next-completion
768 dffb2592 2021-07-14 op previous-completion
770 e7b982f4 2021-07-14 op next-completion
772 e7b982f4 2021-07-14 op insert-current-candidate
774 7ee780fa 2021-07-21 op mini-goto-beginning
776 7ee780fa 2021-07-21 op mini-goto-end
778 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
779 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
780 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
781 bba111bc 2021-03-28 op .Ic execute-extended-command .
782 bba111bc 2021-03-28 op .Ss Movement commands
783 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
784 bba111bc 2021-03-28 op .It Ic backward-char
785 bba111bc 2021-03-28 op Move point one character backward.
786 bba111bc 2021-03-28 op .It Ic backward-paragraph
787 bba111bc 2021-03-28 op Move point one paragraph backward.
788 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
789 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
790 bba111bc 2021-03-28 op .It Ic end-of-buffer
791 bba111bc 2021-03-28 op Move point to the end of the buffer.
792 bba111bc 2021-03-28 op .It Ic forward-char
793 bba111bc 2021-03-28 op Move point one character forward.
794 bba111bc 2021-03-28 op .It Ic forward-paragraph
795 bba111bc 2021-03-28 op Move point one paragraph forward.
796 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
797 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
798 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
799 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
800 bba111bc 2021-03-28 op .It Ic move-end-of-line
801 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
802 bba111bc 2021-03-28 op .It Ic next-button
803 bba111bc 2021-03-28 op Move point to the next link.
804 e7b982f4 2021-07-14 op .It Ic next-completion
805 e7b982f4 2021-07-14 op Select the next completion.
806 1c412d48 2021-06-25 op .It Ic next-heading
807 1c412d48 2021-06-25 op Move point to the next heading.
808 bba111bc 2021-03-28 op .It Ic next-line
809 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
810 bba111bc 2021-03-28 op .It Ic previous-button
811 bba111bc 2021-03-28 op Move point to the previous link.
812 e7b982f4 2021-07-14 op .It Ic previous-completion
813 e7b982f4 2021-07-14 op Select the previous completion.
814 1c412d48 2021-06-25 op .It Ic previous-heading
815 1c412d48 2021-06-25 op Move point to the previous heading.
816 bba111bc 2021-03-28 op .It Ic previous-line
817 bba111bc 2021-03-28 op Move point to the previous (visual) line.
819 bba111bc 2021-03-28 op .Ss Bookmark-related commands
820 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
821 bba111bc 2021-03-28 op .It Ic bookmark-page
822 b3be07ea 2021-07-18 op Save a page in the bookmark file.
823 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
824 63875195 2021-04-01 op .It Ic list-bookmarks
825 bba111bc 2021-03-28 op Load the bookmarks page.
827 c0be9207 2024-02-06 op .Ss Client certificate-related commands
828 c0be9207 2024-02-06 op .Bl -tag -width execute-extended-command -compact
829 c0be9207 2024-02-06 op .It Ic client-certificate-info
830 c0be9207 2024-02-06 op Show the active client certificate.
831 c0be9207 2024-02-06 op .It Ic unload-certificate
832 06d1fa32 2024-02-08 op Forget the certificate on this page.
833 c0be9207 2024-02-06 op .It Ic use-certificate
834 c0be9207 2024-02-06 op Use a certificate for the current page.
836 bba111bc 2021-03-28 op .Ss Tab-related commands
837 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
838 bba111bc 2021-03-28 op .It Ic tab-close
839 bba111bc 2021-03-28 op Close the current tab.
840 bba111bc 2021-03-28 op .It Ic tab-close-other
841 bba111bc 2021-03-28 op Close all tabs but the current one.
842 bba111bc 2021-03-28 op .It Ic tab-move
843 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
845 bba111bc 2021-03-28 op .It Ic tab-move-to
846 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
847 bba111bc 2021-03-28 op .It Ic tab-new
848 bba111bc 2021-03-28 op Open a new tab.
849 bba111bc 2021-03-28 op .It Ic tab-next
850 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
851 bba111bc 2021-03-28 op .It Ic tab-previous
852 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
853 3360ef1b 2021-07-14 op .It Ic tab-select
854 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
855 4e5935f4 2022-01-05 op .It Ic tab-undo-close
856 4e5935f4 2022-01-05 op Re-open the most recently closed tab, if any.
858 bba111bc 2021-03-28 op .Ss Misc commands
859 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
860 1495fbb2 2022-01-12 op .It Ic cache-info
861 1495fbb2 2022-01-12 op Show cache stats.
862 bba111bc 2021-03-28 op .It Ic clear-minibuf
863 b3be07ea 2021-07-18 op Clear the echo area.
864 61251035 2021-06-26 op .It Ic dec-fill-column
865 b3be07ea 2021-07-18 op Decrement fill-column by two.
866 bba111bc 2021-03-28 op .It Ic execute-extended-command
867 b3be07ea 2021-07-18 op Execute an internal command.
869 a36bb43a 2024-01-15 op Go to the home directory.
870 a36bb43a 2024-01-15 op The home directory is assumed to be the first path component in the
871 a36bb43a 2024-01-15 op .Sy ~username
873 a36bb43a 2024-01-15 op If not found, loads the root directory.
874 bba111bc 2021-03-28 op .It Ic kill-telescope
877 61251035 2021-06-26 op .It Ic inc-fill-column
878 b3be07ea 2021-07-18 op Increment fill-column by two.
879 753c6ac7 2021-07-14 op .It Ic link-select
880 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
881 bba111bc 2021-03-28 op .It Ic load-current-url
882 b3be07ea 2021-07-18 op Edit the current URL.
883 bba111bc 2021-03-28 op .It Ic load-url
884 b3be07ea 2021-07-18 op Prompt for an URL.
885 4bb6a4fa 2024-01-15 op Use the same heuristic as the URLs given as a command-line argument,
887 4bb6a4fa 2024-01-15 op .Ic load-url-use-heuristic
888 4bb6a4fa 2024-01-15 op option is unsed, in which case the URL is resolved using the current
890 bba111bc 2021-03-28 op .It Ic next-page
891 b3be07ea 2021-07-18 op Go forward in the page history.
892 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
893 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
895 9a7d62cb 2021-07-21 op .It Ic other-window
896 9a7d62cb 2021-07-21 op Select the other window.
897 bba111bc 2021-03-28 op .It Ic previous-page
898 b3be07ea 2021-07-18 op Go backward in the page history.
899 bba111bc 2021-03-28 op .It Ic push-button
900 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
901 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
902 bba111bc 2021-03-28 op .It Ic push-button-new-tab
903 b3be07ea 2021-07-18 op Follow link at point in a new tab.
904 bba111bc 2021-03-28 op .It Ic redraw
905 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
907 661233ed 2021-07-14 op .It Ic reload-page
908 661233ed 2021-07-14 op Reload the current page.
909 e95a7248 2022-02-08 op .It Ic reply-last-input
910 e95a7248 2022-02-08 op Reply the last input request.
912 a36bb43a 2024-01-15 op Go to the root directory.
913 fd6c540b 2024-02-12 op .It Ic search
914 fd6c540b 2024-02-12 op Search using the preferred search engine.
915 bba111bc 2021-03-28 op .It Ic scroll-down
916 bba111bc 2021-03-28 op Scroll down by one visual page.
917 bba111bc 2021-03-28 op .It Ic scroll-line-down
918 bba111bc 2021-03-28 op Scroll down by one line.
919 bba111bc 2021-03-28 op .It Ic scroll-line-up
920 bba111bc 2021-03-28 op Scroll up by one line.
921 bba111bc 2021-03-28 op .It Ic scroll-up
922 bba111bc 2021-03-28 op Scroll up by one visual page.
923 12cf7d80 2021-07-15 op .It Ic suspend-telescope
924 12cf7d80 2021-07-15 op Suspend the current
927 753c6ac7 2021-07-14 op .It Ic swiper
928 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
930 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
931 7a014cef 2021-04-01 op .It Ic toggle-help
932 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
933 7a014cef 2021-04-01 op interactive command.
934 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
935 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
937 a36bb43a 2024-01-15 op Go up one level in the path hierarchy.
938 288b931b 2022-04-13 op .It Ic write-buffer
939 288b931b 2022-04-13 op Save the current buffer to the disk.
941 bba111bc 2021-03-28 op .Ss Minibuffer commands
942 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
943 bba111bc 2021-03-28 op .It Ic mini-abort
944 bba111bc 2021-03-28 op Abort the current minibuffer action.
945 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
946 bba111bc 2021-03-28 op Complete the current minibuffer action.
947 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
948 bba111bc 2021-03-28 op Delete the character before the point.
949 bba111bc 2021-03-28 op .It Ic mini-delete-char
950 bba111bc 2021-03-28 op Delete the character after the point.
951 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
952 de190a2b 2021-07-17 op Select the first completion, if any.
953 de190a2b 2021-07-17 op .It Ic mini-goto-end
954 de190a2b 2021-07-17 op Select the last completion, if any.
955 bba111bc 2021-03-28 op .It Ic mini-kill-line
956 b3be07ea 2021-07-18 op Delete from point until the end of the line.
957 067b7ffd 2022-04-15 op .It Ic mini-kill-whole-line
958 067b7ffd 2022-04-15 op Delete the whole line.
959 bba111bc 2021-03-28 op .It Ic mini-next-history-element
960 bba111bc 2021-03-28 op Load the previous history element.
961 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
962 bba111bc 2021-03-28 op Load the next history element.
965 7d2d15f5 2021-04-30 op The following aliases are available during
966 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
967 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
972 c82b3fd6 2021-05-12 op .It Ic tabnew
975 c82b3fd6 2021-05-12 op .Ic tab-previous
976 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
977 7d2d15f5 2021-04-30 op .Ic kill-telescope
979 288b931b 2022-04-13 op .Ic write-buffer
981 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
984 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
985 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
987 7ee780fa 2021-07-21 op The user's login directory.
988 7ee780fa 2021-07-21 op .It Ev NO_COLORS
989 7ee780fa 2021-07-21 op To decide whether to use colors or not.
990 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
992 7ee780fa 2021-07-21 op The user's terminal name.
993 73389b00 2021-10-08 op .It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
994 73389b00 2021-10-08 op If defined can alter the default location of the files used.
999 73389b00 2021-10-08 op follows the XDG Base Directory Specification.
1001 73389b00 2021-10-08 op .Pa ~/.telescope
1002 73389b00 2021-10-08 op exists, XDG is ignored and all the files are stored inside it.
1003 73389b00 2021-10-08 op The usage of
1004 73389b00 2021-10-08 op .Ev XDG_CACHE_HOME ,
1005 73389b00 2021-10-08 op .Ev XDG_CONFIG_HOME
1007 73389b00 2021-10-08 op .Ev XDG_DATA_HOME
1008 73389b00 2021-10-08 op can further alter the location of these files.
1010 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
1011 eb2ed626 2021-10-07 op .It Pa ~/.config/telescope/config
1012 dca97b00 2021-06-19 op Default configuration file.
1013 de04b178 2021-11-26 op .It Pa ~/.local/share/telescope/pages/about_*.gmi
1014 eb2ed626 2021-10-07 op Overrides for built-in about: pages.
1015 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/bookmarks.gmi
1016 eb2ed626 2021-10-07 op Bookmarks file.
1017 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/known_hosts
1018 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
1019 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
1020 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
1021 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/lock
1022 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
1024 d0fd368a 2021-07-15 op from running at the same time.
1025 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/session
1026 7ee780fa 2021-07-21 op The list of tabs from the last session.
1028 74ca8ef4 2021-06-19 op .Sh EXAMPLES
1029 984245ce 2021-06-23 op It's possible to browse
1030 984245ce 2021-06-23 op .Dq the small web
1031 984245ce 2021-06-23 op .Pq i.e. simple websites
1032 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
1033 eb2ed626 2021-10-07 op .Pa ~/.config/telescope/config :
1034 984245ce 2021-06-23 op .Bd -literal -offset indent
1035 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
1036 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
1041 7ee780fa 2021-07-21 op without any configuration
1042 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
1043 19f9cf0f 2021-06-24 op telescope -c /dev/null
1045 73389b00 2021-10-08 op .Sh STANDARDS
1047 73389b00 2021-10-08 op .%B XDG Base Directory Specification
1048 73389b00 2021-10-08 op .%U https://specifications.freedesktop.org/basedir-spec/latest/
1050 c7067b0b 2022-01-13 op .Sh ACKNOWLEDGEMENTS
1052 c7067b0b 2022-01-13 op .Dq Trust, but verify (where appropriate)
1053 c7067b0b 2022-01-13 op TOFU scheme was firstly suggested by thfr:
1054 c7067b0b 2022-01-13 op .Lk gemini://thfr.info/gemini/modified-trust-verify.gmi .
1056 bba111bc 2021-03-28 op .An -nosplit
1059 bba111bc 2021-03-28 op program was written by
1060 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
1063 95e30305 2021-01-02 op assumes a UTF-8 environment and doesn't try to cope with other encodings.
1064 95e30305 2021-01-02 op This can cause strange rendering issues if you're lucky, or possibly
1065 95e30305 2021-01-02 op weird thing happening depending on your locale and terminal emulator.
1067 b240cdbb 2022-01-13 op The algorithm used for text-wrapping is naive and doesn't really work for
1068 b240cdbb 2022-01-13 op languages that make heavily use of glyphs composed by multiple UNICODE
1071 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.
