1 4702c8ff 2021-01-02 op .\" Copyright (c) 2021, 2022 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 4702c8ff 2021-01-02 op .Dd $Mdocdate: January 02 2022$
 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 a19dd818 2021-08-03 op .Nd multi-protocol browser
 20 bba111bc 2021-03-28 op .Sh SYNOPSIS
 21 bba111bc 2021-03-28 op .Nm
 22 bba111bc 2021-03-28 op .Bk -words
 23 d0971653 2021-09-15 op .Op Fl ChnSv
 24 dee3a166 2021-11-29 op .Op Fl c Ar 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 a19dd818 2021-08-03 op is an interactive browser that supports the Finger, Gemini and Gopher
 30 a19dd818 2021-08-03 op protocols.
 31 bba111bc 2021-03-28 op .Nm
 32 a19dd818 2021-08-03 op features tabs, a minibuffer, interactive completions, bookmarks and
 33 a19dd818 2021-08-03 op out-of-band TOFU verification.
 34 c92e529c 2021-06-15 op .Pp
 35 c92e529c 2021-06-15 op The arguments are as follows:
 36 dc761924 2021-07-15 op .Bl -tag -width xxxxxxxxxxxxx
 37 a599eaa6 2021-01-02 op .It Fl C , Fl -colours
 38 97870a34 2021-07-15 op Show all available colors and exit.
 39 a599eaa6 2021-01-02 op This option can also be spelled
 40 a599eaa6 2021-01-02 op .Fl -colors .
 41 dee3a166 2021-11-29 op .It Fl c Ar config
 42 c92e529c 2021-06-15 op Specify an alternative configuration file.
 43 c92e529c 2021-06-15 op By default
 44 dee3a166 2021-11-29 op .Pa ~/.config/telescope/config
 45 c92e529c 2021-06-15 op is loaded.
 46 ccc5591f 2021-07-15 op .It Fl h , Fl -help
 47 ccc5591f 2021-07-15 op Display version and usage.
 48 ccc5591f 2021-07-15 op .It Fl n
 49 ccc5591f 2021-07-15 op Configtest mode.
 50 ccc5591f 2021-07-15 op Only check the configuration file for validity.
 51 d0971653 2021-09-15 op .It Fl S , Fl -safe
 52 d0971653 2021-09-15 op .Dq Safe
 53 d0971653 2021-09-15 op .Pq or Dq sandbox
 54 d0971653 2021-09-15 op mode.
 55 d0971653 2021-09-15 op Prevent
 56 d0971653 2021-09-15 op .Nm
 57 d34a1873 2021-09-15 op from writing files to the disk and to acquire the lock, allowing to
 58 d34a1873 2021-09-15 op run multiple instances at the same time.
 59 d34a1873 2021-09-15 op .Nm
 60 d34a1873 2021-09-15 op still loads the session file and the custom about pages.
 61 dc761924 2021-07-15 op .It Fl v , Fl -version
 62 dc761924 2021-07-15 op Display version.
 63 c92e529c 2021-06-15 op .El
 64 7ee780fa 2021-07-21 op .Sh UI CONCEPTS
 65 7ee780fa 2021-07-21 op .Nm
 66 7ee780fa 2021-07-21 op interface is divided into four areas: the tabline, the body, the
 67 7ee780fa 2021-07-21 op modeline and the echoarea/minibuffer.
 68 7ee780fa 2021-07-21 op .Pp
 69 7ee780fa 2021-07-21 op The tabline is always at the top of the screen and displays the tabs
 70 7ee780fa 2021-07-21 op separated by a vertical line.
 71 7ee780fa 2021-07-21 op When there are more tabs than the size of the window allow to display,
 72 7ee780fa 2021-07-21 op the characters
 73 7ee780fa 2021-07-21 op .Sq \&<
 74 7ee780fa 2021-07-21 op or
 75 7ee780fa 2021-07-21 op .Sq \&>
 76 7ee780fa 2021-07-21 op are shown at the start/end of the tabline to indicate that there are
 77 7ee780fa 2021-07-21 op more tabs in that direction.
 78 7ee780fa 2021-07-21 op .Pp
 79 7ee780fa 2021-07-21 op The body occupies the majority of the visible area.
 80 7ee780fa 2021-07-21 op It contains the current page and optionally a side window.
 81 7ee780fa 2021-07-21 op .Pp
 82 7ee780fa 2021-07-21 op The modeline is the second to last row of the screen.
 83 7ee780fa 2021-07-21 op It shows some information about the page: a spinner when the page is
 84 7ee780fa 2021-07-21 op loading, the trust level, the document type, the scroll offset and the
 85 7ee780fa 2021-07-21 op URL.
 86 7ee780fa 2021-07-21 op .Pp
 87 7ee780fa 2021-07-21 op The echoarea is usually the last line of the screen.
 88 7ee780fa 2021-07-21 op Messages are often showed there, and link addresses too.
 89 7ee780fa 2021-07-21 op The echoarea is also used to obtain input from the user.
 90 7ee780fa 2021-07-21 op When commands like
 91 7ee780fa 2021-07-21 op .Ic swiper
 92 7ee780fa 2021-07-21 op or
 93 7ee780fa 2021-07-21 op .Ic link-select
 94 9eb0c887 2021-08-03 op are invoked, the minibuffer area grows to show possible completions.
 95 bba111bc 2021-03-28 op .Sh TOFU
 96 bba111bc 2021-03-28 op .Nm
 97 7ee780fa 2021-07-21 op aims to use the
 98 7ee780fa 2021-07-21 op .Dq Trust, but Verify Pq where appropriate
 99 7ee780fa 2021-07-21 op approach for
