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

Diff Legend

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