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.45 by root, Mon Jul 17 19:20:29 2006 UTC

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

Diff Legend

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