| … | |
… | |
| 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 |
| … | |
… | |
| 145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
150 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 146 | </dt> |
151 | </dt> |
| 147 | <dd> |
152 | <dd> |
| 148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
153 | 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 |
154 | text into various other formats/action (such as uri unescaping, perl |
| 150 | evalution, web-browser starting etc.), depending on content. |
155 | evaluation, web-browser starting etc.), depending on content. |
|
|
156 | </dd> |
|
|
157 | <dd> |
|
|
158 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
159 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
160 | popup is displayed.</p> |
|
|
161 | </dd> |
|
|
162 | <dd> |
|
|
163 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
164 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
165 | It should either return nothing or a string and a code reference. The |
|
|
166 | string will be used as button text and the code reference will be called |
|
|
167 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
168 | </dd> |
|
|
169 | <dd> |
|
|
170 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
171 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
172 | <code>a</code>s:</p> |
|
|
173 | </dd> |
|
|
174 | <dd> |
|
|
175 | <pre> |
|
|
176 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
177 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
178 | : () |
|
|
179 | };</pre> |
| 151 | </dd> |
180 | </dd> |
| 152 | <p></p> |
181 | <p></p> |
| 153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
182 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
| 154 | </dt> |
183 | </dt> |
| 155 | <dd> |
184 | <dd> |
| … | |
… | |
| 166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
195 | 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 |
196 | additionally stores the first match in the current line into the primary |
| 168 | selection.</p> |
197 | selection.</p> |
| 169 | </dd> |
198 | </dd> |
| 170 | <p></p> |
199 | <p></p> |
|
|
200 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
201 | </dt> |
|
|
202 | <dd> |
|
|
203 | A support package that tries to make editing with readline easier. At the |
|
|
204 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
205 | move the text cursor to this position. It does so by generating as many |
|
|
206 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
207 | for programs that correctly support wide characters). |
|
|
208 | </dd> |
|
|
209 | <dd> |
|
|
210 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
211 | </dd> |
|
|
212 | <dl> |
|
|
213 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
214 | </dt> |
|
|
215 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
216 | </dt> |
|
|
217 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
218 | </dt> |
|
|
219 | </dl> |
|
|
220 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
221 | might interfere with selection creation in harmless ways.</p> |
| 171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
222 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
| 172 | </dt> |
223 | </dt> |
| 173 | <dd> |
224 | <dd> |
| 174 | This selection allows you to do automatic transforms on a selection |
225 | This selection allows you to do automatic transforms on a selection |
| 175 | whenever a selection is made. |
226 | whenever a selection is made. |
| … | |
… | |
| 197 | <p>And this example matches the same,but replaces it with vi-commands you can |
248 | <p>And this example matches the same,but replaces it with vi-commands you can |
| 198 | paste directly into your (vi :) editor:</p> |
249 | paste directly into your (vi :) editor:</p> |
| 199 | </dd> |
250 | </dd> |
| 200 | <dd> |
251 | <dd> |
| 201 | <pre> |
252 | <pre> |
| 202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
253 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
| 203 | </dd> |
254 | </dd> |
| 204 | <dd> |
255 | <dd> |
| 205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
256 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
| 206 | </dd> |
257 | </dd> |
| 207 | <dd> |
258 | <dd> |
| 208 | <p>To expand the example above to typical perl error messages (``XXX at |
259 | <p>To expand the example above to typical perl error messages (``XXX at |
| 209 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
260 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
| 210 | </dd> |
261 | </dd> |
| 211 | <dd> |
262 | <dd> |
| 212 | <pre> |
263 | <pre> |
| 213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
264 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
| 214 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
265 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
| 215 | </dd> |
266 | </dd> |
| 216 | <dd> |
267 | <dd> |
| 217 | <p>The first line tells the selection code to treat the unchanging part of |
268 | <p>The first line tells the selection code to treat the unchanging part of |
| 218 | every error message as a selection pattern, and the second line transforms |
269 | every error message as a selection pattern, and the second line transforms |
| 219 | the message into vi commands to load the file.</p> |
270 | the message into vi commands to load the file.</p> |
|
|
271 | </dd> |
|
|
272 | <p></p> |
|
|
273 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
274 | </dt> |
|
|
275 | <dd> |
|
|
276 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
277 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
278 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
279 | button per tab. |
|
|
280 | </dd> |
|
|
281 | <dd> |
|
|
282 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
283 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
284 | while <strong>Shift-Down</strong> creates a new tab.</p> |
| 220 | </dd> |
285 | </dd> |
| 221 | <p></p> |
286 | <p></p> |
| 222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
287 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 223 | </dt> |
288 | </dt> |
| 224 | <dd> |
289 | <dd> |
| 225 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
290 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
| 226 | make them clickable. When middle-clicked, the program specified in the |
291 | make them clickable. When middle-clicked, the program specified in the |
| 227 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
292 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
| 228 | the URL as first argument. |
293 | the URL as first argument. |
|
|
294 | </dd> |
|
|
295 | <p></p> |
|
|
296 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
297 | </dt> |
|
|
298 | <dd> |
|
|
299 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
300 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
301 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
302 | </dd> |
|
|
303 | <dd> |
|
|
304 | <pre> |
|
|
305 | rxvt -pixmap background.xpm -pe automove-background</pre> |
| 229 | </dd> |
306 | </dd> |
| 230 | <p></p> |
307 | <p></p> |
| 231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
308 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 232 | </dt> |
309 | </dt> |
| 233 | <dd> |
310 | <dd> |
| … | |
… | |
| 372 | <h2><a name="hooks">Hooks</a></h2> |
449 | <h2><a name="hooks">Hooks</a></h2> |
| 373 | <p>The following subroutines can be declared in extension files, and will be |
450 | <p>The following subroutines can be declared in extension files, and will be |
| 374 | called whenever the relevant event happens.</p> |
451 | called whenever the relevant event happens.</p> |
| 375 | <p>The first argument passed to them is an extension oject as described in |
452 | <p>The first argument passed to them is an extension oject as described in |
| 376 | the in the <code>Extension Objects</code> section.</p> |
453 | the in the <code>Extension Objects</code> section.</p> |
| 377 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
454 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 378 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
455 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 379 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
456 | relevant action might not be carried out by the C++ code.</p> |
| 380 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
457 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 381 | <dl> |
458 | <dl> |
| 382 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
459 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 383 | </dt> |
460 | </dt> |
| 384 | <dd> |
461 | <dd> |
| 385 | Called after a new terminal object has been initialized, but before |
462 | Called after a new terminal object has been initialized, but before |
| 386 | windows are created or the command gets run. Most methods are unsafe to |
463 | windows are created or the command gets run. Most methods are unsafe to |
| 387 | call or deliver senseless data, as terminal size and other characteristics |
464 | call or deliver senseless data, as terminal size and other characteristics |
| 388 | have not yet been determined. You can safely query and change resources, |
465 | have not yet been determined. You can safely query and change resources |
| 389 | though. |
466 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
467 | place. |
|
|
468 | </dd> |
|
|
469 | <p></p> |
|
|
470 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
471 | </dt> |
|
|
472 | <dd> |
|
|
473 | Called at the very end of initialisation of a new terminal, just before |
|
|
474 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
475 | </dd> |
|
|
476 | <p></p> |
|
|
477 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
478 | </dt> |
|
|
479 | <dd> |
|
|
480 | Called whenever something tries to destroy terminal, before doing anything |
|
|
481 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
482 | rarely a good idea. |
| 390 | </dd> |
483 | </dd> |
| 391 | <p></p> |
484 | <p></p> |
| 392 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
485 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 393 | </dt> |
486 | </dt> |
| 394 | <dd> |
487 | <dd> |
| 395 | Called after the screen is ``reset'' for any reason, such as resizing or |
488 | Called after the screen is ``reset'' for any reason, such as resizing or |
| 396 | control sequences. Here is where you can react on changes to size-related |
489 | control sequences. Here is where you can react on changes to size-related |
| 397 | variables. |
490 | variables. |
| 398 | </dd> |
491 | </dd> |
| 399 | <p></p> |
492 | <p></p> |
| 400 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
493 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 401 | </dt> |
494 | </dt> |
|
|
495 | <dd> |
|
|
496 | Called just after the child process has been <code>fork</code>ed. |
| 402 | <dd> |
497 | </dd> |
| 403 | Called at the very end of initialisation of a new terminal, just before |
498 | <p></p> |
| 404 | returning to the mainloop. |
499 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
500 | </dt> |
|
|
501 | <dd> |
|
|
502 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
503 | from <code>waitpid</code>. |
| 405 | </dd> |
504 | </dd> |
| 406 | <p></p> |
505 | <p></p> |
| 407 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
506 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 408 | </dt> |
507 | </dt> |
| 409 | <dd> |
508 | <dd> |
| … | |
… | |
| 556 | <dd> |
655 | <dd> |
| 557 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
656 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 558 | focus out processing. |
657 | focus out processing. |
| 559 | </dd> |
658 | </dd> |
| 560 | <p></p> |
659 | <p></p> |
|
|
660 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
661 | </dt> |
|
|
662 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
663 | </dt> |
| 561 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
664 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
| 562 | </dt> |
665 | </dt> |
| 563 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
666 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 564 | </dt> |
667 | </dt> |
| 565 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
668 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| … | |
… | |
| 576 | Called whenever the corresponding X event is received for the terminal If |
679 | Called whenever the corresponding X event is received for the terminal If |
| 577 | the hook returns true, then the even will be ignored by rxvt-unicode. |
680 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 578 | </dd> |
681 | </dd> |
| 579 | <dd> |
682 | <dd> |
| 580 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
683 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 581 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
684 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 582 | and column under the mouse cursor.</p> |
685 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 583 | </dd> |
686 | </dd> |
| 584 | <dd> |
687 | <dd> |
| 585 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
688 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 586 | output, if any, in locale-specific encoding.</p> |
689 | output, if any, in locale-specific encoding.</p> |
| 587 | </dd> |
690 | </dd> |
| 588 | <dd> |
691 | <dd> |
| 589 | <p>subwindow.</p> |
692 | <p>subwindow.</p> |
|
|
693 | </dd> |
|
|
694 | <p></p> |
|
|
695 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
696 | </dt> |
|
|
697 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
698 | </dt> |
|
|
699 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
700 | </dt> |
|
|
701 | <dd> |
|
|
702 | Called when various types of ClientMessage events are received (all with |
|
|
703 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 590 | </dd> |
704 | </dd> |
| 591 | <p></p></dl> |
705 | <p></p></dl> |
| 592 | <p> |
706 | <p> |
| 593 | </p> |
707 | </p> |
| 594 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
708 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 615 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
729 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
| 616 | </dt> |
730 | </dt> |
| 617 | <dd> |
731 | <dd> |
| 618 | The current terminal. This variable stores the current <code>urxvt::term</code> |
732 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 619 | object, whenever a callback/hook is executing. |
733 | object, whenever a callback/hook is executing. |
|
|
734 | </dd> |
|
|
735 | <p></p> |
|
|
736 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
737 | </dt> |
|
|
738 | <dd> |
|
|
739 | All coderefs in this array will be called as methods of the next newly |
|
|
740 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
741 | gets cleared before the codereferences that were in it are being executed, |
|
|
742 | so coderefs can push themselves onto it again if they so desire. |
|
|
743 | </dd> |
|
|
744 | <dd> |
|
|
745 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
746 | first.</p> |
|
|
747 | </dd> |
|
|
748 | <p></p> |
|
|
749 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
750 | </dt> |
|
|
751 | <dd> |
|
|
752 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
753 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
754 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
| 620 | </dd> |
755 | </dd> |
| 621 | <p></p></dl> |
756 | <p></p></dl> |
| 622 | <p> |
757 | <p> |
| 623 | </p> |
758 | </p> |
| 624 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
759 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 773 | Destroy the terminal object (close the window, free resources |
908 | Destroy the terminal object (close the window, free resources |
| 774 | etc.). Please note that rxvt will not exit as long as any event |
909 | etc.). Please note that rxvt will not exit as long as any event |
| 775 | watchers (timers, io watchers) are still active. |
910 | watchers (timers, io watchers) are still active. |
| 776 | </dd> |
911 | </dd> |
| 777 | <p></p> |
912 | <p></p> |
|
|
913 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
914 | </dt> |
|
|
915 | <dd> |
|
|
916 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
917 | (``starts'') programs in the background. This function takes care of setting |
|
|
918 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
919 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
920 | </dd> |
|
|
921 | <dd> |
|
|
922 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
923 | </dd> |
|
|
924 | <p></p> |
| 778 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
925 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 779 | </dt> |
926 | </dt> |
| 780 | <dd> |
927 | <dd> |
| 781 | Returns true if the option specified by <code>$optval</code> is enabled, and |
928 | Returns true if the option specified by <code>$optval</code> is enabled, and |
| 782 | optionally change it. All option values are stored by name in the hash |
929 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 788 | </dd> |
935 | </dd> |
| 789 | <dd> |
936 | <dd> |
| 790 | <pre> |
937 | <pre> |
| 791 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
938 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 792 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
939 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 793 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
940 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 794 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
941 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 795 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
942 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 796 | tripleclickwords utmpInhibit visualBell</pre> |
943 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 797 | </dd> |
944 | </dd> |
| 798 | <p></p> |
945 | <p></p> |
| 799 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
946 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 800 | </dt> |
947 | </dt> |
| 801 | <dd> |
948 | <dd> |
| … | |
… | |
| 826 | <pre> |
973 | <pre> |
| 827 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
974 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 828 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
975 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 829 | display_name embed ext_bwidth fade font geometry hold iconName |
976 | display_name embed ext_bwidth fade font geometry hold iconName |
| 830 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
977 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 831 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
978 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 832 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
979 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 833 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
980 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 834 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
981 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 835 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
982 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 836 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
983 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 837 | shade term_name title transparent transparent_all tripleclickwords |
984 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
985 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 838 | utmpInhibit visualBell</pre> |
986 | visualBell</pre> |
| 839 | </dd> |
987 | </dd> |
| 840 | <p></p> |
988 | <p></p> |
| 841 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
989 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
| 842 | </dt> |
990 | </dt> |
| 843 | <dd> |
991 | <dd> |
| … | |
… | |
| 1018 | <p>Normally its not a good idea to use this function, as programs might be |
1166 | <p>Normally its not a good idea to use this function, as programs might be |
| 1019 | confused by changes in cursor position or scrolling. Its useful inside a |
1167 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1020 | <code>on_add_lines</code> hook, though.</p> |
1168 | <code>on_add_lines</code> hook, though.</p> |
| 1021 | </dd> |
1169 | </dd> |
| 1022 | <p></p> |
1170 | <p></p> |
|
|
1171 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1172 | </dt> |
|
|
1173 | <dd> |
|
|
1174 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1175 | </dd> |
|
|
1176 | <p></p> |
| 1023 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1177 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 1024 | </dt> |
1178 | </dt> |
| 1025 | <dd> |
1179 | <dd> |
| 1026 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1180 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 1027 | locale-specific encoding of the terminal and can contain command sequences |
1181 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 1122 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1276 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
| 1123 | </dt> |
1277 | </dt> |
| 1124 | <dd> |
1278 | <dd> |
| 1125 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1279 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 1126 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1280 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1281 | </dd> |
|
|
1282 | <p></p> |
|
|
1283 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1284 | </dt> |
|
|
1285 | <dd> |
|
|
1286 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1287 | </dd> |
|
|
1288 | <p></p> |
|
|
1289 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1290 | </dt> |
|
|
1291 | <dd> |
|
|
1292 | Returns wether the cursor is currently hidden or not. |
| 1127 | </dd> |
1293 | </dd> |
| 1128 | <p></p> |
1294 | <p></p> |
| 1129 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1295 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 1130 | </dt> |
1296 | </dt> |
| 1131 | <dd> |
1297 | <dd> |
| … | |
… | |
| 1159 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1325 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 1160 | to replace only parts of a line. The font index in the rendition will |
1326 | to replace only parts of a line. The font index in the rendition will |
| 1161 | automatically be updated.</p> |
1327 | automatically be updated.</p> |
| 1162 | </dd> |
1328 | </dd> |
| 1163 | <dd> |
1329 | <dd> |
| 1164 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1330 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use |
| 1165 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1331 | more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> |
| 1166 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1332 | characters. Characters with combining characters and other characters that |
| 1167 | that do not fit into the normal tetx encoding will be replaced with |
1333 | do not fit into the normal tetx encoding will be replaced with characters |
| 1168 | characters in the private use area.</p> |
1334 | in the private use area.</p> |
| 1169 | </dd> |
1335 | </dd> |
| 1170 | <dd> |
1336 | <dd> |
| 1171 | <p>You have to obey this encoding when changing text. The advantage is |
1337 | <p>You have to obey this encoding when changing text. The advantage is |
| 1172 | that <code>substr</code> and similar functions work on screen cells and not on |
1338 | that <code>substr</code> and similar functions work on screen cells and not on |
| 1173 | characters.</p> |
1339 | characters.</p> |
| … | |
… | |
| 1307 | </dt> |
1473 | </dt> |
| 1308 | <dd> |
1474 | <dd> |
| 1309 | Calls XUngrab for the most recent grab. Is called automatically on |
1475 | Calls XUngrab for the most recent grab. Is called automatically on |
| 1310 | evaluation errors, as it is better to lose the grab in the error case as |
1476 | evaluation errors, as it is better to lose the grab in the error case as |
| 1311 | the session. |
1477 | the session. |
|
|
1478 | </dd> |
|
|
1479 | <p></p> |
|
|
1480 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1481 | </dt> |
|
|
1482 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1483 | </dt> |
|
|
1484 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1485 | </dt> |
|
|
1486 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1487 | </dt> |
|
|
1488 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1489 | </dt> |
|
|
1490 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1491 | </dt> |
|
|
1492 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1493 | </dt> |
|
|
1494 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1495 | </dt> |
|
|
1496 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1497 | </dt> |
|
|
1498 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1499 | </dt> |
|
|
1500 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1501 | </dt> |
|
|
1502 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1503 | </dt> |
|
|
1504 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1505 | </dt> |
|
|
1506 | <dd> |
|
|
1507 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1508 | the source of the display, otherwise those functions map more-or-less |
|
|
1509 | directory onto the X functions of the same name. |
| 1312 | </dd> |
1510 | </dd> |
| 1313 | <p></p></dl> |
1511 | <p></p></dl> |
| 1314 | <p> |
1512 | <p> |
| 1315 | </p> |
1513 | </p> |
| 1316 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1514 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| … | |
… | |
| 1404 | <p></p> |
1602 | <p></p> |
| 1405 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1603 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1406 | </dt> |
1604 | </dt> |
| 1407 | <dd> |
1605 | <dd> |
| 1408 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1606 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1607 | </dd> |
|
|
1608 | <p></p> |
|
|
1609 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1610 | </dt> |
|
|
1611 | <dd> |
|
|
1612 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1409 | </dd> |
1613 | </dd> |
| 1410 | <p></p> |
1614 | <p></p> |
| 1411 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1615 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1412 | </dt> |
1616 | </dt> |
| 1413 | <dd> |
1617 | <dd> |
| … | |
… | |
| 1471 | Stop watching for events on the given filehandle. |
1675 | Stop watching for events on the given filehandle. |
| 1472 | </dd> |
1676 | </dd> |
| 1473 | <p></p></dl> |
1677 | <p></p></dl> |
| 1474 | <p> |
1678 | <p> |
| 1475 | </p> |
1679 | </p> |
|
|
1680 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1681 | <p>This class implements idle watchers, that get called automatically when |
|
|
1682 | the process is idle. They should return as fast as possible, after doing |
|
|
1683 | some useful work.</p> |
|
|
1684 | <dl> |
|
|
1685 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1686 | </dt> |
|
|
1687 | <dd> |
|
|
1688 | Create a new idle watcher object in stopped state. |
|
|
1689 | </dd> |
|
|
1690 | <p></p> |
|
|
1691 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1692 | </dt> |
|
|
1693 | <dd> |
|
|
1694 | Set the callback to be called when the watcher triggers. |
|
|
1695 | </dd> |
|
|
1696 | <p></p> |
|
|
1697 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1698 | </dt> |
|
|
1699 | <dd> |
|
|
1700 | Start the watcher. |
|
|
1701 | </dd> |
|
|
1702 | <p></p> |
|
|
1703 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1704 | </dt> |
|
|
1705 | <dd> |
|
|
1706 | Stop the watcher. |
|
|
1707 | </dd> |
|
|
1708 | <p></p></dl> |
|
|
1709 | <p> |
|
|
1710 | </p> |
|
|
1711 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1712 | <p>This class implements process watchers. They create an event whenever a |
|
|
1713 | process exits, after which they stop automatically.</p> |
|
|
1714 | <pre> |
|
|
1715 | my $pid = fork; |
|
|
1716 | ... |
|
|
1717 | $term->{pw} = urxvt::pw |
|
|
1718 | ->new |
|
|
1719 | ->start ($pid) |
|
|
1720 | ->cb (sub { |
|
|
1721 | my ($pw, $exit_status) = @_; |
|
|
1722 | ... |
|
|
1723 | });</pre> |
|
|
1724 | <dl> |
|
|
1725 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1726 | </dt> |
|
|
1727 | <dd> |
|
|
1728 | Create a new process watcher in stopped state. |
|
|
1729 | </dd> |
|
|
1730 | <p></p> |
|
|
1731 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1732 | </dt> |
|
|
1733 | <dd> |
|
|
1734 | Set the callback to be called when the timer triggers. |
|
|
1735 | </dd> |
|
|
1736 | <p></p> |
|
|
1737 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1738 | </dt> |
|
|
1739 | <dd> |
|
|
1740 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1741 | </dd> |
|
|
1742 | <p></p> |
|
|
1743 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1744 | </dt> |
|
|
1745 | <dd> |
|
|
1746 | Stop the watcher. |
|
|
1747 | </dd> |
|
|
1748 | <p></p></dl> |
|
|
1749 | <p> |
|
|
1750 | </p> |
| 1476 | <hr /> |
1751 | <hr /> |
| 1477 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1752 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1478 | <p> |
1753 | <p> |
| 1479 | </p> |
1754 | </p> |
| 1480 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1755 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
