ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.9 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.30 by root, Mon Jan 16 06:37:51 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#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>
30 <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> 31 <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> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29 </ul> 33 </ul>
30 34
31 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 66<p>
63</p> 67</p>
64<hr /> 68<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 71the <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 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
70<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 rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
72<p> 76<p>
73</p> 77</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
75<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
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
78<pre> 83<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 85<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 87</dt>
83<dd>
84Intelligent selection. This etxension tries to be more intelligent when the user
85extends selections (double-click).
86</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>.
87<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>
88<p>It also offers the following bindable event:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
89</dd> 126</dd>
90<dl> 127<dl>
91<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
92</dt> 129</dt>
93<dd> 130<dd>
… …
96<dd> 133<dd>
97<pre> 134<pre>
98 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
99</dd> 136</dd>
100<p></p></dl> 137<p></p></dl>
138<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
139</dt>
140<dd>
141Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
142runtime.
143</dd>
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>
220</dd>
221<p></p>
222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
223</dt>
224<dd>
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.
229</dd>
230<p></p>
231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
232</dt>
233<dd>
234A not very useful example of filtering all text output to the terminal,
235by replacing all line-drawing characters (U+2500 .. U+259F) by a
236similar-looking ascii character.
237</dd>
238<p></p>
101<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 239<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
102</dt> 240</dt>
103<dd> 241<dd>
104Displays a digital clock using the built-in overlay. 242Displays a digital clock using the built-in overlay.
105</dd> 243</dd>
… …
110Displays 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
111window. Illustrates overwriting the refresh callbacks to create your own 249window. Illustrates overwriting the refresh callbacks to create your own
112overlays or changes. 250overlays or changes.
113</dd> 251</dd>
114<p></p></dl> 252<p></p></dl>
253<p>
254</p>
255<hr />
256<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
115<p> 257<p>
116</p> 258</p>
117<h2><a name="general_api_considerations">General API Considerations</a></h2> 259<h2><a name="general_api_considerations">General API Considerations</a></h2>
118<p>All objects (such as terminals, time watchers etc.) are typical 260<p>All objects (such as terminals, time watchers etc.) are typical
119reference-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
… …
122modified).</p> 264modified).</p>
123<p>When objects are destroyed on the C++ side, the perl object hashes are 265<p>When objects are destroyed on the C++ side, the perl object hashes are
124emptied, so its best to store related objects such as time watchers and 266emptied, so its best to store related objects such as time watchers and
125the like inside the terminal object so they get destroyed as soon as the 267the like inside the terminal object so they get destroyed as soon as the
126terminal is destroyed.</p> 268terminal is destroyed.</p>
269<p>Argument names also often indicate the type of a parameter. Here are some
270hints on what they mean:</p>
271<dl>
272<dt><strong><a name="item__24text">$text</a></strong><br />
273</dt>
274<dd>
275Rxvt-unicodes special way of encoding text, where one ``unicode'' character
276always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
277</dd>
278<p></p>
279<dt><strong><a name="item__24string">$string</a></strong><br />
280</dt>
281<dd>
282A perl text string, with an emphasis on <em>text</em>. It can store all unicode
283characters and is to be distinguished with text encoded in a specific
284encoding (often locale-specific) and binary data.
285</dd>
286<p></p>
287<dt><strong><a name="item__24octets">$octets</a></strong><br />
288</dt>
289<dd>
290Either binary data or - more common - a text string encoded in a
291locale-specific way.
292</dd>
293<p></p></dl>
294<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>
127<p> 328<p>
128</p> 329</p>
129<h2><a name="hooks">Hooks</a></h2> 330<h2><a name="hooks">Hooks</a></h2>
130<p>The following subroutines can be declared in loaded scripts, and will be 331<p>The following subroutines can be declared in extension files, and will be
131called whenever the relevant event happens.</p> 332called whenever the relevant event happens.</p>
132<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
133and extension package. You can call all <code>urxvt::term</code> methods on it, but 334the in the <code>Extension Objects</code> section.</p>
134its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
135object that is shared between all packages is stored in the <code>term</code>
136member.</p>
137<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
138counts 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
139and 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>
140<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>
141<dl> 339<dl>
142<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 />
143</dt> 341</dt>
144<dd> 342<dd>
145Called after a new terminal object has been initialized, but before 343Called after a new terminal object has been initialized, but before
146windows are created or the command gets run. 344windows are created or the command gets run. Most methods are unsafe to
345call or deliver senseless data, as terminal size and other characteristics
346have not yet been determined. You can safely query and change resources,
347though.
147</dd> 348</dd>
148<p></p> 349<p></p>
149<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 350<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
150</dt> 351</dt>
151<dd> 352<dd>
… …
188</dt> 389</dt>
189<dd> 390<dd>
190Called 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
191click) and is either supposed to return false (normal operation), or 392click) and is either supposed to return false (normal operation), or
192should 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
193processing. 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.
194</dd> 397</dd>
195<dd> 398<dd>
196<p>See the <em>selection</em> example extension.</p> 399<p>See the <em>selection</em> example extension.</p>
197</dd>
198<p></p>
199<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
200</dt>
201<dd>
202Called whenever the window gets the keyboard focus, before urxvt does
203focus in processing.
204</dd>
205<p></p>
206<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
207</dt>
208<dd>
209Called wheneever the window loses keyboard focus, before urxvt does focus
210out processing.
211</dd> 400</dd>
212<p></p> 401<p></p>
213<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 402<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
214</dt> 403</dt>
215<dd> 404<dd>
… …
229<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,
230$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
231number of lines that will be in the scrollback buffer.</p> 420number of lines that will be in the scrollback buffer.</p>
232</dd> 421</dd>
233<p></p> 422<p></p>
234<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 423<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
235</dt> 424</dt>
425<dd>
426Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
427operating system command) is processed. Cursor position and other state
428information is up-to-date when this happens. For interoperability, the
429string should start with the extension name and a colon, to distinguish
430it from commands for other extensions, and this might be enforced in the
431future.
236<dd> 432</dd>
237Called whenever the <code>program(s)</code> running in the urxvt window send output. 433<dd>
434<p>Be careful not ever to trust (in a security sense) the data you receive,
435as its source can not easily be controleld (e-mail content, messages from
436other users on the same system etc.).</p>
437</dd>
438<p></p>
439<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
440</dt>
441<dd>
442Called whenever text is about to be output, with the text as argument. You
443can filter/change and output the text yourself by returning a true value
444and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
445might be very slow, however, as your hook is called for <strong>all</strong> text being
446output.
447</dd>
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>
456<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
457</dt>
458<dd>
459Called whenever a line was updated or changed. Can be used to filter
460screen output (e.g. underline urls or other useless stuff). Only lines
461that are being shown will be filtered, and, due to performance reasons,
462not always immediately.
463</dd>
464<dd>
465<p>The row number is always the topmost row of the line if the line spans
466multiple rows.</p>
467</dd>
468<dd>
469<p>Please note that, if you change the line, then the hook might get called
470later with the already-modified line (e.g. if unrelated parts change), so
471you cannot just toggle rendition bits, but only set them.</p>
238</dd> 472</dd>
239<p></p> 473<p></p>
240<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 474<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
241</dt> 475</dt>
242<dd> 476<dd>
… …
257<dd> 491<dd>
258Called whenever the user presses a key combination that has a 492Called whenever the user presses a key combination that has a
259<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>
260resource in the <code>rxvt(1)</code> manpage). 494resource in the <code>rxvt(1)</code> manpage).
261</dd> 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.
503</dd>
504<p></p>
505<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
506</dt>
507<dd>
508Called whenever the window gets the keyboard focus, before rxvt-unicode
509does focus in processing.
510</dd>
511<p></p>
512<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
513</dt>
514<dd>
515Called wheneever the window loses keyboard focus, before rxvt-unicode does
516focus out processing.
517</dd>
518<p></p>
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 />
520</dt>
521<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
522</dt>
523<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
524</dt>
525<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
526</dt>
527<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
528</dt>
529<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
530</dt>
531<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
532</dt>
533<dd>
534Called whenever the corresponding X event is received for the terminal If
535the hook returns true, then the even will be ignored by rxvt-unicode.
536</dd>
537<dd>
538<p>The event is a hash with most values as named by Xlib (see the XEvent
539manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
540and column under the mouse cursor.</p>
541</dd>
542<dd>
543<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
544output, if any, in locale-specific encoding.</p>
545</dd>
546<dd>
547<p>subwindow.</p>
548</dd>
262<p></p></dl> 549<p></p></dl>
263<p> 550<p>
264</p> 551</p>
265<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>
266<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>
267<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 />
268</dt> 574</dt>
269<dd> 575<dd>
270The current terminal. Whenever a callback/Hook is bein executed, this 576The current terminal. This variable stores the current <code>urxvt::term</code>
271variable stores the current <code>urxvt::term</code> object. 577object, whenever a callback/hook is executing.
272</dd> 578</dd>
273<p></p></dl> 579<p></p></dl>
274<p> 580<p>
275</p> 581</p>
276<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>
… …
292</dd> 598</dd>
293<dd> 599<dd>
294<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
295correct place, e.g. on stderr of the connecting urxvtc client.</p> 601correct place, e.g. on stderr of the connecting urxvtc client.</p>
296</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>
297<p></p> 614<p></p>
298<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 />
299</dt> 616</dt>
300<dd> 617<dd>
301Returns the ``current time'' (as per the event loop). 618Returns the ``current time'' (as per the event loop).
619</dd>
620<p></p>
621<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
622</dt>
623<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
624Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
625Button4Mask, Button5Mask, AnyModifier</a></strong><br />
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>
643<dd>
644Various constants for use in X calls and event processing.
302</dd> 645</dd>
303<p></p></dl> 646<p></p></dl>
304<p> 647<p>
305</p> 648</p>
306<h2><a name="rendition">RENDITION</a></h2> 649<h2><a name="rendition">RENDITION</a></h2>
… …
338</dt> 681</dt>
339<dd> 682<dd>
340Return the foreground/background colour index, respectively. 683Return the foreground/background colour index, respectively.
341</dd> 684</dd>
342<p></p> 685<p></p>
343<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 />
344</dt> 687</dt>
345<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 />
346</dt> 689</dt>
347<dd> 690<dd>
348Replace the foreground/background colour in the rendition mask with the 691Replace the foreground/background colour in the rendition mask with the
349specified one. 692specified one.
350</dd> 693</dd>
351<p></p> 694<p></p>
352<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 />
353</dt> 696</dt>
354<dd> 697<dd>
355Return the ``custom'' value: Every rendition has 5 bits for use by 698Return the ``custom'' value: Every rendition has 5 bits for use by
356extensions. 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
357zero. 700zero.
358</dd> 701</dd>
359<p></p> 702<p></p>
360<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 />
361</dt> 704</dt>
362<dd> 705<dd>
363Change the custom value. 706Change the custom value.
364</dd> 707</dd>
365<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>
366<p> 718<p>
367</p> 719</p>
368<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>
369<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>
736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
737</dt>
738<dd>
739Destroy the terminal object (close the window, free resources
740etc.). Please note that rxvt will not exit as long as any event
741watchers (timers, io watchers) are still active.
742</dd>
743<p></p>
744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
745</dt>
746<dd>
747Returns true if the option specified by <code>$optval</code> is enabled, and
748optionally change it. All option values are stored by name in the hash
749<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
750</dd>
751<dd>
752<p>Here is a a likely non-exhaustive list of option names, please see the
753source file <em>/src/optinc.h</em> to see the actual list:</p>
754</dd>
755<dd>
756<pre>
757 borderLess console cursorBlink cursorUnderline hold iconic insecure
758 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
759 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
760 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
761 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
762 tripleclickwords utmpInhibit visualBell</pre>
763</dd>
764<p></p>
370<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 765<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
371</dt> 766</dt>
372<dd> 767<dd>
373Returns the current resource value associated with a given name and 768Returns the current resource value associated with a given name and
374optionally sets a new value. Setting values is most useful in the <code>init</code> 769optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
388<p>Please note that resource strings will currently only be freed when the 783<p>Please note that resource strings will currently only be freed when the
389terminal is destroyed, so changing options frequently will eat memory.</p> 784terminal is destroyed, so changing options frequently will eat memory.</p>
390</dd> 785</dd>
391<dd> 786<dd>
392<p>Here is a a likely non-exhaustive list of resource names, not all of which 787<p>Here is a a likely non-exhaustive list of resource names, not all of which
393are supported in every build, please see the source to see the actual 788are supported in every build, please see the source file <em>/src/rsinc.h</em>
394list:</p> 789to see the actual list:</p>
395</dd> 790</dd>
396<dd> 791<dd>
397<pre> 792<pre>
398 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 793 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
399 borderLess color cursorBlink cursorUnderline cutchars delete_key 794 borderLess color cursorBlink cursorUnderline cutchars delete_key
400 display_name embed ext_bwidth fade font geometry hold iconName 795 display_name embed ext_bwidth fade font geometry hold iconName
401 imFont imLocale inputMethod insecure int_bwidth intensityStyles 796 imFont imLocale inputMethod insecure int_bwidth intensityStyles
402 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 797 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
403 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 798 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
404 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 799 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
405 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 800 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
406 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 801 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
407 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
408 shade term_name title transparent transparent_all tripleclickwords 803 shade term_name title transparent transparent_all tripleclickwords
409 utmpInhibit visualBell</pre> 804 utmpInhibit visualBell</pre>
410</dd> 805</dd>
411<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>rxvt(1)</code> manpage.
826</dd>
827<p></p>
828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
829</dt>
830<dd>
831Return and optionally change the current rendition. Text that is output by
832the terminal application will use this style.
833</dd>
834<p></p>
835<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
836</dt>
837<dd>
838Return the current coordinates of the text cursor position and optionally
839set it (which is usually bad as applications don't expect that).
840</dd>
841<p></p>
412<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 842<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
413</dt> 843</dt>
414<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 844<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
415</dt> 845</dt>
416<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 846<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
418<dd> 848<dd>
419Return the current values of the selection mark, begin or end positions, 849Return the current values of the selection mark, begin or end positions,
420and optionally set them to new values. 850and optionally set them to new values.
421</dd> 851</dd>
422<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>
423<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 />
424</dt> 863</dt>
425<dd> 864<dd>
426Try 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
427by 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.
428</dd> 868</dd>
429<p></p> 869<p></p>
430<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 870<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
431</dt> 871</dt>
432<dd> 872<dd>
433Return 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>.
434</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>
435<dd> 878<dd>
436<p>#=item $term-&gt;overlay ($x, $y, $text)
437#
438#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.
439#
440#=cut</p>
441</dd>
442<dd>
443<p>sub urxvt::term::scr_overlay {
444die;
445 my ($self, $x, $y, $text) = @_;</p>
446</dd>
447<dd>
448<pre>
449 my @lines = split /\n/, $text;</pre>
450</dd>
451<dd>
452<pre>
453 my $w = 0;
454 for (map $self-&gt;strwidth ($_), @lines) {
455 $w = $_ if $w &lt; $_;
456 }</pre>
457</dd>
458<dd>
459<pre>
460 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
461 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
462}</pre>
463</dd> 880</dd>
464<p></p> 881<p></p>
465<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 />
466</dt> 883</dt>
467<dd> 884<dd>
… …
503</dt> 920</dt>
504<dd> 921<dd>
505If hidden, display the overlay again. 922If hidden, display the overlay again.
506</dd> 923</dd>
507<p></p></dl> 924<p></p></dl>
925<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
926</dt>
927<dd>
928Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
929<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
930currently).
931</dd>
932<p></p>
508<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 933<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
509</dt> 934</dt>
510<dd> 935<dd>
511Returns the number of screen-cells this string would need. Correctly 936Returns the number of screen-cells this string would need. Correctly
512accounts for wide and combining characters. 937accounts for wide and combining characters.
513</dd> 938</dd>
514<p></p> 939<p></p>
515<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 940<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
516</dt> 941</dt>
517<dd> 942<dd>
518Convert the given text string into the corresponding locale encoding. 943Convert the given text string into the corresponding locale encoding.
519</dd> 944</dd>
520<p></p> 945<p></p>
521<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 />
522</dt> 947</dt>
523<dd> 948<dd>
524Convert 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!
973</dd>
974<p></p>
975<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
976</dt>
977<dd>
978Write the given text string to the screen, as if output by the application
979running inside the terminal. It may not contain command sequences (escape
980codes), but is free to use line feeds, carriage returns and tabs. The
981string is a normal text string, not in locale-dependent encoding.
982</dd>
983<dd>
984<p>Normally its not a good idea to use this function, as programs might be
985confused by changes in cursor position or scrolling. Its useful inside a
986<code>on_add_lines</code> hook, though.</p>
987</dd>
988<p></p>
989<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
990</dt>
991<dd>
992Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
993locale-specific encoding of the terminal and can contain command sequences
994(escape codes) that will be interpreted.
525</dd> 995</dd>
526<p></p> 996<p></p>
527<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 997<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
528</dt> 998</dt>
529<dd> 999<dd>
530Write 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
531pass characters instead of octets, you should convert your strings first 1001pass characters instead of octets, you should convert your strings first
532to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1002to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
533</dd> 1003</dd>
534<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>
1014<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1015</dt>
1016<dd>
1017Return the window id of the toplevel window.
1018</dd>
1019<p></p>
1020<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1021</dt>
1022<dd>
1023Return the window id of the terminal window.
1024</dd>
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>
1037<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1038</dt>
1039<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1040</dt>
1041<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1042</dt>
1043<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1044</dt>
1045<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1046</dt>
535<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 1047<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
536</dt> 1048</dt>
537<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1049<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
538</dt> 1050</dt>
539<dd> 1051<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
540Return the number of rows/columns of the terminal window (i.e. as 1052</dt>
541specified by <code>-geometry</code>, excluding any scrollback). 1053<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1054</dt>
1055<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1056</dt>
1057<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1058</dt>
1059<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1060</dt>
542</dd> 1061<dd>
1062Return various integers describing terminal characteristics.
1063</dd>
543<p></p> 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>
544<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1077<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
545</dt> 1078</dt>
1079<dd>
1080Returns a copy of the environment in effect for the terminal as a hashref
1081similar to <code>\%ENV</code>.
546<dd> 1082</dd>
547Returns the number of lines in the scrollback buffer. 1083<p></p>
1084<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1085</dt>
1086<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1087</dt>
1088<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1089</dt>
1090<dd>
1091Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1092AltGr), the meta key (often Alt) and the num lock key, if applicable.
548</dd> 1093</dd>
549<p></p> 1094<p></p>
550<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1095<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
551</dt> 1096</dt>
552<dd> 1097<dd>
553Returns the negative row number of the topmost line. Minimum value is 1098Returns the row number of the topmost displayed line. Maximum value is
554<code>0</code>, which displays the normal terminal contents. Larger values scroll 1099<code>0</code>, which displays the normal terminal contents. Lower values scroll
555this many lines into the scrollback buffer. 1100this many lines into the scrollback buffer.
556</dd> 1101</dd>
557<p></p> 1102<p></p>
558<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1103<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
559</dt> 1104</dt>
… …
570</dt> 1115</dt>
571<dd> 1116<dd>
572Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1117Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
573is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1118is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
574terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1119terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
575line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1120line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
576is requested. 1121is requested.
577</dd> 1122</dd>
578<dd> 1123<dd>
579<p>If <code>$new_text</code> is specified, it will replace characters in the current 1124<p>If <code>$new_text</code> is specified, it will replace characters in the current
580line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1125line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
581to replace only parts of a line. The font index in the rendition will 1126to replace only parts of a line. The font index in the rendition will
582automatically be updated.</p> 1127automatically be updated.</p>
583</dd> 1128</dd>
584<dd> 1129<dd>
585<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1130<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
586than one cell when displayed are padded with urxvt::NOCHAR characters 1131than one cell when displayed are padded with urxvt::NOCHAR characters
587(<code>chr 65535</code>). Characters with combining characters and other characters 1132(<code>chr 65535</code>). Characters with combining characters and other characters
588that do not fit into the normal tetx encoding will be replaced with 1133that do not fit into the normal tetx encoding will be replaced with
589characters in the private use area.</p> 1134characters in the private use area.</p>
590</dd> 1135</dd>
… …
592<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
593that <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
594characters.</p> 1139characters.</p>
595</dd> 1140</dd>
596<dd> 1141<dd>
597<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>
598can 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>
599</dd> 1144</dd>
600<p></p> 1145<p></p>
601<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 />
602</dt> 1147</dt>
… …
635Create and return a new <code>urxvt::line</code> object that stores information 1180Create and return a new <code>urxvt::line</code> object that stores information
636about the logical line that row <code>$row_number</code> is part of. It supports the 1181about the logical line that row <code>$row_number</code> is part of. It supports the
637following methods: 1182following methods:
638</dd> 1183</dd>
639<dl> 1184<dl>
640<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 1185<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
641</dt> 1186</dt>
642<dd> 1187<dd>
643Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1188Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
644</dd> 1189</dd>
645<p></p> 1190<p></p>
646<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 1191<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
647</dt> 1192</dt>
648<dd> 1193<dd>
649Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1194Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
650</dd> 1195</dd>
651<p></p> 1196<p></p>
652<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1197<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
653</dt> 1198</dt>
654<dd> 1199<dd>
… …
665<p></p> 1210<p></p>
666<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 />
667</dt> 1212</dt>
668<dd> 1213<dd>
669Returns 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
670line. 1215line. Works for rows outside the line, too, and returns corresponding
1216offsets outside the string.
671</dd> 1217</dd>
672<p></p> 1218<p></p>
673<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 />
674</dt> 1220</dt>
675<dd> 1221<dd>
676Translates a string offset into terminal coordinates again. 1222Translates a string offset into terminal coordinates again.
677</dd> 1223</dd>
678<p></p></dl> 1224<p></p></dl>
679<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 />
680=item $text = $term-&gt;special_encode $string</strong><br />
681</dt> 1226</dt>
682<dd> 1227<dd>
683Converts a perl string into the special encoding used by rxvt-unicode, 1228Converts a perl string into the special encoding used by rxvt-unicode,
684where one character corresponds to one screen cell. See 1229where one character corresponds to one screen cell. See
685<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.
… …
688<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1233<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
689</dt> 1234</dt>
690<dd> 1235<dd>
691Converts rxvt-unicodes text reprsentation into a perl string. See 1236Converts rxvt-unicodes text reprsentation into a perl string. See
692<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.
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>
1279<p></p></dl>
1280<p>
1281</p>
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).
693</dd> 1315</dd>
694<p></p></dl> 1316<p></p></dl>
695<p> 1317<p>
696</p> 1318</p>
697<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>
… …
765<pre> 1387<pre>
766 $term-&gt;{socket} = ... 1388 $term-&gt;{socket} = ...
767 $term-&gt;{iow} = urxvt::iow 1389 $term-&gt;{iow} = urxvt::iow
768 -&gt;new 1390 -&gt;new
769 -&gt;fd (fileno $term-&gt;{socket}) 1391 -&gt;fd (fileno $term-&gt;{socket})
770 -&gt;events (1) # wait for read data 1392 -&gt;events (urxvt::EVENT_READ)
771 -&gt;start 1393 -&gt;start
772 -&gt;cb (sub { 1394 -&gt;cb (sub {
773 my ($iow, $revents) = @_; 1395 my ($iow, $revents) = @_;
774 # $revents must be 1 here, no need to check 1396 # $revents must be 1 here, no need to check
775 sysread $term-&gt;{socket}, my $buf, 8192 1397 sysread $term-&gt;{socket}, my $buf, 8192
… …
796</dd> 1418</dd>
797<p></p> 1419<p></p>
798<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 />
799</dt> 1421</dt>
800<dd> 1422<dd>
801Set 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
802data, 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>.
803</dd> 1426</dd>
804<p></p> 1427<p></p>
805<dt><strong>$iow = $iow-&gt;start</strong><br /> 1428<dt><strong>$iow = $iow-&gt;start</strong><br />
806</dt> 1429</dt>
807<dd> 1430<dd>
… …
821<p> 1444<p>
822</p> 1445</p>
823<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1446<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
824<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
825numbers indicate more verbose output.</p> 1448numbers indicate more verbose output.</p>
826<ol> 1449<dl>
827<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1450<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
828</li> 1451</dt>
829<li><strong><a name="item__2d_script_loading_and_management">- 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 />
1453</dt>
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 />
1457</dt>
830</li> 1458</dl>
831<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
832</li>
833</ol>
834<p> 1459<p>
835</p> 1460</p>
836<hr /> 1461<hr />
837<h1><a name="author">AUTHOR</a></h1> 1462<h1><a name="author">AUTHOR</a></h1>
838<pre> 1463<pre>

Diff Legend

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