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.15 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.29 by root, Fri Jan 13 12:40:46 2006 UTC

1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 1<!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"> 2<html xmlns="http://www.w3.org/1999/xhtml">
3<head> 3<head>
4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> 4<title>urxvtperl - rxvt-unicode's embedded perl interpreter</title>
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 5<link rev="made" href="mailto:perl-binary@plan9.de" />
6</head> 6</head>
7 7
8<body style="background-color: white"> 8<body style="background-color: white">
9 9
… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <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> 25 <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> 26 <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> 27 <li><a href="#rendition">RENDITION</a></li>
28 <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> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
30 </ul> 33 </ul>
… …
42<hr /> 45<hr />
43<p> 46<p>
44</p> 47</p>
45<hr /> 48<hr />
46<h1><a name="name">NAME</a></h1> 49<h1><a name="name">NAME</a></h1>
47<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 50<p>urxvtperl - rxvt-unicode's embedded perl interpreter</p>
48<p> 51<p>
49</p> 52</p>
50<hr /> 53<hr />
51<h1><a name="synopsis">SYNOPSIS</a></h1> 54<h1><a name="synopsis">SYNOPSIS</a></h1>
52<pre> 55<pre>
… …
55 sub on_sel_grab { 58 sub on_sel_grab {
56 warn &quot;you selected &quot;, $_[0]-&gt;selection; 59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
57 () 60 ()
58 }</pre> 61 }</pre>
59<pre> 62<pre>
60 # start a rxvt using it:</pre> 63 # start a urxvt using it:</pre>
61<pre> 64<pre>
62 rxvt --perl-lib $HOME -pe grab_test</pre> 65 urxvt --perl-lib $HOME -pe grab_test</pre>
63<p> 66<p>
64</p> 67</p>
65<hr /> 68<hr />
66<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
67<p>Everytime a terminal object gets created, extension scripts specified via 70<p>Everytime a terminal object gets created, extension scripts specified via
68the <code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
69<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
70thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
71<p>Each script will only ever be loaded once, even in rxvtd, where 74<p>Each script will only ever be loaded once, even in urxvtd, where
72scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
73<p> 76<p>
74</p> 77</p>
75<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
76<p>This section describes the extensiosn delivered with this version. You can 80<p>This section describes the extensions delivered with this release. You can
77find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/usr/local/lib/urxvt/perl/</em>.</p>
78<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
79<pre> 83<pre>
80 rxvt -pe &lt;extensionname&gt;</pre> 84 urxvt -pe &lt;extensionname&gt;</pre>
81<dl> 85<dl>
82<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
83</dt> 87</dt>
84<dd>
85Intelligent selection. This extension tries to be more intelligent when
86the user extends selections (double-click). Right now, it tries to select
87urls and complete shell-quoted arguments, which is very convenient, too,
88if your <em>ls</em> supports <code>--quoting-style=shell</code>.
89</dd> 88<dd>
89(More) intelligent selection. This extension tries to be more intelligent
90when the user extends selections (double-click and further clicks). Right
91now, it tries to select words, urls and complete shell-quoted
92arguments, which is very convenient, too, if your <em>ls</em> supports
93<code>--quoting-style=shell</code>.
90<dd> 94</dd>
95<dd>
96<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p>
98</dd>
99<dd>
100<p>The selection works by trying to match a number of regexes and displaying
101them in increasing order of length. You can add your own regexes by
102specifying resources of the form:</p>
103</dd>
104<dd>
105<pre>
106 URxvt.selection.pattern-0: perl-regex
107 URxvt.selection.pattern-1: perl-regex
108 ...</pre>
109</dd>
110<dd>
111<p>The index number (0, 1...) must not have any holes, and each regex must
112contain at least one pair of capturing parentheses, which will be used for
113the match. For example, the followign adds a regex that matches everything
114between two vertical bars:</p>
115</dd>
116<dd>
117<pre>
118 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
119</dd>
120<dd>
121<p>You can look at the source of the selection extension to see more
122interesting uses, such as parsing a line from beginning to end.</p>
123</dd>
124<dd>
91<p>It also offers the following bindable event:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
92</dd> 126</dd>
93<dl> 127<dl>
94<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
95</dt> 129</dt>
96<dd> 130<dd>
… …
99<dd> 133<dd>
100<pre> 134<pre>
101 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
102</dd> 136</dd>
103<p></p></dl> 137<p></p></dl>
104<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 138<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
105</dt> 139</dt>
140<dd>
141Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
142runtime.
106<dd> 143</dd>
107Displays a digital clock using the built-in overlay. 144<p></p>
145<dt><strong>selection-popup (enabled by default)</strong><br />
146</dt>
147<dd>
148Binds a popup menu to Ctrl-Button3 that lets you convert the selection
149text into various other formats/action (such as uri unescaping, perl
150evalution, web-browser starting etc.), depending on content.
151</dd>
152<p></p>
153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
154</dt>
155<dd>
156Adds regex search functionality to the scrollback buffer, triggered
157by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
158input/output is suspended and a regex is displayed at the bottom of the
159screen.
160</dd>
161<dd>
162<p>Inputting characters appends them to the regex and continues incremental
163search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
164search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
165bottom. <code>Escape</code> leaves search mode and returns to the point where search
166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167additionally stores the first match in the current line into the primary
168selection.</p>
169</dd>
170<p></p>
171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172</dt>
173<dd>
174This selection allows you to do automatic transforms on a selection
175whenever a selection is made.
176</dd>
177<dd>
178<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
179operator) that modify <code>$_</code> as resources:</p>
180</dd>
181<dd>
182<pre>
183 URxvt.selection-autotransform.0: transform
184 URxvt.selection-autotransform.1: transform
185 ...</pre>
186</dd>
187<dd>
188<p>For example, the following will transform selections of the form
189<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
190$word</code>:</p>
191</dd>
192<dd>
193<pre>
194 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
195</dd>
196<dd>
197<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p>
199</dd>
200<dd>
201<pre>
202 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd>
204<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd>
207<dd>
208<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd>
211<dd>
212<pre>
213 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
214 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre>
215</dd>
216<dd>
217<p>The first line tells the selection code to treat the unchanging part of
218every error message as a selection pattern, and the second line transforms
219the message into vi commands to load the file.</p>
108</dd> 220</dd>
109<p></p> 221<p></p>
110<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
111</dt> 223</dt>
112<dd> 224<dd>
113Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 225Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
226make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument.
114</dd> 229</dd>
115<p></p> 230<p></p>
116<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
117</dt> 232</dt>
118<dd> 233<dd>
119A not very useful example of filtering all text output to the terminal, 234A not very useful example of filtering all text output to the terminal,
120by replacing all line-drawing characters (U+2500 .. U+259F) by a 235by replacing all line-drawing characters (U+2500 .. U+259F) by a
121similar-looking ascii character. 236similar-looking ascii character.
122</dd> 237</dd>
123<p></p> 238<p></p>
239<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
240</dt>
241<dd>
242Displays a digital clock using the built-in overlay.
243</dd>
244<p></p>
124<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 245<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
125</dt> 246</dt>
126<dd> 247<dd>
127Displays a very simple digital clock in the upper right corner of the 248Displays a very simple digital clock in the upper right corner of the
128window. Illustrates overwriting the refresh callbacks to create your own 249window. Illustrates overwriting the refresh callbacks to create your own
129overlays or changes. 250overlays or changes.
130</dd> 251</dd>
131<p></p></dl> 252<p></p></dl>
253<p>
254</p>
255<hr />
256<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
132<p> 257<p>
133</p> 258</p>
134<h2><a name="general_api_considerations">General API Considerations</a></h2> 259<h2><a name="general_api_considerations">General API Considerations</a></h2>
135<p>All objects (such as terminals, time watchers etc.) are typical 260<p>All objects (such as terminals, time watchers etc.) are typical
136reference-to-hash objects. The hash can be used to store anything you 261reference-to-hash objects. The hash can be used to store anything you
… …
146<dl> 271<dl>
147<dt><strong><a name="item__24text">$text</a></strong><br /> 272<dt><strong><a name="item__24text">$text</a></strong><br />
148</dt> 273</dt>
149<dd> 274<dd>
150Rxvt-unicodes special way of encoding text, where one ``unicode'' character 275Rxvt-unicodes special way of encoding text, where one ``unicode'' character
151always represents one screen cell. See <em>row_t</em> for a discussion of this format. 276always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
152</dd> 277</dd>
153<p></p> 278<p></p>
154<dt><strong><a name="item__24string">$string</a></strong><br /> 279<dt><strong><a name="item__24string">$string</a></strong><br />
155</dt> 280</dt>
156<dd> 281<dd>
… …
166locale-specific way. 291locale-specific way.
167</dd> 292</dd>
168<p></p></dl> 293<p></p></dl>
169<p> 294<p>
170</p> 295</p>
296<h2><a name="extension_objects">Extension Objects</a></h2>
297<p>Very perl extension is a perl class. A separate perl object is created
298for each terminal and each extension and passed as the first parameter to
299hooks. So extensions can use their <code>$self</code> object without having to think
300about other extensions, with the exception of methods and members that
301begin with an underscore character <code>_</code>: these are reserved for internal
302use.</p>
303<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
304<code>urxvt::term</code> class on this object.</p>
305<p>It has the following methods and data members:</p>
306<dl>
307<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
308</dt>
309<dd>
310Returns the <code>urxvt::term</code> object associated with this instance of the
311extension. This member <em>must not</em> be changed in any way.
312</dd>
313<p></p>
314<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
315</dt>
316<dd>
317Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
318this extension, replacing any previous hook. This is useful when you want
319to overwrite time-critical hooks only temporarily.
320</dd>
321<p></p>
322<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
323</dt>
324<dd>
325Dynamically disable the given hooks.
326</dd>
327<p></p></dl>
328<p>
329</p>
171<h2><a name="hooks">Hooks</a></h2> 330<h2><a name="hooks">Hooks</a></h2>
172<p>The following subroutines can be declared in extension files, and will be 331<p>The following subroutines can be declared in extension files, and will be
173called whenever the relevant event happens.</p> 332called whenever the relevant event happens.</p>
174<p>The first argument passed to them is an object private to each terminal 333<p>The first argument passed to them is an extension oject as described in
175and extension package. You can call all <code>urxvt::term</code> methods on it, but 334the in the <code>Extension Objects</code> section.</p>
176its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
177object that is shared between all packages is stored in the <code>term</code>
178member. It is, however, blessed intot he package of the extension script,
179so for all practical purposes you can treat an extension script as a class.</p>
180<p>All of them must return a boolean value. If it is true, then the event 335<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
181counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 336event counts as being <em>consumed</em>, and the invocation of other hooks is
182and the relevant action might not be carried out by the C++ code.</p> 337skipped, and the relevant action might not be carried out by the C++ code.</p>
183<p>When in doubt, return a false value (preferably <code>()</code>).</p> 338<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
184<dl> 339<dl>
185<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 340<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
186</dt> 341</dt>
187<dd> 342<dd>
188Called after a new terminal object has been initialized, but before 343Called after a new terminal object has been initialized, but before
… …
234</dt> 389</dt>
235<dd> 390<dd>
236Called whenever the user tries to extend the selection (e.g. with a double 391Called whenever the user tries to extend the selection (e.g. with a double
237click) and is either supposed to return false (normal operation), or 392click) and is either supposed to return false (normal operation), or
238should extend the selection itelf and return true to suppress the built-in 393should extend the selection itelf and return true to suppress the built-in
239processing. 394processing. This can happen multiple times, as long as the callback
395returns true, it will be called on every further click by the user and is
396supposed to enlarge the selection more and more, if possible.
240</dd> 397</dd>
241<dd> 398<dd>
242<p>See the <em>selection</em> example extension.</p> 399<p>See the <em>selection</em> example extension.</p>
243</dd> 400</dd>
244<p></p> 401<p></p>
… …
259</dd> 416</dd>
260<dd> 417<dd>
261<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 418<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
262$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 419$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
263number of lines that will be in the scrollback buffer.</p> 420number of lines that will be in the scrollback buffer.</p>
264</dd>
265<p></p>
266<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
267</dt>
268<dd>
269Called whenever the <code>program(s)</code> running in the urxvt window send output.
270</dd> 421</dd>
271<p></p> 422<p></p>
272<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 423<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
273</dt> 424</dt>
274<dd> 425<dd>
… …
293and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 444and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
294might be very slow, however, as your hook is called for <strong>all</strong> text being 445might be very slow, however, as your hook is called for <strong>all</strong> text being
295output. 446output.
296</dd> 447</dd>
297<p></p> 448<p></p>
449<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
450</dt>
451<dd>
452Called whenever some data is written to the tty/pty and can be used to
453suppress or filter tty input.
454</dd>
455<p></p>
298<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 456<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
299</dt> 457</dt>
300<dd> 458<dd>
301Called whenever a line was updated or changed. Can be used to filter 459Called whenever a line was updated or changed. Can be used to filter
302screen output (e.g. underline urls or other useless stuff). Only lines 460screen output (e.g. underline urls or other useless stuff). Only lines
… …
331<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 489<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
332</dt> 490</dt>
333<dd> 491<dd>
334Called whenever the user presses a key combination that has a 492Called whenever the user presses a key combination that has a
335<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 493<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
336resource in the <code>rxvt(1)</code> manpage). 494resource in the <code>urxvt(1)</code> manpage).
495</dd>
496<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt>
499<dd>
500Called on every X event received on the vt window (and possibly other
501windows). Should only be used as a last resort. Most event structure
502members are not passed.
337</dd> 503</dd>
338<p></p> 504<p></p>
339<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 505<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
340</dt> 506</dt>
341<dd> 507<dd>
… …
348<dd> 514<dd>
349Called wheneever the window loses keyboard focus, before rxvt-unicode does 515Called wheneever the window loses keyboard focus, before rxvt-unicode does
350focus out processing. 516focus out processing.
351</dd> 517</dd>
352<p></p> 518<p></p>
353<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 519<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
354</dt> 520</dt>
355<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 521<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
356</dt> 522</dt>
357<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 523<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
358</dt> 524</dt>
359<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 525<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
360</dt> 526</dt>
… …
383<p></p></dl> 549<p></p></dl>
384<p> 550<p>
385</p> 551</p>
386<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 552<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
387<dl> 553<dl>
554<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
555</dt>
556<dd>
557The rxvt-unicode library directory, where, among other things, the perl
558modules and scripts are stored.
559</dd>
560<p></p>
561<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
562</dt>
563<dd>
564The resource class and name rxvt-unicode uses to look up X resources.
565</dd>
566<p></p>
567<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
568</dt>
569<dd>
570The basename of the installed binaries, usually <code>urxvt</code>.
571</dd>
572<p></p>
388<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 573<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
389</dt> 574</dt>
390<dd> 575<dd>
391The current terminal. This variable stores the current <code>urxvt::term</code> 576The current terminal. This variable stores the current <code>urxvt::term</code>
392object, whenever a callback/hook is executing. 577object, whenever a callback/hook is executing.
… …
394<p></p></dl> 579<p></p></dl>
395<p> 580<p>
396</p> 581</p>
397<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 582<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
398<dl> 583<dl>
399<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
400</dt>
401<dd>
402Creates a new terminal, very similar as if you had started it with
403<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
404if the new instance couldn't be created. Returns <code>undef</code> if the new
405instance didn't initialise perl, and the terminal object otherwise. The
406<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
407</dd>
408<p></p>
409<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 584<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
410</dt> 585</dt>
411<dd> 586<dd>
412Fatally aborts execution with the given error message. Avoid at all 587Fatally aborts execution with the given error message. Avoid at all
413costs! The only time this is acceptable is when the terminal process 588costs! The only time this is acceptable is when the terminal process
… …
423</dd> 598</dd>
424<dd> 599<dd>
425<p>Using this function has the advantage that its output ends up in the 600<p>Using this function has the advantage that its output ends up in the
426correct place, e.g. on stderr of the connecting urxvtc client.</p> 601correct place, e.g. on stderr of the connecting urxvtc client.</p>
427</dd> 602</dd>
603<dd>
604<p>Messages have a size limit of 1023 bytes currently.</p>
605</dd>
606<p></p>
607<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
608</dt>
609<dd>
610Returns true when it is safe to do potentially unsafe things, such as
611evaluating perl code specified by the user. This is true when urxvt was
612started setuid or setgid.
613</dd>
428<p></p> 614<p></p>
429<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 615<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
430</dt> 616</dt>
431<dd> 617<dd>
432Returns the ``current time'' (as per the event loop). 618Returns the ``current time'' (as per the event loop).
… …
436</dt> 622</dt>
437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 623<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 624Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
439Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 625Button4Mask, Button5Mask, AnyModifier</a></strong><br />
440</dt> 626</dt>
627<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
628ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
629PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
630Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
631KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
632ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
633FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
634</dt>
635<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
636EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
637GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
638UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
639ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
640CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
641SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
642</dt>
441<dd> 643<dd>
442Various constants for use in X events. 644Various constants for use in X calls and event processing.
443</dd> 645</dd>
444<p></p></dl> 646<p></p></dl>
445<p> 647<p>
446</p> 648</p>
447<h2><a name="rendition">RENDITION</a></h2> 649<h2><a name="rendition">RENDITION</a></h2>
… …
479</dt> 681</dt>
480<dd> 682<dd>
481Return the foreground/background colour index, respectively. 683Return the foreground/background colour index, respectively.
482</dd> 684</dd>
483<p></p> 685<p></p>
484<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 686<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
485</dt> 687</dt>
486<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 688<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
487</dt> 689</dt>
488<dd> 690<dd>
489Replace the foreground/background colour in the rendition mask with the 691Replace the foreground/background colour in the rendition mask with the
490specified one. 692specified one.
491</dd> 693</dd>
492<p></p> 694<p></p>
493<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 695<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
494</dt> 696</dt>
495<dd> 697<dd>
496Return the ``custom'' value: Every rendition has 5 bits for use by 698Return the ``custom'' value: Every rendition has 5 bits for use by
497extensions. They can be set and changed as you like and are initially 699extensions. They can be set and changed as you like and are initially
498zero. 700zero.
499</dd> 701</dd>
500<p></p> 702<p></p>
501<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 703<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
502</dt> 704</dt>
503<dd> 705<dd>
504Change the custom value. 706Change the custom value.
505</dd> 707</dd>
506<p></p></dl> 708<p></p></dl>
709<p>
710</p>
711<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
712<p>The sole purpose of this class is to deliver an interface to the
713<code>AnyEvent</code> module - any module using it will work inside urxvt without
714further programming. The only exception is that you cannot wait on
715condition variables, but non-blocking condvar use is ok. What this means
716is that you cannot use blocking APIs, but the non-blocking variant should
717work.</p>
507<p> 718<p>
508</p> 719</p>
509<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 720<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
510<dl> 721<dl>
722<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
723</dt>
724<dd>
725Creates a new terminal, very similar as if you had started it with system
726<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
727hash which defines the environment of the new terminal.
728</dd>
729<dd>
730<p>Croaks (and probably outputs an error message) if the new instance
731couldn't be created. Returns <code>undef</code> if the new instance didn't
732initialise perl, and the terminal object otherwise. The <code>init</code> and
733<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
734</dd>
735<p></p>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
512</dt> 737</dt>
513<dd> 738<dd>
514Destroy the terminal object (close the window, free resources etc.). 739Destroy the terminal object (close the window, free resources
740etc.). Please note that urxvt will not exit as long as any event
741watchers (timers, io watchers) are still active.
515</dd> 742</dd>
516<p></p> 743<p></p>
517<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
518</dt> 745</dt>
519<dd> 746<dd>
… …
575 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
576 shade term_name title transparent transparent_all tripleclickwords 803 shade term_name title transparent transparent_all tripleclickwords
577 utmpInhibit visualBell</pre> 804 utmpInhibit visualBell</pre>
578</dd> 805</dd>
579<p></p> 806<p></p>
807<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
808</dt>
809<dd>
810Returns the X-Resource for the given pattern, excluding the program or
811class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
812same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
813resource with that pattern exists.
814</dd>
815<dd>
816<p>This method should only be called during the <code>on_start</code> hook, as there is
817only one resource database per display, and later invocations might return
818the wrong resources.</p>
819</dd>
820<p></p>
821<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
822</dt>
823<dd>
824Adds a keymap translation exactly as specified via a resource. See the
825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage.
826</dd>
827<p></p>
580<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
581</dt> 829</dt>
582<dd> 830<dd>
583Return and optionally change the current rendition. Text that is output by 831Return and optionally change the current rendition. Text that is output by
584the terminal application will use this style. 832the terminal application will use this style.
… …
600<dd> 848<dd>
601Return the current values of the selection mark, begin or end positions, 849Return the current values of the selection mark, begin or end positions,
602and optionally set them to new values. 850and optionally set them to new values.
603</dd> 851</dd>
604<p></p> 852<p></p>
853<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
854</dt>
855<dd>
856Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
857<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
858rectangular selection will be made. This is the prefered function to make
859a selection.
860</dd>
861<p></p>
605<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 862<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
606</dt> 863</dt>
607<dd> 864<dd>
608Try to request the primary selection from the server (for example, as set 865Try to request the primary selection text from the server (for example, as
609by the next method). 866set by the next method). No visual feedback will be given. This function
867is mostly useful from within <code>on_sel_grab</code> hooks.
610</dd> 868</dd>
611<p></p> 869<p></p>
612<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 870<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
613</dt> 871</dt>
614<dd> 872<dd>
615Return the current selection text and optionally replace it by <code>$newtext</code>. 873Return the current selection text and optionally replace it by <code>$newtext</code>.
616</dd> 874</dd>
875<p></p>
876<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
877</dt>
617<dd> 878<dd>
618<p>#=item $term-&gt;overlay ($x, $y, $text)
619#
620#Create a simple multi-line overlay box. See the next method for details. 879Create a simple multi-line overlay box. See the next method for details.
621#
622#=cut
623#
624#sub urxvt::term::scr_overlay {
625# my ($self, $x, $y, $text) = @_;
626#
627# my @lines = split /\n/, $text;
628#
629# my $w = 0;
630# for (map $self-&gt;strwidth ($_), @lines) {
631# $w = $_ if $w &lt; $_;
632# }
633#
634# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
635# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
636#}</p>
637</dd> 880</dd>
638<p></p> 881<p></p>
639<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 882<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
640</dt> 883</dt>
641<dd> 884<dd>
… …
677</dt> 920</dt>
678<dd> 921<dd>
679If hidden, display the overlay again. 922If hidden, display the overlay again.
680</dd> 923</dd>
681<p></p></dl> 924<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br /> 925<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
683</dt> 926</dt>
684<dd> 927<dd>
685Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 928Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
686<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, 929<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
687currently). 930currently).
… …
702<p></p> 945<p></p>
703<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 946<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
704</dt> 947</dt>
705<dd> 948<dd>
706Convert the given locale-encoded octets into a perl string. 949Convert the given locale-encoded octets into a perl string.
950</dd>
951<p></p>
952<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
953</dt>
954<dd>
955XORs the rendition values in the given span with the provided value
956(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
957refresh hooks to provide effects similar to the selection.
958</dd>
959<p></p>
960<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
961</dt>
962<dd>
963Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
964whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
965to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
966it instead. Both styles <em>MUST NOT</em> contain font styles.
967</dd>
968<p></p>
969<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
970</dt>
971<dd>
972Ring the bell!
707</dd> 973</dd>
708<p></p> 974<p></p>
709<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 975<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
710</dt> 976</dt>
711<dd> 977<dd>
… …
734Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1000Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
735pass characters instead of octets, you should convert your strings first 1001pass characters instead of octets, you should convert your strings first
736to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1002to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
737</dd> 1003</dd>
738<p></p> 1004<p></p>
1005<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1006</dt>
1007<dd>
1008Replaces the event mask of the pty watcher by the given event mask. Can
1009be used to suppress input and output handling to the pty/tty. See the
1010description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1011the previous value.
1012</dd>
1013<p></p>
739<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1014<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
740</dt> 1015</dt>
741<dd> 1016<dd>
742Return the window id of the toplevel window. 1017Return the window id of the toplevel window.
743</dd> 1018</dd>
… …
746</dt> 1021</dt>
747<dd> 1022<dd>
748Return the window id of the terminal window. 1023Return the window id of the terminal window.
749</dd> 1024</dd>
750<p></p> 1025<p></p>
1026<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1027</dt>
1028<dd>
1029Adds the specified events to the vt event mask. Useful e.g. when you want
1030to receive pointer events all the times:
1031</dd>
1032<dd>
1033<pre>
1034 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1035</dd>
1036<p></p>
751<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1037<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
752</dt> 1038</dt>
753<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1039<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
754</dt> 1040</dt>
755<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1041<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
772</dt> 1058</dt>
773<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1059<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
774</dt> 1060</dt>
775<dd> 1061<dd>
776Return various integers describing terminal characteristics. 1062Return various integers describing terminal characteristics.
1063</dd>
1064<p></p>
1065<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1066</dt>
1067<dd>
1068Return the DISPLAY used by rxvt-unicode.
1069</dd>
1070<p></p>
1071<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1072</dt>
1073<dd>
1074Returns the LC_CTYPE category string used by this rxvt-unicode.
1075</dd>
1076<p></p>
1077<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1078</dt>
1079<dd>
1080Returns a copy of the environment in effect for the terminal as a hashref
1081similar to <code>\%ENV</code>.
777</dd> 1082</dd>
778<p></p> 1083<p></p>
779<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1084<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
780</dt> 1085</dt>
781<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1086<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
832<p>You have to obey this encoding when changing text. The advantage is 1137<p>You have to obey this encoding when changing text. The advantage is
833that <code>substr</code> and similar functions work on screen cells and not on 1138that <code>substr</code> and similar functions work on screen cells and not on
834characters.</p> 1139characters.</p>
835</dd> 1140</dd>
836<dd> 1141<dd>
837<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1142<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>
838can be used to convert normal strings into this encoding and vice versa.</p> 1143can be used to convert normal strings into this encoding and vice versa.</p>
839</dd> 1144</dd>
840<p></p> 1145<p></p>
841<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1146<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
842</dt> 1147</dt>
… …
905<p></p> 1210<p></p>
906<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1211<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
907</dt> 1212</dt>
908<dd> 1213<dd>
909Returns the character offset of the given row|col pair within the logical 1214Returns the character offset of the given row|col pair within the logical
910line. 1215line. Works for rows outside the line, too, and returns corresponding
1216offsets outside the string.
911</dd> 1217</dd>
912<p></p> 1218<p></p>
913<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1219<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
914</dt> 1220</dt>
915<dd> 1221<dd>
916Translates a string offset into terminal coordinates again. 1222Translates a string offset into terminal coordinates again.
917</dd> 1223</dd>
918<p></p></dl> 1224<p></p></dl>
919<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1225<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
920=item $text = $term-&gt;special_encode $string</strong><br />
921</dt> 1226</dt>
922<dd> 1227<dd>
923Converts a perl string into the special encoding used by rxvt-unicode, 1228Converts a perl string into the special encoding used by rxvt-unicode,
924where one character corresponds to one screen cell. See 1229where one character corresponds to one screen cell. See
925<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1230<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
929</dt> 1234</dt>
930<dd> 1235<dd>
931Converts rxvt-unicodes text reprsentation into a perl string. See 1236Converts rxvt-unicodes text reprsentation into a perl string. See
932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1237<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
933</dd> 1238</dd>
1239<p></p>
1240<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1241</dt>
1242<dd>
1243Registers a synchronous button grab. See the XGrabButton manpage.
1244</dd>
1245<p></p>
1246<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1247</dt>
1248<dd>
1249Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1250synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1251</dd>
1252<p></p>
1253<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1254</dt>
1255<dd>
1256Calls XAllowEvents with AsyncBoth for the most recent grab.
1257</dd>
1258<p></p>
1259<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1260</dt>
1261<dd>
1262Calls XAllowEvents with SyncBoth for the most recent grab.
1263</dd>
1264<p></p>
1265<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1266</dt>
1267<dd>
1268Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1269recent grab.
1270</dd>
1271<p></p>
1272<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1273</dt>
1274<dd>
1275Calls XUngrab for the most recent grab. Is called automatically on
1276evaluation errors, as it is better to lose the grab in the error case as
1277the session.
1278</dd>
934<p></p></dl> 1279<p></p></dl>
935<p> 1280<p>
936</p> 1281</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1282<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1283<dl>
1284<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1285</dt>
1286<dd>
1287Adds a non-clickable title to the popup.
1288</dd>
1289<p></p>
1290<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1291</dt>
1292<dd>
1293Creates a separator, optionally using the character given as <code>$sepchr</code>.
1294</dd>
1295<p></p>
1296<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1297</dt>
1298<dd>
1299Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1300selected.
1301</dd>
1302<p></p>
1303<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1304</dt>
1305<dd>
1306Adds a toggle/checkbox item to the popup. Teh callback gets called
1307whenever it gets toggled, with a boolean indicating its value as its first
1308argument.
1309</dd>
1310<p></p>
1311<dt><strong>$popup-&gt;show</strong><br />
1312</dt>
1313<dd>
1314Displays the popup (which is initially hidden).
1315</dd>
1316<p></p></dl>
938<p> 1317<p>
939</p> 1318</p>
940<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1319<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
941<p>This class implements timer watchers/events. Time is represented as a 1320<p>This class implements timer watchers/events. Time is represented as a
942fractional number of seconds since the epoch. Example:</p> 1321fractional number of seconds since the epoch. Example:</p>
… …
1008<pre> 1387<pre>
1009 $term-&gt;{socket} = ... 1388 $term-&gt;{socket} = ...
1010 $term-&gt;{iow} = urxvt::iow 1389 $term-&gt;{iow} = urxvt::iow
1011 -&gt;new 1390 -&gt;new
1012 -&gt;fd (fileno $term-&gt;{socket}) 1391 -&gt;fd (fileno $term-&gt;{socket})
1013 -&gt;events (1) # wait for read data 1392 -&gt;events (urxvt::EVENT_READ)
1014 -&gt;start 1393 -&gt;start
1015 -&gt;cb (sub { 1394 -&gt;cb (sub {
1016 my ($iow, $revents) = @_; 1395 my ($iow, $revents) = @_;
1017 # $revents must be 1 here, no need to check 1396 # $revents must be 1 here, no need to check
1018 sysread $term-&gt;{socket}, my $buf, 8192 1397 sysread $term-&gt;{socket}, my $buf, 8192
… …
1039</dd> 1418</dd>
1040<p></p> 1419<p></p>
1041<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1420<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1042</dt> 1421</dt>
1043<dd> 1422<dd>
1044Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1423Set the event mask to watch. The only allowed values are
1045data, Bit #1 (value <code>2</code>) enables watching for write data. 1424<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1425together, or <code>urxvt::EVENT_NONE</code>.
1046</dd> 1426</dd>
1047<p></p> 1427<p></p>
1048<dt><strong>$iow = $iow-&gt;start</strong><br /> 1428<dt><strong>$iow = $iow-&gt;start</strong><br />
1049</dt> 1429</dt>
1050<dd> 1430<dd>
… …
1065</p> 1445</p>
1066<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1446<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1067<p>This variable controls the verbosity level of the perl extension. Higher 1447<p>This variable controls the verbosity level of the perl extension. Higher
1068numbers indicate more verbose output.</p> 1448numbers indicate more verbose output.</p>
1069<dl> 1449<dl>
1070<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1450<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1071</dt> 1451</dt>
1072<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1452<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1073</dt> 1453</dt>
1074<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1454<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1455</dt>
1456<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1075</dt> 1457</dt>
1076</dl> 1458</dl>
1077<p> 1459<p>
1078</p> 1460</p>
1079<hr /> 1461<hr />

Diff Legend

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