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.14 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.21 by root, Tue Jan 10 19:46:28 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>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
27 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
28 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29 </ul> 33 </ul>
30 34
31 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 66<p>
63</p> 67</p>
64<hr /> 68<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
68<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
70<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
71scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
72<p> 76<p>
73</p> 77</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
75<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
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
78<pre> 83<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 85<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 87</dt>
83<dd> 88<dd>
84Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
85the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click). Right now, it tries to
86urls and complete shell-quoted arguments, which is very convenient, too, 91select urls and complete shell-quoted arguments, which is very convenient,
87if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>.
88</dd>
89<dd> 93</dd>
94<dd>
90<p>It also offers the following bindable event:</p> 95<p>It also offers the following bindable keyboard command:</p>
91</dd> 96</dd>
92<dl> 97<dl>
93<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
94</dt> 99</dt>
95<dd> 100<dd>
… …
98<dd> 103<dd>
99<pre> 104<pre>
100 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 105 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
101</dd> 106</dd>
102<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>
103<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 />
104</dt> 138</dt>
105<dd> 139<dd>
106Displays a digital clock using the built-in overlay. 140Displays a digital clock using the built-in overlay.
107</dd> 141</dd>
… …
126Displays 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
127window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
128overlays or changes. 162overlays or changes.
129</dd> 163</dd>
130<p></p></dl> 164<p></p></dl>
165<p>
166</p>
167<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
131<p> 169<p>
132</p> 170</p>
133<h2><a name="general_api_considerations">General API Considerations</a></h2> 171<h2><a name="general_api_considerations">General API Considerations</a></h2>
134<p>All objects (such as terminals, time watchers etc.) are typical 172<p>All objects (such as terminals, time watchers etc.) are typical
135reference-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
… …
165locale-specific way. 203locale-specific way.
166</dd> 204</dd>
167<p></p></dl> 205<p></p></dl>
168<p> 206<p>
169</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>
170<h2><a name="hooks">Hooks</a></h2> 242<h2><a name="hooks">Hooks</a></h2>
171<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
172called whenever the relevant event happens.</p> 244called whenever the relevant event happens.</p>
173<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
174and extension package. You can call all <code>urxvt::term</code> methods on it, but 246the in the <code>Extension Objects</code> section.</p>
175its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
176object that is shared between all packages is stored in the <code>term</code>
177member.</p>
178<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
179counts 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
180and 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>
181<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>
182<dl> 251<dl>
183<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 />
184</dt> 253</dt>
185<dd> 254<dd>
186Called after a new terminal object has been initialized, but before 255Called after a new terminal object has been initialized, but before
… …
238</dd> 307</dd>
239<dd> 308<dd>
240<p>See the <em>selection</em> example extension.</p> 309<p>See the <em>selection</em> example extension.</p>
241</dd> 310</dd>
242<p></p> 311<p></p>
243<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
244</dt>
245<dd>
246Called whenever the window gets the keyboard focus, before urxvt does
247focus in processing.
248</dd>
249<p></p>
250<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
251</dt>
252<dd>
253Called wheneever the window loses keyboard focus, before urxvt does focus
254out processing.
255</dd>
256<p></p>
257<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 312<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
258</dt> 313</dt>
259<dd> 314<dd>
260Called whenever the view offset changes, i..e the user or program 315Called whenever the view offset changes, i..e the user or program
261scrolls. Offset <code>0</code> means display the normal terminal, positive values 316scrolls. Offset <code>0</code> means display the normal terminal, positive values
… …
271</dd> 326</dd>
272<dd> 327<dd>
273<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 328<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
274$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 329$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
275number of lines that will be in the scrollback buffer.</p> 330number of lines that will be in the scrollback buffer.</p>
276</dd>
277<p></p>
278<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
279</dt>
280<dd>
281Called whenever the <code>program(s)</code> running in the urxvt window send output.
282</dd> 331</dd>
283<p></p> 332<p></p>
284<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 333<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
285</dt> 334</dt>
286<dd> 335<dd>
… …
305and 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
306might 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
307output. 356output.
308</dd> 357</dd>
309<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>
310<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 />
311</dt> 367</dt>
312<dd> 368<dd>
313Called 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
314screen output (e.g. underline urls or other useless stuff). Only lines 370screen output (e.g. underline urls or other useless stuff). Only lines
… …
346Called whenever the user presses a key combination that has a 402Called whenever the user presses a key combination that has a
347<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 403<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
348resource in the <code>rxvt(1)</code> manpage). 404resource in the <code>rxvt(1)</code> manpage).
349</dd> 405</dd>
350<p></p> 406<p></p>
407<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
408</dt>
409<dd>
410Called whenever the window gets the keyboard focus, before rxvt-unicode
411does focus in processing.
412</dd>
413<p></p>
414<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
415</dt>
416<dd>
417Called wheneever the window loses keyboard focus, before rxvt-unicode does
418focus out processing.
419</dd>
420<p></p>
351<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 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 />
352</dt> 422</dt>
353<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 />
354</dt> 424</dt>
355<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 />
356</dt> 426</dt>
357<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 />
358</dt> 428</dt>
359<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> 429<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
430</dt>
431<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
432</dt>
433<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
360</dt> 434</dt>
361<dd> 435<dd>
362Called whenever the corresponding X event is received for the terminal If 436Called whenever the corresponding X event is received for the terminal If
363the hook returns true, then the even will be ignored by rxvt-unicode. 437the hook returns true, then the even will be ignored by rxvt-unicode.
364</dd> 438</dd>
… …
377<p></p></dl> 451<p></p></dl>
378<p> 452<p>
379</p> 453</p>
380<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>
381<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>
382<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 />
383</dt> 476</dt>
384<dd> 477<dd>
385The current terminal. This variable stores the current <code>urxvt::term</code> 478The current terminal. This variable stores the current <code>urxvt::term</code>
386object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
387</dd> 480</dd>
388<p></p></dl> 481<p></p>
482<dt></dt>
483</dl>
389<p> 484<p>
390</p> 485</p>
391<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>
392<dl> 487<dl>
393<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> 488<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
… …
418<dd> 513<dd>
419<p>Using this function has the advantage that its output ends up in the 514<p>Using this function has the advantage that its output ends up in the
420correct place, e.g. on stderr of the connecting urxvtc client.</p> 515correct place, e.g. on stderr of the connecting urxvtc client.</p>
421</dd> 516</dd>
422<p></p> 517<p></p>
518<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519</dt>
520<dd>
521Returns true when it is safe to do potentially unsafe things, such as
522evaluating perl code specified by the user. This is true when urxvt was
523started setuid or setgid.
524</dd>
525<p></p>
423<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 526<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
424</dt> 527</dt>
425<dd> 528<dd>
426Returns the ``current time'' (as per the event loop). 529Returns the ``current time'' (as per the event loop).
530</dd>
531<p></p>
532<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
533</dt>
534<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
535Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
536Button4Mask, Button5Mask, AnyModifier</a></strong><br />
537</dt>
538<dd>
539Various constants for use in X calls and event processing.
427</dd> 540</dd>
428<p></p></dl> 541<p></p></dl>
429<p> 542<p>
430</p> 543</p>
431<h2><a name="rendition">RENDITION</a></h2> 544<h2><a name="rendition">RENDITION</a></h2>
… …
463</dt> 576</dt>
464<dd> 577<dd>
465Return the foreground/background colour index, respectively. 578Return the foreground/background colour index, respectively.
466</dd> 579</dd>
467<p></p> 580<p></p>
468<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 581<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
469</dt> 582</dt>
470<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 583<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
471</dt> 584</dt>
472<dd> 585<dd>
473Replace the foreground/background colour in the rendition mask with the 586Replace the foreground/background colour in the rendition mask with the
474specified one. 587specified one.
475</dd> 588</dd>
476<p></p> 589<p></p>
477<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 590<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
478</dt> 591</dt>
479<dd> 592<dd>
480Return the ``custom'' value: Every rendition has 5 bits for use by 593Return the ``custom'' value: Every rendition has 5 bits for use by
481extensions. They can be set and changed as you like and are initially 594extensions. They can be set and changed as you like and are initially
482zero. 595zero.
483</dd> 596</dd>
484<p></p> 597<p></p>
485<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 598<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
486</dt> 599</dt>
487<dd> 600<dd>
488Change the custom value. 601Change the custom value.
489</dd> 602</dd>
490<p></p></dl> 603<p></p></dl>
491<p> 604<p>
492</p> 605</p>
606<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
607<p>The sole purpose of this class is to deliver an interface to the
608<code>AnyEvent</code> module - any module using it will work inside urxvt without
609further programming. The only exception is that you cannot wait on
610condition variables, but non-blocking condvar use is ok. What this means
611is that you cannot use blocking APIs, but the non-blocking variant should
612work.</p>
613<p>
614</p>
493<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 615<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
494<dl> 616<dl>
495<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
496</dt> 618</dt>
497<dd> 619<dd>
498Destroy the terminal object (close the window, free resources etc.). 620Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event
622watchers (timers, io watchers) are still active.
623</dd>
624<p></p>
625<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
626</dt>
627<dd>
628Returns true if the option specified by <code>$optval</code> is enabled, and
629optionally change it. All option values are stored by name in the hash
630<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
631</dd>
632<dd>
633<p>Here is a a likely non-exhaustive list of option names, please see the
634source file <em>/src/optinc.h</em> to see the actual list:</p>
635</dd>
636<dd>
637<pre>
638 borderLess console cursorBlink cursorUnderline hold iconic insecure
639 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
640 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
641 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
642 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
643 tripleclickwords utmpInhibit visualBell</pre>
499</dd> 644</dd>
500<p></p> 645<p></p>
501<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 646<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
502</dt> 647</dt>
503<dd> 648<dd>
… …
519<p>Please note that resource strings will currently only be freed when the 664<p>Please note that resource strings will currently only be freed when the
520terminal is destroyed, so changing options frequently will eat memory.</p> 665terminal is destroyed, so changing options frequently will eat memory.</p>
521</dd> 666</dd>
522<dd> 667<dd>
523<p>Here is a a likely non-exhaustive list of resource names, not all of which 668<p>Here is a a likely non-exhaustive list of resource names, not all of which
524are supported in every build, please see the source to see the actual 669are supported in every build, please see the source file <em>/src/rsinc.h</em>
525list:</p> 670to see the actual list:</p>
526</dd> 671</dd>
527<dd> 672<dd>
528<pre> 673<pre>
529 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 674 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
530 borderLess color cursorBlink cursorUnderline cutchars delete_key 675 borderLess color cursorBlink cursorUnderline cutchars delete_key
… …
538 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 683 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
539 shade term_name title transparent transparent_all tripleclickwords 684 shade term_name title transparent transparent_all tripleclickwords
540 utmpInhibit visualBell</pre> 685 utmpInhibit visualBell</pre>
541</dd> 686</dd>
542<p></p> 687<p></p>
688<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
689</dt>
690<dd>
691Adds a keymap translation exactly as specified via a resource. See the
692<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
693</dd>
694<p></p>
543<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 695<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
544</dt> 696</dt>
545<dd> 697<dd>
546Return and optionally change the current rendition. Text that is output by 698Return and optionally change the current rendition. Text that is output by
547the terminal application will use this style. 699the terminal application will use this style.
… …
575<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 727<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
576</dt> 728</dt>
577<dd> 729<dd>
578Return the current selection text and optionally replace it by <code>$newtext</code>. 730Return the current selection text and optionally replace it by <code>$newtext</code>.
579</dd> 731</dd>
732<p></p>
733<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
734</dt>
580<dd> 735<dd>
581<p>#=item $term-&gt;overlay ($x, $y, $text)
582#
583#Create a simple multi-line overlay box. See the next method for details. 736Create a simple multi-line overlay box. See the next method for details.
584#
585#=cut
586#
587#sub urxvt::term::scr_overlay {
588# my ($self, $x, $y, $text) = @_;
589#
590# my @lines = split /\n/, $text;
591#
592# my $w = 0;
593# for (map $self-&gt;strwidth ($_), @lines) {
594# $w = $_ if $w &lt; $_;
595# }
596#
597# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
598# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
599#}</p>
600</dd> 737</dd>
601<p></p> 738<p></p>
602<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 739<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
603</dt> 740</dt>
604<dd> 741<dd>
… …
640</dt> 777</dt>
641<dd> 778<dd>
642If hidden, display the overlay again. 779If hidden, display the overlay again.
643</dd> 780</dd>
644<p></p></dl> 781<p></p></dl>
782<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
783</dt>
784<dd>
785Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
786<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
787currently).
788</dd>
789<p></p>
645<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br /> 790<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
646</dt> 791</dt>
647<dd> 792<dd>
648Returns the number of screen-cells this string would need. Correctly 793Returns the number of screen-cells this string would need. Correctly
649accounts for wide and combining characters. 794accounts for wide and combining characters.
… …
657<p></p> 802<p></p>
658<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 803<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
659</dt> 804</dt>
660<dd> 805<dd>
661Convert the given locale-encoded octets into a perl string. 806Convert the given locale-encoded octets into a perl string.
807</dd>
808<p></p>
809<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 />
810</dt>
811<dd>
812XORs the rendition values in the given span with the provided value
813(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
814to the selection.
815</dd>
816<p></p>
817<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 />
818</dt>
819<dd>
820Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
821whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
822to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
823it instead.
824</dd>
825<p></p>
826<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
827</dt>
828<dd>
829Ring the bell!
662</dd> 830</dd>
663<p></p> 831<p></p>
664<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 832<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
665</dt> 833</dt>
666<dd> 834<dd>
… …
689Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 857Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
690pass characters instead of octets, you should convert your strings first 858pass characters instead of octets, you should convert your strings first
691to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 859to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
692</dd> 860</dd>
693<p></p> 861<p></p>
862<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
863</dt>
864<dd>
865Replaces the event mask of the pty watcher by the given event mask. Can
866be used to suppress input and output handling to the pty/tty. See the
867description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
868the previous value.
869</dd>
870<p></p>
694<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 871<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
695</dt> 872</dt>
696<dd> 873<dd>
697Return the window id of the toplevel window. 874Return the window id of the toplevel window.
698</dd> 875</dd>
… …
727</dt> 904</dt>
728<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 905<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
729</dt> 906</dt>
730<dd> 907<dd>
731Return various integers describing terminal characteristics. 908Return various integers describing terminal characteristics.
909</dd>
910<p></p>
911<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912</dt>
913<dd>
914Returns the LC_CTYPE category string used by this rxvt-unicode.
915</dd>
916<p></p>
917<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
918</dt>
919<dd>
920Return the DISPLAY used by rxvt-unicode.
921</dd>
922<p></p>
923<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
924</dt>
925<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
926</dt>
927<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
928</dt>
929<dd>
930Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
931AltGr), the meta key (often Alt) and the num lock key, if applicable.
732</dd> 932</dd>
733<p></p> 933<p></p>
734<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 934<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
735</dt> 935</dt>
736<dd> 936<dd>
… …
776<p>You have to obey this encoding when changing text. The advantage is 976<p>You have to obey this encoding when changing text. The advantage is
777that <code>substr</code> and similar functions work on screen cells and not on 977that <code>substr</code> and similar functions work on screen cells and not on
778characters.</p> 978characters.</p>
779</dd> 979</dd>
780<dd> 980<dd>
781<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 981<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>
782can be used to convert normal strings into this encoding and vice versa.</p> 982can be used to convert normal strings into this encoding and vice versa.</p>
783</dd> 983</dd>
784<p></p> 984<p></p>
785<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 985<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
786</dt> 986</dt>
… …
858</dt> 1058</dt>
859<dd> 1059<dd>
860Translates a string offset into terminal coordinates again. 1060Translates a string offset into terminal coordinates again.
861</dd> 1061</dd>
862<p></p></dl> 1062<p></p></dl>
863<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1063<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
864=item $text = $term-&gt;special_encode $string</strong><br />
865</dt> 1064</dt>
866<dd> 1065<dd>
867Converts a perl string into the special encoding used by rxvt-unicode, 1066Converts a perl string into the special encoding used by rxvt-unicode,
868where one character corresponds to one screen cell. See 1067where one character corresponds to one screen cell. See
869<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1068<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
872<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1071<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
873</dt> 1072</dt>
874<dd> 1073<dd>
875Converts rxvt-unicodes text reprsentation into a perl string. See 1074Converts rxvt-unicodes text reprsentation into a perl string. See
876<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1075<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1076</dd>
1077<p></p>
1078<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1079</dt>
1080<dd>
1081Registers a synchronous button grab. See the XGrabButton manpage.
1082</dd>
1083<p></p>
1084<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1085</dt>
1086<dd>
1087Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1088synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1089</dd>
1090<p></p>
1091<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1092</dt>
1093<dd>
1094Calls XAllowEvents with AsyncBoth for the most recent grab.
1095</dd>
1096<p></p>
1097<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1098</dt>
1099<dd>
1100Calls XAllowEvents with SyncBoth for the most recent grab.
1101</dd>
1102<p></p>
1103<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1104</dt>
1105<dd>
1106Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1107recent grab.
1108</dd>
1109<p></p>
1110<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1111</dt>
1112<dd>
1113Calls XUngrab for the most recent grab. Is called automatically on
1114evaluation errors, as it is better to lose the grab in the error case as
1115the session.
1116</dd>
1117<p></p></dl>
1118<p>
1119</p>
1120<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1121<dl>
1122<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1123</dt>
1124<dd>
1125Adds a non-clickable title to the popup.
1126</dd>
1127<p></p>
1128<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1129</dt>
1130<dd>
1131Creates a separator, optionally using the character given as <code>$sepchr</code>.
1132</dd>
1133<p></p>
1134<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1135</dt>
1136<dd>
1137Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1138selected.
1139</dd>
1140<p></p>
1141<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1142</dt>
1143<dd>
1144Adds a toggle/checkbox item to the popup. Teh callback gets called
1145whenever it gets toggled, with a boolean indicating its value as its first
1146argument.
1147</dd>
1148<p></p>
1149<dt><strong>$popup-&gt;show</strong><br />
1150</dt>
1151<dd>
1152Displays the popup (which is initially hidden).
877</dd> 1153</dd>
878<p></p></dl> 1154<p></p></dl>
879<p> 1155<p>
880</p> 1156</p>
881<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1157<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
949<pre> 1225<pre>
950 $term-&gt;{socket} = ... 1226 $term-&gt;{socket} = ...
951 $term-&gt;{iow} = urxvt::iow 1227 $term-&gt;{iow} = urxvt::iow
952 -&gt;new 1228 -&gt;new
953 -&gt;fd (fileno $term-&gt;{socket}) 1229 -&gt;fd (fileno $term-&gt;{socket})
954 -&gt;events (1) # wait for read data 1230 -&gt;events (urxvt::EVENT_READ)
955 -&gt;start 1231 -&gt;start
956 -&gt;cb (sub { 1232 -&gt;cb (sub {
957 my ($iow, $revents) = @_; 1233 my ($iow, $revents) = @_;
958 # $revents must be 1 here, no need to check 1234 # $revents must be 1 here, no need to check
959 sysread $term-&gt;{socket}, my $buf, 8192 1235 sysread $term-&gt;{socket}, my $buf, 8192
… …
980</dd> 1256</dd>
981<p></p> 1257<p></p>
982<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1258<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
983</dt> 1259</dt>
984<dd> 1260<dd>
985Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1261Set the event mask to watch. The only allowed values are
986data, Bit #1 (value <code>2</code>) enables watching for write data. 1262<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1263together, or <code>urxvt::EVENT_NONE</code>.
987</dd> 1264</dd>
988<p></p> 1265<p></p>
989<dt><strong>$iow = $iow-&gt;start</strong><br /> 1266<dt><strong>$iow = $iow-&gt;start</strong><br />
990</dt> 1267</dt>
991<dd> 1268<dd>
… …
1006</p> 1283</p>
1007<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1284<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1008<p>This variable controls the verbosity level of the perl extension. Higher 1285<p>This variable controls the verbosity level of the perl extension. Higher
1009numbers indicate more verbose output.</p> 1286numbers indicate more verbose output.</p>
1010<dl> 1287<dl>
1011<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1288<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1012</dt> 1289</dt>
1013<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1290<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1014</dt> 1291</dt>
1015<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1292<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1016</dt> 1293</dt>
1017</dl> 1294</dl>
1018<p> 1295<p>
1019</p> 1296</p>
1020<hr /> 1297<hr />

Diff Legend

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