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.8 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.33 by root, Thu Jan 19 19:26:31 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="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <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>
22 <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>
23 <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>
24 <li><a href="#rendition">RENDITION</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>
25 <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>
26 <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>
27 <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>
28 </ul> 33 </ul>
29 34
30 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
60 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
61<p> 66<p>
62</p> 67</p>
63<hr /> 68<hr />
64<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
65<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
66<code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
67<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
68thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
69<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
70scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
71<p> 76<p>
72</p> 77</p>
73<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
74<p>This section describes the extensiosn delivered with this version. You can 80<p>This section describes the extensions delivered with this release. You can
75find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
76<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
77<pre> 83<pre>
78 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
79<dl> 85<dl>
80<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
81</dt> 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>.
82<dd> 94</dd>
83Miscellaneous selection modifications. 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>
84</dd> 126</dd>
85<dl> 127<dl>
86<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
87</dt> 129</dt>
88<dd> 130<dd>
… …
91<dd> 133<dd>
92<pre> 134<pre>
93 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
94</dd> 136</dd>
95<p></p></dl> 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<dd>
153<p>Other extensions can extend this popup menu by pushing a code reference
154onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
155popup is displayed.</p>
156</dd>
157<dd>
158<p>It's sole argument is the popup menu, which can be modified. The selection
159is in <code>$_</code>, which can be used to decide wether to add something or not.
160It should either return nothing or a string and a code reference. The
161string will be used as button text and the code reference will be called
162when the button gets activated and should transform <code>$_</code>.</p>
163</dd>
164<dd>
165<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
166the selection to <code>b</code>s, but only if the selection currently contains any
167<code>a</code>s:</p>
168</dd>
169<dd>
170<pre>
171 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
172 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
173 : ()
174 };</pre>
175</dd>
176<p></p>
177<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
178</dt>
179<dd>
180Adds regex search functionality to the scrollback buffer, triggered
181by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
182input/output is suspended and a regex is displayed at the bottom of the
183screen.
184</dd>
185<dd>
186<p>Inputting characters appends them to the regex and continues incremental
187search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
188search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
189bottom. <code>Escape</code> leaves search mode and returns to the point where search
190was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
191additionally stores the first match in the current line into the primary
192selection.</p>
193</dd>
194<p></p>
195<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
196</dt>
197<dd>
198This selection allows you to do automatic transforms on a selection
199whenever a selection is made.
200</dd>
201<dd>
202<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
203operator) that modify <code>$_</code> as resources:</p>
204</dd>
205<dd>
206<pre>
207 URxvt.selection-autotransform.0: transform
208 URxvt.selection-autotransform.1: transform
209 ...</pre>
210</dd>
211<dd>
212<p>For example, the following will transform selections of the form
213<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
214$word</code>:</p>
215</dd>
216<dd>
217<pre>
218 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
219</dd>
220<dd>
221<p>And this example matches the same,but replaces it with vi-commands you can
222paste directly into your (vi :) editor:</p>
223</dd>
224<dd>
225<pre>
226 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
227</dd>
228<dd>
229<p>Of course, this can be modified to suit your needs and your editor :)</p>
230</dd>
231<dd>
232<p>To expand the example above to typical perl error messages (``XXX at
233FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
234</dd>
235<dd>
236<pre>
237 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
238 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
239</dd>
240<dd>
241<p>The first line tells the selection code to treat the unchanging part of
242every error message as a selection pattern, and the second line transforms
243the message into vi commands to load the file.</p>
244</dd>
245<p></p>
246<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
247</dt>
248<dd>
249Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
250make them clickable. When middle-clicked, the program specified in the
251resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
252the URL as first argument.
253</dd>
254<p></p>
255<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
256</dt>
257<dd>
258This is basically a one-line extension that dynamically changes the background pixmap offset
259to the window position, in effect creating the same effect as pseudo transparency with
260a custom pixmap. No scaling is supported in this mode. Exmaple:
261</dd>
262<dd>
263<pre>
264 rxvt -pixmap background.xpm -pe automove-background</pre>
265</dd>
266<p></p>
267<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
268</dt>
269<dd>
270A not very useful example of filtering all text output to the terminal,
271by replacing all line-drawing characters (U+2500 .. U+259F) by a
272similar-looking ascii character.
273</dd>
274<p></p>
96<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 275<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
97</dt> 276</dt>
98<dd> 277<dd>
99Displays a digital clock using the built-in overlay. 278Displays a digital clock using the built-in overlay.
100</dd> 279</dd>
… …
104<dd> 283<dd>
105Displays a very simple digital clock in the upper right corner of the 284Displays a very simple digital clock in the upper right corner of the
106window. Illustrates overwriting the refresh callbacks to create your own 285window. Illustrates overwriting the refresh callbacks to create your own
107overlays or changes. 286overlays or changes.
108</dd> 287</dd>
288<p></p>
289<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
290</dt>
291<dd>
292This is a little rarely useful extension that Uploads the selection as
293textfile to a remote site (or does other things). (The implementation is
294not currently secure for use in a multiuser environment as it writes to
295<em>/tmp</em> directly.).
296</dd>
297<dd>
298<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
299i.e.</p>
300</dd>
301<dd>
302<pre>
303 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
304</dd>
305<dd>
306<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
307the textfile. This command can be set via a resource:</p>
308</dd>
309<dd>
310<pre>
311 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
312</dd>
313<dd>
314<p>And the default is likely not useful to anybody but the few people around
315here :)</p>
316</dd>
317<dd>
318<p>The name of the textfile is the hex encoded md5 sum of the selection, so
319the same content should lead to the same filename.</p>
320</dd>
321<dd>
322<p>After a successful upload the selection will be replaced by the text given
323in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
324for the filename):</p>
325</dd>
326<dd>
327<pre>
328 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
329</dd>
109<p></p></dl> 330<p></p></dl>
331<p>
332</p>
333<hr />
334<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
110<p> 335<p>
111</p> 336</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 337<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 338<p>All objects (such as terminals, time watchers etc.) are typical
114reference-to-hash objects. The hash can be used to store anything you 339reference-to-hash objects. The hash can be used to store anything you
115like. All members starting with an underscore (such as <code>_ptr</code> or 340like. All members starting with an underscore (such as <code>_ptr</code> or
116<code>_hook</code>) are reserved for internal uses and must not be accessed or 341<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 342modified).</p>
118<p>When objects are destroyed on the C++ side, the perl object hashes are 343<p>When objects are destroyed on the C++ side, the perl object hashes are
119emptied, so its best to store related objects such as time watchers and 344emptied, so its best to store related objects such as time watchers and
120the like inside the terminal object so they get destroyed as soon as the 345the like inside the terminal object so they get destroyed as soon as the
121terminal is destroyed.</p> 346terminal is destroyed.</p>
347<p>Argument names also often indicate the type of a parameter. Here are some
348hints on what they mean:</p>
349<dl>
350<dt><strong><a name="item__24text">$text</a></strong><br />
351</dt>
352<dd>
353Rxvt-unicodes special way of encoding text, where one ``unicode'' character
354always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
355</dd>
356<p></p>
357<dt><strong><a name="item__24string">$string</a></strong><br />
358</dt>
359<dd>
360A perl text string, with an emphasis on <em>text</em>. It can store all unicode
361characters and is to be distinguished with text encoded in a specific
362encoding (often locale-specific) and binary data.
363</dd>
364<p></p>
365<dt><strong><a name="item__24octets">$octets</a></strong><br />
366</dt>
367<dd>
368Either binary data or - more common - a text string encoded in a
369locale-specific way.
370</dd>
371<p></p></dl>
372<p>
373</p>
374<h2><a name="extension_objects">Extension Objects</a></h2>
375<p>Very perl extension is a perl class. A separate perl object is created
376for each terminal and each extension and passed as the first parameter to
377hooks. So extensions can use their <code>$self</code> object without having to think
378about other extensions, with the exception of methods and members that
379begin with an underscore character <code>_</code>: these are reserved for internal
380use.</p>
381<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
382<code>urxvt::term</code> class on this object.</p>
383<p>It has the following methods and data members:</p>
384<dl>
385<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
386</dt>
387<dd>
388Returns the <code>urxvt::term</code> object associated with this instance of the
389extension. This member <em>must not</em> be changed in any way.
390</dd>
391<p></p>
392<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
393</dt>
394<dd>
395Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
396this extension, replacing any previous hook. This is useful when you want
397to overwrite time-critical hooks only temporarily.
398</dd>
399<p></p>
400<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
401</dt>
402<dd>
403Dynamically disable the given hooks.
404</dd>
405<p></p></dl>
122<p> 406<p>
123</p> 407</p>
124<h2><a name="hooks">Hooks</a></h2> 408<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 409<p>The following subroutines can be declared in extension files, and will be
126whenever the relevant event happens.</p> 410called whenever the relevant event happens.</p>
411<p>The first argument passed to them is an extension oject as described in
412the in the <code>Extension Objects</code> section.</p>
127<p>All of them must return a boolean value. If it is true, then the event 413<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
128counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 414event counts as being <em>consumed</em>, and the invocation of other hooks is
129and the relevant action might not be carried out by the C++ code.</p> 415skipped, and the relevant action might not be carried out by the C++ code.</p>
130<p>When in doubt, return a false value (preferably <code>()</code>).</p> 416<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
131<dl> 417<dl>
132<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 418<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
133</dt> 419</dt>
134<dd> 420<dd>
135Called after a new terminal object has been initialized, but before 421Called after a new terminal object has been initialized, but before
136windows are created or the command gets run. 422windows are created or the command gets run. Most methods are unsafe to
423call or deliver senseless data, as terminal size and other characteristics
424have not yet been determined. You can safely query and change resources,
425though.
137</dd> 426</dd>
138<p></p> 427<p></p>
139<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 428<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
140</dt> 429</dt>
141<dd> 430<dd>
… …
149<dd> 438<dd>
150Called at the very end of initialisation of a new terminal, just before 439Called at the very end of initialisation of a new terminal, just before
151returning to the mainloop. 440returning to the mainloop.
152</dd> 441</dd>
153<p></p> 442<p></p>
443<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
444</dt>
445<dd>
446Called just after the child process has been <code>fork</code>ed.
447</dd>
448<p></p>
449<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
450</dt>
451<dd>
452Called just after the child process has exited. <code>$status</code> is the status
453from <code>waitpid</code>.
454</dd>
455<p></p>
154<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 456<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
155</dt> 457</dt>
156<dd> 458<dd>
157Called whenever a selection has been made by the user, but before the 459Called whenever a selection has been made by the user, but before the
158selection text is copied, so changes to the beginning, end or type of the 460selection text is copied, so changes to the beginning, end or type of the
… …
172</dd> 474</dd>
173<dd> 475<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 476<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 477</dd>
176<p></p> 478<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 479<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
178</dt> 480</dt>
179<dd>
180Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing.
182</dd> 481<dd>
183<p></p> 482Called whenever the user tries to extend the selection (e.g. with a double
184<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 483click) and is either supposed to return false (normal operation), or
185</dt> 484should extend the selection itelf and return true to suppress the built-in
485processing. This can happen multiple times, as long as the callback
486returns true, it will be called on every further click by the user and is
487supposed to enlarge the selection more and more, if possible.
186<dd> 488</dd>
187Called wheneever the window loses keyboard focus, before urxvt does focus 489<dd>
188out processing. 490<p>See the <em>selection</em> example extension.</p>
189</dd> 491</dd>
190<p></p> 492<p></p>
191<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 493<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
192</dt> 494</dt>
193<dd> 495<dd>
… …
207<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 509<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
208$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 510$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
209number of lines that will be in the scrollback buffer.</p> 511number of lines that will be in the scrollback buffer.</p>
210</dd> 512</dd>
211<p></p> 513<p></p>
212<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 514<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
213</dt> 515</dt>
516<dd>
517Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
518operating system command) is processed. Cursor position and other state
519information is up-to-date when this happens. For interoperability, the
520string should start with the extension name and a colon, to distinguish
521it from commands for other extensions, and this might be enforced in the
522future.
214<dd> 523</dd>
215Called whenever the <code>program(s)</code> running in the urxvt window send output. 524<dd>
525<p>Be careful not ever to trust (in a security sense) the data you receive,
526as its source can not easily be controleld (e-mail content, messages from
527other users on the same system etc.).</p>
528</dd>
529<p></p>
530<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
531</dt>
532<dd>
533Called whenever text is about to be output, with the text as argument. You
534can filter/change and output the text yourself by returning a true value
535and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
536might be very slow, however, as your hook is called for <strong>all</strong> text being
537output.
538</dd>
539<p></p>
540<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
541</dt>
542<dd>
543Called whenever some data is written to the tty/pty and can be used to
544suppress or filter tty input.
545</dd>
546<p></p>
547<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
548</dt>
549<dd>
550Called whenever a line was updated or changed. Can be used to filter
551screen output (e.g. underline urls or other useless stuff). Only lines
552that are being shown will be filtered, and, due to performance reasons,
553not always immediately.
554</dd>
555<dd>
556<p>The row number is always the topmost row of the line if the line spans
557multiple rows.</p>
558</dd>
559<dd>
560<p>Please note that, if you change the line, then the hook might get called
561later with the already-modified line (e.g. if unrelated parts change), so
562you cannot just toggle rendition bits, but only set them.</p>
216</dd> 563</dd>
217<p></p> 564<p></p>
218<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 565<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
219</dt> 566</dt>
220<dd> 567<dd>
… …
235<dd> 582<dd>
236Called whenever the user presses a key combination that has a 583Called whenever the user presses a key combination that has a
237<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 584<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
238resource in the <code>rxvt(1)</code> manpage). 585resource in the <code>rxvt(1)</code> manpage).
239</dd> 586</dd>
587<p></p>
588<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
589</dt>
590<dd>
591Called on every X event received on the vt window (and possibly other
592windows). Should only be used as a last resort. Most event structure
593members are not passed.
594</dd>
595<p></p>
596<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
597</dt>
598<dd>
599Called whenever the window gets the keyboard focus, before rxvt-unicode
600does focus in processing.
601</dd>
602<p></p>
603<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
604</dt>
605<dd>
606Called wheneever the window loses keyboard focus, before rxvt-unicode does
607focus out processing.
608</dd>
609<p></p>
610<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
611</dt>
612<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
613</dt>
614<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
615</dt>
616<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
617</dt>
618<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
619</dt>
620<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
621</dt>
622<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
623</dt>
624<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
625</dt>
626<dd>
627Called whenever the corresponding X event is received for the terminal If
628the hook returns true, then the even will be ignored by rxvt-unicode.
629</dd>
630<dd>
631<p>The event is a hash with most values as named by Xlib (see the XEvent
632manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
633and column under the mouse cursor.</p>
634</dd>
635<dd>
636<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
637output, if any, in locale-specific encoding.</p>
638</dd>
639<dd>
640<p>subwindow.</p>
641</dd>
642<p></p></dl>
643<p>
644</p>
645<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
646<dl>
647<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
648</dt>
649<dd>
650The rxvt-unicode library directory, where, among other things, the perl
651modules and scripts are stored.
652</dd>
653<p></p>
654<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
655</dt>
656<dd>
657The resource class and name rxvt-unicode uses to look up X resources.
658</dd>
659<p></p>
660<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
661</dt>
662<dd>
663The basename of the installed binaries, usually <code>urxvt</code>.
664</dd>
665<p></p>
666<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
667</dt>
668<dd>
669The current terminal. This variable stores the current <code>urxvt::term</code>
670object, whenever a callback/hook is executing.
671</dd>
240<p></p></dl> 672<p></p></dl>
241<p> 673<p>
242</p> 674</p>
243<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 675<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
244<dl> 676<dl>
… …
259</dd> 691</dd>
260<dd> 692<dd>
261<p>Using this function has the advantage that its output ends up in the 693<p>Using this function has the advantage that its output ends up in the
262correct place, e.g. on stderr of the connecting urxvtc client.</p> 694correct place, e.g. on stderr of the connecting urxvtc client.</p>
263</dd> 695</dd>
696<dd>
697<p>Messages have a size limit of 1023 bytes currently.</p>
698</dd>
264<p></p> 699<p></p>
265<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 700<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
266</dt> 701</dt>
267<dd> 702<dd>
268Returns the ``current time'' (as per the event loop). 703Returns the ``current time'' (as per the event loop).
704</dd>
705<p></p>
706<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
707</dt>
708<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
709Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
710Button4Mask, Button5Mask, AnyModifier</a></strong><br />
711</dt>
712<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
713ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
714PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
715Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
716KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
717ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
718FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
719</dt>
720<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
721EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
722GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
723UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
724ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
725CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
726SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
727</dt>
728<dd>
729Various constants for use in X calls and event processing.
269</dd> 730</dd>
270<p></p></dl> 731<p></p></dl>
271<p> 732<p>
272</p> 733</p>
273<h2><a name="rendition">RENDITION</a></h2> 734<h2><a name="rendition">RENDITION</a></h2>
… …
305</dt> 766</dt>
306<dd> 767<dd>
307Return the foreground/background colour index, respectively. 768Return the foreground/background colour index, respectively.
308</dd> 769</dd>
309<p></p> 770<p></p>
310<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 771<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
311</dt> 772</dt>
312<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 773<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
313</dt> 774</dt>
314<dd> 775<dd>
315Replace the foreground/background colour in the rendition mask with the 776Replace the foreground/background colour in the rendition mask with the
316specified one. 777specified one.
317</dd> 778</dd>
318<p></p> 779<p></p>
319<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 780<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
320</dt> 781</dt>
321<dd> 782<dd>
322Return the ``custom'' value: Every rendition has 5 bits for use by 783Return the ``custom'' value: Every rendition has 5 bits for use by
323extensions. They can be set and changed as you like and are initially 784extensions. They can be set and changed as you like and are initially
324zero. 785zero.
325</dd> 786</dd>
326<p></p> 787<p></p>
327<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 788<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
328</dt> 789</dt>
329<dd> 790<dd>
330Change the custom value. 791Change the custom value.
331</dd> 792</dd>
332<p></p></dl> 793<p></p></dl>
794<p>
795</p>
796<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
797<p>The sole purpose of this class is to deliver an interface to the
798<code>AnyEvent</code> module - any module using it will work inside urxvt without
799further programming. The only exception is that you cannot wait on
800condition variables, but non-blocking condvar use is ok. What this means
801is that you cannot use blocking APIs, but the non-blocking variant should
802work.</p>
333<p> 803<p>
334</p> 804</p>
335<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 805<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
336<dl> 806<dl>
807<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
808</dt>
809<dd>
810Creates a new terminal, very similar as if you had started it with system
811<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
812hash which defines the environment of the new terminal.
813</dd>
814<dd>
815<p>Croaks (and probably outputs an error message) if the new instance
816couldn't be created. Returns <code>undef</code> if the new instance didn't
817initialise perl, and the terminal object otherwise. The <code>init</code> and
818<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
819</dd>
820<p></p>
821<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
822</dt>
823<dd>
824Destroy the terminal object (close the window, free resources
825etc.). Please note that rxvt will not exit as long as any event
826watchers (timers, io watchers) are still active.
827</dd>
828<p></p>
829<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
830</dt>
831<dd>
832Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
833(``starts'') programs in the background. This function takes care of setting
834the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
835be preferred over explicit calls to <code>exec</code> or <code>system</code>.
836</dd>
837<dd>
838<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
839</dd>
840<p></p>
841<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
842</dt>
843<dd>
844Returns true if the option specified by <code>$optval</code> is enabled, and
845optionally change it. All option values are stored by name in the hash
846<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
847</dd>
848<dd>
849<p>Here is a a likely non-exhaustive list of option names, please see the
850source file <em>/src/optinc.h</em> to see the actual list:</p>
851</dd>
852<dd>
853<pre>
854 borderLess console cursorBlink cursorUnderline hold iconic insecure
855 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
856 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
857 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
858 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
859 transparent tripleclickwords utmpInhibit visualBell</pre>
860</dd>
861<p></p>
337<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 862<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
338</dt> 863</dt>
339<dd> 864<dd>
340Returns the current resource value associated with a given name and 865Returns the current resource value associated with a given name and
341optionally sets a new value. Setting values is most useful in the <code>init</code> 866optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
355<p>Please note that resource strings will currently only be freed when the 880<p>Please note that resource strings will currently only be freed when the
356terminal is destroyed, so changing options frequently will eat memory.</p> 881terminal is destroyed, so changing options frequently will eat memory.</p>
357</dd> 882</dd>
358<dd> 883<dd>
359<p>Here is a a likely non-exhaustive list of resource names, not all of which 884<p>Here is a a likely non-exhaustive list of resource names, not all of which
360are supported in every build, please see the source to see the actual 885are supported in every build, please see the source file <em>/src/rsinc.h</em>
361list:</p> 886to see the actual list:</p>
362</dd> 887</dd>
363<dd> 888<dd>
364<pre> 889<pre>
365 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 890 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
366 borderLess color cursorBlink cursorUnderline cutchars delete_key 891 borderLess color cursorBlink cursorUnderline cutchars delete_key
367 display_name embed ext_bwidth fade font geometry hold iconName 892 display_name embed ext_bwidth fade font geometry hold iconName
368 imFont imLocale inputMethod insecure int_bwidth intensityStyles 893 imFont imLocale inputMethod insecure int_bwidth intensityStyles
369 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 894 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
370 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 895 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
371 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 896 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
372 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 897 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
373 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 898 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
374 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 899 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
375 shade term_name title transparent transparent_all tripleclickwords 900 secondaryScreen secondaryScroll selectstyle shade term_name title
901 transient_for transparent transparent_all tripleclickwords utmpInhibit
376 utmpInhibit visualBell</pre> 902 visualBell</pre>
903</dd>
904<p></p>
905<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
906</dt>
907<dd>
908Returns the X-Resource for the given pattern, excluding the program or
909class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
910same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
911resource with that pattern exists.
912</dd>
913<dd>
914<p>This method should only be called during the <code>on_start</code> hook, as there is
915only one resource database per display, and later invocations might return
916the wrong resources.</p>
917</dd>
918<p></p>
919<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
920</dt>
921<dd>
922Adds a keymap translation exactly as specified via a resource. See the
923<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
924</dd>
925<p></p>
926<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
927</dt>
928<dd>
929Return and optionally change the current rendition. Text that is output by
930the terminal application will use this style.
931</dd>
932<p></p>
933<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
934</dt>
935<dd>
936Return the current coordinates of the text cursor position and optionally
937set it (which is usually bad as applications don't expect that).
377</dd> 938</dd>
378<p></p> 939<p></p>
379<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 940<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
380</dt> 941</dt>
381<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 942<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
385<dd> 946<dd>
386Return the current values of the selection mark, begin or end positions, 947Return the current values of the selection mark, begin or end positions,
387and optionally set them to new values. 948and optionally set them to new values.
388</dd> 949</dd>
389<p></p> 950<p></p>
951<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
952</dt>
953<dd>
954Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
955<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
956rectangular selection will be made. This is the prefered function to make
957a selection.
958</dd>
959<p></p>
390<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 960<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
391</dt> 961</dt>
392<dd> 962<dd>
393Try to request the primary selection from the server (for example, as set 963Try to request the primary selection text from the server (for example, as
394by the next method). 964set by the next method). No visual feedback will be given. This function
965is mostly useful from within <code>on_sel_grab</code> hooks.
395</dd> 966</dd>
396<p></p> 967<p></p>
397<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 968<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
398</dt> 969</dt>
399<dd> 970<dd>
400Return the current selection text and optionally replace it by <code>$newtext</code>. 971Return the current selection text and optionally replace it by <code>$newtext</code>.
401</dd> 972</dd>
973<p></p>
974<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
975</dt>
402<dd> 976<dd>
403<p>#=item $term-&gt;overlay ($x, $y, $text)
404#
405#Create a simple multi-line overlay box. See the next method for details. 977Create a simple multi-line overlay box. See the next method for details.
406#
407#=cut</p>
408</dd>
409<dd>
410<p>sub urxvt::term::scr_overlay {
411die;
412 my ($self, $x, $y, $text) = @_;</p>
413</dd>
414<dd>
415<pre>
416 my @lines = split /\n/, $text;</pre>
417</dd>
418<dd>
419<pre>
420 my $w = 0;
421 for (map $self-&gt;strwidth ($_), @lines) {
422 $w = $_ if $w &lt; $_;
423 }</pre>
424</dd>
425<dd>
426<pre>
427 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
428 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
429}</pre>
430</dd> 978</dd>
431<p></p> 979<p></p>
432<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 980<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
433</dt> 981</dt>
434<dd> 982<dd>
… …
447<dd> 995<dd>
448<p>This method returns an urxvt::overlay object. The overlay will be visible 996<p>This method returns an urxvt::overlay object. The overlay will be visible
449as long as the perl object is referenced.</p> 997as long as the perl object is referenced.</p>
450</dd> 998</dd>
451<dd> 999<dd>
452<p>Currently, the only method on the <code>urxvt::overlay</code> object is <a href="#item_set"><code>set</code></a>:</p> 1000<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
453</dd> 1001</dd>
454<p></p> 1002<dl>
455<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 1003<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
456</dt> 1004</dt>
457<dd> 1005<dd>
458Similar 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 1006Similar 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
459text in rxvt-unicode's special encoding and an array of rendition values 1007text in rxvt-unicode's special encoding and an array of rendition values
460at a specific position inside the overlay. 1008at a specific position inside the overlay.
461</dd> 1009</dd>
462<p></p> 1010<p></p>
1011<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
1012</dt>
1013<dd>
1014If visible, hide the overlay, but do not destroy it.
1015</dd>
1016<p></p>
1017<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
1018</dt>
1019<dd>
1020If hidden, display the overlay again.
1021</dd>
1022<p></p></dl>
1023<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1024</dt>
1025<dd>
1026Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1027<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1028currently).
1029</dd>
1030<p></p>
463<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 1031<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
464</dt> 1032</dt>
465<dd> 1033<dd>
466Returns the number of screen-cells this string would need. Correctly 1034Returns the number of screen-cells this string would need. Correctly
467accounts for wide and combining characters. 1035accounts for wide and combining characters.
468</dd> 1036</dd>
469<p></p> 1037<p></p>
470<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 1038<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
471</dt> 1039</dt>
472<dd> 1040<dd>
473Convert the given text string into the corresponding locale encoding. 1041Convert the given text string into the corresponding locale encoding.
474</dd> 1042</dd>
475<p></p> 1043<p></p>
476<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 1044<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
477</dt> 1045</dt>
478<dd> 1046<dd>
479Convert the given locale-encoded octets into a perl string. 1047Convert the given locale-encoded octets into a perl string.
1048</dd>
1049<p></p>
1050<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 />
1051</dt>
1052<dd>
1053XORs the rendition values in the given span with the provided value
1054(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1055refresh hooks to provide effects similar to the selection.
1056</dd>
1057<p></p>
1058<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 />
1059</dt>
1060<dd>
1061Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1062whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1063to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1064it instead. Both styles <em>MUST NOT</em> contain font styles.
1065</dd>
1066<p></p>
1067<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1068</dt>
1069<dd>
1070Ring the bell!
1071</dd>
1072<p></p>
1073<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1074</dt>
1075<dd>
1076Write the given text string to the screen, as if output by the application
1077running inside the terminal. It may not contain command sequences (escape
1078codes), but is free to use line feeds, carriage returns and tabs. The
1079string is a normal text string, not in locale-dependent encoding.
1080</dd>
1081<dd>
1082<p>Normally its not a good idea to use this function, as programs might be
1083confused by changes in cursor position or scrolling. Its useful inside a
1084<code>on_add_lines</code> hook, though.</p>
1085</dd>
1086<p></p>
1087<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1088</dt>
1089<dd>
1090Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1091locale-specific encoding of the terminal and can contain command sequences
1092(escape codes) that will be interpreted.
480</dd> 1093</dd>
481<p></p> 1094<p></p>
482<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1095<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
483</dt> 1096</dt>
484<dd> 1097<dd>
485Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1098Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
486pass characters instead of octets, you should convert your strings first 1099pass characters instead of octets, you should convert your strings first
487to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1100to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
488</dd> 1101</dd>
489<p></p> 1102<p></p>
1103<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1104</dt>
1105<dd>
1106Replaces the event mask of the pty watcher by the given event mask. Can
1107be used to suppress input and output handling to the pty/tty. See the
1108description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1109the previous value.
1110</dd>
1111<p></p>
1112<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1113</dt>
1114<dd>
1115Return the window id of the toplevel window.
1116</dd>
1117<p></p>
1118<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1119</dt>
1120<dd>
1121Return the window id of the terminal window.
1122</dd>
1123<p></p>
1124<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1125</dt>
1126<dd>
1127Adds the specified events to the vt event mask. Useful e.g. when you want
1128to receive pointer events all the times:
1129</dd>
1130<dd>
1131<pre>
1132 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1133</dd>
1134<p></p>
1135<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1136</dt>
1137<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1138</dt>
1139<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1140</dt>
1141<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1142</dt>
1143<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1144</dt>
490<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 1145<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
491</dt> 1146</dt>
492<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1147<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
493</dt> 1148</dt>
494<dd> 1149<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
495Return the number of rows/columns of the terminal window (i.e. as 1150</dt>
496specified by <code>-geometry</code>, excluding any scrollback). 1151<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1152</dt>
1153<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1154</dt>
1155<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1156</dt>
1157<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1158</dt>
497</dd> 1159<dd>
1160Return various integers describing terminal characteristics.
1161</dd>
498<p></p> 1162<p></p>
1163<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1164</dt>
1165<dd>
1166Return the DISPLAY used by rxvt-unicode.
1167</dd>
1168<p></p>
1169<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1170</dt>
1171<dd>
1172Returns the LC_CTYPE category string used by this rxvt-unicode.
1173</dd>
1174<p></p>
499<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1175<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
500</dt> 1176</dt>
1177<dd>
1178Returns a copy of the environment in effect for the terminal as a hashref
1179similar to <code>\%ENV</code>.
501<dd> 1180</dd>
502Returns the number of lines in the scrollback buffer. 1181<p></p>
1182<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1183</dt>
1184<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1185</dt>
1186<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1187</dt>
1188<dd>
1189Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1190AltGr), the meta key (often Alt) and the num lock key, if applicable.
503</dd> 1191</dd>
504<p></p> 1192<p></p>
505<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1193<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
506</dt> 1194</dt>
507<dd> 1195<dd>
508Returns the negative row number of the topmost line. Minimum value is 1196Returns the row number of the topmost displayed line. Maximum value is
509<code>0</code>, which displays the normal terminal contents. Larger values scroll 1197<code>0</code>, which displays the normal terminal contents. Lower values scroll
510this many lines into the scrollback buffer. 1198this many lines into the scrollback buffer.
511</dd> 1199</dd>
512<p></p> 1200<p></p>
513<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1201<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
514</dt> 1202</dt>
… …
525</dt> 1213</dt>
526<dd> 1214<dd>
527Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1215Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
528is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1216is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
529terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1217terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
530line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. 1218line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1219is requested.
531</dd> 1220</dd>
532<dd> 1221<dd>
533<p>If <code>$new_text</code> is specified, it will replace characters in the current 1222<p>If <code>$new_text</code> is specified, it will replace characters in the current
534line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1223line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
535to replace only parts of a line. The font index in the rendition will 1224to replace only parts of a line. The font index in the rendition will
536automatically be updated.</p> 1225automatically be updated.</p>
537</dd> 1226</dd>
538<dd> 1227<dd>
539<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1228<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
540than one cell when displayed are padded with urxvt::NOCHAR characters 1229than one cell when displayed are padded with urxvt::NOCHAR characters
541(<code>chr 65535</code>). Characters with combining characters and other characters 1230(<code>chr 65535</code>). Characters with combining characters and other characters
542that do not fit into the normal tetx encoding will be replaced with 1231that do not fit into the normal tetx encoding will be replaced with
543characters in the private use area.</p> 1232characters in the private use area.</p>
544</dd> 1233</dd>
… …
567</dd> 1256</dd>
568<p></p> 1257<p></p>
569<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 1258<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
570</dt> 1259</dt>
571<dd> 1260<dd>
572Returns the number of screen cells that are in use (``the line length''). If 1261Returns the number of screen cells that are in use (``the line
573it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which 1262length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
574means all characters are in use and it is continued on the next row. 1263line is joined with the following one.
1264</dd>
1265<p></p>
1266<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1267</dt>
575</dd> 1268<dd>
1269Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1270joined with the following row), which means all characters are in use
1271and it is continued on the next row (and possibly a continuation of the
1272previous row(s)).
1273</dd>
576<p></p> 1274<p></p>
1275<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1276</dt>
1277<dd>
1278Create and return a new <code>urxvt::line</code> object that stores information
1279about the logical line that row <code>$row_number</code> is part of. It supports the
1280following methods:
1281</dd>
1282<dl>
1283<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1284</dt>
1285<dd>
1286Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1287</dd>
1288<p></p>
1289<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1290</dt>
1291<dd>
1292Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1293</dd>
1294<p></p>
1295<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1296</dt>
1297<dd>
1298Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1299</dd>
1300<p></p>
1301<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1302</dt>
1303<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1304</dt>
1305<dd>
1306Return the row number of the first/last row of the line, respectively.
1307</dd>
1308<p></p>
1309<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1310</dt>
1311<dd>
1312Returns the character offset of the given row|col pair within the logical
1313line. Works for rows outside the line, too, and returns corresponding
1314offsets outside the string.
1315</dd>
1316<p></p>
1317<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1318</dt>
1319<dd>
1320Translates a string offset into terminal coordinates again.
1321</dd>
1322<p></p></dl>
577<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 1323<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
578</dt> 1324</dt>
579<dd> 1325<dd>
580Converts a perl string into the special encoding used by rxvt-unicode, 1326Converts a perl string into the special encoding used by rxvt-unicode,
581where one character corresponds to one screen cell. See 1327where one character corresponds to one screen cell. See
… …
585<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1331<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
586</dt> 1332</dt>
587<dd> 1333<dd>
588Converts rxvt-unicodes text reprsentation into a perl string. See 1334Converts rxvt-unicodes text reprsentation into a perl string. See
589<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1335<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1336</dd>
1337<p></p>
1338<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1339</dt>
1340<dd>
1341Registers a synchronous button grab. See the XGrabButton manpage.
1342</dd>
1343<p></p>
1344<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1345</dt>
1346<dd>
1347Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1349</dd>
1350<p></p>
1351<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1352</dt>
1353<dd>
1354Calls XAllowEvents with AsyncBoth for the most recent grab.
1355</dd>
1356<p></p>
1357<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1358</dt>
1359<dd>
1360Calls XAllowEvents with SyncBoth for the most recent grab.
1361</dd>
1362<p></p>
1363<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1364</dt>
1365<dd>
1366Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1367recent grab.
1368</dd>
1369<p></p>
1370<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1371</dt>
1372<dd>
1373Calls XUngrab for the most recent grab. Is called automatically on
1374evaluation errors, as it is better to lose the grab in the error case as
1375the session.
1376</dd>
1377<p></p></dl>
1378<p>
1379</p>
1380<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1381<dl>
1382<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1383</dt>
1384<dd>
1385Adds a non-clickable title to the popup.
1386</dd>
1387<p></p>
1388<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1389</dt>
1390<dd>
1391Creates a separator, optionally using the character given as <code>$sepchr</code>.
1392</dd>
1393<p></p>
1394<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1395</dt>
1396<dd>
1397Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1398selected.
1399</dd>
1400<p></p>
1401<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1402</dt>
1403<dd>
1404Adds a toggle/checkbox item to the popup. Teh callback gets called
1405whenever it gets toggled, with a boolean indicating its value as its first
1406argument.
1407</dd>
1408<p></p>
1409<dt><strong>$popup-&gt;show</strong><br />
1410</dt>
1411<dd>
1412Displays the popup (which is initially hidden).
590</dd> 1413</dd>
591<p></p></dl> 1414<p></p></dl>
592<p> 1415<p>
593</p> 1416</p>
594<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1417<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
647</dt> 1470</dt>
648<dd> 1471<dd>
649Set the event trigger time to <code>$tstamp</code> and start the timer. 1472Set the event trigger time to <code>$tstamp</code> and start the timer.
650</dd> 1473</dd>
651<p></p> 1474<p></p>
1475<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1476</dt>
1477<dd>
1478Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1479</dd>
1480<p></p>
652<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1481<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
653</dt> 1482</dt>
654<dd> 1483<dd>
655Stop the timer. 1484Stop the timer.
656</dd> 1485</dd>
… …
662<pre> 1491<pre>
663 $term-&gt;{socket} = ... 1492 $term-&gt;{socket} = ...
664 $term-&gt;{iow} = urxvt::iow 1493 $term-&gt;{iow} = urxvt::iow
665 -&gt;new 1494 -&gt;new
666 -&gt;fd (fileno $term-&gt;{socket}) 1495 -&gt;fd (fileno $term-&gt;{socket})
667 -&gt;events (1) # wait for read data 1496 -&gt;events (urxvt::EVENT_READ)
668 -&gt;start 1497 -&gt;start
669 -&gt;cb (sub { 1498 -&gt;cb (sub {
670 my ($iow, $revents) = @_; 1499 my ($iow, $revents) = @_;
671 # $revents must be 1 here, no need to check 1500 # $revents must be 1 here, no need to check
672 sysread $term-&gt;{socket}, my $buf, 8192 1501 sysread $term-&gt;{socket}, my $buf, 8192
… …
693</dd> 1522</dd>
694<p></p> 1523<p></p>
695<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1524<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
696</dt> 1525</dt>
697<dd> 1526<dd>
698Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1527Set the event mask to watch. The only allowed values are
699data, Bit #1 (value <code>2</code>) enables watching for write data. 1528<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1529together, or <code>urxvt::EVENT_NONE</code>.
700</dd> 1530</dd>
701<p></p> 1531<p></p>
702<dt><strong>$iow = $iow-&gt;start</strong><br /> 1532<dt><strong>$iow = $iow-&gt;start</strong><br />
703</dt> 1533</dt>
704<dd> 1534<dd>
… …
718<p> 1548<p>
719</p> 1549</p>
720<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1550<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
721<p>This variable controls the verbosity level of the perl extension. Higher 1551<p>This variable controls the verbosity level of the perl extension. Higher
722numbers indicate more verbose output.</p> 1552numbers indicate more verbose output.</p>
723<ol> 1553<dl>
724<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1554<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
725</li> 1555</dt>
726<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1556<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1557</dt>
1558<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1559</dt>
1560<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1561</dt>
727</li> 1562</dl>
728<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
729</li>
730</ol>
731<p> 1563<p>
732</p> 1564</p>
733<hr /> 1565<hr />
734<h1><a name="author">AUTHOR</a></h1> 1566<h1><a name="author">AUTHOR</a></h1>
735<pre> 1567<pre>

Diff Legend

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