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.24 by root, Wed Jan 11 02:13:56 2006 UTC vs.
Revision 1.47 by root, Thu Nov 2 17:37:47 2006 UTC

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

Diff Legend

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