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.42 by root, Mon Feb 6 06:14:55 2006 UTC vs.
Revision 1.50 by root, Sat Feb 17 20:36:36 2007 UTC

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

Diff Legend

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