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