Blame


1 bba111bc 2021-03-28 op .\" Copyright (c) 2021 Omar Polo <op@omarpolo.com>
2 bba111bc 2021-03-28 op .\"
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.
6 bba111bc 2021-03-28 op .\"
7 bba111bc 2021-03-28 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 bba111bc 2021-03-28 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 bba111bc 2021-03-28 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 bba111bc 2021-03-28 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 bba111bc 2021-03-28 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 bba111bc 2021-03-28 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 bba111bc 2021-03-28 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 bba111bc 2021-03-28 op .Dd $Mdocdate: March 28 2021$
15 bba111bc 2021-03-28 op .Dt TELESCOPE 1
16 bba111bc 2021-03-28 op .Os
17 bba111bc 2021-03-28 op .Sh NAME
18 bba111bc 2021-03-28 op .Nm telescope
19 bba111bc 2021-03-28 op .Nd Gemini client
20 bba111bc 2021-03-28 op .Sh SYNOPSIS
21 bba111bc 2021-03-28 op .Nm
22 bba111bc 2021-03-28 op .Bk -words
23 dc761924 2021-07-15 op .Op Fl hnv
24 c92e529c 2021-06-15 op .Op Fl c Pa config
25 bba111bc 2021-03-28 op .Op Ar URL
26 bba111bc 2021-03-28 op .Ek
27 bba111bc 2021-03-28 op .Sh DESCRIPTION
28 bba111bc 2021-03-28 op .Nm
29 bba111bc 2021-03-28 op is an interactive browser for the Gemini protocol.
30 bba111bc 2021-03-28 op It is able to process text/gemini and more in general every text/* file.
31 bba111bc 2021-03-28 op .Nm
32 bba111bc 2021-03-28 op also features tabs, bookmarks and out-of-band TOFU verification.
33 c92e529c 2021-06-15 op .Pp
34 c92e529c 2021-06-15 op The arguments are as follows:
35 dc761924 2021-07-15 op .Bl -tag -width xxxxxxxxxxxxx
36 dc761924 2021-07-15 op .It Fl h , Fl -help
37 c92e529c 2021-06-15 op Display version and usage.
38 c92e529c 2021-06-15 op .It Fl n
39 c92e529c 2021-06-15 op Configtest mode.
40 c92e529c 2021-06-15 op Only check the configuration file for validity.
41 c92e529c 2021-06-15 op .It Fl c Pa config
42 c92e529c 2021-06-15 op Specify an alternative configuration file.
43 c92e529c 2021-06-15 op By default
44 c92e529c 2021-06-15 op .Pa $HOME/.telescope/config
45 c92e529c 2021-06-15 op is loaded.
46 dc761924 2021-07-15 op .It Fl v , Fl -version
47 dc761924 2021-07-15 op Display version.
48 c92e529c 2021-06-15 op .El
49 bba111bc 2021-03-28 op .Sh TOFU
50 bba111bc 2021-03-28 op .Nm
51 bba111bc 2021-03-28 op aims to use the "Trust, but Verify (where appropriate)" approach.
52 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
53 bba111bc 2021-03-28 op .Bl -tag -width 12m
54 bba111bc 2021-03-28 op .It untrusted
55 bba111bc 2021-03-28 op the server fingerprint does NOT match the stored value
56 bba111bc 2021-03-28 op .It trusted
57 bba111bc 2021-03-28 op the server fingerprint matches the store one
58 bba111bc 2021-03-28 op .It verified
59 bba111bc 2021-03-28 op the fingerprint matches and has been verified out-of-band
60 bba111bc 2021-03-28 op .El
61 bba111bc 2021-03-28 op .Pp
62 bba111bc 2021-03-28 op Most of the time the
63 bba111bc 2021-03-28 op .Dq trusted
64 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
65 bba111bc 2021-03-28 op verify out-of-band the certificate.
66 bba111bc 2021-03-28 op .Pp
67 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
68 bba111bc 2021-03-28 op verification though.
69 bba111bc 2021-03-28 op .Pp
70 bba111bc 2021-03-28 op Known certificates are store in
71 bba111bc 2021-03-28 op .Pa ~/.telescope/known_hosts
72 bba111bc 2021-03-28 op with a format similar to the
73 bba111bc 2021-03-28 op .Xr ssh 1 Ns '
74 bba111bc 2021-03-28 op .Pa known_hosts
75 bba111bc 2021-03-28 op file.
76 bba111bc 2021-03-28 op Each line is a record and it's made up by three fields, separated by a
77 bba111bc 2021-03-28 op single space, according to the following format:
78 bba111bc 2021-03-28 op .Dq HOST HASH TRUSTED
79 bba111bc 2021-03-28 op where:
80 bba111bc 2021-03-28 op .Bl -tag -width 12m
81 bba111bc 2021-03-28 op .It HOST
82 eb4388ee 2021-04-25 op the hostname, optionally followed by a colon (":") and a port number.
83 bba111bc 2021-03-28 op .It HASH
84 bba111bc 2021-03-28 op is the hash of the certificate, as outputted by
85 6c04e8b6 2021-04-01 op .Xr tls_peer_cert_hash 3 .
86 bba111bc 2021-03-28 op .It TRUSTED
87 bba111bc 2021-03-28 op a single digit.
88 bba111bc 2021-03-28 op 0 means trusted, 1 verified.
89 bba111bc 2021-03-28 op .El
90 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
91 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
92 bba111bc 2021-03-28 op been taken to include also bindings familiar for
93 bba111bc 2021-03-28 op .Xr vi 1
94 bba111bc 2021-03-28 op and
95 bba111bc 2021-03-28 op .Dq CUA
96 bba111bc 2021-03-28 op users.
97 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
98 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
99 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
100 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
101 bba111bc 2021-03-28 op .Pp
102 bba111bc 2021-03-28 op Keys are usually a single character, like
103 bba111bc 2021-03-28 op .Sq p
104 bba111bc 2021-03-28 op or
105 bba111bc 2021-03-28 op .Sq n ,
106 bba111bc 2021-03-28 op but some special keys are accepted as well.
107 bba111bc 2021-03-28 op .Pp
108 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
109 bba111bc 2021-03-28 op .It <up>
110 bba111bc 2021-03-28 op Up arrow
111 bba111bc 2021-03-28 op .It <down>
112 bba111bc 2021-03-28 op Down arrow
113 bba111bc 2021-03-28 op .It <left>
114 bba111bc 2021-03-28 op Left arrow
115 bba111bc 2021-03-28 op .It <right>
116 bba111bc 2021-03-28 op Right arrow
117 bba111bc 2021-03-28 op .It <prior>
118 bba111bc 2021-03-28 op Previous page/Page up
119 bba111bc 2021-03-28 op .It <next>
120 bba111bc 2021-03-28 op Next page/Page down
121 bba111bc 2021-03-28 op .It <home>
122 bba111bc 2021-03-28 op Home
123 bba111bc 2021-03-28 op .It <end>
124 bba111bc 2021-03-28 op End
125 bba111bc 2021-03-28 op .It <f0> thru <f63>
126 bba111bc 2021-03-28 op Function keys
127 bba111bc 2021-03-28 op .It del or backspace
128 bba111bc 2021-03-28 op Backspace
129 bba111bc 2021-03-28 op .It esc
130 bba111bc 2021-03-28 op Escape
131 bba111bc 2021-03-28 op .It space or spc
132 bba111bc 2021-03-28 op Space
133 bba111bc 2021-03-28 op .It enter or ret
134 bba111bc 2021-03-28 op Enter
135 bba111bc 2021-03-28 op .It tab
136 bba111bc 2021-03-28 op Tab
137 8dc60352 2021-06-15 op .It backtab
138 8dc60352 2021-06-15 op Depends on the configuration of the terminal emulator.
139 8dc60352 2021-06-15 op Usually is shift tab though.
140 bba111bc 2021-03-28 op .El
141 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
142 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
143 bba111bc 2021-03-28 op .It C-p
144 7dbaef94 2021-04-22 op previous-line
145 bba111bc 2021-03-28 op .It C-n
146 7dbaef94 2021-04-22 op next-line
147 bba111bc 2021-03-28 op .It C-f
148 7dbaef94 2021-04-22 op forward-char
149 bba111bc 2021-03-28 op .It C-b
150 7dbaef94 2021-04-22 op backward-char
151 bba111bc 2021-03-28 op .It M-{
152 7dbaef94 2021-04-22 op backward-paragraph
153 bba111bc 2021-03-28 op .It M-}
154 7dbaef94 2021-04-22 op forward-paragraph
155 bba111bc 2021-03-28 op .It C-a
156 7dbaef94 2021-04-22 op move-beginning-of-line
157 bba111bc 2021-03-28 op .It C-e
158 7dbaef94 2021-04-22 op move-end-of-line
159 bba111bc 2021-03-28 op .It M-v, M-space
160 7dbaef94 2021-04-22 op scroll-up
161 bba111bc 2021-03-28 op .It C-v, space
162 7dbaef94 2021-04-22 op scroll-down
163 bba111bc 2021-03-28 op .It M-<
164 7dbaef94 2021-04-22 op beginning-of-buffer
165 bba111bc 2021-03-28 op .It M->
166 7dbaef94 2021-04-22 op end-of-buffer
167 bba111bc 2021-03-28 op .It C-x C-c
168 7dbaef94 2021-04-22 op kill-telescope
169 bba111bc 2021-03-28 op .It C-g
170 7dbaef94 2021-04-22 op clear-minibuf
171 bba111bc 2021-03-28 op .It M-x
172 7dbaef94 2021-04-22 op execute-extended-command
173 61251035 2021-06-26 op .It C-c {
174 61251035 2021-06-26 op dec-fill-column
175 61251035 2021-06-26 op .It C-c }
176 61251035 2021-06-26 op inc-fill-column
177 1c412d48 2021-06-25 op .It C-c p
178 1c412d48 2021-06-25 op previous-heading
179 1c412d48 2021-06-25 op .It C-c n
180 1c412d48 2021-06-25 op next-heading
181 157d4810 2021-06-24 op .It >
182 157d4810 2021-06-24 op load-url
183 f2ab2540 2021-07-14 op .It <
184 f2ab2540 2021-07-14 op load-current-url
185 bba111bc 2021-03-28 op .It C-x C-f
186 7dbaef94 2021-04-22 op load-url
187 bba111bc 2021-03-28 op .It C-x M-f
188 7dbaef94 2021-04-22 op load-current-url
189 bba111bc 2021-03-28 op .It C-x t 0
190 7dbaef94 2021-04-22 op tab-close
191 bba111bc 2021-03-28 op .It C-x t 1
192 7dbaef94 2021-04-22 op tab-close-other
193 bba111bc 2021-03-28 op .It C-x t 2
194 7dbaef94 2021-04-22 op tab-new
195 bba111bc 2021-03-28 op .It C-x t o
196 7dbaef94 2021-04-22 op tab-next
197 bba111bc 2021-03-28 op .It C-x t O
198 7dbaef94 2021-04-22 op tab-previous
199 bba111bc 2021-03-28 op .It C-x t m
200 7dbaef94 2021-04-22 op tab-move
201 bba111bc 2021-03-28 op .It C-x t M
202 7dbaef94 2021-04-22 op tab-move-to
203 05c5cf0c 2021-07-13 op .It B, C-M-b
204 7dbaef94 2021-04-22 op previous-page
205 05c5cf0c 2021-07-13 op .It F, C-M-f
206 7dbaef94 2021-04-22 op next-page
207 bba111bc 2021-03-28 op .It <f7> a
208 7dbaef94 2021-04-22 op bookmark-page
209 bba111bc 2021-03-28 op .It <f7> <f7>
210 7dbaef94 2021-04-22 op list-bookmarks
211 bba111bc 2021-03-28 op .El
212 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
213 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
214 bba111bc 2021-03-28 op .It k
215 7dbaef94 2021-04-22 op previous-line
216 bba111bc 2021-03-28 op .It j
217 7dbaef94 2021-04-22 op next-line
218 bba111bc 2021-03-28 op .It l
219 7dbaef94 2021-04-22 op forward-char
220 bba111bc 2021-03-28 op .It h
221 7dbaef94 2021-04-22 op backward-char
222 bba111bc 2021-03-28 op .It {
223 7dbaef94 2021-04-22 op backward-paragraph
224 bba111bc 2021-03-28 op .It }
225 7dbaef94 2021-04-22 op forward-paragraph
226 bba111bc 2021-03-28 op .It ^
227 7dbaef94 2021-04-22 op move-beginning-of-line
228 bba111bc 2021-03-28 op .It $
229 7dbaef94 2021-04-22 op move-end-of-line
230 bba111bc 2021-03-28 op .It K
231 7dbaef94 2021-04-22 op scroll-line-up
232 bba111bc 2021-03-28 op .It J
233 7dbaef94 2021-04-22 op scroll-line-down
234 bba111bc 2021-03-28 op .It g g
235 7dbaef94 2021-04-22 op beginning-of-buffer
236 6c04e8b6 2021-04-01 op .It G
237 7dbaef94 2021-04-22 op end-of-buffer
238 bba111bc 2021-03-28 op .It g D
239 7dbaef94 2021-04-22 op tab-close
240 bba111bc 2021-03-28 op .It g N
241 7dbaef94 2021-04-22 op tab-new
242 bba111bc 2021-03-28 op .It g t
243 7dbaef94 2021-04-22 op tab-next
244 bba111bc 2021-03-28 op .It g T
245 7dbaef94 2021-04-22 op tab-previous
246 bba111bc 2021-03-28 op .It g M-t
247 7dbaef94 2021-04-22 op tab-move
248 bba111bc 2021-03-28 op .It g M-T
249 7dbaef94 2021-04-22 op tab-move-to
250 bba111bc 2021-03-28 op .It H
251 7dbaef94 2021-04-22 op previous-page
252 bba111bc 2021-03-28 op .It L
253 7dbaef94 2021-04-22 op next-page
254 bba111bc 2021-03-28 op .It q
255 7dbaef94 2021-04-22 op kill-telescope
256 bba111bc 2021-03-28 op .It ESC
257 7dbaef94 2021-04-22 op clear-minibuf
258 bba111bc 2021-03-28 op .It :
259 7dbaef94 2021-04-22 op execute-extended-command
260 bba111bc 2021-03-28 op .El
261 bba111bc 2021-03-28 op .Ss CUA-like keys
262 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
263 bba111bc 2021-03-28 op .It <up>
264 7dbaef94 2021-04-22 op previous-line
265 bba111bc 2021-03-28 op .It <down>
266 7dbaef94 2021-04-22 op next-line
267 bba111bc 2021-03-28 op .It <right>
268 7dbaef94 2021-04-22 op forward-char
269 bba111bc 2021-03-28 op .It <left>
270 7dbaef94 2021-04-22 op backward-char
271 bba111bc 2021-03-28 op .It <prior>
272 7dbaef94 2021-04-22 op scroll-up
273 bba111bc 2021-03-28 op .It <next>
274 7dbaef94 2021-04-22 op scroll-down
275 25f5824b 2021-07-08 op .It C-w
276 25f5824b 2021-07-08 op tab-close
277 3c3af0fd 2021-07-08 op .It C-t
278 3c3af0fd 2021-07-08 op tab-new
279 3c3af0fd 2021-07-08 op .It M-<prior>
280 3c3af0fd 2021-07-08 op tab-previous
281 3c3af0fd 2021-07-08 op .It M-<next>
282 3c3af0fd 2021-07-08 op tab-next
283 bba111bc 2021-03-28 op .It M-<left>
284 7dbaef94 2021-04-22 op previous-page
285 bba111bc 2021-03-28 op .It M-<right>
286 7dbaef94 2021-04-22 op next-page
287 661233ed 2021-07-14 op .It <f5>
288 661233ed 2021-07-14 op reload-page
289 661233ed 2021-07-14 op .It r
290 661233ed 2021-07-14 op reload-page
291 bba111bc 2021-03-28 op .El
292 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
293 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
294 7a014cef 2021-04-01 op .It <f1>
295 7dbaef94 2021-04-22 op toggle-help
296 bba111bc 2021-03-28 op .It enter
297 7dbaef94 2021-04-22 op push-button
298 bba111bc 2021-03-28 op .It M-enter
299 7dbaef94 2021-04-22 op push-button-new-tab
300 bba111bc 2021-03-28 op .It M-tab
301 7dbaef94 2021-04-22 op previous-button
302 8dc60352 2021-06-15 op .It backtab
303 8dc60352 2021-06-15 op previous-button
304 bba111bc 2021-03-28 op .It tab
305 7dbaef94 2021-04-22 op next-button
306 3360ef1b 2021-07-14 op .It M-t
307 3360ef1b 2021-07-14 op tab-select
308 dad288ec 2021-07-15 op .It M-l
309 753c6ac7 2021-07-14 op link-select
310 753c6ac7 2021-07-14 op .It M-/
311 753c6ac7 2021-07-14 op swiper
312 bba111bc 2021-03-28 op .El
313 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
314 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
315 bba111bc 2021-03-28 op .It enter
316 7dbaef94 2021-04-22 op mini-complete-and-exit
317 bba111bc 2021-03-28 op .It C-g
318 7dbaef94 2021-04-22 op mini-abort
319 bba111bc 2021-03-28 op .It ESC
320 7dbaef94 2021-04-22 op mini-abort
321 bba111bc 2021-03-28 op .It C-d
322 7dbaef94 2021-04-22 op mini-delete-char
323 bba111bc 2021-03-28 op .It del
324 7dbaef94 2021-04-22 op mini-delete-backward-char
325 bba111bc 2021-03-28 op .It backspace
326 7dbaef94 2021-04-22 op mini-delete-backward-char
327 bba111bc 2021-03-28 op .It C-h
328 7dbaef94 2021-04-22 op mini-delete-backward-char
329 bba111bc 2021-03-28 op .It C-b
330 7dbaef94 2021-04-22 op backward-char
331 bba111bc 2021-03-28 op .It C-f
332 7dbaef94 2021-04-22 op forward-char
333 bba111bc 2021-03-28 op .It <left>
334 7dbaef94 2021-04-22 op backward-char
335 bba111bc 2021-03-28 op .It <right>
336 7dbaef94 2021-04-22 op forward-char
337 bba111bc 2021-03-28 op .It C-e
338 7dbaef94 2021-04-22 op move-end-of-line
339 bba111bc 2021-03-28 op .It C-a
340 7dbaef94 2021-04-22 op move-beginning-of-line
341 bba111bc 2021-03-28 op .It <end>
342 7dbaef94 2021-04-22 op move-end-of-line
343 bba111bc 2021-03-28 op .It <home>
344 7dbaef94 2021-04-22 op move-beginning-of-line
345 bba111bc 2021-03-28 op .It C-k
346 7dbaef94 2021-04-22 op mini-kill-line
347 bba111bc 2021-03-28 op .It M-p
348 7dbaef94 2021-04-22 op mini-previous-history-element
349 bba111bc 2021-03-28 op .It M-n
350 7dbaef94 2021-04-22 op mini-next-history-element
351 e7b982f4 2021-07-14 op .It C-p
352 e7b982f4 2021-07-14 op previous-completion
353 e7b982f4 2021-07-14 op .It C-n
354 dffb2592 2021-07-14 op next-completion
355 dffb2592 2021-07-14 op .It <up>
356 dffb2592 2021-07-14 op previous-completion
357 dffb2592 2021-07-14 op .It <down>
358 e7b982f4 2021-07-14 op next-completion
359 e7b982f4 2021-07-14 op .It tab
360 e7b982f4 2021-07-14 op insert-current-candidate
361 bba111bc 2021-03-28 op .El
362 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
363 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
364 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
365 bba111bc 2021-03-28 op .Ic execute-extended-command .
366 bba111bc 2021-03-28 op .Ss Movement commands
367 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
368 bba111bc 2021-03-28 op .It Ic backward-char
369 bba111bc 2021-03-28 op Move point one character backward.
370 bba111bc 2021-03-28 op .It Ic backward-paragraph
371 bba111bc 2021-03-28 op Move point one paragraph backward.
372 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
373 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
374 bba111bc 2021-03-28 op .It Ic end-of-buffer
375 bba111bc 2021-03-28 op Move point to the end of the buffer.
376 bba111bc 2021-03-28 op .It Ic forward-char
377 bba111bc 2021-03-28 op Move point one character forward.
378 bba111bc 2021-03-28 op .It Ic forward-paragraph
379 bba111bc 2021-03-28 op Move point one paragraph forward.
380 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
381 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
382 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
383 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
384 bba111bc 2021-03-28 op .It Ic move-end-of-line
385 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
386 bba111bc 2021-03-28 op .It Ic next-button
387 bba111bc 2021-03-28 op Move point to the next link.
388 e7b982f4 2021-07-14 op .It Ic next-completion
389 e7b982f4 2021-07-14 op Select the next completion.
390 1c412d48 2021-06-25 op .It Ic next-heading
391 1c412d48 2021-06-25 op Move point to the next heading.
392 bba111bc 2021-03-28 op .It Ic next-line
393 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
394 bba111bc 2021-03-28 op .It Ic previous-button
395 bba111bc 2021-03-28 op Move point to the previous link.
396 e7b982f4 2021-07-14 op .It Ic previous-completion
397 e7b982f4 2021-07-14 op Select the previous completion.
398 1c412d48 2021-06-25 op .It Ic previous-heading
399 1c412d48 2021-06-25 op Move point to the previous heading.
400 bba111bc 2021-03-28 op .It Ic previous-line
401 bba111bc 2021-03-28 op Move point to the previous (visual) line.
402 bba111bc 2021-03-28 op .El
403 bba111bc 2021-03-28 op .Ss Bookmark-related commands
404 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
405 bba111bc 2021-03-28 op .It Ic bookmark-page
406 bba111bc 2021-03-28 op Add a link to the bookmark file.
407 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
408 63875195 2021-04-01 op .It Ic list-bookmarks
409 bba111bc 2021-03-28 op Load the bookmarks page.
410 bba111bc 2021-03-28 op .El
411 bba111bc 2021-03-28 op .Ss Tab-related commands
412 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
413 bba111bc 2021-03-28 op .It Ic tab-close
414 bba111bc 2021-03-28 op Close the current tab.
415 bba111bc 2021-03-28 op .It Ic tab-close-other
416 bba111bc 2021-03-28 op Close all tabs but the current one.
417 bba111bc 2021-03-28 op .It Ic tab-move
418 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
419 bba111bc 2021-03-28 op needed.
420 bba111bc 2021-03-28 op .It Ic tab-move-to
421 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
422 bba111bc 2021-03-28 op .It Ic tab-new
423 bba111bc 2021-03-28 op Open a new tab.
424 bba111bc 2021-03-28 op .It Ic tab-next
425 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
426 bba111bc 2021-03-28 op .It Ic tab-previous
427 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
428 3360ef1b 2021-07-14 op .It Ic tab-select
429 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
430 bba111bc 2021-03-28 op .El
431 bba111bc 2021-03-28 op .Ss Misc commands
432 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
433 bba111bc 2021-03-28 op .It Ic clear-minibuf
434 bba111bc 2021-03-28 op Clears the echo area.
435 61251035 2021-06-26 op .It Ic dec-fill-column
436 61251035 2021-06-26 op Decrements fill-column by two.
437 bba111bc 2021-03-28 op .It Ic execute-extended-command
438 bba111bc 2021-03-28 op Prompts for a command name using the minibuffer.
439 bba111bc 2021-03-28 op .It Ic kill-telescope
440 bba111bc 2021-03-28 op Quit
441 bba111bc 2021-03-28 op .Nm .
442 61251035 2021-06-26 op .It Ic inc-fill-column
443 61251035 2021-06-26 op Increments fill-column by two.
444 753c6ac7 2021-07-14 op .It Ic link-select
445 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
446 bba111bc 2021-03-28 op .It Ic load-current-url
447 bba111bc 2021-03-28 op Prompts for an URL, the minibuffer is preloaded with the current
448 bba111bc 2021-03-28 op one.
449 bba111bc 2021-03-28 op .It Ic load-url
450 bba111bc 2021-03-28 op Prompts for an URL.
451 bba111bc 2021-03-28 op .It Ic next-page
452 bba111bc 2021-03-28 op Load the next item in the history list.
453 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
454 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
455 9f3f9f5e 2021-06-19 op window.)
456 bba111bc 2021-03-28 op .It Ic previous-page
457 bba111bc 2021-03-28 op Load the previous item in the history list.
458 bba111bc 2021-03-28 op .It Ic push-button
459 60e87719 2021-07-05 op Follow the link on the current line, or toggle the visibility of the
460 60e87719 2021-07-05 op following preformatted block if called when the cursor is on the
461 60e87719 2021-07-05 op heading of the block.
462 bba111bc 2021-03-28 op .It Ic push-button-new-tab
463 bba111bc 2021-03-28 op Follow the link on the current line on a new tab.
464 bba111bc 2021-03-28 op .It Ic redraw
465 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
466 bba111bc 2021-03-28 op display.
467 661233ed 2021-07-14 op .It Ic reload-page
468 661233ed 2021-07-14 op Reload the current page.
469 bba111bc 2021-03-28 op .It Ic scroll-down
470 bba111bc 2021-03-28 op Scroll down by one visual page.
471 bba111bc 2021-03-28 op .It Ic scroll-line-down
472 bba111bc 2021-03-28 op Scroll down by one line.
473 bba111bc 2021-03-28 op .It Ic scroll-line-up
474 bba111bc 2021-03-28 op Scroll up by one line.
475 bba111bc 2021-03-28 op .It Ic scroll-up
476 bba111bc 2021-03-28 op Scroll up by one visual page.
477 753c6ac7 2021-07-14 op .It Ic swiper
478 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
479 edd9a650 2021-07-15 op .It Ic toc
480 edd9a650 2021-07-15 op Select and jump to a heading of the page using the minibuffer.
481 7a014cef 2021-04-01 op .It Ic toggle-help
482 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
483 7a014cef 2021-04-01 op interactive command.
484 bba111bc 2021-03-28 op .El
485 bba111bc 2021-03-28 op .Ss Minibuffer commands
486 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
487 bba111bc 2021-03-28 op .It Ic mini-abort
488 bba111bc 2021-03-28 op Abort the current minibuffer action.
489 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
490 bba111bc 2021-03-28 op Complete the current minibuffer action.
491 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
492 bba111bc 2021-03-28 op Delete the character before the point.
493 bba111bc 2021-03-28 op .It Ic mini-delete-char
494 bba111bc 2021-03-28 op Delete the character after the point.
495 bba111bc 2021-03-28 op .It Ic mini-kill-line
496 bba111bc 2021-03-28 op Delete from the point until the end of the line.
497 bba111bc 2021-03-28 op .It Ic mini-next-history-element
498 bba111bc 2021-03-28 op Load the previous history element.
499 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
500 bba111bc 2021-03-28 op Load the next history element.
501 bba111bc 2021-03-28 op .El
502 7d2d15f5 2021-04-30 op .Ss Aliases
503 7d2d15f5 2021-04-30 op The following aliases are available during
504 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
505 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
506 c82b3fd6 2021-05-12 op .It Ic tabn
507 c82b3fd6 2021-05-12 op .Ic tab-next
508 c82b3fd6 2021-05-12 op .It Ic tabnew
509 c82b3fd6 2021-05-12 op .Ic tab-new
510 c82b3fd6 2021-05-12 op .It Ic tabp
511 c82b3fd6 2021-05-12 op .Ic tab-previous
512 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
513 7d2d15f5 2021-04-30 op .Ic kill-telescope
514 74ca8ef4 2021-06-19 op .El
515 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
516 74ca8ef4 2021-06-19 op During the startup,
517 74ca8ef4 2021-06-19 op .Nm
518 74ca8ef4 2021-06-19 op reads the configuration file at
519 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
520 74ca8ef4 2021-06-19 op or the one given with the
521 74ca8ef4 2021-06-19 op .Fl c
522 74ca8ef4 2021-06-19 op flag.
523 74ca8ef4 2021-06-19 op .Pp
524 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
525 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
526 74ca8ef4 2021-06-19 op backslash
527 74ca8ef4 2021-06-19 op .Pq Sq \e .
528 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
529 74ca8ef4 2021-06-19 op .Pq Sq # ,
530 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
531 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
532 74ca8ef4 2021-06-19 op .Pp
533 74ca8ef4 2021-06-19 op The following constructs are available:
534 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
535 138421e8 2021-06-25 op .It Ic bind Ar map Ar key Ar cmd
536 138421e8 2021-06-25 op Bind
537 138421e8 2021-06-25 op .Ar key
538 138421e8 2021-06-25 op to the function
539 138421e8 2021-06-25 op .Ar cmd
540 138421e8 2021-06-25 op in the keymap
541 138421e8 2021-06-25 op .Ar map .
542 138421e8 2021-06-25 op Valid values for map are
543 138421e8 2021-06-25 op .Dq global-map
544 138421e8 2021-06-25 op .Pq i.e. when the user is viewing a page
545 138421e8 2021-06-25 op and
546 138421e8 2021-06-25 op .Dq minibuffer-map
547 138421e8 2021-06-25 op .Pq i.e. when the minibuffer has the focus.
548 138421e8 2021-06-25 op .Ar key
549 138421e8 2021-06-25 op follows the same syntax described in
550 138421e8 2021-06-25 op .Sx DEFAULT KEY BINDINGS
551 138421e8 2021-06-25 op and all the possible functions are listed in
552 138421e8 2021-06-25 op .Sx INTERACTIVE COMMANDS .
553 90d8329a 2021-06-25 op .It Ic proxy Ar proto Ic via Ar url
554 90d8329a 2021-06-25 op Use
555 90d8329a 2021-06-25 op .Ar url
556 90d8329a 2021-06-25 op as proxy for all URLs with
557 90d8329a 2021-06-25 op protocol
558 90d8329a 2021-06-25 op .Ar proto .
559 90d8329a 2021-06-25 op .Ar url
560 90d8329a 2021-06-25 op must be a Gemini URI without path, query and fragment component.
561 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
562 74ca8ef4 2021-06-19 op Set the option
563 74ca8ef4 2021-06-19 op .Ar opt
564 74ca8ef4 2021-06-19 op to the value
565 74ca8ef4 2021-06-19 op .Ar val .
566 74ca8ef4 2021-06-19 op Valid options are:
567 74ca8ef4 2021-06-19 op .Pp
568 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
569 2c748a1f 2021-06-21 op .It enable-colors
570 2c748a1f 2021-06-21 op .Pq integer
571 2c748a1f 2021-06-21 op If not zero, enable colours.
572 2c748a1f 2021-06-21 op By default is 1 if
573 2c748a1f 2021-06-21 op .Ev NO_COLORS
574 2c748a1f 2021-06-21 op is not set, 0 otherwise.
575 74ca8ef4 2021-06-19 op .It fill-column
576 74ca8ef4 2021-06-19 op .Pq integer
577 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
578 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
579 2c362f95 2021-06-24 op By default is 80.
580 b1379f34 2021-07-05 op .It hide-pre-blocks
581 0193225e 2021-07-05 op .Pq integer
582 b1379f34 2021-07-05 op If nonzero, hide by default the body of the preformatted blocks.
583 0193225e 2021-07-05 op By default is zero.
584 b1379f34 2021-07-05 op .Ic push-button
585 b1379f34 2021-07-05 op can be used to toggle the visibility per-block.
586 144733a7 2021-07-15 op .It hide-pre-closing-line
587 144733a7 2021-07-15 op .Pq integer
588 144733a7 2021-07-15 op If nonzero, hide the closing line of preformatted blocks.
589 b1379f34 2021-07-05 op .It hide-pre-context
590 0193225e 2021-07-05 op .Pq integer
591 b1379f34 2021-07-05 op If nonzero, hide the start and end line of the preformatted blocks.
592 b1379f34 2021-07-05 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
593 b1379f34 2021-07-05 op blocks are irremediably hidden.
594 0193225e 2021-07-05 op By default is zero.
595 74ca8ef4 2021-06-19 op .It new-tab-url
596 74ca8ef4 2021-06-19 op .Pq string
597 41a9ae40 2021-06-20 op URL for the new tab page.
598 41a9ae40 2021-06-20 op By default is
599 41a9ae40 2021-06-20 op .Dq about:new .
600 74ca8ef4 2021-06-19 op .It olivetti-mode
601 74ca8ef4 2021-06-19 op .Pq integer
602 74ca8ef4 2021-06-19 op Enable
603 74ca8ef4 2021-06-19 op .Ic olivetti-mode
604 41a9ae40 2021-06-20 op if non zero.
605 2c362f95 2021-06-24 op By default is 1.
606 74ca8ef4 2021-06-19 op .El
607 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
608 74ca8ef4 2021-06-19 op Change the styling of the element identified by
609 74ca8ef4 2021-06-19 op .Ar name .
610 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
611 74ca8ef4 2021-06-19 op Valid style identifiers are:
612 74bc52e8 2021-06-25 op .Bl -tag -width 16m -compact -offset Ds
613 74bc52e8 2021-06-25 op .It line
614 74bc52e8 2021-06-25 op for the area outside the lines in the body of the page.
615 45fe2472 2021-07-14 op .It line.compl
616 45fe2472 2021-07-14 op for the completion in the minibuffer
617 45fe2472 2021-07-14 op .It line.compl.current
618 45fe2472 2021-07-14 op for the current completion
619 74ca8ef4 2021-06-19 op .It line.text
620 74bc52e8 2021-06-25 op for text lines.
621 74bc52e8 2021-06-25 op .It line.link
622 74bc52e8 2021-06-25 op for link lines.
623 74ca8ef4 2021-06-19 op .It line.title1..3
624 14feea06 2021-07-14 op for headings
625 74ca8ef4 2021-06-19 op .It line.item
626 74bc52e8 2021-06-25 op for item lines.
627 74ca8ef4 2021-06-19 op .It line.quote
628 74bc52e8 2021-06-25 op for quotes.
629 74ca8ef4 2021-06-19 op .It line.pre.start
630 74bc52e8 2021-06-25 op for the heading of a preformatted block.
631 74ca8ef4 2021-06-19 op .It line.pre
632 74bc52e8 2021-06-25 op for the content of a preformatted block.
633 74ca8ef4 2021-06-19 op .It line.pre.end
634 74bc52e8 2021-06-25 op for the closing line of a preformatted block.
635 eaf1a84b 2021-06-25 op .It minibuffer
636 eaf1a84b 2021-06-25 op for the minibuffer
637 eaf1a84b 2021-06-25 op .Dq i.e. the last line of the window
638 eaf1a84b 2021-06-25 op .It modeline
639 eaf1a84b 2021-06-25 op for the modeline
640 eaf1a84b 2021-06-25 op .Dq i.e. the info line right above the minibuffer
641 74bc52e8 2021-06-25 op .It tabline
642 74bc52e8 2021-06-25 op for the tabline.
643 74bc52e8 2021-06-25 op .It tabline.tab
644 74bc52e8 2021-06-25 op for the non-focused tabs.
645 74bc52e8 2021-06-25 op .It tabline.current
646 74bc52e8 2021-06-25 op for the focused tab.
647 7d2d15f5 2021-04-30 op .El
648 74ca8ef4 2021-06-19 op .Pp
649 74ca8ef4 2021-06-19 op Valid options are:
650 ab728b01 2021-06-22 op .Bl -tag -width Ds
651 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
652 ab728b01 2021-06-22 op Sets the text attributes.
653 ab728b01 2021-06-22 op If only one value is given,
654 ab728b01 2021-06-22 op .Ar line
655 ab728b01 2021-06-22 op and
656 ab728b01 2021-06-22 op .Ar trail
657 ab728b01 2021-06-22 op default to that; if two values are given then
658 ab728b01 2021-06-22 op .Ar trail
659 ab728b01 2021-06-22 op defaults to
660 ab728b01 2021-06-22 op .Ar prefix .
661 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
662 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
663 ab728b01 2021-06-22 op .It Ic normal
664 ab728b01 2021-06-22 op no attributes.
665 ab728b01 2021-06-22 op .It Ic standout
666 ab728b01 2021-06-22 op best highlighting mode for the terminal.
667 ab728b01 2021-06-22 op .It Ic underline
668 ab728b01 2021-06-22 op underlines the text.
669 ab728b01 2021-06-22 op .It Ic reverse
670 ab728b01 2021-06-22 op reverses background/foreground colors.
671 ab728b01 2021-06-22 op .It Ic blink
672 ab728b01 2021-06-22 op makes the text blinking.
673 ab728b01 2021-06-22 op .It Ic dim
674 ab728b01 2021-06-22 op half bright.
675 ab728b01 2021-06-22 op .It Ic bold
676 ab728b01 2021-06-22 op extra bright or bold.
677 74ca8ef4 2021-06-19 op .El
678 74bc52e8 2021-06-25 op .Pp
679 74bc52e8 2021-06-25 op Only the styles under the
680 74bc52e8 2021-06-25 op .Dq line.
681 74bc52e8 2021-06-25 op prefix accept up to three attributes.
682 74bc52e8 2021-06-25 op The other will only use the first one given.
683 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
684 ab728b01 2021-06-22 op Sets the background color.
685 ab728b01 2021-06-22 op Follows the same behaviour as
686 ab728b01 2021-06-22 op .Ic attr
687 ab728b01 2021-06-22 op regarding the optional parameters.
688 ae844a00 2021-06-25 op The colour is one of black, red, green, yellow, blue,
689 ae844a00 2021-06-25 op magenta, cyan and white; colour0 to colour255
690 ae844a00 2021-06-25 op .Pq or color0 to color255
691 ae844a00 2021-06-25 op from the 256-colour set;
692 ae844a00 2021-06-25 op default for the default colour.
693 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
694 ab728b01 2021-06-22 op Sets the foreground color.
695 ab728b01 2021-06-22 op It behaves just like
696 ab728b01 2021-06-22 op .Ic bg .
697 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
698 eaf1a84b 2021-06-25 op Sets the prefix for the current line type to
699 ab728b01 2021-06-22 op .Ar prfx
700 ab728b01 2021-06-22 op and
701 ab728b01 2021-06-22 op .Ar cont
702 ab728b01 2021-06-22 op as the prefix for the continuation lines
703 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
704 ab728b01 2021-06-22 op If
705 ab728b01 2021-06-22 op .Ar cont
706 ab728b01 2021-06-22 op is not given its value will be the same of
707 ab728b01 2021-06-22 op .Ar prfx .
708 74ca8ef4 2021-06-19 op .El
709 ab728b01 2021-06-22 op .El
710 bba111bc 2021-03-28 op .Sh FILES
711 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
712 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
713 bba111bc 2021-03-28 op Holds the bookmarks.
714 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
715 dca97b00 2021-06-19 op Default configuration file.
716 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
717 bba111bc 2021-03-28 op Contains a list of host keys for all the hosts the user has visited.
718 bba111bc 2021-03-28 op See the TOFU section for more info.
719 d0fd368a 2021-07-15 op .It Pa ~/.telescope/lock
720 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
721 d0fd368a 2021-07-15 op .Nm
722 d0fd368a 2021-07-15 op from running at the same time.
723 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
724 e9b1e094 2021-04-01 op Contains the list of opened tabs in the last session, one per line.
725 e9b1e094 2021-04-01 op Gets written on
726 e9b1e094 2021-04-01 op .Ic kill-telescope
727 e9b1e094 2021-04-01 op and loaded on startup.
728 6c04e8b6 2021-04-01 op .El
729 74ca8ef4 2021-06-19 op .Sh EXAMPLES
730 ab728b01 2021-06-22 op The following is my config file:
731 74ca8ef4 2021-06-19 op .Bd -literal -offset indent
732 74bc52e8 2021-06-25 op # enable colors regardless of $NO_COLOR
733 ab728b01 2021-06-22 op set enable-colors = 1
734 74ca8ef4 2021-06-19 op
735 74ca8ef4 2021-06-19 op style line.item {
736 6322dee3 2021-06-21 op prefix " • " " "
737 74ca8ef4 2021-06-19 op }
738 74ca8ef4 2021-06-19 op
739 74ca8ef4 2021-06-19 op style line.link {
740 6322dee3 2021-06-21 op prefix "→ " " "
741 74ca8ef4 2021-06-19 op }
742 74ca8ef4 2021-06-19 op
743 74ca8ef4 2021-06-19 op style line.quote {
744 74ca8ef4 2021-06-19 op prefix " ┃ "
745 74ca8ef4 2021-06-19 op }
746 984245ce 2021-06-23 op .Ed
747 984245ce 2021-06-23 op .Pp
748 984245ce 2021-06-23 op It's possible to browse
749 984245ce 2021-06-23 op .Dq the small web
750 984245ce 2021-06-23 op .Pq i.e. simple websites
751 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
752 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
753 984245ce 2021-06-23 op .Bd -literal -offset indent
754 984245ce 2021-06-23 op proxy http via "gemini://localhost:1965"
755 984245ce 2021-06-23 op proxy https via "gemini://localhost:1965"
756 74ca8ef4 2021-06-19 op .Ed
757 19f9cf0f 2021-06-24 op .Pp
758 19f9cf0f 2021-06-24 op To load
759 19f9cf0f 2021-06-24 op .Nm
760 19f9cf0f 2021-06-24 op without any configuration use
761 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
762 19f9cf0f 2021-06-24 op telescope -c /dev/null
763 19f9cf0f 2021-06-24 op .Ed
764 bba111bc 2021-03-28 op .Sh AUTHORS
765 bba111bc 2021-03-28 op .An -nosplit
766 bba111bc 2021-03-28 op The
767 bba111bc 2021-03-28 op .Nm
768 bba111bc 2021-03-28 op program was written by
769 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .