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 04146b9f 2021-11-29 op .Dd $Mdocdate: November 29 2021$
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 a599eaa6 2021-01-02 op .It Fl C , Fl -colours
38 97870a34 2021-07-15 op Show all available colors and exit.
39 a599eaa6 2021-01-02 op This option can also be spelled
41 dee3a166 2021-11-29 op .It Fl c Ar config
42 c92e529c 2021-06-15 op Specify an alternative configuration file.
44 dee3a166 2021-11-29 op .Pa ~/.config/telescope/config
46 ccc5591f 2021-07-15 op .It Fl h , Fl -help
47 ccc5591f 2021-07-15 op Display version and usage.
49 ccc5591f 2021-07-15 op Configtest mode.
50 ccc5591f 2021-07-15 op Only check the configuration file for validity.
51 d0971653 2021-09-15 op .It Fl S , Fl -safe
53 d0971653 2021-09-15 op .Pq or Dq sandbox
57 d34a1873 2021-09-15 op from writing files to the disk and to acquire the lock, allowing to
58 d34a1873 2021-09-15 op run multiple instances at the same time.
60 d34a1873 2021-09-15 op still loads the session file and the custom about pages.
61 dc761924 2021-07-15 op .It Fl v , Fl -version
62 dc761924 2021-07-15 op Display version.
64 7ee780fa 2021-07-21 op .Sh UI CONCEPTS
66 7ee780fa 2021-07-21 op interface is divided into four areas: the tabline, the body, the
67 7ee780fa 2021-07-21 op modeline and the echoarea/minibuffer.
69 7ee780fa 2021-07-21 op The tabline is always at the top of the screen and displays the tabs
70 7ee780fa 2021-07-21 op separated by a vertical line.
71 7ee780fa 2021-07-21 op When there are more tabs than the size of the window allow to display,
72 7ee780fa 2021-07-21 op the characters
76 7ee780fa 2021-07-21 op are shown at the start/end of the tabline to indicate that there are
77 7ee780fa 2021-07-21 op more tabs in that direction.
79 7ee780fa 2021-07-21 op The body occupies the majority of the visible area.
80 7ee780fa 2021-07-21 op It contains the current page and optionally a side window.
82 7ee780fa 2021-07-21 op The modeline is the second to last row of the screen.
83 7ee780fa 2021-07-21 op It shows some information about the page: a spinner when the page is
84 7ee780fa 2021-07-21 op loading, the trust level, the document type, the scroll offset and the
87 7ee780fa 2021-07-21 op The echoarea is usually the last line of the screen.
88 7ee780fa 2021-07-21 op Messages are often showed there, and link addresses too.
89 7ee780fa 2021-07-21 op The echoarea is also used to obtain input from the user.
90 7ee780fa 2021-07-21 op When commands like
93 7ee780fa 2021-07-21 op .Ic link-select
94 9eb0c887 2021-08-03 op are invoked, the minibuffer area grows to show possible completions.
97 7ee780fa 2021-07-21 op aims to use the
98 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
101 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
102 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
103 bba111bc 2021-03-28 op .Bl -tag -width 12m
104 bba111bc 2021-03-28 op .It untrusted
106 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
109 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
112 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
115 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
116 7ee780fa 2021-07-21 op indicated character.
118 bba111bc 2021-03-28 op Most of the time the
120 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
121 bba111bc 2021-03-28 op verify out-of-band the certificate.
123 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
124 bba111bc 2021-03-28 op verification though.
125 f1279523 2021-08-13 op .Sh SUPPORTED PROTOCOLS
126 f1279523 2021-08-13 op The following protocols are supported:
127 f1279523 2021-08-13 op .Bl -tag -width gemini://
129 f1279523 2021-08-13 op About pages are
131 f1279523 2021-08-13 op internal page.
132 f1279523 2021-08-13 op See about:about for a list of all these pages.
134 f1279523 2021-08-13 op File types know to
136 f1279523 2021-08-13 op such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
137 f1279523 2021-08-13 op viewed inside the application.
138 f1279523 2021-08-13 op Types of local files are detected solely based on the file extension.
139 f1279523 2021-08-13 op On some systems, such as
141 f1279523 2021-08-13 op only files inside special directories
142 f1279523 2021-08-13 op .Pq like Pa /tmp No or Pa ~/Downloads
143 f1279523 2021-08-13 op are available.
144 f1279523 2021-08-13 op .It finger://
145 f1279523 2021-08-13 op Finger URLs are interpreted as follows:
146 4a52e6fe 2021-08-03 op .Bl -bullet -compact
148 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
150 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
151 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
154 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
156 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
157 f1279523 2021-08-13 op are treated as the same URL.
158 f1279523 2021-08-13 op .It gemini://
159 f1279523 2021-08-13 op Gemini is fully supported, with the exception of client-certificates.
160 f1279523 2021-08-13 op .It gopher://
161 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
162 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
165 eb6e7b8a 2021-08-16 op User-entered URLs, given as argument on the command line or entered
167 eb6e7b8a 2021-08-16 op .Ic load-url ,
168 eb6e7b8a 2021-08-16 op are intepreted with a simple heuristic:
169 eb6e7b8a 2021-08-16 op .Bl -bullet -compact
171 eb6e7b8a 2021-08-16 op if it's a proper absolute URL then use it as-is,
173 eb6e7b8a 2021-08-16 op if it starts with
177 eb6e7b8a 2021-08-16 op assume it's a file:// URL,
179 eb6e7b8a 2021-08-16 op otherwise assume it's a Gemini URL.
181 a74a9f2c 2021-10-08 op .Sh CONFIGURATION FILE
182 a74a9f2c 2021-10-08 op During the startup,
184 a74a9f2c 2021-10-08 op reads the configuration file at
185 a74a9f2c 2021-10-08 op .Pa ~/.config/telescope/config
187 a74a9f2c 2021-10-08 op .Pa ~/.telescope/config .
189 a74a9f2c 2021-10-08 op It's possible to load a custom configuration file using the
194 a74a9f2c 2021-10-08 op will also load a file called
195 a74a9f2c 2021-10-08 op .Pa config-TERM ,
198 a74a9f2c 2021-10-08 op is the name of the terminal type
199 a74a9f2c 2021-10-08 op .Pq i.e. the TERM environment variable ,
200 a74a9f2c 2021-10-08 op if it exists.
202 a74a9f2c 2021-10-08 op The format of the configuration file is fairly flexible.
203 a74a9f2c 2021-10-08 op The current line can be extended over multiple ones using a
206 a74a9f2c 2021-10-08 op Comments can be put anywhere in the file using a hash mark
208 a74a9f2c 2021-10-08 op and extend to the end of the current line, but backslashes can't be
209 a74a9f2c 2021-10-08 op used to extend comments over multiple lines.
211 a74a9f2c 2021-10-08 op The following constructs are available:
212 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
213 a74a9f2c 2021-10-08 op .It Ic bind Ar map Ar key Ar cmd
216 a74a9f2c 2021-10-08 op to the function
218 a74a9f2c 2021-10-08 op in the keymap
220 a74a9f2c 2021-10-08 op Valid values for map are
221 a74a9f2c 2021-10-08 op .Dq global-map
222 a74a9f2c 2021-10-08 op .Pq i.e. when the user is viewing a page
224 a74a9f2c 2021-10-08 op .Dq minibuffer-map
225 a74a9f2c 2021-10-08 op .Pq i.e. when the minibuffer has the focus.
227 a74a9f2c 2021-10-08 op follows the same syntax described in
228 a74a9f2c 2021-10-08 op .Sx DEFAULT KEY BINDINGS
229 a74a9f2c 2021-10-08 op and all the possible functions are listed in
230 a74a9f2c 2021-10-08 op .Sx INTERACTIVE COMMANDS .
231 a74a9f2c 2021-10-08 op .It Ic proxy Ar proto Ic via Ar url
234 a74a9f2c 2021-10-08 op as proxy for all URLs with
238 a74a9f2c 2021-10-08 op must be a Gemini URI without path, query and fragment component.
239 a74a9f2c 2021-10-08 op .It Ic set Ar opt No = Ar val
240 a74a9f2c 2021-10-08 op Set the option
244 a74a9f2c 2021-10-08 op Valid options are:
246 a74a9f2c 2021-10-08 op .Bl -tag -width twelveletters -compact
249 a74a9f2c 2021-10-08 op If greater than zero, save the session after the specified amount of
250 a74a9f2c 2021-10-08 op seconds after some events happens
251 a74a9f2c 2021-10-08 op .Pq new or closed tabs, visited a link ...
252 a74a9f2c 2021-10-08 op Defaults to 20.
253 a74a9f2c 2021-10-08 op .It dont-wrap-pre
255 a74a9f2c 2021-10-08 op If nonzero, don't wrap preformatted blocks.
256 a74a9f2c 2021-10-08 op Defaults to 0.
257 a74a9f2c 2021-10-08 op .It download-path
259 a74a9f2c 2021-10-08 op The default download path.
262 a74a9f2c 2021-10-08 op .It emojify-link
264 a74a9f2c 2021-10-08 op If nonzero, when the text of a link starts with an emoji followed by a
265 a74a9f2c 2021-10-08 op space, use that emoji as line prefix.
266 a74a9f2c 2021-10-08 op Defaults to 1.
267 a74a9f2c 2021-10-08 op .It enable-colors
269 a74a9f2c 2021-10-08 op If nonzero, enable colours.
270 a74a9f2c 2021-10-08 op Defaults to 0 if
271 a74a9f2c 2021-10-08 op .Ev NO_COLORS
272 a74a9f2c 2021-10-08 op is set, 1 otherwise.
273 a74a9f2c 2021-10-08 op .It fill-column
275 a74a9f2c 2021-10-08 op If greater than zero, lines of text will be formatted in a way that
276 a74a9f2c 2021-10-08 op don't exceed the given number of columns.
277 a74a9f2c 2021-10-08 op Defaults to 80.
278 a74a9f2c 2021-10-08 op .It hide-pre-blocks
280 a74a9f2c 2021-10-08 op If nonzero, hide by default the body of the preformatted blocks.
281 a74a9f2c 2021-10-08 op Defaults to zero.
282 a74a9f2c 2021-10-08 op .Ic push-button
283 a74a9f2c 2021-10-08 op can be used to toggle the visibility per-block.
284 a74a9f2c 2021-10-08 op .It hide-pre-closing-line
286 a74a9f2c 2021-10-08 op If nonzero, hide the closing line of preformatted blocks.
287 a74a9f2c 2021-10-08 op Defaults to 0.
288 a74a9f2c 2021-10-08 op .It hide-pre-context
290 a74a9f2c 2021-10-08 op If nonzero, hide the start and end line of the preformatted blocks.
291 a74a9f2c 2021-10-08 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
292 a74a9f2c 2021-10-08 op blocks are irremediably hidden.
293 a74a9f2c 2021-10-08 op Defaults to zero.
294 a74a9f2c 2021-10-08 op .It new-tab-url
296 a74a9f2c 2021-10-08 op URL for the new tab page.
298 a74a9f2c 2021-10-08 op .Dq about:new .
299 a74a9f2c 2021-10-08 op .It olivetti-mode
301 a74a9f2c 2021-10-08 op If nonzero, enable
302 a74a9f2c 2021-10-08 op .Ic olivetti-mode
303 a74a9f2c 2021-10-08 op Defaults to 1.
304 a74a9f2c 2021-10-08 op .It set-title
306 a74a9f2c 2021-10-08 op If nonzero, set the terminal title to the page title.
307 a74a9f2c 2021-10-08 op Defaults to 1.
308 a74a9f2c 2021-10-08 op .It tab-bar-show
310 a74a9f2c 2021-10-08 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
311 a74a9f2c 2021-10-08 op unconditionally.
312 a74a9f2c 2021-10-08 op If it's 1, show the bar only when there is more than one tab.
313 a74a9f2c 2021-10-08 op Defaults to 1.
315 a74a9f2c 2021-10-08 op .It Ic style Ar name Ar option
316 a74a9f2c 2021-10-08 op Change the styling of the element identified by
318 a74a9f2c 2021-10-08 op Multiple options may be specified within curly braces.
319 a74a9f2c 2021-10-08 op Valid style identifiers are:
320 399bd9a0 2021-11-05 op .Bl -tag -width line.download.ongoing -compact -offset Ds
322 a74a9f2c 2021-10-08 op the area outside the lines in the body of the page.
323 a74a9f2c 2021-10-08 op .It line.compl
324 a74a9f2c 2021-10-08 op the completions.
325 a74a9f2c 2021-10-08 op .It line.compl.current
326 a74a9f2c 2021-10-08 op the current completion.
327 a74a9f2c 2021-10-08 op .It line.help
328 a74a9f2c 2021-10-08 op text in the *Help* buffer.
329 399bd9a0 2021-11-05 op .It line.download.ongoing
330 399bd9a0 2021-11-05 op an ongoing download
331 399bd9a0 2021-11-05 op .It line.download.done
332 399bd9a0 2021-11-05 op a completed download
333 399bd9a0 2021-11-05 op .It line.download.info
334 399bd9a0 2021-11-05 op informational text in the *Downloads* buffer.
335 a74a9f2c 2021-10-08 op .It line.text
337 a74a9f2c 2021-10-08 op .It line.link
339 a74a9f2c 2021-10-08 op .It line.title1..3
341 a74a9f2c 2021-10-08 op .It line.item
343 a74a9f2c 2021-10-08 op .It line.quote
345 a74a9f2c 2021-10-08 op .It line.pre.start
346 a74a9f2c 2021-10-08 op the heading of a preformatted block.
348 a74a9f2c 2021-10-08 op the content of a preformatted block.
349 a74a9f2c 2021-10-08 op .It line.pre.end
350 a74a9f2c 2021-10-08 op the closing line of a preformatted block.
352 399bd9a0 2021-11-05 op the download pane
353 a74a9f2c 2021-10-08 op .It minibuffer
354 a74a9f2c 2021-10-08 op the minibuffer.
356 a74a9f2c 2021-10-08 op the modeline.
359 a74a9f2c 2021-10-08 op .It tabline.tab
360 a74a9f2c 2021-10-08 op the non-focused tabs.
361 a74a9f2c 2021-10-08 op .It tabline.current
362 a74a9f2c 2021-10-08 op the focused tab.
365 a74a9f2c 2021-10-08 op Valid options are:
366 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
367 a74a9f2c 2021-10-08 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
368 a74a9f2c 2021-10-08 op Sets the text attributes.
369 a74a9f2c 2021-10-08 op If only one value is given,
373 a74a9f2c 2021-10-08 op default to that; if two values are given then
377 a74a9f2c 2021-10-08 op Each attribute is a comma-separated list of keywords:
378 a74a9f2c 2021-10-08 op .Bl -tag -width underline -compact -offset Ds
379 a74a9f2c 2021-10-08 op .It Ic normal
380 a74a9f2c 2021-10-08 op no attributes.
381 a74a9f2c 2021-10-08 op .It Ic standout
382 a74a9f2c 2021-10-08 op best highlighting mode for the terminal.
383 a74a9f2c 2021-10-08 op .It Ic underline
384 a74a9f2c 2021-10-08 op underlines the text.
385 a74a9f2c 2021-10-08 op .It Ic reverse
386 a74a9f2c 2021-10-08 op reverses background/foreground colors.
388 a74a9f2c 2021-10-08 op makes the text blinking.
392 a74a9f2c 2021-10-08 op extra bright or bold.
395 a74a9f2c 2021-10-08 op Only the style identifiers with the
397 a74a9f2c 2021-10-08 op prefix accept up to three attributes.
398 a74a9f2c 2021-10-08 op The other will only use the first one given.
399 a74a9f2c 2021-10-08 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
400 a74a9f2c 2021-10-08 op Sets the background color.
401 a74a9f2c 2021-10-08 op Follows the same behaviour as
403 a74a9f2c 2021-10-08 op regarding the optional parameters.
404 a74a9f2c 2021-10-08 op The colour is one of black, red, green, yellow, blue,
405 a74a9f2c 2021-10-08 op magenta, cyan and white; colour0 to colour255
406 a74a9f2c 2021-10-08 op .Pq or color0 to color255
407 a74a9f2c 2021-10-08 op from the 256-colour set;
408 a74a9f2c 2021-10-08 op default for the default colour.
409 a74a9f2c 2021-10-08 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
410 a74a9f2c 2021-10-08 op Sets the foreground color.
411 a74a9f2c 2021-10-08 op It behaves just like
413 a74a9f2c 2021-10-08 op .It Ic prefix Ar prfx Op Ar cont
414 a74a9f2c 2021-10-08 op Sets the prefix for the current line type to
418 a74a9f2c 2021-10-08 op as the prefix for the continuation lines
419 a74a9f2c 2021-10-08 op .Pq i.e. when a long line gets wrapped.
422 a74a9f2c 2021-10-08 op is not given its value will be the same of
426 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
427 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
428 bba111bc 2021-03-28 op been taken to include also bindings familiar for
433 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
434 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
435 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
436 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
438 bba111bc 2021-03-28 op Keys are usually a single character, like
442 bba111bc 2021-03-28 op but some special keys are accepted as well.
444 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
454 bba111bc 2021-03-28 op Previous page/Page up
456 bba111bc 2021-03-28 op Next page/Page down
461 bba111bc 2021-03-28 op .It <f0> thru <f63>
462 bba111bc 2021-03-28 op Function keys
463 bba111bc 2021-03-28 op .It del or backspace
467 bba111bc 2021-03-28 op .It space or spc
469 bba111bc 2021-03-28 op .It enter or ret
474 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
477 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
478 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
480 7dbaef94 2021-04-22 op previous-line
486 7dbaef94 2021-04-22 op backward-char
488 7dbaef94 2021-04-22 op backward-paragraph
490 7dbaef94 2021-04-22 op forward-paragraph
492 7dbaef94 2021-04-22 op move-beginning-of-line
494 7dbaef94 2021-04-22 op move-end-of-line
495 bba111bc 2021-03-28 op .It M-v, M-space
497 bba111bc 2021-03-28 op .It C-v, space
500 7dbaef94 2021-04-22 op beginning-of-buffer
502 7dbaef94 2021-04-22 op end-of-buffer
504 7dbaef94 2021-04-22 op kill-telescope
506 7dbaef94 2021-04-22 op clear-minibuf
508 7dbaef94 2021-04-22 op execute-extended-command
510 61251035 2021-06-26 op dec-fill-column
512 61251035 2021-06-26 op inc-fill-column
514 1c412d48 2021-06-25 op previous-heading
520 f2ab2540 2021-07-14 op load-current-url
524 7dbaef94 2021-04-22 op load-current-url
530 7dbaef94 2021-04-22 op tab-close-other
542 7dbaef94 2021-04-22 op previous-page
546 7dbaef94 2021-04-22 op bookmark-page
547 bba111bc 2021-03-28 op .It <f7> <f7>
548 7dbaef94 2021-04-22 op list-bookmarks
550 12cf7d80 2021-07-15 op suspend-telescope
552 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
553 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
555 7dbaef94 2021-04-22 op previous-line
561 7dbaef94 2021-04-22 op backward-char
563 7dbaef94 2021-04-22 op backward-paragraph
565 7dbaef94 2021-04-22 op forward-paragraph
567 7dbaef94 2021-04-22 op move-beginning-of-line
569 7dbaef94 2021-04-22 op move-end-of-line
571 7dbaef94 2021-04-22 op scroll-line-up
573 7dbaef94 2021-04-22 op scroll-line-down
575 7dbaef94 2021-04-22 op beginning-of-buffer
577 7dbaef94 2021-04-22 op end-of-buffer
591 7dbaef94 2021-04-22 op previous-page
595 7dbaef94 2021-04-22 op kill-telescope
597 7dbaef94 2021-04-22 op clear-minibuf
599 7dbaef94 2021-04-22 op execute-extended-command
601 bba111bc 2021-03-28 op .Ss CUA-like keys
602 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
604 7dbaef94 2021-04-22 op previous-line
610 7dbaef94 2021-04-22 op backward-char
612 12cf7d80 2021-07-15 op move-beginning-of-line
614 12cf7d80 2021-07-15 op move-end-of-line
623 3c3af0fd 2021-07-08 op .It M-<prior>
628 135e1a52 2021-01-02 op previous-page
630 7dbaef94 2021-04-22 op previous-page
631 bba111bc 2021-03-28 op .It M-<right>
638 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
639 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
645 7dbaef94 2021-04-22 op push-button-new-tab
647 7dbaef94 2021-04-22 op previous-button
649 8dc60352 2021-06-15 op previous-button
667 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
668 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
670 7dbaef94 2021-04-22 op mini-complete-and-exit
676 7dbaef94 2021-04-22 op mini-delete-char
678 7dbaef94 2021-04-22 op mini-delete-backward-char
679 bba111bc 2021-03-28 op .It backspace
680 7dbaef94 2021-04-22 op mini-delete-backward-char
682 7dbaef94 2021-04-22 op mini-delete-backward-char
684 7dbaef94 2021-04-22 op backward-char
688 7dbaef94 2021-04-22 op backward-char
692 7dbaef94 2021-04-22 op move-end-of-line
694 7dbaef94 2021-04-22 op move-beginning-of-line
696 7dbaef94 2021-04-22 op move-end-of-line
698 7dbaef94 2021-04-22 op move-beginning-of-line
700 7dbaef94 2021-04-22 op mini-kill-line
702 7dbaef94 2021-04-22 op mini-previous-history-element
704 7dbaef94 2021-04-22 op mini-next-history-element
706 e7b982f4 2021-07-14 op previous-completion
708 dffb2592 2021-07-14 op next-completion
710 dffb2592 2021-07-14 op previous-completion
712 e7b982f4 2021-07-14 op next-completion
714 e7b982f4 2021-07-14 op insert-current-candidate
716 7ee780fa 2021-07-21 op mini-goto-beginning
718 7ee780fa 2021-07-21 op mini-goto-end
720 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
721 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
722 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
723 bba111bc 2021-03-28 op .Ic execute-extended-command .
724 bba111bc 2021-03-28 op .Ss Movement commands
725 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
726 bba111bc 2021-03-28 op .It Ic backward-char
727 bba111bc 2021-03-28 op Move point one character backward.
728 bba111bc 2021-03-28 op .It Ic backward-paragraph
729 bba111bc 2021-03-28 op Move point one paragraph backward.
730 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
731 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
732 bba111bc 2021-03-28 op .It Ic end-of-buffer
733 bba111bc 2021-03-28 op Move point to the end of the buffer.
734 bba111bc 2021-03-28 op .It Ic forward-char
735 bba111bc 2021-03-28 op Move point one character forward.
736 bba111bc 2021-03-28 op .It Ic forward-paragraph
737 bba111bc 2021-03-28 op Move point one paragraph forward.
738 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
739 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
740 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
741 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
742 bba111bc 2021-03-28 op .It Ic move-end-of-line
743 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
744 bba111bc 2021-03-28 op .It Ic next-button
745 bba111bc 2021-03-28 op Move point to the next link.
746 e7b982f4 2021-07-14 op .It Ic next-completion
747 e7b982f4 2021-07-14 op Select the next completion.
748 1c412d48 2021-06-25 op .It Ic next-heading
749 1c412d48 2021-06-25 op Move point to the next heading.
750 bba111bc 2021-03-28 op .It Ic next-line
751 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
752 bba111bc 2021-03-28 op .It Ic previous-button
753 bba111bc 2021-03-28 op Move point to the previous link.
754 e7b982f4 2021-07-14 op .It Ic previous-completion
755 e7b982f4 2021-07-14 op Select the previous completion.
756 1c412d48 2021-06-25 op .It Ic previous-heading
757 1c412d48 2021-06-25 op Move point to the previous heading.
758 bba111bc 2021-03-28 op .It Ic previous-line
759 bba111bc 2021-03-28 op Move point to the previous (visual) line.
761 bba111bc 2021-03-28 op .Ss Bookmark-related commands
762 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
763 bba111bc 2021-03-28 op .It Ic bookmark-page
764 b3be07ea 2021-07-18 op Save a page in the bookmark file.
765 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
766 63875195 2021-04-01 op .It Ic list-bookmarks
767 bba111bc 2021-03-28 op Load the bookmarks page.
769 bba111bc 2021-03-28 op .Ss Tab-related commands
770 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
771 bba111bc 2021-03-28 op .It Ic tab-close
772 bba111bc 2021-03-28 op Close the current tab.
773 bba111bc 2021-03-28 op .It Ic tab-close-other
774 bba111bc 2021-03-28 op Close all tabs but the current one.
775 bba111bc 2021-03-28 op .It Ic tab-move
776 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
778 bba111bc 2021-03-28 op .It Ic tab-move-to
779 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
780 bba111bc 2021-03-28 op .It Ic tab-new
781 bba111bc 2021-03-28 op Open a new tab.
782 bba111bc 2021-03-28 op .It Ic tab-next
783 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
784 bba111bc 2021-03-28 op .It Ic tab-previous
785 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
786 3360ef1b 2021-07-14 op .It Ic tab-select
787 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
789 bba111bc 2021-03-28 op .Ss Misc commands
790 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
791 bba111bc 2021-03-28 op .It Ic clear-minibuf
792 b3be07ea 2021-07-18 op Clear the echo area.
793 61251035 2021-06-26 op .It Ic dec-fill-column
794 b3be07ea 2021-07-18 op Decrement fill-column by two.
795 bba111bc 2021-03-28 op .It Ic execute-extended-command
796 b3be07ea 2021-07-18 op Execute an internal command.
797 bba111bc 2021-03-28 op .It Ic kill-telescope
800 61251035 2021-06-26 op .It Ic inc-fill-column
801 b3be07ea 2021-07-18 op Increment fill-column by two.
802 753c6ac7 2021-07-14 op .It Ic link-select
803 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
804 bba111bc 2021-03-28 op .It Ic load-current-url
805 b3be07ea 2021-07-18 op Edit the current URL.
806 bba111bc 2021-03-28 op .It Ic load-url
807 b3be07ea 2021-07-18 op Prompt for an URL.
808 bba111bc 2021-03-28 op .It Ic next-page
809 b3be07ea 2021-07-18 op Go forward in the page history.
810 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
811 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
813 9a7d62cb 2021-07-21 op .It Ic other-window
814 9a7d62cb 2021-07-21 op Select the other window.
815 bba111bc 2021-03-28 op .It Ic previous-page
816 b3be07ea 2021-07-18 op Go backward in the page history.
817 bba111bc 2021-03-28 op .It Ic push-button
818 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
819 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
820 bba111bc 2021-03-28 op .It Ic push-button-new-tab
821 b3be07ea 2021-07-18 op Follow link at point in a new tab.
822 bba111bc 2021-03-28 op .It Ic redraw
823 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
825 661233ed 2021-07-14 op .It Ic reload-page
826 661233ed 2021-07-14 op Reload the current page.
827 bba111bc 2021-03-28 op .It Ic scroll-down
828 bba111bc 2021-03-28 op Scroll down by one visual page.
829 bba111bc 2021-03-28 op .It Ic scroll-line-down
830 bba111bc 2021-03-28 op Scroll down by one line.
831 bba111bc 2021-03-28 op .It Ic scroll-line-up
832 bba111bc 2021-03-28 op Scroll up by one line.
833 bba111bc 2021-03-28 op .It Ic scroll-up
834 bba111bc 2021-03-28 op Scroll up by one visual page.
835 12cf7d80 2021-07-15 op .It Ic suspend-telescope
836 12cf7d80 2021-07-15 op Suspend the current
839 753c6ac7 2021-07-14 op .It Ic swiper
840 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
842 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
843 7a014cef 2021-04-01 op .It Ic toggle-help
844 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
845 7a014cef 2021-04-01 op interactive command.
846 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
847 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
849 bba111bc 2021-03-28 op .Ss Minibuffer commands
850 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
851 bba111bc 2021-03-28 op .It Ic mini-abort
852 bba111bc 2021-03-28 op Abort the current minibuffer action.
853 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
854 bba111bc 2021-03-28 op Complete the current minibuffer action.
855 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
856 bba111bc 2021-03-28 op Delete the character before the point.
857 bba111bc 2021-03-28 op .It Ic mini-delete-char
858 bba111bc 2021-03-28 op Delete the character after the point.
859 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
860 de190a2b 2021-07-17 op Select the first completion, if any.
861 de190a2b 2021-07-17 op .It Ic mini-goto-end
862 de190a2b 2021-07-17 op Select the last completion, if any.
863 bba111bc 2021-03-28 op .It Ic mini-kill-line
864 b3be07ea 2021-07-18 op Delete from point until the end of the line.
865 bba111bc 2021-03-28 op .It Ic mini-next-history-element
866 bba111bc 2021-03-28 op Load the previous history element.
867 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
868 bba111bc 2021-03-28 op Load the next history element.
871 7d2d15f5 2021-04-30 op The following aliases are available during
872 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
873 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
876 c82b3fd6 2021-05-12 op .It Ic tabnew
879 c82b3fd6 2021-05-12 op .Ic tab-previous
880 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
881 7d2d15f5 2021-04-30 op .Ic kill-telescope
883 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
886 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
887 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
889 7ee780fa 2021-07-21 op The user's login directory.
890 7ee780fa 2021-07-21 op .It Ev NO_COLORS
891 7ee780fa 2021-07-21 op To decide whether to use colors or not.
892 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
894 7ee780fa 2021-07-21 op The user's terminal name.
895 73389b00 2021-10-08 op .It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
896 73389b00 2021-10-08 op If defined can alter the default location of the files used.
901 73389b00 2021-10-08 op follows the XDG Base Directory Specification.
903 73389b00 2021-10-08 op .Pa ~/.telescope
904 73389b00 2021-10-08 op exists, XDG is ignored and all the files are stored inside it.
906 73389b00 2021-10-08 op .Ev XDG_CACHE_HOME ,
907 73389b00 2021-10-08 op .Ev XDG_CONFIG_HOME
909 73389b00 2021-10-08 op .Ev XDG_DATA_HOME
910 73389b00 2021-10-08 op can further alter the location of these files.
912 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
913 eb2ed626 2021-10-07 op .It Pa ~/.config/telescope/config
914 dca97b00 2021-06-19 op Default configuration file.
915 de04b178 2021-11-26 op .It Pa ~/.local/share/telescope/pages/about_*.gmi
916 eb2ed626 2021-10-07 op Overrides for built-in about: pages.
917 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/bookmarks.gmi
918 eb2ed626 2021-10-07 op Bookmarks file.
919 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/known_hosts
920 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
921 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
922 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
923 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/lock
924 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
926 d0fd368a 2021-07-15 op from running at the same time.
927 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/session
928 7ee780fa 2021-07-21 op The list of tabs from the last session.
929 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
930 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
932 87e3e801 2021-07-17 op Is written by
933 e9b1e094 2021-04-01 op .Ic kill-telescope
934 7ee780fa 2021-07-21 op and loaded during startup.
937 984245ce 2021-06-23 op It's possible to browse
938 984245ce 2021-06-23 op .Dq the small web
939 984245ce 2021-06-23 op .Pq i.e. simple websites
940 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
941 eb2ed626 2021-10-07 op .Pa ~/.config/telescope/config :
942 984245ce 2021-06-23 op .Bd -literal -offset indent
943 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
944 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
949 7ee780fa 2021-07-21 op without any configuration
950 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
951 19f9cf0f 2021-06-24 op telescope -c /dev/null
953 73389b00 2021-10-08 op .Sh STANDARDS
955 73389b00 2021-10-08 op .%B XDG Base Directory Specification
956 73389b00 2021-10-08 op .%U https://specifications.freedesktop.org/basedir-spec/latest/
962 bba111bc 2021-03-28 op program was written by
963 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
966 8bfe7529 2021-11-27 op assumes a UTF-8 environment and doesn't do anything to cope with other
968 8bfe7529 2021-11-27 op This can cause weird rendering issues if you're lucky, or possibly
969 8bfe7529 2021-11-27 op worst things depending on your locale and terminal emulator.
971 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.