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

Diff Legend

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