… | |
… | |
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#hooks">Hooks</a></li> |
22 | <li><a href="#hooks">Hooks</a></li> |
23 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
23 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
24 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
24 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#rendition">RENDITION</a></li> |
25 | <li><a href="#rendition">RENDITION</a></li> |
|
|
26 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
26 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
27 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
|
|
28 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
27 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
29 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
28 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
30 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
29 | </ul> |
31 | </ul> |
30 | |
32 | |
31 | <li><a href="#environment">ENVIRONMENT</a></li> |
33 | <li><a href="#environment">ENVIRONMENT</a></li> |
… | |
… | |
61 | rxvt --perl-lib $HOME -pe grab_test</pre> |
63 | rxvt --perl-lib $HOME -pe grab_test</pre> |
62 | <p> |
64 | <p> |
63 | </p> |
65 | </p> |
64 | <hr /> |
66 | <hr /> |
65 | <h1><a name="description">DESCRIPTION</a></h1> |
67 | <h1><a name="description">DESCRIPTION</a></h1> |
66 | <p>Everytime a terminal object gets created, scripts specified via the |
68 | <p>Everytime a terminal object gets created, extension scripts specified via |
67 | <code>perl</code> resource are loaded and associated with it.</p> |
69 | the <code>perl</code> resource are loaded and associated with it.</p> |
68 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
70 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
69 | thus must be encoded as UTF-8.</p> |
71 | thus must be encoded as UTF-8.</p> |
70 | <p>Each script will only ever be loaded once, even in rxvtd, where |
72 | <p>Each script will only ever be loaded once, even in rxvtd, where |
71 | scripts will be shared (but not enabled) for all terminals.</p> |
73 | scripts will be shared (but not enabled) for all terminals.</p> |
72 | <p> |
74 | <p> |
… | |
… | |
76 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
78 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
77 | <p>You can activate them like this:</p> |
79 | <p>You can activate them like this:</p> |
78 | <pre> |
80 | <pre> |
79 | rxvt -pe <extensionname></pre> |
81 | rxvt -pe <extensionname></pre> |
80 | <dl> |
82 | <dl> |
81 | <dt><strong><a name="item_selection">selection</a></strong><br /> |
83 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
82 | </dt> |
84 | </dt> |
83 | <dd> |
85 | <dd> |
84 | Intelligent selection. This extension tries to be more intelligent when |
86 | Intelligent selection. This extension tries to be more intelligent when |
85 | the user extends selections (double-click). Right now, it tries to select |
87 | the user extends selections (double-click). Right now, it tries to select |
86 | urls and complete shell-quoted arguments, which is very convenient, too, |
88 | urls and complete shell-quoted arguments, which is very convenient, too, |
… | |
… | |
98 | <dd> |
100 | <dd> |
99 | <pre> |
101 | <pre> |
100 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
102 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
101 | </dd> |
103 | </dd> |
102 | <p></p></dl> |
104 | <p></p></dl> |
|
|
105 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
|
|
106 | </dt> |
|
|
107 | <dd> |
|
|
108 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
109 | runtime. |
|
|
110 | </dd> |
|
|
111 | <p></p> |
|
|
112 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
113 | </dt> |
|
|
114 | <dd> |
|
|
115 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
116 | text into various other formats/action. |
|
|
117 | </dd> |
|
|
118 | <p></p> |
103 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
119 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
104 | </dt> |
120 | </dt> |
105 | <dd> |
121 | <dd> |
106 | Displays a digital clock using the built-in overlay. |
122 | Displays a digital clock using the built-in overlay. |
107 | </dd> |
123 | </dd> |
… | |
… | |
169 | </p> |
185 | </p> |
170 | <h2><a name="hooks">Hooks</a></h2> |
186 | <h2><a name="hooks">Hooks</a></h2> |
171 | <p>The following subroutines can be declared in extension files, and will be |
187 | <p>The following subroutines can be declared in extension files, and will be |
172 | called whenever the relevant event happens.</p> |
188 | called whenever the relevant event happens.</p> |
173 | <p>The first argument passed to them is an object private to each terminal |
189 | <p>The first argument passed to them is an object private to each terminal |
174 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
190 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
175 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
191 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
176 | object that is shared between all packages is stored in the <code>term</code> |
192 | object that is shared between all packages is stored in the <code>term</code> |
177 | member.</p> |
193 | member. It is, however, blessed intot he package of the extension script, |
|
|
194 | so for all practical purposes you can treat an extension script as a class.</p> |
178 | <p>All of them must return a boolean value. If it is true, then the event |
195 | <p>All of them must return a boolean value. If it is true, then the event |
179 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
196 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
180 | and the relevant action might not be carried out by the C++ code.</p> |
197 | and the relevant action might not be carried out by the C++ code.</p> |
181 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
198 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
182 | <dl> |
199 | <dl> |
… | |
… | |
238 | </dd> |
255 | </dd> |
239 | <dd> |
256 | <dd> |
240 | <p>See the <em>selection</em> example extension.</p> |
257 | <p>See the <em>selection</em> example extension.</p> |
241 | </dd> |
258 | </dd> |
242 | <p></p> |
259 | <p></p> |
243 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
244 | </dt> |
|
|
245 | <dd> |
|
|
246 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
247 | focus in processing. |
|
|
248 | </dd> |
|
|
249 | <p></p> |
|
|
250 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
251 | </dt> |
|
|
252 | <dd> |
|
|
253 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
254 | out processing. |
|
|
255 | </dd> |
|
|
256 | <p></p> |
|
|
257 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
260 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
258 | </dt> |
261 | </dt> |
259 | <dd> |
262 | <dd> |
260 | Called whenever the view offset changes, i..e the user or program |
263 | Called whenever the view offset changes, i..e the user or program |
261 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
264 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
… | |
… | |
271 | </dd> |
274 | </dd> |
272 | <dd> |
275 | <dd> |
273 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
276 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
274 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
277 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
275 | number of lines that will be in the scrollback buffer.</p> |
278 | number of lines that will be in the scrollback buffer.</p> |
276 | </dd> |
|
|
277 | <p></p> |
|
|
278 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
|
|
279 | </dt> |
|
|
280 | <dd> |
|
|
281 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
282 | </dd> |
279 | </dd> |
283 | <p></p> |
280 | <p></p> |
284 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
281 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
285 | </dt> |
282 | </dt> |
286 | <dd> |
283 | <dd> |
… | |
… | |
346 | Called whenever the user presses a key combination that has a |
343 | Called whenever the user presses a key combination that has a |
347 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
344 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
348 | resource in the <code>rxvt(1)</code> manpage). |
345 | resource in the <code>rxvt(1)</code> manpage). |
349 | </dd> |
346 | </dd> |
350 | <p></p> |
347 | <p></p> |
|
|
348 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
349 | </dt> |
|
|
350 | <dd> |
|
|
351 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
352 | does focus in processing. |
|
|
353 | </dd> |
|
|
354 | <p></p> |
|
|
355 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
356 | </dt> |
|
|
357 | <dd> |
|
|
358 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
359 | focus out processing. |
|
|
360 | </dd> |
|
|
361 | <p></p> |
351 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
362 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
352 | </dt> |
363 | </dt> |
353 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
364 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
354 | </dt> |
365 | </dt> |
355 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
366 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
356 | </dt> |
367 | </dt> |
357 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
368 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
358 | </dt> |
369 | </dt> |
359 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
370 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
371 | </dt> |
|
|
372 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
373 | </dt> |
|
|
374 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
360 | </dt> |
375 | </dt> |
361 | <dd> |
376 | <dd> |
362 | Called whenever the corresponding X event is received for the terminal If |
377 | Called whenever the corresponding X event is received for the terminal If |
363 | the hook returns true, then the even will be ignored by rxvt-unicode. |
378 | the hook returns true, then the even will be ignored by rxvt-unicode. |
364 | </dd> |
379 | </dd> |
… | |
… | |
422 | <p></p> |
437 | <p></p> |
423 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
438 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
424 | </dt> |
439 | </dt> |
425 | <dd> |
440 | <dd> |
426 | Returns the ``current time'' (as per the event loop). |
441 | Returns the ``current time'' (as per the event loop). |
|
|
442 | </dd> |
|
|
443 | <p></p> |
|
|
444 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
445 | </dt> |
|
|
446 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
447 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
448 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
449 | </dt> |
|
|
450 | <dd> |
|
|
451 | Various constants for use in X calls and event processing. |
427 | </dd> |
452 | </dd> |
428 | <p></p></dl> |
453 | <p></p></dl> |
429 | <p> |
454 | <p> |
430 | </p> |
455 | </p> |
431 | <h2><a name="rendition">RENDITION</a></h2> |
456 | <h2><a name="rendition">RENDITION</a></h2> |
… | |
… | |
488 | Change the custom value. |
513 | Change the custom value. |
489 | </dd> |
514 | </dd> |
490 | <p></p></dl> |
515 | <p></p></dl> |
491 | <p> |
516 | <p> |
492 | </p> |
517 | </p> |
|
|
518 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
519 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
520 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
521 | further work. The only exception is that you cannot wait on condition |
|
|
522 | variables, but non-blocking condvar use is ok. What this means is that you |
|
|
523 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
|
|
524 | <p> |
|
|
525 | </p> |
493 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
526 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
494 | <dl> |
527 | <dl> |
495 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
528 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
496 | </dt> |
529 | </dt> |
497 | <dd> |
530 | <dd> |
498 | Destroy the terminal object (close the window, free resources etc.). |
531 | Destroy the terminal object (close the window, free resources etc.). |
|
|
532 | </dd> |
|
|
533 | <p></p> |
|
|
534 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
535 | </dt> |
|
|
536 | <dd> |
|
|
537 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
538 | optionally change it. All option values are stored by name in the hash |
|
|
539 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
540 | </dd> |
|
|
541 | <dd> |
|
|
542 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
543 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
544 | </dd> |
|
|
545 | <dd> |
|
|
546 | <pre> |
|
|
547 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
548 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
549 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
550 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
551 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
552 | tripleclickwords utmpInhibit visualBell</pre> |
499 | </dd> |
553 | </dd> |
500 | <p></p> |
554 | <p></p> |
501 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
555 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
502 | </dt> |
556 | </dt> |
503 | <dd> |
557 | <dd> |
… | |
… | |
519 | <p>Please note that resource strings will currently only be freed when the |
573 | <p>Please note that resource strings will currently only be freed when the |
520 | terminal is destroyed, so changing options frequently will eat memory.</p> |
574 | terminal is destroyed, so changing options frequently will eat memory.</p> |
521 | </dd> |
575 | </dd> |
522 | <dd> |
576 | <dd> |
523 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
577 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
524 | are supported in every build, please see the source to see the actual |
578 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
525 | list:</p> |
579 | to see the actual list:</p> |
526 | </dd> |
580 | </dd> |
527 | <dd> |
581 | <dd> |
528 | <pre> |
582 | <pre> |
529 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
583 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
530 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
584 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
640 | </dt> |
694 | </dt> |
641 | <dd> |
695 | <dd> |
642 | If hidden, display the overlay again. |
696 | If hidden, display the overlay again. |
643 | </dd> |
697 | </dd> |
644 | <p></p></dl> |
698 | <p></p></dl> |
|
|
699 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
700 | </dt> |
|
|
701 | <dd> |
|
|
702 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
703 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
704 | currently). |
|
|
705 | </dd> |
|
|
706 | <p></p> |
645 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
707 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
646 | </dt> |
708 | </dt> |
647 | <dd> |
709 | <dd> |
648 | Returns the number of screen-cells this string would need. Correctly |
710 | Returns the number of screen-cells this string would need. Correctly |
649 | accounts for wide and combining characters. |
711 | accounts for wide and combining characters. |
… | |
… | |
727 | </dt> |
789 | </dt> |
728 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
790 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
729 | </dt> |
791 | </dt> |
730 | <dd> |
792 | <dd> |
731 | Return various integers describing terminal characteristics. |
793 | Return various integers describing terminal characteristics. |
|
|
794 | </dd> |
|
|
795 | <p></p> |
|
|
796 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
797 | </dt> |
|
|
798 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
799 | </dt> |
|
|
800 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
801 | </dt> |
|
|
802 | <dd> |
|
|
803 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
804 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
732 | </dd> |
805 | </dd> |
733 | <p></p> |
806 | <p></p> |
734 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
807 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
735 | </dt> |
808 | </dt> |
736 | <dd> |
809 | <dd> |
… | |
… | |
776 | <p>You have to obey this encoding when changing text. The advantage is |
849 | <p>You have to obey this encoding when changing text. The advantage is |
777 | that <code>substr</code> and similar functions work on screen cells and not on |
850 | that <code>substr</code> and similar functions work on screen cells and not on |
778 | characters.</p> |
851 | characters.</p> |
779 | </dd> |
852 | </dd> |
780 | <dd> |
853 | <dd> |
781 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
854 | <p>The methods <a href="#item_special_encode"><code>$term->special_encode</code></a> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
782 | can be used to convert normal strings into this encoding and vice versa.</p> |
855 | can be used to convert normal strings into this encoding and vice versa.</p> |
783 | </dd> |
856 | </dd> |
784 | <p></p> |
857 | <p></p> |
785 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
858 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
786 | </dt> |
859 | </dt> |
… | |
… | |
858 | </dt> |
931 | </dt> |
859 | <dd> |
932 | <dd> |
860 | Translates a string offset into terminal coordinates again. |
933 | Translates a string offset into terminal coordinates again. |
861 | </dd> |
934 | </dd> |
862 | <p></p></dl> |
935 | <p></p></dl> |
863 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
936 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
864 | =item $text = $term->special_encode $string</strong><br /> |
|
|
865 | </dt> |
937 | </dt> |
866 | <dd> |
938 | <dd> |
867 | Converts a perl string into the special encoding used by rxvt-unicode, |
939 | Converts a perl string into the special encoding used by rxvt-unicode, |
868 | where one character corresponds to one screen cell. See |
940 | where one character corresponds to one screen cell. See |
869 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
941 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
873 | </dt> |
945 | </dt> |
874 | <dd> |
946 | <dd> |
875 | Converts rxvt-unicodes text reprsentation into a perl string. See |
947 | Converts rxvt-unicodes text reprsentation into a perl string. See |
876 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
948 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
877 | </dd> |
949 | </dd> |
|
|
950 | <p></p> |
|
|
951 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
952 | </dt> |
|
|
953 | <dd> |
|
|
954 | Registers a synchronous button grab. See XGrabButton. |
|
|
955 | </dd> |
|
|
956 | <p></p> |
|
|
957 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
958 | </dt> |
|
|
959 | <dd> |
|
|
960 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
961 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
962 | </dd> |
|
|
963 | <p></p> |
|
|
964 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
965 | </dt> |
|
|
966 | <dd> |
|
|
967 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
968 | </dd> |
|
|
969 | <p></p> |
|
|
970 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
971 | </dt> |
|
|
972 | <dd> |
|
|
973 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
974 | </dd> |
|
|
975 | <p></p> |
|
|
976 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
977 | </dt> |
|
|
978 | <dd> |
|
|
979 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
980 | recent grab. |
|
|
981 | </dd> |
|
|
982 | <p></p> |
|
|
983 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
984 | </dt> |
|
|
985 | <dd> |
|
|
986 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
987 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
988 | the session. |
|
|
989 | </dd> |
878 | <p></p></dl> |
990 | <p></p></dl> |
|
|
991 | <p> |
|
|
992 | </p> |
|
|
993 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
879 | <p> |
994 | <p> |
880 | </p> |
995 | </p> |
881 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
996 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
882 | <p>This class implements timer watchers/events. Time is represented as a |
997 | <p>This class implements timer watchers/events. Time is represented as a |
883 | fractional number of seconds since the epoch. Example:</p> |
998 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1006 | </p> |
1121 | </p> |
1007 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1122 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1008 | <p>This variable controls the verbosity level of the perl extension. Higher |
1123 | <p>This variable controls the verbosity level of the perl extension. Higher |
1009 | numbers indicate more verbose output.</p> |
1124 | numbers indicate more verbose output.</p> |
1010 | <dl> |
1125 | <dl> |
1011 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1126 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1012 | </dt> |
1127 | </dt> |
1013 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1128 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1014 | </dt> |
1129 | </dt> |
1015 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1130 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1016 | </dt> |
1131 | </dt> |
1017 | </dl> |
1132 | </dl> |
1018 | <p> |
1133 | <p> |
1019 | </p> |
1134 | </p> |
1020 | <hr /> |
1135 | <hr /> |