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.2 by root, Mon Jan 2 17:21:59 2006 UTC vs.
Revision 1.25 by root, Thu Jan 12 05:37:34 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
20 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
21 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
22 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
23 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
24 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
25 </ul> 33 </ul>
26 34
27 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
35<!-- INDEX END --> 43<!-- INDEX END -->
36 44
37<hr /> 45<hr />
38<p> 46<p>
39</p> 47</p>
48<hr />
40<h1><a name="name">NAME</a></h1> 49<h1><a name="name">NAME</a></h1>
41<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 50<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
42<p> 51<p>
43</p> 52</p>
44<hr /> 53<hr />
45<h1><a name="synopsis">SYNOPSIS</a></h1> 54<h1><a name="synopsis">SYNOPSIS</a></h1>
46<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 55<pre>
47<p>* Each script will only be loaded once, even in urxvtd, and will be valid 56 # create a file grab_test in $HOME:</pre>
48globally.</p>
49<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
50thus must be encoded as UTF-8.</p>
51<pre> 57<pre>
52 sub on_sel_grab { 58 sub on_sel_grab {
53 warn &quot;you selected &quot;, $_[0]-&gt;selection; 59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
54 () 60 ()
55 }</pre> 61 }</pre>
56<pre> 62<pre>
57 1</pre> 63 # start a rxvt using it:</pre>
64<pre>
65 rxvt --perl-lib $HOME -pe grab_test</pre>
58<p> 66<p>
59</p> 67</p>
60<hr /> 68<hr />
61<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
70<p>Everytime a terminal object gets created, extension scripts specified via
71the <code>perl</code> resource are loaded and associated with it.</p>
72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
73thus must be encoded as UTF-8.</p>
74<p>Each script will only ever be loaded once, even in rxvtd, where
75scripts will be shared (but not enabled) for all terminals.</p>
76<p>
77</p>
78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
80<p>This section describes the extensions delivered with this release. You can
81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
82<p>You can activate them like this:</p>
83<pre>
84 rxvt -pe &lt;extensionname&gt;</pre>
85<dl>
86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
87</dt>
88<dd>
89(More) intelligent selection. This extension tries to be more intelligent
90when the user extends selections (double-click and further clicks). Right
91now, it tries to select words, urls and complete shell-quoted
92arguments, which is very convenient, too, if your <em>ls</em> supports
93<code>--quoting-style=shell</code>.
94</dd>
95<dd>
96<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p>
98</dd>
99<dd>
100<p>It also offers the following bindable keyboard command:</p>
101</dd>
102<dl>
103<dt><strong><a name="item_rot13">rot13</a></strong><br />
104</dt>
105<dd>
106Rot-13 the selection when activated. Used via keyboard trigger:
107</dd>
108<dd>
109<pre>
110 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
111</dd>
112<p></p></dl>
113<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
114</dt>
115<dd>
116Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
117runtime.
118</dd>
119<p></p>
120<dt><strong>selection-popup (enabled by default)</strong><br />
121</dt>
122<dd>
123Binds a popup menu to Ctrl-Button3 that lets you convert the selection
124text into various other formats/action (such as uri unescaping, perl
125evalution, web-browser starting etc.), depending on content.
126</dd>
127<p></p>
128<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
129</dt>
130<dd>
131Adds regex search functionality to the scrollback buffer, triggered
132by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
133input/output is suspended and a regex is displayed at the bottom of the
134screen.
135</dd>
136<dd>
137<p>Inputting characters appends them to the regex and continues incremental
138search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
139search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
140bottom. <code>Escape</code> leaves search mode and returns to the point where search
141was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
142additionally stores the first match in the current line into the primary
143selection.</p>
144</dd>
145<p></p>
146<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
147</dt>
148<dd>
149Displays a digital clock using the built-in overlay.
150</dd>
151<p></p>
152<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
153</dt>
154<dd>
155Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
156make them clickable. When middle-clicked, the program specified in the
157resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
158the URL as first argument.
159</dd>
160<p></p>
161<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
162</dt>
163<dd>
164A not very useful example of filtering all text output to the terminal,
165by replacing all line-drawing characters (U+2500 .. U+259F) by a
166similar-looking ascii character.
167</dd>
168<p></p>
169<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
170</dt>
171<dd>
172Displays a very simple digital clock in the upper right corner of the
173window. Illustrates overwriting the refresh callbacks to create your own
174overlays or changes.
175</dd>
176<p></p></dl>
177<p>
178</p>
179<hr />
180<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
181<p>
182</p>
183<h2><a name="general_api_considerations">General API Considerations</a></h2>
184<p>All objects (such as terminals, time watchers etc.) are typical
185reference-to-hash objects. The hash can be used to store anything you
186like. All members starting with an underscore (such as <code>_ptr</code> or
187<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
188modified).</p>
189<p>When objects are destroyed on the C++ side, the perl object hashes are
190emptied, so its best to store related objects such as time watchers and
191the like inside the terminal object so they get destroyed as soon as the
192terminal is destroyed.</p>
193<p>Argument names also often indicate the type of a parameter. Here are some
194hints on what they mean:</p>
195<dl>
196<dt><strong><a name="item__24text">$text</a></strong><br />
197</dt>
198<dd>
199Rxvt-unicodes special way of encoding text, where one ``unicode'' character
200always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
201</dd>
202<p></p>
203<dt><strong><a name="item__24string">$string</a></strong><br />
204</dt>
205<dd>
206A perl text string, with an emphasis on <em>text</em>. It can store all unicode
207characters and is to be distinguished with text encoded in a specific
208encoding (often locale-specific) and binary data.
209</dd>
210<p></p>
211<dt><strong><a name="item__24octets">$octets</a></strong><br />
212</dt>
213<dd>
214Either binary data or - more common - a text string encoded in a
215locale-specific way.
216</dd>
217<p></p></dl>
218<p>
219</p>
220<h2><a name="extension_objects">Extension Objects</a></h2>
221<p>Very perl extension is a perl class. A separate perl object is created
222for each terminal and each extension and passed as the first parameter to
223hooks. So extensions can use their <code>$self</code> object without having to think
224about other extensions, with the exception of methods and members that
225begin with an underscore character <code>_</code>: these are reserved for internal
226use.</p>
227<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
228<code>urxvt::term</code> class on this object.</p>
229<p>It has the following methods and data members:</p>
230<dl>
231<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
232</dt>
233<dd>
234Returns the <code>urxvt::term</code> object associated with this instance of the
235extension. This member <em>must not</em> be changed in any way.
236</dd>
237<p></p>
238<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
239</dt>
240<dd>
241Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
242this extension, replacing any previous hook. This is useful when you want
243to overwrite time-critical hooks only temporarily.
244</dd>
245<p></p>
246<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
247</dt>
248<dd>
249Dynamically disable the given hooks.
250</dd>
251<p></p></dl>
62<p> 252<p>
63</p> 253</p>
64<h2><a name="hooks">Hooks</a></h2> 254<h2><a name="hooks">Hooks</a></h2>
65<p>The following subroutines can be declared in loaded scripts, and will be called 255<p>The following subroutines can be declared in extension files, and will be
66whenever the relevant event happens.</p> 256called whenever the relevant event happens.</p>
257<p>The first argument passed to them is an extension oject as described in
258the in the <code>Extension Objects</code> section.</p>
67<p>All of them must return a boolean value. If it is true, then the event 259<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
68counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 260event counts as being <em>consumed</em>, and the invocation of other hooks is
69and the relevant action might not be carried out by the C++ code.</p> 261skipped, and the relevant action might not be carried out by the C++ code.</p>
70<p>When in doubt, return a false value (preferably <code>()</code>).</p> 262<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
71<dl> 263<dl>
72<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 264<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
73</dt> 265</dt>
74<dd> 266<dd>
75Called after a new terminal object has been initialized, but before 267Called after a new terminal object has been initialized, but before
76windows are created or the command gets run. 268windows are created or the command gets run. Most methods are unsafe to
269call or deliver senseless data, as terminal size and other characteristics
270have not yet been determined. You can safely query and change resources,
271though.
77</dd> 272</dd>
78<p></p> 273<p></p>
79<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 274<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
80</dt> 275</dt>
81<dd> 276<dd>
… …
112</dd> 307</dd>
113<dd> 308<dd>
114<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 309<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
115</dd> 310</dd>
116<p></p> 311<p></p>
117<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 312<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
118</dt> 313</dt>
119<dd>
120Called whenever the window gets the keyboard focus, before urxvt does
121focus in processing.
122</dd> 314<dd>
123<p></p> 315Called whenever the user tries to extend the selection (e.g. with a double
124<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 316click) and is either supposed to return false (normal operation), or
125</dt> 317should extend the selection itelf and return true to suppress the built-in
318processing. This can happen multiple times, as long as the callback
319returns true, it will be called on every further click by the user and is
320supposed to enlarge the selection more and more, if possible.
126<dd> 321</dd>
127Called wheneever the window loses keyboard focus, before urxvt does focus 322<dd>
128out processing. 323<p>See the <em>selection</em> example extension.</p>
129</dd> 324</dd>
130<p></p> 325<p></p>
131<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 326<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
132</dt> 327</dt>
133<dd> 328<dd>
… …
147<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 342<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
148$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 343$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
149number of lines that will be in the scrollback buffer.</p> 344number of lines that will be in the scrollback buffer.</p>
150</dd> 345</dd>
151<p></p> 346<p></p>
152<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 347<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
153</dt> 348</dt>
349<dd>
350Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
351operating system command) is processed. Cursor position and other state
352information is up-to-date when this happens. For interoperability, the
353string should start with the extension name and a colon, to distinguish
354it from commands for other extensions, and this might be enforced in the
355future.
154<dd> 356</dd>
155Called whenever the <code>program(s)</code> running in the urxvt window send output. 357<dd>
358<p>Be careful not ever to trust (in a security sense) the data you receive,
359as its source can not easily be controleld (e-mail content, messages from
360other users on the same system etc.).</p>
361</dd>
362<p></p>
363<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
364</dt>
365<dd>
366Called whenever text is about to be output, with the text as argument. You
367can filter/change and output the text yourself by returning a true value
368and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
369might be very slow, however, as your hook is called for <strong>all</strong> text being
370output.
371</dd>
372<p></p>
373<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
374</dt>
375<dd>
376Called whenever some data is written to the tty/pty and can be used to
377suppress or filter tty input.
378</dd>
379<p></p>
380<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
381</dt>
382<dd>
383Called whenever a line was updated or changed. Can be used to filter
384screen output (e.g. underline urls or other useless stuff). Only lines
385that are being shown will be filtered, and, due to performance reasons,
386not always immediately.
387</dd>
388<dd>
389<p>The row number is always the topmost row of the line if the line spans
390multiple rows.</p>
391</dd>
392<dd>
393<p>Please note that, if you change the line, then the hook might get called
394later with the already-modified line (e.g. if unrelated parts change), so
395you cannot just toggle rendition bits, but only set them.</p>
156</dd> 396</dd>
157<p></p> 397<p></p>
158<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 398<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
159</dt> 399</dt>
160<dd> 400<dd>
… …
167<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 407<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
168</dt> 408</dt>
169<dd> 409<dd>
170Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 410Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
171</dd> 411</dd>
412<p></p>
413<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
414</dt>
415<dd>
416Called whenever the user presses a key combination that has a
417<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
418resource in the <code>rxvt(1)</code> manpage).
419</dd>
420<p></p>
421<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
422</dt>
423<dd>
424Called whenever the window gets the keyboard focus, before rxvt-unicode
425does focus in processing.
426</dd>
427<p></p>
428<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
429</dt>
430<dd>
431Called wheneever the window loses keyboard focus, before rxvt-unicode does
432focus out processing.
433</dd>
434<p></p>
435<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
436</dt>
437<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
438</dt>
439<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
440</dt>
441<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
442</dt>
443<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
444</dt>
445<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
446</dt>
447<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
448</dt>
449<dd>
450Called whenever the corresponding X event is received for the terminal If
451the hook returns true, then the even will be ignored by rxvt-unicode.
452</dd>
453<dd>
454<p>The event is a hash with most values as named by Xlib (see the XEvent
455manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
456and column under the mouse cursor.</p>
457</dd>
458<dd>
459<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
460output, if any, in locale-specific encoding.</p>
461</dd>
462<dd>
463<p>subwindow.</p>
464</dd>
465<p></p></dl>
466<p>
467</p>
468<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
469<dl>
470<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
471</dt>
472<dd>
473The rxvt-unicode library directory, where, among other things, the perl
474modules and scripts are stored.
475</dd>
476<p></p>
477<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
478</dt>
479<dd>
480The resource class and name rxvt-unicode uses to look up X resources.
481</dd>
482<p></p>
483<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
484</dt>
485<dd>
486The basename of the installed binaries, usually <code>urxvt</code>.
487</dd>
488<p></p>
489<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
490</dt>
491<dd>
492The current terminal. This variable stores the current <code>urxvt::term</code>
493object, whenever a callback/hook is executing.
494</dd>
172<p></p></dl> 495<p></p></dl>
173<p> 496<p>
174</p> 497</p>
175<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 498<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
176<dl> 499<dl>
… …
183</dd> 506</dd>
184<p></p> 507<p></p>
185<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> 508<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
186</dt> 509</dt>
187<dd> 510<dd>
188Calls <code>rxvt_warn</code> witht eh given string which should not include a 511Calls <code>rxvt_warn</code> with the given string which should not include a
189newline. The module also overwrites the <code>warn</code> builtin with a function 512newline. The module also overwrites the <code>warn</code> builtin with a function
190that calls this function. 513that calls this function.
191</dd> 514</dd>
192<dd> 515<dd>
193<p>Using this function has the advantage that its output ends up in the 516<p>Using this function has the advantage that its output ends up in the
194correct place, e.g. on stderr of the connecting urxvtc client.</p> 517correct place, e.g. on stderr of the connecting urxvtc client.</p>
195</dd> 518</dd>
196<p></p> 519<dd>
197<dt><strong><a name="item__24cellwidth__3d_urxvt_3a_3awcswidth__24string">$cellwidth = urxvt::wcswidth $string</a></strong><br /> 520<p>Messages have a size limit of 1023 bytes currently.</p>
198</dt>
199<dd> 521</dd>
200Returns the number of screen-cells this string would need. Correctly 522<p></p>
201accounts for wide and combining characters. 523<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
524</dt>
525<dd>
526Returns true when it is safe to do potentially unsafe things, such as
527evaluating perl code specified by the user. This is true when urxvt was
528started setuid or setgid.
202</dd> 529</dd>
203<p></p> 530<p></p>
204<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 531<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
205</dt> 532</dt>
206<dd> 533<dd>
207Returns the ``current time'' (as per the event loop). 534Returns the ``current time'' (as per the event loop).
208</dd> 535</dd>
536<p></p>
537<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
538</dt>
539<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
540Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
541Button4Mask, Button5Mask, AnyModifier</a></strong><br />
542</dt>
543<dd>
544Various constants for use in X calls and event processing.
545</dd>
209<p></p></dl> 546<p></p></dl>
210<p> 547<p>
211</p> 548</p>
549<h2><a name="rendition">RENDITION</a></h2>
550<p>Rendition bitsets contain information about colour, font, font styles and
551similar information for each screen cell.</p>
552<p>The following ``macros'' deal with changes in rendition sets. You should
553never just create a bitset, you should always modify an existing one,
554as they contain important information required for correct operation of
555rxvt-unicode.</p>
556<dl>
557<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
558</dt>
559<dd>
560Returns the default rendition, as used when the terminal is starting up or
561being reset. Useful as a base to start when creating renditions.
562</dd>
563<p></p>
564<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
565</dt>
566<dd>
567Return the rendition mask used for overlays by default.
568</dd>
569<p></p>
570<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 />
571</dt>
572<dd>
573Return the bit that enabled bold, italic, blink, reverse-video and
574underline, respectively. To enable such a style, just logically OR it into
575the bitset.
576</dd>
577<p></p>
578<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
579</dt>
580<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
581</dt>
582<dd>
583Return the foreground/background colour index, respectively.
584</dd>
585<p></p>
586<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
587</dt>
588<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
589</dt>
590<dd>
591Replace the foreground/background colour in the rendition mask with the
592specified one.
593</dd>
594<p></p>
595<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
596</dt>
597<dd>
598Return the ``custom'' value: Every rendition has 5 bits for use by
599extensions. They can be set and changed as you like and are initially
600zero.
601</dd>
602<p></p>
603<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
604</dt>
605<dd>
606Change the custom value.
607</dd>
608<p></p></dl>
609<p>
610</p>
611<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
612<p>The sole purpose of this class is to deliver an interface to the
613<code>AnyEvent</code> module - any module using it will work inside urxvt without
614further programming. The only exception is that you cannot wait on
615condition variables, but non-blocking condvar use is ok. What this means
616is that you cannot use blocking APIs, but the non-blocking variant should
617work.</p>
618<p>
619</p>
212<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 620<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
213<dl> 621<dl>
622<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
623</dt>
624<dd>
625Creates a new terminal, very similar as if you had started it with system
626<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
627hash which defines the environment of the new terminal.
628</dd>
629<dd>
630<p>Croaks (and probably outputs an error message) if the new instance
631couldn't be created. Returns <code>undef</code> if the new instance didn't
632initialise perl, and the terminal object otherwise. The <code>init</code> and
633<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
634</dd>
635<p></p>
636<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
637</dt>
638<dd>
639Destroy the terminal object (close the window, free resources
640etc.). Please note that rxvt will not exit as long as any event
641watchers (timers, io watchers) are still active.
642</dd>
643<p></p>
644<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
645</dt>
646<dd>
647Returns true if the option specified by <code>$optval</code> is enabled, and
648optionally change it. All option values are stored by name in the hash
649<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
650</dd>
651<dd>
652<p>Here is a a likely non-exhaustive list of option names, please see the
653source file <em>/src/optinc.h</em> to see the actual list:</p>
654</dd>
655<dd>
656<pre>
657 borderLess console cursorBlink cursorUnderline hold iconic insecure
658 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
659 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
660 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
661 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
662 tripleclickwords utmpInhibit visualBell</pre>
663</dd>
664<p></p>
214<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 665<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
215</dt> 666</dt>
216<dd> 667<dd>
217Returns the current resource value associated with a given name and 668Returns the current resource value associated with a given name and
218optionally sets a new value. Setting values is most useful in the <code>init</code> 669optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
232<p>Please note that resource strings will currently only be freed when the 683<p>Please note that resource strings will currently only be freed when the
233terminal is destroyed, so changing options frequently will eat memory.</p> 684terminal is destroyed, so changing options frequently will eat memory.</p>
234</dd> 685</dd>
235<dd> 686<dd>
236<p>Here is a a likely non-exhaustive list of resource names, not all of which 687<p>Here is a a likely non-exhaustive list of resource names, not all of which
237are supported in every build, please see the source to see the actual 688are supported in every build, please see the source file <em>/src/rsinc.h</em>
238list:</p> 689to see the actual list:</p>
239</dd> 690</dd>
240<dd> 691<dd>
241<pre> 692<pre>
242 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 693 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
243 borderLess color cursorBlink cursorUnderline cutchars delete_key 694 borderLess color cursorBlink cursorUnderline cutchars delete_key
244 display_name embed ext_bwidth fade font geometry hold iconName 695 display_name embed ext_bwidth fade font geometry hold iconName
245 imFont imLocale inputMethod insecure int_bwidth intensityStyles 696 imFont imLocale inputMethod insecure int_bwidth intensityStyles
246 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 697 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
247 modifier mouseWheelScrollPage name pastableTabs path pointerBlank 698 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
248 pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines 699 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
249 scrollBar scrollBar_align scrollBar_floating scrollBar_right 700 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
250 scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer 701 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
251 scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name 702 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
252 title transparent transparent_all tripleclickwords utmpInhibit 703 shade term_name title transparent transparent_all tripleclickwords
253 visualBell</pre> 704 utmpInhibit visualBell</pre>
705</dd>
706<p></p>
707<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
708</dt>
709<dd>
710Returns the X-Resource for the given pattern, excluding the program or
711class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
712same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
713resource with that pattern exists.
714</dd>
715<dd>
716<p>This method should only be called during the <code>on_start</code> hook, as there is
717only one resource database per display, and later invocations might return
718the wrong resources.</p>
719</dd>
720<p></p>
721<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
722</dt>
723<dd>
724Adds a keymap translation exactly as specified via a resource. See the
725<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
726</dd>
727<p></p>
728<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
729</dt>
730<dd>
731Return and optionally change the current rendition. Text that is output by
732the terminal application will use this style.
733</dd>
734<p></p>
735<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
736</dt>
737<dd>
738Return the current coordinates of the text cursor position and optionally
739set it (which is usually bad as applications don't expect that).
254</dd> 740</dd>
255<p></p> 741<p></p>
256<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 742<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
257</dt> 743</dt>
258<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 744<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
262<dd> 748<dd>
263Return the current values of the selection mark, begin or end positions, 749Return the current values of the selection mark, begin or end positions,
264and optionally set them to new values. 750and optionally set them to new values.
265</dd> 751</dd>
266<p></p> 752<p></p>
753<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
754</dt>
755<dd>
756Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
757<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
758rectangular selection will be made. This is the prefered function to make
759a selection.
760</dd>
761<p></p>
267<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 762<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
268</dt> 763</dt>
269<dd> 764<dd>
270Try to request the primary selection from the server (for example, as set 765Try to request the primary selection text from the server (for example, as
271by the next method). 766set by the next method). No visual feedback will be given. This function
767is mostly useful from within <code>on_sel_grab</code> hooks.
272</dd> 768</dd>
273<p></p> 769<p></p>
274<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 770<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
275</dt> 771</dt>
276<dd> 772<dd>
277Return the current selection text and optionally replace it by <code>$newtext</code>. 773Return the current selection text and optionally replace it by <code>$newtext</code>.
278</dd> 774</dd>
279<p></p> 775<p></p>
280<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 776<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
281</dt> 777</dt>
282<dd> 778<dd>
283Create a simple multi-line overlay box. See the next method for details. 779Create a simple multi-line overlay box. See the next method for details.
284</dd> 780</dd>
285<p></p> 781<p></p>
286<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 782<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
287</dt> 783</dt>
288<dd> 784<dd>
289Create a new (empty) overlay at the given position with the given 785Create a new (empty) overlay at the given position with the given
290width/height. A border will be put around the box. If either <code>$x</code> or 786width/height. <code>$rstyle</code> defines the initial rendition style
291<code>$y</code> is negative, then this is counted from the right/bottom side, 787(default: <code>OVERLAY_RSTYLE</code>).
292respectively.
293</dd>
294<p></p>
295<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
296</dt>
297<dd> 788</dd>
298Switch the overlay off again.
299</dd> 789<dd>
300<p></p> 790<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
301<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 791around the box.</p>
302</dt>
303<dd> 792</dd>
304Put a single character (specified numerically) at the given overlay
305position.
306</dd> 793<dd>
307<p></p> 794<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
308<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 795right/bottom side, respectively.</p>
309</dt>
310<dd> 796</dd>
311Write a string at the given position into the overlay. 797<dd>
798<p>This method returns an urxvt::overlay object. The overlay will be visible
799as long as the perl object is referenced.</p>
800</dd>
801<dd>
802<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
803</dd>
804<dl>
805<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
806</dt>
807<dd>
808Similar 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
809text in rxvt-unicode's special encoding and an array of rendition values
810at a specific position inside the overlay.
811</dd>
812<p></p>
813<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
814</dt>
815<dd>
816If visible, hide the overlay, but do not destroy it.
817</dd>
818<p></p>
819<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
820</dt>
821<dd>
822If hidden, display the overlay again.
823</dd>
824<p></p></dl>
825<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
826</dt>
827<dd>
828Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
829<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
830currently).
831</dd>
832<p></p>
833<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
834</dt>
835<dd>
836Returns the number of screen-cells this string would need. Correctly
837accounts for wide and combining characters.
838</dd>
839<p></p>
840<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
841</dt>
842<dd>
843Convert the given text string into the corresponding locale encoding.
844</dd>
845<p></p>
846<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
847</dt>
848<dd>
849Convert the given locale-encoded octets into a perl string.
850</dd>
851<p></p>
852<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
853</dt>
854<dd>
855XORs the rendition values in the given span with the provided value
856(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
857refresh hooks to provide effects similar to the selection.
858</dd>
859<p></p>
860<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
861</dt>
862<dd>
863Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
864whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
865to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
866it instead. Both styles <em>MUST NOT</em> contain font styles.
867</dd>
868<p></p>
869<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
870</dt>
871<dd>
872Ring the bell!
873</dd>
874<p></p>
875<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
876</dt>
877<dd>
878Write the given text string to the screen, as if output by the application
879running inside the terminal. It may not contain command sequences (escape
880codes), but is free to use line feeds, carriage returns and tabs. The
881string is a normal text string, not in locale-dependent encoding.
882</dd>
883<dd>
884<p>Normally its not a good idea to use this function, as programs might be
885confused by changes in cursor position or scrolling. Its useful inside a
886<code>on_add_lines</code> hook, though.</p>
887</dd>
888<p></p>
889<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
890</dt>
891<dd>
892Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
893locale-specific encoding of the terminal and can contain command sequences
894(escape codes) that will be interpreted.
895</dd>
896<p></p>
897<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
898</dt>
899<dd>
900Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
901pass characters instead of octets, you should convert your strings first
902to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
903</dd>
904<p></p>
905<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
906</dt>
907<dd>
908Replaces the event mask of the pty watcher by the given event mask. Can
909be used to suppress input and output handling to the pty/tty. See the
910description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
911the previous value.
912</dd>
913<p></p>
914<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
915</dt>
916<dd>
917Return the window id of the toplevel window.
918</dd>
919<p></p>
920<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
921</dt>
922<dd>
923Return the window id of the terminal window.
924</dd>
925<p></p>
926<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
927</dt>
928<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
929</dt>
930<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
931</dt>
932<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
933</dt>
934<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
935</dt>
936<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
937</dt>
938<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
939</dt>
940<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
941</dt>
942<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
943</dt>
944<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
945</dt>
946<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
947</dt>
948<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
949</dt>
950<dd>
951Return various integers describing terminal characteristics.
952</dd>
953<p></p>
954<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
955</dt>
956<dd>
957Return the DISPLAY used by rxvt-unicode.
958</dd>
959<p></p>
960<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
961</dt>
962<dd>
963Returns the LC_CTYPE category string used by this rxvt-unicode.
964</dd>
965<p></p>
966<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
967</dt>
968<dd>
969Returns a copy of the environment in effect for the terminal as a hashref
970similar to <code>\%ENV</code>.
971</dd>
972<p></p>
973<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
974</dt>
975<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
976</dt>
977<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
978</dt>
979<dd>
980Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
981AltGr), the meta key (often Alt) and the num lock key, if applicable.
982</dd>
983<p></p>
984<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
985</dt>
986<dd>
987Returns the negative row number of the topmost line. Minimum value is
988<code>0</code>, which displays the normal terminal contents. Larger values scroll
989this many lines into the scrollback buffer.
990</dd>
991<p></p>
992<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
993</dt>
994<dd>
995Requests a screen refresh. At the next opportunity, rxvt-unicode will
996compare the on-screen display with its stored representation. If they
997differ, it redraws the differences.
998</dd>
999<dd>
1000<p>Used after changing terminal contents to display them.</p>
1001</dd>
1002<p></p>
1003<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1004</dt>
1005<dd>
1006Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1007is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1008terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1009line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
1010is requested.
1011</dd>
1012<dd>
1013<p>If <code>$new_text</code> is specified, it will replace characters in the current
1014line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1015to replace only parts of a line. The font index in the rendition will
1016automatically be updated.</p>
1017</dd>
1018<dd>
1019<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1020than one cell when displayed are padded with urxvt::NOCHAR characters
1021(<code>chr 65535</code>). Characters with combining characters and other characters
1022that do not fit into the normal tetx encoding will be replaced with
1023characters in the private use area.</p>
1024</dd>
1025<dd>
1026<p>You have to obey this encoding when changing text. The advantage is
1027that <code>substr</code> and similar functions work on screen cells and not on
1028characters.</p>
1029</dd>
1030<dd>
1031<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>
1032can be used to convert normal strings into this encoding and vice versa.</p>
1033</dd>
1034<p></p>
1035<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1036</dt>
1037<dd>
1038Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1039bitsets. Rendition bitsets contain information about colour, font, font
1040styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1041</dd>
1042<dd>
1043<p>When setting rendition, the font mask will be ignored.</p>
1044</dd>
1045<dd>
1046<p>See the section on RENDITION, above.</p>
1047</dd>
1048<p></p>
1049<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1050</dt>
1051<dd>
1052Returns the number of screen cells that are in use (``the line
1053length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1054line is joined with the following one.
1055</dd>
1056<p></p>
1057<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1058</dt>
1059<dd>
1060Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1061joined with the following row), which means all characters are in use
1062and it is continued on the next row (and possibly a continuation of the
1063previous row(s)).
1064</dd>
1065<p></p>
1066<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1067</dt>
1068<dd>
1069Create and return a new <code>urxvt::line</code> object that stores information
1070about the logical line that row <code>$row_number</code> is part of. It supports the
1071following methods:
1072</dd>
1073<dl>
1074<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1075</dt>
1076<dd>
1077Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1078</dd>
1079<p></p>
1080<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1081</dt>
1082<dd>
1083Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1084</dd>
1085<p></p>
1086<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1087</dt>
1088<dd>
1089Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1090</dd>
1091<p></p>
1092<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1093</dt>
1094<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1095</dt>
1096<dd>
1097Return the row number of the first/last row of the line, respectively.
1098</dd>
1099<p></p>
1100<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1101</dt>
1102<dd>
1103Returns the character offset of the given row|col pair within the logical
1104line. Works for rows outside the line, too, and returns corresponding
1105offsets outside the string.
1106</dd>
1107<p></p>
1108<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1109</dt>
1110<dd>
1111Translates a string offset into terminal coordinates again.
1112</dd>
1113<p></p></dl>
1114<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1115</dt>
1116<dd>
1117Converts a perl string into the special encoding used by rxvt-unicode,
1118where one character corresponds to one screen cell. See
1119<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1120</dd>
1121<p></p>
1122<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1123</dt>
1124<dd>
1125Converts rxvt-unicodes text reprsentation into a perl string. See
1126<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1127</dd>
1128<p></p>
1129<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1130</dt>
1131<dd>
1132Registers a synchronous button grab. See the XGrabButton manpage.
1133</dd>
1134<p></p>
1135<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1136</dt>
1137<dd>
1138Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1139synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1140</dd>
1141<p></p>
1142<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1143</dt>
1144<dd>
1145Calls XAllowEvents with AsyncBoth for the most recent grab.
1146</dd>
1147<p></p>
1148<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1149</dt>
1150<dd>
1151Calls XAllowEvents with SyncBoth for the most recent grab.
1152</dd>
1153<p></p>
1154<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1155</dt>
1156<dd>
1157Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1158recent grab.
1159</dd>
1160<p></p>
1161<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1162</dt>
1163<dd>
1164Calls XUngrab for the most recent grab. Is called automatically on
1165evaluation errors, as it is better to lose the grab in the error case as
1166the session.
1167</dd>
1168<p></p></dl>
1169<p>
1170</p>
1171<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1172<dl>
1173<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1174</dt>
1175<dd>
1176Adds a non-clickable title to the popup.
1177</dd>
1178<p></p>
1179<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1180</dt>
1181<dd>
1182Creates a separator, optionally using the character given as <code>$sepchr</code>.
1183</dd>
1184<p></p>
1185<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1186</dt>
1187<dd>
1188Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1189selected.
1190</dd>
1191<p></p>
1192<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1193</dt>
1194<dd>
1195Adds a toggle/checkbox item to the popup. Teh callback gets called
1196whenever it gets toggled, with a boolean indicating its value as its first
1197argument.
1198</dd>
1199<p></p>
1200<dt><strong>$popup-&gt;show</strong><br />
1201</dt>
1202<dd>
1203Displays the popup (which is initially hidden).
312</dd> 1204</dd>
313<p></p></dl> 1205<p></p></dl>
314<p> 1206<p>
315</p> 1207</p>
316<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1208<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
317<p>This class implements timer watchers/events. Time is represented as a 1209<p>This class implements timer watchers/events. Time is represented as a
318fractional number of seconds since the epoch. Example:</p> 1210fractional number of seconds since the epoch. Example:</p>
319<pre> 1211<pre>
320 # create a digital clock display in upper right corner 1212 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
321 $term-&gt;{timer} = urxvt::timer 1213 $term-&gt;{timer} = urxvt::timer
322 -&gt;new 1214 -&gt;new
323 -&gt;start (urxvt::NOW) 1215 -&gt;interval (1)
324 -&gt;cb (sub { 1216 -&gt;cb (sub {
325 my ($timer) = @_;
326 my $time = $timer-&gt;at;
327 $timer-&gt;start ($time + 1);
328 $self-&gt;scr_overlay (-1, 0, 1217 $term-&gt;{overlay}-&gt;set (0, 0,
329 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 1218 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
330 });</pre> 1219 });</pre>
331<dl> 1220<dl>
332<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1221<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
333</dt> 1222</dt>
334<dd> 1223<dd>
335Create a new timer object in stopped state. 1224Create a new timer object in started state. It is scheduled to fire
1225immediately.
336</dd> 1226</dd>
337<p></p> 1227<p></p>
338<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1228<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
339</dt> 1229</dt>
340<dd> 1230<dd>
… …
345</dt> 1235</dt>
346<dd> 1236<dd>
347Return the time this watcher will fire next. 1237Return the time this watcher will fire next.
348</dd> 1238</dd>
349<p></p> 1239<p></p>
350<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 1240<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
351</dt> 1241</dt>
352<dd> 1242<dd>
353Set the time the event is generated to $tstamp. 1243Set the time the event is generated to $tstamp.
1244</dd>
1245<p></p>
1246<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1247</dt>
1248<dd>
1249Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1250stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1251is automatically rescheduled at the given intervals.
354</dd> 1252</dd>
355<p></p> 1253<p></p>
356<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1254<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
357</dt> 1255</dt>
358<dd> 1256<dd>
… …
378<pre> 1276<pre>
379 $term-&gt;{socket} = ... 1277 $term-&gt;{socket} = ...
380 $term-&gt;{iow} = urxvt::iow 1278 $term-&gt;{iow} = urxvt::iow
381 -&gt;new 1279 -&gt;new
382 -&gt;fd (fileno $term-&gt;{socket}) 1280 -&gt;fd (fileno $term-&gt;{socket})
383 -&gt;events (1) # wait for read data 1281 -&gt;events (urxvt::EVENT_READ)
384 -&gt;start 1282 -&gt;start
385 -&gt;cb (sub { 1283 -&gt;cb (sub {
386 my ($iow, $revents) = @_; 1284 my ($iow, $revents) = @_;
387 # $revents must be 1 here, no need to check 1285 # $revents must be 1 here, no need to check
388 sysread $term-&gt;{socket}, my $buf, 8192 1286 sysread $term-&gt;{socket}, my $buf, 8192
… …
409</dd> 1307</dd>
410<p></p> 1308<p></p>
411<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1309<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
412</dt> 1310</dt>
413<dd> 1311<dd>
414Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1312Set the event mask to watch. The only allowed values are
415data, Bit #1 (value <code>2</code>) enables watching for write data. 1313<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1314together, or <code>urxvt::EVENT_NONE</code>.
416</dd> 1315</dd>
417<p></p> 1316<p></p>
418<dt><strong>$iow = $iow-&gt;start</strong><br /> 1317<dt><strong>$iow = $iow-&gt;start</strong><br />
419</dt> 1318</dt>
420<dd> 1319<dd>
… …
434<p> 1333<p>
435</p> 1334</p>
436<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1335<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
437<p>This variable controls the verbosity level of the perl extension. Higher 1336<p>This variable controls the verbosity level of the perl extension. Higher
438numbers indicate more verbose output.</p> 1337numbers indicate more verbose output.</p>
439<ol> 1338<dl>
440<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1339<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
441</li> 1340</dt>
442<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1341<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1342</dt>
1343<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1344</dt>
1345<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1346</dt>
443</li> 1347</dl>
444<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
445</li>
446</ol>
447<p> 1348<p>
448</p> 1349</p>
449<hr /> 1350<hr />
450<h1><a name="author">AUTHOR</a></h1> 1351<h1><a name="author">AUTHOR</a></h1>
451<pre> 1352<pre>

Diff Legend

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