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.12 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.44 by root, Thu Jul 6 18:56:10 2006 UTC

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

Diff Legend

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