… | |
… | |
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> |
… | |
… | |
111 | <p></p> |
114 | <p></p> |
112 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
115 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
113 | </dt> |
116 | </dt> |
114 | <dd> |
117 | <dd> |
115 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
116 | text into various other formats/action. |
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> |
117 | </dd> |
135 | </dd> |
118 | <p></p> |
136 | <p></p> |
119 | <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 /> |
120 | </dt> |
138 | </dt> |
121 | <dd> |
139 | <dd> |
… | |
… | |
142 | 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 |
143 | window. Illustrates overwriting the refresh callbacks to create your own |
161 | window. Illustrates overwriting the refresh callbacks to create your own |
144 | overlays or changes. |
162 | overlays or changes. |
145 | </dd> |
163 | </dd> |
146 | <p></p></dl> |
164 | <p></p></dl> |
|
|
165 | <p> |
|
|
166 | </p> |
|
|
167 | <hr /> |
|
|
168 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
147 | <p> |
169 | <p> |
148 | </p> |
170 | </p> |
149 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
171 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
150 | <p>All objects (such as terminals, time watchers etc.) are typical |
172 | <p>All objects (such as terminals, time watchers etc.) are typical |
151 | 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 |
… | |
… | |
181 | locale-specific way. |
203 | locale-specific way. |
182 | </dd> |
204 | </dd> |
183 | <p></p></dl> |
205 | <p></p></dl> |
184 | <p> |
206 | <p> |
185 | </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> |
186 | <h2><a name="hooks">Hooks</a></h2> |
242 | <h2><a name="hooks">Hooks</a></h2> |
187 | <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 |
188 | called whenever the relevant event happens.</p> |
244 | called whenever the relevant event happens.</p> |
189 | <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 |
190 | 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> |
191 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
192 | object that is shared between all packages is stored in the <code>term</code> |
|
|
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> |
|
|
195 | <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 |
196 | 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 |
197 | 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> |
198 | <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> |
199 | <dl> |
251 | <dl> |
200 | <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 /> |
201 | </dt> |
253 | </dt> |
202 | <dd> |
254 | <dd> |
203 | Called after a new terminal object has been initialized, but before |
255 | Called after a new terminal object has been initialized, but before |
… | |
… | |
302 | 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 |
303 | 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 |
304 | output. |
356 | output. |
305 | </dd> |
357 | </dd> |
306 | <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> |
307 | <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 /> |
308 | </dt> |
367 | </dt> |
309 | <dd> |
368 | <dd> |
310 | 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 |
311 | 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 |
… | |
… | |
357 | <dd> |
416 | <dd> |
358 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
359 | focus out processing. |
418 | focus out processing. |
360 | </dd> |
419 | </dd> |
361 | <p></p> |
420 | <p></p> |
362 | <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 /> |
363 | </dt> |
422 | </dt> |
364 | <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 /> |
365 | </dt> |
424 | </dt> |
366 | <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 /> |
367 | </dt> |
426 | </dt> |
368 | <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 /> |
369 | </dt> |
428 | </dt> |
… | |
… | |
392 | <p></p></dl> |
451 | <p></p></dl> |
393 | <p> |
452 | <p> |
394 | </p> |
453 | </p> |
395 | <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> |
396 | <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> |
397 | <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 /> |
398 | </dt> |
476 | </dt> |
399 | <dd> |
477 | <dd> |
400 | 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> |
401 | object, whenever a callback/hook is executing. |
479 | object, whenever a callback/hook is executing. |
402 | </dd> |
480 | </dd> |
403 | <p></p></dl> |
481 | <p></p> |
|
|
482 | <dt></dt> |
|
|
483 | </dl> |
404 | <p> |
484 | <p> |
405 | </p> |
485 | </p> |
406 | <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> |
407 | <dl> |
487 | <dl> |
408 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
409 | </dt> |
|
|
410 | <dd> |
|
|
411 | Creates a new terminal, very similar as if you had started it with |
|
|
412 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
413 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
414 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
415 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
416 | </dd> |
|
|
417 | <p></p> |
|
|
418 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
488 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
419 | </dt> |
489 | </dt> |
420 | <dd> |
490 | <dd> |
421 | Fatally aborts execution with the given error message. Avoid at all |
491 | Fatally aborts execution with the given error message. Avoid at all |
422 | costs! The only time this is acceptable is when the terminal process |
492 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
431 | that calls this function. |
501 | that calls this function. |
432 | </dd> |
502 | </dd> |
433 | <dd> |
503 | <dd> |
434 | <p>Using this function has the advantage that its output ends up in the |
504 | <p>Using this function has the advantage that its output ends up in the |
435 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
505 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
|
|
506 | </dd> |
|
|
507 | <dd> |
|
|
508 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
509 | </dd> |
|
|
510 | <p></p> |
|
|
511 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
512 | </dt> |
|
|
513 | <dd> |
|
|
514 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
515 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
516 | started setuid or setgid. |
436 | </dd> |
517 | </dd> |
437 | <p></p> |
518 | <p></p> |
438 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
519 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
439 | </dt> |
520 | </dt> |
440 | <dd> |
521 | <dd> |
… | |
… | |
488 | </dt> |
569 | </dt> |
489 | <dd> |
570 | <dd> |
490 | Return the foreground/background colour index, respectively. |
571 | Return the foreground/background colour index, respectively. |
491 | </dd> |
572 | </dd> |
492 | <p></p> |
573 | <p></p> |
493 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
574 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
494 | </dt> |
575 | </dt> |
495 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
576 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
496 | </dt> |
577 | </dt> |
497 | <dd> |
578 | <dd> |
498 | Replace the foreground/background colour in the rendition mask with the |
579 | Replace the foreground/background colour in the rendition mask with the |
499 | specified one. |
580 | specified one. |
500 | </dd> |
581 | </dd> |
501 | <p></p> |
582 | <p></p> |
502 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
583 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
503 | </dt> |
584 | </dt> |
504 | <dd> |
585 | <dd> |
505 | Return the ``custom'' value: Every rendition has 5 bits for use by |
586 | Return the ``custom'' value: Every rendition has 5 bits for use by |
506 | extensions. They can be set and changed as you like and are initially |
587 | extensions. They can be set and changed as you like and are initially |
507 | zero. |
588 | zero. |
508 | </dd> |
589 | </dd> |
509 | <p></p> |
590 | <p></p> |
510 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
591 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
511 | </dt> |
592 | </dt> |
512 | <dd> |
593 | <dd> |
513 | Change the custom value. |
594 | Change the custom value. |
514 | </dd> |
595 | </dd> |
515 | <p></p></dl> |
596 | <p></p></dl> |
516 | <p> |
597 | <p> |
517 | </p> |
598 | </p> |
518 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
599 | <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 |
600 | <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 |
601 | <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 |
602 | further programming. The only exception is that you cannot wait on |
522 | variables, but non-blocking condvar use is ok. What this means is that you |
603 | condition variables, but non-blocking condvar use is ok. What this means |
523 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
604 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
605 | work.</p> |
524 | <p> |
606 | <p> |
525 | </p> |
607 | </p> |
526 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
608 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
527 | <dl> |
609 | <dl> |
|
|
610 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
611 | </dt> |
|
|
612 | <dd> |
|
|
613 | Creates a new terminal, very similar as if you had started it with system |
|
|
614 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a %ENV>-like |
|
|
615 | <code></code>hash which defines the environment of the new terminal. |
|
|
616 | </dd> |
|
|
617 | <dd> |
|
|
618 | <p>>Croaks (and probably outputs an error message) if the new instance |
|
|
619 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
620 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
621 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
622 | </dd> |
|
|
623 | <p></p> |
528 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
624 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
529 | </dt> |
625 | </dt> |
530 | <dd> |
626 | <dd> |
531 | Destroy the terminal object (close the window, free resources etc.). |
627 | Destroy the terminal object (close the window, free resources |
|
|
628 | etc.). Please note that rxvt will not exit as long as any event |
|
|
629 | watchers (timers, io watchers) are still active. |
532 | </dd> |
630 | </dd> |
533 | <p></p> |
631 | <p></p> |
534 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
632 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
535 | </dt> |
633 | </dt> |
536 | <dd> |
634 | <dd> |
… | |
… | |
592 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
690 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
593 | shade term_name title transparent transparent_all tripleclickwords |
691 | shade term_name title transparent transparent_all tripleclickwords |
594 | utmpInhibit visualBell</pre> |
692 | utmpInhibit visualBell</pre> |
595 | </dd> |
693 | </dd> |
596 | <p></p> |
694 | <p></p> |
|
|
695 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
696 | </dt> |
|
|
697 | <dd> |
|
|
698 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
699 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
700 | </dd> |
|
|
701 | <p></p> |
597 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
702 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
598 | </dt> |
703 | </dt> |
599 | <dd> |
704 | <dd> |
600 | Return and optionally change the current rendition. Text that is output by |
705 | Return and optionally change the current rendition. Text that is output by |
601 | the terminal application will use this style. |
706 | the terminal application will use this style. |
… | |
… | |
629 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
734 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
630 | </dt> |
735 | </dt> |
631 | <dd> |
736 | <dd> |
632 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
737 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
633 | </dd> |
738 | </dd> |
|
|
739 | <p></p> |
|
|
740 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
741 | </dt> |
634 | <dd> |
742 | <dd> |
635 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
636 | # |
|
|
637 | #Create a simple multi-line overlay box. See the next method for details. |
743 | Create a simple multi-line overlay box. See the next method for details. |
638 | # |
|
|
639 | #=cut |
|
|
640 | # |
|
|
641 | #sub urxvt::term::scr_overlay { |
|
|
642 | # my ($self, $x, $y, $text) = @_; |
|
|
643 | # |
|
|
644 | # my @lines = split /\n/, $text; |
|
|
645 | # |
|
|
646 | # my $w = 0; |
|
|
647 | # for (map $self->strwidth ($_), @lines) { |
|
|
648 | # $w = $_ if $w < $_; |
|
|
649 | # } |
|
|
650 | # |
|
|
651 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
652 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
653 | #}</p> |
|
|
654 | </dd> |
744 | </dd> |
655 | <p></p> |
745 | <p></p> |
656 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
746 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
657 | </dt> |
747 | </dt> |
658 | <dd> |
748 | <dd> |
… | |
… | |
719 | <p></p> |
809 | <p></p> |
720 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
810 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
721 | </dt> |
811 | </dt> |
722 | <dd> |
812 | <dd> |
723 | Convert the given locale-encoded octets into a perl string. |
813 | Convert the given locale-encoded octets into a perl string. |
|
|
814 | </dd> |
|
|
815 | <p></p> |
|
|
816 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
817 | </dt> |
|
|
818 | <dd> |
|
|
819 | XORs the rendition values in the given span with the provided value |
|
|
820 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
|
|
821 | to the selection. |
|
|
822 | </dd> |
|
|
823 | <p></p> |
|
|
824 | <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 /> |
|
|
825 | </dt> |
|
|
826 | <dd> |
|
|
827 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
828 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
829 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
830 | it instead. |
|
|
831 | </dd> |
|
|
832 | <p></p> |
|
|
833 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
834 | </dt> |
|
|
835 | <dd> |
|
|
836 | Ring the bell! |
724 | </dd> |
837 | </dd> |
725 | <p></p> |
838 | <p></p> |
726 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
839 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
727 | </dt> |
840 | </dt> |
728 | <dd> |
841 | <dd> |
… | |
… | |
751 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
864 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
752 | pass characters instead of octets, you should convert your strings first |
865 | pass characters instead of octets, you should convert your strings first |
753 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
866 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
754 | </dd> |
867 | </dd> |
755 | <p></p> |
868 | <p></p> |
|
|
869 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
870 | </dt> |
|
|
871 | <dd> |
|
|
872 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
873 | be used to suppress input and output handling to the pty/tty. See the |
|
|
874 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
875 | the previous value. |
|
|
876 | </dd> |
|
|
877 | <p></p> |
756 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
878 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
757 | </dt> |
879 | </dt> |
758 | <dd> |
880 | <dd> |
759 | Return the window id of the toplevel window. |
881 | Return the window id of the toplevel window. |
760 | </dd> |
882 | </dd> |
… | |
… | |
789 | </dt> |
911 | </dt> |
790 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
912 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
791 | </dt> |
913 | </dt> |
792 | <dd> |
914 | <dd> |
793 | Return various integers describing terminal characteristics. |
915 | Return various integers describing terminal characteristics. |
|
|
916 | </dd> |
|
|
917 | <p></p> |
|
|
918 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
919 | </dt> |
|
|
920 | <dd> |
|
|
921 | Return the DISPLAY used by rxvt-unicode. |
|
|
922 | </dd> |
|
|
923 | <p></p> |
|
|
924 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
925 | </dt> |
|
|
926 | <dd> |
|
|
927 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
928 | </dd> |
|
|
929 | <p></p> |
|
|
930 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
931 | </dt> |
|
|
932 | <dd> |
|
|
933 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
934 | similar to <code>\%ENV</code>. |
794 | </dd> |
935 | </dd> |
795 | <p></p> |
936 | <p></p> |
796 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
937 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
797 | </dt> |
938 | </dt> |
798 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
939 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
949 | </dd> |
1090 | </dd> |
950 | <p></p> |
1091 | <p></p> |
951 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
1092 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
952 | </dt> |
1093 | </dt> |
953 | <dd> |
1094 | <dd> |
954 | Registers a synchronous button grab. See XGrabButton. |
1095 | Registers a synchronous button grab. See the XGrabButton manpage. |
955 | </dd> |
1096 | </dd> |
956 | <p></p> |
1097 | <p></p> |
957 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1098 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
958 | </dt> |
1099 | </dt> |
959 | <dd> |
1100 | <dd> |
… | |
… | |
989 | </dd> |
1130 | </dd> |
990 | <p></p></dl> |
1131 | <p></p></dl> |
991 | <p> |
1132 | <p> |
992 | </p> |
1133 | </p> |
993 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1134 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1135 | <dl> |
|
|
1136 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1137 | </dt> |
|
|
1138 | <dd> |
|
|
1139 | Adds a non-clickable title to the popup. |
|
|
1140 | </dd> |
|
|
1141 | <p></p> |
|
|
1142 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1143 | </dt> |
|
|
1144 | <dd> |
|
|
1145 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1146 | </dd> |
|
|
1147 | <p></p> |
|
|
1148 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1149 | </dt> |
|
|
1150 | <dd> |
|
|
1151 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1152 | selected. |
|
|
1153 | </dd> |
|
|
1154 | <p></p> |
|
|
1155 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1156 | </dt> |
|
|
1157 | <dd> |
|
|
1158 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1159 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1160 | argument. |
|
|
1161 | </dd> |
|
|
1162 | <p></p> |
|
|
1163 | <dt><strong>$popup->show</strong><br /> |
|
|
1164 | </dt> |
|
|
1165 | <dd> |
|
|
1166 | Displays the popup (which is initially hidden). |
|
|
1167 | </dd> |
|
|
1168 | <p></p></dl> |
994 | <p> |
1169 | <p> |
995 | </p> |
1170 | </p> |
996 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1171 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
997 | <p>This class implements timer watchers/events. Time is represented as a |
1172 | <p>This class implements timer watchers/events. Time is represented as a |
998 | fractional number of seconds since the epoch. Example:</p> |
1173 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1064 | <pre> |
1239 | <pre> |
1065 | $term->{socket} = ... |
1240 | $term->{socket} = ... |
1066 | $term->{iow} = urxvt::iow |
1241 | $term->{iow} = urxvt::iow |
1067 | ->new |
1242 | ->new |
1068 | ->fd (fileno $term->{socket}) |
1243 | ->fd (fileno $term->{socket}) |
1069 | ->events (1) # wait for read data |
1244 | ->events (urxvt::EVENT_READ) |
1070 | ->start |
1245 | ->start |
1071 | ->cb (sub { |
1246 | ->cb (sub { |
1072 | my ($iow, $revents) = @_; |
1247 | my ($iow, $revents) = @_; |
1073 | # $revents must be 1 here, no need to check |
1248 | # $revents must be 1 here, no need to check |
1074 | sysread $term->{socket}, my $buf, 8192 |
1249 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1095 | </dd> |
1270 | </dd> |
1096 | <p></p> |
1271 | <p></p> |
1097 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1272 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1098 | </dt> |
1273 | </dt> |
1099 | <dd> |
1274 | <dd> |
1100 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1275 | Set the event mask to watch. The only allowed values are |
1101 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1276 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1277 | together, or <code>urxvt::EVENT_NONE</code>. |
1102 | </dd> |
1278 | </dd> |
1103 | <p></p> |
1279 | <p></p> |
1104 | <dt><strong>$iow = $iow->start</strong><br /> |
1280 | <dt><strong>$iow = $iow->start</strong><br /> |
1105 | </dt> |
1281 | </dt> |
1106 | <dd> |
1282 | <dd> |