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.4 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.42 by root, Mon Feb 6 06:14:55 2006 UTC

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

Diff Legend

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