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.9 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.51 by root, Sat Jun 2 05:23:11 2007 UTC

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

Diff Legend

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