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.29 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.43 by root, Tue Feb 21 01:00:40 2006 UTC

1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 1<!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"> 2<html xmlns="http://www.w3.org/1999/xhtml">
3<head> 3<head>
4<title>urxvtperl - rxvt-unicode's embedded perl interpreter</title> 4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 5<link rev="made" href="mailto:perl-binary@plan9.de" />
6</head> 6</head>
7 7
8<body style="background-color: white"> 8<body style="background-color: white">
9 9
… …
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
33 <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li>
34 <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li>
33 </ul> 35 </ul>
34 36
35 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
36 <ul> 38 <ul>
37 39
… …
45<hr /> 47<hr />
46<p> 48<p>
47</p> 49</p>
48<hr /> 50<hr />
49<h1><a name="name">NAME</a></h1> 51<h1><a name="name">NAME</a></h1>
50<p>urxvtperl - rxvt-unicode's embedded perl interpreter</p> 52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
51<p> 53<p>
52</p> 54</p>
53<hr /> 55<hr />
54<h1><a name="synopsis">SYNOPSIS</a></h1> 56<h1><a name="synopsis">SYNOPSIS</a></h1>
55<pre> 57<pre>
… …
58 sub on_sel_grab { 60 sub on_sel_grab {
59 warn &quot;you selected &quot;, $_[0]-&gt;selection; 61 warn &quot;you selected &quot;, $_[0]-&gt;selection;
60 () 62 ()
61 }</pre> 63 }</pre>
62<pre> 64<pre>
63 # start a urxvt using it:</pre> 65 # start a rxvt using it:</pre>
64<pre> 66<pre>
65 urxvt --perl-lib $HOME -pe grab_test</pre> 67 rxvt --perl-lib $HOME -pe grab_test</pre>
66<p> 68<p>
67</p> 69</p>
68<hr /> 70<hr />
69<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
70<p>Everytime a terminal object gets created, extension scripts specified via 72<p>Everytime a terminal object gets created, extension scripts specified via
71the <code>perl</code> resource are loaded and associated with it.</p> 73the <code>perl</code> resource are loaded and associated with it.</p>
72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
73thus must be encoded as UTF-8.</p> 75thus must be encoded as UTF-8.</p>
74<p>Each script will only ever be loaded once, even in urxvtd, where 76<p>Each script will only ever be loaded once, even in rxvtd, where
75scripts will be shared (but not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
76<p> 78<p>
77</p> 79</p>
78<hr /> 80<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> 81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
80<p>This section describes the extensions delivered with this release. You can 82<p>This section describes the extensions delivered with this release. You can
81find them in <em>/usr/local/lib/urxvt/perl/</em>.</p> 83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
82<p>You can activate them like this:</p> 84<p>You can activate them like this:</p>
83<pre> 85<pre>
84 urxvt -pe &lt;extensionname&gt;</pre> 86 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
85<dl> 90<dl>
86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
87</dt> 92</dt>
88<dd> 93<dd>
89(More) intelligent selection. This extension tries to be more intelligent 94(More) intelligent selection. This extension tries to be more intelligent
… …
116<dd> 121<dd>
117<pre> 122<pre>
118 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> 123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
119</dd> 124</dd>
120<dd> 125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
121<p>You can look at the source of the selection extension to see more 136<p>You can look at the source of the selection extension to see more
122interesting uses, such as parsing a line from beginning to end.</p> 137interesting uses, such as parsing a line from beginning to end.</p>
123</dd> 138</dd>
124<dd> 139<dd>
125<p>This extension also offers the following bindable keyboard command:</p> 140<p>This extension also offers following bindable keyboard commands:</p>
126</dd> 141</dd>
127<dl> 142<dl>
128<dt><strong><a name="item_rot13">rot13</a></strong><br /> 143<dt><strong><a name="item_rot13">rot13</a></strong><br />
129</dt> 144</dt>
130<dd> 145<dd>
… …
139</dt> 154</dt>
140<dd> 155<dd>
141Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
142runtime. 157runtime.
143</dd> 158</dd>
159<dd>
160<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
162popup is being displayed.</p>
163</dd>
164<dd>
165<p>It's sole argument is the popup menu, which can be modified. It should
166either return nothing or a string, the initial boolean value and a code
167reference. The string will be used as button text and the code reference
168will be called when the toggle changes, with the new boolean value as
169first argument.</p>
170</dd>
171<dd>
172<p>The following will add an entry <code>myoption</code> that changes
173<code>$self-</code>{myoption}&gt;:</p>
174</dd>
175<dd>
176<pre>
177 push @{ $self-&gt;{term}{option_popup_hook} }, sub {
178 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] })
179 };</pre>
180</dd>
144<p></p> 181<p></p>
145<dt><strong>selection-popup (enabled by default)</strong><br /> 182<dt><strong>selection-popup (enabled by default)</strong><br />
146</dt> 183</dt>
147<dd> 184<dd>
148Binds a popup menu to Ctrl-Button3 that lets you convert the selection 185Binds a popup menu to Ctrl-Button3 that lets you convert the selection
149text into various other formats/action (such as uri unescaping, perl 186text into various other formats/action (such as uri unescaping, perl
150evalution, web-browser starting etc.), depending on content. 187evaluation, web-browser starting etc.), depending on content.
188</dd>
189<dd>
190<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
192popup is being displayed.</p>
193</dd>
194<dd>
195<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.
197It 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
199when the button gets activated and should transform <code>$_</code>.</p>
200</dd>
201<dd>
202<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
203the selection to <code>b</code>s, but only if the selection currently contains any
204<code>a</code>s:</p>
205</dd>
206<dd>
207<pre>
208 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
209 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
210 : ()
211 };</pre>
151</dd> 212</dd>
152<p></p> 213<p></p>
153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 214<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
154</dt> 215</dt>
155<dd> 216<dd>
… …
166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 227was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167additionally stores the first match in the current line into the primary 228additionally stores the first match in the current line into the primary
168selection.</p> 229selection.</p>
169</dd> 230</dd>
170<p></p> 231<p></p>
232<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
233</dt>
234<dd>
235A support package that tries to make editing with readline easier. At
236the 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
238cursor-left or cursor-right keypresses as required (the this only works
239for programs that correctly support wide characters).
240</dd>
241<dd>
242<p>To avoid too many false positives, this is only done when:</p>
243</dd>
244<dl>
245<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
246</dt>
247<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
248</dt>
249<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
250</dt>
251<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
252</dt>
253</dl>
254<p>The normal selection mechanism isn't disabled, so quick successive clicks
255might interfere with selection creation in harmless ways.</p>
171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 256<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172</dt> 257</dt>
173<dd> 258<dd>
174This selection allows you to do automatic transforms on a selection 259This selection allows you to do automatic transforms on a selection
175whenever a selection is made. 260whenever a selection is made.
… …
197<p>And this example matches the same,but replaces it with vi-commands you can 282<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p> 283paste directly into your (vi :) editor:</p>
199</dd> 284</dd>
200<dd> 285<dd>
201<pre> 286<pre>
202 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> 287 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd> 288</dd>
204<dd> 289<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p> 290<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd> 291</dd>
207<dd> 292<dd>
208<p>To expand the example above to typical perl error messages (``XXX at 293<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p> 294FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd> 295</dd>
211<dd> 296<dd>
212<pre> 297<pre>
213 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 298 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
214 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> 299 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
215</dd> 300</dd>
216<dd> 301<dd>
217<p>The first line tells the selection code to treat the unchanging part of 302<p>The first line tells the selection code to treat the unchanging part of
218every error message as a selection pattern, and the second line transforms 303every error message as a selection pattern, and the second line transforms
219the message into vi commands to load the file.</p> 304the message into vi commands to load the file.</p>
305</dd>
306<p></p>
307<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
308</dt>
309<dd>
310This transforms the terminal into a tabbar with additional terminals, that
311is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
312displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
313button per tab.
314</dd>
315<dd>
316<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,
318while <strong>Shift-Down</strong> creates a new tab.</p>
319</dd>
320<dd>
321<p>The tabbar itself can be configured similarly to a normal terminal, but
322with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
323following four resources (shown with defaults):</p>
324</dd>
325<dd>
326<pre>
327 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
328 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
329 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
330 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
331</dd>
332<dd>
333<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
334indices.</p>
220</dd> 335</dd>
221<p></p> 336<p></p>
222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 337<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
223</dt> 338</dt>
224<dd> 339<dd>
… …
226make them clickable. When middle-clicked, the program specified in the 341make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 342resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument. 343the URL as first argument.
229</dd> 344</dd>
230<p></p> 345<p></p>
346<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
347</dt>
348<dd>
349This (experimental) perl extension implements OnTheSpot editing. It does
350not 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
352kinput2.
353</dd>
354<dd>
355<p>You enable it by specifying this extension and a preedit style of
356<code>OnTheSpot</code>, i.e.:</p>
357</dd>
358<dd>
359<pre>
360 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
361</dd>
362<p></p>
363<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
364</dt>
365<dd>
366This is basically a one-line extension that dynamically changes the background pixmap offset
367to the window position, in effect creating the same effect as pseudo transparency with
368a custom pixmap. No scaling is supported in this mode. Exmaple:
369</dd>
370<dd>
371<pre>
372 rxvt -pixmap background.xpm -pe automove-background</pre>
373</dd>
374<p></p>
231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 375<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
232</dt> 376</dt>
233<dd> 377<dd>
234A not very useful example of filtering all text output to the terminal, 378A not very useful example of filtering all text output to the terminal,
235by replacing all line-drawing characters (U+2500 .. U+259F) by a 379by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
238<p></p> 382<p></p>
239<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 383<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
240</dt> 384</dt>
241<dd> 385<dd>
242Displays a digital clock using the built-in overlay. 386Displays a digital clock using the built-in overlay.
387</dd>
388<p></p>
389<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
390</dt>
391<dd>
392Somewhat of a misnomer, this extension adds two menu entries to the
393selection popup that allows one ti run external commands to store the
394selection somewhere and fetch it again.
395</dd>
396<dd>
397<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
399reads it.</p>
400</dd>
401<dd>
402<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
403<code>URxvt.remote-selection.fetch</code> resources. The first should read the
404selection to store from STDIN (always in UTF-8), the second should provide
405the selection data on STDOUT (also in UTF-8).</p>
406</dd>
407<dd>
408<p>The defaults (which are likely useless to you) use rsh and cat:</p>
409</dd>
410<dd>
411<pre>
412 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
413 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
414</dd>
415<p></p>
416<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
417</dt>
418<dd>
419This is a little rarely useful extension that Uploads the selection as
420textfile to a remote site (or does other things). (The implementation is
421not currently secure for use in a multiuser environment as it writes to
422<em>/tmp</em> directly.).
423</dd>
424<dd>
425<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
426i.e.</p>
427</dd>
428<dd>
429<pre>
430 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
431</dd>
432<dd>
433<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
434the textfile. This command can be set via a resource:</p>
435</dd>
436<dd>
437<pre>
438 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
439</dd>
440<dd>
441<p>And the default is likely not useful to anybody but the few people around
442here :)</p>
443</dd>
444<dd>
445<p>The name of the textfile is the hex encoded md5 sum of the selection, so
446the same content should lead to the same filename.</p>
447</dd>
448<dd>
449<p>After a successful upload the selection will be replaced by the text given
450in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
451for the filename):</p>
452</dd>
453<dd>
454<pre>
455 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
243</dd> 456</dd>
244<p></p> 457<p></p>
245<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 458<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
246</dt> 459</dt>
247<dd> 460<dd>
… …
330<h2><a name="hooks">Hooks</a></h2> 543<h2><a name="hooks">Hooks</a></h2>
331<p>The following subroutines can be declared in extension files, and will be 544<p>The following subroutines can be declared in extension files, and will be
332called whenever the relevant event happens.</p> 545called whenever the relevant event happens.</p>
333<p>The first argument passed to them is an extension oject as described in 546<p>The first argument passed to them is an extension oject as described in
334the in the <code>Extension Objects</code> section.</p> 547the in the <code>Extension Objects</code> section.</p>
335<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the 548<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
336event counts as being <em>consumed</em>, and the invocation of other hooks is 549hooks returns true, then the event counts as being <em>consumed</em>, and the
337skipped, and the relevant action might not be carried out by the C++ code.</p> 550relevant action might not be carried out by the C++ code.</p>
338<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 551<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
339<dl> 552<dl>
340<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 553<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
341</dt> 554</dt>
342<dd> 555<dd>
343Called after a new terminal object has been initialized, but before 556Called after a new terminal object has been initialized, but before
344windows are created or the command gets run. Most methods are unsafe to 557windows are created or the command gets run. Most methods are unsafe to
345call or deliver senseless data, as terminal size and other characteristics 558call or deliver senseless data, as terminal size and other characteristics
346have not yet been determined. You can safely query and change resources, 559have not yet been determined. You can safely query and change resources
347though. 560and options, though. For many purposes the <code>on_start</code> hook is a better
561place.
562</dd>
563<p></p>
564<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
565</dt>
566<dd>
567Called at the very end of initialisation of a new terminal, just before
568trying to map (display) the toplevel and returning to the mainloop.
569</dd>
570<p></p>
571<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
572</dt>
573<dd>
574Called whenever something tries to destroy terminal, when the terminal is
575still fully functional (not for long, though).
348</dd> 576</dd>
349<p></p> 577<p></p>
350<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 578<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
351</dt> 579</dt>
352<dd> 580<dd>
353Called after the screen is ``reset'' for any reason, such as resizing or 581Called after the screen is ``reset'' for any reason, such as resizing or
354control sequences. Here is where you can react on changes to size-related 582control sequences. Here is where you can react on changes to size-related
355variables. 583variables.
356</dd> 584</dd>
357<p></p> 585<p></p>
358<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 586<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
359</dt> 587</dt>
588<dd>
589Called just after the child process has been <code>fork</code>ed.
360<dd> 590</dd>
361Called at the very end of initialisation of a new terminal, just before 591<p></p>
362returning to the mainloop. 592<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
593</dt>
594<dd>
595Called just after the child process has exited. <code>$status</code> is the status
596from <code>waitpid</code>.
363</dd> 597</dd>
364<p></p> 598<p></p>
365<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 599<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
366</dt> 600</dt>
367<dd> 601<dd>
… …
484</dt> 718</dt>
485<dd> 719<dd>
486Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 720Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
487</dd> 721</dd>
488<p></p> 722<p></p>
489<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 723<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
490</dt> 724</dt>
491<dd> 725<dd>
492Called whenever the user presses a key combination that has a 726Called whenever the a user-configured event is being activated (e.g. via
493<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 727a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
494resource in the <code>urxvt(1)</code> manpage). 728resource in the <code>rxvt(1)</code> manpage).
729</dd>
730<dd>
731<p>The event is simply the action string. This interface is assumed to change
732slightly in the future.</p>
733</dd>
734<p></p>
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 />
736</dt>
737<dd>
738Called just after the new window size has been calculcated, but before
739windows are actually being resized or hints are being set. If this hook
740returns TRUE, setting of the window hints is being skipped.
495</dd> 741</dd>
496<p></p> 742<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 743<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt> 744</dt>
499<dd> 745<dd>
… …
514<dd> 760<dd>
515Called wheneever the window loses keyboard focus, before rxvt-unicode does 761Called wheneever the window loses keyboard focus, before rxvt-unicode does
516focus out processing. 762focus out processing.
517</dd> 763</dd>
518<p></p> 764<p></p>
765<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
766</dt>
767<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
768</dt>
519<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 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 />
520</dt> 770</dt>
521<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 771<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
522</dt> 772</dt>
523<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 773<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
534Called whenever the corresponding X event is received for the terminal If 784Called whenever the corresponding X event is received for the terminal If
535the hook returns true, then the even will be ignored by rxvt-unicode. 785the hook returns true, then the even will be ignored by rxvt-unicode.
536</dd> 786</dd>
537<dd> 787<dd>
538<p>The event is a hash with most values as named by Xlib (see the XEvent 788<p>The event is a hash with most values as named by Xlib (see the XEvent
539manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 789manpage), with the additional members <code>row</code> and <code>col</code>, which are the
540and column under the mouse cursor.</p> 790(real, not screen-based) row and column under the mouse cursor.</p>
541</dd> 791</dd>
542<dd> 792<dd>
543<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 793<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
544output, if any, in locale-specific encoding.</p> 794output, if any, in locale-specific encoding.</p>
545</dd> 795</dd>
546<dd> 796<dd>
547<p>subwindow.</p> 797<p>subwindow.</p>
798</dd>
799<p></p>
800<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
801</dt>
802<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
803</dt>
804<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
805</dt>
806<dd>
807Called when various types of ClientMessage events are received (all with
808format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
548</dd> 809</dd>
549<p></p></dl> 810<p></p></dl>
550<p> 811<p>
551</p> 812</p>
552<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 813<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
… …
574</dt> 835</dt>
575<dd> 836<dd>
576The current terminal. This variable stores the current <code>urxvt::term</code> 837The current terminal. This variable stores the current <code>urxvt::term</code>
577object, whenever a callback/hook is executing. 838object, whenever a callback/hook is executing.
578</dd> 839</dd>
840<p></p>
841<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
842</dt>
843<dd>
844All coderefs 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
846gets cleared before the codereferences that were in it are being executed,
847so coderefs can push themselves onto it again if they so desire.
848</dd>
849<dd>
850<p>This complements to the perl-eval commandline option, but gets executed
851first.</p>
852</dd>
853<p></p>
854<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
855</dt>
856<dd>
857Works 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>
859but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
860</dd>
579<p></p></dl> 861<p></p></dl>
580<p> 862<p>
581</p> 863</p>
582<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 864<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
583<dl> 865<dl>
… …
602</dd> 884</dd>
603<dd> 885<dd>
604<p>Messages have a size limit of 1023 bytes currently.</p> 886<p>Messages have a size limit of 1023 bytes currently.</p>
605</dd> 887</dd>
606<p></p> 888<p></p>
607<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 889<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
608</dt> 890</dt>
609<dd> 891<dd>
610Returns true when it is safe to do potentially unsafe things, such as 892Returns all urxvt::term objects that exist in this process, regardless of
611evaluating perl code specified by the user. This is true when urxvt was 893wether they are started, being destroyed etc., so be careful. Only term
612started setuid or setgid. 894objects that have perl extensions attached will be returned (because there
895is no urxvt::term objet associated with others).
613</dd> 896</dd>
614<p></p> 897<p></p>
615<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 898<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
616</dt> 899</dt>
617<dd> 900<dd>
… …
685<p></p> 968<p></p>
686<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> 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 />
687</dt> 970</dt>
688<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> 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 />
689</dt> 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>
690<dd> 975<dd>
691Replace the foreground/background colour in the rendition mask with the 976Replace the foreground/background colour in the rendition mask with the
692specified one. 977specified one.
693</dd> 978</dd>
694<p></p> 979<p></p>
… …
728</dd> 1013</dd>
729<dd> 1014<dd>
730<p>Croaks (and probably outputs an error message) if the new instance 1015<p>Croaks (and probably outputs an error message) if the new instance
731couldn't be created. Returns <code>undef</code> if the new instance didn't 1016couldn't be created. Returns <code>undef</code> if the new instance didn't
732initialise perl, and the terminal object otherwise. The <code>init</code> and 1017initialise perl, and the terminal object otherwise. The <code>init</code> and
733<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 1018<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>
734</dd> 1020</dd>
735<p></p> 1021<p></p>
736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1022<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
737</dt> 1023</dt>
738<dd> 1024<dd>
739Destroy the terminal object (close the window, free resources 1025Destroy the terminal object (close the window, free resources
740etc.). Please note that urxvt will not exit as long as any event 1026etc.). Please note that rxvt will not exit as long as any event
741watchers (timers, io watchers) are still active. 1027watchers (timers, io watchers) are still active.
1028</dd>
1029<p></p>
1030<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
1031</dt>
1032<dd>
1033Works 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
1035the 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>.
1037</dd>
1038<dd>
1039<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
742</dd> 1040</dd>
743<p></p> 1041<p></p>
744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 1042<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
745</dt> 1043</dt>
746<dd> 1044<dd>
… …
754</dd> 1052</dd>
755<dd> 1053<dd>
756<pre> 1054<pre>
757 borderLess console cursorBlink cursorUnderline hold iconic insecure 1055 borderLess console cursorBlink cursorUnderline hold iconic insecure
758 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1056 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
759 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1057 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
760 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1058 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
761 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1059 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
762 tripleclickwords utmpInhibit visualBell</pre> 1060 transparent tripleclickwords utmpInhibit visualBell</pre>
763</dd> 1061</dd>
764<p></p> 1062<p></p>
765<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 1063<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
766</dt> 1064</dt>
767<dd> 1065<dd>
… …
792<pre> 1090<pre>
793 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1091 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
794 borderLess color cursorBlink cursorUnderline cutchars delete_key 1092 borderLess color cursorBlink cursorUnderline cutchars delete_key
795 display_name embed ext_bwidth fade font geometry hold iconName 1093 display_name embed ext_bwidth fade font geometry hold iconName
796 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1094 imFont imLocale inputMethod insecure int_bwidth intensityStyles
797 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1095 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
798 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1096 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
799 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1097 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
800 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1098 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
801 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1099 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1100 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
803 shade term_name title transparent transparent_all tripleclickwords 1101 secondaryScreen secondaryScroll selectstyle shade term_name title
1102 transient_for transparent transparent_all tripleclickwords utmpInhibit
804 utmpInhibit visualBell</pre> 1103 visualBell</pre>
805</dd> 1104</dd>
806<p></p> 1105<p></p>
807<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 1106<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
808</dt> 1107</dt>
809<dd> 1108<dd>
… …
820<p></p> 1119<p></p>
821<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 1120<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
822</dt> 1121</dt>
823<dd> 1122<dd>
824Adds a keymap translation exactly as specified via a resource. See the 1123Adds a keymap translation exactly as specified via a resource. See the
825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage. 1124<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
826</dd> 1125</dd>
827<p></p> 1126<p></p>
828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 1127<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
829</dt> 1128</dt>
830<dd> 1129<dd>
… …
984<p>Normally its not a good idea to use this function, as programs might be 1283<p>Normally its not a good idea to use this function, as programs might be
985confused by changes in cursor position or scrolling. Its useful inside a 1284confused by changes in cursor position or scrolling. Its useful inside a
986<code>on_add_lines</code> hook, though.</p> 1285<code>on_add_lines</code> hook, though.</p>
987</dd> 1286</dd>
988<p></p> 1287<p></p>
1288<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1289</dt>
1290<dd>
1291Switch to given screen - 0 primary, 1 secondary.
1292</dd>
1293<p></p>
989<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1294<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
990</dt> 1295</dt>
991<dd> 1296<dd>
992Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1297Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
993locale-specific encoding of the terminal and can contain command sequences 1298locale-specific encoding of the terminal and can contain command sequences
… …
1009be used to suppress input and output handling to the pty/tty. See the 1314be used to suppress input and output handling to the pty/tty. See the
1010description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1315description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1011the previous value. 1316the previous value.
1012</dd> 1317</dd>
1013<p></p> 1318<p></p>
1319<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1320</dt>
1321<dd>
1322Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1323is used.
1324</dd>
1325<p></p>
1014<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1326<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1015</dt> 1327</dt>
1016<dd> 1328<dd>
1017Return the window id of the toplevel window. 1329Return the window id of the toplevel window.
1018</dd> 1330</dd>
… …
1032<dd> 1344<dd>
1033<pre> 1345<pre>
1034 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1346 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1035</dd> 1347</dd>
1036<p></p> 1348<p></p>
1349<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1350</dt>
1351<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1352</dt>
1353<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1354</dt>
1355<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1356</dt>
1357<dd>
1358Deliver various fake events to to terminal.
1359</dd>
1360<p></p>
1037<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1361<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1038</dt> 1362</dt>
1039<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1363<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1040</dt> 1364</dt>
1041<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1365<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
1054</dt> 1378</dt>
1055<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1379<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1056</dt> 1380</dt>
1057<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1381<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1058</dt> 1382</dt>
1059<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1383<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1060</dt> 1384</dt>
1061<dd> 1385<dd>
1062Return various integers describing terminal characteristics. 1386Return various integers describing terminal characteristics.
1063</dd> 1387</dd>
1064<p></p> 1388<p></p>
… …
1079<dd> 1403<dd>
1080Returns a copy of the environment in effect for the terminal as a hashref 1404Returns a copy of the environment in effect for the terminal as a hashref
1081similar to <code>\%ENV</code>. 1405similar to <code>\%ENV</code>.
1082</dd> 1406</dd>
1083<p></p> 1407<p></p>
1408<dt><strong><a name="item_envv">@envv = $term-&gt;envv</a></strong><br />
1409</dt>
1410<dd>
1411Returns the environment as array of strings of the form <code>VAR=VALUE</code>.
1412</dd>
1413<p></p>
1414<dt><strong><a name="item_argv">@argv = $term-&gt;argv</a></strong><br />
1415</dt>
1416<dd>
1417Return the argument vector as this terminal, similar to @ARGV, but
1418includes the program name as first element.
1419</dd>
1420<p></p>
1084<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1421<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1085</dt> 1422</dt>
1086<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1423<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1087</dt> 1424</dt>
1088<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br /> 1425<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
… …
1090<dd> 1427<dd>
1091Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1428Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1092AltGr), the meta key (often Alt) and the num lock key, if applicable. 1429AltGr), the meta key (often Alt) and the num lock key, if applicable.
1093</dd> 1430</dd>
1094<p></p> 1431<p></p>
1432<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1433</dt>
1434<dd>
1435Returns the currently displayed screen (0 primary, 1 secondary).
1436</dd>
1437<p></p>
1438<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1439</dt>
1440<dd>
1441Returns wether the cursor is currently hidden or not.
1442</dd>
1443<p></p>
1095<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1444<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1096</dt> 1445</dt>
1097<dd> 1446<dd>
1098Returns the negative row number of the topmost line. Minimum value is 1447Returns the row number of the topmost displayed line. Maximum value is
1099<code>0</code>, which displays the normal terminal contents. Larger values scroll 1448<code>0</code>, which displays the normal terminal contents. Lower values scroll
1100this many lines into the scrollback buffer. 1449this many lines into the scrollback buffer.
1101</dd> 1450</dd>
1102<p></p> 1451<p></p>
1103<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1452<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1104</dt> 1453</dt>
… …
1115</dt> 1464</dt>
1116<dd> 1465<dd>
1117Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1466Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1118is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1467is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1119terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1468terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1120line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1469line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1121is requested. 1470is requested.
1122</dd> 1471</dd>
1123<dd> 1472<dd>
1124<p>If <code>$new_text</code> is specified, it will replace characters in the current 1473<p>If <code>$new_text</code> is specified, it will replace characters in the current
1125line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1474line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1126to replace only parts of a line. The font index in the rendition will 1475to replace only parts of a line. The font index in the rendition will
1127automatically be updated.</p> 1476automatically be updated.</p>
1128</dd> 1477</dd>
1129<dd> 1478<dd>
1130<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1479<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1131than one cell when displayed are padded with urxvt::NOCHAR characters 1480than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1132(<code>chr 65535</code>). Characters with combining characters and other characters 1481characters. Characters with combining characters and other characters that
1133that do not fit into the normal tetx encoding will be replaced with 1482do not fit into the normal tetx encoding will be replaced with characters
1134characters in the private use area.</p> 1483in the private use area.</p>
1135</dd> 1484</dd>
1136<dd> 1485<dd>
1137<p>You have to obey this encoding when changing text. The advantage is 1486<p>You have to obey this encoding when changing text. The advantage is
1138that <code>substr</code> and similar functions work on screen cells and not on 1487that <code>substr</code> and similar functions work on screen cells and not on
1139characters.</p> 1488characters.</p>
… …
1235<dd> 1584<dd>
1236Converts rxvt-unicodes text reprsentation into a perl string. See 1585Converts rxvt-unicodes text reprsentation into a perl string. See
1237<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1586<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1238</dd> 1587</dd>
1239<p></p> 1588<p></p>
1240<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1589<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1241</dt> 1590</dt>
1591<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1592</dt>
1242<dd> 1593<dd>
1243Registers a synchronous button grab. See the XGrabButton manpage. 1594Register/unregister a synchronous button grab. See the XGrabButton
1595manpage.
1244</dd> 1596</dd>
1245<p></p> 1597<p></p>
1246<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1598<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1247</dt> 1599</dt>
1248<dd> 1600<dd>
… …
1274<dd> 1626<dd>
1275Calls XUngrab for the most recent grab. Is called automatically on 1627Calls XUngrab for the most recent grab. Is called automatically on
1276evaluation errors, as it is better to lose the grab in the error case as 1628evaluation errors, as it is better to lose the grab in the error case as
1277the session. 1629the session.
1278</dd> 1630</dd>
1631<p></p>
1632<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1633</dt>
1634<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1635</dt>
1636<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1637</dt>
1638<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1639</dt>
1640<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1641</dt>
1642<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1643</dt>
1644<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1645</dt>
1646<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1647</dt>
1648<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1649</dt>
1650<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1651</dt>
1652<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1653</dt>
1654<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1655</dt>
1656<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1657</dt>
1658<dd>
1659Various X or X-related functions. The <code>$term</code> object only serves as
1660the source of the display, otherwise those functions map more-or-less
1661directory onto the X functions of the same name.
1662</dd>
1279<p></p></dl> 1663<p></p></dl>
1280<p> 1664<p>
1281</p> 1665</p>
1282<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1666<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1283<dl> 1667<dl>
… …
1298<dd> 1682<dd>
1299Adds a clickable button to the popup. <code>$cb</code> is called whenever it is 1683Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1300selected. 1684selected.
1301</dd> 1685</dd>
1302<p></p> 1686<p></p>
1303<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br /> 1687<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong><br />
1304</dt> 1688</dt>
1305<dd> 1689<dd>
1306Adds a toggle/checkbox item to the popup. Teh callback gets called 1690Adds a toggle/checkbox item to the popup. The callback gets called
1307whenever it gets toggled, with a boolean indicating its value as its first 1691whenever it gets toggled, with a boolean indicating its new value as its
1308argument. 1692first argument.
1309</dd> 1693</dd>
1310<p></p> 1694<p></p>
1311<dt><strong>$popup-&gt;show</strong><br /> 1695<dt><strong>$popup-&gt;show</strong><br />
1312</dt> 1696</dt>
1313<dd> 1697<dd>
… …
1370<p></p> 1754<p></p>
1371<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1755<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1372</dt> 1756</dt>
1373<dd> 1757<dd>
1374Set the event trigger time to <code>$tstamp</code> and start the timer. 1758Set the event trigger time to <code>$tstamp</code> and start the timer.
1759</dd>
1760<p></p>
1761<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1762</dt>
1763<dd>
1764Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1375</dd> 1765</dd>
1376<p></p> 1766<p></p>
1377<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1767<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1378</dt> 1768</dt>
1379<dd> 1769<dd>
… …
1437Stop watching for events on the given filehandle. 1827Stop watching for events on the given filehandle.
1438</dd> 1828</dd>
1439<p></p></dl> 1829<p></p></dl>
1440<p> 1830<p>
1441</p> 1831</p>
1832<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
1834the process is idle. They should return as fast as possible, after doing
1835some useful work.</p>
1836<dl>
1837<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1838</dt>
1839<dd>
1840Create a new idle watcher object in stopped state.
1841</dd>
1842<p></p>
1843<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1844</dt>
1845<dd>
1846Set the callback to be called when the watcher triggers.
1847</dd>
1848<p></p>
1849<dt><strong>$timer = $timer-&gt;start</strong><br />
1850</dt>
1851<dd>
1852Start the watcher.
1853</dd>
1854<p></p>
1855<dt><strong>$timer = $timer-&gt;stop</strong><br />
1856</dt>
1857<dd>
1858Stop the watcher.
1859</dd>
1860<p></p></dl>
1861<p>
1862</p>
1863<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
1865process exits, after which they stop automatically.</p>
1866<pre>
1867 my $pid = fork;
1868 ...
1869 $term-&gt;{pw} = urxvt::pw
1870 -&gt;new
1871 -&gt;start ($pid)
1872 -&gt;cb (sub {
1873 my ($pw, $exit_status) = @_;
1874 ...
1875 });</pre>
1876<dl>
1877<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1878</dt>
1879<dd>
1880Create a new process watcher in stopped state.
1881</dd>
1882<p></p>
1883<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1884</dt>
1885<dd>
1886Set the callback to be called when the timer triggers.
1887</dd>
1888<p></p>
1889<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1890</dt>
1891<dd>
1892Tells the wqtcher to start watching for process <code>$pid</code>.
1893</dd>
1894<p></p>
1895<dt><strong>$pw = $pw-&gt;stop</strong><br />
1896</dt>
1897<dd>
1898Stop the watcher.
1899</dd>
1900<p></p></dl>
1901<p>
1902</p>
1442<hr /> 1903<hr />
1443<h1><a name="environment">ENVIRONMENT</a></h1> 1904<h1><a name="environment">ENVIRONMENT</a></h1>
1444<p> 1905<p>
1445</p> 1906</p>
1446<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1907<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>

Diff Legend

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