100 7ee780fa 2021-07-21 op TOFU
101 7ee780fa 2021-07-21 op .Pq Dq Trust On First Use .
102 bba111bc 2021-03-28 op The idea is to define three level of verification for a certificate:
103 bba111bc 2021-03-28 op .Bl -tag -width 12m
104 bba111bc 2021-03-28 op .It untrusted
105 7ee780fa 2021-07-21 op .Pq Sq \&!
106 7ee780fa 2021-07-21 op the server fingerprint does NOT match the stored value.
107 bba111bc 2021-03-28 op .It trusted
108 7ee780fa 2021-07-21 op .Pq Sq v
109 7ee780fa 2021-07-21 op the server fingerprint matches the store one.
110 bba111bc 2021-03-28 op .It verified
111 7ee780fa 2021-07-21 op .Pq Sq V
112 7ee780fa 2021-07-21 op the fingerprint matches and has been verified out-of-band.
113 bba111bc 2021-03-28 op .El
114 bba111bc 2021-03-28 op .Pp
115 7ee780fa 2021-07-21 op The trust level of the page is indicated in the modeline with the
116 7ee780fa 2021-07-21 op indicated character.
117 7ee780fa 2021-07-21 op .Pp
118 bba111bc 2021-03-28 op Most of the time the
119 bba111bc 2021-03-28 op .Dq trusted
120 bba111bc 2021-03-28 op level is enough, but where is appropriate users should be able to
121 bba111bc 2021-03-28 op verify out-of-band the certificate.
122 bba111bc 2021-03-28 op .Pp
123 bba111bc 2021-03-28 op At the moment, there is no built-in support for an out-of-band
124 bba111bc 2021-03-28 op verification though.
125 f1279523 2021-08-13 op .Sh SUPPORTED PROTOCOLS
126 f1279523 2021-08-13 op The following protocols are supported:
127 f1279523 2021-08-13 op .Bl -tag -width gemini://
128 f1279523 2021-08-13 op .It about:
129 f1279523 2021-08-13 op About pages are
130 4a52e6fe 2021-08-03 op .Nm
131 f1279523 2021-08-13 op internal page.
132 f1279523 2021-08-13 op See about:about for a list of all these pages.
133 f1279523 2021-08-13 op .It file://
134 f1279523 2021-08-13 op File types know to
135 f1279523 2021-08-13 op .Nm ,
136 f1279523 2021-08-13 op such as .gmi, .gemini, .txt, .md, .markdown, .diff or .patch, can be
137 f1279523 2021-08-13 op viewed inside the application.
138 f1279523 2021-08-13 op Types of local files are detected solely based on the file extension.
139 f1279523 2021-08-13 op On some systems, such as
140 f1279523 2021-08-13 op .Ox ,
141 f1279523 2021-08-13 op only files inside special directories
142 f1279523 2021-08-13 op .Pq like Pa /tmp No or Pa ~/Downloads
143 f1279523 2021-08-13 op are available.
144 f1279523 2021-08-13 op .It finger://
145 f1279523 2021-08-13 op Finger URLs are interpreted as follows:
146 4a52e6fe 2021-08-03 op .Bl -bullet -compact
147 4a52e6fe 2021-08-03 op .It
148 4a52e6fe 2021-08-03 op the host is determined by the host name portion of the URL
149 4a52e6fe 2021-08-03 op .It
150 4a52e6fe 2021-08-03 op if the user portion of the URL is provided, it's interpreted as the
151 4a52e6fe 2021-08-03 op user to finger, otherwise the path component will be used
152 4a52e6fe 2021-08-03 op .El
153 4a52e6fe 2021-08-03 op thus
154 4a52e6fe 2021-08-03 op .Lk finger://user@hostname
155 4a52e6fe 2021-08-03 op and
156 4a52e6fe 2021-08-03 op .Lk finger://hostname/user
157 f1279523 2021-08-13 op are treated as the same URL.
158 f1279523 2021-08-13 op .It gemini://
159 f1279523 2021-08-13 op Gemini is fully supported, with the exception of client-certificates.
160 f1279523 2021-08-13 op .It gopher://
161 4a52e6fe 2021-08-03 op Gopher support is limited to items type 0, 1 and 7.
162 4a52e6fe 2021-08-03 op All text is assumed to be encoded in UTF-8 (or ASCII).
163 f1279523 2021-08-13 op .El
164 eb6e7b8a 2021-08-16 op .Pp
165 eb6e7b8a 2021-08-16 op User-entered URLs, given as argument on the command line or entered
166 eb6e7b8a 2021-08-16 op with
167 eb6e7b8a 2021-08-16 op .Ic load-url ,
168 eb6e7b8a 2021-08-16 op are intepreted with a simple heuristic:
169 eb6e7b8a 2021-08-16 op .Bl -bullet -compact
170 eb6e7b8a 2021-08-16 op .It
171 eb6e7b8a 2021-08-16 op if it's a proper absolute URL then use it as-is,
172 eb6e7b8a 2021-08-16 op .It
173 eb6e7b8a 2021-08-16 op if it starts with
174 eb6e7b8a 2021-08-16 op .Dq ./
175 eb6e7b8a 2021-08-16 op or
176 eb6e7b8a 2021-08-16 op .Dq /
177 eb6e7b8a 2021-08-16 op assume it's a file:// URL,
178 eb6e7b8a 2021-08-16 op .It
179 eb6e7b8a 2021-08-16 op otherwise assume it's a Gemini URL.
180 a74a9f2c 2021-10-08 op .El
181 a74a9f2c 2021-10-08 op .Sh CONFIGURATION FILE
182 a74a9f2c 2021-10-08 op During the startup,
183 a74a9f2c 2021-10-08 op .Nm
184 a74a9f2c 2021-10-08 op reads the configuration file at
185 a74a9f2c 2021-10-08 op .Pa ~/.config/telescope/config
186 a74a9f2c 2021-10-08 op or
187 a74a9f2c 2021-10-08 op .Pa ~/.telescope/config .
188 a74a9f2c 2021-10-08 op .Pp
189 a74a9f2c 2021-10-08 op It's possible to load a custom configuration file using the
190 a74a9f2c 2021-10-08 op .Fl c
191 a74a9f2c 2021-10-08 op flag.
192 a74a9f2c 2021-10-08 op .Pp
193 a74a9f2c 2021-10-08 op .Nm
194 a74a9f2c 2021-10-08 op will also load a file called
195 a74a9f2c 2021-10-08 op .Pa config-TERM ,
196 a74a9f2c 2021-10-08 op where
197 a74a9f2c 2021-10-08 op .Dq TERM
198 a74a9f2c 2021-10-08 op is the name of the terminal type
199 a74a9f2c 2021-10-08 op .Pq i.e. the TERM environment variable ,
200 a74a9f2c 2021-10-08 op if it exists.
201 a74a9f2c 2021-10-08 op .Pp
202 a74a9f2c 2021-10-08 op The format of the configuration file is fairly flexible.
203 a74a9f2c 2021-10-08 op The current line can be extended over multiple ones using a
204 a74a9f2c 2021-10-08 op backslash
205 a74a9f2c 2021-10-08 op .Pq Sq \e .
206 a74a9f2c 2021-10-08 op Comments can be put anywhere in the file using a hash mark
207 a74a9f2c 2021-10-08 op .Pq Sq # ,
208 a74a9f2c 2021-10-08 op and extend to the end of the current line, but backslashes can't be
209 a74a9f2c 2021-10-08 op used to extend comments over multiple lines.
210 a74a9f2c 2021-10-08 op .Pp
211 a74a9f2c 2021-10-08 op The following constructs are available:
212 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
213 a74a9f2c 2021-10-08 op .It Ic bind Ar map Ar key Ar cmd
214 a74a9f2c 2021-10-08 op Bind
215 a74a9f2c 2021-10-08 op .Ar key
216 a74a9f2c 2021-10-08 op to the function
217 a74a9f2c 2021-10-08 op .Ar cmd
218 a74a9f2c 2021-10-08 op in the keymap
219 a74a9f2c 2021-10-08 op .Ar map .
220 a74a9f2c 2021-10-08 op Valid values for map are
221 a74a9f2c 2021-10-08 op .Dq global-map
222 a74a9f2c 2021-10-08 op .Pq i.e. when the user is viewing a page
223 a74a9f2c 2021-10-08 op and
224 a74a9f2c 2021-10-08 op .Dq minibuffer-map
225 a74a9f2c 2021-10-08 op .Pq i.e. when the minibuffer has the focus.
226 a74a9f2c 2021-10-08 op .Ar key
227 a74a9f2c 2021-10-08 op follows the same syntax described in
228 a74a9f2c 2021-10-08 op .Sx DEFAULT KEY BINDINGS
229 a74a9f2c 2021-10-08 op and all the possible functions are listed in
230 a74a9f2c 2021-10-08 op .Sx INTERACTIVE COMMANDS .
231 a74a9f2c 2021-10-08 op .It Ic proxy Ar proto Ic via Ar url
232 a74a9f2c 2021-10-08 op Use
233 a74a9f2c 2021-10-08 op .Ar url
234 a74a9f2c 2021-10-08 op as proxy for all URLs with
235 a74a9f2c 2021-10-08 op protocol
236 a74a9f2c 2021-10-08 op .Ar proto .
237 a74a9f2c 2021-10-08 op .Ar url
238 a74a9f2c 2021-10-08 op must be a Gemini URI without path, query and fragment component.
239 a74a9f2c 2021-10-08 op .It Ic set Ar opt No = Ar val
240 a74a9f2c 2021-10-08 op Set the option
241 a74a9f2c 2021-10-08 op .Ar opt
242 a74a9f2c 2021-10-08 op to the value
243 a74a9f2c 2021-10-08 op .Ar val .
244 a74a9f2c 2021-10-08 op Valid options are:
245 a74a9f2c 2021-10-08 op .Pp
246 a74a9f2c 2021-10-08 op .Bl -tag -width twelveletters -compact
247 a74a9f2c 2021-10-08 op .It autosave
248 a74a9f2c 2021-10-08 op .Pq integer
249 a74a9f2c 2021-10-08 op If greater than zero, save the session after the specified amount of
250 a74a9f2c 2021-10-08 op seconds after some events happens
251 a74a9f2c 2021-10-08 op .Pq new or closed tabs, visited a link ...
252 a74a9f2c 2021-10-08 op Defaults to 20.
253 4702c8ff 2021-01-02 op .It change-title
254 4702c8ff 2021-01-02 op .Pq integer
255 4702c8ff 2021-01-02 op If nonzero, set the terminal title to the page title.
256 4702c8ff 2021-01-02 op Defaults to 1.
257 a74a9f2c 2021-10-08 op .It dont-wrap-pre
258 a74a9f2c 2021-10-08 op .Pq integer
259 a74a9f2c 2021-10-08 op If nonzero, don't wrap preformatted blocks.
260 a74a9f2c 2021-10-08 op Defaults to 0.
261 a74a9f2c 2021-10-08 op .It download-path
262 a74a9f2c 2021-10-08 op .Pq string
263 a74a9f2c 2021-10-08 op The default download path.
264 a74a9f2c 2021-10-08 op Defaults to
265 a74a9f2c 2021-10-08 op .Pa /tmp .
266 a74a9f2c 2021-10-08 op .It emojify-link
267 a74a9f2c 2021-10-08 op .Pq integer
268 a74a9f2c 2021-10-08 op If nonzero, when the text of a link starts with an emoji followed by a
269 a74a9f2c 2021-10-08 op space, use that emoji as line prefix.
270 a74a9f2c 2021-10-08 op Defaults to 1.
271 a74a9f2c 2021-10-08 op .It enable-colors
272 a74a9f2c 2021-10-08 op .Pq integer
273 a74a9f2c 2021-10-08 op If nonzero, enable colours.
274 a74a9f2c 2021-10-08 op Defaults to 0 if
275 a74a9f2c 2021-10-08 op .Ev NO_COLORS
276 a74a9f2c 2021-10-08 op is set, 1 otherwise.
277 a74a9f2c 2021-10-08 op .It fill-column
278 a74a9f2c 2021-10-08 op .Pq integer
279 a74a9f2c 2021-10-08 op If greater than zero, lines of text will be formatted in a way that
280 a74a9f2c 2021-10-08 op don't exceed the given number of columns.
281 a74a9f2c 2021-10-08 op Defaults to 80.
282 a74a9f2c 2021-10-08 op .It hide-pre-blocks
283 a74a9f2c 2021-10-08 op .Pq integer
284 a74a9f2c 2021-10-08 op If nonzero, hide by default the body of the preformatted blocks.
285 a74a9f2c 2021-10-08 op Defaults to zero.
286 a74a9f2c 2021-10-08 op .Ic push-button
287 a74a9f2c 2021-10-08 op can be used to toggle the visibility per-block.
288 a74a9f2c 2021-10-08 op .It hide-pre-closing-line
289 a74a9f2c 2021-10-08 op .Pq integer
290 a74a9f2c 2021-10-08 op If nonzero, hide the closing line of preformatted blocks.
291 a74a9f2c 2021-10-08 op Defaults to 0.
292 a74a9f2c 2021-10-08 op .It hide-pre-context
293 a74a9f2c 2021-10-08 op .Pq integer
294 a74a9f2c 2021-10-08 op If nonzero, hide the start and end line of the preformatted blocks.
295 a74a9f2c 2021-10-08 op If both hide-pre-context and hide-pre-blocks are nonzero, preformatted
296 a74a9f2c 2021-10-08 op blocks are irremediably hidden.
297 a74a9f2c 2021-10-08 op Defaults to zero.
298 a74a9f2c 2021-10-08 op .It new-tab-url
299 a74a9f2c 2021-10-08 op .Pq string
300 a74a9f2c 2021-10-08 op URL for the new tab page.
301 a74a9f2c 2021-10-08 op Defaults to
302 a74a9f2c 2021-10-08 op .Dq about:new .
303 a74a9f2c 2021-10-08 op .It olivetti-mode
304 a74a9f2c 2021-10-08 op .Pq integer
305 a74a9f2c 2021-10-08 op If nonzero, enable
306 a74a9f2c 2021-10-08 op .Ic olivetti-mode
307 a74a9f2c 2021-10-08 op Defaults to 1.
308 a74a9f2c 2021-10-08 op .It tab-bar-show
309 a74a9f2c 2021-10-08 op .Pq integer
310 a74a9f2c 2021-10-08 op If tab-bar-show is -1 hide the tab bar permanently, if 0 show it
311 a74a9f2c 2021-10-08 op unconditionally.
312 a74a9f2c 2021-10-08 op If it's 1, show the bar only when there is more than one tab.
313 a74a9f2c 2021-10-08 op Defaults to 1.
314 a74a9f2c 2021-10-08 op .El
315 a74a9f2c 2021-10-08 op .It Ic style Ar name Ar option
316 a74a9f2c 2021-10-08 op Change the styling of the element identified by
317 a74a9f2c 2021-10-08 op .Ar name .
318 a74a9f2c 2021-10-08 op Multiple options may be specified within curly braces.
319 a74a9f2c 2021-10-08 op Valid style identifiers are:
320 399bd9a0 2021-11-05 op .Bl -tag -width line.download.ongoing -compact -offset Ds
321 a74a9f2c 2021-10-08 op .It line
322 a74a9f2c 2021-10-08 op the area outside the lines in the body of the page.
323 a74a9f2c 2021-10-08 op .It line.compl
324 a74a9f2c 2021-10-08 op the completions.
325 a74a9f2c 2021-10-08 op .It line.compl.current
326 a74a9f2c 2021-10-08 op the current completion.
327 a74a9f2c 2021-10-08 op .It line.help
328 a74a9f2c 2021-10-08 op text in the *Help* buffer.
329 399bd9a0 2021-11-05 op .It line.download.ongoing
330 399bd9a0 2021-11-05 op an ongoing download
331 399bd9a0 2021-11-05 op .It line.download.done
332 399bd9a0 2021-11-05 op a completed download
333 399bd9a0 2021-11-05 op .It line.download.info
334 399bd9a0 2021-11-05 op informational text in the *Downloads* buffer.
335 a74a9f2c 2021-10-08 op .It line.text
336 a74a9f2c 2021-10-08 op text lines.
337 a74a9f2c 2021-10-08 op .It line.link
338 a74a9f2c 2021-10-08 op link lines.
339 a74a9f2c 2021-10-08 op .It line.title1..3
340 a74a9f2c 2021-10-08 op headings
341 a74a9f2c 2021-10-08 op .It line.item
342 a74a9f2c 2021-10-08 op item lines.
343 a74a9f2c 2021-10-08 op .It line.quote
344 a74a9f2c 2021-10-08 op quotes.
345 a74a9f2c 2021-10-08 op .It line.pre.start
346 a74a9f2c 2021-10-08 op the heading of a preformatted block.
347 a74a9f2c 2021-10-08 op .It line.pre
348 a74a9f2c 2021-10-08 op the content of a preformatted block.
349 a74a9f2c 2021-10-08 op .It line.pre.end
350 a74a9f2c 2021-10-08 op the closing line of a preformatted block.
351 399bd9a0 2021-11-05 op .It download
352 399bd9a0 2021-11-05 op the download pane
353 a74a9f2c 2021-10-08 op .It minibuffer
354 a74a9f2c 2021-10-08 op the minibuffer.
355 a74a9f2c 2021-10-08 op .It modeline
356 a74a9f2c 2021-10-08 op the modeline.
357 a74a9f2c 2021-10-08 op .It tabline
358 a74a9f2c 2021-10-08 op the tabline.
359 a74a9f2c 2021-10-08 op .It tabline.tab
360 a74a9f2c 2021-10-08 op the non-focused tabs.
361 a74a9f2c 2021-10-08 op .It tabline.current
362 a74a9f2c 2021-10-08 op the focused tab.
363 a74a9f2c 2021-10-08 op .El
364 a74a9f2c 2021-10-08 op .Pp
365 a74a9f2c 2021-10-08 op Valid options are:
366 a74a9f2c 2021-10-08 op .Bl -tag -width Ds
367 a74a9f2c 2021-10-08 op .It Ic attr Ar prefix Oo Ar line Oo Ar trail Oc Oc
368 a74a9f2c 2021-10-08 op Sets the text attributes.
369 a74a9f2c 2021-10-08 op If only one value is given,
370 a74a9f2c 2021-10-08 op .Ar line
371 a74a9f2c 2021-10-08 op and
372 a74a9f2c 2021-10-08 op .Ar trail
373 a74a9f2c 2021-10-08 op default to that; if two values are given then
374 a74a9f2c 2021-10-08 op .Ar trail
375 a74a9f2c 2021-10-08 op defaults to
376 a74a9f2c 2021-10-08 op .Ar prefix .
377 a74a9f2c 2021-10-08 op Each attribute is a comma-separated list of keywords:
378 a74a9f2c 2021-10-08 op .Bl -tag -width underline -compact -offset Ds
379 a74a9f2c 2021-10-08 op .It Ic normal
380 a74a9f2c 2021-10-08 op no attributes.
381 a74a9f2c 2021-10-08 op .It Ic standout
382 a74a9f2c 2021-10-08 op best highlighting mode for the terminal.
383 a74a9f2c 2021-10-08 op .It Ic underline
384 a74a9f2c 2021-10-08 op underlines the text.
385 a74a9f2c 2021-10-08 op .It Ic reverse
386 a74a9f2c 2021-10-08 op reverses background/foreground colors.
387 a74a9f2c 2021-10-08 op .It Ic blink
388 a74a9f2c 2021-10-08 op makes the text blinking.
389 a74a9f2c 2021-10-08 op .It Ic dim
390 a74a9f2c 2021-10-08 op half bright.
391 a74a9f2c 2021-10-08 op .It Ic bold
392 a74a9f2c 2021-10-08 op extra bright or bold.
393 a74a9f2c 2021-10-08 op .El
394 a74a9f2c 2021-10-08 op .Pp
395 a74a9f2c 2021-10-08 op Only the style identifiers with the
396 a74a9f2c 2021-10-08 op .Dq line.
397 a74a9f2c 2021-10-08 op prefix accept up to three attributes.
398 a74a9f2c 2021-10-08 op The other will only use the first one given.
399 a74a9f2c 2021-10-08 op .It Ic bg Ar prefix Oo Ar line Oo Ar trail Oc Oc
400 a74a9f2c 2021-10-08 op Sets the background color.
401 a74a9f2c 2021-10-08 op Follows the same behaviour as
402 a74a9f2c 2021-10-08 op .Ic attr
403 a74a9f2c 2021-10-08 op regarding the optional parameters.
404 a74a9f2c 2021-10-08 op The colour is one of black, red, green, yellow, blue,
405 a74a9f2c 2021-10-08 op magenta, cyan and white; colour0 to colour255
406 a74a9f2c 2021-10-08 op .Pq or color0 to color255
407 a74a9f2c 2021-10-08 op from the 256-colour set;
408 a74a9f2c 2021-10-08 op default for the default colour.
409 a74a9f2c 2021-10-08 op .It Ic fg Ar prefix Oo Ar line Oo Ar trail Oc Oc
410 a74a9f2c 2021-10-08 op Sets the foreground color.
411 a74a9f2c 2021-10-08 op It behaves just like
412 a74a9f2c 2021-10-08 op .Ic bg .
413 a74a9f2c 2021-10-08 op .It Ic prefix Ar prfx Op Ar cont
414 a74a9f2c 2021-10-08 op Sets the prefix for the current line type to
415 a74a9f2c 2021-10-08 op .Ar prfx
416 a74a9f2c 2021-10-08 op and
417 a74a9f2c 2021-10-08 op .Ar cont
418 a74a9f2c 2021-10-08 op as the prefix for the continuation lines
419 a74a9f2c 2021-10-08 op .Pq i.e. when a long line gets wrapped.
420 a74a9f2c 2021-10-08 op If
421 a74a9f2c 2021-10-08 op .Ar cont
422 a74a9f2c 2021-10-08 op is not given its value will be the same of
423 a74a9f2c 2021-10-08 op .Ar prfx .
424 a74a9f2c 2021-10-08 op .El
425 eb6e7b8a 2021-08-16 op .El
426 bba111bc 2021-03-28 op .Sh DEFAULT KEY BINDINGS
427 bba111bc 2021-03-28 op The default key bindings are very similar to GNU Emacs, but care has
428 bba111bc 2021-03-28 op been taken to include also bindings familiar for
429 bba111bc 2021-03-28 op .Xr vi 1
430 bba111bc 2021-03-28 op and
431 bba111bc 2021-03-28 op .Dq CUA
432 bba111bc 2021-03-28 op users.
433 bba111bc 2021-03-28 op In the following examples, C-x means Control-x, M-x means Meta-x,
434 bba111bc 2021-03-28 op where the Meta key may be either a special key on the keyboard or the
435 bba111bc 2021-03-28 op ALT key; otherwise ESC followed by the key X works as well, and C-M-x
436 bba111bc 2021-03-28 op means to press the key X together with both Control and Meta.
437 bba111bc 2021-03-28 op .Pp
438 bba111bc 2021-03-28 op Keys are usually a single character, like
439 bba111bc 2021-03-28 op .Sq p
440 bba111bc 2021-03-28 op or
441 bba111bc 2021-03-28 op .Sq n ,
442 bba111bc 2021-03-28 op but some special keys are accepted as well.
443 bba111bc 2021-03-28 op .Pp
444 bba111bc 2021-03-28 op .Bl -tag -width 16m -offset indent -compact
445 bba111bc 2021-03-28 op .It <up>
446 bba111bc 2021-03-28 op Up arrow
447 bba111bc 2021-03-28 op .It <down>
448 bba111bc 2021-03-28 op Down arrow
449 bba111bc 2021-03-28 op .It <left>
450 bba111bc 2021-03-28 op Left arrow
451 bba111bc 2021-03-28 op .It <right>
452 bba111bc 2021-03-28 op Right arrow
453 bba111bc 2021-03-28 op .It <prior>
454 bba111bc 2021-03-28 op Previous page/Page up
455 bba111bc 2021-03-28 op .It <next>
456 bba111bc 2021-03-28 op Next page/Page down
457 bba111bc 2021-03-28 op .It <home>
458 bba111bc 2021-03-28 op Home
459 bba111bc 2021-03-28 op .It <end>
460 bba111bc 2021-03-28 op End
461 bba111bc 2021-03-28 op .It <f0> thru <f63>
462 bba111bc 2021-03-28 op Function keys
463 bba111bc 2021-03-28 op .It del or backspace
464 bba111bc 2021-03-28 op Backspace
465 bba111bc 2021-03-28 op .It esc
466 bba111bc 2021-03-28 op Escape
467 bba111bc 2021-03-28 op .It space or spc
468 bba111bc 2021-03-28 op Space
469 bba111bc 2021-03-28 op .It enter or ret
470 bba111bc 2021-03-28 op Enter
471 bba111bc 2021-03-28 op .It tab
472 bba111bc 2021-03-28 op Tab
473 8dc60352 2021-06-15 op .It backtab
474 9eb0c887 2021-08-03 op Depends on the configuration of the terminal emulator; usually shift
475 9eb0c887 2021-08-03 op tab.
476 bba111bc 2021-03-28 op .El
477 bba111bc 2021-03-28 op .Ss GNU Emacs-like keys
478 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
479 bba111bc 2021-03-28 op .It C-p
480 7dbaef94 2021-04-22 op previous-line
481 bba111bc 2021-03-28 op .It C-n
482 7dbaef94 2021-04-22 op next-line
483 bba111bc 2021-03-28 op .It C-f
484 7dbaef94 2021-04-22 op forward-char
485 bba111bc 2021-03-28 op .It C-b
486 7dbaef94 2021-04-22 op backward-char
487 bba111bc 2021-03-28 op .It M-{
488 7dbaef94 2021-04-22 op backward-paragraph
489 bba111bc 2021-03-28 op .It M-}
490 7dbaef94 2021-04-22 op forward-paragraph
491 bba111bc 2021-03-28 op .It C-a
492 7dbaef94 2021-04-22 op move-beginning-of-line
493 bba111bc 2021-03-28 op .It C-e
494 7dbaef94 2021-04-22 op move-end-of-line
495 bba111bc 2021-03-28 op .It M-v, M-space
496 7dbaef94 2021-04-22 op scroll-up
497 bba111bc 2021-03-28 op .It C-v, space
498 7dbaef94 2021-04-22 op scroll-down
499 bba111bc 2021-03-28 op .It M-<
500 7dbaef94 2021-04-22 op beginning-of-buffer
501 bba111bc 2021-03-28 op .It M->
502 7dbaef94 2021-04-22 op end-of-buffer
503 bba111bc 2021-03-28 op .It C-x C-c
504 7dbaef94 2021-04-22 op kill-telescope
505 bba111bc 2021-03-28 op .It C-g
506 7dbaef94 2021-04-22 op clear-minibuf
507 bba111bc 2021-03-28 op .It M-x
508 7dbaef94 2021-04-22 op execute-extended-command
509 61251035 2021-06-26 op .It C-c {
510 61251035 2021-06-26 op dec-fill-column
511 61251035 2021-06-26 op .It C-c }
512 61251035 2021-06-26 op inc-fill-column
513 1c412d48 2021-06-25 op .It C-c p
514 1c412d48 2021-06-25 op previous-heading
515 1c412d48 2021-06-25 op .It C-c n
516 1c412d48 2021-06-25 op next-heading
517 157d4810 2021-06-24 op .It >
518 157d4810 2021-06-24 op load-url
519 f2ab2540 2021-07-14 op .It <
520 f2ab2540 2021-07-14 op load-current-url
521 bba111bc 2021-03-28 op .It C-x C-f
522 7dbaef94 2021-04-22 op load-url
523 bba111bc 2021-03-28 op .It C-x M-f
524 7dbaef94 2021-04-22 op load-current-url
525 9a7d62cb 2021-07-21 op .It C-x o
526 9a7d62cb 2021-07-21 op other-window
527 bba111bc 2021-03-28 op .It C-x t 0
528 7dbaef94 2021-04-22 op tab-close
529 bba111bc 2021-03-28 op .It C-x t 1
530 7dbaef94 2021-04-22 op tab-close-other
531 bba111bc 2021-03-28 op .It C-x t 2
532 7dbaef94 2021-04-22 op tab-new
533 bba111bc 2021-03-28 op .It C-x t o
534 7dbaef94 2021-04-22 op tab-next
535 bba111bc 2021-03-28 op .It C-x t O
536 7dbaef94 2021-04-22 op tab-previous
537 bba111bc 2021-03-28 op .It C-x t m
538 7dbaef94 2021-04-22 op tab-move
539 bba111bc 2021-03-28 op .It C-x t M
540 7dbaef94 2021-04-22 op tab-move-to
541 05c5cf0c 2021-07-13 op .It B, C-M-b
542 7dbaef94 2021-04-22 op previous-page
543 05c5cf0c 2021-07-13 op .It F, C-M-f
544 7dbaef94 2021-04-22 op next-page
545 bba111bc 2021-03-28 op .It <f7> a
546 7dbaef94 2021-04-22 op bookmark-page
547 bba111bc 2021-03-28 op .It <f7> <f7>
548 7dbaef94 2021-04-22 op list-bookmarks
549 12cf7d80 2021-07-15 op .It C-z
550 12cf7d80 2021-07-15 op suspend-telescope
551 bba111bc 2021-03-28 op .El
552 bba111bc 2021-03-28 op .Ss Xr vi 1 Ns -like keys
553 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
554 bba111bc 2021-03-28 op .It k
555 7dbaef94 2021-04-22 op previous-line
556 bba111bc 2021-03-28 op .It j
557 7dbaef94 2021-04-22 op next-line
558 bba111bc 2021-03-28 op .It l
559 7dbaef94 2021-04-22 op forward-char
560 bba111bc 2021-03-28 op .It h
561 7dbaef94 2021-04-22 op backward-char
562 bba111bc 2021-03-28 op .It {
563 7dbaef94 2021-04-22 op backward-paragraph
564 bba111bc 2021-03-28 op .It }
565 7dbaef94 2021-04-22 op forward-paragraph
566 bba111bc 2021-03-28 op .It ^
567 7dbaef94 2021-04-22 op move-beginning-of-line
568 bba111bc 2021-03-28 op .It $
569 7dbaef94 2021-04-22 op move-end-of-line
570 bba111bc 2021-03-28 op .It K
571 7dbaef94 2021-04-22 op scroll-line-up
572 bba111bc 2021-03-28 op .It J
573 7dbaef94 2021-04-22 op scroll-line-down
574 bba111bc 2021-03-28 op .It g g
575 7dbaef94 2021-04-22 op beginning-of-buffer
576 6c04e8b6 2021-04-01 op .It G
577 7dbaef94 2021-04-22 op end-of-buffer
578 bba111bc 2021-03-28 op .It g D
579 7dbaef94 2021-04-22 op tab-close
580 bba111bc 2021-03-28 op .It g N
581 7dbaef94 2021-04-22 op tab-new
582 bba111bc 2021-03-28 op .It g t
583 7dbaef94 2021-04-22 op tab-next
584 bba111bc 2021-03-28 op .It g T
585 7dbaef94 2021-04-22 op tab-previous
586 bba111bc 2021-03-28 op .It g M-t
587 7dbaef94 2021-04-22 op tab-move
588 bba111bc 2021-03-28 op .It g M-T
589 7dbaef94 2021-04-22 op tab-move-to
590 bba111bc 2021-03-28 op .It H
591 7dbaef94 2021-04-22 op previous-page
592 bba111bc 2021-03-28 op .It L
593 7dbaef94 2021-04-22 op next-page
594 bba111bc 2021-03-28 op .It q
595 7dbaef94 2021-04-22 op kill-telescope
596 bba111bc 2021-03-28 op .It ESC
597 7dbaef94 2021-04-22 op clear-minibuf
598 bba111bc 2021-03-28 op .It :
599 7dbaef94 2021-04-22 op execute-extended-command
600 bba111bc 2021-03-28 op .El
601 bba111bc 2021-03-28 op .Ss CUA-like keys
602 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
603 bba111bc 2021-03-28 op .It <up>
604 7dbaef94 2021-04-22 op previous-line
605 bba111bc 2021-03-28 op .It <down>
606 7dbaef94 2021-04-22 op next-line
607 bba111bc 2021-03-28 op .It <right>
608 7dbaef94 2021-04-22 op forward-char
609 bba111bc 2021-03-28 op .It <left>
610 7dbaef94 2021-04-22 op backward-char
611 12cf7d80 2021-07-15 op .It <home>
612 12cf7d80 2021-07-15 op move-beginning-of-line
613 12cf7d80 2021-07-15 op .It <end>
614 12cf7d80 2021-07-15 op move-end-of-line
615 bba111bc 2021-03-28 op .It <prior>
616 7dbaef94 2021-04-22 op scroll-up
617 bba111bc 2021-03-28 op .It <next>
618 7dbaef94 2021-04-22 op scroll-down
619 25f5824b 2021-07-08 op .It C-w
620 25f5824b 2021-07-08 op tab-close
621 3c3af0fd 2021-07-08 op .It C-t
622 3c3af0fd 2021-07-08 op tab-new
623 3c3af0fd 2021-07-08 op .It M-<prior>
624 3c3af0fd 2021-07-08 op tab-previous
625 3c3af0fd 2021-07-08 op .It M-<next>
626 3c3af0fd 2021-07-08 op tab-next
627 135e1a52 2021-01-02 op .It del
628 135e1a52 2021-01-02 op previous-page
629 bba111bc 2021-03-28 op .It M-<left>
630 7dbaef94 2021-04-22 op previous-page
631 bba111bc 2021-03-28 op .It M-<right>
632 7dbaef94 2021-04-22 op next-page
633 661233ed 2021-07-14 op .It <f5>
634 661233ed 2021-07-14 op reload-page
635 661233ed 2021-07-14 op .It r
636 661233ed 2021-07-14 op reload-page
637 bba111bc 2021-03-28 op .El
638 bba111bc 2021-03-28 op .Ss Neither Emacs nor vi specific
639 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
640 7a014cef 2021-04-01 op .It <f1>
641 7dbaef94 2021-04-22 op toggle-help
642 bba111bc 2021-03-28 op .It enter
643 7dbaef94 2021-04-22 op push-button
644 bba111bc 2021-03-28 op .It M-enter
645 7dbaef94 2021-04-22 op push-button-new-tab
646 bba111bc 2021-03-28 op .It M-tab
647 7dbaef94 2021-04-22 op previous-button
648 8dc60352 2021-06-15 op .It backtab
649 8dc60352 2021-06-15 op previous-button
650 bba111bc 2021-03-28 op .It tab
651 7dbaef94 2021-04-22 op next-button
652 3360ef1b 2021-07-14 op .It M-t
653 3360ef1b 2021-07-14 op tab-select
654 75fd746b 2021-07-21 op .It \&[
655 f6ad0de1 2021-07-16 op tab-previous
656 75fd746b 2021-07-21 op .It \&]
657 f6ad0de1 2021-07-16 op tab-next
658 935d50dc 2021-08-18 op .It M-\&[
659 935d50dc 2021-08-18 op tab-move-to
660 935d50dc 2021-08-18 op .It M-\&]
661 935d50dc 2021-08-18 op tab-move
662 dad288ec 2021-07-15 op .It M-l
663 753c6ac7 2021-07-14 op link-select
664 753c6ac7 2021-07-14 op .It M-/
665 753c6ac7 2021-07-14 op swiper
666 bba111bc 2021-03-28 op .El
667 bba111bc 2021-03-28 op .Ss Minibuffer-specific keys
668 bba111bc 2021-03-28 op .Bl -tag -width xxxxxxxxxxxx -offset indent -compact
669 bba111bc 2021-03-28 op .It enter
670 7dbaef94 2021-04-22 op mini-complete-and-exit
671 bba111bc 2021-03-28 op .It C-g
672 7dbaef94 2021-04-22 op mini-abort
673 bba111bc 2021-03-28 op .It ESC
674 7dbaef94 2021-04-22 op mini-abort
675 bba111bc 2021-03-28 op .It C-d
676 7dbaef94 2021-04-22 op mini-delete-char
677 bba111bc 2021-03-28 op .It del
678 7dbaef94 2021-04-22 op mini-delete-backward-char
679 bba111bc 2021-03-28 op .It backspace
680 7dbaef94 2021-04-22 op mini-delete-backward-char
681 bba111bc 2021-03-28 op .It C-h
682 7dbaef94 2021-04-22 op mini-delete-backward-char
683 bba111bc 2021-03-28 op .It C-b
684 7dbaef94 2021-04-22 op backward-char
685 bba111bc 2021-03-28 op .It C-f
686 7dbaef94 2021-04-22 op forward-char
687 bba111bc 2021-03-28 op .It <left>
688 7dbaef94 2021-04-22 op backward-char
689 bba111bc 2021-03-28 op .It <right>
690 7dbaef94 2021-04-22 op forward-char
691 bba111bc 2021-03-28 op .It C-e
692 7dbaef94 2021-04-22 op move-end-of-line
693 bba111bc 2021-03-28 op .It C-a
694 7dbaef94 2021-04-22 op move-beginning-of-line
695 bba111bc 2021-03-28 op .It <end>
696 7dbaef94 2021-04-22 op move-end-of-line
697 bba111bc 2021-03-28 op .It <home>
698 7dbaef94 2021-04-22 op move-beginning-of-line
699 bba111bc 2021-03-28 op .It C-k
700 7dbaef94 2021-04-22 op mini-kill-line
701 bba111bc 2021-03-28 op .It M-p
702 7dbaef94 2021-04-22 op mini-previous-history-element
703 bba111bc 2021-03-28 op .It M-n
704 7dbaef94 2021-04-22 op mini-next-history-element
705 e7b982f4 2021-07-14 op .It C-p
706 e7b982f4 2021-07-14 op previous-completion
707 e7b982f4 2021-07-14 op .It C-n
708 dffb2592 2021-07-14 op next-completion
709 dffb2592 2021-07-14 op .It <up>
710 dffb2592 2021-07-14 op previous-completion
711 dffb2592 2021-07-14 op .It <down>
712 e7b982f4 2021-07-14 op next-completion
713 e7b982f4 2021-07-14 op .It tab
714 e7b982f4 2021-07-14 op insert-current-candidate
715 7ee780fa 2021-07-21 op .It M-<
716 7ee780fa 2021-07-21 op mini-goto-beginning
717 7ee780fa 2021-07-21 op .It M->
718 7ee780fa 2021-07-21 op mini-goto-end
719 bba111bc 2021-03-28 op .El
720 bba111bc 2021-03-28 op .Sh INTERACTIVE COMMANDS
721 bba111bc 2021-03-28 op Follows the documentation for the interactive commands.
722 bba111bc 2021-03-28 op These commands can be bound to a key or executed with
723 bba111bc 2021-03-28 op .Ic execute-extended-command .
724 bba111bc 2021-03-28 op .Ss Movement commands
725 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
726 bba111bc 2021-03-28 op .It Ic backward-char
727 bba111bc 2021-03-28 op Move point one character backward.
728 bba111bc 2021-03-28 op .It Ic backward-paragraph
729 bba111bc 2021-03-28 op Move point one paragraph backward.
730 bba111bc 2021-03-28 op .It Ic beginning-of-buffer
731 bba111bc 2021-03-28 op Move point to the beginning of the buffer.
732 bba111bc 2021-03-28 op .It Ic end-of-buffer
733 bba111bc 2021-03-28 op Move point to the end of the buffer.
734 bba111bc 2021-03-28 op .It Ic forward-char
735 bba111bc 2021-03-28 op Move point one character forward.
736 bba111bc 2021-03-28 op .It Ic forward-paragraph
737 bba111bc 2021-03-28 op Move point one paragraph forward.
738 e7b982f4 2021-07-14 op .It Ic insert-current-candidate
739 e7b982f4 2021-07-14 op Copy the current selection text as minibuffer input.
740 bba111bc 2021-03-28 op .It Ic move-beginning-of-line
741 bba111bc 2021-03-28 op Move point at the beginning of the current (visual) line.
742 bba111bc 2021-03-28 op .It Ic move-end-of-line
743 bba111bc 2021-03-28 op Move point at the end of the current (visual) line.
744 bba111bc 2021-03-28 op .It Ic next-button
745 bba111bc 2021-03-28 op Move point to the next link.
746 e7b982f4 2021-07-14 op .It Ic next-completion
747 e7b982f4 2021-07-14 op Select the next completion.
748 1c412d48 2021-06-25 op .It Ic next-heading
749 1c412d48 2021-06-25 op Move point to the next heading.
750 bba111bc 2021-03-28 op .It Ic next-line
751 bba111bc 2021-03-28 op Move point to the next (visual) line, in the same column if possible.
752 bba111bc 2021-03-28 op .It Ic previous-button
753 bba111bc 2021-03-28 op Move point to the previous link.
754 e7b982f4 2021-07-14 op .It Ic previous-completion
755 e7b982f4 2021-07-14 op Select the previous completion.
756 1c412d48 2021-06-25 op .It Ic previous-heading
757 1c412d48 2021-06-25 op Move point to the previous heading.
758 bba111bc 2021-03-28 op .It Ic previous-line
759 bba111bc 2021-03-28 op Move point to the previous (visual) line.
760 bba111bc 2021-03-28 op .El
761 bba111bc 2021-03-28 op .Ss Bookmark-related commands
762 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
763 bba111bc 2021-03-28 op .It Ic bookmark-page
764 b3be07ea 2021-07-18 op Save a page in the bookmark file.
765 bba111bc 2021-03-28 op It preloads the minibuffer with the current URL.
766 63875195 2021-04-01 op .It Ic list-bookmarks
767 bba111bc 2021-03-28 op Load the bookmarks page.
768 bba111bc 2021-03-28 op .El
769 bba111bc 2021-03-28 op .Ss Tab-related commands
770 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
771 bba111bc 2021-03-28 op .It Ic tab-close
772 bba111bc 2021-03-28 op Close the current tab.
773 bba111bc 2021-03-28 op .It Ic tab-close-other
774 bba111bc 2021-03-28 op Close all tabs but the current one.
775 bba111bc 2021-03-28 op .It Ic tab-move
776 bba111bc 2021-03-28 op Move the current tab after the next one, wrapping around if
777 bba111bc 2021-03-28 op needed.
778 bba111bc 2021-03-28 op .It Ic tab-move-to
779 bba111bc 2021-03-28 op Move the current tab before the previous one, wrapping around if needed.
780 bba111bc 2021-03-28 op .It Ic tab-new
781 bba111bc 2021-03-28 op Open a new tab.
782 bba111bc 2021-03-28 op .It Ic tab-next
783 bba111bc 2021-03-28 op Focus next tab, wrapping around eventually.
784 bba111bc 2021-03-28 op .It Ic tab-previous
785 bba111bc 2021-03-28 op Focus the previous tab, wrapping around eventually.
786 3360ef1b 2021-07-14 op .It Ic tab-select
787 3360ef1b 2021-07-14 op Switch to a tab using the minibuffer.
788 bba111bc 2021-03-28 op .El
789 bba111bc 2021-03-28 op .Ss Misc commands
790 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
791 bba111bc 2021-03-28 op .It Ic clear-minibuf
792 b3be07ea 2021-07-18 op Clear the echo area.
793 61251035 2021-06-26 op .It Ic dec-fill-column
794 b3be07ea 2021-07-18 op Decrement fill-column by two.
795 bba111bc 2021-03-28 op .It Ic execute-extended-command
796 b3be07ea 2021-07-18 op Execute an internal command.
797 bba111bc 2021-03-28 op .It Ic kill-telescope
798 bba111bc 2021-03-28 op Quit
799 bba111bc 2021-03-28 op .Nm .
800 61251035 2021-06-26 op .It Ic inc-fill-column
801 b3be07ea 2021-07-18 op Increment fill-column by two.
802 753c6ac7 2021-07-14 op .It Ic link-select
803 753c6ac7 2021-07-14 op Select and visit a link using the minibuffer.
804 bba111bc 2021-03-28 op .It Ic load-current-url
805 b3be07ea 2021-07-18 op Edit the current URL.
806 bba111bc 2021-03-28 op .It Ic load-url
807 b3be07ea 2021-07-18 op Prompt for an URL.
808 bba111bc 2021-03-28 op .It Ic next-page
809 b3be07ea 2021-07-18 op Go forward in the page history.
810 9f3f9f5e 2021-06-19 op .It Ic olivetti-mode
811 9f3f9f5e 2021-06-19 op Toggle olivetti mode (i.e. horizontal centering of the lines of the
812 9f3f9f5e 2021-06-19 op window.)
813 9a7d62cb 2021-07-21 op .It Ic other-window
814 9a7d62cb 2021-07-21 op Select the other window.
815 bba111bc 2021-03-28 op .It Ic previous-page
816 b3be07ea 2021-07-18 op Go backward in the page history.
817 bba111bc 2021-03-28 op .It Ic push-button
818 b3be07ea 2021-07-18 op Follow link at point, or toggle the visibility of the following
819 b3be07ea 2021-07-18 op preformatted block if called when the cursor is on the heading of the block.
820 bba111bc 2021-03-28 op .It Ic push-button-new-tab
821 b3be07ea 2021-07-18 op Follow link at point in a new tab.
822 bba111bc 2021-03-28 op .It Ic redraw
823 708fab48 2021-06-19 op Redraw the screen, useful if some background program messed up the
824 bba111bc 2021-03-28 op display.
825 661233ed 2021-07-14 op .It Ic reload-page
826 661233ed 2021-07-14 op Reload the current page.
827 bba111bc 2021-03-28 op .It Ic scroll-down
828 bba111bc 2021-03-28 op Scroll down by one visual page.
829 bba111bc 2021-03-28 op .It Ic scroll-line-down
830 bba111bc 2021-03-28 op Scroll down by one line.
831 bba111bc 2021-03-28 op .It Ic scroll-line-up
832 bba111bc 2021-03-28 op Scroll up by one line.
833 bba111bc 2021-03-28 op .It Ic scroll-up
834 bba111bc 2021-03-28 op Scroll up by one visual page.
835 12cf7d80 2021-07-15 op .It Ic suspend-telescope
836 12cf7d80 2021-07-15 op Suspend the current
837 12cf7d80 2021-07-15 op .Nm
838 12cf7d80 2021-07-15 op session.
839 753c6ac7 2021-07-14 op .It Ic swiper
840 753c6ac7 2021-07-14 op Jump to a line using the minibuffer.
841 edd9a650 2021-07-15 op .It Ic toc
842 b3be07ea 2021-07-18 op Jump to a heading using the minibuffer.
843 7a014cef 2021-04-01 op .It Ic toggle-help
844 7a014cef 2021-04-01 op Toggle side window with help about available keys and their associated
845 7a014cef 2021-04-01 op interactive command.
846 987d9c88 2021-07-15 op .It Ic toggle-pre-wrap
847 987d9c88 2021-07-15 op Toggle the wrapping of preformatted blocks.
848 bba111bc 2021-03-28 op .El
849 bba111bc 2021-03-28 op .Ss Minibuffer commands
850 bba111bc 2021-03-28 op .Bl -tag -width execute-extended-command -compact
851 bba111bc 2021-03-28 op .It Ic mini-abort
852 bba111bc 2021-03-28 op Abort the current minibuffer action.
853 bba111bc 2021-03-28 op .It Ic mini-complete-and-exit
854 bba111bc 2021-03-28 op Complete the current minibuffer action.
855 bba111bc 2021-03-28 op .It Ic mini-delete-backward-char
856 bba111bc 2021-03-28 op Delete the character before the point.
857 bba111bc 2021-03-28 op .It Ic mini-delete-char
858 bba111bc 2021-03-28 op Delete the character after the point.
859 de190a2b 2021-07-17 op .It Ic mini-goto-beginning
860 de190a2b 2021-07-17 op Select the first completion, if any.
861 de190a2b 2021-07-17 op .It Ic mini-goto-end
862 de190a2b 2021-07-17 op Select the last completion, if any.
863 bba111bc 2021-03-28 op .It Ic mini-kill-line
864 b3be07ea 2021-07-18 op Delete from point until the end of the line.
865 bba111bc 2021-03-28 op .It Ic mini-next-history-element
866 bba111bc 2021-03-28 op Load the previous history element.
867 bba111bc 2021-03-28 op .It Ic mini-previous-history-element
868 bba111bc 2021-03-28 op Load the next history element.
869 bba111bc 2021-03-28 op .El
870 7d2d15f5 2021-04-30 op .Ss Aliases
871 7d2d15f5 2021-04-30 op The following aliases are available during
872 7d2d15f5 2021-04-30 op .Ic execute-extended-command :
873 7d2d15f5 2021-04-30 op .Bl -tag -width 16m -compact
874 c82b3fd6 2021-05-12 op .It Ic tabn
875 c82b3fd6 2021-05-12 op .Ic tab-next
876 c82b3fd6 2021-05-12 op .It Ic tabnew
877 c82b3fd6 2021-05-12 op .Ic tab-new
878 c82b3fd6 2021-05-12 op .It Ic tabp
879 c82b3fd6 2021-05-12 op .Ic tab-previous
880 7d2d15f5 2021-04-30 op .It Ic q No and Ic wq
881 7d2d15f5 2021-04-30 op .Ic kill-telescope
882 74ca8ef4 2021-06-19 op .El
883 7ee780fa 2021-07-21 op .Sh ENVIRONMENT
884 7ee780fa 2021-07-21 op When
885 7ee780fa 2021-07-21 op .Nm
886 7ee780fa 2021-07-21 op is started, it inspects the following environment variables:
887 7ee780fa 2021-07-21 op .Bl -tag -width NO_COLORS
888 7ee780fa 2021-07-21 op .It Ev HOME
889 7ee780fa 2021-07-21 op The user's login directory.
890 7ee780fa 2021-07-21 op .It Ev NO_COLORS
891 7ee780fa 2021-07-21 op To decide whether to use colors or not.
892 7ee780fa 2021-07-21 op The content of the variable doesn't matter.
893 7ee780fa 2021-07-21 op .It Ev TERM
894 7ee780fa 2021-07-21 op The user's terminal name.
895 73389b00 2021-10-08 op .It Ev XDG_CACHE_HOME , Ev XDG_CONFIG_HOME , Ev XDG_DATA_HOME
896 73389b00 2021-10-08 op If defined can alter the default location of the files used.
897 7ee780fa 2021-07-21 op .El
898 bba111bc 2021-03-28 op .Sh FILES
899 73389b00 2021-10-08 op By default
900 73389b00 2021-10-08 op .Nm
901 73389b00 2021-10-08 op follows the XDG Base Directory Specification.
902 73389b00 2021-10-08 op However, if
903 73389b00 2021-10-08 op .Pa ~/.telescope
904 73389b00 2021-10-08 op exists, XDG is ignored and all the files are stored inside it.
905 73389b00 2021-10-08 op The usage of
906 73389b00 2021-10-08 op .Ev XDG_CACHE_HOME ,
907 73389b00 2021-10-08 op .Ev XDG_CONFIG_HOME
908 73389b00 2021-10-08 op and
909 73389b00 2021-10-08 op .Ev XDG_DATA_HOME
910 73389b00 2021-10-08 op can further alter the location of these files.
911 73389b00 2021-10-08 op .Pp
912 bba111bc 2021-03-28 op .Bl -tag -width Ds -compact
913 eb2ed626 2021-10-07 op .It Pa ~/.config/telescope/config
914 dca97b00 2021-06-19 op Default configuration file.
915 de04b178 2021-11-26 op .It Pa ~/.local/share/telescope/pages/about_*.gmi
916 eb2ed626 2021-10-07 op Overrides for built-in about: pages.
917 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/bookmarks.gmi
918 eb2ed626 2021-10-07 op Bookmarks file.
919 eb2ed626 2021-10-07 op .It Pa ~/.local/share/telescope/known_hosts
920 7ee780fa 2021-07-21 op Hash of the certificates for all the known hosts.
921 7ee780fa 2021-07-21 op Each line contains three fields: hostname with optional port number,
922 7ee780fa 2021-07-21 op hash of the certificate and a numeric flag.
923 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/lock
924 d0fd368a 2021-07-15 op Lock file used to prevent multiple instance of
925 d0fd368a 2021-07-15 op .Nm
926 d0fd368a 2021-07-15 op from running at the same time.
927 eb2ed626 2021-10-07 op .It Pa ~/.cache/telescope/session
928 7ee780fa 2021-07-21 op The list of tabs from the last session.
929 7ee780fa 2021-07-21 op Every line identifies a tab and contains three space-separated fields:
930 7ee780fa 2021-07-21 op the full URL, a comma-separated list of attributes and the cached
931 7ee780fa 2021-07-21 op title.
932 87e3e801 2021-07-17 op Is written by
933 e9b1e094 2021-04-01 op .Ic kill-telescope
934 7ee780fa 2021-07-21 op and loaded during startup.
935 6c04e8b6 2021-04-01 op .El
936 74ca8ef4 2021-06-19 op .Sh EXAMPLES
937 984245ce 2021-06-23 op It's possible to browse
938 984245ce 2021-06-23 op .Dq the small web
939 984245ce 2021-06-23 op .Pq i.e. simple websites
940 3a761ed2 2021-06-25 op by using programs like the duckling-proxy by defining a proxy in
941 eb2ed626 2021-10-07 op .Pa ~/.config/telescope/config :
942 984245ce 2021-06-23 op .Bd -literal -offset indent
943 a0c41865 2021-07-20 op proxy http via "gemini://127.0.0.1:1965"
944 a0c41865 2021-07-20 op proxy https via "gemini://127.0.0.1:1965"
945 74ca8ef4 2021-06-19 op .Ed
946 19f9cf0f 2021-06-24 op .Pp
947 19f9cf0f 2021-06-24 op To load
948 19f9cf0f 2021-06-24 op .Nm
949 7ee780fa 2021-07-21 op without any configuration
950 19f9cf0f 2021-06-24 op .Bd -literal -offset indent
951 19f9cf0f 2021-06-24 op telescope -c /dev/null
952 19f9cf0f 2021-06-24 op .Ed
953 73389b00 2021-10-08 op .Sh STANDARDS
954 73389b00 2021-10-08 op .Rs
955 73389b00 2021-10-08 op .%B XDG Base Directory Specification
956 73389b00 2021-10-08 op .%U https://specifications.freedesktop.org/basedir-spec/latest/
957 73389b00 2021-10-08 op .Re
958 bba111bc 2021-03-28 op .Sh AUTHORS
959 bba111bc 2021-03-28 op .An -nosplit
960 bba111bc 2021-03-28 op The
961 bba111bc 2021-03-28 op .Nm
962 bba111bc 2021-03-28 op program was written by
963 bba111bc 2021-03-28 op .An Omar Polo Aq Mt op@omarpolo.com .
964 8bfe7529 2021-11-27 op .Sh CAVEATS
965 8bfe7529 2021-11-27 op .Nm
966 95e30305 2021-01-02 op assumes a UTF-8 environment and doesn't try to cope with other encodings.
967 95e30305 2021-01-02 op This can cause strange rendering issues if you're lucky, or possibly
968 95e30305 2021-01-02 op weird thing happening depending on your locale and terminal emulator.
969 7ee780fa 2021-07-21 op .Sh BUGS
970 7ee780fa 2021-07-21 op There's no UI for out-of-band certificates validation.