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 157d4810 2021-06-24 op .It >
172 157d4810 2021-06-24 op load-url
173 bba111bc 2021-03-28 op .It C-x C-f
174 7dbaef94 2021-04-22 op load-url
175 bba111bc 2021-03-28 op .It C-x M-f
176 7dbaef94 2021-04-22 op load-current-url
177 bba111bc 2021-03-28 op .It C-x t 0
178 7dbaef94 2021-04-22 op tab-close
179 bba111bc 2021-03-28 op .It C-x t 1
180 7dbaef94 2021-04-22 op tab-close-other
181 bba111bc 2021-03-28 op .It C-x t 2
182 7dbaef94 2021-04-22 op tab-new
183 bba111bc 2021-03-28 op .It C-x t o
184 7dbaef94 2021-04-22 op tab-next
185 bba111bc 2021-03-28 op .It C-x t O
186 7dbaef94 2021-04-22 op tab-previous
187 bba111bc 2021-03-28 op .It C-x t m
188 7dbaef94 2021-04-22 op tab-move
189 bba111bc 2021-03-28 op .It C-x t M
190 7dbaef94 2021-04-22 op tab-move-to
191 bba111bc 2021-03-28 op .It C-M-b
192 7dbaef94 2021-04-22 op previous-page
193 bba111bc 2021-03-28 op .It C-M-f
194 7dbaef94 2021-04-22 op next-page
195 bba111bc 2021-03-28 op .It <f7> a
196 7dbaef94 2021-04-22 op bookmark-page
197 bba111bc 2021-03-28 op .It <f7> <f7>
198 7dbaef94 2021-04-22 op list-bookmarks
199 bba111bc 2021-03-28 op .El
200 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
201 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
202 bba111bc 2021-03-28 op .It k
203 7dbaef94 2021-04-22 op previous-line
204 bba111bc 2021-03-28 op .It j
205 7dbaef94 2021-04-22 op next-line
206 bba111bc 2021-03-28 op .It l
207 7dbaef94 2021-04-22 op forward-char
208 bba111bc 2021-03-28 op .It h
209 7dbaef94 2021-04-22 op backward-char
210 bba111bc 2021-03-28 op .It {
211 7dbaef94 2021-04-22 op backward-paragraph
212 bba111bc 2021-03-28 op .It }
213 7dbaef94 2021-04-22 op forward-paragraph
214 bba111bc 2021-03-28 op .It ^
215 7dbaef94 2021-04-22 op move-beginning-of-line
216 bba111bc 2021-03-28 op .It $
217 7dbaef94 2021-04-22 op move-end-of-line
218 bba111bc 2021-03-28 op .It K
219 7dbaef94 2021-04-22 op scroll-line-up
220 bba111bc 2021-03-28 op .It J
221 7dbaef94 2021-04-22 op scroll-line-down
222 bba111bc 2021-03-28 op .It g g
223 7dbaef94 2021-04-22 op beginning-of-buffer
224 6c04e8b6 2021-04-01 op .It G
225 7dbaef94 2021-04-22 op end-of-buffer
226 bba111bc 2021-03-28 op .It g D
227 7dbaef94 2021-04-22 op tab-close
228 bba111bc 2021-03-28 op .It g N
229 7dbaef94 2021-04-22 op tab-new
230 bba111bc 2021-03-28 op .It g t
231 7dbaef94 2021-04-22 op tab-next
232 bba111bc 2021-03-28 op .It g T
233 7dbaef94 2021-04-22 op tab-previous
234 bba111bc 2021-03-28 op .It g M-t
235 7dbaef94 2021-04-22 op tab-move
236 bba111bc 2021-03-28 op .It g M-T
237 7dbaef94 2021-04-22 op tab-move-to
238 bba111bc 2021-03-28 op .It H
239 7dbaef94 2021-04-22 op previous-page
240 bba111bc 2021-03-28 op .It L
241 7dbaef94 2021-04-22 op next-page
242 bba111bc 2021-03-28 op .It q
243 7dbaef94 2021-04-22 op kill-telescope
244 bba111bc 2021-03-28 op .It ESC
245 7dbaef94 2021-04-22 op clear-minibuf
246 bba111bc 2021-03-28 op .It :
247 7dbaef94 2021-04-22 op execute-extended-command
248 bba111bc 2021-03-28 op .El
249 bba111bc 2021-03-28 op .Ss CUA-like keys
250 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
251 bba111bc 2021-03-28 op .It <up>
252 7dbaef94 2021-04-22 op previous-line
253 bba111bc 2021-03-28 op .It <down>
254 7dbaef94 2021-04-22 op next-line
255 bba111bc 2021-03-28 op .It <right>
256 7dbaef94 2021-04-22 op forward-char
257 bba111bc 2021-03-28 op .It <left>
258 7dbaef94 2021-04-22 op backward-char
259 bba111bc 2021-03-28 op .It <prior>
260 7dbaef94 2021-04-22 op scroll-up
261 bba111bc 2021-03-28 op .It <next>
262 7dbaef94 2021-04-22 op scroll-down
263 bba111bc 2021-03-28 op .It M-<left>
264 7dbaef94 2021-04-22 op previous-page
265 bba111bc 2021-03-28 op .It M-<right>
266 7dbaef94 2021-04-22 op next-page
267 bba111bc 2021-03-28 op .El
268 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
269 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
270 7a014cef 2021-04-01 op .It <f1>
271 7dbaef94 2021-04-22 op toggle-help
272 bba111bc 2021-03-28 op .It enter
273 7dbaef94 2021-04-22 op push-button
274 bba111bc 2021-03-28 op .It M-enter
275 7dbaef94 2021-04-22 op push-button-new-tab
276 bba111bc 2021-03-28 op .It M-tab
277 7dbaef94 2021-04-22 op previous-button
278 8dc60352 2021-06-15 op .It backtab
279 8dc60352 2021-06-15 op previous-button
280 bba111bc 2021-03-28 op .It tab
281 7dbaef94 2021-04-22 op next-button
282 bba111bc 2021-03-28 op .El
283 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
284 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
285 bba111bc 2021-03-28 op .It enter
286 7dbaef94 2021-04-22 op mini-complete-and-exit
287 bba111bc 2021-03-28 op .It C-g
288 7dbaef94 2021-04-22 op mini-abort
289 bba111bc 2021-03-28 op .It ESC
290 7dbaef94 2021-04-22 op mini-abort
291 bba111bc 2021-03-28 op .It C-d
292 7dbaef94 2021-04-22 op mini-delete-char
293 bba111bc 2021-03-28 op .It del
294 7dbaef94 2021-04-22 op mini-delete-backward-char
295 bba111bc 2021-03-28 op .It backspace
296 7dbaef94 2021-04-22 op mini-delete-backward-char
297 bba111bc 2021-03-28 op .It C-h
298 7dbaef94 2021-04-22 op mini-delete-backward-char
299 bba111bc 2021-03-28 op .It C-b
300 7dbaef94 2021-04-22 op backward-char
301 bba111bc 2021-03-28 op .It C-f
302 7dbaef94 2021-04-22 op forward-char
303 bba111bc 2021-03-28 op .It <left>
304 7dbaef94 2021-04-22 op backward-char
305 bba111bc 2021-03-28 op .It <right>
306 7dbaef94 2021-04-22 op forward-char
307 bba111bc 2021-03-28 op .It C-e
308 7dbaef94 2021-04-22 op move-end-of-line
309 bba111bc 2021-03-28 op .It C-a
310 7dbaef94 2021-04-22 op move-beginning-of-line
311 bba111bc 2021-03-28 op .It <end>
312 7dbaef94 2021-04-22 op move-end-of-line
313 bba111bc 2021-03-28 op .It <home>
314 7dbaef94 2021-04-22 op move-beginning-of-line
315 bba111bc 2021-03-28 op .It C-k
316 7dbaef94 2021-04-22 op mini-kill-line
317 bba111bc 2021-03-28 op .It M-p
318 7dbaef94 2021-04-22 op mini-previous-history-element
319 bba111bc 2021-03-28 op .It M-n
320 7dbaef94 2021-04-22 op mini-next-history-element
321 bba111bc 2021-03-28 op .It <up>
322 7dbaef94 2021-04-22 op mini-previous-history-element
323 bba111bc 2021-03-28 op .It <down>
324 7dbaef94 2021-04-22 op mini-next-history-element
325 bba111bc 2021-03-28 op .El
326 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
327 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
328 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
329 bba111bc 2021-03-28 op .Ic execute-extended-command .
330 bba111bc 2021-03-28 op .Ss Movement commands
331 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
332 bba111bc 2021-03-28 op .It Ic backward-char
333 bba111bc 2021-03-28 op Move point one character backward.
334 bba111bc 2021-03-28 op .It Ic backward-paragraph
335 bba111bc 2021-03-28 op Move point one paragraph backward.
336 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
337 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
338 bba111bc 2021-03-28 op .It Ic end-of-buffer
339 bba111bc 2021-03-28 op Move point to the end of the buffer.
340 bba111bc 2021-03-28 op .It Ic forward-char
341 bba111bc 2021-03-28 op Move point one character forward.
342 bba111bc 2021-03-28 op .It Ic forward-paragraph
343 bba111bc 2021-03-28 op Move point one paragraph forward.
344 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
345 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
346 bba111bc 2021-03-28 op .It Ic move-end-of-line
347 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
348 bba111bc 2021-03-28 op .It Ic next-button
349 bba111bc 2021-03-28 op Move point to the next link.
350 bba111bc 2021-03-28 op .It Ic next-line
351 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
352 bba111bc 2021-03-28 op .It Ic previous-button
353 bba111bc 2021-03-28 op Move point to the previous link.
354 bba111bc 2021-03-28 op .It Ic previous-line
355 bba111bc 2021-03-28 op Move point to the previous (visual) line.
356 bba111bc 2021-03-28 op .El
357 bba111bc 2021-03-28 op .Ss Bookmark-related commands
358 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
359 bba111bc 2021-03-28 op .It Ic bookmark-page
360 bba111bc 2021-03-28 op Add a link to the bookmark file.
361 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
362 63875195 2021-04-01 op .It Ic list-bookmarks
363 bba111bc 2021-03-28 op Load the bookmarks page.
364 bba111bc 2021-03-28 op .El
365 bba111bc 2021-03-28 op .Ss Tab-related commands
366 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
367 bba111bc 2021-03-28 op .It Ic tab-close
368 bba111bc 2021-03-28 op Close the current tab.
369 bba111bc 2021-03-28 op .It Ic tab-close-other
370 bba111bc 2021-03-28 op Close all tabs but the current one.
371 bba111bc 2021-03-28 op .It Ic tab-move
372 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
373 bba111bc 2021-03-28 op needed.
374 bba111bc 2021-03-28 op .It Ic tab-move-to
375 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
376 bba111bc 2021-03-28 op .It Ic tab-new
377 bba111bc 2021-03-28 op Open a new tab.
378 bba111bc 2021-03-28 op .It Ic tab-next
379 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
380 bba111bc 2021-03-28 op .It Ic tab-previous
381 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
382 bba111bc 2021-03-28 op .El
383 bba111bc 2021-03-28 op .Ss Misc commands
384 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
385 bba111bc 2021-03-28 op .It Ic clear-minibuf
386 bba111bc 2021-03-28 op Clears the echo area.
387 bba111bc 2021-03-28 op .It Ic execute-extended-command
388 bba111bc 2021-03-28 op Prompts for a command name using the minibuffer.
389 bba111bc 2021-03-28 op .It Ic kill-telescope
390 bba111bc 2021-03-28 op Quit
391 bba111bc 2021-03-28 op .Nm .
392 bba111bc 2021-03-28 op .It Ic load-current-url
393 bba111bc 2021-03-28 op Prompts for an URL, the minibuffer is preloaded with the current
394 bba111bc 2021-03-28 op one.
395 bba111bc 2021-03-28 op .It Ic load-url
396 bba111bc 2021-03-28 op Prompts for an URL.
397 bba111bc 2021-03-28 op .It Ic next-page
398 bba111bc 2021-03-28 op Load the next item in the history list.
399 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
400 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
401 9f3f9f5e 2021-06-19 op window.)
402 bba111bc 2021-03-28 op .It Ic previous-page
403 bba111bc 2021-03-28 op Load the previous item in the history list.
404 bba111bc 2021-03-28 op .It Ic push-button
405 bba111bc 2021-03-28 op Follow the link on the current line.
406 bba111bc 2021-03-28 op .It Ic push-button-new-tab
407 bba111bc 2021-03-28 op Follow the link on the current line on a new tab.
408 bba111bc 2021-03-28 op .It Ic redraw
409 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
410 bba111bc 2021-03-28 op display.
411 bba111bc 2021-03-28 op .It Ic scroll-down
412 bba111bc 2021-03-28 op Scroll down by one visual page.
413 bba111bc 2021-03-28 op .It Ic scroll-line-down
414 bba111bc 2021-03-28 op Scroll down by one line.
415 bba111bc 2021-03-28 op .It Ic scroll-line-up
416 bba111bc 2021-03-28 op Scroll up by one line.
417 bba111bc 2021-03-28 op .It Ic scroll-up
418 bba111bc 2021-03-28 op Scroll up by one visual page.
419 7a014cef 2021-04-01 op .It Ic toggle-help
420 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
421 7a014cef 2021-04-01 op interactive command.
422 bba111bc 2021-03-28 op .El
423 bba111bc 2021-03-28 op .Ss Minibuffer commands
424 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
425 bba111bc 2021-03-28 op .It Ic mini-abort
426 bba111bc 2021-03-28 op Abort the current minibuffer action.
427 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
428 bba111bc 2021-03-28 op Complete the current minibuffer action.
429 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
430 bba111bc 2021-03-28 op Delete the character before the point.
431 bba111bc 2021-03-28 op .It Ic mini-delete-char
432 bba111bc 2021-03-28 op Delete the character after the point.
433 bba111bc 2021-03-28 op .It Ic mini-kill-line
434 bba111bc 2021-03-28 op Delete from the point until the end of the line.
435 bba111bc 2021-03-28 op .It Ic mini-next-history-element
436 bba111bc 2021-03-28 op Load the previous history element.
437 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
438 bba111bc 2021-03-28 op Load the next history element.
439 bba111bc 2021-03-28 op .El
440 7d2d15f5 2021-04-30 op .Ss Aliases
441 7d2d15f5 2021-04-30 op The following aliases are available during
442 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
443 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
444 c82b3fd6 2021-05-12 op .It Ic tabn
445 c82b3fd6 2021-05-12 op .Ic tab-next
446 c82b3fd6 2021-05-12 op .It Ic tabnew
447 c82b3fd6 2021-05-12 op .Ic tab-new
448 c82b3fd6 2021-05-12 op .It Ic tabp
449 c82b3fd6 2021-05-12 op .Ic tab-previous
450 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
451 7d2d15f5 2021-04-30 op .Ic kill-telescope
452 74ca8ef4 2021-06-19 op .El
453 74ca8ef4 2021-06-19 op .Sh CONFIGURATION FILE
454 74ca8ef4 2021-06-19 op During the startup,
455 74ca8ef4 2021-06-19 op .Nm
456 74ca8ef4 2021-06-19 op reads the configuration file at
457 74ca8ef4 2021-06-19 op .Pa ~/.telescope/config
458 74ca8ef4 2021-06-19 op or the one given with the
459 74ca8ef4 2021-06-19 op .Fl c
460 74ca8ef4 2021-06-19 op flag.
461 74ca8ef4 2021-06-19 op .Pp
462 74ca8ef4 2021-06-19 op The format of the configuration file is fairly flexible.
463 74ca8ef4 2021-06-19 op The current line can be extended over multiple ones using a
464 74ca8ef4 2021-06-19 op backslash
465 74ca8ef4 2021-06-19 op .Pq Sq \e .
466 74ca8ef4 2021-06-19 op Comments can be put anywhere in the file using a hash mark
467 74ca8ef4 2021-06-19 op .Pq Sq # ,
468 74ca8ef4 2021-06-19 op and extend to the end of the current line, but backslashes can't be
469 74ca8ef4 2021-06-19 op used to extend comments over multiple lines.
470 74ca8ef4 2021-06-19 op .Pp
471 74ca8ef4 2021-06-19 op The following constructs are available:
472 74ca8ef4 2021-06-19 op .Bl -tag -width Ds
473 74ca8ef4 2021-06-19 op .It Ic set Ar opt No = Ar val
474 74ca8ef4 2021-06-19 op Set the option
475 74ca8ef4 2021-06-19 op .Ar opt
476 74ca8ef4 2021-06-19 op to the value
477 74ca8ef4 2021-06-19 op .Ar val .
478 74ca8ef4 2021-06-19 op Valid options are:
479 74ca8ef4 2021-06-19 op .Pp
480 74ca8ef4 2021-06-19 op .Bl -tag -width twelveletters -compact
481 2c748a1f 2021-06-21 op .It enable-colors
482 2c748a1f 2021-06-21 op .Pq integer
483 2c748a1f 2021-06-21 op If not zero, enable colours.
484 2c748a1f 2021-06-21 op By default is 1 if
485 2c748a1f 2021-06-21 op .Ev NO_COLORS
486 2c748a1f 2021-06-21 op is not set, 0 otherwise.
487 74ca8ef4 2021-06-19 op .It fill-column
488 74ca8ef4 2021-06-19 op .Pq integer
489 74ca8ef4 2021-06-19 op If greater than zero, lines of text will be formatted in a way that
490 74ca8ef4 2021-06-19 op don't exceed the given number of columns.
491 2c362f95 2021-06-24 op By default is 80.
492 74ca8ef4 2021-06-19 op .It new-tab-url
493 74ca8ef4 2021-06-19 op .Pq string
494 41a9ae40 2021-06-20 op URL for the new tab page.
495 41a9ae40 2021-06-20 op By default is
496 41a9ae40 2021-06-20 op .Dq about:new .
497 74ca8ef4 2021-06-19 op .It olivetti-mode
498 74ca8ef4 2021-06-19 op .Pq integer
499 74ca8ef4 2021-06-19 op Enable
500 74ca8ef4 2021-06-19 op .Ic olivetti-mode
501 41a9ae40 2021-06-20 op if non zero.
502 2c362f95 2021-06-24 op By default is 1.
503 74ca8ef4 2021-06-19 op .El
504 984245ce 2021-06-23 op .It Ic proxy Ar proto Ic via Ar url
505 984245ce 2021-06-23 op Use
506 984245ce 2021-06-23 op .Ar url
507 984245ce 2021-06-23 op as proxy for all URLs with
508 984245ce 2021-06-23 op protocol
509 6e8a284f 2021-06-24 op .Ar proto .
510 984245ce 2021-06-23 op .Ar url
511 984245ce 2021-06-23 op must be a Gemini URI without path, query and fragment component.
512 74ca8ef4 2021-06-19 op .It Ic style Ar name Ar option
513 74ca8ef4 2021-06-19 op Change the styling of the element identified by
514 74ca8ef4 2021-06-19 op .Ar name .
515 74ca8ef4 2021-06-19 op Multiple options may be specified within curly braces.
516 74ca8ef4 2021-06-19 op Valid style identifiers are:
517 74ca8ef4 2021-06-19 op .Bl -tag -width 14m -compact -offset Ds
518 74ca8ef4 2021-06-19 op .It line.text
519 74ca8ef4 2021-06-19 op for text lines
520 74ca8ef4 2021-06-19 op .It line.link
521 74ca8ef4 2021-06-19 op for link lines
522 74ca8ef4 2021-06-19 op .It line.title1..3
523 74ca8ef4 2021-06-19 op for headings
524 74ca8ef4 2021-06-19 op .It line.item
525 74ca8ef4 2021-06-19 op for item lines
526 74ca8ef4 2021-06-19 op .It line.quote
527 74ca8ef4 2021-06-19 op for quotes
528 74ca8ef4 2021-06-19 op .It line.pre.start
529 74ca8ef4 2021-06-19 op for the heading of a preformatted block
530 74ca8ef4 2021-06-19 op .It line.pre
531 74ca8ef4 2021-06-19 op for the content of a preformatted block
532 74ca8ef4 2021-06-19 op .It line.pre.end
533 74ca8ef4 2021-06-19 op for the closing line of a preformatted block
534 7d2d15f5 2021-04-30 op .El
535 74ca8ef4 2021-06-19 op .Pp
536 74ca8ef4 2021-06-19 op Valid options are:
537 ab728b01 2021-06-22 op .Bl -tag -width Ds
538 6e8a284f 2021-06-24 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
539 ab728b01 2021-06-22 op Sets the text attributes.
540 ab728b01 2021-06-22 op If only one value is given,
541 ab728b01 2021-06-22 op .Ar line
542 ab728b01 2021-06-22 op and
543 ab728b01 2021-06-22 op .Ar trail
544 ab728b01 2021-06-22 op default to that; if two values are given then
545 ab728b01 2021-06-22 op .Ar trail
546 ab728b01 2021-06-22 op defaults to
547 ab728b01 2021-06-22 op .Ar prefix .
548 ab728b01 2021-06-22 op Each attribute is a comma-separated list of keywords:
549 ab728b01 2021-06-22 op .Bl -tag -width underline -compact -offset Ds
550 ab728b01 2021-06-22 op .It Ic normal
551 ab728b01 2021-06-22 op no attributes.
552 ab728b01 2021-06-22 op .It Ic standout
553 ab728b01 2021-06-22 op best highlighting mode for the terminal.
554 ab728b01 2021-06-22 op .It Ic underline
555 ab728b01 2021-06-22 op underlines the text.
556 ab728b01 2021-06-22 op .It Ic reverse
557 ab728b01 2021-06-22 op reverses background/foreground colors.
558 ab728b01 2021-06-22 op .It Ic blink
559 ab728b01 2021-06-22 op makes the text blinking.
560 ab728b01 2021-06-22 op .It Ic dim
561 ab728b01 2021-06-22 op half bright.
562 ab728b01 2021-06-22 op .It Ic bold
563 ab728b01 2021-06-22 op extra bright or bold.
564 74ca8ef4 2021-06-19 op .El
565 6e8a284f 2021-06-24 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
566 ab728b01 2021-06-22 op Sets the background color.
567 ab728b01 2021-06-22 op Follows the same behaviour as
568 ab728b01 2021-06-22 op .Ic attr
569 ab728b01 2021-06-22 op regarding the optional parameters.
570 ab728b01 2021-06-22 op Supported colors are: default, black, red, green, yellow, blue,
571 ab728b01 2021-06-22 op magenta, cyan and white
572 6e8a284f 2021-06-24 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
573 ab728b01 2021-06-22 op Sets the foreground color.
574 ab728b01 2021-06-22 op It behaves just like
575 ab728b01 2021-06-22 op .Ic bg .
576 ab728b01 2021-06-22 op .It Ic prefix Ar prfx Op Ar cont
577 ab728b01 2021-06-22 op Sets the prefix for the given line to
578 ab728b01 2021-06-22 op .Ar prfx
579 ab728b01 2021-06-22 op and
580 ab728b01 2021-06-22 op .Ar cont
581 ab728b01 2021-06-22 op as the prefix for the continuation lines
582 ab728b01 2021-06-22 op .Pq i.e. when a long line gets wrapped.
583 ab728b01 2021-06-22 op If
584 ab728b01 2021-06-22 op .Ar cont
585 ab728b01 2021-06-22 op is not given its value will be the same of
586 ab728b01 2021-06-22 op .Ar prfx .
587 74ca8ef4 2021-06-19 op .El
588 ab728b01 2021-06-22 op .El
589 bba111bc 2021-03-28 op .Sh FILES
590 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
591 bba111bc 2021-03-28 op .It Pa ~/.telescope/bookmarks.gmi
592 bba111bc 2021-03-28 op Holds the bookmarks.
593 dca97b00 2021-06-19 op .It Pa ~/.telescope/config
594 dca97b00 2021-06-19 op Default configuration file.
595 bba111bc 2021-03-28 op .It Pa ~/.telescope/known_hosts
596 bba111bc 2021-03-28 op Contains a list of host keys for all the hosts the user has visited.
597 bba111bc 2021-03-28 op See the TOFU section for more info.
598 e9b1e094 2021-04-01 op .It Pa ~/.telescope/session
599 e9b1e094 2021-04-01 op Contains the list of opened tabs in the last session, one per line.
600 e9b1e094 2021-04-01 op Gets written on
601 e9b1e094 2021-04-01 op .Ic kill-telescope
602 e9b1e094 2021-04-01 op and loaded on startup.
603 6c04e8b6 2021-04-01 op .El
604 74ca8ef4 2021-06-19 op .Sh EXAMPLES
605 ab728b01 2021-06-22 op The following is my config file:
606 74ca8ef4 2021-06-19 op .Bd -literal -offset indent
607 2c362f95 2021-06-24 op # ignore the NO_COLOR environment variable
608 ab728b01 2021-06-22 op set enable-colors = 1
609 74ca8ef4 2021-06-19 op
610 74ca8ef4 2021-06-19 op style line.item {
611 6322dee3 2021-06-21 op prefix " • " " "
612 74ca8ef4 2021-06-19 op }
613 74ca8ef4 2021-06-19 op
614 74ca8ef4 2021-06-19 op style line.link {
615 6322dee3 2021-06-21 op prefix "→ " " "
616 ab728b01 2021-06-22 op fg blue
617 ab728b01 2021-06-22 op attr normal underline
618 74ca8ef4 2021-06-19 op }
619 74ca8ef4 2021-06-19 op
620 74ca8ef4 2021-06-19 op style line.quote {
621 74ca8ef4 2021-06-19 op prefix " ┃ "
622 74ca8ef4 2021-06-19 op }
623 984245ce 2021-06-23 op .Ed
624 984245ce 2021-06-23 op .Pp
625 984245ce 2021-06-23 op It's possible to browse
626 984245ce 2021-06-23 op .Dq the small web
627 984245ce 2021-06-23 op .Pq i.e. simple websites
628 984245ce 2021-06-23 op using programs like the duckling-proxy by defining a proxy in
629 6e8a284f 2021-06-24 op .Pa ~/.telescope/config :
630 984245ce 2021-06-23 op .Bd -literal -offset indent
631 984245ce 2021-06-23 op proxy http via "gemini://localhost:1965"
632 984245ce 2021-06-23 op proxy https via "gemini://localhost:1965"
633 74ca8ef4 2021-06-19 op .Ed
634 19f9cf0f 2021-06-24 op .Pp
635 19f9cf0f 2021-06-24 op To load
636 19f9cf0f 2021-06-24 op .Nm
637 19f9cf0f 2021-06-24 op without any configuration use
638 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
639 19f9cf0f 2021-06-24 op telescope -c /dev/null
640 19f9cf0f 2021-06-24 op .Ed
641 bba111bc 2021-03-28 op .Sh AUTHORS
642 bba111bc 2021-03-28 op .An -nosplit
643 bba111bc 2021-03-28 op The
644 bba111bc 2021-03-28 op .Nm
645 bba111bc 2021-03-28 op program was written by
646 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .