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