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.21 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.46 by root, Mon Aug 7 16:17:30 2006 UTC

1<?xml version="1.0" ?>
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml"> 3<html xmlns="http://www.w3.org/1999/xhtml">
3<head> 4<head>
4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> 5<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>
6<meta http-equiv="content-type" content="text/html; charset=utf-8" />
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 7<link rev="made" href="mailto:perl-binary@plan9.de" />
6</head> 8</head>
7 9
8<body style="background-color: white"> 10<body style="background-color: white">
9 11
… …
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 30 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 31 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 32 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 33 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 34 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
35 <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li>
36 <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li>
33 </ul> 37 </ul>
34 38
35 <li><a href="#environment">ENVIRONMENT</a></li> 39 <li><a href="#environment">ENVIRONMENT</a></li>
36 <ul> 40 <ul>
37 41
… …
65 rxvt --perl-lib $HOME -pe grab_test</pre> 69 rxvt --perl-lib $HOME -pe grab_test</pre>
66<p> 70<p>
67</p> 71</p>
68<hr /> 72<hr />
69<h1><a name="description">DESCRIPTION</a></h1> 73<h1><a name="description">DESCRIPTION</a></h1>
70<p>Everytime a terminal object gets created, extension scripts specified via 74<p>Every time a terminal object gets created, extension scripts specified via
71the <code>perl</code> resource are loaded and associated with it.</p> 75the <code>perl</code> resource are loaded and associated with it.</p>
72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 76<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
73thus must be encoded as UTF-8.</p> 77thus must be encoded as UTF-8.</p>
74<p>Each script will only ever be loaded once, even in rxvtd, where 78<p>Each script will only ever be loaded once, even in rxvtd, where
75scripts will be shared (but not enabled) for all terminals.</p> 79scripts will be shared (but not enabled) for all terminals.</p>
… …
80<p>This section describes the extensions delivered with this release. You can 84<p>This section describes the extensions delivered with this release. You can
81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 85find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
82<p>You can activate them like this:</p> 86<p>You can activate them like this:</p>
83<pre> 87<pre>
84 rxvt -pe &lt;extensionname&gt;</pre> 88 rxvt -pe &lt;extensionname&gt;</pre>
89<p>Or by adding them to the resource for extensions loaded by default:</p>
90<pre>
91 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
85<dl> 92<dl>
86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 93<dt><strong><a name="item_selection">selection (enabled by default)</a></strong>
87</dt> 94
88<dd> 95<dd>
89(More) intelligent selection. This extension tries to be more intelligent 96<p>(More) intelligent selection. This extension tries to be more intelligent
90when the user extends selections (double-click). Right now, it tries to 97when the user extends selections (double-click and further clicks). Right
91select urls and complete shell-quoted arguments, which is very convenient, 98now, it tries to select words, urls and complete shell-quoted
92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. 99arguments, which is very convenient, too, if your <em>ls</em> supports
93</dd> 100<code>--quoting-style=shell</code>.</p>
94<dd> 101</dd>
102<dd>
103<p>A double-click usually selects the word under the cursor, further clicks
104will enlarge the selection.</p>
105</dd>
106<dd>
107<p>The selection works by trying to match a number of regexes and displaying
108them in increasing order of length. You can add your own regexes by
109specifying resources of the form:</p>
110</dd>
111<dd>
112<pre>
113 URxvt.selection.pattern-0: perl-regex
114 URxvt.selection.pattern-1: perl-regex
115 ...</pre>
116</dd>
117<dd>
118<p>The index number (0, 1...) must not have any holes, and each regex must
119contain at least one pair of capturing parentheses, which will be used for
120the match. For example, the following adds a regex that matches everything
121between two vertical bars:</p>
122</dd>
123<dd>
124<pre>
125 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
126</dd>
127<dd>
128<p>Another example: Programs I use often output ``absolute path: '' at the
129beginning of a line when they process multiple files. The following
130pattern matches the filename (note, there is a single space at the very
131end):</p>
132</dd>
133<dd>
134<pre>
135 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
136</dd>
137<dd>
138<p>You can look at the source of the selection extension to see more
139interesting uses, such as parsing a line from beginning to end.</p>
140</dd>
141<dd>
95<p>It also offers the following bindable keyboard command:</p> 142<p>This extension also offers following bindable keyboard commands:</p>
96</dd> 143</dd>
97<dl> 144<dl>
98<dt><strong><a name="item_rot13">rot13</a></strong><br /> 145<dt><strong><a name="item_rot13">rot13</a></strong>
99</dt> 146
100<dd> 147<dd>
101Rot-13 the selection when activated. Used via keyboard trigger: 148<p>Rot-13 the selection when activated. Used via keyboard trigger:</p>
102</dd> 149</dd>
103<dd> 150<dd>
104<pre> 151<pre>
105 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 152 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
106</dd> 153</dd>
107<p></p></dl> 154</li>
155</dl>
108<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>
109</dt> 157
110<dd> 158<dd>
111Binds 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
112runtime. 160runtime.</p>
161</dd>
113</dd> 162<dd>
114<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>
115<dt><strong>selection-popup (enabled by default)</strong><br /> 185<dt><strong>selection-popup (enabled by default)</strong>
116</dt> 186
117<dd> 187<dd>
118Binds 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
119text into various other formats/action (such as uri unescaping, perl 189text into various other formats/action (such as uri unescaping, perl
120evalution, web-browser starting etc.), depending on content. 190evaluation, web-browser starting etc.), depending on content.</p>
191</dd>
121</dd> 192<dd>
122<p></p> 193<p>Other extensions can extend this popup menu by pushing a code reference
194onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
195popup is being displayed.</p>
196</dd>
197<dd>
198<p>It's sole argument is the popup menu, which can be modified. The selection
199is in <code>$_</code>, which can be used to decide whether to add something or not.
200It should either return nothing or a string and a code reference. The
201string will be used as button text and the code reference will be called
202when the button gets activated and should transform <code>$_</code>.</p>
203</dd>
204<dd>
205<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
206the selection to <code>b</code>s, but only if the selection currently contains any
207<code>a</code>s:</p>
208</dd>
209<dd>
210<pre>
211 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
212 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
213 : ()
214 };</pre>
215</dd>
216</li>
123<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>
124</dt> 218
125<dd> 219<dd>
126Adds regex search functionality to the scrollback buffer, triggered 220<p>Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal 221by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
128input/output is suspended. 222input/output is suspended and a regex is displayed at the bottom of the
129</dd> 223screen.</p>
130<dd> 224</dd>
131<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
132<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns to the original position.</p>
135</dd> 225<dd>
136<p></p> 226<p>Inputting characters appends them to the regex and continues incremental
137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 227search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
138</dt> 228search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
229bottom. <code>Escape</code> leaves search mode and returns to the point where search
230was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
231additionally stores the first match in the current line into the primary
232selection.</p>
139<dd> 233</dd>
140Displays a digital clock using the built-in overlay.
141</dd> 234<dd>
142<p></p> 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>
267<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong>
268
269<dd>
270<p>This selection allows you to do automatic transforms on a selection
271whenever a selection is made.</p>
272</dd>
273<dd>
274<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
275operator) that modify <code>$_</code> as resources:</p>
276</dd>
277<dd>
278<pre>
279 URxvt.selection-autotransform.0: transform
280 URxvt.selection-autotransform.1: transform
281 ...</pre>
282</dd>
283<dd>
284<p>For example, the following will transform selections of the form
285<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
286$word</code>:</p>
287</dd>
288<dd>
289<pre>
290 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
291</dd>
292<dd>
293<p>And this example matches the same,but replaces it with vi-commands you can
294paste directly into your (vi :) editor:</p>
295</dd>
296<dd>
297<pre>
298 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
299</dd>
300<dd>
301<p>Of course, this can be modified to suit your needs and your editor :)</p>
302</dd>
303<dd>
304<p>To expand the example above to typical perl error messages (``XXX at
305FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
306</dd>
307<dd>
308<pre>
309 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
310 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
311</dd>
312<dd>
313<p>The first line tells the selection code to treat the unchanging part of
314every error message as a selection pattern, and the second line transforms
315the message into vi commands to load the file.</p>
316</dd>
317</li>
318<dt><strong><a name="item_tabbed">tabbed</a></strong>
319
320<dd>
321<p>This transforms the terminal into a tabbar with additional terminals, that
322is, it implements what is commonly referred to as ``tabbed terminal''. The topmost line
323displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
324button per tab.</p>
325</dd>
326<dd>
327<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
328<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
329while <strong>Shift-Down</strong> creates a new tab.</p>
330</dd>
331<dd>
332<p>The tabbar itself can be configured similarly to a normal terminal, but
333with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
334following four resources (shown with defaults):</p>
335</dd>
336<dd>
337<pre>
338 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
339 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
340 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
341 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
342</dd>
343<dd>
344<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
345indices.</p>
346</dd>
347</li>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 348<dt><strong><a name="item_mark_2durls">mark-urls</a></strong>
144</dt> 349
145<dd> 350<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 351<p>Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
352make them clickable. When middle-clicked, the program specified in the
353resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
354the URL as first argument.</p>
355</dd>
356</li>
357<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong>
358
147</dd> 359<dd>
148<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 modifiers, 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. Example:</p>
406</dd>
407<dd>
408<pre>
409 rxvt -pixmap background.xpm -pe automove-background</pre>
410</dd>
411</li>
149<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>
150</dt> 413
151<dd> 414<dd>
152A 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
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 416by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 417similar-looking ascii character.</p>
418</dd>
419</li>
420<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong>
421
155</dd> 422<dd>
156<p></p> 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
428<dd>
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>
157<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>
158</dt> 496
159<dd> 497<dd>
160Displays 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
161window. Illustrates overwriting the refresh callbacks to create your own 499window. Illustrates overwriting the refresh callbacks to create your own
162overlays or changes. 500overlays or changes.</p>
501</dd>
502</li>
163</dd> 503</dl>
164<p></p></dl>
165<p> 504<p>
166</p> 505</p>
167<hr /> 506<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1> 507<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
169<p> 508<p>
… …
179the 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
180terminal is destroyed.</p> 519terminal is destroyed.</p>
181<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
182hints on what they mean:</p> 521hints on what they mean:</p>
183<dl> 522<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br /> 523<dt><strong><a name="item__text">$text</a></strong>
185</dt> 524
186<dd> 525<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 526<p>Rxvt-unicodes special way of encoding text, where one ``unicode'' character
188always represents one screen cell. See <em>row_t</em> 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>
189</dd> 528</dd>
190<p></p> 529</li>
191<dt><strong><a name="item__24string">$string</a></strong><br /> 530<dt><strong><a name="item__string">$string</a></strong>
192</dt> 531
193<dd> 532<dd>
194A 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
195characters and is to be distinguished with text encoded in a specific 534characters and is to be distinguished with text encoded in a specific
196encoding (often locale-specific) and binary data. 535encoding (often locale-specific) and binary data.</p>
197</dd> 536</dd>
198<p></p> 537</li>
199<dt><strong><a name="item__24octets">$octets</a></strong><br /> 538<dt><strong><a name="item__octets">$octets</a></strong>
200</dt> 539
201<dd> 540<dd>
202Either 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
203locale-specific way. 542locale-specific way.</p>
543</dd>
544</li>
204</dd> 545</dl>
205<p></p></dl>
206<p> 546<p>
207</p> 547</p>
208<h2><a name="extension_objects">Extension Objects</a></h2> 548<h2><a name="extension_objects">Extension Objects</a></h2>
209<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
210for 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
211hooks. 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
212about other extensions, with the exception of methods and members that 552about other extensions, with the exception of methods and members that
213begin with an underscore character <code>_</code>: these are reserved for internal 553begin with an underscore character <code>_</code>: these are reserved for internal
214use.</p> 554use.</p>
215<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
216<code>urxvt::term</code> class on this object.</p> 556<code>urxvt::term</code> class on this object.</p>
217<p>It has the following methods and data members:</p> 557<p>It has the following methods and data members:</p>
218<dl> 558<dl>
219<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>
220</dt> 560
221<dd> 561<dd>
222Returns 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
223extension. This member <em>must not</em> be changed in any way. 563extension. This member <em>must not</em> be changed in any way.</p>
224</dd> 564</dd>
225<p></p> 565</li>
226<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>
227</dt> 567
228<dd> 568<dd>
229Dynamically 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
230this extension, replacing any previous hook. This is useful when you want 570this extension, replacing any previous hook. This is useful when you want
231to overwrite time-critical hooks only temporarily. 571to overwrite time-critical hooks only temporarily.</p>
232</dd> 572</dd>
233<p></p> 573</li>
234<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>
235</dt> 575
236<dd> 576<dd>
237Dynamically disable the given hooks. 577<p>Dynamically disable the given hooks.</p>
578</dd>
579</li>
238</dd> 580</dl>
239<p></p></dl>
240<p> 581<p>
241</p> 582</p>
242<h2><a name="hooks">Hooks</a></h2> 583<h2><a name="hooks">Hooks</a></h2>
243<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
244called whenever the relevant event happens.</p> 585called whenever the relevant event happens.</p>
245<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 object as described in
246the in the <code>Extension Objects</code> section.</p> 587the in the <code>Extension Objects</code> section.</p>
247<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
248event 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
249skipped, 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>
250<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>
251<dl> 592<dl>
252<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>
253</dt> 594
254<dd> 595<dd>
255Called after a new terminal object has been initialized, but before 596<p>Called after a new terminal object has been initialized, but before
256windows 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
257call or deliver senseless data, as terminal size and other characteristics 598call or deliver senseless data, as terminal size and other characteristics
258have not yet been determined. You can safely query and change resources, 599have not yet been determined. You can safely query and change resources
259though. 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
260</dd> 606<dd>
261<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 main loop.</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>
262<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>
263</dt> 619
264<dd> 620<dd>
265Called 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
266control 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
267variables. 623variables.</p>
268</dd>
269<p></p>
270<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
271</dt>
272<dd> 624</dd>
273Called at the very end of initialisation of a new terminal, just before 625</li>
274returning to the mainloop. 626<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong>
627
275</dd> 628<dd>
276<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>
277<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>
278</dt> 640
279<dd> 641<dd>
280Called 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
281selection 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
282selection will be honored. 644selection will be honored.</p>
283</dd> 645</dd>
284<dd> 646<dd>
285<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
286have 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>
287</dd> 649</dd>
288<p></p> 650</li>
289<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>
290</dt> 652
291<dd> 653<dd>
292Called 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
293requested from the server. The selection text can be queried and changed 655requested from the server. The selection text can be queried and changed
294by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>. 656by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.</p>
295</dd>
296<dd> 657</dd>
658<dd>
297<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 highlighted.</p>
298</dd> 660</dd>
299<p></p> 661</li>
300<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>
301</dt> 663
302<dd> 664<dd>
303Called 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
304click) and is either supposed to return false (normal operation), or 666click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 667should extend the selection itself and return true to suppress the built-in
306processing. 668processing. This can happen multiple times, as long as the callback
669returns true, it will be called on every further click by the user and is
670supposed to enlarge the selection more and more, if possible.</p>
307</dd> 671</dd>
308<dd> 672<dd>
309<p>See the <em>selection</em> example extension.</p> 673<p>See the <em>selection</em> example extension.</p>
310</dd> 674</dd>
311<p></p> 675</li>
312<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>
313</dt> 677
314<dd> 678<dd>
315Called 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
316scrolls. Offset <code>0</code> means display the normal terminal, positive values 680scrolls. Offset <code>0</code> means display the normal terminal, positive values
317show this many lines of scrollback. 681show this many lines of scrollback.</p>
318</dd> 682</dd>
319<p></p> 683</li>
320<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>
321</dt> 685
322<dd> 686<dd>
323Called 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
324buffer. <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
325than the scroll back buffer or the terminal. 689than the scroll back buffer or the terminal.</p>
326</dd> 690</dd>
327<dd> 691<dd>
328<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,
329$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
330number of lines that will be in the scrollback buffer.</p> 694number of lines that will be in the scrollback buffer.</p>
331</dd> 695</dd>
332<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>
333<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>
334</dt> 711
335<dd> 712<dd>
336Called 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 =
337operating system command) is processed. Cursor position and other state 714operating system command) is processed. Cursor position and other state
338information is up-to-date when this happens. For interoperability, the 715information is up-to-date when this happens. For interoperability, the
339string should start with the extension name and a colon, to distinguish 716string should start with the extension name and a colon, to distinguish
340it 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
341future. 718future.</p>
342</dd> 719</dd>
343<dd> 720<dd>
344<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,
345as its source can not easily be controleld (e-mail content, messages from 722as its source can not easily be controlled (e-mail content, messages from
346other users on the same system etc.).</p> 723other users on the same system etc.).</p>
347</dd> 724</dd>
348<p></p> 725</li>
349<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>
350</dt> 727
351<dd> 728<dd>
352Called 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
353can 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
354and 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
355might 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
356output. 733output.</p>
357</dd> 734</dd>
358<p></p> 735</li>
359<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>
360</dt> 737
361<dd> 738<dd>
362Called 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
363suppress or filter tty input. 740suppress or filter tty input.</p>
364</dd> 741</dd>
365<p></p> 742</li>
366<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>
367</dt> 744
368<dd> 745<dd>
369Called 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
370screen output (e.g. underline urls or other useless stuff). Only lines 747screen output (e.g. underline urls or other useless stuff). Only lines
371that are being shown will be filtered, and, due to performance reasons, 748that are being shown will be filtered, and, due to performance reasons,
372not always immediately. 749not always immediately.</p>
373</dd> 750</dd>
374<dd> 751<dd>
375<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
376multiple rows.</p> 753multiple rows.</p>
377</dd> 754</dd>
378<dd> 755<dd>
379<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
380later 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
381you cannot just toggle rendition bits, but only set them.</p> 758you cannot just toggle rendition bits, but only set them.</p>
382</dd> 759</dd>
383<p></p> 760</li>
384<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>
385</dt> 762
386<dd> 763<dd>
387Called 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
388or similar effects by modify terminal contents in refresh_begin, and 765or similar effects by modify terminal contents in refresh_begin, and
389restoring them in refresh_end. The built-in overlay and selection display 766restoring them in refresh_end. The built-in overlay and selection display
390code is run after this hook, and takes precedence. 767code is run after this hook, and takes precedence.</p>
391</dd> 768</dd>
392<p></p> 769</li>
393<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>
394</dt> 771
395<dd> 772<dd>
396Called 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>
397</dd> 774</dd>
398<p></p> 775</li>
399<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>
400</dt> 777
401<dd> 778<dd>
402Called whenever the user presses a key combination that has a 779<p>Called whenever a user-configured event is being activated (e.g. via
403<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>
404resource in the <code>rxvt(1)</code> manpage). 781resource in the <code>rxvt(1)</code> manpage).</p>
782</dd>
405</dd> 783<dd>
406<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 calculated, 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>
796<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong>
797
798<dd>
799<p>Called on every X event received on the vt window (and possibly other
800windows). Should only be used as a last resort. Most event structure
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
806<dd>
807<p>Like <code>on_x_event</code>, but is called for events on the root window.</p>
808</dd>
809</li>
407<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>
408</dt> 811
409<dd> 812<dd>
410Called whenever the window gets the keyboard focus, before rxvt-unicode 813<p>Called whenever the window gets the keyboard focus, before rxvt-unicode
411does focus in processing. 814does focus in processing.</p>
412</dd> 815</dd>
413<p></p> 816</li>
414<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>
415</dt> 818
416<dd> 819<dd>
417Called wheneever the window loses keyboard focus, before rxvt-unicode does 820<p>Called whenever the window loses keyboard focus, before rxvt-unicode does
418focus out processing. 821focus out processing.</p>
419</dd> 822</dd>
420<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
421<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>
422</dt> 829
423<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>
424</dt> 831
425<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>
426</dt> 833
427<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>
428</dt> 835
429<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>
430</dt> 837
431<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>
432</dt> 839
433<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>
434</dt> 841
435<dd> 842<dd>
436Called 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
437the 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>
438</dd> 845</dd>
439<dd> 846<dd>
440<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
441manpage), 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
442and column under the mouse cursor.</p> 849(real, not screen-based) row and column under the mouse cursor.</p>
443</dd> 850</dd>
444<dd> 851<dd>
445<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
446output, if any, in locale-specific encoding.</p> 853output, if any, in locale-specific encoding.</p>
447</dd> 854</dd>
448<dd> 855<dd>
449<p>subwindow.</p> 856<p>subwindow.</p>
450</dd> 857</dd>
451<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>
452<p> 871<p>
453</p> 872</p>
454<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>
455<dl> 874<dl>
456<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>
457</dt> 876
458<dd> 877<dd>
459The rxvt-unicode library directory, where, among other things, the perl 878<p>The rxvt-unicode library directory, where, among other things, the perl
460modules and scripts are stored. 879modules and scripts are stored.</p>
461</dd>
462<p></p>
463<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
464</dt>
465<dd> 880</dd>
881</li>
882<dt><strong><a name="item__urxvt__resclass_">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong>
883
884<dd>
466The 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>
467</dd> 886</dd>
468<p></p> 887</li>
469<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>
470</dt> 889
471<dd> 890<dd>
472The basename of the installed binaries, usually <code>urxvt</code>. 891<p>The basename of the installed binaries, usually <code>urxvt</code>.</p>
473</dd> 892</dd>
474<p></p> 893</li>
475<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>
476</dt> 895
477<dd> 896<dd>
478The 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>
479object, 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
480</dd> 903<dd>
481<p></p> 904<p>All code references in this array will be called as methods of the next newly
482<dt></dt> 905created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
906gets cleared before the code references that were in it are being executed,
907so references can push themselves onto it again if they so desire.</p>
908</dd>
909<dd>
910<p>This complements to the perl-eval command line 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>
483</dl> 922</dl>
484<p> 923<p>
485</p> 924</p>
486<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>
487<dl> 926<dl>
488<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
489</dt>
490<dd>
491Creates a new terminal, very similar as if you had started it with
492<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
493if the new instance couldn't be created. Returns <code>undef</code> if the new
494instance didn't initialise perl, and the terminal object otherwise. The
495<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
496</dd>
497<p></p>
498<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>
499</dt> 928
500<dd> 929<dd>
501Fatally aborts execution with the given error message. Avoid at all 930<p>Fatally aborts execution with the given error message. Avoid at all
502costs! The only time this is acceptable is when the terminal process 931costs! The only time this is acceptable is when the terminal process
503starts up. 932starts up.</p>
504</dd> 933</dd>
505<p></p> 934</li>
506<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>
507</dt> 936
508<dd> 937<dd>
509Calls <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
510newline. 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
511that calls this function. 940that calls this function.</p>
512</dd> 941</dd>
513<dd> 942<dd>
514<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
515correct place, e.g. on stderr of the connecting urxvtc client.</p> 944correct place, e.g. on stderr of the connecting urxvtc client.</p>
516</dd> 945</dd>
517<p></p>
518<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519</dt>
520<dd>
521Returns true when it is safe to do potentially unsafe things, such as
522evaluating perl code specified by the user. This is true when urxvt was
523started setuid or setgid.
524</dd> 946<dd>
525<p></p> 947<p>Messages have a size limit of 1023 bytes currently.</p>
526<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
527</dt>
528<dd> 948</dd>
949</li>
950<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong>
951
952<dd>
953<p>Returns all urxvt::term objects that exist in this process, regardless of
954whether they are started, being destroyed etc., so be careful. Only term
955objects that have perl extensions attached will be returned (because there
956is no urxvt::term objet associated with others).</p>
957</dd>
958</li>
959<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong>
960
961<dd>
529Returns the ``current time'' (as per the event loop). 962<p>Returns the ``current time'' (as per the event loop).</p>
530</dd> 963</dd>
531<p></p> 964</li>
532<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>
533</dt> 966
534<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,
535Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 968Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
536Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 969Button4Mask, Button5Mask, AnyModifier</a></strong>
537</dt> 970
971<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
972ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
973PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
974Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
975KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
976ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
977FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong>
978
979<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
980EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
981GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
982UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
983ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
984CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
985SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong>
986
538<dd> 987<dd>
539Various 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>
540</dd> 991</dl>
541<p></p></dl>
542<p> 992<p>
543</p> 993</p>
544<h2><a name="rendition">RENDITION</a></h2> 994<h2><a name="rendition">RENDITION</a></h2>
545<p>Rendition bitsets contain information about colour, font, font styles and 995<p>Rendition bitsets contain information about colour, font, font styles and
546similar information for each screen cell.</p> 996similar information for each screen cell.</p>
547<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
548never just create a bitset, you should always modify an existing one, 998never just create a bitset, you should always modify an existing one,
549as they contain important information required for correct operation of 999as they contain important information required for correct operation of
550rxvt-unicode.</p> 1000rxvt-unicode.</p>
551<dl> 1001<dl>
552<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>
553</dt> 1003
554<dd> 1004<dd>
555Returns 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
556being reset. Useful as a base to start when creating renditions. 1006being reset. Useful as a base to start when creating renditions.</p>
557</dd>
558<p></p>
559<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
560</dt>
561<dd> 1007</dd>
1008</li>
1009<dt><strong>$rend = urxvt::OVERLAY_RSTYLE</strong>
1010
1011<dd>
562Return the rendition mask used for overlays by default. 1012<p>Return the rendition mask used for overlays by default.</p>
563</dd>
564<p></p>
565<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 />
566</dt>
567<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>
568Return the bit that enabled bold, italic, blink, reverse-video and 1018<p>Return the bit that enabled bold, italic, blink, reverse-video and
569underline, respectively. To enable such a style, just logically OR it into 1019underline, respectively. To enable such a style, just logically OR it into
570the bitset. 1020the bitset.</p>
571</dd>
572<p></p>
573<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
574</dt>
575<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
576</dt>
577<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>
578Return the foreground/background colour index, respectively. 1028<p>Return the foreground/background colour index, respectively.</p>
579</dd>
580<p></p>
581<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
582</dt>
583<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
584</dt>
585<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>
586Replace the foreground/background colour in the rendition mask with the 1038<p>Replace the foreground/background colour in the rendition mask with the
587specified one. 1039specified one.</p>
588</dd>
589<p></p>
590<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
591</dt>
592<dd> 1040</dd>
1041</li>
1042<dt><strong><a name="item__value">$value = urxvt::GET_CUSTOM $rend</a></strong>
1043
1044<dd>
593Return 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
594extensions. 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
595zero. 1047zero.</p>
596</dd>
597<p></p>
598<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
599</dt>
600<dd> 1048</dd>
601Change the custom value. 1049</li>
1050<dt><strong>$rend = urxvt::SET_CUSTOM $rend, $new_value</strong>
1051
602</dd> 1052<dd>
603<p></p></dl> 1053<p>Change the custom value.</p>
1054</dd>
1055</li>
1056</dl>
604<p> 1057<p>
605</p> 1058</p>
606<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>
607<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
608<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
… …
612work.</p> 1065work.</p>
613<p> 1066<p>
614</p> 1067</p>
615<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>
616<dl> 1069<dl>
1070<dt><strong><a name="item__term">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong>
1071
1072<dd>
1073<p>Creates a new terminal, very similar as if you had started it with system
1074<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
1075hash which defines the environment of the new terminal.</p>
1076</dd>
1077<dd>
1078<p>Croaks (and probably outputs an error message) if the new instance
1079couldn't be created. Returns <code>undef</code> if the new instance didn't
1080initialise perl, and the terminal object otherwise. The <code>init</code> and
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>
1083</dd>
1084</li>
617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1085<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong>
618</dt> 1086
619<dd> 1087<dd>
620Destroy the terminal object (close the window, free resources 1088<p>Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event 1089etc.). Please note that rxvt will not exit as long as any event
622watchers (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
623</dd> 1095<dd>
624<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>
625<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>
626</dt> 1106
627<dd> 1107<dd>
628Returns 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
629optionally 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
630<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>
631</dd>
632<dd> 1111</dd>
1112<dd>
633<p>Here is a a likely non-exhaustive list of option names, please see the 1113<p>Here is a likely non-exhaustive list of option names, please see the
634source 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>
635</dd> 1115</dd>
636<dd> 1116<dd>
637<pre> 1117<pre>
638 borderLess console cursorBlink cursorUnderline hold iconic insecure 1118 borderLess console cursorBlink cursorUnderline hold iconic insecure
639 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1119 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
640 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1120 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
641 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1121 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
642 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1122 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
643 tripleclickwords utmpInhibit visualBell</pre> 1123 transparent tripleclickwords utmpInhibit visualBell</pre>
644</dd> 1124</dd>
645<p></p> 1125</li>
646<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>
647</dt> 1127
648<dd> 1128<dd>
649Returns the current resource value associated with a given name and 1129<p>Returns the current resource value associated with a given name and
650optionally 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>
651hook. Unset resources are returned and accepted as <code>undef</code>. 1131hook. Unset resources are returned and accepted as <code>undef</code>.</p>
652</dd> 1132</dd>
653<dd> 1133<dd>
654<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
655before passing it to this method. Similarly, the returned value may need 1135before passing it to this method. Similarly, the returned value may need
656to be converted from the used encoding to text.</p> 1136to be converted from the used encoding to text.</p>
… …
663<dd> 1143<dd>
664<p>Please note that resource strings will currently only be freed when the 1144<p>Please note that resource strings will currently only be freed when the
665terminal is destroyed, so changing options frequently will eat memory.</p> 1145terminal is destroyed, so changing options frequently will eat memory.</p>
666</dd> 1146</dd>
667<dd> 1147<dd>
668<p>Here is a a likely non-exhaustive list of resource names, not all of which 1148<p>Here is a likely non-exhaustive list of resource names, not all of which
669are supported in every build, please see the source file <em>/src/rsinc.h</em> 1149are supported in every build, please see the source file <em>/src/rsinc.h</em>
670to see the actual list:</p> 1150to see the actual list:</p>
671</dd> 1151</dd>
672<dd> 1152<dd>
673<pre> 1153<pre>
674 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1154 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
675 borderLess color cursorBlink cursorUnderline cutchars delete_key 1155 borderLess color cursorBlink cursorUnderline cutchars delete_key
676 display_name embed ext_bwidth fade font geometry hold iconName 1156 display_name embed ext_bwidth fade font geometry hold iconName
677 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1157 imFont imLocale inputMethod insecure int_bwidth intensityStyles
678 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1158 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
679 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1159 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
680 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1160 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
681 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1161 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
682 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1162 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
683 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1163 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
684 shade term_name title transparent transparent_all tripleclickwords 1164 secondaryScreen secondaryScroll selectstyle shade term_name title
1165 transient_for transparent transparent_all tripleclickwords utmpInhibit
685 utmpInhibit visualBell</pre> 1166 visualBell</pre>
1167</dd>
1168</li>
1169<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong>
1170
686</dd> 1171<dd>
687<p></p> 1172<p>Returns the X-Resource for the given pattern, excluding the program or
1173class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
1174same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1175resource with that pattern exists.</p>
1176</dd>
1177<dd>
1178<p>This method should only be called during the <code>on_start</code> hook, as there is
1179only one resource database per display, and later invocations might return
1180the wrong resources.</p>
1181</dd>
1182</li>
688<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>
689</dt> 1184
690<dd> 1185<dd>
691Adds 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
692<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 1187<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.</p>
693</dd> 1188</dd>
694<p></p> 1189</li>
695<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>
696</dt> 1191
697<dd> 1192<dd>
698Return 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
699the terminal application will use this style. 1194the terminal application will use this style.</p>
700</dd> 1195</dd>
701<p></p> 1196</li>
702<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>
703</dt> 1198
704<dd> 1199<dd>
705Return the current coordinates of the text cursor position and optionally 1200<p>Return the current coordinates of the text cursor position and optionally
706set it (which is usually bad as applications don't expect that). 1201set it (which is usually bad as applications don't expect that).</p>
707</dd> 1202</dd>
708<p></p> 1203</li>
709<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>
710</dt> 1205
711<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>
712</dt> 1207
713<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>
714</dt> 1209
715<dd> 1210<dd>
716Return 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,
717and optionally set them to new values. 1212and optionally set them to new values.</p>
1213</dd>
1214</li>
1215<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong>
1216
718</dd> 1217<dd>
719<p></p> 1218<p>Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1219<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1220rectangular selection will be made. This is the prefered function to make
1221a selection.</p>
1222</dd>
1223</li>
720<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>
721</dt> 1225
722<dd> 1226<dd>
723Try to request the primary selection from the server (for example, as set 1227<p>Try to request the primary selection text from the server (for example, as
724by the next method). 1228set by the next method). No visual feedback will be given. This function
1229is mostly useful from within <code>on_sel_grab</code> hooks.</p>
725</dd> 1230</dd>
726<p></p> 1231</li>
727<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1232<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong>
728</dt> 1233
729<dd> 1234<dd>
730Return 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>
731</dd> 1236</dd>
732<p></p> 1237</li>
733<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>
734</dt> 1239
735<dd> 1240<dd>
736Create 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>
737</dd> 1242</dd>
738<p></p> 1243</li>
739<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>
740</dt> 1245
741<dd> 1246<dd>
742Create 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
743width/height. <code>$rstyle</code> defines the initial rendition style 1248width/height. <code>$rstyle</code> defines the initial rendition style
744(default: <code>OVERLAY_RSTYLE</code>). 1249(default: <code>OVERLAY_RSTYLE</code>).</p>
745</dd> 1250</dd>
746<dd> 1251<dd>
747<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
748around the box.</p> 1253around the box.</p>
749</dd> 1254</dd>
… …
757</dd> 1262</dd>
758<dd> 1263<dd>
759<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>
760</dd> 1265</dd>
761<dl> 1266<dl>
762<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>
763</dt> 1268
764<dd> 1269<dd>
765Similar 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
766text 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
767at a specific position inside the overlay. 1272at a specific position inside the overlay.</p>
768</dd> 1273</dd>
769<p></p> 1274</li>
770<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br /> 1275<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong>
771</dt> 1276
772<dd> 1277<dd>
773If visible, hide the overlay, but do not destroy it. 1278<p>If visible, hide the overlay, but do not destroy it.</p>
774</dd> 1279</dd>
775<p></p> 1280</li>
776<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br /> 1281<dt><strong><a name="item_show">$overlay-&gt;show</a></strong>
777</dt> 1282
778<dd> 1283<dd>
779If hidden, display the overlay again. 1284<p>If hidden, display the overlay again.</p>
1285</dd>
1286</li>
780</dd> 1287</dl>
781<p></p></dl>
782<dt><strong>$popup = $term-&gt;popup ($event)</strong><br /> 1288<dt><strong>$popup = $term-&gt;popup ($event)</strong>
783</dt> 1289
784<dd> 1290<dd>
785Creates 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
786<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,
787currently). 1293currently).</p>
788</dd> 1294</dd>
789<p></p> 1295</li>
790<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>
791</dt> 1297
792<dd> 1298<dd>
793Returns the number of screen-cells this string would need. Correctly 1299<p>Returns the number of screen-cells this string would need. Correctly
794accounts for wide and combining characters. 1300accounts for wide and combining characters.</p>
795</dd> 1301</dd>
796<p></p> 1302</li>
797<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>
798</dt> 1304
799<dd> 1305<dd>
800Convert the given text string into the corresponding locale encoding. 1306<p>Convert the given text string into the corresponding locale encoding.</p>
801</dd> 1307</dd>
802<p></p> 1308</li>
803<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>
804</dt> 1310
805<dd> 1311<dd>
806Convert the given locale-encoded octets into a perl string. 1312<p>Convert the given locale-encoded octets into a perl string.</p>
807</dd> 1313</dd>
808<p></p> 1314</li>
809<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>
810</dt> 1316
811<dd> 1317<dd>
812XORs 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
813(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar 1319(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
814to the selection. 1320refresh hooks to provide effects similar to the selection.</p>
815</dd> 1321</dd>
816<p></p> 1322</li>
817<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>
818</dt> 1324
819<dd> 1325<dd>
820Similar 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
821whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 1327whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
822to <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
823it instead. 1329it instead. Both styles <em>MUST NOT</em> contain font styles.</p>
824</dd> 1330</dd>
825<p></p> 1331</li>
826<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>
827</dt> 1333
828<dd>
829Ring the bell!
830</dd> 1334<dd>
831<p></p> 1335<p>Ring the bell!</p>
1336</dd>
1337</li>
832<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>
833</dt> 1339
834<dd> 1340<dd>
835Write 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
836running inside the terminal. It may not contain command sequences (escape 1342running inside the terminal. It may not contain command sequences (escape
837codes), 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
838string is a normal text string, not in locale-dependent encoding. 1344string is a normal text string, not in locale-dependent encoding.</p>
839</dd> 1345</dd>
840<dd> 1346<dd>
841<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
842confused by changes in cursor position or scrolling. Its useful inside a 1348confused by changes in cursor position or scrolling. Its useful inside a
843<code>on_add_lines</code> hook, though.</p> 1349<code>on_add_lines</code> hook, though.</p>
844</dd> 1350</dd>
845<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>
846<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>
847</dt> 1359
848<dd> 1360<dd>
849Similar 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
850locale-specific encoding of the terminal and can contain command sequences 1362locale-specific encoding of the terminal and can contain command sequences
851(escape codes) that will be interpreted. 1363(escape codes) that will be interpreted.</p>
852</dd> 1364</dd>
853<p></p> 1365</li>
854<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>
855</dt> 1367
856<dd> 1368<dd>
857Write 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
858pass characters instead of octets, you should convert your strings first 1370pass characters instead of octets, you should convert your strings first
859to 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>
860</dd> 1372</dd>
861<p></p> 1373</li>
862<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>
863</dt> 1375
864<dd> 1376<dd>
865Replaces 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
866be 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
867description 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
868the 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
869</dd> 1385<dd>
870<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>
871<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>
872</dt> 1391
873<dd> 1392<dd>
874Return the window id of the toplevel window. 1393<p>Return the window id of the toplevel window.</p>
875</dd> 1394</dd>
876<p></p> 1395</li>
877<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>
878</dt> 1397
879<dd> 1398<dd>
880Return the window id of the terminal window. 1399<p>Return the window id of the terminal window.</p>
1400</dd>
1401</li>
1402<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong>
1403
881</dd> 1404<dd>
882<p></p> 1405<p>Adds the specified events to the vt event mask. Useful e.g. when you want
1406to receive pointer events all the times:</p>
1407</dd>
1408<dd>
1409<pre>
1410 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1411</dd>
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>
883<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>
884</dt> 1426
885<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>
886</dt> 1428
887<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>
888</dt> 1430
889<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>
890</dt> 1432
891<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>
892</dt> 1434
893<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>
894</dt> 1436
895<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>
896</dt> 1438
897<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>
898</dt> 1440
899<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>
900</dt> 1442
901<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>
902</dt> 1444
903<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>
904</dt> 1446
905<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>
906</dt> 1448
907<dd> 1449<dd>
908Return various integers describing terminal characteristics. 1450<p>Return various integers describing terminal characteristics.</p>
909</dd>
910<p></p>
911<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912</dt>
913<dd> 1451</dd>
914Returns the LC_CTYPE category string used by this rxvt-unicode. 1452</li>
915</dd>
916<p></p>
917<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>
918</dt> 1454
919<dd> 1455<dd>
920Return the DISPLAY used by rxvt-unicode. 1456<p>Return the DISPLAY used by rxvt-unicode.</p>
1457</dd>
1458</li>
1459<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong>
1460
921</dd> 1461<dd>
922<p></p> 1462<p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>
1463</dd>
1464</li>
1465<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong>
1466
1467<dd>
1468<p>Returns a copy of the environment in effect for the terminal as a hashref
1469similar to <code>\%ENV</code>.</p>
1470</dd>
1471</li>
1472<dt><strong><a name="item_envv">@envv = $term-&gt;envv</a></strong>
1473
1474<dd>
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>
923<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>
924</dt> 1486
925<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>
926</dt> 1488
927<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>
928</dt> 1490
929<dd> 1491<dd>
930Return 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
931AltGr), 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
932</dd> 1498<dd>
933<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 whether the cursor is currently hidden or not.</p>
1506</dd>
1507</li>
934<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>
935</dt> 1509
936<dd> 1510<dd>
937Returns 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
938<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
939this many lines into the scrollback buffer. 1513this many lines into the scrollback buffer.</p>
940</dd> 1514</dd>
941<p></p> 1515</li>
942<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>
943</dt> 1517
944<dd> 1518<dd>
945Requests a screen refresh. At the next opportunity, rxvt-unicode will 1519<p>Requests a screen refresh. At the next opportunity, rxvt-unicode will
946compare the on-screen display with its stored representation. If they 1520compare the on-screen display with its stored representation. If they
947differ, it redraws the differences. 1521differ, it redraws the differences.</p>
948</dd> 1522</dd>
949<dd> 1523<dd>
950<p>Used after changing terminal contents to display them.</p> 1524<p>Used after changing terminal contents to display them.</p>
951</dd> 1525</dd>
952<p></p> 1526</li>
953<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>
954</dt> 1528
955<dd> 1529<dd>
956Returns 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>
957is 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
958terminal 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
959line <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
960is requested. 1534is requested.</p>
961</dd> 1535</dd>
962<dd> 1536<dd>
963<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
964line, 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
965to 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
966automatically be updated.</p> 1540automatically be updated.</p>
967</dd> 1541</dd>
968<dd> 1542<dd>
969<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
970than one cell when displayed are padded with urxvt::NOCHAR characters 1544than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
971(<code>chr 65535</code>). Characters with combining characters and other characters 1545characters. Characters with combining characters and other characters that
972that 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
973characters in the private use area.</p> 1547in the private use area.</p>
974</dd> 1548</dd>
975<dd> 1549<dd>
976<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
977that <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
978characters.</p> 1552characters.</p>
979</dd> 1553</dd>
980<dd> 1554<dd>
981<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>
982can 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>
983</dd> 1557</dd>
984<p></p> 1558</li>
985<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>
986</dt> 1560
987<dd> 1561<dd>
988Like <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
989bitsets. Rendition bitsets contain information about colour, font, font 1563bitsets. Rendition bitsets contain information about colour, font, font
990styles 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>
991</dd> 1565</dd>
992<dd> 1566<dd>
993<p>When setting rendition, the font mask will be ignored.</p> 1567<p>When setting rendition, the font mask will be ignored.</p>
994</dd> 1568</dd>
995<dd> 1569<dd>
996<p>See the section on RENDITION, above.</p> 1570<p>See the section on RENDITION, above.</p>
997</dd> 1571</dd>
998<p></p> 1572</li>
999<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>
1000</dt> 1574
1001<dd> 1575<dd>
1002Returns 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
1003length''). 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
1004line is joined with the following one. 1578line is joined with the following one.</p>
1005</dd> 1579</dd>
1006<p></p> 1580</li>
1007<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>
1008</dt> 1582
1009<dd> 1583<dd>
1010Returns 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.
1011joined with the following row), which means all characters are in use 1585joined with the following row), which means all characters are in use
1012and 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
1013previous row(s)). 1587previous row(s)).</p>
1014</dd> 1588</dd>
1015<p></p> 1589</li>
1016<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>
1017</dt> 1591
1018<dd> 1592<dd>
1019Create 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
1020about 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
1021following methods: 1595following methods:</p>
1022</dd> 1596</dd>
1023<dl> 1597<dl>
1024<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>
1025</dt> 1599
1026<dd> 1600<dd>
1027Returns 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>
1028</dd> 1602</dd>
1029<p></p> 1603</li>
1030<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>
1031</dt> 1605
1032<dd> 1606<dd>
1033Returns 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>
1034</dd> 1608</dd>
1035<p></p> 1609</li>
1036<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>
1037</dt> 1611
1038<dd> 1612<dd>
1039Returns 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>
1040</dd> 1614</dd>
1041<p></p> 1615</li>
1042<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>
1043</dt> 1617
1044<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>
1045</dt> 1619
1046<dd> 1620<dd>
1047Return 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>
1048</dd> 1622</dd>
1049<p></p> 1623</li>
1050<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>
1051</dt> 1625
1052<dd> 1626<dd>
1053Returns 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
1054line. 1628line. Works for rows outside the line, too, and returns corresponding
1629offsets outside the string.</p>
1055</dd> 1630</dd>
1056<p></p> 1631</li>
1057<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>
1058</dt> 1633
1059<dd> 1634<dd>
1060Translates a string offset into terminal coordinates again. 1635<p>Translates a string offset into terminal coordinates again.</p>
1636</dd>
1637</li>
1061</dd> 1638</dl>
1062<p></p></dl>
1063<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>
1064</dt> 1640
1065<dd> 1641<dd>
1066Converts 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,
1067where one character corresponds to one screen cell. See 1643where one character corresponds to one screen cell. See
1068<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>
1069</dd> 1645</dd>
1070<p></p> 1646</li>
1071<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>
1072</dt> 1648
1073<dd> 1649<dd>
1074Converts rxvt-unicodes text reprsentation into a perl string. See 1650<p>Converts rxvt-unicodes text representation into a perl string. See
1075<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>
1076</dd>
1077<p></p>
1078<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1079</dt>
1080<dd> 1652</dd>
1081Registers 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
1082</dd> 1658<dd>
1083<p></p> 1659<p>Register/unregister a synchronous button grab. See the XGrabButton
1660manpage.</p>
1661</dd>
1662</li>
1084<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>
1085</dt> 1664
1086<dd> 1665<dd>
1087Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1666<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1088synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. 1667synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
1089</dd> 1668</dd>
1090<p></p> 1669</li>
1091<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>
1092</dt> 1671
1093<dd> 1672<dd>
1094Calls XAllowEvents with AsyncBoth for the most recent grab. 1673<p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>
1095</dd> 1674</dd>
1096<p></p> 1675</li>
1097<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>
1098</dt> 1677
1099<dd> 1678<dd>
1100Calls XAllowEvents with SyncBoth for the most recent grab. 1679<p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>
1101</dd> 1680</dd>
1102<p></p> 1681</li>
1103<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>
1104</dt> 1683
1105<dd> 1684<dd>
1106Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1685<p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1107recent grab. 1686recent grab.</p>
1108</dd> 1687</dd>
1109<p></p> 1688</li>
1110<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br /> 1689<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong>
1111</dt> 1690
1112<dd> 1691<dd>
1113Calls XUngrab for the most recent grab. Is called automatically on 1692<p>Calls XUngrab for the most recent grab. Is called automatically on
1114evaluation 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
1115the 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
1116</dd> 1723<dd>
1117<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>
1118<p> 1730<p>
1119</p> 1731</p>
1120<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>
1121<dl> 1733<dl>
1122<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>
1123</dt> 1735
1124<dd> 1736<dd>
1125Adds a non-clickable title to the popup. 1737<p>Adds a non-clickable title to the popup.</p>
1126</dd> 1738</dd>
1127<p></p> 1739</li>
1128<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>
1129</dt> 1741
1130<dd> 1742<dd>
1131Creates 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>
1132</dd> 1744</dd>
1133<p></p> 1745</li>
1134<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>
1135</dt> 1747
1136<dd> 1748<dd>
1137Adds 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
1138selected. 1750selected.</p>
1139</dd> 1751</dd>
1140<p></p> 1752</li>
1141<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>
1142</dt> 1754
1143<dd> 1755<dd>
1144Adds 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
1145whenever 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
1146argument. 1758first argument.</p>
1147</dd> 1759</dd>
1148<p></p> 1760</li>
1149<dt><strong>$popup-&gt;show</strong><br /> 1761<dt><strong>$popup-&gt;show</strong>
1150</dt> 1762
1151<dd> 1763<dd>
1152Displays the popup (which is initially hidden). 1764<p>Displays the popup (which is initially hidden).</p>
1765</dd>
1766</li>
1153</dd> 1767</dl>
1154<p></p></dl>
1155<p> 1768<p>
1156</p> 1769</p>
1157<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>
1158<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
1159fractional number of seconds since the epoch. Example:</p> 1772fractional number of seconds since the epoch. Example:</p>
… …
1165 -&gt;cb (sub { 1778 -&gt;cb (sub {
1166 $term-&gt;{overlay}-&gt;set (0, 0, 1779 $term-&gt;{overlay}-&gt;set (0, 0,
1167 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]);
1168 });</pre> 1781 });</pre>
1169<dl> 1782<dl>
1170<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>
1171</dt> 1784
1172<dd> 1785<dd>
1173Create 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
1174immediately. 1787immediately.</p>
1175</dd> 1788</dd>
1176<p></p> 1789</li>
1177<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>
1178</dt> 1791
1179<dd> 1792<dd>
1180Set the callback to be called when the timer triggers. 1793<p>Set the callback to be called when the timer triggers.</p>
1181</dd> 1794</dd>
1182<p></p> 1795</li>
1183<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>
1184</dt> 1797
1185<dd> 1798<dd>
1186Return the time this watcher will fire next. 1799<p>Return the time this watcher will fire next.</p>
1187</dd> 1800</dd>
1188<p></p> 1801</li>
1189<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br /> 1802<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong>
1190</dt> 1803
1191<dd> 1804<dd>
1192Set the time the event is generated to $tstamp. 1805<p>Set the time the event is generated to $tstamp.</p>
1193</dd> 1806</dd>
1194<p></p> 1807</li>
1195<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>
1196</dt> 1809
1197<dd> 1810<dd>
1198Normally (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
1199stop 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
1200is automatically rescheduled at the given intervals. 1813is automatically rescheduled at the given intervals.</p>
1201</dd> 1814</dd>
1202<p></p> 1815</li>
1203<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>
1204</dt> 1817
1205<dd>
1206Start the timer.
1207</dd> 1818<dd>
1208<p></p> 1819<p>Start the timer.</p>
1820</dd>
1821</li>
1209<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1822<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong>
1210</dt> 1823
1211<dd> 1824<dd>
1212Set 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
1213</dd> 1830<dd>
1214<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>
1215<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>
1216</dt> 1835
1217<dd>
1218Stop the timer.
1219</dd> 1836<dd>
1220<p></p></dl> 1837<p>Stop the timer.</p>
1838</dd>
1839</li>
1840</dl>
1221<p> 1841<p>
1222</p> 1842</p>
1223<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>
1224<p>This class implements io watchers/events. Example:</p> 1844<p>This class implements io watchers/events. Example:</p>
1225<pre> 1845<pre>
… …
1234 # $revents must be 1 here, no need to check 1854 # $revents must be 1 here, no need to check
1235 sysread $term-&gt;{socket}, my $buf, 8192 1855 sysread $term-&gt;{socket}, my $buf, 8192
1236 or end-of-file; 1856 or end-of-file;
1237 });</pre> 1857 });</pre>
1238<dl> 1858<dl>
1239<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>
1240</dt> 1860
1241<dd> 1861<dd>
1242Create a new io watcher object in stopped state. 1862<p>Create a new io watcher object in stopped state.</p>
1243</dd> 1863</dd>
1244<p></p> 1864</li>
1245<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> 1865<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong>
1246</dt> 1866
1247<dd> 1867<dd>
1248Set 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>
1249is 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>
1250</dd> 1870</dd>
1251<p></p> 1871</li>
1252<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>
1253</dt> 1873
1254<dd> 1874<dd>
1255Set the filedescriptor (not handle) to watch. 1875<p>Set the file descriptor (not handle) to watch.</p>
1256</dd> 1876</dd>
1257<p></p> 1877</li>
1258<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>
1259</dt> 1879
1260<dd> 1880<dd>
1261Set the event mask to watch. The only allowed values are 1881<p>Set the event mask to watch. The only allowed values are
1262<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
1263together, or <code>urxvt::EVENT_NONE</code>. 1883together, or <code>urxvt::EVENT_NONE</code>.</p>
1264</dd> 1884</dd>
1265<p></p> 1885</li>
1266<dt><strong>$iow = $iow-&gt;start</strong><br /> 1886<dt><strong>$iow = $iow-&gt;start</strong>
1267</dt> 1887
1268<dd> 1888<dd>
1269Start watching for requested events on the given handle. 1889<p>Start watching for requested events on the given handle.</p>
1270</dd> 1890</dd>
1271<p></p> 1891</li>
1272<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1892<dt><strong>$iow = $iow-&gt;stop</strong>
1273</dt> 1893
1274<dd> 1894<dd>
1275Stop watching for events on the given filehandle. 1895<p>Stop watching for events on the given file handle.</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
1276</dd> 1908<dd>
1277<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 watcher 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>
1278<p> 1972<p>
1279</p> 1973</p>
1280<hr /> 1974<hr />
1281<h1><a name="environment">ENVIRONMENT</a></h1> 1975<h1><a name="environment">ENVIRONMENT</a></h1>
1282<p> 1976<p>
1283</p> 1977</p>
1284<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1978<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1285<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
1286numbers indicate more verbose output.</p> 1980numbers indicate more verbose output.</p>
1287<dl> 1981<dl>
1288<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>
1289</dt> 1983
1290<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>
1291</dt> 1985
1292<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1986<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong>
1293</dt> 1987
1988<dt><strong><a name="item__3e_3d11__2d_hook_return_values">&gt;=11 - hook return values</a></strong>
1989
1294</dl> 1990</dl>
1295<p> 1991<p>
1296</p> 1992</p>
1297<hr /> 1993<hr />
1298<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