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.29 by root, Fri Jan 13 12:40:46 2006 UTC

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

Diff Legend

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