ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.3 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.32 by root, Wed Jan 18 09:40:53 2006 UTC

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

Diff Legend

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