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

Diff Legend

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