ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.18 by root, Mon Jan 9 07:17:24 2006 UTC vs.
Revision 1.23 by root, Wed Jan 11 01:01:52 2006 UTC

… …
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>
… …
71thus must be encoded as UTF-8.</p> 73thus 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
73scripts will be shared (but not enabled) for all terminals.</p> 75scripts 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
78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find 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 &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</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>
86Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
87the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click). Right now, it tries to
88urls and complete shell-quoted arguments, which is very convenient, too, 91select urls and complete shell-quoted arguments, which is very convenient,
89if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92too, 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>
115Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
116text into various other formats/action. 119text into various other formats/action (such as uri unescaping, perl
120evalution, 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&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt>
125<dd>
126Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal
128input/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
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns 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>
… …
142Displays a very simple digital clock in the upper right corner of the 160Displays a very simple digital clock in the upper right corner of the
143window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
144overlays or changes. 162overlays 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
151reference-to-hash objects. The hash can be used to store anything you 173reference-to-hash objects. The hash can be used to store anything you
… …
161<dl> 183<dl>
162<dt><strong><a name="item__24text">$text</a></strong><br /> 184<dt><strong><a name="item__24text">$text</a></strong><br />
163</dt> 185</dt>
164<dd> 186<dd>
165Rxvt-unicodes special way of encoding text, where one ``unicode'' character 187Rxvt-unicodes special way of encoding text, where one ``unicode'' character
166always represents one screen cell. See <em>row_t</em> for a discussion of this format. 188always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
167</dd> 189</dd>
168<p></p> 190<p></p>
169<dt><strong><a name="item__24string">$string</a></strong><br /> 191<dt><strong><a name="item__24string">$string</a></strong><br />
170</dt> 192</dt>
171<dd> 193<dd>
… …
181locale-specific way. 203locale-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
210for each terminal and each extension and passed as the first parameter to
211hooks. So extensions can use their <code>$self</code> object without having to think
212about other extensions, with the exception of methods and members that
213begin with an underscore character <code>_</code>: these are reserved for internal
214use.</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-&gt;{term}</a></strong><br />
220</dt>
221<dd>
222Returns the <code>urxvt::term</code> object associated with this instance of the
223extension. This member <em>must not</em> be changed in any way.
224</dd>
225<p></p>
226<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
227</dt>
228<dd>
229Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
230this extension, replacing any previous hook. This is useful when you want
231to overwrite time-critical hooks only temporarily.
232</dd>
233<p></p>
234<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
235</dt>
236<dd>
237Dynamically 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
188called whenever the relevant event happens.</p> 244called 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
190and extension package. You can call all <code>urxvt::term</code> methods on it, but 246the in the <code>Extension Objects</code> section.</p>
191its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
192object that is shared between all packages is stored in the <code>term</code>
193member. It is, however, blessed intot he package of the extension script,
194so 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
196counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 248event counts as being <em>consumed</em>, and the invocation of other hooks is
197and the relevant action might not be carried out by the C++ code.</p> 249skipped, 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>&gt;</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>
203Called after a new terminal object has been initialized, but before 255Called after a new terminal object has been initialized, but before
… …
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 354and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
303might be very slow, however, as your hook is called for <strong>all</strong> text being 355might be very slow, however, as your hook is called for <strong>all</strong> text being
304output. 356output.
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>
362Called whenever some data is written to the tty/pty and can be used to
363suppress 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>
310Called whenever a line was updated or changed. Can be used to filter 369Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines 370screen output (e.g. underline urls or other useless stuff). Only lines
… …
357<dd> 416<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does 417Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing. 418focus 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>
459The rxvt-unicode library directory, where, among other things, the perl
460modules 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>
466The 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>
472The 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>
400The current terminal. This variable stores the current <code>urxvt::term</code> 478The current terminal. This variable stores the current <code>urxvt::term</code>
401object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
… …
403<p></p></dl> 481<p></p></dl>
404<p> 482<p>
405</p> 483</p>
406<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 484<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
407<dl> 485<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>
411Creates 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)
413if the new instance couldn't be created. Returns <code>undef</code> if the new
414instance 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 /> 486<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
419</dt> 487</dt>
420<dd> 488<dd>
421Fatally aborts execution with the given error message. Avoid at all 489Fatally aborts execution with the given error message. Avoid at all
422costs! The only time this is acceptable is when the terminal process 490costs! The only time this is acceptable is when the terminal process
… …
431that calls this function. 499that calls this function.
432</dd> 500</dd>
433<dd> 501<dd>
434<p>Using this function has the advantage that its output ends up in the 502<p>Using this function has the advantage that its output ends up in the
435correct place, e.g. on stderr of the connecting urxvtc client.</p> 503correct place, e.g. on stderr of the connecting urxvtc client.</p>
504</dd>
505<dd>
506<p>Messages have a size limit of 1023 bytes currently.</p>
436</dd> 507</dd>
437<p></p> 508<p></p>
438<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 509<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
439</dt> 510</dt>
440<dd> 511<dd>
… …
496</dt> 567</dt>
497<dd> 568<dd>
498Return the foreground/background colour index, respectively. 569Return the foreground/background colour index, respectively.
499</dd> 570</dd>
500<p></p> 571<p></p>
501<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 572<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
502</dt> 573</dt>
503<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 574<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
504</dt> 575</dt>
505<dd> 576<dd>
506Replace the foreground/background colour in the rendition mask with the 577Replace the foreground/background colour in the rendition mask with the
507specified one. 578specified one.
508</dd> 579</dd>
509<p></p> 580<p></p>
510<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 581<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
511</dt> 582</dt>
512<dd> 583<dd>
513Return the ``custom'' value: Every rendition has 5 bits for use by 584Return the ``custom'' value: Every rendition has 5 bits for use by
514extensions. They can be set and changed as you like and are initially 585extensions. They can be set and changed as you like and are initially
515zero. 586zero.
516</dd> 587</dd>
517<p></p> 588<p></p>
518<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 589<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
519</dt> 590</dt>
520<dd> 591<dd>
521Change the custom value. 592Change the custom value.
522</dd> 593</dd>
523<p></p></dl> 594<p></p></dl>
524<p> 595<p>
525</p> 596</p>
526<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 597<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
527<p>The sole purpose of this class is to deliver an interface to the 598<p>The sole purpose of this class is to deliver an interface to the
528<code>AnyEvent</code> module - any module using it will work inside urxvt without 599<code>AnyEvent</code> module - any module using it will work inside urxvt without
529further work. The only exception is that you cannot wait on condition 600further programming. The only exception is that you cannot wait on
530variables, but non-blocking condvar use is ok. What this means is that you 601condition variables, but non-blocking condvar use is ok. What this means
531cannot use blocking APIs, but the non-blocking variant should work.</p> 602is that you cannot use blocking APIs, but the non-blocking variant should
603work.</p>
532<p> 604<p>
533</p> 605</p>
534<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 606<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
535<dl> 607<dl>
608<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
609</dt>
610<dd>
611Creates a new terminal, very similar as if you had started it with system
612<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
613hash which defines the environment of the new terminal.
614</dd>
615<dd>
616<p>Croaks (and probably outputs an error message) if the new instance
617couldn't be created. Returns <code>undef</code> if the new instance didn't
618initialise perl, and the terminal object otherwise. The <code>init</code> and
619<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
620</dd>
621<p></p>
536<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 622<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
537</dt> 623</dt>
538<dd> 624<dd>
539Destroy the terminal object (close the window, free resources etc.). 625Destroy the terminal object (close the window, free resources
626etc.). Please note that rxvt will not exit as long as any event
627watchers (timers, io watchers) are still active.
540</dd> 628</dd>
541<p></p> 629<p></p>
542<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 630<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
543</dt> 631</dt>
544<dd> 632<dd>
… …
600 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 688 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
601 shade term_name title transparent transparent_all tripleclickwords 689 shade term_name title transparent transparent_all tripleclickwords
602 utmpInhibit visualBell</pre> 690 utmpInhibit visualBell</pre>
603</dd> 691</dd>
604<p></p> 692<p></p>
693<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
694</dt>
695<dd>
696Adds a keymap translation exactly as specified via a resource. See the
697<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
698</dd>
699<p></p>
605<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 700<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
606</dt> 701</dt>
607<dd> 702<dd>
608Return and optionally change the current rendition. Text that is output by 703Return and optionally change the current rendition. Text that is output by
609the terminal application will use this style. 704the terminal application will use this style.
… …
637<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 732<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
638</dt> 733</dt>
639<dd> 734<dd>
640Return the current selection text and optionally replace it by <code>$newtext</code>. 735Return the current selection text and optionally replace it by <code>$newtext</code>.
641</dd> 736</dd>
737<p></p>
738<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
739</dt>
642<dd> 740<dd>
643<p>#=item $term-&gt;overlay ($x, $y, $text)
644#
645#Create a simple multi-line overlay box. See the next method for details. 741Create a simple multi-line overlay box. See the next method for details.
646#
647#=cut
648#
649#sub urxvt::term::scr_overlay {
650# my ($self, $x, $y, $text) = @_;
651#
652# my @lines = split /\n/, $text;
653#
654# my $w = 0;
655# for (map $self-&gt;strwidth ($_), @lines) {
656# $w = $_ if $w &lt; $_;
657# }
658#
659# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
660# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
661#}</p>
662</dd> 742</dd>
663<p></p> 743<p></p>
664<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 744<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
665</dt> 745</dt>
666<dd> 746<dd>
… …
727<p></p> 807<p></p>
728<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 808<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
729</dt> 809</dt>
730<dd> 810<dd>
731Convert the given locale-encoded octets into a perl string. 811Convert the given locale-encoded octets into a perl string.
812</dd>
813<p></p>
814<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
815</dt>
816<dd>
817XORs the rendition values in the given span with the provided value
818(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
819to the selection.
820</dd>
821<p></p>
822<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
823</dt>
824<dd>
825Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
826whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
827to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
828it instead.
829</dd>
830<p></p>
831<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
832</dt>
833<dd>
834Ring the bell!
732</dd> 835</dd>
733<p></p> 836<p></p>
734<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 837<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
735</dt> 838</dt>
736<dd> 839<dd>
… …
759Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 862Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
760pass characters instead of octets, you should convert your strings first 863pass characters instead of octets, you should convert your strings first
761to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 864to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
762</dd> 865</dd>
763<p></p> 866<p></p>
867<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
868</dt>
869<dd>
870Replaces the event mask of the pty watcher by the given event mask. Can
871be used to suppress input and output handling to the pty/tty. See the
872description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
873the previous value.
874</dd>
875<p></p>
764<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 876<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
765</dt> 877</dt>
766<dd> 878<dd>
767Return the window id of the toplevel window. 879Return the window id of the toplevel window.
768</dd> 880</dd>
… …
797</dt> 909</dt>
798<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 910<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
799</dt> 911</dt>
800<dd> 912<dd>
801Return various integers describing terminal characteristics. 913Return various integers describing terminal characteristics.
914</dd>
915<p></p>
916<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
917</dt>
918<dd>
919Return the DISPLAY used by rxvt-unicode.
920</dd>
921<p></p>
922<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
923</dt>
924<dd>
925Returns the LC_CTYPE category string used by this rxvt-unicode.
926</dd>
927<p></p>
928<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
929</dt>
930<dd>
931Returns a copy of the environment in effect for the terminal as a hashref
932similar to <code>\%ENV</code>.
802</dd> 933</dd>
803<p></p> 934<p></p>
804<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 935<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
805</dt> 936</dt>
806<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 937<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
997</dd> 1128</dd>
998<p></p></dl> 1129<p></p></dl>
999<p> 1130<p>
1000</p> 1131</p>
1001<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1132<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1133<dl>
1134<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1135</dt>
1136<dd>
1137Adds a non-clickable title to the popup.
1138</dd>
1139<p></p>
1140<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1141</dt>
1142<dd>
1143Creates a separator, optionally using the character given as <code>$sepchr</code>.
1144</dd>
1145<p></p>
1146<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1147</dt>
1148<dd>
1149Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1150selected.
1151</dd>
1152<p></p>
1153<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1154</dt>
1155<dd>
1156Adds a toggle/checkbox item to the popup. Teh callback gets called
1157whenever it gets toggled, with a boolean indicating its value as its first
1158argument.
1159</dd>
1160<p></p>
1161<dt><strong>$popup-&gt;show</strong><br />
1162</dt>
1163<dd>
1164Displays the popup (which is initially hidden).
1165</dd>
1166<p></p></dl>
1002<p> 1167<p>
1003</p> 1168</p>
1004<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1169<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1005<p>This class implements timer watchers/events. Time is represented as a 1170<p>This class implements timer watchers/events. Time is represented as a
1006fractional number of seconds since the epoch. Example:</p> 1171fractional number of seconds since the epoch. Example:</p>
… …
1072<pre> 1237<pre>
1073 $term-&gt;{socket} = ... 1238 $term-&gt;{socket} = ...
1074 $term-&gt;{iow} = urxvt::iow 1239 $term-&gt;{iow} = urxvt::iow
1075 -&gt;new 1240 -&gt;new
1076 -&gt;fd (fileno $term-&gt;{socket}) 1241 -&gt;fd (fileno $term-&gt;{socket})
1077 -&gt;events (1) # wait for read data 1242 -&gt;events (urxvt::EVENT_READ)
1078 -&gt;start 1243 -&gt;start
1079 -&gt;cb (sub { 1244 -&gt;cb (sub {
1080 my ($iow, $revents) = @_; 1245 my ($iow, $revents) = @_;
1081 # $revents must be 1 here, no need to check 1246 # $revents must be 1 here, no need to check
1082 sysread $term-&gt;{socket}, my $buf, 8192 1247 sysread $term-&gt;{socket}, my $buf, 8192
… …
1103</dd> 1268</dd>
1104<p></p> 1269<p></p>
1105<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1270<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1106</dt> 1271</dt>
1107<dd> 1272<dd>
1108Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1273Set the event mask to watch. The only allowed values are
1109data, Bit #1 (value <code>2</code>) enables watching for write data. 1274<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1275together, or <code>urxvt::EVENT_NONE</code>.
1110</dd> 1276</dd>
1111<p></p> 1277<p></p>
1112<dt><strong>$iow = $iow-&gt;start</strong><br /> 1278<dt><strong>$iow = $iow-&gt;start</strong><br />
1113</dt> 1279</dt>
1114<dd> 1280<dd>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines