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.3 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.16 by root, Sun Jan 8 06:35:38 2006 UTC

… …
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 <ul> 18 <ul>
19 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
20 <li><a href="#general_api_considerations">General API Considerations</a></li> 21 <li><a href="#general_api_considerations">General API Considerations</a></li>
21 <li><a href="#hooks">Hooks</a></li> 22 <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>
22 <li><a href="#functions_in_the_urxvt_package">Functions 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>
25 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
23 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 27 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
28 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
24 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 29 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
25 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 30 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
26 </ul> 31 </ul>
27 32
28 <li><a href="#environment">ENVIRONMENT</a></li> 33 <li><a href="#environment">ENVIRONMENT</a></li>
… …
36<!-- INDEX END --> 41<!-- INDEX END -->
37 42
38<hr /> 43<hr />
39<p> 44<p>
40</p> 45</p>
46<hr />
41<h1><a name="name">NAME</a></h1> 47<h1><a name="name">NAME</a></h1>
42<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 48<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
43<p> 49<p>
44</p> 50</p>
45<hr /> 51<hr />
46<h1><a name="synopsis">SYNOPSIS</a></h1> 52<h1><a name="synopsis">SYNOPSIS</a></h1>
47<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 53<pre>
48<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and 54 # create a file grab_test in $HOME:</pre>
49thus must be encoded as UTF-8.</p>
50<pre> 55<pre>
51 sub on_sel_grab { 56 sub on_sel_grab {
52 warn &quot;you selected &quot;, $_[0]-&gt;selection; 57 warn &quot;you selected &quot;, $_[0]-&gt;selection;
53 () 58 ()
54 }</pre> 59 }</pre>
55<pre> 60<pre>
56 1</pre> 61 # start a rxvt using it:</pre>
62<pre>
63 rxvt --perl-lib $HOME -pe grab_test</pre>
57<p> 64<p>
58</p> 65</p>
59<hr /> 66<hr />
60<h1><a name="description">DESCRIPTION</a></h1> 67<h1><a name="description">DESCRIPTION</a></h1>
61<p>On startup, rxvt will scan <em>/opt/rxvt/lib/urxvt/perl-ext/</em> 68<p>Everytime a terminal object gets created, extension scripts specified via
62for files and will load them. Everytime a terminal object gets created, 69the <code>perl</code> resource are loaded and associated with it.</p>
63the directory specified by the <code>perl-lib</code> resource will be additionally 70<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
64scanned.</p> 71thus must be encoded as UTF-8.</p>
65<p>Each script will only ever be loaded once, even in rxvtd, where 72<p>Each script will only ever be loaded once, even in rxvtd, where
66scripts will be shared for all terminals.</p> 73scripts will be shared (but not enabled) for all terminals.</p>
67<p>Hooks in scripts specified by <code>perl-lib</code> will only be called for the 74<p>
68terminals created with that specific option value.</p> 75</p>
76<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2>
77<p>This section describes the extensiosn delivered with this version. You can
78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
79<p>You can activate them like this:</p>
80<pre>
81 rxvt -pe &lt;extensionname&gt;</pre>
82<dl>
83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
84</dt>
85<dd>
86Intelligent selection. This extension tries to be more intelligent when
87the user extends selections (double-click). Right now, it tries to select
88urls and complete shell-quoted arguments, which is very convenient, too,
89if your <em>ls</em> supports <code>--quoting-style=shell</code>.
90</dd>
91<dd>
92<p>It also offers the following bindable event:</p>
93</dd>
94<dl>
95<dt><strong><a name="item_rot13">rot13</a></strong><br />
96</dt>
97<dd>
98Rot-13 the selection when activated. Used via keyboard trigger:
99</dd>
100<dd>
101<pre>
102 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
103</dd>
104<p></p></dl>
105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
106</dt>
107<dd>
108Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
109runtime.
110</dd>
111<p></p>
112<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
113</dt>
114<dd>
115Displays a digital clock using the built-in overlay.
116</dd>
117<p></p>
118<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
119</dt>
120<dd>
121Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
122</dd>
123<p></p>
124<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
125</dt>
126<dd>
127A not very useful example of filtering all text output to the terminal,
128by replacing all line-drawing characters (U+2500 .. U+259F) by a
129similar-looking ascii character.
130</dd>
131<p></p>
132<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
133</dt>
134<dd>
135Displays a very simple digital clock in the upper right corner of the
136window. Illustrates overwriting the refresh callbacks to create your own
137overlays or changes.
138</dd>
139<p></p></dl>
69<p> 140<p>
70</p> 141</p>
71<h2><a name="general_api_considerations">General API Considerations</a></h2> 142<h2><a name="general_api_considerations">General API Considerations</a></h2>
72<p>All objects (such as terminals, time watchers etc.) are typical 143<p>All objects (such as terminals, time watchers etc.) are typical
73reference-to-hash objects. The hash can be used to store anything you 144reference-to-hash objects. The hash can be used to store anything you
74like. All members starting with an underscore (such as <code>_ptr</code> or 145like. All members starting with an underscore (such as <code>_ptr</code> or
75<code>_hook</code>) are reserved for internal uses and must not be accessed or 146<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
76modified).</p> 147modified).</p>
77<p>When objects are destroyed on the C++ side, the perl object hashes are 148<p>When objects are destroyed on the C++ side, the perl object hashes are
78emptied, so its best to store related objects such as time watchers and 149emptied, so its best to store related objects such as time watchers and
79the like inside the terminal object so they get destroyed as soon as the 150the like inside the terminal object so they get destroyed as soon as the
80terminal is destroyed.</p> 151terminal is destroyed.</p>
152<p>Argument names also often indicate the type of a parameter. Here are some
153hints on what they mean:</p>
154<dl>
155<dt><strong><a name="item__24text">$text</a></strong><br />
156</dt>
157<dd>
158Rxvt-unicodes special way of encoding text, where one ``unicode'' character
159always represents one screen cell. See <em>row_t</em> for a discussion of this format.
160</dd>
161<p></p>
162<dt><strong><a name="item__24string">$string</a></strong><br />
163</dt>
164<dd>
165A perl text string, with an emphasis on <em>text</em>. It can store all unicode
166characters and is to be distinguished with text encoded in a specific
167encoding (often locale-specific) and binary data.
168</dd>
169<p></p>
170<dt><strong><a name="item__24octets">$octets</a></strong><br />
171</dt>
172<dd>
173Either binary data or - more common - a text string encoded in a
174locale-specific way.
175</dd>
176<p></p></dl>
81<p> 177<p>
82</p> 178</p>
83<h2><a name="hooks">Hooks</a></h2> 179<h2><a name="hooks">Hooks</a></h2>
84<p>The following subroutines can be declared in loaded scripts, and will be called 180<p>The following subroutines can be declared in extension files, and will be
85whenever the relevant event happens.</p> 181called whenever the relevant event happens.</p>
182<p>The first argument passed to them is an object private to each terminal
183and extension package. You can call all <code>urxvt::term</code> methods on it, but
184its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
185object that is shared between all packages is stored in the <code>term</code>
186member. It is, however, blessed intot he package of the extension script,
187so for all practical purposes you can treat an extension script as a class.</p>
86<p>All of them must return a boolean value. If it is true, then the event 188<p>All of them must return a boolean value. If it is true, then the event
87counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 189counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
88and the relevant action might not be carried out by the C++ code.</p> 190and the relevant action might not be carried out by the C++ code.</p>
89<p>When in doubt, return a false value (preferably <code>()</code>).</p> 191<p>When in doubt, return a false value (preferably <code>()</code>).</p>
90<dl> 192<dl>
91<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 193<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
92</dt> 194</dt>
93<dd> 195<dd>
94Called after a new terminal object has been initialized, but before 196Called after a new terminal object has been initialized, but before
95windows are created or the command gets run. 197windows are created or the command gets run. Most methods are unsafe to
198call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources,
200though.
96</dd> 201</dd>
97<p></p> 202<p></p>
98<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 203<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
99</dt> 204</dt>
100<dd> 205<dd>
… …
131</dd> 236</dd>
132<dd> 237<dd>
133<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 238<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
134</dd> 239</dd>
135<p></p> 240<p></p>
136<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 241<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
137</dt> 242</dt>
138<dd>
139Called whenever the window gets the keyboard focus, before urxvt does
140focus in processing.
141</dd> 243<dd>
142<p></p> 244Called whenever the user tries to extend the selection (e.g. with a double
143<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 245click) and is either supposed to return false (normal operation), or
144</dt> 246should extend the selection itelf and return true to suppress the built-in
247processing.
145<dd> 248</dd>
146Called wheneever the window loses keyboard focus, before urxvt does focus 249<dd>
147out processing. 250<p>See the <em>selection</em> example extension.</p>
148</dd> 251</dd>
149<p></p> 252<p></p>
150<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 253<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
151</dt> 254</dt>
152<dd> 255<dd>
… …
170<p></p> 273<p></p>
171<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 274<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
172</dt> 275</dt>
173<dd> 276<dd>
174Called whenever the <code>program(s)</code> running in the urxvt window send output. 277Called whenever the <code>program(s)</code> running in the urxvt window send output.
278</dd>
279<p></p>
280<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
281</dt>
282<dd>
283Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
284operating system command) is processed. Cursor position and other state
285information is up-to-date when this happens. For interoperability, the
286string should start with the extension name and a colon, to distinguish
287it from commands for other extensions, and this might be enforced in the
288future.
289</dd>
290<dd>
291<p>Be careful not ever to trust (in a security sense) the data you receive,
292as its source can not easily be controleld (e-mail content, messages from
293other users on the same system etc.).</p>
294</dd>
295<p></p>
296<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
297</dt>
298<dd>
299Called whenever text is about to be output, with the text as argument. You
300can filter/change and output the text yourself by returning a true value
301and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
302might be very slow, however, as your hook is called for <strong>all</strong> text being
303output.
304</dd>
305<p></p>
306<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
307</dt>
308<dd>
309Called whenever a line was updated or changed. Can be used to filter
310screen output (e.g. underline urls or other useless stuff). Only lines
311that are being shown will be filtered, and, due to performance reasons,
312not always immediately.
313</dd>
314<dd>
315<p>The row number is always the topmost row of the line if the line spans
316multiple rows.</p>
317</dd>
318<dd>
319<p>Please note that, if you change the line, then the hook might get called
320later with the already-modified line (e.g. if unrelated parts change), so
321you cannot just toggle rendition bits, but only set them.</p>
175</dd> 322</dd>
176<p></p> 323<p></p>
177<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 324<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
178</dt> 325</dt>
179<dd> 326<dd>
… …
186<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 333<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
187</dt> 334</dt>
188<dd> 335<dd>
189Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 336Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
190</dd> 337</dd>
338<p></p>
339<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
340</dt>
341<dd>
342Called whenever the user presses a key combination that has a
343<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
344resource in the <code>rxvt(1)</code> manpage).
345</dd>
346<p></p>
347<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
348</dt>
349<dd>
350Called whenever the window gets the keyboard focus, before rxvt-unicode
351does focus in processing.
352</dd>
353<p></p>
354<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
355</dt>
356<dd>
357Called wheneever the window loses keyboard focus, before rxvt-unicode does
358focus out processing.
359</dd>
360<p></p>
361<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
362</dt>
363<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
364</dt>
365<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
366</dt>
367<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
368</dt>
369<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
370</dt>
371<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
372</dt>
373<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
374</dt>
375<dd>
376Called whenever the corresponding X event is received for the terminal If
377the hook returns true, then the even will be ignored by rxvt-unicode.
378</dd>
379<dd>
380<p>The event is a hash with most values as named by Xlib (see the XEvent
381manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
382and column under the mouse cursor.</p>
383</dd>
384<dd>
385<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
386output, if any, in locale-specific encoding.</p>
387</dd>
388<dd>
389<p>subwindow.</p>
390</dd>
191<p></p></dl> 391<p></p></dl>
192<p> 392<p>
193</p> 393</p>
394<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
395<dl>
396<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
397</dt>
398<dd>
399The current terminal. This variable stores the current <code>urxvt::term</code>
400object, whenever a callback/hook is executing.
401</dd>
402<p></p></dl>
403<p>
404</p>
194<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 405<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
195<dl> 406<dl>
407<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
408</dt>
409<dd>
410Creates a new terminal, very similar as if you had started it with
411<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
412if the new instance couldn't be created. Returns <code>undef</code> if the new
413instance didn't initialise perl, and the terminal object otherwise. The
414<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
415</dd>
416<p></p>
196<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 417<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
197</dt> 418</dt>
198<dd> 419<dd>
199Fatally aborts execution with the given error message. Avoid at all 420Fatally aborts execution with the given error message. Avoid at all
200costs! The only time this is acceptable is when the terminal process 421costs! The only time this is acceptable is when the terminal process
… …
216<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 437<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
217</dt> 438</dt>
218<dd> 439<dd>
219Returns the ``current time'' (as per the event loop). 440Returns the ``current time'' (as per the event loop).
220</dd> 441</dd>
442<p></p>
443<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
444</dt>
445<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
446Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
447Button4Mask, Button5Mask, AnyModifier</a></strong><br />
448</dt>
449<dd>
450Various constants for use in X calls and event processing.
451</dd>
221<p></p></dl> 452<p></p></dl>
222<p> 453<p>
223</p> 454</p>
455<h2><a name="rendition">RENDITION</a></h2>
456<p>Rendition bitsets contain information about colour, font, font styles and
457similar information for each screen cell.</p>
458<p>The following ``macros'' deal with changes in rendition sets. You should
459never just create a bitset, you should always modify an existing one,
460as they contain important information required for correct operation of
461rxvt-unicode.</p>
462<dl>
463<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
464</dt>
465<dd>
466Returns the default rendition, as used when the terminal is starting up or
467being reset. Useful as a base to start when creating renditions.
468</dd>
469<p></p>
470<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
471</dt>
472<dd>
473Return the rendition mask used for overlays by default.
474</dd>
475<p></p>
476<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
477</dt>
478<dd>
479Return the bit that enabled bold, italic, blink, reverse-video and
480underline, respectively. To enable such a style, just logically OR it into
481the bitset.
482</dd>
483<p></p>
484<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
485</dt>
486<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
487</dt>
488<dd>
489Return the foreground/background colour index, respectively.
490</dd>
491<p></p>
492<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br />
493</dt>
494<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br />
495</dt>
496<dd>
497Replace the foreground/background colour in the rendition mask with the
498specified one.
499</dd>
500<p></p>
501<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br />
502</dt>
503<dd>
504Return the ``custom'' value: Every rendition has 5 bits for use by
505extensions. They can be set and changed as you like and are initially
506zero.
507</dd>
508<p></p>
509<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br />
510</dt>
511<dd>
512Change the custom value.
513</dd>
514<p></p></dl>
515<p>
516</p>
517<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
518<p>The sole purpose of this class is to deliver an interface to the
519<code>AnyEvent</code> module - any module using it will work inside urxvt without
520further work. The only exception is that you cannot wait on condition
521variables, but non-blocking condvar use is ok. What this means is that you
522cannot use blocking APIs, but the non-blocking variant should work.</p>
523<p>
524</p>
224<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 525<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
225<dl> 526<dl>
527<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
528</dt>
529<dd>
530Destroy the terminal object (close the window, free resources etc.).
531</dd>
532<p></p>
533<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
534</dt>
535<dd>
536Returns true if the option specified by <code>$optval</code> is enabled, and
537optionally change it. All option values are stored by name in the hash
538<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
539</dd>
540<dd>
541<p>Here is a a likely non-exhaustive list of option names, please see the
542source file <em>/src/optinc.h</em> to see the actual list:</p>
543</dd>
544<dd>
545<pre>
546 borderLess console cursorBlink cursorUnderline hold iconic insecure
547 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
548 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
549 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
550 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
551 tripleclickwords utmpInhibit visualBell</pre>
552</dd>
553<p></p>
226<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 554<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
227</dt> 555</dt>
228<dd> 556<dd>
229Returns the current resource value associated with a given name and 557Returns the current resource value associated with a given name and
230optionally sets a new value. Setting values is most useful in the <code>init</code> 558optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
244<p>Please note that resource strings will currently only be freed when the 572<p>Please note that resource strings will currently only be freed when the
245terminal is destroyed, so changing options frequently will eat memory.</p> 573terminal is destroyed, so changing options frequently will eat memory.</p>
246</dd> 574</dd>
247<dd> 575<dd>
248<p>Here is a a likely non-exhaustive list of resource names, not all of which 576<p>Here is a a likely non-exhaustive list of resource names, not all of which
249are supported in every build, please see the source to see the actual 577are supported in every build, please see the source file <em>/src/rsinc.h</em>
250list:</p> 578to see the actual list:</p>
251</dd> 579</dd>
252<dd> 580<dd>
253<pre> 581<pre>
254 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 582 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
255 borderLess color cursorBlink cursorUnderline cutchars delete_key 583 borderLess color cursorBlink cursorUnderline cutchars delete_key
256 display_name embed ext_bwidth fade font geometry hold iconName 584 display_name embed ext_bwidth fade font geometry hold iconName
257 imFont imLocale inputMethod insecure int_bwidth intensityStyles 585 imFont imLocale inputMethod insecure int_bwidth intensityStyles
258 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 586 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
259 modifier mouseWheelScrollPage name pastableTabs path perl perl_eval 587 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
260 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 588 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
261 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 589 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
262 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 590 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
263 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 591 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
264 shade term_name title transparent transparent_all tripleclickwords 592 shade term_name title transparent transparent_all tripleclickwords
265 utmpInhibit visualBell</pre> 593 utmpInhibit visualBell</pre>
266</dd> 594</dd>
267<p></p> 595<p></p>
596<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
597</dt>
598<dd>
599Return and optionally change the current rendition. Text that is output by
600the terminal application will use this style.
601</dd>
602<p></p>
603<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
604</dt>
605<dd>
606Return the current coordinates of the text cursor position and optionally
607set it (which is usually bad as applications don't expect that).
608</dd>
609<p></p>
268<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 610<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
269</dt> 611</dt>
270<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 612<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
271</dt> 613</dt>
272<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 614<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
281<dd> 623<dd>
282Try to request the primary selection from the server (for example, as set 624Try to request the primary selection from the server (for example, as set
283by the next method). 625by the next method).
284</dd> 626</dd>
285<p></p> 627<p></p>
286<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 628<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
287</dt> 629</dt>
288<dd> 630<dd>
289Return the current selection text and optionally replace it by <code>$newtext</code>. 631Return the current selection text and optionally replace it by <code>$newtext</code>.
290</dd> 632</dd>
291<p></p>
292<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br />
293</dt>
294<dd> 633<dd>
634<p>#=item $term-&gt;overlay ($x, $y, $text)
635#
295Create a simple multi-line overlay box. See the next method for details. 636#Create a simple multi-line overlay box. See the next method for details.
637#
638#=cut
639#
640#sub urxvt::term::scr_overlay {
641# my ($self, $x, $y, $text) = @_;
642#
643# my @lines = split /\n/, $text;
644#
645# my $w = 0;
646# for (map $self-&gt;strwidth ($_), @lines) {
647# $w = $_ if $w &lt; $_;
648# }
649#
650# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
651# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
652#}</p>
296</dd> 653</dd>
297<p></p> 654<p></p>
298<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 655<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
299</dt> 656</dt>
300<dd> 657<dd>
301Create a new (empty) overlay at the given position with the given 658Create a new (empty) overlay at the given position with the given
302width/height. A border will be put around the box. If either <code>$x</code> or 659width/height. <code>$rstyle</code> defines the initial rendition style
303<code>$y</code> is negative, then this is counted from the right/bottom side, 660(default: <code>OVERLAY_RSTYLE</code>).
304respectively.
305</dd>
306<p></p>
307<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
308</dt>
309<dd> 661</dd>
310Switch the overlay off again.
311</dd> 662<dd>
312<p></p> 663<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
313<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 664around the box.</p>
314</dt>
315<dd> 665</dd>
316Put a single character (specified numerically) at the given overlay
317position.
318</dd> 666<dd>
319<p></p> 667<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
320<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 668right/bottom side, respectively.</p>
321</dt>
322<dd> 669</dd>
323Write a string at the given position into the overlay.
324</dd> 670<dd>
671<p>This method returns an urxvt::overlay object. The overlay will be visible
672as long as the perl object is referenced.</p>
673</dd>
674<dd>
675<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
676</dd>
677<dl>
678<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
679</dt>
680<dd>
681Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
682text in rxvt-unicode's special encoding and an array of rendition values
683at a specific position inside the overlay.
684</dd>
325<p></p> 685<p></p>
686<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
687</dt>
688<dd>
689If visible, hide the overlay, but do not destroy it.
690</dd>
691<p></p>
692<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
693</dt>
694<dd>
695If hidden, display the overlay again.
696</dd>
697<p></p></dl>
698<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
699</dt>
700<dd>
701Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
702<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
703currently).
704</dd>
705<p></p>
326<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 706<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
327</dt> 707</dt>
328<dd> 708<dd>
329Returns the number of screen-cells this string would need. Correctly 709Returns the number of screen-cells this string would need. Correctly
330accounts for wide and combining characters. 710accounts for wide and combining characters.
331</dd> 711</dd>
332<p></p> 712<p></p>
333<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 713<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
334</dt> 714</dt>
335<dd> 715<dd>
336Convert the given text string into the corresponding locale encoding. 716Convert the given text string into the corresponding locale encoding.
337</dd> 717</dd>
338<p></p> 718<p></p>
339<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 719<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
340</dt> 720</dt>
341<dd> 721<dd>
342Convert the given locale-encoded octets into a perl string. 722Convert the given locale-encoded octets into a perl string.
343</dd> 723</dd>
344<p></p> 724<p></p>
725<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
726</dt>
727<dd>
728Write the given text string to the screen, as if output by the application
729running inside the terminal. It may not contain command sequences (escape
730codes), but is free to use line feeds, carriage returns and tabs. The
731string is a normal text string, not in locale-dependent encoding.
732</dd>
733<dd>
734<p>Normally its not a good idea to use this function, as programs might be
735confused by changes in cursor position or scrolling. Its useful inside a
736<code>on_add_lines</code> hook, though.</p>
737</dd>
738<p></p>
739<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
740</dt>
741<dd>
742Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
743locale-specific encoding of the terminal and can contain command sequences
744(escape codes) that will be interpreted.
745</dd>
746<p></p>
345<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 747<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
346</dt> 748</dt>
347<dd> 749<dd>
348Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 750Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
349pass characters instead of octets, you should convetr you strings first to 751pass characters instead of octets, you should convert your strings first
350the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 752to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
753</dd>
754<p></p>
755<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
756</dt>
757<dd>
758Return the window id of the toplevel window.
759</dd>
760<p></p>
761<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
762</dt>
763<dd>
764Return the window id of the terminal window.
765</dd>
766<p></p>
767<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
768</dt>
769<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
770</dt>
771<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
772</dt>
773<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
774</dt>
775<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
776</dt>
777<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
778</dt>
779<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
780</dt>
781<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
782</dt>
783<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
784</dt>
785<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
786</dt>
787<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
788</dt>
789<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
790</dt>
791<dd>
792Return various integers describing terminal characteristics.
793</dd>
794<p></p>
795<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
796</dt>
797<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
798</dt>
799<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
800</dt>
801<dd>
802Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
803AltGr), the meta key (often Alt) and the num lock key, if applicable.
804</dd>
805<p></p>
806<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
807</dt>
808<dd>
809Returns the negative row number of the topmost line. Minimum value is
810<code>0</code>, which displays the normal terminal contents. Larger values scroll
811this many lines into the scrollback buffer.
812</dd>
813<p></p>
814<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
815</dt>
816<dd>
817Requests a screen refresh. At the next opportunity, rxvt-unicode will
818compare the on-screen display with its stored representation. If they
819differ, it redraws the differences.
820</dd>
821<dd>
822<p>Used after changing terminal contents to display them.</p>
823</dd>
824<p></p>
825<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
826</dt>
827<dd>
828Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
829is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
830terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
831line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
832is requested.
833</dd>
834<dd>
835<p>If <code>$new_text</code> is specified, it will replace characters in the current
836line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
837to replace only parts of a line. The font index in the rendition will
838automatically be updated.</p>
839</dd>
840<dd>
841<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
842than one cell when displayed are padded with urxvt::NOCHAR characters
843(<code>chr 65535</code>). Characters with combining characters and other characters
844that do not fit into the normal tetx encoding will be replaced with
845characters in the private use area.</p>
846</dd>
847<dd>
848<p>You have to obey this encoding when changing text. The advantage is
849that <code>substr</code> and similar functions work on screen cells and not on
850characters.</p>
851</dd>
852<dd>
853<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
854can be used to convert normal strings into this encoding and vice versa.</p>
855</dd>
856<p></p>
857<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
858</dt>
859<dd>
860Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
861bitsets. Rendition bitsets contain information about colour, font, font
862styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
863</dd>
864<dd>
865<p>When setting rendition, the font mask will be ignored.</p>
866</dd>
867<dd>
868<p>See the section on RENDITION, above.</p>
869</dd>
870<p></p>
871<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
872</dt>
873<dd>
874Returns the number of screen cells that are in use (``the line
875length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
876line is joined with the following one.
877</dd>
878<p></p>
879<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
880</dt>
881<dd>
882Returns true if the row is part of a multiple-row logical ``line'' (i.e.
883joined with the following row), which means all characters are in use
884and it is continued on the next row (and possibly a continuation of the
885previous row(s)).
886</dd>
887<p></p>
888<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
889</dt>
890<dd>
891Create and return a new <code>urxvt::line</code> object that stores information
892about the logical line that row <code>$row_number</code> is part of. It supports the
893following methods:
894</dd>
895<dl>
896<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
897</dt>
898<dd>
899Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
900</dd>
901<p></p>
902<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
903</dt>
904<dd>
905Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
906</dd>
907<p></p>
908<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
909</dt>
910<dd>
911Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
912</dd>
913<p></p>
914<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
915</dt>
916<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
917</dt>
918<dd>
919Return the row number of the first/last row of the line, respectively.
920</dd>
921<p></p>
922<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
923</dt>
924<dd>
925Returns the character offset of the given row|col pair within the logical
926line.
927</dd>
928<p></p>
929<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
930</dt>
931<dd>
932Translates a string offset into terminal coordinates again.
351</dd> 933</dd>
352<p></p></dl> 934<p></p></dl>
935<dt><strong>($row, $col) = $line-&gt;coord_of ($offset)
936=item $text = $term-&gt;special_encode $string</strong><br />
937</dt>
938<dd>
939Converts a perl string into the special encoding used by rxvt-unicode,
940where one character corresponds to one screen cell. See
941<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
942</dd>
943<p></p>
944<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
945</dt>
946<dd>
947Converts rxvt-unicodes text reprsentation into a perl string. See
948<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
949</dd>
950<p></p></dl>
951<p>
952</p>
953<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
353<p> 954<p>
354</p> 955</p>
355<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 956<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
356<p>This class implements timer watchers/events. Time is represented as a 957<p>This class implements timer watchers/events. Time is represented as a
357fractional number of seconds since the epoch. Example:</p> 958fractional number of seconds since the epoch. Example:</p>
358<pre> 959<pre>
359 # create a digital clock display in upper right corner 960 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
360 $term-&gt;{timer} = urxvt::timer 961 $term-&gt;{timer} = urxvt::timer
361 -&gt;new 962 -&gt;new
362 -&gt;start (urxvt::NOW) 963 -&gt;interval (1)
363 -&gt;cb (sub { 964 -&gt;cb (sub {
364 my ($timer) = @_;
365 my $time = $timer-&gt;at;
366 $timer-&gt;start ($time + 1);
367 $self-&gt;scr_overlay (-1, 0, 965 $term-&gt;{overlay}-&gt;set (0, 0,
368 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 966 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
369 });</pre> 967 });</pre>
370<dl> 968<dl>
371<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 969<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
372</dt> 970</dt>
373<dd> 971<dd>
374Create a new timer object in stopped state. 972Create a new timer object in started state. It is scheduled to fire
973immediately.
375</dd> 974</dd>
376<p></p> 975<p></p>
377<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 976<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
378</dt> 977</dt>
379<dd> 978<dd>
… …
384</dt> 983</dt>
385<dd> 984<dd>
386Return the time this watcher will fire next. 985Return the time this watcher will fire next.
387</dd> 986</dd>
388<p></p> 987<p></p>
389<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 988<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
390</dt> 989</dt>
391<dd> 990<dd>
392Set the time the event is generated to $tstamp. 991Set the time the event is generated to $tstamp.
992</dd>
993<p></p>
994<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
995</dt>
996<dd>
997Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
998stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
999is automatically rescheduled at the given intervals.
393</dd> 1000</dd>
394<p></p> 1001<p></p>
395<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1002<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
396</dt> 1003</dt>
397<dd> 1004<dd>
… …
473<p> 1080<p>
474</p> 1081</p>
475<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1082<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
476<p>This variable controls the verbosity level of the perl extension. Higher 1083<p>This variable controls the verbosity level of the perl extension. Higher
477numbers indicate more verbose output.</p> 1084numbers indicate more verbose output.</p>
478<ol> 1085<dl>
479<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1086<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br />
480</li> 1087</dt>
481<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1088<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br />
482</li> 1089</dt>
483<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 1090<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br />
1091</dt>
484</li> 1092</dl>
485</ol>
486<p> 1093<p>
487</p> 1094</p>
488<hr /> 1095<hr />
489<h1><a name="author">AUTHOR</a></h1> 1096<h1><a name="author">AUTHOR</a></h1>
490<pre> 1097<pre>

Diff Legend

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