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.1 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.43 by root, Tue Feb 21 01:00:40 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
22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
20 <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>
21 <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>
22 <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>
23 <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>
24 <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>
35 </ul>
36
37 <li><a href="#environment">ENVIRONMENT</a></li>
38 <ul>
39
40 <li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li>
25 </ul> 41 </ul>
26 42
27 <li><a href="#author">AUTHOR</a></li> 43 <li><a href="#author">AUTHOR</a></li>
28</ul> 44</ul>
29<!-- INDEX END --> 45<!-- INDEX END -->
30 46
31<hr /> 47<hr />
32<p> 48<p>
33</p> 49</p>
50<hr />
34<h1><a name="name">NAME</a></h1> 51<h1><a name="name">NAME</a></h1>
35<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
36<p> 53<p>
37</p> 54</p>
38<hr /> 55<hr />
39<h1><a name="synopsis">SYNOPSIS</a></h1> 56<h1><a name="synopsis">SYNOPSIS</a></h1>
40<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 57<pre>
41<p>* Each script will only be loaded once, even in urxvtd, and will be valid 58 # create a file grab_test in $HOME:</pre>
42globally.</p>
43<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
44thus must be encoded as UTF-8.</p>
45<pre> 59<pre>
46 sub on_sel_grab { 60 sub on_sel_grab {
47 warn &quot;you selected &quot;, $_[0]-&gt;selection; 61 warn &quot;you selected &quot;, $_[0]-&gt;selection;
48 () 62 ()
49 }</pre> 63 }</pre>
50<pre> 64<pre>
51 1</pre> 65 # start a rxvt using it:</pre>
66<pre>
67 rxvt --perl-lib $HOME -pe grab_test</pre>
52<p> 68<p>
53</p> 69</p>
54<hr /> 70<hr />
55<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
72<p>Everytime a terminal object gets created, extension scripts specified via
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>
76<p>Each script will only ever be loaded once, even in rxvtd, where
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
236the moment, it reacts to clicking shift-left mouse button by trying to
237move the text cursor to this position. It does so by generating as many
238cursor-left or cursor-right keypresses as required (the this only works
239for programs that correctly support wide characters).
240</dd>
241<dd>
242<p>To avoid too many false positives, this is only done when:</p>
243</dd>
244<dl>
245<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
246</dt>
247<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
248</dt>
249<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
250</dt>
251<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
252</dt>
253</dl>
254<p>The normal selection mechanism isn't disabled, so quick successive clicks
255might interfere with selection creation in harmless ways.</p>
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>
470<p>
471</p>
472<h2><a name="general_api_considerations">General API Considerations</a></h2>
473<p>All objects (such as terminals, time watchers etc.) are typical
474reference-to-hash objects. The hash can be used to store anything you
475like. All members starting with an underscore (such as <code>_ptr</code> or
476<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
477modified).</p>
478<p>When objects are destroyed on the C++ side, the perl object hashes are
479emptied, so its best to store related objects such as time watchers and
480the like inside the terminal object so they get destroyed as soon as the
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>
56<p> 541<p>
57</p> 542</p>
58<h2><a name="hooks">Hooks</a></h2> 543<h2><a name="hooks">Hooks</a></h2>
59<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
60whenever the relevant event happens.</p> 545called whenever the relevant event happens.</p>
61<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
62counts 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
63and 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>
64<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>
65<dl> 552<dl>
66<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 />
67</dt> 554</dt>
68<dd> 555<dd>
69Called after a new terminal object has been initialized, but before 556Called after a new terminal object has been initialized, but before
70windows 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).
71</dd> 576</dd>
72<p></p> 577<p></p>
73<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 />
74</dt> 579</dt>
75<dd> 580<dd>
76Called 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
77control 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
78variables. 583variables.
79</dd> 584</dd>
80<p></p> 585<p></p>
81<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 />
82</dt> 587</dt>
588<dd>
589Called just after the child process has been <code>fork</code>ed.
83<dd> 590</dd>
84Called at the very end of initialisation of a new terminal, just before 591<p></p>
85returning 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>.
86</dd> 597</dd>
87<p></p> 598<p></p>
88<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 />
89</dt> 600</dt>
90<dd> 601<dd>
… …
106</dd> 617</dd>
107<dd> 618<dd>
108<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>
109</dd> 620</dd>
110<p></p> 621<p></p>
111<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 />
112</dt> 623</dt>
113<dd>
114Called whenever the window gets the keyboard focus, before urxvt does
115focus in processing.
116</dd> 624<dd>
117<p></p> 625Called whenever the user tries to extend the selection (e.g. with a double
118<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
119</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.
120<dd> 631</dd>
121Called wheneever the window loses keyboard focus, before urxvt does focus 632<dd>
122out processing. 633<p>See the <em>selection</em> example extension.</p>
123</dd> 634</dd>
124<p></p> 635<p></p>
125<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 />
126</dt> 637</dt>
127<dd> 638<dd>
… …
141<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,
142$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
143number of lines that will be in the scrollback buffer.</p> 654number of lines that will be in the scrollback buffer.</p>
144</dd> 655</dd>
145<p></p> 656<p></p>
146<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 />
147</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.
148<dd> 666</dd>
149Called 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>
150</dd> 706</dd>
151<p></p> 707<p></p>
152<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 />
153</dt> 709</dt>
154<dd> 710<dd>
… …
161<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 />
162</dt> 718</dt>
163<dd> 719<dd>
164Called 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>.
165</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_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong><br />
736</dt>
737<dd>
738Called just after the new window size has been calculcated, but before
739windows are actually being resized or hints are being set. If this hook
740returns TRUE, setting of the window hints is being skipped.
741</dd>
742<p></p>
743<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
744</dt>
745<dd>
746Called on every X event received on the vt window (and possibly other
747windows). Should only be used as a last resort. Most event structure
748members are not passed.
749</dd>
750<p></p>
751<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
752</dt>
753<dd>
754Called whenever the window gets the keyboard focus, before rxvt-unicode
755does focus in processing.
756</dd>
757<p></p>
758<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
759</dt>
760<dd>
761Called wheneever the window loses keyboard focus, before rxvt-unicode does
762focus out processing.
763</dd>
764<p></p>
765<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
766</dt>
767<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
768</dt>
769<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
770</dt>
771<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
772</dt>
773<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
774</dt>
775<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
776</dt>
777<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
778</dt>
779<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
780</dt>
781<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
782</dt>
783<dd>
784Called whenever the corresponding X event is received for the terminal If
785the hook returns true, then the even will be ignored by rxvt-unicode.
786</dd>
787<dd>
788<p>The event is a hash with most values as named by Xlib (see the XEvent
789manpage), with the additional members <code>row</code> and <code>col</code>, which are the
790(real, not screen-based) row and column under the mouse cursor.</p>
791</dd>
792<dd>
793<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
794output, if any, in locale-specific encoding.</p>
795</dd>
796<dd>
797<p>subwindow.</p>
798</dd>
799<p></p>
800<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
801</dt>
802<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
803</dt>
804<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
805</dt>
806<dd>
807Called when various types of ClientMessage events are received (all with
808format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
809</dd>
810<p></p></dl>
811<p>
812</p>
813<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
814<dl>
815<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
816</dt>
817<dd>
818The rxvt-unicode library directory, where, among other things, the perl
819modules and scripts are stored.
820</dd>
821<p></p>
822<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
823</dt>
824<dd>
825The resource class and name rxvt-unicode uses to look up X resources.
826</dd>
827<p></p>
828<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
829</dt>
830<dd>
831The basename of the installed binaries, usually <code>urxvt</code>.
832</dd>
833<p></p>
834<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
835</dt>
836<dd>
837The current terminal. This variable stores the current <code>urxvt::term</code>
838object, whenever a callback/hook is executing.
839</dd>
840<p></p>
841<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
842</dt>
843<dd>
844All coderefs in this array will be called as methods of the next newly
845created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
846gets cleared before the codereferences that were in it are being executed,
847so coderefs can push themselves onto it again if they so desire.
848</dd>
849<dd>
850<p>This complements to the perl-eval commandline option, but gets executed
851first.</p>
852</dd>
853<p></p>
854<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
855</dt>
856<dd>
857Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
858get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
859but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
860</dd>
166<p></p></dl> 861<p></p></dl>
167<p> 862<p>
168</p> 863</p>
169<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 864<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
170<dl> 865<dl>
… …
177</dd> 872</dd>
178<p></p> 873<p></p>
179<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> 874<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
180</dt> 875</dt>
181<dd> 876<dd>
182Calls <code>rxvt_warn</code> witht eh given string which should not include a 877Calls <code>rxvt_warn</code> with the given string which should not include a
183newline. The module also overwrites the <code>warn</code> builtin with a function 878newline. The module also overwrites the <code>warn</code> builtin with a function
184that calls this function. 879that calls this function.
185</dd> 880</dd>
186<dd> 881<dd>
187<p>Using this function has the advantage that its output ends up in the 882<p>Using this function has the advantage that its output ends up in the
188correct place, e.g. on stderr of the connecting urxvtc client.</p> 883correct place, e.g. on stderr of the connecting urxvtc client.</p>
189</dd> 884</dd>
885<dd>
886<p>Messages have a size limit of 1023 bytes currently.</p>
887</dd>
190<p></p> 888<p></p>
191<dt><strong><a name="item__24cellwidth__3d_urxvt_3a_3awcswidth__24string">$cellwidth = urxvt::wcswidth $string</a></strong><br /> 889<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
890</dt>
891<dd>
892Returns all urxvt::term objects that exist in this process, regardless of
893wether they are started, being destroyed etc., so be careful. Only term
894objects that have perl extensions attached will be returned (because there
895is no urxvt::term objet associated with others).
896</dd>
897<p></p>
898<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
899</dt>
900<dd>
901Returns the ``current time'' (as per the event loop).
902</dd>
903<p></p>
904<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
905</dt>
906<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
907Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
908Button4Mask, Button5Mask, AnyModifier</a></strong><br />
909</dt>
910<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
911ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
912PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
913Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
914KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
915ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
916FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
917</dt>
918<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
919EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
920GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
921UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
922ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
923CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
924SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
925</dt>
926<dd>
927Various constants for use in X calls and event processing.
928</dd>
929<p></p></dl>
930<p>
931</p>
932<h2><a name="rendition">RENDITION</a></h2>
933<p>Rendition bitsets contain information about colour, font, font styles and
934similar information for each screen cell.</p>
935<p>The following ``macros'' deal with changes in rendition sets. You should
936never just create a bitset, you should always modify an existing one,
937as they contain important information required for correct operation of
938rxvt-unicode.</p>
939<dl>
940<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
941</dt>
942<dd>
943Returns the default rendition, as used when the terminal is starting up or
944being reset. Useful as a base to start when creating renditions.
945</dd>
946<p></p>
947<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
948</dt>
949<dd>
950Return the rendition mask used for overlays by default.
951</dd>
952<p></p>
953<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
954</dt>
955<dd>
956Return the bit that enabled bold, italic, blink, reverse-video and
957underline, respectively. To enable such a style, just logically OR it into
958the bitset.
959</dd>
960<p></p>
961<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
962</dt>
963<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
964</dt>
965<dd>
966Return the foreground/background colour index, respectively.
967</dd>
968<p></p>
969<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
970</dt>
971<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
972</dt>
973<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
974</dt>
975<dd>
976Replace the foreground/background colour in the rendition mask with the
977specified one.
978</dd>
979<p></p>
980<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
981</dt>
982<dd>
983Return the ``custom'' value: Every rendition has 5 bits for use by
984extensions. They can be set and changed as you like and are initially
985zero.
986</dd>
987<p></p>
988<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
989</dt>
990<dd>
991Change the custom value.
992</dd>
993<p></p></dl>
994<p>
995</p>
996<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
997<p>The sole purpose of this class is to deliver an interface to the
998<code>AnyEvent</code> module - any module using it will work inside urxvt without
999further programming. The only exception is that you cannot wait on
1000condition variables, but non-blocking condvar use is ok. What this means
1001is that you cannot use blocking APIs, but the non-blocking variant should
1002work.</p>
1003<p>
1004</p>
1005<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
1006<dl>
1007<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
1008</dt>
1009<dd>
1010Creates a new terminal, very similar as if you had started it with system
1011<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
1012hash which defines the environment of the new terminal.
1013</dd>
1014<dd>
1015<p>Croaks (and probably outputs an error message) if the new instance
1016couldn't be created. Returns <code>undef</code> if the new instance didn't
1017initialise perl, and the terminal object otherwise. The <code>init</code> and
1018<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
1019refer to global data (which is race free).</p>
1020</dd>
1021<p></p>
1022<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
1023</dt>
1024<dd>
1025Destroy the terminal object (close the window, free resources
1026etc.). Please note that rxvt will not exit as long as any event
1027watchers (timers, io watchers) are still active.
1028</dd>
1029<p></p>
1030<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
1031</dt>
1032<dd>
1033Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
1034(``starts'') programs in the background. This function takes care of setting
1035the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
1036be preferred over explicit calls to <code>exec</code> or <code>system</code>.
1037</dd>
1038<dd>
1039<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
1040</dd>
1041<p></p>
1042<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
1043</dt>
1044<dd>
1045Returns true if the option specified by <code>$optval</code> is enabled, and
1046optionally change it. All option values are stored by name in the hash
1047<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
1048</dd>
1049<dd>
1050<p>Here is a a likely non-exhaustive list of option names, please see the
1051source file <em>/src/optinc.h</em> to see the actual list:</p>
1052</dd>
1053<dd>
1054<pre>
1055 borderLess console cursorBlink cursorUnderline hold iconic insecure
1056 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1057 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1058 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1059 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1060 transparent tripleclickwords utmpInhibit visualBell</pre>
1061</dd>
1062<p></p>
1063<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
1064</dt>
1065<dd>
1066Returns the current resource value associated with a given name and
1067optionally sets a new value. Setting values is most useful in the <code>init</code>
1068hook. Unset resources are returned and accepted as <code>undef</code>.
1069</dd>
1070<dd>
1071<p>The new value must be properly encoded to a suitable character encoding
1072before passing it to this method. Similarly, the returned value may need
1073to be converted from the used encoding to text.</p>
1074</dd>
1075<dd>
1076<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
1077as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
1078likely change).</p>
1079</dd>
1080<dd>
1081<p>Please note that resource strings will currently only be freed when the
1082terminal is destroyed, so changing options frequently will eat memory.</p>
1083</dd>
1084<dd>
1085<p>Here is a a likely non-exhaustive list of resource names, not all of which
1086are supported in every build, please see the source file <em>/src/rsinc.h</em>
1087to see the actual list:</p>
1088</dd>
1089<dd>
1090<pre>
1091 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1092 borderLess color cursorBlink cursorUnderline cutchars delete_key
1093 display_name embed ext_bwidth fade font geometry hold iconName
1094 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1095 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1096 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1097 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1098 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1099 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1100 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1101 secondaryScreen secondaryScroll selectstyle shade term_name title
1102 transient_for transparent transparent_all tripleclickwords utmpInhibit
1103 visualBell</pre>
1104</dd>
1105<p></p>
1106<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1107</dt>
1108<dd>
1109Returns the X-Resource for the given pattern, excluding the program or
1110class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
1111same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1112resource with that pattern exists.
1113</dd>
1114<dd>
1115<p>This method should only be called during the <code>on_start</code> hook, as there is
1116only one resource database per display, and later invocations might return
1117the wrong resources.</p>
1118</dd>
1119<p></p>
1120<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1121</dt>
1122<dd>
1123Adds a keymap translation exactly as specified via a resource. See the
1124<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
1125</dd>
1126<p></p>
1127<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1128</dt>
1129<dd>
1130Return and optionally change the current rendition. Text that is output by
1131the terminal application will use this style.
1132</dd>
1133<p></p>
1134<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1135</dt>
1136<dd>
1137Return the current coordinates of the text cursor position and optionally
1138set it (which is usually bad as applications don't expect that).
1139</dd>
1140<p></p>
1141<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
1142</dt>
1143<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
1144</dt>
1145<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
1146</dt>
1147<dd>
1148Return the current values of the selection mark, begin or end positions,
1149and optionally set them to new values.
1150</dd>
1151<p></p>
1152<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1153</dt>
1154<dd>
1155Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1156<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1157rectangular selection will be made. This is the prefered function to make
1158a selection.
1159</dd>
1160<p></p>
1161<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
1162</dt>
1163<dd>
1164Try to request the primary selection text from the server (for example, as
1165set by the next method). No visual feedback will be given. This function
1166is mostly useful from within <code>on_sel_grab</code> hooks.
1167</dd>
1168<p></p>
1169<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
1170</dt>
1171<dd>
1172Return the current selection text and optionally replace it by <code>$newtext</code>.
1173</dd>
1174<p></p>
1175<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1176</dt>
1177<dd>
1178Create a simple multi-line overlay box. See the next method for details.
1179</dd>
1180<p></p>
1181<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
1182</dt>
1183<dd>
1184Create a new (empty) overlay at the given position with the given
1185width/height. <code>$rstyle</code> defines the initial rendition style
1186(default: <code>OVERLAY_RSTYLE</code>).
1187</dd>
1188<dd>
1189<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
1190around the box.</p>
1191</dd>
1192<dd>
1193<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
1194right/bottom side, respectively.</p>
1195</dd>
1196<dd>
1197<p>This method returns an urxvt::overlay object. The overlay will be visible
1198as long as the perl object is referenced.</p>
1199</dd>
1200<dd>
1201<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
1202</dd>
1203<dl>
1204<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
1205</dt>
1206<dd>
1207Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
1208text in rxvt-unicode's special encoding and an array of rendition values
1209at a specific position inside the overlay.
1210</dd>
1211<p></p>
1212<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
1213</dt>
1214<dd>
1215If visible, hide the overlay, but do not destroy it.
1216</dd>
1217<p></p>
1218<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
1219</dt>
1220<dd>
1221If hidden, display the overlay again.
1222</dd>
1223<p></p></dl>
1224<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1225</dt>
1226<dd>
1227Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1228<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1229currently).
1230</dd>
1231<p></p>
1232<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
192</dt> 1233</dt>
193<dd> 1234<dd>
194Returns the number of screen-cells this string would need. Correctly 1235Returns the number of screen-cells this string would need. Correctly
195accounts for wide and combining characters. 1236accounts for wide and combining characters.
196</dd> 1237</dd>
197<p></p> 1238<p></p>
198<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 1239<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
199</dt> 1240</dt>
1241<dd>
1242Convert the given text string into the corresponding locale encoding.
200<dd> 1243</dd>
201Returns the ``current time'' (as per the event loop). 1244<p></p>
1245<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
1246</dt>
1247<dd>
1248Convert the given locale-encoded octets into a perl string.
1249</dd>
1250<p></p>
1251<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
1252</dt>
1253<dd>
1254XORs the rendition values in the given span with the provided value
1255(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1256refresh hooks to provide effects similar to the selection.
1257</dd>
1258<p></p>
1259<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
1260</dt>
1261<dd>
1262Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1263whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1264to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1265it instead. Both styles <em>MUST NOT</em> contain font styles.
1266</dd>
1267<p></p>
1268<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1269</dt>
1270<dd>
1271Ring the bell!
1272</dd>
1273<p></p>
1274<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1275</dt>
1276<dd>
1277Write the given text string to the screen, as if output by the application
1278running inside the terminal. It may not contain command sequences (escape
1279codes), but is free to use line feeds, carriage returns and tabs. The
1280string is a normal text string, not in locale-dependent encoding.
1281</dd>
1282<dd>
1283<p>Normally its not a good idea to use this function, as programs might be
1284confused by changes in cursor position or scrolling. Its useful inside a
1285<code>on_add_lines</code> hook, though.</p>
1286</dd>
1287<p></p>
1288<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1289</dt>
1290<dd>
1291Switch to given screen - 0 primary, 1 secondary.
1292</dd>
1293<p></p>
1294<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1295</dt>
1296<dd>
1297Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1298locale-specific encoding of the terminal and can contain command sequences
1299(escape codes) that will be interpreted.
1300</dd>
1301<p></p>
1302<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
1303</dt>
1304<dd>
1305Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
1306pass characters instead of octets, you should convert your strings first
1307to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
1308</dd>
1309<p></p>
1310<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1311</dt>
1312<dd>
1313Replaces the event mask of the pty watcher by the given event mask. Can
1314be used to suppress input and output handling to the pty/tty. See the
1315description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1316the previous value.
1317</dd>
1318<p></p>
1319<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1320</dt>
1321<dd>
1322Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1323is used.
1324</dd>
1325<p></p>
1326<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1327</dt>
1328<dd>
1329Return the window id of the toplevel window.
1330</dd>
1331<p></p>
1332<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1333</dt>
1334<dd>
1335Return the window id of the terminal window.
1336</dd>
1337<p></p>
1338<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1339</dt>
1340<dd>
1341Adds the specified events to the vt event mask. Useful e.g. when you want
1342to receive pointer events all the times:
1343</dd>
1344<dd>
1345<pre>
1346 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1347</dd>
1348<p></p>
1349<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1350</dt>
1351<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1352</dt>
1353<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1354</dt>
1355<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1356</dt>
1357<dd>
1358Deliver various fake events to to terminal.
1359</dd>
1360<p></p>
1361<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1362</dt>
1363<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1364</dt>
1365<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1366</dt>
1367<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1368</dt>
1369<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1370</dt>
1371<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
1372</dt>
1373<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
1374</dt>
1375<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1376</dt>
1377<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1378</dt>
1379<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1380</dt>
1381<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1382</dt>
1383<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1384</dt>
1385<dd>
1386Return various integers describing terminal characteristics.
1387</dd>
1388<p></p>
1389<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1390</dt>
1391<dd>
1392Return the DISPLAY used by rxvt-unicode.
1393</dd>
1394<p></p>
1395<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1396</dt>
1397<dd>
1398Returns the LC_CTYPE category string used by this rxvt-unicode.
1399</dd>
1400<p></p>
1401<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1402</dt>
1403<dd>
1404Returns a copy of the environment in effect for the terminal as a hashref
1405similar to <code>\%ENV</code>.
1406</dd>
1407<p></p>
1408<dt><strong><a name="item_envv">@envv = $term-&gt;envv</a></strong><br />
1409</dt>
1410<dd>
1411Returns the environment as array of strings of the form <code>VAR=VALUE</code>.
1412</dd>
1413<p></p>
1414<dt><strong><a name="item_argv">@argv = $term-&gt;argv</a></strong><br />
1415</dt>
1416<dd>
1417Return the argument vector as this terminal, similar to @ARGV, but
1418includes the program name as first element.
1419</dd>
1420<p></p>
1421<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1422</dt>
1423<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1424</dt>
1425<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1426</dt>
1427<dd>
1428Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1429AltGr), the meta key (often Alt) and the num lock key, if applicable.
1430</dd>
1431<p></p>
1432<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1433</dt>
1434<dd>
1435Returns the currently displayed screen (0 primary, 1 secondary).
1436</dd>
1437<p></p>
1438<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1439</dt>
1440<dd>
1441Returns wether the cursor is currently hidden or not.
1442</dd>
1443<p></p>
1444<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1445</dt>
1446<dd>
1447Returns the row number of the topmost displayed line. Maximum value is
1448<code>0</code>, which displays the normal terminal contents. Lower values scroll
1449this many lines into the scrollback buffer.
1450</dd>
1451<p></p>
1452<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1453</dt>
1454<dd>
1455Requests a screen refresh. At the next opportunity, rxvt-unicode will
1456compare the on-screen display with its stored representation. If they
1457differ, it redraws the differences.
1458</dd>
1459<dd>
1460<p>Used after changing terminal contents to display them.</p>
1461</dd>
1462<p></p>
1463<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1464</dt>
1465<dd>
1466Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1467is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1468terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1469line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1470is requested.
1471</dd>
1472<dd>
1473<p>If <code>$new_text</code> is specified, it will replace characters in the current
1474line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1475to replace only parts of a line. The font index in the rendition will
1476automatically be updated.</p>
1477</dd>
1478<dd>
1479<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1480than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1481characters. Characters with combining characters and other characters that
1482do not fit into the normal tetx encoding will be replaced with characters
1483in the private use area.</p>
1484</dd>
1485<dd>
1486<p>You have to obey this encoding when changing text. The advantage is
1487that <code>substr</code> and similar functions work on screen cells and not on
1488characters.</p>
1489</dd>
1490<dd>
1491<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
1492can be used to convert normal strings into this encoding and vice versa.</p>
1493</dd>
1494<p></p>
1495<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1496</dt>
1497<dd>
1498Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1499bitsets. Rendition bitsets contain information about colour, font, font
1500styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1501</dd>
1502<dd>
1503<p>When setting rendition, the font mask will be ignored.</p>
1504</dd>
1505<dd>
1506<p>See the section on RENDITION, above.</p>
1507</dd>
1508<p></p>
1509<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1510</dt>
1511<dd>
1512Returns the number of screen cells that are in use (``the line
1513length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1514line is joined with the following one.
1515</dd>
1516<p></p>
1517<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1518</dt>
1519<dd>
1520Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1521joined with the following row), which means all characters are in use
1522and it is continued on the next row (and possibly a continuation of the
1523previous row(s)).
1524</dd>
1525<p></p>
1526<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1527</dt>
1528<dd>
1529Create and return a new <code>urxvt::line</code> object that stores information
1530about the logical line that row <code>$row_number</code> is part of. It supports the
1531following methods:
1532</dd>
1533<dl>
1534<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1535</dt>
1536<dd>
1537Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1538</dd>
1539<p></p>
1540<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1541</dt>
1542<dd>
1543Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1544</dd>
1545<p></p>
1546<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1547</dt>
1548<dd>
1549Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1550</dd>
1551<p></p>
1552<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1553</dt>
1554<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1555</dt>
1556<dd>
1557Return the row number of the first/last row of the line, respectively.
1558</dd>
1559<p></p>
1560<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1561</dt>
1562<dd>
1563Returns the character offset of the given row|col pair within the logical
1564line. Works for rows outside the line, too, and returns corresponding
1565offsets outside the string.
1566</dd>
1567<p></p>
1568<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1569</dt>
1570<dd>
1571Translates a string offset into terminal coordinates again.
202</dd> 1572</dd>
203<p></p></dl> 1573<p></p></dl>
204<p> 1574<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1575</dt>
1576<dd>
1577Converts a perl string into the special encoding used by rxvt-unicode,
1578where one character corresponds to one screen cell. See
1579<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1580</dd>
1581<p></p>
1582<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1583</dt>
1584<dd>
1585Converts rxvt-unicodes text reprsentation into a perl string. See
1586<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1587</dd>
1588<p></p>
1589<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1590</dt>
1591<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1592</dt>
1593<dd>
1594Register/unregister a synchronous button grab. See the XGrabButton
1595manpage.
1596</dd>
1597<p></p>
1598<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1599</dt>
1600<dd>
1601Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1602synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1603</dd>
1604<p></p>
1605<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1606</dt>
1607<dd>
1608Calls XAllowEvents with AsyncBoth for the most recent grab.
1609</dd>
1610<p></p>
1611<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1612</dt>
1613<dd>
1614Calls XAllowEvents with SyncBoth for the most recent grab.
1615</dd>
1616<p></p>
1617<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1618</dt>
1619<dd>
1620Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1621recent grab.
1622</dd>
1623<p></p>
1624<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1625</dt>
1626<dd>
1627Calls XUngrab for the most recent grab. Is called automatically on
1628evaluation errors, as it is better to lose the grab in the error case as
1629the session.
1630</dd>
1631<p></p>
1632<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1633</dt>
1634<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1635</dt>
1636<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1637</dt>
1638<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1639</dt>
1640<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1641</dt>
1642<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1643</dt>
1644<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1645</dt>
1646<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1647</dt>
1648<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1649</dt>
1650<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1651</dt>
1652<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1653</dt>
1654<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1655</dt>
1656<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1657</dt>
1658<dd>
1659Various X or X-related functions. The <code>$term</code> object only serves as
1660the source of the display, otherwise those functions map more-or-less
1661directory onto the X functions of the same name.
1662</dd>
1663<p></p></dl>
205</p> 1664<p>
1665</p>
206<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 1666<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
207<dl> 1667<dl>
208<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1668<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
209</dt> 1669</dt>
210<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
211</dt>
212<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
213</dt>
214<dd>
215Return the current values of the selection mark, begin or end positions,
216and optionally set them to new values.
217</dd> 1670<dd>
218<p></p> 1671Adds a non-clickable title to the popup.
219<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
220</dt>
221<dd> 1672</dd>
222Try to request the primary selection from the server (for example, as set 1673<p></p>
223by the next method). 1674<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1675</dt>
224</dd> 1676<dd>
225<p></p> 1677Creates a separator, optionally using the character given as <code>$sepchr</code>.
226<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br />
227</dt>
228<dd> 1678</dd>
229Return the current selection text and optionally replace it by <code>$newtext</code>. 1679<p></p>
1680<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1681</dt>
230</dd> 1682<dd>
231<p></p> 1683Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
232<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 1684selected.
233</dt>
234<dd> 1685</dd>
235Create a simple multi-line overlay box. See the next method for details. 1686<p></p>
1687<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong><br />
1688</dt>
236</dd> 1689<dd>
237<p></p> 1690Adds a toggle/checkbox item to the popup. The callback gets called
238<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 1691whenever it gets toggled, with a boolean indicating its new value as its
239</dt> 1692first argument.
240<dd> 1693</dd>
241Create a new (empty) overlay at the given position with the given 1694<p></p>
242width/height. A border will be put around the box. If either <code>$x</code> or 1695<dt><strong>$popup-&gt;show</strong><br />
243<code>$y</code> is negative, then this is counted from the right/bottom side, 1696</dt>
244respectively.
245</dd> 1697<dd>
246<p></p> 1698Displays the popup (which is initially hidden).
247<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
248</dt>
249<dd>
250Switch the overlay off again.
251</dd>
252<p></p>
253<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br />
254</dt>
255<dd>
256Put a single character (specified numerically) at the given overlay
257position.
258</dd>
259<p></p>
260<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br />
261</dt>
262<dd>
263Write a string at the given position into the overlay.
264</dd> 1699</dd>
265<p></p></dl> 1700<p></p></dl>
266<p> 1701<p>
267</p> 1702</p>
268<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1703<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
269<p>This class implements timer watchers/events. Time is represented as a 1704<p>This class implements timer watchers/events. Time is represented as a
270fractional number of seconds since the epoch. Example:</p> 1705fractional number of seconds since the epoch. Example:</p>
271<pre> 1706<pre>
272 # create a digital clock display in upper right corner 1707 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
273 $term-&gt;{timer} = urxvt::timer 1708 $term-&gt;{timer} = urxvt::timer
274 -&gt;new 1709 -&gt;new
275 -&gt;start (urxvt::NOW) 1710 -&gt;interval (1)
276 -&gt;cb (sub { 1711 -&gt;cb (sub {
277 my ($timer) = @_;
278 my $time = $timer-&gt;at;
279 $timer-&gt;start ($time + 1);
280 $self-&gt;scr_overlay (-1, 0, 1712 $term-&gt;{overlay}-&gt;set (0, 0,
281 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 1713 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
282 });</pre> 1714 });</pre>
283<dl> 1715<dl>
284<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1716<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
285</dt> 1717</dt>
286<dd> 1718<dd>
287Create a new timer object in stopped state. 1719Create a new timer object in started state. It is scheduled to fire
1720immediately.
288</dd> 1721</dd>
289<p></p> 1722<p></p>
290<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1723<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
291</dt> 1724</dt>
292<dd> 1725<dd>
… …
297</dt> 1730</dt>
298<dd> 1731<dd>
299Return the time this watcher will fire next. 1732Return the time this watcher will fire next.
300</dd> 1733</dd>
301<p></p> 1734<p></p>
302<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 1735<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
303</dt> 1736</dt>
304<dd> 1737<dd>
305Set the time the event is generated to $tstamp. 1738Set the time the event is generated to $tstamp.
306</dd> 1739</dd>
307<p></p> 1740<p></p>
1741<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1742</dt>
1743<dd>
1744Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1745stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1746is automatically rescheduled at the given intervals.
1747</dd>
1748<p></p>
308<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1749<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
309</dt> 1750</dt>
310<dd> 1751<dd>
311Start the timer. 1752Start the timer.
312</dd> 1753</dd>
313<p></p> 1754<p></p>
314<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1755<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
315</dt> 1756</dt>
316<dd> 1757<dd>
317Set the event trigger time to <code>$tstamp</code> and start the timer. 1758Set the event trigger time to <code>$tstamp</code> and start the timer.
1759</dd>
1760<p></p>
1761<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1762</dt>
1763<dd>
1764Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
318</dd> 1765</dd>
319<p></p> 1766<p></p>
320<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1767<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
321</dt> 1768</dt>
322<dd> 1769<dd>
… …
330<pre> 1777<pre>
331 $term-&gt;{socket} = ... 1778 $term-&gt;{socket} = ...
332 $term-&gt;{iow} = urxvt::iow 1779 $term-&gt;{iow} = urxvt::iow
333 -&gt;new 1780 -&gt;new
334 -&gt;fd (fileno $term-&gt;{socket}) 1781 -&gt;fd (fileno $term-&gt;{socket})
335 -&gt;events (1) # wait for read data 1782 -&gt;events (urxvt::EVENT_READ)
336 -&gt;start 1783 -&gt;start
337 -&gt;cb (sub { 1784 -&gt;cb (sub {
338 my ($iow, $revents) = @_; 1785 my ($iow, $revents) = @_;
339 # $revents must be 1 here, no need to check 1786 # $revents must be 1 here, no need to check
340 sysread $term-&gt;{socket}, my $buf, 8192 1787 sysread $term-&gt;{socket}, my $buf, 8192
… …
361</dd> 1808</dd>
362<p></p> 1809<p></p>
363<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1810<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
364</dt> 1811</dt>
365<dd> 1812<dd>
366Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1813Set the event mask to watch. The only allowed values are
367data, Bit #1 (value <code>2</code>) enables watching for write data. 1814<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1815together, or <code>urxvt::EVENT_NONE</code>.
368</dd> 1816</dd>
369<p></p> 1817<p></p>
370<dt><strong>$iow = $iow-&gt;start</strong><br /> 1818<dt><strong>$iow = $iow-&gt;start</strong><br />
371</dt> 1819</dt>
372<dd> 1820<dd>
… …
377</dt> 1825</dt>
378<dd> 1826<dd>
379Stop watching for events on the given filehandle. 1827Stop watching for events on the given filehandle.
380</dd> 1828</dd>
381<p></p></dl> 1829<p></p></dl>
1830<p>
1831</p>
1832<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1833<p>This class implements idle watchers, that get called automatically when
1834the process is idle. They should return as fast as possible, after doing
1835some useful work.</p>
1836<dl>
1837<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1838</dt>
1839<dd>
1840Create a new idle watcher object in stopped state.
1841</dd>
1842<p></p>
1843<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1844</dt>
1845<dd>
1846Set the callback to be called when the watcher triggers.
1847</dd>
1848<p></p>
1849<dt><strong>$timer = $timer-&gt;start</strong><br />
1850</dt>
1851<dd>
1852Start the watcher.
1853</dd>
1854<p></p>
1855<dt><strong>$timer = $timer-&gt;stop</strong><br />
1856</dt>
1857<dd>
1858Stop the watcher.
1859</dd>
1860<p></p></dl>
1861<p>
1862</p>
1863<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1864<p>This class implements process watchers. They create an event whenever a
1865process exits, after which they stop automatically.</p>
1866<pre>
1867 my $pid = fork;
1868 ...
1869 $term-&gt;{pw} = urxvt::pw
1870 -&gt;new
1871 -&gt;start ($pid)
1872 -&gt;cb (sub {
1873 my ($pw, $exit_status) = @_;
1874 ...
1875 });</pre>
1876<dl>
1877<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1878</dt>
1879<dd>
1880Create a new process watcher in stopped state.
1881</dd>
1882<p></p>
1883<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1884</dt>
1885<dd>
1886Set the callback to be called when the timer triggers.
1887</dd>
1888<p></p>
1889<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1890</dt>
1891<dd>
1892Tells the wqtcher to start watching for process <code>$pid</code>.
1893</dd>
1894<p></p>
1895<dt><strong>$pw = $pw-&gt;stop</strong><br />
1896</dt>
1897<dd>
1898Stop the watcher.
1899</dd>
1900<p></p></dl>
1901<p>
1902</p>
1903<hr />
1904<h1><a name="environment">ENVIRONMENT</a></h1>
1905<p>
1906</p>
1907<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1908<p>This variable controls the verbosity level of the perl extension. Higher
1909numbers indicate more verbose output.</p>
1910<dl>
1911<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1912</dt>
1913<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1914</dt>
1915<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1916</dt>
1917<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1918</dt>
1919</dl>
382<p> 1920<p>
383</p> 1921</p>
384<hr /> 1922<hr />
385<h1><a name="author">AUTHOR</a></h1> 1923<h1><a name="author">AUTHOR</a></h1>
386<pre> 1924<pre>

Diff Legend

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