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.15 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.24 by root, Wed Jan 11 02:13:56 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>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
30 </ul> 33 </ul>
… …
70thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
71<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
72scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
73<p> 76<p>
74</p> 77</p>
75<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
76<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
77find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
78<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
79<pre> 83<pre>
80 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
81<dl> 85<dl>
82<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
83</dt> 87</dt>
84<dd> 88<dd>
85Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
86the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click). Right now, it tries to
87urls and complete shell-quoted arguments, which is very convenient, too, 91select urls and complete shell-quoted arguments, which is very convenient,
88if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>.
89</dd>
90<dd> 93</dd>
94<dd>
91<p>It also offers the following bindable event:</p> 95<p>It also offers the following bindable keyboard command:</p>
92</dd> 96</dd>
93<dl> 97<dl>
94<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
95</dt> 99</dt>
96<dd> 100<dd>
… …
99<dd> 103<dd>
100<pre> 104<pre>
101 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 105 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
102</dd> 106</dd>
103<p></p></dl> 107<p></p></dl>
108<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
109</dt>
110<dd>
111Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
112runtime.
113</dd>
114<p></p>
115<dt><strong>selection-popup (enabled by default)</strong><br />
116</dt>
117<dd>
118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
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>
135</dd>
136<p></p>
104<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 />
105</dt> 138</dt>
106<dd> 139<dd>
107Displays a digital clock using the built-in overlay. 140Displays a digital clock using the built-in overlay.
108</dd> 141</dd>
109<p></p> 142<p></p>
110<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
111</dt> 144</dt>
112<dd> 145<dd>
113Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 146Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
147make them clickable. When clicked, the program specified in the resource
148<code>urlLauncher</code> (default <code>x-www-browser</code>) will be started.
114</dd> 149</dd>
115<p></p> 150<p></p>
116<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 151<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
117</dt> 152</dt>
118<dd> 153<dd>
… …
127Displays a very simple digital clock in the upper right corner of the 162Displays a very simple digital clock in the upper right corner of the
128window. Illustrates overwriting the refresh callbacks to create your own 163window. Illustrates overwriting the refresh callbacks to create your own
129overlays or changes. 164overlays or changes.
130</dd> 165</dd>
131<p></p></dl> 166<p></p></dl>
167<p>
168</p>
169<hr />
170<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
132<p> 171<p>
133</p> 172</p>
134<h2><a name="general_api_considerations">General API Considerations</a></h2> 173<h2><a name="general_api_considerations">General API Considerations</a></h2>
135<p>All objects (such as terminals, time watchers etc.) are typical 174<p>All objects (such as terminals, time watchers etc.) are typical
136reference-to-hash objects. The hash can be used to store anything you 175reference-to-hash objects. The hash can be used to store anything you
… …
146<dl> 185<dl>
147<dt><strong><a name="item__24text">$text</a></strong><br /> 186<dt><strong><a name="item__24text">$text</a></strong><br />
148</dt> 187</dt>
149<dd> 188<dd>
150Rxvt-unicodes special way of encoding text, where one ``unicode'' character 189Rxvt-unicodes special way of encoding text, where one ``unicode'' character
151always represents one screen cell. See <em>row_t</em> for a discussion of this format. 190always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
152</dd> 191</dd>
153<p></p> 192<p></p>
154<dt><strong><a name="item__24string">$string</a></strong><br /> 193<dt><strong><a name="item__24string">$string</a></strong><br />
155</dt> 194</dt>
156<dd> 195<dd>
… …
166locale-specific way. 205locale-specific way.
167</dd> 206</dd>
168<p></p></dl> 207<p></p></dl>
169<p> 208<p>
170</p> 209</p>
210<h2><a name="extension_objects">Extension Objects</a></h2>
211<p>Very perl extension is a perl class. A separate perl object is created
212for each terminal and each extension and passed as the first parameter to
213hooks. So extensions can use their <code>$self</code> object without having to think
214about other extensions, with the exception of methods and members that
215begin with an underscore character <code>_</code>: these are reserved for internal
216use.</p>
217<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
218<code>urxvt::term</code> class on this object.</p>
219<p>It has the following methods and data members:</p>
220<dl>
221<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
222</dt>
223<dd>
224Returns the <code>urxvt::term</code> object associated with this instance of the
225extension. This member <em>must not</em> be changed in any way.
226</dd>
227<p></p>
228<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
229</dt>
230<dd>
231Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
232this extension, replacing any previous hook. This is useful when you want
233to overwrite time-critical hooks only temporarily.
234</dd>
235<p></p>
236<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
237</dt>
238<dd>
239Dynamically disable the given hooks.
240</dd>
241<p></p></dl>
242<p>
243</p>
171<h2><a name="hooks">Hooks</a></h2> 244<h2><a name="hooks">Hooks</a></h2>
172<p>The following subroutines can be declared in extension files, and will be 245<p>The following subroutines can be declared in extension files, and will be
173called whenever the relevant event happens.</p> 246called whenever the relevant event happens.</p>
174<p>The first argument passed to them is an object private to each terminal 247<p>The first argument passed to them is an extension oject as described in
175and extension package. You can call all <code>urxvt::term</code> methods on it, but 248the in the <code>Extension Objects</code> section.</p>
176its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
177object that is shared between all packages is stored in the <code>term</code>
178member. It is, however, blessed intot he package of the extension script,
179so for all practical purposes you can treat an extension script as a class.</p>
180<p>All of them must return a boolean value. If it is true, then the event 249<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
181counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 250event counts as being <em>consumed</em>, and the invocation of other hooks is
182and the relevant action might not be carried out by the C++ code.</p> 251skipped, and the relevant action might not be carried out by the C++ code.</p>
183<p>When in doubt, return a false value (preferably <code>()</code>).</p> 252<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
184<dl> 253<dl>
185<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 254<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
186</dt> 255</dt>
187<dd> 256<dd>
188Called after a new terminal object has been initialized, but before 257Called after a new terminal object has been initialized, but before
… …
259</dd> 328</dd>
260<dd> 329<dd>
261<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 330<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
262$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 331$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
263number of lines that will be in the scrollback buffer.</p> 332number of lines that will be in the scrollback buffer.</p>
264</dd>
265<p></p>
266<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
267</dt>
268<dd>
269Called whenever the <code>program(s)</code> running in the urxvt window send output.
270</dd> 333</dd>
271<p></p> 334<p></p>
272<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 335<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
273</dt> 336</dt>
274<dd> 337<dd>
… …
293and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 356and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
294might be very slow, however, as your hook is called for <strong>all</strong> text being 357might be very slow, however, as your hook is called for <strong>all</strong> text being
295output. 358output.
296</dd> 359</dd>
297<p></p> 360<p></p>
361<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
362</dt>
363<dd>
364Called whenever some data is written to the tty/pty and can be used to
365suppress or filter tty input.
366</dd>
367<p></p>
298<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 368<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
299</dt> 369</dt>
300<dd> 370<dd>
301Called whenever a line was updated or changed. Can be used to filter 371Called whenever a line was updated or changed. Can be used to filter
302screen output (e.g. underline urls or other useless stuff). Only lines 372screen output (e.g. underline urls or other useless stuff). Only lines
… …
348<dd> 418<dd>
349Called wheneever the window loses keyboard focus, before rxvt-unicode does 419Called wheneever the window loses keyboard focus, before rxvt-unicode does
350focus out processing. 420focus out processing.
351</dd> 421</dd>
352<p></p> 422<p></p>
353<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 423<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
354</dt> 424</dt>
355<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 425<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
356</dt> 426</dt>
357<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 427<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
358</dt> 428</dt>
359<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 429<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
360</dt> 430</dt>
… …
383<p></p></dl> 453<p></p></dl>
384<p> 454<p>
385</p> 455</p>
386<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 456<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
387<dl> 457<dl>
458<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
459</dt>
460<dd>
461The rxvt-unicode library directory, where, among other things, the perl
462modules and scripts are stored.
463</dd>
464<p></p>
465<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
466</dt>
467<dd>
468The resource class and name rxvt-unicode uses to look up X resources.
469</dd>
470<p></p>
471<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
472</dt>
473<dd>
474The basename of the installed binaries, usually <code>urxvt</code>.
475</dd>
476<p></p>
388<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 477<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
389</dt> 478</dt>
390<dd> 479<dd>
391The current terminal. This variable stores the current <code>urxvt::term</code> 480The current terminal. This variable stores the current <code>urxvt::term</code>
392object, whenever a callback/hook is executing. 481object, whenever a callback/hook is executing.
… …
394<p></p></dl> 483<p></p></dl>
395<p> 484<p>
396</p> 485</p>
397<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>
398<dl> 487<dl>
399<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
400</dt>
401<dd>
402Creates a new terminal, very similar as if you had started it with
403<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
404if the new instance couldn't be created. Returns <code>undef</code> if the new
405instance didn't initialise perl, and the terminal object otherwise. The
406<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
407</dd>
408<p></p>
409<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 />
410</dt> 489</dt>
411<dd> 490<dd>
412Fatally aborts execution with the given error message. Avoid at all 491Fatally aborts execution with the given error message. Avoid at all
413costs! The only time this is acceptable is when the terminal process 492costs! The only time this is acceptable is when the terminal process
… …
423</dd> 502</dd>
424<dd> 503<dd>
425<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
426correct place, e.g. on stderr of the connecting urxvtc client.</p> 505correct place, e.g. on stderr of the connecting urxvtc client.</p>
427</dd> 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>
514Returns true when it is safe to do potentially unsafe things, such as
515evaluating perl code specified by the user. This is true when urxvt was
516started setuid or setgid.
517</dd>
428<p></p> 518<p></p>
429<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 />
430</dt> 520</dt>
431<dd> 521<dd>
432Returns the ``current time'' (as per the event loop). 522Returns the ``current time'' (as per the event loop).
… …
437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 527<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 528Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
439Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 529Button4Mask, Button5Mask, AnyModifier</a></strong><br />
440</dt> 530</dt>
441<dd> 531<dd>
442Various constants for use in X events. 532Various constants for use in X calls and event processing.
443</dd> 533</dd>
444<p></p></dl> 534<p></p></dl>
445<p> 535<p>
446</p> 536</p>
447<h2><a name="rendition">RENDITION</a></h2> 537<h2><a name="rendition">RENDITION</a></h2>
… …
479</dt> 569</dt>
480<dd> 570<dd>
481Return the foreground/background colour index, respectively. 571Return the foreground/background colour index, respectively.
482</dd> 572</dd>
483<p></p> 573<p></p>
484<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 />
485</dt> 575</dt>
486<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 />
487</dt> 577</dt>
488<dd> 578<dd>
489Replace the foreground/background colour in the rendition mask with the 579Replace the foreground/background colour in the rendition mask with the
490specified one. 580specified one.
491</dd> 581</dd>
492<p></p> 582<p></p>
493<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 />
494</dt> 584</dt>
495<dd> 585<dd>
496Return the ``custom'' value: Every rendition has 5 bits for use by 586Return the ``custom'' value: Every rendition has 5 bits for use by
497extensions. They can be set and changed as you like and are initially 587extensions. They can be set and changed as you like and are initially
498zero. 588zero.
499</dd> 589</dd>
500<p></p> 590<p></p>
501<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 />
502</dt> 592</dt>
503<dd> 593<dd>
504Change the custom value. 594Change the custom value.
505</dd> 595</dd>
506<p></p></dl> 596<p></p></dl>
507<p> 597<p>
508</p> 598</p>
599<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
600<p>The sole purpose of this class is to deliver an interface to the
601<code>AnyEvent</code> module - any module using it will work inside urxvt without
602further programming. The only exception is that you cannot wait on
603condition variables, but non-blocking condvar use is ok. What this means
604is that you cannot use blocking APIs, but the non-blocking variant should
605work.</p>
606<p>
607</p>
509<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>
510<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>
613Creates 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 <code>%ENV</code>-like
615hash 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
619couldn't be created. Returns <code>undef</code> if the new instance didn't
620initialise 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>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 624<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
512</dt> 625</dt>
513<dd> 626<dd>
514Destroy the terminal object (close the window, free resources etc.). 627Destroy the terminal object (close the window, free resources
628etc.). Please note that rxvt will not exit as long as any event
629watchers (timers, io watchers) are still active.
515</dd> 630</dd>
516<p></p> 631<p></p>
517<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 632<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
518</dt> 633</dt>
519<dd> 634<dd>
… …
575 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 690 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
576 shade term_name title transparent transparent_all tripleclickwords 691 shade term_name title transparent transparent_all tripleclickwords
577 utmpInhibit visualBell</pre> 692 utmpInhibit visualBell</pre>
578</dd> 693</dd>
579<p></p> 694<p></p>
695<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
696</dt>
697<dd>
698Returns the X-Resource for the given pattern, excluding the program or
699class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
700same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
701resource with that pattern exists.
702</dd>
703<dd>
704<p>This method should only be called during the <code>on_start</code> hook, as there is
705only one resource database per display, and later invocations might return
706the wrong resources.</p>
707</dd>
708<p></p>
709<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
710</dt>
711<dd>
712Adds a keymap translation exactly as specified via a resource. See the
713<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
714</dd>
715<p></p>
580<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 716<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
581</dt> 717</dt>
582<dd> 718<dd>
583Return and optionally change the current rendition. Text that is output by 719Return and optionally change the current rendition. Text that is output by
584the terminal application will use this style. 720the terminal application will use this style.
… …
612<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 748<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
613</dt> 749</dt>
614<dd> 750<dd>
615Return the current selection text and optionally replace it by <code>$newtext</code>. 751Return the current selection text and optionally replace it by <code>$newtext</code>.
616</dd> 752</dd>
753<p></p>
754<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
755</dt>
617<dd> 756<dd>
618<p>#=item $term-&gt;overlay ($x, $y, $text)
619#
620#Create a simple multi-line overlay box. See the next method for details. 757Create a simple multi-line overlay box. See the next method for details.
621#
622#=cut
623#
624#sub urxvt::term::scr_overlay {
625# my ($self, $x, $y, $text) = @_;
626#
627# my @lines = split /\n/, $text;
628#
629# my $w = 0;
630# for (map $self-&gt;strwidth ($_), @lines) {
631# $w = $_ if $w &lt; $_;
632# }
633#
634# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
635# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
636#}</p>
637</dd> 758</dd>
638<p></p> 759<p></p>
639<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 760<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
640</dt> 761</dt>
641<dd> 762<dd>
… …
677</dt> 798</dt>
678<dd> 799<dd>
679If hidden, display the overlay again. 800If hidden, display the overlay again.
680</dd> 801</dd>
681<p></p></dl> 802<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br /> 803<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
683</dt> 804</dt>
684<dd> 805<dd>
685Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 806Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
686<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, 807<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
687currently). 808currently).
… …
702<p></p> 823<p></p>
703<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 824<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
704</dt> 825</dt>
705<dd> 826<dd>
706Convert the given locale-encoded octets into a perl string. 827Convert the given locale-encoded octets into a perl string.
828</dd>
829<p></p>
830<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 />
831</dt>
832<dd>
833XORs the rendition values in the given span with the provided value
834(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
835to the selection.
836</dd>
837<p></p>
838<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 />
839</dt>
840<dd>
841Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
842whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
843to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
844it instead.
845</dd>
846<p></p>
847<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
848</dt>
849<dd>
850Ring the bell!
707</dd> 851</dd>
708<p></p> 852<p></p>
709<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 853<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
710</dt> 854</dt>
711<dd> 855<dd>
… …
734Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 878Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
735pass characters instead of octets, you should convert your strings first 879pass characters instead of octets, you should convert your strings first
736to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 880to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
737</dd> 881</dd>
738<p></p> 882<p></p>
883<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
884</dt>
885<dd>
886Replaces the event mask of the pty watcher by the given event mask. Can
887be used to suppress input and output handling to the pty/tty. See the
888description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
889the previous value.
890</dd>
891<p></p>
739<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 892<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
740</dt> 893</dt>
741<dd> 894<dd>
742Return the window id of the toplevel window. 895Return the window id of the toplevel window.
743</dd> 896</dd>
… …
772</dt> 925</dt>
773<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 926<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
774</dt> 927</dt>
775<dd> 928<dd>
776Return various integers describing terminal characteristics. 929Return various integers describing terminal characteristics.
930</dd>
931<p></p>
932<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
933</dt>
934<dd>
935Return the DISPLAY used by rxvt-unicode.
936</dd>
937<p></p>
938<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
939</dt>
940<dd>
941Returns the LC_CTYPE category string used by this rxvt-unicode.
942</dd>
943<p></p>
944<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
945</dt>
946<dd>
947Returns a copy of the environment in effect for the terminal as a hashref
948similar to <code>\%ENV</code>.
777</dd> 949</dd>
778<p></p> 950<p></p>
779<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 951<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
780</dt> 952</dt>
781<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 953<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
832<p>You have to obey this encoding when changing text. The advantage is 1004<p>You have to obey this encoding when changing text. The advantage is
833that <code>substr</code> and similar functions work on screen cells and not on 1005that <code>substr</code> and similar functions work on screen cells and not on
834characters.</p> 1006characters.</p>
835</dd> 1007</dd>
836<dd> 1008<dd>
837<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1009<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
838can be used to convert normal strings into this encoding and vice versa.</p> 1010can be used to convert normal strings into this encoding and vice versa.</p>
839</dd> 1011</dd>
840<p></p> 1012<p></p>
841<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1013<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
842</dt> 1014</dt>
… …
914</dt> 1086</dt>
915<dd> 1087<dd>
916Translates a string offset into terminal coordinates again. 1088Translates a string offset into terminal coordinates again.
917</dd> 1089</dd>
918<p></p></dl> 1090<p></p></dl>
919<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1091<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
920=item $text = $term-&gt;special_encode $string</strong><br />
921</dt> 1092</dt>
922<dd> 1093<dd>
923Converts a perl string into the special encoding used by rxvt-unicode, 1094Converts a perl string into the special encoding used by rxvt-unicode,
924where one character corresponds to one screen cell. See 1095where one character corresponds to one screen cell. See
925<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1096<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
929</dt> 1100</dt>
930<dd> 1101<dd>
931Converts rxvt-unicodes text reprsentation into a perl string. See 1102Converts rxvt-unicodes text reprsentation into a perl string. See
932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1103<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
933</dd> 1104</dd>
1105<p></p>
1106<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1107</dt>
1108<dd>
1109Registers a synchronous button grab. See the XGrabButton manpage.
1110</dd>
1111<p></p>
1112<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1113</dt>
1114<dd>
1115Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1116synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1117</dd>
1118<p></p>
1119<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1120</dt>
1121<dd>
1122Calls XAllowEvents with AsyncBoth for the most recent grab.
1123</dd>
1124<p></p>
1125<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1126</dt>
1127<dd>
1128Calls XAllowEvents with SyncBoth for the most recent grab.
1129</dd>
1130<p></p>
1131<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1132</dt>
1133<dd>
1134Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1135recent grab.
1136</dd>
1137<p></p>
1138<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1139</dt>
1140<dd>
1141Calls XUngrab for the most recent grab. Is called automatically on
1142evaluation errors, as it is better to lose the grab in the error case as
1143the session.
1144</dd>
934<p></p></dl> 1145<p></p></dl>
935<p> 1146<p>
936</p> 1147</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1148<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1149<dl>
1150<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1151</dt>
1152<dd>
1153Adds a non-clickable title to the popup.
1154</dd>
1155<p></p>
1156<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1157</dt>
1158<dd>
1159Creates a separator, optionally using the character given as <code>$sepchr</code>.
1160</dd>
1161<p></p>
1162<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1163</dt>
1164<dd>
1165Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1166selected.
1167</dd>
1168<p></p>
1169<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1170</dt>
1171<dd>
1172Adds a toggle/checkbox item to the popup. Teh callback gets called
1173whenever it gets toggled, with a boolean indicating its value as its first
1174argument.
1175</dd>
1176<p></p>
1177<dt><strong>$popup-&gt;show</strong><br />
1178</dt>
1179<dd>
1180Displays the popup (which is initially hidden).
1181</dd>
1182<p></p></dl>
938<p> 1183<p>
939</p> 1184</p>
940<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1185<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
941<p>This class implements timer watchers/events. Time is represented as a 1186<p>This class implements timer watchers/events. Time is represented as a
942fractional number of seconds since the epoch. Example:</p> 1187fractional number of seconds since the epoch. Example:</p>
… …
1008<pre> 1253<pre>
1009 $term-&gt;{socket} = ... 1254 $term-&gt;{socket} = ...
1010 $term-&gt;{iow} = urxvt::iow 1255 $term-&gt;{iow} = urxvt::iow
1011 -&gt;new 1256 -&gt;new
1012 -&gt;fd (fileno $term-&gt;{socket}) 1257 -&gt;fd (fileno $term-&gt;{socket})
1013 -&gt;events (1) # wait for read data 1258 -&gt;events (urxvt::EVENT_READ)
1014 -&gt;start 1259 -&gt;start
1015 -&gt;cb (sub { 1260 -&gt;cb (sub {
1016 my ($iow, $revents) = @_; 1261 my ($iow, $revents) = @_;
1017 # $revents must be 1 here, no need to check 1262 # $revents must be 1 here, no need to check
1018 sysread $term-&gt;{socket}, my $buf, 8192 1263 sysread $term-&gt;{socket}, my $buf, 8192
… …
1039</dd> 1284</dd>
1040<p></p> 1285<p></p>
1041<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1286<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1042</dt> 1287</dt>
1043<dd> 1288<dd>
1044Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1289Set the event mask to watch. The only allowed values are
1045data, Bit #1 (value <code>2</code>) enables watching for write data. 1290<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1291together, or <code>urxvt::EVENT_NONE</code>.
1046</dd> 1292</dd>
1047<p></p> 1293<p></p>
1048<dt><strong>$iow = $iow-&gt;start</strong><br /> 1294<dt><strong>$iow = $iow-&gt;start</strong><br />
1049</dt> 1295</dt>
1050<dd> 1296<dd>
… …
1065</p> 1311</p>
1066<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1312<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1067<p>This variable controls the verbosity level of the perl extension. Higher 1313<p>This variable controls the verbosity level of the perl extension. Higher
1068numbers indicate more verbose output.</p> 1314numbers indicate more verbose output.</p>
1069<dl> 1315<dl>
1070<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1316<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1071</dt> 1317</dt>
1072<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1318<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1073</dt> 1319</dt>
1074<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1320<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1075</dt> 1321</dt>
1076</dl> 1322</dl>
1077<p> 1323<p>
1078</p> 1324</p>
1079<hr /> 1325<hr />

Diff Legend

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