… | |
… | |
13 | <ul> |
13 | <ul> |
14 | |
14 | |
15 | <li><a href="#name">NAME</a></li> |
15 | <li><a href="#name">NAME</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
|
|
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
|
|
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
18 | <ul> |
20 | <ul> |
19 | |
21 | |
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
|
|
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
22 | <li><a href="#hooks">Hooks</a></li> |
24 | <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> |
25 | <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> |
26 | <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> |
27 | <li><a href="#rendition">RENDITION</a></li> |
26 | <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> |
… | |
… | |
71 | thus must be encoded as UTF-8.</p> |
73 | thus must be encoded as UTF-8.</p> |
72 | <p>Each script will only ever be loaded once, even in rxvtd, where |
74 | <p>Each script will only ever be loaded once, even in rxvtd, where |
73 | scripts will be shared (but not enabled) for all terminals.</p> |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
74 | <p> |
76 | <p> |
75 | </p> |
77 | </p> |
76 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
78 | <hr /> |
|
|
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
77 | <p>This section describes the extensiosn delivered with this version. You can |
80 | <p>This section describes the extensions delivered with this release. You can |
78 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
79 | <p>You can activate them like this:</p> |
82 | <p>You can activate them like this:</p> |
80 | <pre> |
83 | <pre> |
81 | rxvt -pe <extensionname></pre> |
84 | rxvt -pe <extensionname></pre> |
82 | <dl> |
85 | <dl> |
83 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
84 | </dt> |
87 | </dt> |
85 | <dd> |
88 | <dd> |
86 | Intelligent selection. This extension tries to be more intelligent when |
89 | (More) intelligent selection. This extension tries to be more intelligent |
87 | the user extends selections (double-click). Right now, it tries to select |
90 | when the user extends selections (double-click). Right now, it tries to |
88 | urls and complete shell-quoted arguments, which is very convenient, too, |
91 | select urls and complete shell-quoted arguments, which is very convenient, |
89 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
90 | </dd> |
|
|
91 | <dd> |
93 | </dd> |
|
|
94 | <dd> |
92 | <p>It also offers the following bindable event:</p> |
95 | <p>It also offers the following bindable keyboard command:</p> |
93 | </dd> |
96 | </dd> |
94 | <dl> |
97 | <dl> |
95 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
96 | </dt> |
99 | </dt> |
97 | <dd> |
100 | <dd> |
… | |
… | |
103 | </dd> |
106 | </dd> |
104 | <p></p></dl> |
107 | <p></p></dl> |
105 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
108 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
106 | </dt> |
109 | </dt> |
107 | <dd> |
110 | <dd> |
108 | Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at |
111 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
109 | runtime. |
112 | runtime. |
|
|
113 | </dd> |
|
|
114 | <p></p> |
|
|
115 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
116 | </dt> |
|
|
117 | <dd> |
|
|
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
119 | text into various other formats/action (such as uri unescaping, perl |
|
|
120 | evalution, web-browser starting etc.), depending on content. |
|
|
121 | </dd> |
|
|
122 | <p></p> |
|
|
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
124 | </dt> |
|
|
125 | <dd> |
|
|
126 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
|
|
128 | input/output is suspended. |
|
|
129 | </dd> |
|
|
130 | <dd> |
|
|
131 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
132 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
133 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
134 | returns to the original position.</p> |
110 | </dd> |
135 | </dd> |
111 | <p></p> |
136 | <p></p> |
112 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
113 | </dt> |
138 | </dt> |
114 | <dd> |
139 | <dd> |
… | |
… | |
135 | Displays a very simple digital clock in the upper right corner of the |
160 | Displays a very simple digital clock in the upper right corner of the |
136 | window. Illustrates overwriting the refresh callbacks to create your own |
161 | window. Illustrates overwriting the refresh callbacks to create your own |
137 | overlays or changes. |
162 | overlays or changes. |
138 | </dd> |
163 | </dd> |
139 | <p></p></dl> |
164 | <p></p></dl> |
|
|
165 | <p> |
|
|
166 | </p> |
|
|
167 | <hr /> |
|
|
168 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
140 | <p> |
169 | <p> |
141 | </p> |
170 | </p> |
142 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
171 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
143 | <p>All objects (such as terminals, time watchers etc.) are typical |
172 | <p>All objects (such as terminals, time watchers etc.) are typical |
144 | reference-to-hash objects. The hash can be used to store anything you |
173 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
174 | locale-specific way. |
203 | locale-specific way. |
175 | </dd> |
204 | </dd> |
176 | <p></p></dl> |
205 | <p></p></dl> |
177 | <p> |
206 | <p> |
178 | </p> |
207 | </p> |
|
|
208 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
209 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
210 | for each terminal and each extension and passed as the first parameter to |
|
|
211 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
212 | about other extensions, with the exception of methods and members that |
|
|
213 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
214 | use.</p> |
|
|
215 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
216 | <code>urxvt::term</code> class on this object.</p> |
|
|
217 | <p>It has the following methods and data members:</p> |
|
|
218 | <dl> |
|
|
219 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
220 | </dt> |
|
|
221 | <dd> |
|
|
222 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
223 | extension. This member <em>must not</em> be changed in any way. |
|
|
224 | </dd> |
|
|
225 | <p></p> |
|
|
226 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
227 | </dt> |
|
|
228 | <dd> |
|
|
229 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
230 | this extension, replacing any previous hook. This is useful when you want |
|
|
231 | to overwrite time-critical hooks only temporarily. |
|
|
232 | </dd> |
|
|
233 | <p></p> |
|
|
234 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
235 | </dt> |
|
|
236 | <dd> |
|
|
237 | Dynamically disable the given hooks. |
|
|
238 | </dd> |
|
|
239 | <p></p></dl> |
|
|
240 | <p> |
|
|
241 | </p> |
179 | <h2><a name="hooks">Hooks</a></h2> |
242 | <h2><a name="hooks">Hooks</a></h2> |
180 | <p>The following subroutines can be declared in extension files, and will be |
243 | <p>The following subroutines can be declared in extension files, and will be |
181 | called whenever the relevant event happens.</p> |
244 | called whenever the relevant event happens.</p> |
182 | <p>The first argument passed to them is an object private to each terminal |
245 | <p>The first argument passed to them is an extension oject as described in |
183 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
246 | the in the <code>Extension Objects</code> section.</p> |
184 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
185 | object that is shared between all packages is stored in the <code>term</code> |
|
|
186 | member. It is, however, blessed intot he package of the extension script, |
|
|
187 | so for all practical purposes you can treat an extension script as a class.</p> |
|
|
188 | <p>All of them must return a boolean value. If it is true, then the event |
247 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
189 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
248 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
190 | and the relevant action might not be carried out by the C++ code.</p> |
249 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
191 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
250 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
192 | <dl> |
251 | <dl> |
193 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
252 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
194 | </dt> |
253 | </dt> |
195 | <dd> |
254 | <dd> |
196 | Called after a new terminal object has been initialized, but before |
255 | Called after a new terminal object has been initialized, but before |
… | |
… | |
267 | </dd> |
326 | </dd> |
268 | <dd> |
327 | <dd> |
269 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
328 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
270 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
329 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
271 | number of lines that will be in the scrollback buffer.</p> |
330 | number of lines that will be in the scrollback buffer.</p> |
272 | </dd> |
|
|
273 | <p></p> |
|
|
274 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
|
|
275 | </dt> |
|
|
276 | <dd> |
|
|
277 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
278 | </dd> |
331 | </dd> |
279 | <p></p> |
332 | <p></p> |
280 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
333 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
281 | </dt> |
334 | </dt> |
282 | <dd> |
335 | <dd> |
… | |
… | |
301 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
354 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
302 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
355 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
303 | output. |
356 | output. |
304 | </dd> |
357 | </dd> |
305 | <p></p> |
358 | <p></p> |
|
|
359 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
360 | </dt> |
|
|
361 | <dd> |
|
|
362 | Called whenever some data is written to the tty/pty and can be used to |
|
|
363 | suppress or filter tty input. |
|
|
364 | </dd> |
|
|
365 | <p></p> |
306 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
366 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
307 | </dt> |
367 | </dt> |
308 | <dd> |
368 | <dd> |
309 | Called whenever a line was updated or changed. Can be used to filter |
369 | Called whenever a line was updated or changed. Can be used to filter |
310 | screen output (e.g. underline urls or other useless stuff). Only lines |
370 | screen output (e.g. underline urls or other useless stuff). Only lines |
… | |
… | |
356 | <dd> |
416 | <dd> |
357 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
358 | focus out processing. |
418 | focus out processing. |
359 | </dd> |
419 | </dd> |
360 | <p></p> |
420 | <p></p> |
361 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
421 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
362 | </dt> |
422 | </dt> |
363 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
364 | </dt> |
424 | </dt> |
365 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
366 | </dt> |
426 | </dt> |
367 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
427 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
368 | </dt> |
428 | </dt> |
… | |
… | |
391 | <p></p></dl> |
451 | <p></p></dl> |
392 | <p> |
452 | <p> |
393 | </p> |
453 | </p> |
394 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
395 | <dl> |
455 | <dl> |
|
|
456 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
457 | </dt> |
|
|
458 | <dd> |
|
|
459 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
460 | modules and scripts are stored. |
|
|
461 | </dd> |
|
|
462 | <p></p> |
|
|
463 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
464 | </dt> |
|
|
465 | <dd> |
|
|
466 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
467 | </dd> |
|
|
468 | <p></p> |
|
|
469 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
470 | </dt> |
|
|
471 | <dd> |
|
|
472 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
473 | </dd> |
|
|
474 | <p></p> |
396 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
475 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
397 | </dt> |
476 | </dt> |
398 | <dd> |
477 | <dd> |
399 | The current terminal. This variable stores the current <code>urxvt::term</code> |
478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
400 | object, whenever a callback/hook is executing. |
479 | object, whenever a callback/hook is executing. |
401 | </dd> |
480 | </dd> |
402 | <p></p></dl> |
481 | <p></p> |
|
|
482 | <dt></dt> |
|
|
483 | </dl> |
403 | <p> |
484 | <p> |
404 | </p> |
485 | </p> |
405 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
486 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
406 | <dl> |
487 | <dl> |
407 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
488 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
… | |
… | |
430 | that calls this function. |
511 | that calls this function. |
431 | </dd> |
512 | </dd> |
432 | <dd> |
513 | <dd> |
433 | <p>Using this function has the advantage that its output ends up in the |
514 | <p>Using this function has the advantage that its output ends up in the |
434 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
515 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
|
|
516 | </dd> |
|
|
517 | <p></p> |
|
|
518 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
519 | </dt> |
|
|
520 | <dd> |
|
|
521 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
522 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
523 | started setuid or setgid. |
435 | </dd> |
524 | </dd> |
436 | <p></p> |
525 | <p></p> |
437 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
526 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
438 | </dt> |
527 | </dt> |
439 | <dd> |
528 | <dd> |
… | |
… | |
487 | </dt> |
576 | </dt> |
488 | <dd> |
577 | <dd> |
489 | Return the foreground/background colour index, respectively. |
578 | Return the foreground/background colour index, respectively. |
490 | </dd> |
579 | </dd> |
491 | <p></p> |
580 | <p></p> |
492 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
581 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
493 | </dt> |
582 | </dt> |
494 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
583 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
495 | </dt> |
584 | </dt> |
496 | <dd> |
585 | <dd> |
497 | Replace the foreground/background colour in the rendition mask with the |
586 | Replace the foreground/background colour in the rendition mask with the |
498 | specified one. |
587 | specified one. |
499 | </dd> |
588 | </dd> |
500 | <p></p> |
589 | <p></p> |
501 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
590 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
502 | </dt> |
591 | </dt> |
503 | <dd> |
592 | <dd> |
504 | Return the ``custom'' value: Every rendition has 5 bits for use by |
593 | Return the ``custom'' value: Every rendition has 5 bits for use by |
505 | extensions. They can be set and changed as you like and are initially |
594 | extensions. They can be set and changed as you like and are initially |
506 | zero. |
595 | zero. |
507 | </dd> |
596 | </dd> |
508 | <p></p> |
597 | <p></p> |
509 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
598 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
510 | </dt> |
599 | </dt> |
511 | <dd> |
600 | <dd> |
512 | Change the custom value. |
601 | Change the custom value. |
513 | </dd> |
602 | </dd> |
514 | <p></p></dl> |
603 | <p></p></dl> |
515 | <p> |
604 | <p> |
516 | </p> |
605 | </p> |
517 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
606 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
518 | <p>The sole purpose of this class is to deliver an interface to the |
607 | <p>The sole purpose of this class is to deliver an interface to the |
519 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
608 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
520 | further work. The only exception is that you cannot wait on condition |
609 | further programming. The only exception is that you cannot wait on |
521 | variables, but non-blocking condvar use is ok. What this means is that you |
610 | condition variables, but non-blocking condvar use is ok. What this means |
522 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
611 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
612 | work.</p> |
523 | <p> |
613 | <p> |
524 | </p> |
614 | </p> |
525 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
615 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
526 | <dl> |
616 | <dl> |
527 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
617 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
528 | </dt> |
618 | </dt> |
529 | <dd> |
619 | <dd> |
530 | Destroy the terminal object (close the window, free resources etc.). |
620 | Destroy the terminal object (close the window, free resources |
|
|
621 | etc.). Please note that rxvt will not exit as long as any event |
|
|
622 | watchers (timers, io watchers) are still active. |
531 | </dd> |
623 | </dd> |
532 | <p></p> |
624 | <p></p> |
533 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
625 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
534 | </dt> |
626 | </dt> |
535 | <dd> |
627 | <dd> |
… | |
… | |
591 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
683 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
592 | shade term_name title transparent transparent_all tripleclickwords |
684 | shade term_name title transparent transparent_all tripleclickwords |
593 | utmpInhibit visualBell</pre> |
685 | utmpInhibit visualBell</pre> |
594 | </dd> |
686 | </dd> |
595 | <p></p> |
687 | <p></p> |
|
|
688 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
689 | </dt> |
|
|
690 | <dd> |
|
|
691 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
692 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
693 | </dd> |
|
|
694 | <p></p> |
596 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
695 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
597 | </dt> |
696 | </dt> |
598 | <dd> |
697 | <dd> |
599 | Return and optionally change the current rendition. Text that is output by |
698 | Return and optionally change the current rendition. Text that is output by |
600 | the terminal application will use this style. |
699 | the terminal application will use this style. |
… | |
… | |
628 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
727 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
629 | </dt> |
728 | </dt> |
630 | <dd> |
729 | <dd> |
631 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
730 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
632 | </dd> |
731 | </dd> |
|
|
732 | <p></p> |
|
|
733 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
734 | </dt> |
633 | <dd> |
735 | <dd> |
634 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
635 | # |
|
|
636 | #Create a simple multi-line overlay box. See the next method for details. |
736 | Create a simple multi-line overlay box. See the next method for details. |
637 | # |
|
|
638 | #=cut |
|
|
639 | # |
|
|
640 | #sub urxvt::term::scr_overlay { |
|
|
641 | # my ($self, $x, $y, $text) = @_; |
|
|
642 | # |
|
|
643 | # my @lines = split /\n/, $text; |
|
|
644 | # |
|
|
645 | # my $w = 0; |
|
|
646 | # for (map $self->strwidth ($_), @lines) { |
|
|
647 | # $w = $_ if $w < $_; |
|
|
648 | # } |
|
|
649 | # |
|
|
650 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
651 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
652 | #}</p> |
|
|
653 | </dd> |
737 | </dd> |
654 | <p></p> |
738 | <p></p> |
655 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
739 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
656 | </dt> |
740 | </dt> |
657 | <dd> |
741 | <dd> |
… | |
… | |
718 | <p></p> |
802 | <p></p> |
719 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
803 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
720 | </dt> |
804 | </dt> |
721 | <dd> |
805 | <dd> |
722 | Convert the given locale-encoded octets into a perl string. |
806 | Convert the given locale-encoded octets into a perl string. |
|
|
807 | </dd> |
|
|
808 | <p></p> |
|
|
809 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
810 | </dt> |
|
|
811 | <dd> |
|
|
812 | XORs the rendition values in the given span with the provided value |
|
|
813 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
|
|
814 | to the selection. |
|
|
815 | </dd> |
|
|
816 | <p></p> |
|
|
817 | <dt><strong><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br /> |
|
|
818 | </dt> |
|
|
819 | <dd> |
|
|
820 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
821 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
822 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
823 | it instead. |
|
|
824 | </dd> |
|
|
825 | <p></p> |
|
|
826 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
827 | </dt> |
|
|
828 | <dd> |
|
|
829 | Ring the bell! |
723 | </dd> |
830 | </dd> |
724 | <p></p> |
831 | <p></p> |
725 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
832 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
726 | </dt> |
833 | </dt> |
727 | <dd> |
834 | <dd> |
… | |
… | |
750 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
857 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
751 | pass characters instead of octets, you should convert your strings first |
858 | pass characters instead of octets, you should convert your strings first |
752 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
859 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
753 | </dd> |
860 | </dd> |
754 | <p></p> |
861 | <p></p> |
|
|
862 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
863 | </dt> |
|
|
864 | <dd> |
|
|
865 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
866 | be used to suppress input and output handling to the pty/tty. See the |
|
|
867 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
868 | the previous value. |
|
|
869 | </dd> |
|
|
870 | <p></p> |
755 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
871 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
756 | </dt> |
872 | </dt> |
757 | <dd> |
873 | <dd> |
758 | Return the window id of the toplevel window. |
874 | Return the window id of the toplevel window. |
759 | </dd> |
875 | </dd> |
… | |
… | |
788 | </dt> |
904 | </dt> |
789 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
905 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
790 | </dt> |
906 | </dt> |
791 | <dd> |
907 | <dd> |
792 | Return various integers describing terminal characteristics. |
908 | Return various integers describing terminal characteristics. |
|
|
909 | </dd> |
|
|
910 | <p></p> |
|
|
911 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
912 | </dt> |
|
|
913 | <dd> |
|
|
914 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
915 | </dd> |
|
|
916 | <p></p> |
|
|
917 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
918 | </dt> |
|
|
919 | <dd> |
|
|
920 | Return the DISPLAY used by rxvt-unicode. |
793 | </dd> |
921 | </dd> |
794 | <p></p> |
922 | <p></p> |
795 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
923 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
796 | </dt> |
924 | </dt> |
797 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
925 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
848 | <p>You have to obey this encoding when changing text. The advantage is |
976 | <p>You have to obey this encoding when changing text. The advantage is |
849 | that <code>substr</code> and similar functions work on screen cells and not on |
977 | that <code>substr</code> and similar functions work on screen cells and not on |
850 | characters.</p> |
978 | characters.</p> |
851 | </dd> |
979 | </dd> |
852 | <dd> |
980 | <dd> |
853 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
981 | <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> |
854 | can be used to convert normal strings into this encoding and vice versa.</p> |
982 | can be used to convert normal strings into this encoding and vice versa.</p> |
855 | </dd> |
983 | </dd> |
856 | <p></p> |
984 | <p></p> |
857 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
985 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
858 | </dt> |
986 | </dt> |
… | |
… | |
930 | </dt> |
1058 | </dt> |
931 | <dd> |
1059 | <dd> |
932 | Translates a string offset into terminal coordinates again. |
1060 | Translates a string offset into terminal coordinates again. |
933 | </dd> |
1061 | </dd> |
934 | <p></p></dl> |
1062 | <p></p></dl> |
935 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
1063 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
936 | =item $text = $term->special_encode $string</strong><br /> |
|
|
937 | </dt> |
1064 | </dt> |
938 | <dd> |
1065 | <dd> |
939 | Converts a perl string into the special encoding used by rxvt-unicode, |
1066 | Converts a perl string into the special encoding used by rxvt-unicode, |
940 | where one character corresponds to one screen cell. See |
1067 | where one character corresponds to one screen cell. See |
941 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1068 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
945 | </dt> |
1072 | </dt> |
946 | <dd> |
1073 | <dd> |
947 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1074 | Converts rxvt-unicodes text reprsentation into a perl string. See |
948 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1075 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
949 | </dd> |
1076 | </dd> |
|
|
1077 | <p></p> |
|
|
1078 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1079 | </dt> |
|
|
1080 | <dd> |
|
|
1081 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1082 | </dd> |
|
|
1083 | <p></p> |
|
|
1084 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1085 | </dt> |
|
|
1086 | <dd> |
|
|
1087 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1088 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1089 | </dd> |
|
|
1090 | <p></p> |
|
|
1091 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1092 | </dt> |
|
|
1093 | <dd> |
|
|
1094 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1095 | </dd> |
|
|
1096 | <p></p> |
|
|
1097 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1098 | </dt> |
|
|
1099 | <dd> |
|
|
1100 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1101 | </dd> |
|
|
1102 | <p></p> |
|
|
1103 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1104 | </dt> |
|
|
1105 | <dd> |
|
|
1106 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1107 | recent grab. |
|
|
1108 | </dd> |
|
|
1109 | <p></p> |
|
|
1110 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1111 | </dt> |
|
|
1112 | <dd> |
|
|
1113 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1114 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1115 | the session. |
|
|
1116 | </dd> |
950 | <p></p></dl> |
1117 | <p></p></dl> |
951 | <p> |
1118 | <p> |
952 | </p> |
1119 | </p> |
953 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1120 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1121 | <dl> |
|
|
1122 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1123 | </dt> |
|
|
1124 | <dd> |
|
|
1125 | Adds a non-clickable title to the popup. |
|
|
1126 | </dd> |
|
|
1127 | <p></p> |
|
|
1128 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1129 | </dt> |
|
|
1130 | <dd> |
|
|
1131 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1132 | </dd> |
|
|
1133 | <p></p> |
|
|
1134 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1135 | </dt> |
|
|
1136 | <dd> |
|
|
1137 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1138 | selected. |
|
|
1139 | </dd> |
|
|
1140 | <p></p> |
|
|
1141 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1142 | </dt> |
|
|
1143 | <dd> |
|
|
1144 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1145 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1146 | argument. |
|
|
1147 | </dd> |
|
|
1148 | <p></p> |
|
|
1149 | <dt><strong>$popup->show</strong><br /> |
|
|
1150 | </dt> |
|
|
1151 | <dd> |
|
|
1152 | Displays the popup (which is initially hidden). |
|
|
1153 | </dd> |
|
|
1154 | <p></p></dl> |
954 | <p> |
1155 | <p> |
955 | </p> |
1156 | </p> |
956 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1157 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
957 | <p>This class implements timer watchers/events. Time is represented as a |
1158 | <p>This class implements timer watchers/events. Time is represented as a |
958 | fractional number of seconds since the epoch. Example:</p> |
1159 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1024 | <pre> |
1225 | <pre> |
1025 | $term->{socket} = ... |
1226 | $term->{socket} = ... |
1026 | $term->{iow} = urxvt::iow |
1227 | $term->{iow} = urxvt::iow |
1027 | ->new |
1228 | ->new |
1028 | ->fd (fileno $term->{socket}) |
1229 | ->fd (fileno $term->{socket}) |
1029 | ->events (1) # wait for read data |
1230 | ->events (urxvt::EVENT_READ) |
1030 | ->start |
1231 | ->start |
1031 | ->cb (sub { |
1232 | ->cb (sub { |
1032 | my ($iow, $revents) = @_; |
1233 | my ($iow, $revents) = @_; |
1033 | # $revents must be 1 here, no need to check |
1234 | # $revents must be 1 here, no need to check |
1034 | sysread $term->{socket}, my $buf, 8192 |
1235 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1055 | </dd> |
1256 | </dd> |
1056 | <p></p> |
1257 | <p></p> |
1057 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1258 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1058 | </dt> |
1259 | </dt> |
1059 | <dd> |
1260 | <dd> |
1060 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1261 | Set the event mask to watch. The only allowed values are |
1061 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1262 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1263 | together, or <code>urxvt::EVENT_NONE</code>. |
1062 | </dd> |
1264 | </dd> |
1063 | <p></p> |
1265 | <p></p> |
1064 | <dt><strong>$iow = $iow->start</strong><br /> |
1266 | <dt><strong>$iow = $iow->start</strong><br /> |
1065 | </dt> |
1267 | </dt> |
1066 | <dd> |
1268 | <dd> |
… | |
… | |
1081 | </p> |
1283 | </p> |
1082 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1284 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1083 | <p>This variable controls the verbosity level of the perl extension. Higher |
1285 | <p>This variable controls the verbosity level of the perl extension. Higher |
1084 | numbers indicate more verbose output.</p> |
1286 | numbers indicate more verbose output.</p> |
1085 | <dl> |
1287 | <dl> |
1086 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1288 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1087 | </dt> |
1289 | </dt> |
1088 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1290 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1089 | </dt> |
1291 | </dt> |
1090 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1292 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1091 | </dt> |
1293 | </dt> |
1092 | </dl> |
1294 | </dl> |
1093 | <p> |
1295 | <p> |
1094 | </p> |
1296 | </p> |
1095 | <hr /> |
1297 | <hr /> |