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

Diff Legend

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