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