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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.5 by root, Mon Jan 2 21:41:51 2006 UTC vs.
Revision 1.35 by root, Fri Jan 20 22:49:34 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
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>
33 <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li>
34 <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li>
26 </ul> 35 </ul>
27 36
28 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
29 <ul> 38 <ul>
30 39
… …
36<!-- INDEX END --> 45<!-- INDEX END -->
37 46
38<hr /> 47<hr />
39<p> 48<p>
40</p> 49</p>
50<hr />
41<h1><a name="name">NAME</a></h1> 51<h1><a name="name">NAME</a></h1>
42<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
43<p> 53<p>
44</p> 54</p>
45<hr /> 55<hr />
… …
57 rxvt --perl-lib $HOME -pe grab_test</pre> 67 rxvt --perl-lib $HOME -pe grab_test</pre>
58<p> 68<p>
59</p> 69</p>
60<hr /> 70<hr />
61<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
62<p>Everytime a terminal object gets created, scripts specified via the 72<p>Everytime a terminal object gets created, extension scripts specified via
63<code>perl</code> resource are loaded and associated with it.</p> 73the <code>perl</code> resource are loaded and associated with it.</p>
64<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
65thus must be encoded as UTF-8.</p> 75thus must be encoded as UTF-8.</p>
66<p>Each script will only ever be loaded once, even in rxvtd, where 76<p>Each script will only ever be loaded once, even in rxvtd, where
67scripts will be shared (But not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
78<p>
79</p>
80<hr />
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
82<p>This section describes the extensions delivered with this release. You can
83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
84<p>You can activate them like this:</p>
85<pre>
86 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
90<dl>
91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
92</dt>
93<dd>
94(More) intelligent selection. This extension tries to be more intelligent
95when the user extends selections (double-click and further clicks). Right
96now, it tries to select words, urls and complete shell-quoted
97arguments, which is very convenient, too, if your <em>ls</em> supports
98<code>--quoting-style=shell</code>.
99</dd>
100<dd>
101<p>A double-click usually selects the word under the cursor, further clicks
102will enlarge the selection.</p>
103</dd>
104<dd>
105<p>The selection works by trying to match a number of regexes and displaying
106them in increasing order of length. You can add your own regexes by
107specifying resources of the form:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.selection.pattern-0: perl-regex
112 URxvt.selection.pattern-1: perl-regex
113 ...</pre>
114</dd>
115<dd>
116<p>The index number (0, 1...) must not have any holes, and each regex must
117contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything
119between two vertical bars:</p>
120</dd>
121<dd>
122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd>
125<dd>
126<p>You can look at the source of the selection extension to see more
127interesting uses, such as parsing a line from beginning to end.</p>
128</dd>
129<dd>
130<p>This extension also offers following bindable keyboard commands:</p>
131</dd>
132<dl>
133<dt><strong><a name="item_rot13">rot13</a></strong><br />
134</dt>
135<dd>
136Rot-13 the selection when activated. Used via keyboard trigger:
137</dd>
138<dd>
139<pre>
140 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
141</dd>
142<p></p></dl>
143<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
144</dt>
145<dd>
146Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
147runtime.
148</dd>
149<p></p>
150<dt><strong>selection-popup (enabled by default)</strong><br />
151</dt>
152<dd>
153Binds a popup menu to Ctrl-Button3 that lets you convert the selection
154text into various other formats/action (such as uri unescaping, perl
155evaluation, web-browser starting etc.), depending on content.
156</dd>
157<dd>
158<p>Other extensions can extend this popup menu by pushing a code reference
159onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
160popup is displayed.</p>
161</dd>
162<dd>
163<p>It's sole argument is the popup menu, which can be modified. The selection
164is in <code>$_</code>, which can be used to decide wether to add something or not.
165It should either return nothing or a string and a code reference. The
166string will be used as button text and the code reference will be called
167when the button gets activated and should transform <code>$_</code>.</p>
168</dd>
169<dd>
170<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
171the selection to <code>b</code>s, but only if the selection currently contains any
172<code>a</code>s:</p>
173</dd>
174<dd>
175<pre>
176 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
177 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
178 : ()
179 };</pre>
180</dd>
181<p></p>
182<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
183</dt>
184<dd>
185Adds regex search functionality to the scrollback buffer, triggered
186by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
187input/output is suspended and a regex is displayed at the bottom of the
188screen.
189</dd>
190<dd>
191<p>Inputting characters appends them to the regex and continues incremental
192search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
193search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
194bottom. <code>Escape</code> leaves search mode and returns to the point where search
195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
196additionally stores the first match in the current line into the primary
197selection.</p>
198</dd>
199<p></p>
200<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
201</dt>
202<dd>
203This selection allows you to do automatic transforms on a selection
204whenever a selection is made.
205</dd>
206<dd>
207<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
208operator) that modify <code>$_</code> as resources:</p>
209</dd>
210<dd>
211<pre>
212 URxvt.selection-autotransform.0: transform
213 URxvt.selection-autotransform.1: transform
214 ...</pre>
215</dd>
216<dd>
217<p>For example, the following will transform selections of the form
218<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
219$word</code>:</p>
220</dd>
221<dd>
222<pre>
223 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
224</dd>
225<dd>
226<p>And this example matches the same,but replaces it with vi-commands you can
227paste directly into your (vi :) editor:</p>
228</dd>
229<dd>
230<pre>
231 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
232</dd>
233<dd>
234<p>Of course, this can be modified to suit your needs and your editor :)</p>
235</dd>
236<dd>
237<p>To expand the example above to typical perl error messages (``XXX at
238FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
239</dd>
240<dd>
241<pre>
242 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
243 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
244</dd>
245<dd>
246<p>The first line tells the selection code to treat the unchanging part of
247every error message as a selection pattern, and the second line transforms
248the message into vi commands to load the file.</p>
249</dd>
250<p></p>
251<dt><strong><a name="item_readline">readline</a></strong><br />
252</dt>
253<dd>
254A support package that tries to make editing with readline easier. At the
255moment, it reacts to clicking with the left mouse button by trying to
256move the text cursor to this position. It does so by generating as many
257cursor-left or cursor-right keypresses as required (the this only works
258for programs that correctly support wide characters).
259</dd>
260<dd>
261<p>It only works when clicking into the same line (possibly extended over
262multiple rows) as the text cursor and on the primary screen, to reduce the
263risk of misinterpreting. The normal selection isn't disabled, so quick
264successive clicks might interfere with selection creation in harmless
265ways.</p>
266</dd>
267<p></p>
268<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
269</dt>
270<dd>
271This transforms the terminal into a tabbar with additional terminals, that
272is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
273displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
274button per tab.
275</dd>
276<dd>
277<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
278<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
279while <strong>Shift-Down</strong> creates a new tab.</p>
280</dd>
281<p></p>
282<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
283</dt>
284<dd>
285Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
286make them clickable. When middle-clicked, the program specified in the
287resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
288the URL as first argument.
289</dd>
290<p></p>
291<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
292</dt>
293<dd>
294This is basically a one-line extension that dynamically changes the background pixmap offset
295to the window position, in effect creating the same effect as pseudo transparency with
296a custom pixmap. No scaling is supported in this mode. Exmaple:
297</dd>
298<dd>
299<pre>
300 rxvt -pixmap background.xpm -pe automove-background</pre>
301</dd>
302<p></p>
303<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
304</dt>
305<dd>
306A not very useful example of filtering all text output to the terminal,
307by replacing all line-drawing characters (U+2500 .. U+259F) by a
308similar-looking ascii character.
309</dd>
310<p></p>
311<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
312</dt>
313<dd>
314Displays a digital clock using the built-in overlay.
315</dd>
316<p></p>
317<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
318</dt>
319<dd>
320Displays a very simple digital clock in the upper right corner of the
321window. Illustrates overwriting the refresh callbacks to create your own
322overlays or changes.
323</dd>
324<p></p>
325<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
326</dt>
327<dd>
328This is a little rarely useful extension that Uploads the selection as
329textfile to a remote site (or does other things). (The implementation is
330not currently secure for use in a multiuser environment as it writes to
331<em>/tmp</em> directly.).
332</dd>
333<dd>
334<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
335i.e.</p>
336</dd>
337<dd>
338<pre>
339 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
340</dd>
341<dd>
342<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
343the textfile. This command can be set via a resource:</p>
344</dd>
345<dd>
346<pre>
347 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
348</dd>
349<dd>
350<p>And the default is likely not useful to anybody but the few people around
351here :)</p>
352</dd>
353<dd>
354<p>The name of the textfile is the hex encoded md5 sum of the selection, so
355the same content should lead to the same filename.</p>
356</dd>
357<dd>
358<p>After a successful upload the selection will be replaced by the text given
359in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
360for the filename):</p>
361</dd>
362<dd>
363<pre>
364 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
365</dd>
366<p></p></dl>
367<p>
368</p>
369<hr />
370<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
68<p> 371<p>
69</p> 372</p>
70<h2><a name="general_api_considerations">General API Considerations</a></h2> 373<h2><a name="general_api_considerations">General API Considerations</a></h2>
71<p>All objects (such as terminals, time watchers etc.) are typical 374<p>All objects (such as terminals, time watchers etc.) are typical
72reference-to-hash objects. The hash can be used to store anything you 375reference-to-hash objects. The hash can be used to store anything you
73like. All members starting with an underscore (such as <code>_ptr</code> or 376like. All members starting with an underscore (such as <code>_ptr</code> or
74<code>_hook</code>) are reserved for internal uses and must not be accessed or 377<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
75modified).</p> 378modified).</p>
76<p>When objects are destroyed on the C++ side, the perl object hashes are 379<p>When objects are destroyed on the C++ side, the perl object hashes are
77emptied, so its best to store related objects such as time watchers and 380emptied, so its best to store related objects such as time watchers and
78the like inside the terminal object so they get destroyed as soon as the 381the like inside the terminal object so they get destroyed as soon as the
79terminal is destroyed.</p> 382terminal is destroyed.</p>
383<p>Argument names also often indicate the type of a parameter. Here are some
384hints on what they mean:</p>
385<dl>
386<dt><strong><a name="item__24text">$text</a></strong><br />
387</dt>
388<dd>
389Rxvt-unicodes special way of encoding text, where one ``unicode'' character
390always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
391</dd>
392<p></p>
393<dt><strong><a name="item__24string">$string</a></strong><br />
394</dt>
395<dd>
396A perl text string, with an emphasis on <em>text</em>. It can store all unicode
397characters and is to be distinguished with text encoded in a specific
398encoding (often locale-specific) and binary data.
399</dd>
400<p></p>
401<dt><strong><a name="item__24octets">$octets</a></strong><br />
402</dt>
403<dd>
404Either binary data or - more common - a text string encoded in a
405locale-specific way.
406</dd>
407<p></p></dl>
408<p>
409</p>
410<h2><a name="extension_objects">Extension Objects</a></h2>
411<p>Very perl extension is a perl class. A separate perl object is created
412for each terminal and each extension and passed as the first parameter to
413hooks. So extensions can use their <code>$self</code> object without having to think
414about other extensions, with the exception of methods and members that
415begin with an underscore character <code>_</code>: these are reserved for internal
416use.</p>
417<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
418<code>urxvt::term</code> class on this object.</p>
419<p>It has the following methods and data members:</p>
420<dl>
421<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
422</dt>
423<dd>
424Returns the <code>urxvt::term</code> object associated with this instance of the
425extension. This member <em>must not</em> be changed in any way.
426</dd>
427<p></p>
428<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
429</dt>
430<dd>
431Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
432this extension, replacing any previous hook. This is useful when you want
433to overwrite time-critical hooks only temporarily.
434</dd>
435<p></p>
436<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
437</dt>
438<dd>
439Dynamically disable the given hooks.
440</dd>
441<p></p></dl>
80<p> 442<p>
81</p> 443</p>
82<h2><a name="hooks">Hooks</a></h2> 444<h2><a name="hooks">Hooks</a></h2>
83<p>The following subroutines can be declared in loaded scripts, and will be called 445<p>The following subroutines can be declared in extension files, and will be
84whenever the relevant event happens.</p> 446called whenever the relevant event happens.</p>
85<p>All of them must return a boolean value. If it is true, then the event 447<p>The first argument passed to them is an extension oject as described in
86counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 448the in the <code>Extension Objects</code> section.</p>
449<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
450hooks returns true, then the event counts as being <em>consumed</em>, and the
87and the relevant action might not be carried out by the C++ code.</p> 451relevant action might not be carried out by the C++ code.</p>
88<p>When in doubt, return a false value (preferably <code>()</code>).</p> 452<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
89<dl> 453<dl>
90<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 454<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
91</dt> 455</dt>
92<dd> 456<dd>
93Called after a new terminal object has been initialized, but before 457Called after a new terminal object has been initialized, but before
94windows are created or the command gets run. 458windows are created or the command gets run. Most methods are unsafe to
459call or deliver senseless data, as terminal size and other characteristics
460have not yet been determined. You can safely query and change resources
461and options, though. For many purposes the <code>on_start</code> hook is a better
462place.
463</dd>
464<p></p>
465<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
466</dt>
467<dd>
468Called at the very end of initialisation of a new terminal, just before
469trying to map (display) the toplevel and returning to the mainloop.
470</dd>
471<p></p>
472<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
473</dt>
474<dd>
475Called whenever something tries to destroy terminal, before doing anything
476yet. If this hook returns true, then destruction is skipped, but this is
477rarely a good idea.
95</dd> 478</dd>
96<p></p> 479<p></p>
97<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 480<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
98</dt> 481</dt>
99<dd> 482<dd>
100Called after the screen is ``reset'' for any reason, such as resizing or 483Called after the screen is ``reset'' for any reason, such as resizing or
101control sequences. Here is where you can react on changes to size-related 484control sequences. Here is where you can react on changes to size-related
102variables. 485variables.
103</dd> 486</dd>
104<p></p> 487<p></p>
105<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 488<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
106</dt> 489</dt>
490<dd>
491Called just after the child process has been <code>fork</code>ed.
107<dd> 492</dd>
108Called at the very end of initialisation of a new terminal, just before 493<p></p>
109returning to the mainloop. 494<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
495</dt>
496<dd>
497Called just after the child process has exited. <code>$status</code> is the status
498from <code>waitpid</code>.
110</dd> 499</dd>
111<p></p> 500<p></p>
112<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 501<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
113</dt> 502</dt>
114<dd> 503<dd>
… …
130</dd> 519</dd>
131<dd> 520<dd>
132<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 521<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
133</dd> 522</dd>
134<p></p> 523<p></p>
135<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 524<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
136</dt> 525</dt>
137<dd>
138Called whenever the window gets the keyboard focus, before urxvt does
139focus in processing.
140</dd> 526<dd>
141<p></p> 527Called whenever the user tries to extend the selection (e.g. with a double
142<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 528click) and is either supposed to return false (normal operation), or
143</dt> 529should extend the selection itelf and return true to suppress the built-in
530processing. This can happen multiple times, as long as the callback
531returns true, it will be called on every further click by the user and is
532supposed to enlarge the selection more and more, if possible.
144<dd> 533</dd>
145Called wheneever the window loses keyboard focus, before urxvt does focus 534<dd>
146out processing. 535<p>See the <em>selection</em> example extension.</p>
147</dd> 536</dd>
148<p></p> 537<p></p>
149<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 538<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
150</dt> 539</dt>
151<dd> 540<dd>
… …
165<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 554<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
166$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 555$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
167number of lines that will be in the scrollback buffer.</p> 556number of lines that will be in the scrollback buffer.</p>
168</dd> 557</dd>
169<p></p> 558<p></p>
170<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 559<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
171</dt> 560</dt>
561<dd>
562Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
563operating system command) is processed. Cursor position and other state
564information is up-to-date when this happens. For interoperability, the
565string should start with the extension name and a colon, to distinguish
566it from commands for other extensions, and this might be enforced in the
567future.
172<dd> 568</dd>
173Called whenever the <code>program(s)</code> running in the urxvt window send output. 569<dd>
570<p>Be careful not ever to trust (in a security sense) the data you receive,
571as its source can not easily be controleld (e-mail content, messages from
572other users on the same system etc.).</p>
573</dd>
574<p></p>
575<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
576</dt>
577<dd>
578Called whenever text is about to be output, with the text as argument. You
579can filter/change and output the text yourself by returning a true value
580and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
581might be very slow, however, as your hook is called for <strong>all</strong> text being
582output.
583</dd>
584<p></p>
585<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
586</dt>
587<dd>
588Called whenever some data is written to the tty/pty and can be used to
589suppress or filter tty input.
590</dd>
591<p></p>
592<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
593</dt>
594<dd>
595Called whenever a line was updated or changed. Can be used to filter
596screen output (e.g. underline urls or other useless stuff). Only lines
597that are being shown will be filtered, and, due to performance reasons,
598not always immediately.
599</dd>
600<dd>
601<p>The row number is always the topmost row of the line if the line spans
602multiple rows.</p>
603</dd>
604<dd>
605<p>Please note that, if you change the line, then the hook might get called
606later with the already-modified line (e.g. if unrelated parts change), so
607you cannot just toggle rendition bits, but only set them.</p>
174</dd> 608</dd>
175<p></p> 609<p></p>
176<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 610<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
177</dt> 611</dt>
178<dd> 612<dd>
… …
193<dd> 627<dd>
194Called whenever the user presses a key combination that has a 628Called whenever the user presses a key combination that has a
195<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 629<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
196resource in the <code>rxvt(1)</code> manpage). 630resource in the <code>rxvt(1)</code> manpage).
197</dd> 631</dd>
632<p></p>
633<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
634</dt>
635<dd>
636Called on every X event received on the vt window (and possibly other
637windows). Should only be used as a last resort. Most event structure
638members are not passed.
639</dd>
640<p></p>
641<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
642</dt>
643<dd>
644Called whenever the window gets the keyboard focus, before rxvt-unicode
645does focus in processing.
646</dd>
647<p></p>
648<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
649</dt>
650<dd>
651Called wheneever the window loses keyboard focus, before rxvt-unicode does
652focus out processing.
653</dd>
654<p></p>
655<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
656</dt>
657<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
658</dt>
659<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
660</dt>
661<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
662</dt>
663<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
664</dt>
665<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
666</dt>
667<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
668</dt>
669<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
670</dt>
671<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
672</dt>
673<dd>
674Called whenever the corresponding X event is received for the terminal If
675the hook returns true, then the even will be ignored by rxvt-unicode.
676</dd>
677<dd>
678<p>The event is a hash with most values as named by Xlib (see the XEvent
679manpage), with the additional members <code>row</code> and <code>col</code>, which are the
680(real, not screen-based) row and column under the mouse cursor.</p>
681</dd>
682<dd>
683<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
684output, if any, in locale-specific encoding.</p>
685</dd>
686<dd>
687<p>subwindow.</p>
688</dd>
689<p></p>
690<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
691</dt>
692<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
693</dt>
694<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
695</dt>
696<dd>
697Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
699</dd>
700<p></p></dl>
701<p>
702</p>
703<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
704<dl>
705<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
706</dt>
707<dd>
708The rxvt-unicode library directory, where, among other things, the perl
709modules and scripts are stored.
710</dd>
711<p></p>
712<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
713</dt>
714<dd>
715The resource class and name rxvt-unicode uses to look up X resources.
716</dd>
717<p></p>
718<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
719</dt>
720<dd>
721The basename of the installed binaries, usually <code>urxvt</code>.
722</dd>
723<p></p>
724<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
725</dt>
726<dd>
727The current terminal. This variable stores the current <code>urxvt::term</code>
728object, whenever a callback/hook is executing.
729</dd>
730<p></p>
731<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
732</dt>
733<dd>
734All coderefs in this array will be called as methods of the next newly
735created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
736gets cleared before the codereferences that were in it are being executed,
737so coderefs can push themselves onto it again if they so desire.
738</dd>
739<dd>
740<p>This complements to the perl-eval commandline option, but gets executed
741first.</p>
742</dd>
743<p></p>
744<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
745</dt>
746<dd>
747Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
748get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
749but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
750</dd>
198<p></p></dl> 751<p></p></dl>
199<p> 752<p>
200</p> 753</p>
201<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 754<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
202<dl> 755<dl>
… …
217</dd> 770</dd>
218<dd> 771<dd>
219<p>Using this function has the advantage that its output ends up in the 772<p>Using this function has the advantage that its output ends up in the
220correct place, e.g. on stderr of the connecting urxvtc client.</p> 773correct place, e.g. on stderr of the connecting urxvtc client.</p>
221</dd> 774</dd>
775<dd>
776<p>Messages have a size limit of 1023 bytes currently.</p>
777</dd>
222<p></p> 778<p></p>
223<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 779<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
224</dt> 780</dt>
225<dd> 781<dd>
226Returns the ``current time'' (as per the event loop). 782Returns the ``current time'' (as per the event loop).
227</dd> 783</dd>
784<p></p>
785<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
786</dt>
787<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
788Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
789Button4Mask, Button5Mask, AnyModifier</a></strong><br />
790</dt>
791<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
792ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
793PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
794Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
795KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
796ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
797FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
798</dt>
799<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
800EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
801GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
802UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
803ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
804CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
805SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
806</dt>
807<dd>
808Various constants for use in X calls and event processing.
809</dd>
228<p></p></dl> 810<p></p></dl>
811<p>
812</p>
813<h2><a name="rendition">RENDITION</a></h2>
814<p>Rendition bitsets contain information about colour, font, font styles and
815similar information for each screen cell.</p>
816<p>The following ``macros'' deal with changes in rendition sets. You should
817never just create a bitset, you should always modify an existing one,
818as they contain important information required for correct operation of
819rxvt-unicode.</p>
820<dl>
821<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
822</dt>
823<dd>
824Returns the default rendition, as used when the terminal is starting up or
825being reset. Useful as a base to start when creating renditions.
826</dd>
827<p></p>
828<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
829</dt>
830<dd>
831Return the rendition mask used for overlays by default.
832</dd>
833<p></p>
834<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 />
835</dt>
836<dd>
837Return the bit that enabled bold, italic, blink, reverse-video and
838underline, respectively. To enable such a style, just logically OR it into
839the bitset.
840</dd>
841<p></p>
842<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
843</dt>
844<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
845</dt>
846<dd>
847Return the foreground/background colour index, respectively.
848</dd>
849<p></p>
850<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
851</dt>
852<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
853</dt>
854<dd>
855Replace the foreground/background colour in the rendition mask with the
856specified one.
857</dd>
858<p></p>
859<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
860</dt>
861<dd>
862Return the ``custom'' value: Every rendition has 5 bits for use by
863extensions. They can be set and changed as you like and are initially
864zero.
865</dd>
866<p></p>
867<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
868</dt>
869<dd>
870Change the custom value.
871</dd>
872<p></p></dl>
873<p>
874</p>
875<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
876<p>The sole purpose of this class is to deliver an interface to the
877<code>AnyEvent</code> module - any module using it will work inside urxvt without
878further programming. The only exception is that you cannot wait on
879condition variables, but non-blocking condvar use is ok. What this means
880is that you cannot use blocking APIs, but the non-blocking variant should
881work.</p>
229<p> 882<p>
230</p> 883</p>
231<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 884<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
232<dl> 885<dl>
886<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
887</dt>
888<dd>
889Creates a new terminal, very similar as if you had started it with system
890<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
891hash which defines the environment of the new terminal.
892</dd>
893<dd>
894<p>Croaks (and probably outputs an error message) if the new instance
895couldn't be created. Returns <code>undef</code> if the new instance didn't
896initialise perl, and the terminal object otherwise. The <code>init</code> and
897<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
898</dd>
899<p></p>
900<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
901</dt>
902<dd>
903Destroy the terminal object (close the window, free resources
904etc.). Please note that rxvt will not exit as long as any event
905watchers (timers, io watchers) are still active.
906</dd>
907<p></p>
908<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
909</dt>
910<dd>
911Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
912(``starts'') programs in the background. This function takes care of setting
913the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
914be preferred over explicit calls to <code>exec</code> or <code>system</code>.
915</dd>
916<dd>
917<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
918</dd>
919<p></p>
920<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
921</dt>
922<dd>
923Returns true if the option specified by <code>$optval</code> is enabled, and
924optionally change it. All option values are stored by name in the hash
925<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
926</dd>
927<dd>
928<p>Here is a a likely non-exhaustive list of option names, please see the
929source file <em>/src/optinc.h</em> to see the actual list:</p>
930</dd>
931<dd>
932<pre>
933 borderLess console cursorBlink cursorUnderline hold iconic insecure
934 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
935 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
936 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
937 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
938 transparent tripleclickwords utmpInhibit visualBell</pre>
939</dd>
940<p></p>
233<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 941<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
234</dt> 942</dt>
235<dd> 943<dd>
236Returns the current resource value associated with a given name and 944Returns the current resource value associated with a given name and
237optionally sets a new value. Setting values is most useful in the <code>init</code> 945optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
251<p>Please note that resource strings will currently only be freed when the 959<p>Please note that resource strings will currently only be freed when the
252terminal is destroyed, so changing options frequently will eat memory.</p> 960terminal is destroyed, so changing options frequently will eat memory.</p>
253</dd> 961</dd>
254<dd> 962<dd>
255<p>Here is a a likely non-exhaustive list of resource names, not all of which 963<p>Here is a a likely non-exhaustive list of resource names, not all of which
256are supported in every build, please see the source to see the actual 964are supported in every build, please see the source file <em>/src/rsinc.h</em>
257list:</p> 965to see the actual list:</p>
258</dd> 966</dd>
259<dd> 967<dd>
260<pre> 968<pre>
261 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 969 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
262 borderLess color cursorBlink cursorUnderline cutchars delete_key 970 borderLess color cursorBlink cursorUnderline cutchars delete_key
263 display_name embed ext_bwidth fade font geometry hold iconName 971 display_name embed ext_bwidth fade font geometry hold iconName
264 imFont imLocale inputMethod insecure int_bwidth intensityStyles 972 imFont imLocale inputMethod insecure int_bwidth intensityStyles
265 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 973 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
266 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 974 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
267 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 975 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
268 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 976 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
269 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 977 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
270 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 978 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
271 shade term_name title transparent transparent_all tripleclickwords 979 secondaryScreen secondaryScroll selectstyle shade term_name title
980 transient_for transparent transparent_all tripleclickwords utmpInhibit
272 utmpInhibit visualBell</pre> 981 visualBell</pre>
982</dd>
983<p></p>
984<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
985</dt>
986<dd>
987Returns the X-Resource for the given pattern, excluding the program or
988class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
989same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
990resource with that pattern exists.
991</dd>
992<dd>
993<p>This method should only be called during the <code>on_start</code> hook, as there is
994only one resource database per display, and later invocations might return
995the wrong resources.</p>
996</dd>
997<p></p>
998<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
999</dt>
1000<dd>
1001Adds a keymap translation exactly as specified via a resource. See the
1002<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
1003</dd>
1004<p></p>
1005<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1006</dt>
1007<dd>
1008Return and optionally change the current rendition. Text that is output by
1009the terminal application will use this style.
1010</dd>
1011<p></p>
1012<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1013</dt>
1014<dd>
1015Return the current coordinates of the text cursor position and optionally
1016set it (which is usually bad as applications don't expect that).
273</dd> 1017</dd>
274<p></p> 1018<p></p>
275<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1019<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
276</dt> 1020</dt>
277<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 1021<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
281<dd> 1025<dd>
282Return the current values of the selection mark, begin or end positions, 1026Return the current values of the selection mark, begin or end positions,
283and optionally set them to new values. 1027and optionally set them to new values.
284</dd> 1028</dd>
285<p></p> 1029<p></p>
1030<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1031</dt>
1032<dd>
1033Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1034<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1035rectangular selection will be made. This is the prefered function to make
1036a selection.
1037</dd>
1038<p></p>
286<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1039<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
287</dt> 1040</dt>
288<dd> 1041<dd>
289Try to request the primary selection from the server (for example, as set 1042Try to request the primary selection text from the server (for example, as
290by the next method). 1043set by the next method). No visual feedback will be given. This function
1044is mostly useful from within <code>on_sel_grab</code> hooks.
291</dd> 1045</dd>
292<p></p> 1046<p></p>
293<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 1047<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
294</dt> 1048</dt>
295<dd> 1049<dd>
296Return the current selection text and optionally replace it by <code>$newtext</code>. 1050Return the current selection text and optionally replace it by <code>$newtext</code>.
297</dd> 1051</dd>
298<p></p> 1052<p></p>
299<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 1053<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
300</dt> 1054</dt>
301<dd> 1055<dd>
302Create a simple multi-line overlay box. See the next method for details. 1056Create a simple multi-line overlay box. See the next method for details.
303</dd> 1057</dd>
304<p></p> 1058<p></p>
305<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 1059<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
306</dt> 1060</dt>
307<dd> 1061<dd>
308Create a new (empty) overlay at the given position with the given 1062Create a new (empty) overlay at the given position with the given
309width/height. A border will be put around the box. If either <code>$x</code> or 1063width/height. <code>$rstyle</code> defines the initial rendition style
310<code>$y</code> is negative, then this is counted from the right/bottom side, 1064(default: <code>OVERLAY_RSTYLE</code>).
311respectively.
312</dd>
313<p></p>
314<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
315</dt>
316<dd> 1065</dd>
317Switch the overlay off again.
318</dd> 1066<dd>
319<p></p> 1067<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
320<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 1068around the box.</p>
321</dt>
322<dd> 1069</dd>
323Put a single character (specified numerically) at the given overlay
324position.
325</dd> 1070<dd>
326<p></p> 1071<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
327<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 1072right/bottom side, respectively.</p>
328</dt>
329<dd> 1073</dd>
330Write a string at the given position into the overlay.
331</dd> 1074<dd>
1075<p>This method returns an urxvt::overlay object. The overlay will be visible
1076as long as the perl object is referenced.</p>
1077</dd>
1078<dd>
1079<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
1080</dd>
1081<dl>
1082<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
1083</dt>
1084<dd>
1085Similar 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
1086text in rxvt-unicode's special encoding and an array of rendition values
1087at a specific position inside the overlay.
1088</dd>
332<p></p> 1089<p></p>
1090<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
1091</dt>
1092<dd>
1093If visible, hide the overlay, but do not destroy it.
1094</dd>
1095<p></p>
1096<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
1097</dt>
1098<dd>
1099If hidden, display the overlay again.
1100</dd>
1101<p></p></dl>
1102<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1103</dt>
1104<dd>
1105Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1106<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1107currently).
1108</dd>
1109<p></p>
333<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 1110<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
334</dt> 1111</dt>
335<dd> 1112<dd>
336Returns the number of screen-cells this string would need. Correctly 1113Returns the number of screen-cells this string would need. Correctly
337accounts for wide and combining characters. 1114accounts for wide and combining characters.
338</dd> 1115</dd>
339<p></p> 1116<p></p>
340<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 1117<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
341</dt> 1118</dt>
342<dd> 1119<dd>
343Convert the given text string into the corresponding locale encoding. 1120Convert the given text string into the corresponding locale encoding.
344</dd> 1121</dd>
345<p></p> 1122<p></p>
346<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 1123<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
347</dt> 1124</dt>
348<dd> 1125<dd>
349Convert the given locale-encoded octets into a perl string. 1126Convert the given locale-encoded octets into a perl string.
350</dd> 1127</dd>
351<p></p> 1128<p></p>
1129<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 />
1130</dt>
1131<dd>
1132XORs the rendition values in the given span with the provided value
1133(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1134refresh hooks to provide effects similar to the selection.
1135</dd>
1136<p></p>
1137<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 />
1138</dt>
1139<dd>
1140Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1141whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1142to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1143it instead. Both styles <em>MUST NOT</em> contain font styles.
1144</dd>
1145<p></p>
1146<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1147</dt>
1148<dd>
1149Ring the bell!
1150</dd>
1151<p></p>
1152<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1153</dt>
1154<dd>
1155Write the given text string to the screen, as if output by the application
1156running inside the terminal. It may not contain command sequences (escape
1157codes), but is free to use line feeds, carriage returns and tabs. The
1158string is a normal text string, not in locale-dependent encoding.
1159</dd>
1160<dd>
1161<p>Normally its not a good idea to use this function, as programs might be
1162confused by changes in cursor position or scrolling. Its useful inside a
1163<code>on_add_lines</code> hook, though.</p>
1164</dd>
1165<p></p>
1166<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1167</dt>
1168<dd>
1169Switch to given screen - 0 primary, 1 secondary.
1170</dd>
1171<p></p>
1172<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1173</dt>
1174<dd>
1175Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1176locale-specific encoding of the terminal and can contain command sequences
1177(escape codes) that will be interpreted.
1178</dd>
1179<p></p>
352<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1180<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
353</dt> 1181</dt>
354<dd> 1182<dd>
355Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1183Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
356pass characters instead of octets, you should convetr you strings first to 1184pass characters instead of octets, you should convert your strings first
357the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1185to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
1186</dd>
1187<p></p>
1188<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1189</dt>
1190<dd>
1191Replaces the event mask of the pty watcher by the given event mask. Can
1192be used to suppress input and output handling to the pty/tty. See the
1193description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1194the previous value.
1195</dd>
1196<p></p>
1197<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1198</dt>
1199<dd>
1200Return the window id of the toplevel window.
1201</dd>
1202<p></p>
1203<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1204</dt>
1205<dd>
1206Return the window id of the terminal window.
1207</dd>
1208<p></p>
1209<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1210</dt>
1211<dd>
1212Adds the specified events to the vt event mask. Useful e.g. when you want
1213to receive pointer events all the times:
1214</dd>
1215<dd>
1216<pre>
1217 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1218</dd>
1219<p></p>
1220<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1221</dt>
1222<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1223</dt>
1224<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1225</dt>
1226<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1227</dt>
1228<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1229</dt>
1230<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
1231</dt>
1232<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
1233</dt>
1234<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1235</dt>
1236<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1237</dt>
1238<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1239</dt>
1240<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1241</dt>
1242<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1243</dt>
1244<dd>
1245Return various integers describing terminal characteristics.
1246</dd>
1247<p></p>
1248<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1249</dt>
1250<dd>
1251Return the DISPLAY used by rxvt-unicode.
1252</dd>
1253<p></p>
1254<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1255</dt>
1256<dd>
1257Returns the LC_CTYPE category string used by this rxvt-unicode.
1258</dd>
1259<p></p>
1260<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1261</dt>
1262<dd>
1263Returns a copy of the environment in effect for the terminal as a hashref
1264similar to <code>\%ENV</code>.
1265</dd>
1266<p></p>
1267<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1268</dt>
1269<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1270</dt>
1271<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1272</dt>
1273<dd>
1274Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1275AltGr), the meta key (often Alt) and the num lock key, if applicable.
1276</dd>
1277<p></p>
1278<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1279</dt>
1280<dd>
1281Returns the currently displayed screen (0 primary, 1 secondary).
1282</dd>
1283<p></p>
1284<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1285</dt>
1286<dd>
1287Returns the row number of the topmost displayed line. Maximum value is
1288<code>0</code>, which displays the normal terminal contents. Lower values scroll
1289this many lines into the scrollback buffer.
1290</dd>
1291<p></p>
1292<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1293</dt>
1294<dd>
1295Requests a screen refresh. At the next opportunity, rxvt-unicode will
1296compare the on-screen display with its stored representation. If they
1297differ, it redraws the differences.
1298</dd>
1299<dd>
1300<p>Used after changing terminal contents to display them.</p>
1301</dd>
1302<p></p>
1303<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1304</dt>
1305<dd>
1306Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1307is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1308terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1309line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1310is requested.
1311</dd>
1312<dd>
1313<p>If <code>$new_text</code> is specified, it will replace characters in the current
1314line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1315to replace only parts of a line. The font index in the rendition will
1316automatically be updated.</p>
1317</dd>
1318<dd>
1319<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use
1320more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code>
1321characters. Characters with combining characters and other characters that
1322do not fit into the normal tetx encoding will be replaced with characters
1323in the private use area.</p>
1324</dd>
1325<dd>
1326<p>You have to obey this encoding when changing text. The advantage is
1327that <code>substr</code> and similar functions work on screen cells and not on
1328characters.</p>
1329</dd>
1330<dd>
1331<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>
1332can be used to convert normal strings into this encoding and vice versa.</p>
1333</dd>
1334<p></p>
1335<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1336</dt>
1337<dd>
1338Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1339bitsets. Rendition bitsets contain information about colour, font, font
1340styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1341</dd>
1342<dd>
1343<p>When setting rendition, the font mask will be ignored.</p>
1344</dd>
1345<dd>
1346<p>See the section on RENDITION, above.</p>
1347</dd>
1348<p></p>
1349<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1350</dt>
1351<dd>
1352Returns the number of screen cells that are in use (``the line
1353length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1354line is joined with the following one.
1355</dd>
1356<p></p>
1357<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1358</dt>
1359<dd>
1360Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1361joined with the following row), which means all characters are in use
1362and it is continued on the next row (and possibly a continuation of the
1363previous row(s)).
1364</dd>
1365<p></p>
1366<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1367</dt>
1368<dd>
1369Create and return a new <code>urxvt::line</code> object that stores information
1370about the logical line that row <code>$row_number</code> is part of. It supports the
1371following methods:
1372</dd>
1373<dl>
1374<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1375</dt>
1376<dd>
1377Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1378</dd>
1379<p></p>
1380<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1381</dt>
1382<dd>
1383Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1384</dd>
1385<p></p>
1386<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1387</dt>
1388<dd>
1389Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1390</dd>
1391<p></p>
1392<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1393</dt>
1394<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1395</dt>
1396<dd>
1397Return the row number of the first/last row of the line, respectively.
1398</dd>
1399<p></p>
1400<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1401</dt>
1402<dd>
1403Returns the character offset of the given row|col pair within the logical
1404line. Works for rows outside the line, too, and returns corresponding
1405offsets outside the string.
1406</dd>
1407<p></p>
1408<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1409</dt>
1410<dd>
1411Translates a string offset into terminal coordinates again.
1412</dd>
1413<p></p></dl>
1414<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1415</dt>
1416<dd>
1417Converts a perl string into the special encoding used by rxvt-unicode,
1418where one character corresponds to one screen cell. See
1419<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1420</dd>
1421<p></p>
1422<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1423</dt>
1424<dd>
1425Converts rxvt-unicodes text reprsentation into a perl string. See
1426<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1427</dd>
1428<p></p>
1429<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1430</dt>
1431<dd>
1432Registers a synchronous button grab. See the XGrabButton manpage.
1433</dd>
1434<p></p>
1435<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1436</dt>
1437<dd>
1438Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1440</dd>
1441<p></p>
1442<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1443</dt>
1444<dd>
1445Calls XAllowEvents with AsyncBoth for the most recent grab.
1446</dd>
1447<p></p>
1448<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1449</dt>
1450<dd>
1451Calls XAllowEvents with SyncBoth for the most recent grab.
1452</dd>
1453<p></p>
1454<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1455</dt>
1456<dd>
1457Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1458recent grab.
1459</dd>
1460<p></p>
1461<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1462</dt>
1463<dd>
1464Calls XUngrab for the most recent grab. Is called automatically on
1465evaluation errors, as it is better to lose the grab in the error case as
1466the session.
1467</dd>
1468<p></p>
1469<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1470</dt>
1471<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1472</dt>
1473<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1474</dt>
1475<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1476</dt>
1477<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1478</dt>
1479<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1480</dt>
1481<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1482</dt>
1483<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1484</dt>
1485<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1486</dt>
1487<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1488</dt>
1489<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1490</dt>
1491<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1492</dt>
1493<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1494</dt>
1495<dd>
1496Various X or X-related functions. The <code>$term</code> object only serves as
1497the source of the display, otherwise those functions map more-or-less
1498directory onto the X functions of the same name.
1499</dd>
1500<p></p></dl>
1501<p>
1502</p>
1503<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1504<dl>
1505<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1506</dt>
1507<dd>
1508Adds a non-clickable title to the popup.
1509</dd>
1510<p></p>
1511<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1512</dt>
1513<dd>
1514Creates a separator, optionally using the character given as <code>$sepchr</code>.
1515</dd>
1516<p></p>
1517<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1518</dt>
1519<dd>
1520Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1521selected.
1522</dd>
1523<p></p>
1524<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1525</dt>
1526<dd>
1527Adds a toggle/checkbox item to the popup. Teh callback gets called
1528whenever it gets toggled, with a boolean indicating its value as its first
1529argument.
1530</dd>
1531<p></p>
1532<dt><strong>$popup-&gt;show</strong><br />
1533</dt>
1534<dd>
1535Displays the popup (which is initially hidden).
358</dd> 1536</dd>
359<p></p></dl> 1537<p></p></dl>
360<p> 1538<p>
361</p> 1539</p>
362<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1540<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
363<p>This class implements timer watchers/events. Time is represented as a 1541<p>This class implements timer watchers/events. Time is represented as a
364fractional number of seconds since the epoch. Example:</p> 1542fractional number of seconds since the epoch. Example:</p>
365<pre> 1543<pre>
366 # create a digital clock display in upper right corner 1544 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
367 $term-&gt;{timer} = urxvt::timer 1545 $term-&gt;{timer} = urxvt::timer
368 -&gt;new 1546 -&gt;new
369 -&gt;start (urxvt::NOW) 1547 -&gt;interval (1)
370 -&gt;cb (sub { 1548 -&gt;cb (sub {
371 my ($timer) = @_;
372 my $time = $timer-&gt;at;
373 $timer-&gt;start ($time + 1);
374 $self-&gt;scr_overlay (-1, 0, 1549 $term-&gt;{overlay}-&gt;set (0, 0,
375 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 1550 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
376 });</pre> 1551 });</pre>
377<dl> 1552<dl>
378<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1553<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
379</dt> 1554</dt>
380<dd> 1555<dd>
381Create a new timer object in stopped state. 1556Create a new timer object in started state. It is scheduled to fire
1557immediately.
382</dd> 1558</dd>
383<p></p> 1559<p></p>
384<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1560<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
385</dt> 1561</dt>
386<dd> 1562<dd>
… …
391</dt> 1567</dt>
392<dd> 1568<dd>
393Return the time this watcher will fire next. 1569Return the time this watcher will fire next.
394</dd> 1570</dd>
395<p></p> 1571<p></p>
396<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 1572<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
397</dt> 1573</dt>
398<dd> 1574<dd>
399Set the time the event is generated to $tstamp. 1575Set the time the event is generated to $tstamp.
400</dd> 1576</dd>
401<p></p> 1577<p></p>
1578<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1579</dt>
1580<dd>
1581Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1582stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1583is automatically rescheduled at the given intervals.
1584</dd>
1585<p></p>
402<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1586<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
403</dt> 1587</dt>
404<dd> 1588<dd>
405Start the timer. 1589Start the timer.
406</dd> 1590</dd>
407<p></p> 1591<p></p>
408<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1592<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
409</dt> 1593</dt>
410<dd> 1594<dd>
411Set the event trigger time to <code>$tstamp</code> and start the timer. 1595Set the event trigger time to <code>$tstamp</code> and start the timer.
1596</dd>
1597<p></p>
1598<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1599</dt>
1600<dd>
1601Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
412</dd> 1602</dd>
413<p></p> 1603<p></p>
414<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1604<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
415</dt> 1605</dt>
416<dd> 1606<dd>
… …
424<pre> 1614<pre>
425 $term-&gt;{socket} = ... 1615 $term-&gt;{socket} = ...
426 $term-&gt;{iow} = urxvt::iow 1616 $term-&gt;{iow} = urxvt::iow
427 -&gt;new 1617 -&gt;new
428 -&gt;fd (fileno $term-&gt;{socket}) 1618 -&gt;fd (fileno $term-&gt;{socket})
429 -&gt;events (1) # wait for read data 1619 -&gt;events (urxvt::EVENT_READ)
430 -&gt;start 1620 -&gt;start
431 -&gt;cb (sub { 1621 -&gt;cb (sub {
432 my ($iow, $revents) = @_; 1622 my ($iow, $revents) = @_;
433 # $revents must be 1 here, no need to check 1623 # $revents must be 1 here, no need to check
434 sysread $term-&gt;{socket}, my $buf, 8192 1624 sysread $term-&gt;{socket}, my $buf, 8192
… …
455</dd> 1645</dd>
456<p></p> 1646<p></p>
457<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1647<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
458</dt> 1648</dt>
459<dd> 1649<dd>
460Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1650Set the event mask to watch. The only allowed values are
461data, Bit #1 (value <code>2</code>) enables watching for write data. 1651<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1652together, or <code>urxvt::EVENT_NONE</code>.
462</dd> 1653</dd>
463<p></p> 1654<p></p>
464<dt><strong>$iow = $iow-&gt;start</strong><br /> 1655<dt><strong>$iow = $iow-&gt;start</strong><br />
465</dt> 1656</dt>
466<dd> 1657<dd>
… …
469<p></p> 1660<p></p>
470<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1661<dt><strong>$iow = $iow-&gt;stop</strong><br />
471</dt> 1662</dt>
472<dd> 1663<dd>
473Stop watching for events on the given filehandle. 1664Stop watching for events on the given filehandle.
1665</dd>
1666<p></p></dl>
1667<p>
1668</p>
1669<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1670<p>This class implements idle watchers, that get called automatically when
1671the process is idle. They should return as fast as possible, after doing
1672some useful work.</p>
1673<dl>
1674<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1675</dt>
1676<dd>
1677Create a new idle watcher object in stopped state.
1678</dd>
1679<p></p>
1680<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1681</dt>
1682<dd>
1683Set the callback to be called when the watcher triggers.
1684</dd>
1685<p></p>
1686<dt><strong>$timer = $timer-&gt;start</strong><br />
1687</dt>
1688<dd>
1689Start the watcher.
1690</dd>
1691<p></p>
1692<dt><strong>$timer = $timer-&gt;stop</strong><br />
1693</dt>
1694<dd>
1695Stop the watcher.
1696</dd>
1697<p></p></dl>
1698<p>
1699</p>
1700<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1701<p>This class implements process watchers. They create an event whenever a
1702process exits, after which they stop automatically.</p>
1703<pre>
1704 my $pid = fork;
1705 ...
1706 $term-&gt;{pw} = urxvt::pw
1707 -&gt;new
1708 -&gt;start ($pid)
1709 -&gt;cb (sub {
1710 my ($pw, $exit_status) = @_;
1711 ...
1712 });</pre>
1713<dl>
1714<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1715</dt>
1716<dd>
1717Create a new process watcher in stopped state.
1718</dd>
1719<p></p>
1720<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1721</dt>
1722<dd>
1723Set the callback to be called when the timer triggers.
1724</dd>
1725<p></p>
1726<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1727</dt>
1728<dd>
1729Tells the wqtcher to start watching for process <code>$pid</code>.
1730</dd>
1731<p></p>
1732<dt><strong>$pw = $pw-&gt;stop</strong><br />
1733</dt>
1734<dd>
1735Stop the watcher.
474</dd> 1736</dd>
475<p></p></dl> 1737<p></p></dl>
476<p> 1738<p>
477</p> 1739</p>
478<hr /> 1740<hr />
… …
480<p> 1742<p>
481</p> 1743</p>
482<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1744<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
483<p>This variable controls the verbosity level of the perl extension. Higher 1745<p>This variable controls the verbosity level of the perl extension. Higher
484numbers indicate more verbose output.</p> 1746numbers indicate more verbose output.</p>
485<ol> 1747<dl>
486<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1748<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
487</li> 1749</dt>
488<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1750<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1751</dt>
1752<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1753</dt>
1754<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1755</dt>
489</li> 1756</dl>
490<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
491</li>
492</ol>
493<p> 1757<p>
494</p> 1758</p>
495<hr /> 1759<hr />
496<h1><a name="author">AUTHOR</a></h1> 1760<h1><a name="author">AUTHOR</a></h1>
497<pre> 1761<pre>

Diff Legend

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