Blame


1 cc9bf8f2 2021-11-05 op TELESCOPE(1) General Commands Manual TELESCOPE(1)
2 cc9bf8f2 2021-11-05 op
3 cc9bf8f2 2021-11-05 op NAME
4 cc9bf8f2 2021-11-05 op telescope multi-protocol browser
5 cc9bf8f2 2021-11-05 op
6 cc9bf8f2 2021-11-05 op SYNOPSIS
7 bfd29c14 2021-12-01 op telescope [-ChnSv] [-c config] [URL]
8 cc9bf8f2 2021-11-05 op
9 cc9bf8f2 2021-11-05 op DESCRIPTION
10 cc9bf8f2 2021-11-05 op telescope is an interactive browser that supports the Finger, Gemini and
11 cc9bf8f2 2021-11-05 op Gopher protocols. telescope features tabs, a minibuffer, interactive
12 cc9bf8f2 2021-11-05 op completions, bookmarks and out-of-band TOFU verification.
13 cc9bf8f2 2021-11-05 op
14 cc9bf8f2 2021-11-05 op The arguments are as follows:
15 cc9bf8f2 2021-11-05 op
16 cc9bf8f2 2021-11-05 op -C, --colors Show all available colors and exit.
17 cc9bf8f2 2021-11-05 op
18 cc9bf8f2 2021-11-05 op -c config Specify an alternative configuration file. By default
19 ca5a29bf 2021-12-30 op ~/.config/telescope/config is loaded.
20 cc9bf8f2 2021-11-05 op
21 cc9bf8f2 2021-11-05 op -h, --help Display version and usage.
22 cc9bf8f2 2021-11-05 op
23 cc9bf8f2 2021-11-05 op -n Configtest mode. Only check the configuration file for
24 cc9bf8f2 2021-11-05 op validity.
25 cc9bf8f2 2021-11-05 op
26 bfd29c14 2021-12-01 op -S, --safe Safe (or sandbox) mode. Prevent telescope from
27 bfd29c14 2021-12-01 op writing files to the disk and to acquire the lock,
28 bfd29c14 2021-12-01 op allowing to run multiple instances at the same time.
29 bfd29c14 2021-12-01 op telescope still loads the session file and the custom
30 bfd29c14 2021-12-01 op about pages.
31 bfd29c14 2021-12-01 op
32 cc9bf8f2 2021-11-05 op -v, --version Display version.
33 cc9bf8f2 2021-11-05 op
34 cc9bf8f2 2021-11-05 op UI CONCEPTS
35 cc9bf8f2 2021-11-05 op telescope interface is divided into four areas: the tabline, the body,
36 cc9bf8f2 2021-11-05 op the modeline and the echoarea/minibuffer.
37 cc9bf8f2 2021-11-05 op
38 cc9bf8f2 2021-11-05 op The tabline is always at the top of the screen and displays the tabs
39 cc9bf8f2 2021-11-05 op separated by a vertical line. When there are more tabs than the size of
40 cc9bf8f2 2021-11-05 op the window allow to display, the characters < or > are shown at the
41 cc9bf8f2 2021-11-05 op start/end of the tabline to indicate that there are more tabs in that
42 cc9bf8f2 2021-11-05 op direction.
43 cc9bf8f2 2021-11-05 op
44 cc9bf8f2 2021-11-05 op The body occupies the majority of the visible area. It contains the
45 cc9bf8f2 2021-11-05 op current page and optionally a side window.
46 cc9bf8f2 2021-11-05 op
47 cc9bf8f2 2021-11-05 op The modeline is the second to last row of the screen. It shows some
48 cc9bf8f2 2021-11-05 op information about the page: a spinner when the page is loading, the trust
49 cc9bf8f2 2021-11-05 op level, the document type, the scroll offset and the URL.
50 cc9bf8f2 2021-11-05 op
51 cc9bf8f2 2021-11-05 op The echoarea is usually the last line of the screen. Messages are often
52 cc9bf8f2 2021-11-05 op showed there, and link addresses too. The echoarea is also used to
53 cc9bf8f2 2021-11-05 op obtain input from the user. When commands like swiper or link-select are
54 cc9bf8f2 2021-11-05 op invoked, the minibuffer area grows to show possible completions.
55 cc9bf8f2 2021-11-05 op
56 cc9bf8f2 2021-11-05 op TOFU
57 cc9bf8f2 2021-11-05 op telescope aims to use the Trust, but Verify (where appropriate)
58 cc9bf8f2 2021-11-05 op approach for TOFU (Trust On First Use). The idea is to define three
59 cc9bf8f2 2021-11-05 op level of verification for a certificate:
60 cc9bf8f2 2021-11-05 op
61 cc9bf8f2 2021-11-05 op untrusted (!) the server fingerprint does NOT match the stored
62 cc9bf8f2 2021-11-05 op value.
63 cc9bf8f2 2021-11-05 op
64 cc9bf8f2 2021-11-05 op trusted (v) the server fingerprint matches the store one.
65 cc9bf8f2 2021-11-05 op
66 cc9bf8f2 2021-11-05 op verified (V) the fingerprint matches and has been verified out-of-
67 cc9bf8f2 2021-11-05 op band.
68 cc9bf8f2 2021-11-05 op
69 cc9bf8f2 2021-11-05 op The trust level of the page is indicated in the modeline with the
70 cc9bf8f2 2021-11-05 op indicated character.
71 cc9bf8f2 2021-11-05 op
72 cc9bf8f2 2021-11-05 op Most of the time the trusted level is enough, but where is appropriate
73 cc9bf8f2 2021-11-05 op users should be able to verify out-of-band the certificate.
74 cc9bf8f2 2021-11-05 op
75 cc9bf8f2 2021-11-05 op At the moment, there is no built-in support for an out-of-band
76 cc9bf8f2 2021-11-05 op verification though.
77 cc9bf8f2 2021-11-05 op
78 cc9bf8f2 2021-11-05 op SUPPORTED PROTOCOLS
79 cc9bf8f2 2021-11-05 op The following protocols are supported:
80 cc9bf8f2 2021-11-05 op
81 cc9bf8f2 2021-11-05 op about: About pages are telescope internal page. See about:about for
82 cc9bf8f2 2021-11-05 op a list of all these pages.
83 cc9bf8f2 2021-11-05 op
84 cc9bf8f2 2021-11-05 op file:// File types know to telescope, such as .gmi, .gemini, .txt,
85 cc9bf8f2 2021-11-05 op .md, .markdown, .diff or .patch, can be viewed inside the
86 cc9bf8f2 2021-11-05 op application. Types of local files are detected solely based
87 cc9bf8f2 2021-11-05 op on the file extension. On some systems, such as OpenBSD, only
88 cc9bf8f2 2021-11-05 op files inside special directories (like /tmp or ~/Downloads)
89 cc9bf8f2 2021-11-05 op are available.
90 cc9bf8f2 2021-11-05 op
91 cc9bf8f2 2021-11-05 op finger:// Finger URLs are interpreted as follows:
92 cc9bf8f2 2021-11-05 op the host is determined by the host name portion of the URL
93 cc9bf8f2 2021-11-05 op if the user portion of the URL is provided, it's
94 cc9bf8f2 2021-11-05 op interpreted as the user to finger, otherwise the path
95 cc9bf8f2 2021-11-05 op component will be used
96 cc9bf8f2 2021-11-05 op thus finger://user@hostname and finger://hostname/user are
97 cc9bf8f2 2021-11-05 op treated as the same URL.
98 cc9bf8f2 2021-11-05 op
99 cc9bf8f2 2021-11-05 op gemini:// Gemini is fully supported, with the exception of client-
100 cc9bf8f2 2021-11-05 op certificates.
101 cc9bf8f2 2021-11-05 op
102 cc9bf8f2 2021-11-05 op gopher:// Gopher support is limited to items type 0, 1 and 7. All text
103 cc9bf8f2 2021-11-05 op is assumed to be encoded in UTF-8 (or ASCII).
104 cc9bf8f2 2021-11-05 op
105 cc9bf8f2 2021-11-05 op User-entered URLs, given as argument on the command line or entered with
106 cc9bf8f2 2021-11-05 op load-url, are intepreted with a simple heuristic:
107 cc9bf8f2 2021-11-05 op if it's a proper absolute URL then use it as-is,
108 cc9bf8f2 2021-11-05 op if it starts with ./ or / assume it's a file:// URL,
109 cc9bf8f2 2021-11-05 op otherwise assume it's a Gemini URL.
110 cc9bf8f2 2021-11-05 op
111 bfd29c14 2021-12-01 op CONFIGURATION FILE
112 bfd29c14 2021-12-01 op During the startup, telescope reads the configuration file at
113 bfd29c14 2021-12-01 op ~/.config/telescope/config or ~/.telescope/config.
114 bfd29c14 2021-12-01 op
115 bfd29c14 2021-12-01 op It's possible to load a custom configuration file using the -c flag.
116 bfd29c14 2021-12-01 op
117 bfd29c14 2021-12-01 op telescope will also load a file called config-TERM, where TERM is the
118 bfd29c14 2021-12-01 op name of the terminal type (i.e. the TERM environment variable), if it
119 bfd29c14 2021-12-01 op exists.
120 bfd29c14 2021-12-01 op
121 bfd29c14 2021-12-01 op The format of the configuration file is fairly flexible. The current
122 bfd29c14 2021-12-01 op line can be extended over multiple ones using a backslash (\).
123 bfd29c14 2021-12-01 op Comments can be put anywhere in the file using a hash mark (#), and
124 bfd29c14 2021-12-01 op extend to the end of the current line, but backslashes can't be used to
125 bfd29c14 2021-12-01 op extend comments over multiple lines.
126 bfd29c14 2021-12-01 op
127 bfd29c14 2021-12-01 op The following constructs are available:
128 bfd29c14 2021-12-01 op
129 bfd29c14 2021-12-01 op bind map key cmd
130 bfd29c14 2021-12-01 op Bind key to the function cmd in the keymap map. Valid values for
131 bfd29c14 2021-12-01 op map are global-map (i.e. when the user is viewing a page) and
132 bfd29c14 2021-12-01 op minibuffer-map (i.e. when the minibuffer has the focus.) key
133 bfd29c14 2021-12-01 op follows the same syntax described in DEFAULT KEY BINDINGS and all
134 bfd29c14 2021-12-01 op the possible functions are listed in INTERACTIVE COMMANDS.
135 bfd29c14 2021-12-01 op
136 bfd29c14 2021-12-01 op proxy proto via url
137 bfd29c14 2021-12-01 op Use url as proxy for all URLs with protocol proto. url must be a
138 bfd29c14 2021-12-01 op Gemini URI without path, query and fragment component.
139 bfd29c14 2021-12-01 op
140 bfd29c14 2021-12-01 op set opt = val
141 bfd29c14 2021-12-01 op Set the option opt to the value val. Valid options are:
142 bfd29c14 2021-12-01 op
143 bfd29c14 2021-12-01 op autosave (integer) If greater than zero, save the session
144 bfd29c14 2021-12-01 op after the specified amount of seconds after some
145 bfd29c14 2021-12-01 op events happens (new or closed tabs, visited a link
146 bfd29c14 2021-12-01 op ...) Defaults to 20.
147 bfd29c14 2021-12-01 op dont-wrap-pre (integer) If nonzero, don't wrap preformatted
148 bfd29c14 2021-12-01 op blocks. Defaults to 0.
149 bfd29c14 2021-12-01 op download-path (string) The default download path. Defaults to
150 bfd29c14 2021-12-01 op /tmp.
151 bfd29c14 2021-12-01 op emojify-link (integer) If nonzero, when the text of a link
152 bfd29c14 2021-12-01 op starts with an emoji followed by a space, use that
153 bfd29c14 2021-12-01 op emoji as line prefix. Defaults to 1.
154 bfd29c14 2021-12-01 op enable-colors (integer) If nonzero, enable colours. Defaults to
155 bfd29c14 2021-12-01 op 0 if NO_COLORS is set, 1 otherwise.
156 bfd29c14 2021-12-01 op fill-column (integer) If greater than zero, lines of text will
157 bfd29c14 2021-12-01 op be formatted in a way that don't exceed the given
158 bfd29c14 2021-12-01 op number of columns. Defaults to 80.
159 bfd29c14 2021-12-01 op hide-pre-blocks
160 bfd29c14 2021-12-01 op (integer) If nonzero, hide by default the body of
161 bfd29c14 2021-12-01 op the preformatted blocks. Defaults to zero.
162 bfd29c14 2021-12-01 op push-button can be used to toggle the visibility
163 bfd29c14 2021-12-01 op per-block.
164 bfd29c14 2021-12-01 op hide-pre-closing-line
165 bfd29c14 2021-12-01 op (integer) If nonzero, hide the closing line of
166 bfd29c14 2021-12-01 op preformatted blocks. Defaults to 0.
167 bfd29c14 2021-12-01 op hide-pre-context
168 bfd29c14 2021-12-01 op (integer) If nonzero, hide the start and end line
169 bfd29c14 2021-12-01 op of the preformatted blocks. If both hide-pre-
170 bfd29c14 2021-12-01 op context and hide-pre-blocks are nonzero,
171 bfd29c14 2021-12-01 op preformatted blocks are irremediably hidden.
172 bfd29c14 2021-12-01 op Defaults to zero.
173 bfd29c14 2021-12-01 op new-tab-url (string) URL for the new tab page. Defaults to
174 bfd29c14 2021-12-01 op about:new.
175 bfd29c14 2021-12-01 op olivetti-mode (integer) If nonzero, enable olivetti-mode
176 bfd29c14 2021-12-01 op Defaults to 1.
177 bfd29c14 2021-12-01 op set-title (integer) If nonzero, set the terminal title to
178 bfd29c14 2021-12-01 op the page title. Defaults to 1.
179 bfd29c14 2021-12-01 op tab-bar-show (integer) If tab-bar-show is -1 hide the tab bar
180 bfd29c14 2021-12-01 op permanently, if 0 show it unconditionally. If
181 bfd29c14 2021-12-01 op it's 1, show the bar only when there is more than
182 bfd29c14 2021-12-01 op one tab. Defaults to 1.
183 bfd29c14 2021-12-01 op
184 bfd29c14 2021-12-01 op style name option
185 bfd29c14 2021-12-01 op Change the styling of the element identified by name. Multiple
186 bfd29c14 2021-12-01 op options may be specified within curly braces. Valid style
187 bfd29c14 2021-12-01 op identifiers are:
188 bfd29c14 2021-12-01 op line the area outside the lines in the
189 bfd29c14 2021-12-01 op body of the page.
190 bfd29c14 2021-12-01 op line.compl the completions.
191 bfd29c14 2021-12-01 op line.compl.current the current completion.
192 bfd29c14 2021-12-01 op line.help text in the *Help* buffer.
193 bfd29c14 2021-12-01 op line.download.ongoing an ongoing download
194 bfd29c14 2021-12-01 op line.download.done a completed download
195 bfd29c14 2021-12-01 op line.download.info informational text in the
196 bfd29c14 2021-12-01 op *Downloads* buffer.
197 bfd29c14 2021-12-01 op line.text text lines.
198 bfd29c14 2021-12-01 op line.link link lines.
199 bfd29c14 2021-12-01 op line.title1..3 headings
200 bfd29c14 2021-12-01 op line.item item lines.
201 bfd29c14 2021-12-01 op line.quote quotes.
202 bfd29c14 2021-12-01 op line.pre.start the heading of a preformatted block.
203 bfd29c14 2021-12-01 op line.pre the content of a preformatted block.
204 bfd29c14 2021-12-01 op line.pre.end the closing line of a preformatted
205 bfd29c14 2021-12-01 op block.
206 bfd29c14 2021-12-01 op download the download pane
207 bfd29c14 2021-12-01 op minibuffer the minibuffer.
208 bfd29c14 2021-12-01 op modeline the modeline.
209 bfd29c14 2021-12-01 op tabline the tabline.
210 bfd29c14 2021-12-01 op tabline.tab the non-focused tabs.
211 bfd29c14 2021-12-01 op tabline.current the focused tab.
212 bfd29c14 2021-12-01 op
213 bfd29c14 2021-12-01 op Valid options are:
214 bfd29c14 2021-12-01 op
215 bfd29c14 2021-12-01 op attr prefix [line [trail]]
216 bfd29c14 2021-12-01 op Sets the text attributes. If only one value is given,
217 bfd29c14 2021-12-01 op line and trail default to that; if two values are given
218 bfd29c14 2021-12-01 op then trail defaults to prefix. Each attribute is a
219 bfd29c14 2021-12-01 op comma-separated list of keywords:
220 bfd29c14 2021-12-01 op normal no attributes.
221 bfd29c14 2021-12-01 op standout best highlighting mode for the terminal.
222 bfd29c14 2021-12-01 op underline underlines the text.
223 bfd29c14 2021-12-01 op reverse reverses background/foreground colors.
224 bfd29c14 2021-12-01 op blink makes the text blinking.
225 bfd29c14 2021-12-01 op dim half bright.
226 bfd29c14 2021-12-01 op bold extra bright or bold.
227 bfd29c14 2021-12-01 op
228 bfd29c14 2021-12-01 op Only the style identifiers with the line. prefix accept
229 bfd29c14 2021-12-01 op up to three attributes. The other will only use the
230 bfd29c14 2021-12-01 op first one given.
231 bfd29c14 2021-12-01 op
232 bfd29c14 2021-12-01 op bg prefix [line [trail]]
233 bfd29c14 2021-12-01 op Sets the background color. Follows the same behaviour as
234 bfd29c14 2021-12-01 op attr regarding the optional parameters. The colour is
235 bfd29c14 2021-12-01 op one of black, red, green, yellow, blue, magenta, cyan and
236 bfd29c14 2021-12-01 op white; colour0 to colour255 (or color0 to color255) from
237 bfd29c14 2021-12-01 op the 256-colour set; default for the default colour.
238 bfd29c14 2021-12-01 op
239 bfd29c14 2021-12-01 op fg prefix [line [trail]]
240 bfd29c14 2021-12-01 op Sets the foreground color. It behaves just like bg.
241 bfd29c14 2021-12-01 op
242 bfd29c14 2021-12-01 op prefix prfx [cont]
243 bfd29c14 2021-12-01 op Sets the prefix for the current line type to prfx and
244 bfd29c14 2021-12-01 op cont as the prefix for the continuation lines (i.e. when
245 bfd29c14 2021-12-01 op a long line gets wrapped.) If cont is not given its value
246 bfd29c14 2021-12-01 op will be the same of prfx.
247 bfd29c14 2021-12-01 op
248 cc9bf8f2 2021-11-05 op DEFAULT KEY BINDINGS
249 cc9bf8f2 2021-11-05 op The default key bindings are very similar to GNU Emacs, but care has been
250 cc9bf8f2 2021-11-05 op taken to include also bindings familiar for vi(1) and CUA users. In
251 cc9bf8f2 2021-11-05 op the following examples, C-x means Control-x, M-x means Meta-x, where the
252 cc9bf8f2 2021-11-05 op Meta key may be either a special key on the keyboard or the ALT key;
253 cc9bf8f2 2021-11-05 op otherwise ESC followed by the key X works as well, and C-M-x means to
254 cc9bf8f2 2021-11-05 op press the key X together with both Control and Meta.
255 cc9bf8f2 2021-11-05 op
256 cc9bf8f2 2021-11-05 op Keys are usually a single character, like p or n, but some special
257 cc9bf8f2 2021-11-05 op keys are accepted as well.
258 cc9bf8f2 2021-11-05 op
259 cc9bf8f2 2021-11-05 op <up> Up arrow
260 cc9bf8f2 2021-11-05 op <down> Down arrow
261 cc9bf8f2 2021-11-05 op <left> Left arrow
262 cc9bf8f2 2021-11-05 op <right> Right arrow
263 cc9bf8f2 2021-11-05 op <prior> Previous page/Page up
264 cc9bf8f2 2021-11-05 op <next> Next page/Page down
265 cc9bf8f2 2021-11-05 op <home> Home
266 cc9bf8f2 2021-11-05 op <end> End
267 cc9bf8f2 2021-11-05 op <f0> thru <f63> Function keys
268 cc9bf8f2 2021-11-05 op del or backspace Backspace
269 cc9bf8f2 2021-11-05 op esc Escape
270 cc9bf8f2 2021-11-05 op space or spc Space
271 cc9bf8f2 2021-11-05 op enter or ret Enter
272 cc9bf8f2 2021-11-05 op tab Tab
273 cc9bf8f2 2021-11-05 op backtab Depends on the configuration of the terminal
274 cc9bf8f2 2021-11-05 op emulator; usually shift tab.
275 cc9bf8f2 2021-11-05 op
276 cc9bf8f2 2021-11-05 op GNU Emacs-like keys
277 cc9bf8f2 2021-11-05 op C-p previous-line
278 cc9bf8f2 2021-11-05 op C-n next-line
279 cc9bf8f2 2021-11-05 op C-f forward-char
280 cc9bf8f2 2021-11-05 op C-b backward-char
281 cc9bf8f2 2021-11-05 op M-{ backward-paragraph
282 cc9bf8f2 2021-11-05 op M-} forward-paragraph
283 cc9bf8f2 2021-11-05 op C-a move-beginning-of-line
284 cc9bf8f2 2021-11-05 op C-e move-end-of-line
285 cc9bf8f2 2021-11-05 op M-v, M-space scroll-up
286 cc9bf8f2 2021-11-05 op C-v, space scroll-down
287 cc9bf8f2 2021-11-05 op M-< beginning-of-buffer
288 cc9bf8f2 2021-11-05 op M-> end-of-buffer
289 cc9bf8f2 2021-11-05 op C-x C-c kill-telescope
290 cc9bf8f2 2021-11-05 op C-g clear-minibuf
291 cc9bf8f2 2021-11-05 op M-x execute-extended-command
292 cc9bf8f2 2021-11-05 op C-c { dec-fill-column
293 cc9bf8f2 2021-11-05 op C-c } inc-fill-column
294 cc9bf8f2 2021-11-05 op C-c p previous-heading
295 cc9bf8f2 2021-11-05 op C-c n next-heading
296 cc9bf8f2 2021-11-05 op > load-url
297 cc9bf8f2 2021-11-05 op < load-current-url
298 cc9bf8f2 2021-11-05 op C-x C-f load-url
299 cc9bf8f2 2021-11-05 op C-x M-f load-current-url
300 cc9bf8f2 2021-11-05 op C-x o other-window
301 cc9bf8f2 2021-11-05 op C-x t 0 tab-close
302 cc9bf8f2 2021-11-05 op C-x t 1 tab-close-other
303 cc9bf8f2 2021-11-05 op C-x t 2 tab-new
304 cc9bf8f2 2021-11-05 op C-x t o tab-next
305 cc9bf8f2 2021-11-05 op C-x t O tab-previous
306 cc9bf8f2 2021-11-05 op C-x t m tab-move
307 cc9bf8f2 2021-11-05 op C-x t M tab-move-to
308 cc9bf8f2 2021-11-05 op B, C-M-b previous-page
309 cc9bf8f2 2021-11-05 op F, C-M-f next-page
310 cc9bf8f2 2021-11-05 op <f7> a bookmark-page
311 cc9bf8f2 2021-11-05 op <f7> <f7> list-bookmarks
312 cc9bf8f2 2021-11-05 op C-z suspend-telescope
313 cc9bf8f2 2021-11-05 op
314 cc9bf8f2 2021-11-05 op vi(1)-like keys
315 cc9bf8f2 2021-11-05 op k previous-line
316 cc9bf8f2 2021-11-05 op j next-line
317 cc9bf8f2 2021-11-05 op l forward-char
318 cc9bf8f2 2021-11-05 op h backward-char
319 cc9bf8f2 2021-11-05 op { backward-paragraph
320 cc9bf8f2 2021-11-05 op } forward-paragraph
321 cc9bf8f2 2021-11-05 op ^ move-beginning-of-line
322 cc9bf8f2 2021-11-05 op $ move-end-of-line
323 cc9bf8f2 2021-11-05 op K scroll-line-up
324 cc9bf8f2 2021-11-05 op J scroll-line-down
325 cc9bf8f2 2021-11-05 op g g beginning-of-buffer
326 cc9bf8f2 2021-11-05 op G end-of-buffer
327 cc9bf8f2 2021-11-05 op g D tab-close
328 cc9bf8f2 2021-11-05 op g N tab-new
329 cc9bf8f2 2021-11-05 op g t tab-next
330 cc9bf8f2 2021-11-05 op g T tab-previous
331 cc9bf8f2 2021-11-05 op g M-t tab-move
332 cc9bf8f2 2021-11-05 op g M-T tab-move-to
333 cc9bf8f2 2021-11-05 op H previous-page
334 cc9bf8f2 2021-11-05 op L next-page
335 cc9bf8f2 2021-11-05 op q kill-telescope
336 cc9bf8f2 2021-11-05 op ESC clear-minibuf
337 cc9bf8f2 2021-11-05 op : execute-extended-command
338 cc9bf8f2 2021-11-05 op
339 cc9bf8f2 2021-11-05 op CUA-like keys
340 cc9bf8f2 2021-11-05 op <up> previous-line
341 cc9bf8f2 2021-11-05 op <down> next-line
342 cc9bf8f2 2021-11-05 op <right> forward-char
343 cc9bf8f2 2021-11-05 op <left> backward-char
344 cc9bf8f2 2021-11-05 op <home> move-beginning-of-line
345 cc9bf8f2 2021-11-05 op <end> move-end-of-line
346 cc9bf8f2 2021-11-05 op <prior> scroll-up
347 cc9bf8f2 2021-11-05 op <next> scroll-down
348 cc9bf8f2 2021-11-05 op C-w tab-close
349 cc9bf8f2 2021-11-05 op C-t tab-new
350 cc9bf8f2 2021-11-05 op M-<prior> tab-previous
351 cc9bf8f2 2021-11-05 op M-<next> tab-next
352 cc9bf8f2 2021-11-05 op M-<left> previous-page
353 cc9bf8f2 2021-11-05 op M-<right> next-page
354 cc9bf8f2 2021-11-05 op <f5> reload-page
355 cc9bf8f2 2021-11-05 op r reload-page
356 cc9bf8f2 2021-11-05 op
357 cc9bf8f2 2021-11-05 op Neither Emacs nor vi specific
358 cc9bf8f2 2021-11-05 op <f1> toggle-help
359 cc9bf8f2 2021-11-05 op enter push-button
360 cc9bf8f2 2021-11-05 op M-enter push-button-new-tab
361 cc9bf8f2 2021-11-05 op M-tab previous-button
362 cc9bf8f2 2021-11-05 op backtab previous-button
363 cc9bf8f2 2021-11-05 op tab next-button
364 cc9bf8f2 2021-11-05 op M-t tab-select
365 cc9bf8f2 2021-11-05 op [ tab-previous
366 cc9bf8f2 2021-11-05 op ] tab-next
367 cc9bf8f2 2021-11-05 op M-[ tab-move-to
368 cc9bf8f2 2021-11-05 op M-] tab-move
369 cc9bf8f2 2021-11-05 op M-l link-select
370 cc9bf8f2 2021-11-05 op M-/ swiper
371 cc9bf8f2 2021-11-05 op
372 cc9bf8f2 2021-11-05 op Minibuffer-specific keys
373 cc9bf8f2 2021-11-05 op enter mini-complete-and-exit
374 cc9bf8f2 2021-11-05 op C-g mini-abort
375 cc9bf8f2 2021-11-05 op ESC mini-abort
376 cc9bf8f2 2021-11-05 op C-d mini-delete-char
377 cc9bf8f2 2021-11-05 op del mini-delete-backward-char
378 cc9bf8f2 2021-11-05 op backspace mini-delete-backward-char
379 cc9bf8f2 2021-11-05 op C-h mini-delete-backward-char
380 cc9bf8f2 2021-11-05 op C-b backward-char
381 cc9bf8f2 2021-11-05 op C-f forward-char
382 cc9bf8f2 2021-11-05 op <left> backward-char
383 cc9bf8f2 2021-11-05 op <right> forward-char
384 cc9bf8f2 2021-11-05 op C-e move-end-of-line
385 cc9bf8f2 2021-11-05 op C-a move-beginning-of-line
386 cc9bf8f2 2021-11-05 op <end> move-end-of-line
387 cc9bf8f2 2021-11-05 op <home> move-beginning-of-line
388 cc9bf8f2 2021-11-05 op C-k mini-kill-line
389 cc9bf8f2 2021-11-05 op M-p mini-previous-history-element
390 cc9bf8f2 2021-11-05 op M-n mini-next-history-element
391 cc9bf8f2 2021-11-05 op C-p previous-completion
392 cc9bf8f2 2021-11-05 op C-n next-completion
393 cc9bf8f2 2021-11-05 op <up> previous-completion
394 cc9bf8f2 2021-11-05 op <down> next-completion
395 cc9bf8f2 2021-11-05 op tab insert-current-candidate
396 cc9bf8f2 2021-11-05 op M-< mini-goto-beginning
397 cc9bf8f2 2021-11-05 op M-> mini-goto-end
398 cc9bf8f2 2021-11-05 op
399 cc9bf8f2 2021-11-05 op INTERACTIVE COMMANDS
400 cc9bf8f2 2021-11-05 op Follows the documentation for the interactive commands. These commands
401 cc9bf8f2 2021-11-05 op can be bound to a key or executed with execute-extended-command.
402 cc9bf8f2 2021-11-05 op
403 cc9bf8f2 2021-11-05 op Movement commands
404 cc9bf8f2 2021-11-05 op backward-char Move point one character backward.
405 cc9bf8f2 2021-11-05 op backward-paragraph Move point one paragraph backward.
406 cc9bf8f2 2021-11-05 op beginning-of-buffer Move point to the beginning of the buffer.
407 cc9bf8f2 2021-11-05 op end-of-buffer Move point to the end of the buffer.
408 cc9bf8f2 2021-11-05 op forward-char Move point one character forward.
409 cc9bf8f2 2021-11-05 op forward-paragraph Move point one paragraph forward.
410 cc9bf8f2 2021-11-05 op insert-current-candidate Copy the current selection text as minibuffer
411 cc9bf8f2 2021-11-05 op input.
412 cc9bf8f2 2021-11-05 op move-beginning-of-line Move point at the beginning of the current
413 cc9bf8f2 2021-11-05 op (visual) line.
414 cc9bf8f2 2021-11-05 op move-end-of-line Move point at the end of the current (visual)
415 cc9bf8f2 2021-11-05 op line.
416 cc9bf8f2 2021-11-05 op next-button Move point to the next link.
417 cc9bf8f2 2021-11-05 op next-completion Select the next completion.
418 cc9bf8f2 2021-11-05 op next-heading Move point to the next heading.
419 cc9bf8f2 2021-11-05 op next-line Move point to the next (visual) line, in the
420 cc9bf8f2 2021-11-05 op same column if possible.
421 cc9bf8f2 2021-11-05 op previous-button Move point to the previous link.
422 cc9bf8f2 2021-11-05 op previous-completion Select the previous completion.
423 cc9bf8f2 2021-11-05 op previous-heading Move point to the previous heading.
424 cc9bf8f2 2021-11-05 op previous-line Move point to the previous (visual) line.
425 cc9bf8f2 2021-11-05 op
426 cc9bf8f2 2021-11-05 op Bookmark-related commands
427 cc9bf8f2 2021-11-05 op bookmark-page Save a page in the bookmark file. It preloads
428 cc9bf8f2 2021-11-05 op the minibuffer with the current URL.
429 cc9bf8f2 2021-11-05 op list-bookmarks Load the bookmarks page.
430 cc9bf8f2 2021-11-05 op
431 cc9bf8f2 2021-11-05 op Tab-related commands
432 cc9bf8f2 2021-11-05 op tab-close Close the current tab.
433 cc9bf8f2 2021-11-05 op tab-close-other Close all tabs but the current one.
434 cc9bf8f2 2021-11-05 op tab-move Move the current tab after the next one,
435 cc9bf8f2 2021-11-05 op wrapping around if needed.
436 cc9bf8f2 2021-11-05 op tab-move-to Move the current tab before the previous one,
437 cc9bf8f2 2021-11-05 op wrapping around if needed.
438 cc9bf8f2 2021-11-05 op tab-new Open a new tab.
439 cc9bf8f2 2021-11-05 op tab-next Focus next tab, wrapping around eventually.
440 cc9bf8f2 2021-11-05 op tab-previous Focus the previous tab, wrapping around
441 cc9bf8f2 2021-11-05 op eventually.
442 cc9bf8f2 2021-11-05 op tab-select Switch to a tab using the minibuffer.
443 cc9bf8f2 2021-11-05 op
444 cc9bf8f2 2021-11-05 op Misc commands
445 cc9bf8f2 2021-11-05 op clear-minibuf Clear the echo area.
446 cc9bf8f2 2021-11-05 op dec-fill-column Decrement fill-column by two.
447 cc9bf8f2 2021-11-05 op execute-extended-command Execute an internal command.
448 cc9bf8f2 2021-11-05 op kill-telescope Quit telescope.
449 cc9bf8f2 2021-11-05 op inc-fill-column Increment fill-column by two.
450 cc9bf8f2 2021-11-05 op link-select Select and visit a link using the minibuffer.
451 cc9bf8f2 2021-11-05 op load-current-url Edit the current URL.
452 cc9bf8f2 2021-11-05 op load-url Prompt for an URL.
453 cc9bf8f2 2021-11-05 op next-page Go forward in the page history.
454 cc9bf8f2 2021-11-05 op olivetti-mode Toggle olivetti mode (i.e. horizontal centering
455 cc9bf8f2 2021-11-05 op of the lines of the window.)
456 cc9bf8f2 2021-11-05 op other-window Select the other window.
457 cc9bf8f2 2021-11-05 op previous-page Go backward in the page history.
458 cc9bf8f2 2021-11-05 op push-button Follow link at point, or toggle the visibility
459 cc9bf8f2 2021-11-05 op of the following preformatted block if called
460 cc9bf8f2 2021-11-05 op when the cursor is on the heading of the block.
461 cc9bf8f2 2021-11-05 op push-button-new-tab Follow link at point in a new tab.
462 cc9bf8f2 2021-11-05 op redraw Redraw the screen, useful if some background
463 cc9bf8f2 2021-11-05 op program messed up the display.
464 cc9bf8f2 2021-11-05 op reload-page Reload the current page.
465 cc9bf8f2 2021-11-05 op scroll-down Scroll down by one visual page.
466 cc9bf8f2 2021-11-05 op scroll-line-down Scroll down by one line.
467 cc9bf8f2 2021-11-05 op scroll-line-up Scroll up by one line.
468 cc9bf8f2 2021-11-05 op scroll-up Scroll up by one visual page.
469 cc9bf8f2 2021-11-05 op suspend-telescope Suspend the current telescope session.
470 cc9bf8f2 2021-11-05 op swiper Jump to a line using the minibuffer.
471 cc9bf8f2 2021-11-05 op toc Jump to a heading using the minibuffer.
472 cc9bf8f2 2021-11-05 op toggle-help Toggle side window with help about available
473 cc9bf8f2 2021-11-05 op keys and their associated interactive command.
474 cc9bf8f2 2021-11-05 op toggle-pre-wrap Toggle the wrapping of preformatted blocks.
475 cc9bf8f2 2021-11-05 op
476 cc9bf8f2 2021-11-05 op Minibuffer commands
477 cc9bf8f2 2021-11-05 op mini-abort Abort the current minibuffer action.
478 cc9bf8f2 2021-11-05 op mini-complete-and-exit Complete the current minibuffer action.
479 cc9bf8f2 2021-11-05 op mini-delete-backward-char
480 cc9bf8f2 2021-11-05 op Delete the character before the point.
481 cc9bf8f2 2021-11-05 op mini-delete-char Delete the character after the point.
482 cc9bf8f2 2021-11-05 op mini-goto-beginning Select the first completion, if any.
483 cc9bf8f2 2021-11-05 op mini-goto-end Select the last completion, if any.
484 cc9bf8f2 2021-11-05 op mini-kill-line Delete from point until the end of the line.
485 cc9bf8f2 2021-11-05 op mini-next-history-element
486 cc9bf8f2 2021-11-05 op Load the previous history element.
487 cc9bf8f2 2021-11-05 op mini-previous-history-element
488 cc9bf8f2 2021-11-05 op Load the next history element.
489 cc9bf8f2 2021-11-05 op
490 cc9bf8f2 2021-11-05 op Aliases
491 cc9bf8f2 2021-11-05 op The following aliases are available during execute-extended-command:
492 cc9bf8f2 2021-11-05 op tabn tab-next
493 cc9bf8f2 2021-11-05 op tabnew tab-new
494 cc9bf8f2 2021-11-05 op tabp tab-previous
495 cc9bf8f2 2021-11-05 op q and wq kill-telescope
496 cc9bf8f2 2021-11-05 op
497 cc9bf8f2 2021-11-05 op ENVIRONMENT
498 cc9bf8f2 2021-11-05 op When telescope is started, it inspects the following environment
499 cc9bf8f2 2021-11-05 op variables:
500 cc9bf8f2 2021-11-05 op
501 cc9bf8f2 2021-11-05 op HOME The user's login directory.
502 cc9bf8f2 2021-11-05 op
503 cc9bf8f2 2021-11-05 op NO_COLORS To decide whether to use colors or not. The content of the
504 cc9bf8f2 2021-11-05 op variable doesn't matter.
505 cc9bf8f2 2021-11-05 op
506 cc9bf8f2 2021-11-05 op TERM The user's terminal name.
507 cc9bf8f2 2021-11-05 op
508 bfd29c14 2021-12-01 op XDG_CACHE_HOME, XDG_CONFIG_HOME, XDG_DATA_HOME
509 bfd29c14 2021-12-01 op If defined can alter the default location of the files used.
510 bfd29c14 2021-12-01 op
511 cc9bf8f2 2021-11-05 op FILES
512 bfd29c14 2021-12-01 op By default telescope follows the XDG Base Directory Specification.
513 bfd29c14 2021-12-01 op However, if ~/.telescope exists, XDG is ignored and all the files are
514 bfd29c14 2021-12-01 op stored inside it. The usage of XDG_CACHE_HOME, XDG_CONFIG_HOME and
515 bfd29c14 2021-12-01 op XDG_DATA_HOME can further alter the location of these files.
516 bfd29c14 2021-12-01 op
517 bfd29c14 2021-12-01 op ~/.config/telescope/config
518 cc9bf8f2 2021-11-05 op Default configuration file.
519 bfd29c14 2021-12-01 op ~/.local/share/telescope/pages/about_*.gmi
520 bfd29c14 2021-12-01 op Overrides for built-in about: pages.
521 bfd29c14 2021-12-01 op ~/.local/share/telescope/bookmarks.gmi
522 bfd29c14 2021-12-01 op Bookmarks file.
523 bfd29c14 2021-12-01 op ~/.local/share/telescope/known_hosts
524 cc9bf8f2 2021-11-05 op Hash of the certificates for all the known hosts. Each line
525 cc9bf8f2 2021-11-05 op contains three fields: hostname with optional port number, hash
526 cc9bf8f2 2021-11-05 op of the certificate and a numeric flag.
527 bfd29c14 2021-12-01 op ~/.cache/telescope/lock
528 cc9bf8f2 2021-11-05 op Lock file used to prevent multiple instance of telescope from
529 cc9bf8f2 2021-11-05 op running at the same time.
530 bfd29c14 2021-12-01 op ~/.cache/telescope/session
531 cc9bf8f2 2021-11-05 op The list of tabs from the last session. Every line identifies a
532 cc9bf8f2 2021-11-05 op tab and contains three space-separated fields: the full URL, a
533 cc9bf8f2 2021-11-05 op comma-separated list of attributes and the cached title. Is
534 cc9bf8f2 2021-11-05 op written by kill-telescope and loaded during startup.
535 cc9bf8f2 2021-11-05 op
536 cc9bf8f2 2021-11-05 op EXAMPLES
537 cc9bf8f2 2021-11-05 op It's possible to browse the small web (i.e. simple websites) by using
538 cc9bf8f2 2021-11-05 op programs like the duckling-proxy by defining a proxy in
539 bfd29c14 2021-12-01 op ~/.config/telescope/config:
540 cc9bf8f2 2021-11-05 op
541 cc9bf8f2 2021-11-05 op proxy http via "gemini://127.0.0.1:1965"
542 cc9bf8f2 2021-11-05 op proxy https via "gemini://127.0.0.1:1965"
543 cc9bf8f2 2021-11-05 op
544 cc9bf8f2 2021-11-05 op To load telescope without any configuration
545 cc9bf8f2 2021-11-05 op
546 cc9bf8f2 2021-11-05 op telescope -c /dev/null
547 cc9bf8f2 2021-11-05 op
548 bfd29c14 2021-12-01 op STANDARDS
549 bfd29c14 2021-12-01 op XDG Base Directory Specification,
550 bfd29c14 2021-12-01 op https://specifications.freedesktop.org/basedir-spec/latest/.
551 bfd29c14 2021-12-01 op
552 cc9bf8f2 2021-11-05 op AUTHORS
553 cc9bf8f2 2021-11-05 op The telescope program was written by Omar Polo <op@omarpolo.com>.
554 cc9bf8f2 2021-11-05 op
555 bfd29c14 2021-12-01 op CAVEATS
556 bfd29c14 2021-12-01 op telescope assumes a UTF-8 environment and doesn't do anything to cope
557 bfd29c14 2021-12-01 op with other encodings. This can cause weird rendering issues if you're
558 bfd29c14 2021-12-01 op lucky, or possibly worst things depending on your locale and terminal
559 bfd29c14 2021-12-01 op emulator.
560 bfd29c14 2021-12-01 op
561 cc9bf8f2 2021-11-05 op BUGS
562 cc9bf8f2 2021-11-05 op There's no UI for out-of-band certificates validation.
563 cc9bf8f2 2021-11-05 op
564 ca5a29bf 2021-12-30 op OpenBSD 7.0 November 29, 2021 OpenBSD 7.0