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

Diff Legend

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