| … | |
… | |
| 28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
| 29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
| 30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
| 31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
| 32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
| 33 | </ul> |
35 | </ul> |
| 34 | |
36 | |
| 35 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
| 36 | <ul> |
38 | <ul> |
| 37 | |
39 | |
| … | |
… | |
| 80 | <p>This section describes the extensions delivered with this release. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
| 81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 82 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
| 83 | <pre> |
85 | <pre> |
| 84 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
| 85 | <dl> |
90 | <dl> |
| 86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
| 87 | </dt> |
92 | </dt> |
| 88 | <dd> |
93 | <dd> |
| 89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | (More) intelligent selection. This extension tries to be more intelligent |
| … | |
… | |
| 116 | <dd> |
121 | <dd> |
| 117 | <pre> |
122 | <pre> |
| 118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
| 119 | </dd> |
124 | </dd> |
| 120 | <dd> |
125 | <dd> |
|
|
126 | <p>Another example: Programs I use often output ``absolute path: '' at the |
|
|
127 | beginning of a line when they process multiple files. The following |
|
|
128 | pattern matches the filename (note, there is a single space at the very |
|
|
129 | end):</p> |
|
|
130 | </dd> |
|
|
131 | <dd> |
|
|
132 | <pre> |
|
|
133 | URxvt.selection.pattern-0: ^(/[^:]+):\</pre> |
|
|
134 | </dd> |
|
|
135 | <dd> |
| 121 | <p>You can look at the source of the selection extension to see more |
136 | <p>You can look at the source of the selection extension to see more |
| 122 | interesting uses, such as parsing a line from beginning to end.</p> |
137 | interesting uses, such as parsing a line from beginning to end.</p> |
| 123 | </dd> |
138 | </dd> |
| 124 | <dd> |
139 | <dd> |
| 125 | <p>This extension also offers the following bindable keyboard command:</p> |
140 | <p>This extension also offers following bindable keyboard commands:</p> |
| 126 | </dd> |
141 | </dd> |
| 127 | <dl> |
142 | <dl> |
| 128 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
143 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
| 129 | </dt> |
144 | </dt> |
| 130 | <dd> |
145 | <dd> |
| … | |
… | |
| 145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 146 | </dt> |
161 | </dt> |
| 147 | <dd> |
162 | <dd> |
| 148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
163 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
| 149 | text into various other formats/action (such as uri unescaping, perl |
164 | text into various other formats/action (such as uri unescaping, perl |
| 150 | evalution, web-browser starting etc.), depending on content. |
165 | evaluation, web-browser starting etc.), depending on content. |
|
|
166 | </dd> |
|
|
167 | <dd> |
|
|
168 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
169 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
170 | popup is displayed.</p> |
|
|
171 | </dd> |
|
|
172 | <dd> |
|
|
173 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
174 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
175 | It should either return nothing or a string and a code reference. The |
|
|
176 | string will be used as button text and the code reference will be called |
|
|
177 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
178 | </dd> |
|
|
179 | <dd> |
|
|
180 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
181 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
182 | <code>a</code>s:</p> |
|
|
183 | </dd> |
|
|
184 | <dd> |
|
|
185 | <pre> |
|
|
186 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
187 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
188 | : () |
|
|
189 | };</pre> |
| 151 | </dd> |
190 | </dd> |
| 152 | <p></p> |
191 | <p></p> |
| 153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
192 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
| 154 | </dt> |
193 | </dt> |
| 155 | <dd> |
194 | <dd> |
| … | |
… | |
| 166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
205 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
| 167 | additionally stores the first match in the current line into the primary |
206 | additionally stores the first match in the current line into the primary |
| 168 | selection.</p> |
207 | selection.</p> |
| 169 | </dd> |
208 | </dd> |
| 170 | <p></p> |
209 | <p></p> |
|
|
210 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
211 | </dt> |
|
|
212 | <dd> |
|
|
213 | A support package that tries to make editing with readline easier. At the |
|
|
214 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
215 | move the text cursor to this position. It does so by generating as many |
|
|
216 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
217 | for programs that correctly support wide characters). |
|
|
218 | </dd> |
|
|
219 | <dd> |
|
|
220 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
221 | </dd> |
|
|
222 | <dl> |
|
|
223 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> |
|
|
224 | </dt> |
|
|
225 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
226 | </dt> |
|
|
227 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
228 | </dt> |
|
|
229 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
230 | </dt> |
|
|
231 | </dl> |
|
|
232 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
233 | might interfere with selection creation in harmless ways.</p> |
| 171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
234 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
| 172 | </dt> |
235 | </dt> |
| 173 | <dd> |
236 | <dd> |
| 174 | This selection allows you to do automatic transforms on a selection |
237 | This selection allows you to do automatic transforms on a selection |
| 175 | whenever a selection is made. |
238 | whenever a selection is made. |
| … | |
… | |
| 189 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
252 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
| 190 | $word</code>:</p> |
253 | $word</code>:</p> |
| 191 | </dd> |
254 | </dd> |
| 192 | <dd> |
255 | <dd> |
| 193 | <pre> |
256 | <pre> |
| 194 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
257 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
| 195 | </dd> |
258 | </dd> |
| 196 | <dd> |
259 | <dd> |
| 197 | <p>And this example matches the same,but replaces it with vi-commands you can |
260 | <p>And this example matches the same,but replaces it with vi-commands you can |
| 198 | paste directly into your (vi :) editor:</p> |
261 | paste directly into your (vi :) editor:</p> |
| 199 | </dd> |
262 | </dd> |
| 200 | <dd> |
263 | <dd> |
| 201 | <pre> |
264 | <pre> |
| 202 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
265 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
| 203 | </dd> |
266 | </dd> |
| 204 | <dd> |
267 | <dd> |
| 205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
268 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
269 | </dd> |
|
|
270 | <dd> |
|
|
271 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
272 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
273 | </dd> |
|
|
274 | <dd> |
|
|
275 | <pre> |
|
|
276 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
277 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
278 | </dd> |
|
|
279 | <dd> |
|
|
280 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
281 | every error message as a selection pattern, and the second line transforms |
|
|
282 | the message into vi commands to load the file.</p> |
|
|
283 | </dd> |
|
|
284 | <p></p> |
|
|
285 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
286 | </dt> |
|
|
287 | <dd> |
|
|
288 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
289 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
290 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
291 | button per tab. |
|
|
292 | </dd> |
|
|
293 | <dd> |
|
|
294 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
295 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
296 | while <strong>Shift-Down</strong> creates a new tab.</p> |
| 206 | </dd> |
297 | </dd> |
| 207 | <p></p> |
298 | <p></p> |
| 208 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
299 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 209 | </dt> |
300 | </dt> |
| 210 | <dd> |
301 | <dd> |
| … | |
… | |
| 212 | make them clickable. When middle-clicked, the program specified in the |
303 | make them clickable. When middle-clicked, the program specified in the |
| 213 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
304 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
| 214 | the URL as first argument. |
305 | the URL as first argument. |
| 215 | </dd> |
306 | </dd> |
| 216 | <p></p> |
307 | <p></p> |
|
|
308 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
309 | </dt> |
|
|
310 | <dd> |
|
|
311 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
312 | not work perfectly, and some input methods don't seem to work well with |
|
|
313 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
314 | kinput2. |
|
|
315 | </dd> |
|
|
316 | <dd> |
|
|
317 | <p>You enable it by specifying this extension and a preedit style of |
|
|
318 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
319 | </dd> |
|
|
320 | <dd> |
|
|
321 | <pre> |
|
|
322 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
323 | </dd> |
|
|
324 | <p></p> |
|
|
325 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
326 | </dt> |
|
|
327 | <dd> |
|
|
328 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
329 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
330 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <pre> |
|
|
334 | rxvt -pixmap background.xpm -pe automove-background</pre> |
|
|
335 | </dd> |
|
|
336 | <p></p> |
| 217 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
337 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 218 | </dt> |
338 | </dt> |
| 219 | <dd> |
339 | <dd> |
| 220 | A not very useful example of filtering all text output to the terminal, |
340 | A not very useful example of filtering all text output to the terminal, |
| 221 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
341 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| … | |
… | |
| 224 | <p></p> |
344 | <p></p> |
| 225 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
345 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
| 226 | </dt> |
346 | </dt> |
| 227 | <dd> |
347 | <dd> |
| 228 | Displays a digital clock using the built-in overlay. |
348 | Displays a digital clock using the built-in overlay. |
|
|
349 | </dd> |
|
|
350 | <p></p> |
|
|
351 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
|
|
352 | </dt> |
|
|
353 | <dd> |
|
|
354 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
355 | selection popup that allows one ti run external commands to store the |
|
|
356 | selection somewhere and fetch it again. |
|
|
357 | </dd> |
|
|
358 | <dd> |
|
|
359 | <p>We use it to implement a ``distributed selection mechanism'', which just |
|
|
360 | means that one command uploads the file to a remote server, and another |
|
|
361 | reads it.</p> |
|
|
362 | </dd> |
|
|
363 | <dd> |
|
|
364 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
365 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
366 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
367 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
368 | </dd> |
|
|
369 | <dd> |
|
|
370 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
371 | </dd> |
|
|
372 | <dd> |
|
|
373 | <pre> |
|
|
374 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
375 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
|
|
376 | </dd> |
|
|
377 | <p></p> |
|
|
378 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
379 | </dt> |
|
|
380 | <dd> |
|
|
381 | This is a little rarely useful extension that Uploads the selection as |
|
|
382 | textfile to a remote site (or does other things). (The implementation is |
|
|
383 | not currently secure for use in a multiuser environment as it writes to |
|
|
384 | <em>/tmp</em> directly.). |
|
|
385 | </dd> |
|
|
386 | <dd> |
|
|
387 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
388 | i.e.</p> |
|
|
389 | </dd> |
|
|
390 | <dd> |
|
|
391 | <pre> |
|
|
392 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
393 | </dd> |
|
|
394 | <dd> |
|
|
395 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
396 | the textfile. This command can be set via a resource:</p> |
|
|
397 | </dd> |
|
|
398 | <dd> |
|
|
399 | <pre> |
|
|
400 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
401 | </dd> |
|
|
402 | <dd> |
|
|
403 | <p>And the default is likely not useful to anybody but the few people around |
|
|
404 | here :)</p> |
|
|
405 | </dd> |
|
|
406 | <dd> |
|
|
407 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
408 | the same content should lead to the same filename.</p> |
|
|
409 | </dd> |
|
|
410 | <dd> |
|
|
411 | <p>After a successful upload the selection will be replaced by the text given |
|
|
412 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
413 | for the filename):</p> |
|
|
414 | </dd> |
|
|
415 | <dd> |
|
|
416 | <pre> |
|
|
417 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
| 229 | </dd> |
418 | </dd> |
| 230 | <p></p> |
419 | <p></p> |
| 231 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
420 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
| 232 | </dt> |
421 | </dt> |
| 233 | <dd> |
422 | <dd> |
| … | |
… | |
| 316 | <h2><a name="hooks">Hooks</a></h2> |
505 | <h2><a name="hooks">Hooks</a></h2> |
| 317 | <p>The following subroutines can be declared in extension files, and will be |
506 | <p>The following subroutines can be declared in extension files, and will be |
| 318 | called whenever the relevant event happens.</p> |
507 | called whenever the relevant event happens.</p> |
| 319 | <p>The first argument passed to them is an extension oject as described in |
508 | <p>The first argument passed to them is an extension oject as described in |
| 320 | the in the <code>Extension Objects</code> section.</p> |
509 | the in the <code>Extension Objects</code> section.</p> |
| 321 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
510 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 322 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
511 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 323 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
512 | relevant action might not be carried out by the C++ code.</p> |
| 324 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
513 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 325 | <dl> |
514 | <dl> |
| 326 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
515 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 327 | </dt> |
516 | </dt> |
| 328 | <dd> |
517 | <dd> |
| 329 | Called after a new terminal object has been initialized, but before |
518 | Called after a new terminal object has been initialized, but before |
| 330 | windows are created or the command gets run. Most methods are unsafe to |
519 | windows are created or the command gets run. Most methods are unsafe to |
| 331 | call or deliver senseless data, as terminal size and other characteristics |
520 | call or deliver senseless data, as terminal size and other characteristics |
| 332 | have not yet been determined. You can safely query and change resources, |
521 | have not yet been determined. You can safely query and change resources |
| 333 | though. |
522 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
523 | place. |
|
|
524 | </dd> |
|
|
525 | <p></p> |
|
|
526 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
527 | </dt> |
|
|
528 | <dd> |
|
|
529 | Called at the very end of initialisation of a new terminal, just before |
|
|
530 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
531 | </dd> |
|
|
532 | <p></p> |
|
|
533 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
534 | </dt> |
|
|
535 | <dd> |
|
|
536 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
537 | still fully functional (not for long, though). |
| 334 | </dd> |
538 | </dd> |
| 335 | <p></p> |
539 | <p></p> |
| 336 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
540 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 337 | </dt> |
541 | </dt> |
| 338 | <dd> |
542 | <dd> |
| 339 | Called after the screen is ``reset'' for any reason, such as resizing or |
543 | Called after the screen is ``reset'' for any reason, such as resizing or |
| 340 | control sequences. Here is where you can react on changes to size-related |
544 | control sequences. Here is where you can react on changes to size-related |
| 341 | variables. |
545 | variables. |
| 342 | </dd> |
546 | </dd> |
| 343 | <p></p> |
547 | <p></p> |
| 344 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
548 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 345 | </dt> |
549 | </dt> |
|
|
550 | <dd> |
|
|
551 | Called just after the child process has been <code>fork</code>ed. |
| 346 | <dd> |
552 | </dd> |
| 347 | Called at the very end of initialisation of a new terminal, just before |
553 | <p></p> |
| 348 | returning to the mainloop. |
554 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
555 | </dt> |
|
|
556 | <dd> |
|
|
557 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
558 | from <code>waitpid</code>. |
| 349 | </dd> |
559 | </dd> |
| 350 | <p></p> |
560 | <p></p> |
| 351 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
561 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 352 | </dt> |
562 | </dt> |
| 353 | <dd> |
563 | <dd> |
| … | |
… | |
| 470 | </dt> |
680 | </dt> |
| 471 | <dd> |
681 | <dd> |
| 472 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
682 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 473 | </dd> |
683 | </dd> |
| 474 | <p></p> |
684 | <p></p> |
| 475 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
685 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
| 476 | </dt> |
686 | </dt> |
| 477 | <dd> |
687 | <dd> |
| 478 | Called whenever the user presses a key combination that has a |
688 | Called whenever the a user-configured event is being activated (e.g. via |
| 479 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
689 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
| 480 | resource in the <code>rxvt(1)</code> manpage). |
690 | resource in the <code>rxvt(1)</code> manpage). |
|
|
691 | </dd> |
|
|
692 | <dd> |
|
|
693 | <p>The event is simply the action string. This interface is assumed to change |
|
|
694 | slightly in the future.</p> |
|
|
695 | </dd> |
|
|
696 | <p></p> |
|
|
697 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
698 | </dt> |
|
|
699 | <dd> |
|
|
700 | Called on every X event received on the vt window (and possibly other |
|
|
701 | windows). Should only be used as a last resort. Most event structure |
|
|
702 | members are not passed. |
| 481 | </dd> |
703 | </dd> |
| 482 | <p></p> |
704 | <p></p> |
| 483 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
705 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
| 484 | </dt> |
706 | </dt> |
| 485 | <dd> |
707 | <dd> |
| … | |
… | |
| 492 | <dd> |
714 | <dd> |
| 493 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
715 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 494 | focus out processing. |
716 | focus out processing. |
| 495 | </dd> |
717 | </dd> |
| 496 | <p></p> |
718 | <p></p> |
|
|
719 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
720 | </dt> |
|
|
721 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
722 | </dt> |
| 497 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
723 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
| 498 | </dt> |
724 | </dt> |
| 499 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
725 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 500 | </dt> |
726 | </dt> |
| 501 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
727 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| … | |
… | |
| 512 | Called whenever the corresponding X event is received for the terminal If |
738 | Called whenever the corresponding X event is received for the terminal If |
| 513 | the hook returns true, then the even will be ignored by rxvt-unicode. |
739 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 514 | </dd> |
740 | </dd> |
| 515 | <dd> |
741 | <dd> |
| 516 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
742 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 517 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
743 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 518 | and column under the mouse cursor.</p> |
744 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 519 | </dd> |
745 | </dd> |
| 520 | <dd> |
746 | <dd> |
| 521 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
747 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 522 | output, if any, in locale-specific encoding.</p> |
748 | output, if any, in locale-specific encoding.</p> |
| 523 | </dd> |
749 | </dd> |
| 524 | <dd> |
750 | <dd> |
| 525 | <p>subwindow.</p> |
751 | <p>subwindow.</p> |
|
|
752 | </dd> |
|
|
753 | <p></p> |
|
|
754 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
755 | </dt> |
|
|
756 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
757 | </dt> |
|
|
758 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
759 | </dt> |
|
|
760 | <dd> |
|
|
761 | Called when various types of ClientMessage events are received (all with |
|
|
762 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 526 | </dd> |
763 | </dd> |
| 527 | <p></p></dl> |
764 | <p></p></dl> |
| 528 | <p> |
765 | <p> |
| 529 | </p> |
766 | </p> |
| 530 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
767 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 552 | </dt> |
789 | </dt> |
| 553 | <dd> |
790 | <dd> |
| 554 | The current terminal. This variable stores the current <code>urxvt::term</code> |
791 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 555 | object, whenever a callback/hook is executing. |
792 | object, whenever a callback/hook is executing. |
| 556 | </dd> |
793 | </dd> |
|
|
794 | <p></p> |
|
|
795 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
796 | </dt> |
|
|
797 | <dd> |
|
|
798 | All coderefs in this array will be called as methods of the next newly |
|
|
799 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
800 | gets cleared before the codereferences that were in it are being executed, |
|
|
801 | so coderefs can push themselves onto it again if they so desire. |
|
|
802 | </dd> |
|
|
803 | <dd> |
|
|
804 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
805 | first.</p> |
|
|
806 | </dd> |
|
|
807 | <p></p> |
|
|
808 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
809 | </dt> |
|
|
810 | <dd> |
|
|
811 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
812 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
813 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
814 | </dd> |
| 557 | <p></p></dl> |
815 | <p></p></dl> |
| 558 | <p> |
816 | <p> |
| 559 | </p> |
817 | </p> |
| 560 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
818 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 561 | <dl> |
819 | <dl> |
| … | |
… | |
| 580 | </dd> |
838 | </dd> |
| 581 | <dd> |
839 | <dd> |
| 582 | <p>Messages have a size limit of 1023 bytes currently.</p> |
840 | <p>Messages have a size limit of 1023 bytes currently.</p> |
| 583 | </dd> |
841 | </dd> |
| 584 | <p></p> |
842 | <p></p> |
| 585 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
| 586 | </dt> |
|
|
| 587 | <dd> |
|
|
| 588 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
| 589 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
| 590 | started setuid or setgid. |
|
|
| 591 | </dd> |
|
|
| 592 | <p></p> |
|
|
| 593 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
843 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 594 | </dt> |
844 | </dt> |
| 595 | <dd> |
845 | <dd> |
| 596 | Returns the ``current time'' (as per the event loop). |
846 | Returns the ``current time'' (as per the event loop). |
| 597 | </dd> |
847 | </dd> |
| … | |
… | |
| 599 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
849 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
| 600 | </dt> |
850 | </dt> |
| 601 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
851 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
| 602 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
852 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
| 603 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
853 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
854 | </dt> |
|
|
855 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
856 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
857 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
858 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
859 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
860 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
861 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
862 | </dt> |
|
|
863 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
864 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
865 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
866 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
867 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
868 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
869 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
| 604 | </dt> |
870 | </dt> |
| 605 | <dd> |
871 | <dd> |
| 606 | Various constants for use in X calls and event processing. |
872 | Various constants for use in X calls and event processing. |
| 607 | </dd> |
873 | </dd> |
| 608 | <p></p></dl> |
874 | <p></p></dl> |
| … | |
… | |
| 701 | Destroy the terminal object (close the window, free resources |
967 | Destroy the terminal object (close the window, free resources |
| 702 | etc.). Please note that rxvt will not exit as long as any event |
968 | etc.). Please note that rxvt will not exit as long as any event |
| 703 | watchers (timers, io watchers) are still active. |
969 | watchers (timers, io watchers) are still active. |
| 704 | </dd> |
970 | </dd> |
| 705 | <p></p> |
971 | <p></p> |
|
|
972 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
973 | </dt> |
|
|
974 | <dd> |
|
|
975 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
976 | (``starts'') programs in the background. This function takes care of setting |
|
|
977 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
978 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
979 | </dd> |
|
|
980 | <dd> |
|
|
981 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
982 | </dd> |
|
|
983 | <p></p> |
| 706 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
984 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 707 | </dt> |
985 | </dt> |
| 708 | <dd> |
986 | <dd> |
| 709 | Returns true if the option specified by <code>$optval</code> is enabled, and |
987 | Returns true if the option specified by <code>$optval</code> is enabled, and |
| 710 | optionally change it. All option values are stored by name in the hash |
988 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 716 | </dd> |
994 | </dd> |
| 717 | <dd> |
995 | <dd> |
| 718 | <pre> |
996 | <pre> |
| 719 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
997 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 720 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
998 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 721 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
999 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 722 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1000 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 723 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1001 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 724 | tripleclickwords utmpInhibit visualBell</pre> |
1002 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 725 | </dd> |
1003 | </dd> |
| 726 | <p></p> |
1004 | <p></p> |
| 727 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1005 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 728 | </dt> |
1006 | </dt> |
| 729 | <dd> |
1007 | <dd> |
| … | |
… | |
| 754 | <pre> |
1032 | <pre> |
| 755 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1033 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 756 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1034 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 757 | display_name embed ext_bwidth fade font geometry hold iconName |
1035 | display_name embed ext_bwidth fade font geometry hold iconName |
| 758 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1036 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 759 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1037 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 760 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1038 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 761 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1039 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 762 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1040 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 763 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1041 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 764 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1042 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 765 | shade term_name title transparent transparent_all tripleclickwords |
1043 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1044 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 766 | utmpInhibit visualBell</pre> |
1045 | visualBell</pre> |
| 767 | </dd> |
1046 | </dd> |
| 768 | <p></p> |
1047 | <p></p> |
| 769 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
1048 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
| 770 | </dt> |
1049 | </dt> |
| 771 | <dd> |
1050 | <dd> |
| … | |
… | |
| 946 | <p>Normally its not a good idea to use this function, as programs might be |
1225 | <p>Normally its not a good idea to use this function, as programs might be |
| 947 | confused by changes in cursor position or scrolling. Its useful inside a |
1226 | confused by changes in cursor position or scrolling. Its useful inside a |
| 948 | <code>on_add_lines</code> hook, though.</p> |
1227 | <code>on_add_lines</code> hook, though.</p> |
| 949 | </dd> |
1228 | </dd> |
| 950 | <p></p> |
1229 | <p></p> |
|
|
1230 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1231 | </dt> |
|
|
1232 | <dd> |
|
|
1233 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1234 | </dd> |
|
|
1235 | <p></p> |
| 951 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1236 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 952 | </dt> |
1237 | </dt> |
| 953 | <dd> |
1238 | <dd> |
| 954 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1239 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 955 | locale-specific encoding of the terminal and can contain command sequences |
1240 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 971 | be used to suppress input and output handling to the pty/tty. See the |
1256 | be used to suppress input and output handling to the pty/tty. See the |
| 972 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1257 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
| 973 | the previous value. |
1258 | the previous value. |
| 974 | </dd> |
1259 | </dd> |
| 975 | <p></p> |
1260 | <p></p> |
|
|
1261 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1262 | </dt> |
|
|
1263 | <dd> |
|
|
1264 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1265 | is used. |
|
|
1266 | </dd> |
|
|
1267 | <p></p> |
| 976 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1268 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 977 | </dt> |
1269 | </dt> |
| 978 | <dd> |
1270 | <dd> |
| 979 | Return the window id of the toplevel window. |
1271 | Return the window id of the toplevel window. |
| 980 | </dd> |
1272 | </dd> |
| … | |
… | |
| 983 | </dt> |
1275 | </dt> |
| 984 | <dd> |
1276 | <dd> |
| 985 | Return the window id of the terminal window. |
1277 | Return the window id of the terminal window. |
| 986 | </dd> |
1278 | </dd> |
| 987 | <p></p> |
1279 | <p></p> |
|
|
1280 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1281 | </dt> |
|
|
1282 | <dd> |
|
|
1283 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1284 | to receive pointer events all the times: |
|
|
1285 | </dd> |
|
|
1286 | <dd> |
|
|
1287 | <pre> |
|
|
1288 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1289 | </dd> |
|
|
1290 | <p></p> |
| 988 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1291 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 989 | </dt> |
1292 | </dt> |
| 990 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1293 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 991 | </dt> |
1294 | </dt> |
| 992 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1295 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| … | |
… | |
| 1005 | </dt> |
1308 | </dt> |
| 1006 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1309 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
| 1007 | </dt> |
1310 | </dt> |
| 1008 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1311 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
| 1009 | </dt> |
1312 | </dt> |
| 1010 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1313 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
| 1011 | </dt> |
1314 | </dt> |
| 1012 | <dd> |
1315 | <dd> |
| 1013 | Return various integers describing terminal characteristics. |
1316 | Return various integers describing terminal characteristics. |
| 1014 | </dd> |
1317 | </dd> |
| 1015 | <p></p> |
1318 | <p></p> |
| … | |
… | |
| 1041 | <dd> |
1344 | <dd> |
| 1042 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1345 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 1043 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1346 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
| 1044 | </dd> |
1347 | </dd> |
| 1045 | <p></p> |
1348 | <p></p> |
|
|
1349 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1350 | </dt> |
|
|
1351 | <dd> |
|
|
1352 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1353 | </dd> |
|
|
1354 | <p></p> |
|
|
1355 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1356 | </dt> |
|
|
1357 | <dd> |
|
|
1358 | Returns wether the cursor is currently hidden or not. |
|
|
1359 | </dd> |
|
|
1360 | <p></p> |
| 1046 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1361 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 1047 | </dt> |
1362 | </dt> |
| 1048 | <dd> |
1363 | <dd> |
| 1049 | Returns the negative row number of the topmost line. Minimum value is |
1364 | Returns the row number of the topmost displayed line. Maximum value is |
| 1050 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1365 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
| 1051 | this many lines into the scrollback buffer. |
1366 | this many lines into the scrollback buffer. |
| 1052 | </dd> |
1367 | </dd> |
| 1053 | <p></p> |
1368 | <p></p> |
| 1054 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1369 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
| 1055 | </dt> |
1370 | </dt> |
| … | |
… | |
| 1066 | </dt> |
1381 | </dt> |
| 1067 | <dd> |
1382 | <dd> |
| 1068 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1383 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
| 1069 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1384 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
| 1070 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1385 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
| 1071 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1386 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
| 1072 | is requested. |
1387 | is requested. |
| 1073 | </dd> |
1388 | </dd> |
| 1074 | <dd> |
1389 | <dd> |
| 1075 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1390 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
| 1076 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1391 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 1077 | to replace only parts of a line. The font index in the rendition will |
1392 | to replace only parts of a line. The font index in the rendition will |
| 1078 | automatically be updated.</p> |
1393 | automatically be updated.</p> |
| 1079 | </dd> |
1394 | </dd> |
| 1080 | <dd> |
1395 | <dd> |
| 1081 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1396 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
| 1082 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1397 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
| 1083 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1398 | characters. Characters with combining characters and other characters that |
| 1084 | that do not fit into the normal tetx encoding will be replaced with |
1399 | do not fit into the normal tetx encoding will be replaced with characters |
| 1085 | characters in the private use area.</p> |
1400 | in the private use area.</p> |
| 1086 | </dd> |
1401 | </dd> |
| 1087 | <dd> |
1402 | <dd> |
| 1088 | <p>You have to obey this encoding when changing text. The advantage is |
1403 | <p>You have to obey this encoding when changing text. The advantage is |
| 1089 | that <code>substr</code> and similar functions work on screen cells and not on |
1404 | that <code>substr</code> and similar functions work on screen cells and not on |
| 1090 | characters.</p> |
1405 | characters.</p> |
| … | |
… | |
| 1224 | </dt> |
1539 | </dt> |
| 1225 | <dd> |
1540 | <dd> |
| 1226 | Calls XUngrab for the most recent grab. Is called automatically on |
1541 | Calls XUngrab for the most recent grab. Is called automatically on |
| 1227 | evaluation errors, as it is better to lose the grab in the error case as |
1542 | evaluation errors, as it is better to lose the grab in the error case as |
| 1228 | the session. |
1543 | the session. |
|
|
1544 | </dd> |
|
|
1545 | <p></p> |
|
|
1546 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1547 | </dt> |
|
|
1548 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1549 | </dt> |
|
|
1550 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1551 | </dt> |
|
|
1552 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1553 | </dt> |
|
|
1554 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1555 | </dt> |
|
|
1556 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1557 | </dt> |
|
|
1558 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1559 | </dt> |
|
|
1560 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1561 | </dt> |
|
|
1562 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1563 | </dt> |
|
|
1564 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1565 | </dt> |
|
|
1566 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1567 | </dt> |
|
|
1568 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1569 | </dt> |
|
|
1570 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1571 | </dt> |
|
|
1572 | <dd> |
|
|
1573 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1574 | the source of the display, otherwise those functions map more-or-less |
|
|
1575 | directory onto the X functions of the same name. |
| 1229 | </dd> |
1576 | </dd> |
| 1230 | <p></p></dl> |
1577 | <p></p></dl> |
| 1231 | <p> |
1578 | <p> |
| 1232 | </p> |
1579 | </p> |
| 1233 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1580 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| … | |
… | |
| 1321 | <p></p> |
1668 | <p></p> |
| 1322 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1669 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1323 | </dt> |
1670 | </dt> |
| 1324 | <dd> |
1671 | <dd> |
| 1325 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1672 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1673 | </dd> |
|
|
1674 | <p></p> |
|
|
1675 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1676 | </dt> |
|
|
1677 | <dd> |
|
|
1678 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1326 | </dd> |
1679 | </dd> |
| 1327 | <p></p> |
1680 | <p></p> |
| 1328 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1681 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1329 | </dt> |
1682 | </dt> |
| 1330 | <dd> |
1683 | <dd> |
| … | |
… | |
| 1388 | Stop watching for events on the given filehandle. |
1741 | Stop watching for events on the given filehandle. |
| 1389 | </dd> |
1742 | </dd> |
| 1390 | <p></p></dl> |
1743 | <p></p></dl> |
| 1391 | <p> |
1744 | <p> |
| 1392 | </p> |
1745 | </p> |
|
|
1746 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1747 | <p>This class implements idle watchers, that get called automatically when |
|
|
1748 | the process is idle. They should return as fast as possible, after doing |
|
|
1749 | some useful work.</p> |
|
|
1750 | <dl> |
|
|
1751 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1752 | </dt> |
|
|
1753 | <dd> |
|
|
1754 | Create a new idle watcher object in stopped state. |
|
|
1755 | </dd> |
|
|
1756 | <p></p> |
|
|
1757 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1758 | </dt> |
|
|
1759 | <dd> |
|
|
1760 | Set the callback to be called when the watcher triggers. |
|
|
1761 | </dd> |
|
|
1762 | <p></p> |
|
|
1763 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1764 | </dt> |
|
|
1765 | <dd> |
|
|
1766 | Start the watcher. |
|
|
1767 | </dd> |
|
|
1768 | <p></p> |
|
|
1769 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1770 | </dt> |
|
|
1771 | <dd> |
|
|
1772 | Stop the watcher. |
|
|
1773 | </dd> |
|
|
1774 | <p></p></dl> |
|
|
1775 | <p> |
|
|
1776 | </p> |
|
|
1777 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1778 | <p>This class implements process watchers. They create an event whenever a |
|
|
1779 | process exits, after which they stop automatically.</p> |
|
|
1780 | <pre> |
|
|
1781 | my $pid = fork; |
|
|
1782 | ... |
|
|
1783 | $term->{pw} = urxvt::pw |
|
|
1784 | ->new |
|
|
1785 | ->start ($pid) |
|
|
1786 | ->cb (sub { |
|
|
1787 | my ($pw, $exit_status) = @_; |
|
|
1788 | ... |
|
|
1789 | });</pre> |
|
|
1790 | <dl> |
|
|
1791 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1792 | </dt> |
|
|
1793 | <dd> |
|
|
1794 | Create a new process watcher in stopped state. |
|
|
1795 | </dd> |
|
|
1796 | <p></p> |
|
|
1797 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1798 | </dt> |
|
|
1799 | <dd> |
|
|
1800 | Set the callback to be called when the timer triggers. |
|
|
1801 | </dd> |
|
|
1802 | <p></p> |
|
|
1803 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1804 | </dt> |
|
|
1805 | <dd> |
|
|
1806 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1807 | </dd> |
|
|
1808 | <p></p> |
|
|
1809 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1810 | </dt> |
|
|
1811 | <dd> |
|
|
1812 | Stop the watcher. |
|
|
1813 | </dd> |
|
|
1814 | <p></p></dl> |
|
|
1815 | <p> |
|
|
1816 | </p> |
| 1393 | <hr /> |
1817 | <hr /> |
| 1394 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1818 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1395 | <p> |
1819 | <p> |
| 1396 | </p> |
1820 | </p> |
| 1397 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1821 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
