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.8 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.28 by root, Fri Jan 13 01:09:37 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>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
23 <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>
24 <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>
25 <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>
26 <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>
27 <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>
28 </ul> 33 </ul>
29 34
30 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
60 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
61<p> 66<p>
62</p> 67</p>
63<hr /> 68<hr />
64<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
65<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
66<code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
67<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
68thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
69<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
70scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
71<p> 76<p>
72</p> 77</p>
73<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
74<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
75find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
76<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
77<pre> 83<pre>
78 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
79<dl> 85<dl>
80<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
81</dt> 87</dt>
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>.
82<dd> 94</dd>
83Miscellaneous selection modifications. 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>
125<p>This extension also offers the following bindable keyboard command:</p>
84</dd> 126</dd>
85<dl> 127<dl>
86<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
87</dt> 129</dt>
88<dd> 130<dd>
… …
91<dd> 133<dd>
92<pre> 134<pre>
93 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
94</dd> 136</dd>
95<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/^(\\S+):(\\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/^(S+):(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>
96<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 />
97</dt> 240</dt>
98<dd> 241<dd>
99Displays a digital clock using the built-in overlay. 242Displays a digital clock using the built-in overlay.
100</dd> 243</dd>
… …
105Displays 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
106window. Illustrates overwriting the refresh callbacks to create your own 249window. Illustrates overwriting the refresh callbacks to create your own
107overlays or changes. 250overlays or changes.
108</dd> 251</dd>
109<p></p></dl> 252<p></p></dl>
253<p>
254</p>
255<hr />
256<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
110<p> 257<p>
111</p> 258</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 259<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 260<p>All objects (such as terminals, time watchers etc.) are typical
114reference-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
115like. All members starting with an underscore (such as <code>_ptr</code> or 262like. All members starting with an underscore (such as <code>_ptr</code> or
116<code>_hook</code>) are reserved for internal uses and must not be accessed or 263<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 264modified).</p>
118<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
119emptied, 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
120the 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
121terminal 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>
122<p> 328<p>
123</p> 329</p>
124<h2><a name="hooks">Hooks</a></h2> 330<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 331<p>The following subroutines can be declared in extension files, and will be
126whenever the relevant event happens.</p> 332called whenever the relevant event happens.</p>
333<p>The first argument passed to them is an extension oject as described in
334the in the <code>Extension Objects</code> section.</p>
127<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
128counts 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
129and 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>
130<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>
131<dl> 339<dl>
132<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 />
133</dt> 341</dt>
134<dd> 342<dd>
135Called after a new terminal object has been initialized, but before 343Called after a new terminal object has been initialized, but before
136windows 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.
137</dd> 348</dd>
138<p></p> 349<p></p>
139<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 />
140</dt> 351</dt>
141<dd> 352<dd>
… …
172</dd> 383</dd>
173<dd> 384<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 385<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 386</dd>
176<p></p> 387<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 388<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
178</dt> 389</dt>
179<dd>
180Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing.
182</dd> 390<dd>
183<p></p> 391Called whenever the user tries to extend the selection (e.g. with a double
184<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 392click) and is either supposed to return false (normal operation), or
185</dt> 393should extend the selection itelf and return true to suppress the built-in
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.
186<dd> 397</dd>
187Called wheneever the window loses keyboard focus, before urxvt does focus 398<dd>
188out processing. 399<p>See the <em>selection</em> example extension.</p>
189</dd> 400</dd>
190<p></p> 401<p></p>
191<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 />
192</dt> 403</dt>
193<dd> 404<dd>
… …
207<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,
208$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
209number of lines that will be in the scrollback buffer.</p> 420number of lines that will be in the scrollback buffer.</p>
210</dd> 421</dd>
211<p></p> 422<p></p>
212<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 />
213</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.
214<dd> 432</dd>
215Called 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>
216</dd> 472</dd>
217<p></p> 473<p></p>
218<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 />
219</dt> 475</dt>
220<dd> 476<dd>
… …
235<dd> 491<dd>
236Called whenever the user presses a key combination that has a 492Called whenever the user presses a key combination that has a
237<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>
238resource in the <code>rxvt(1)</code> manpage). 494resource in the <code>rxvt(1)</code> manpage).
239</dd> 495</dd>
496<p></p>
497<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
498</dt>
499<dd>
500Called whenever the window gets the keyboard focus, before rxvt-unicode
501does focus in processing.
502</dd>
503<p></p>
504<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
505</dt>
506<dd>
507Called wheneever the window loses keyboard focus, before rxvt-unicode does
508focus out processing.
509</dd>
510<p></p>
511<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
512</dt>
513<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
514</dt>
515<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
516</dt>
517<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
518</dt>
519<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
520</dt>
521<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
522</dt>
523<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
524</dt>
525<dd>
526Called whenever the corresponding X event is received for the terminal If
527the hook returns true, then the even will be ignored by rxvt-unicode.
528</dd>
529<dd>
530<p>The event is a hash with most values as named by Xlib (see the XEvent
531manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
532and column under the mouse cursor.</p>
533</dd>
534<dd>
535<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
536output, if any, in locale-specific encoding.</p>
537</dd>
538<dd>
539<p>subwindow.</p>
540</dd>
541<p></p></dl>
542<p>
543</p>
544<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
545<dl>
546<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
547</dt>
548<dd>
549The rxvt-unicode library directory, where, among other things, the perl
550modules and scripts are stored.
551</dd>
552<p></p>
553<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
554</dt>
555<dd>
556The resource class and name rxvt-unicode uses to look up X resources.
557</dd>
558<p></p>
559<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
560</dt>
561<dd>
562The basename of the installed binaries, usually <code>urxvt</code>.
563</dd>
564<p></p>
565<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
566</dt>
567<dd>
568The current terminal. This variable stores the current <code>urxvt::term</code>
569object, whenever a callback/hook is executing.
570</dd>
240<p></p></dl> 571<p></p></dl>
241<p> 572<p>
242</p> 573</p>
243<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 574<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
244<dl> 575<dl>
… …
259</dd> 590</dd>
260<dd> 591<dd>
261<p>Using this function has the advantage that its output ends up in the 592<p>Using this function has the advantage that its output ends up in the
262correct place, e.g. on stderr of the connecting urxvtc client.</p> 593correct place, e.g. on stderr of the connecting urxvtc client.</p>
263</dd> 594</dd>
595<dd>
596<p>Messages have a size limit of 1023 bytes currently.</p>
597</dd>
598<p></p>
599<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
600</dt>
601<dd>
602Returns true when it is safe to do potentially unsafe things, such as
603evaluating perl code specified by the user. This is true when urxvt was
604started setuid or setgid.
605</dd>
264<p></p> 606<p></p>
265<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 607<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
266</dt> 608</dt>
267<dd> 609<dd>
268Returns the ``current time'' (as per the event loop). 610Returns the ``current time'' (as per the event loop).
611</dd>
612<p></p>
613<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
614</dt>
615<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
616Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
617Button4Mask, Button5Mask, AnyModifier</a></strong><br />
618</dt>
619<dd>
620Various constants for use in X calls and event processing.
269</dd> 621</dd>
270<p></p></dl> 622<p></p></dl>
271<p> 623<p>
272</p> 624</p>
273<h2><a name="rendition">RENDITION</a></h2> 625<h2><a name="rendition">RENDITION</a></h2>
… …
305</dt> 657</dt>
306<dd> 658<dd>
307Return the foreground/background colour index, respectively. 659Return the foreground/background colour index, respectively.
308</dd> 660</dd>
309<p></p> 661<p></p>
310<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 662<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
311</dt> 663</dt>
312<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 664<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
313</dt> 665</dt>
314<dd> 666<dd>
315Replace the foreground/background colour in the rendition mask with the 667Replace the foreground/background colour in the rendition mask with the
316specified one. 668specified one.
317</dd> 669</dd>
318<p></p> 670<p></p>
319<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 671<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
320</dt> 672</dt>
321<dd> 673<dd>
322Return the ``custom'' value: Every rendition has 5 bits for use by 674Return the ``custom'' value: Every rendition has 5 bits for use by
323extensions. They can be set and changed as you like and are initially 675extensions. They can be set and changed as you like and are initially
324zero. 676zero.
325</dd> 677</dd>
326<p></p> 678<p></p>
327<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 679<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
328</dt> 680</dt>
329<dd> 681<dd>
330Change the custom value. 682Change the custom value.
331</dd> 683</dd>
332<p></p></dl> 684<p></p></dl>
685<p>
686</p>
687<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
688<p>The sole purpose of this class is to deliver an interface to the
689<code>AnyEvent</code> module - any module using it will work inside urxvt without
690further programming. The only exception is that you cannot wait on
691condition variables, but non-blocking condvar use is ok. What this means
692is that you cannot use blocking APIs, but the non-blocking variant should
693work.</p>
333<p> 694<p>
334</p> 695</p>
335<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 696<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
336<dl> 697<dl>
698<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
699</dt>
700<dd>
701Creates a new terminal, very similar as if you had started it with system
702<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
703hash which defines the environment of the new terminal.
704</dd>
705<dd>
706<p>Croaks (and probably outputs an error message) if the new instance
707couldn't be created. Returns <code>undef</code> if the new instance didn't
708initialise perl, and the terminal object otherwise. The <code>init</code> and
709<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
710</dd>
711<p></p>
712<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
713</dt>
714<dd>
715Destroy the terminal object (close the window, free resources
716etc.). Please note that rxvt will not exit as long as any event
717watchers (timers, io watchers) are still active.
718</dd>
719<p></p>
720<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
721</dt>
722<dd>
723Returns true if the option specified by <code>$optval</code> is enabled, and
724optionally change it. All option values are stored by name in the hash
725<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
726</dd>
727<dd>
728<p>Here is a a likely non-exhaustive list of option names, please see the
729source file <em>/src/optinc.h</em> to see the actual list:</p>
730</dd>
731<dd>
732<pre>
733 borderLess console cursorBlink cursorUnderline hold iconic insecure
734 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
735 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
736 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
737 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
738 tripleclickwords utmpInhibit visualBell</pre>
739</dd>
740<p></p>
337<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 741<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
338</dt> 742</dt>
339<dd> 743<dd>
340Returns the current resource value associated with a given name and 744Returns the current resource value associated with a given name and
341optionally sets a new value. Setting values is most useful in the <code>init</code> 745optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
355<p>Please note that resource strings will currently only be freed when the 759<p>Please note that resource strings will currently only be freed when the
356terminal is destroyed, so changing options frequently will eat memory.</p> 760terminal is destroyed, so changing options frequently will eat memory.</p>
357</dd> 761</dd>
358<dd> 762<dd>
359<p>Here is a a likely non-exhaustive list of resource names, not all of which 763<p>Here is a a likely non-exhaustive list of resource names, not all of which
360are supported in every build, please see the source to see the actual 764are supported in every build, please see the source file <em>/src/rsinc.h</em>
361list:</p> 765to see the actual list:</p>
362</dd> 766</dd>
363<dd> 767<dd>
364<pre> 768<pre>
365 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 769 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
366 borderLess color cursorBlink cursorUnderline cutchars delete_key 770 borderLess color cursorBlink cursorUnderline cutchars delete_key
367 display_name embed ext_bwidth fade font geometry hold iconName 771 display_name embed ext_bwidth fade font geometry hold iconName
368 imFont imLocale inputMethod insecure int_bwidth intensityStyles 772 imFont imLocale inputMethod insecure int_bwidth intensityStyles
369 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 773 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
370 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 774 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
371 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 775 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
372 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 776 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
373 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 777 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
374 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 778 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
375 shade term_name title transparent transparent_all tripleclickwords 779 shade term_name title transparent transparent_all tripleclickwords
376 utmpInhibit visualBell</pre> 780 utmpInhibit visualBell</pre>
377</dd> 781</dd>
378<p></p> 782<p></p>
783<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
784</dt>
785<dd>
786Returns the X-Resource for the given pattern, excluding the program or
787class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
788same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
789resource with that pattern exists.
790</dd>
791<dd>
792<p>This method should only be called during the <code>on_start</code> hook, as there is
793only one resource database per display, and later invocations might return
794the wrong resources.</p>
795</dd>
796<p></p>
797<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
798</dt>
799<dd>
800Adds a keymap translation exactly as specified via a resource. See the
801<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
802</dd>
803<p></p>
804<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
805</dt>
806<dd>
807Return and optionally change the current rendition. Text that is output by
808the terminal application will use this style.
809</dd>
810<p></p>
811<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
812</dt>
813<dd>
814Return the current coordinates of the text cursor position and optionally
815set it (which is usually bad as applications don't expect that).
816</dd>
817<p></p>
379<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 818<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
380</dt> 819</dt>
381<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 820<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
382</dt> 821</dt>
383<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 822<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
385<dd> 824<dd>
386Return the current values of the selection mark, begin or end positions, 825Return the current values of the selection mark, begin or end positions,
387and optionally set them to new values. 826and optionally set them to new values.
388</dd> 827</dd>
389<p></p> 828<p></p>
829<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
830</dt>
831<dd>
832Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
833<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
834rectangular selection will be made. This is the prefered function to make
835a selection.
836</dd>
837<p></p>
390<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 838<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
391</dt> 839</dt>
392<dd> 840<dd>
393Try to request the primary selection from the server (for example, as set 841Try to request the primary selection text from the server (for example, as
394by the next method). 842set by the next method). No visual feedback will be given. This function
843is mostly useful from within <code>on_sel_grab</code> hooks.
395</dd> 844</dd>
396<p></p> 845<p></p>
397<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 846<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
398</dt> 847</dt>
399<dd> 848<dd>
400Return the current selection text and optionally replace it by <code>$newtext</code>. 849Return the current selection text and optionally replace it by <code>$newtext</code>.
401</dd> 850</dd>
851<p></p>
852<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
853</dt>
402<dd> 854<dd>
403<p>#=item $term-&gt;overlay ($x, $y, $text)
404#
405#Create a simple multi-line overlay box. See the next method for details. 855Create a simple multi-line overlay box. See the next method for details.
406#
407#=cut</p>
408</dd>
409<dd>
410<p>sub urxvt::term::scr_overlay {
411die;
412 my ($self, $x, $y, $text) = @_;</p>
413</dd>
414<dd>
415<pre>
416 my @lines = split /\n/, $text;</pre>
417</dd>
418<dd>
419<pre>
420 my $w = 0;
421 for (map $self-&gt;strwidth ($_), @lines) {
422 $w = $_ if $w &lt; $_;
423 }</pre>
424</dd>
425<dd>
426<pre>
427 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
428 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
429}</pre>
430</dd> 856</dd>
431<p></p> 857<p></p>
432<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 858<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
433</dt> 859</dt>
434<dd> 860<dd>
… …
447<dd> 873<dd>
448<p>This method returns an urxvt::overlay object. The overlay will be visible 874<p>This method returns an urxvt::overlay object. The overlay will be visible
449as long as the perl object is referenced.</p> 875as long as the perl object is referenced.</p>
450</dd> 876</dd>
451<dd> 877<dd>
452<p>Currently, the only method on the <code>urxvt::overlay</code> object is <a href="#item_set"><code>set</code></a>:</p> 878<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
453</dd> 879</dd>
454<p></p> 880<dl>
455<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 881<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
456</dt> 882</dt>
457<dd> 883<dd>
458Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts 884Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
459text in rxvt-unicode's special encoding and an array of rendition values 885text in rxvt-unicode's special encoding and an array of rendition values
460at a specific position inside the overlay. 886at a specific position inside the overlay.
461</dd> 887</dd>
462<p></p> 888<p></p>
889<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
890</dt>
891<dd>
892If visible, hide the overlay, but do not destroy it.
893</dd>
894<p></p>
895<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
896</dt>
897<dd>
898If hidden, display the overlay again.
899</dd>
900<p></p></dl>
901<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
902</dt>
903<dd>
904Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
905<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
906currently).
907</dd>
908<p></p>
463<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 909<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
464</dt> 910</dt>
465<dd> 911<dd>
466Returns the number of screen-cells this string would need. Correctly 912Returns the number of screen-cells this string would need. Correctly
467accounts for wide and combining characters. 913accounts for wide and combining characters.
468</dd> 914</dd>
469<p></p> 915<p></p>
470<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 916<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
471</dt> 917</dt>
472<dd> 918<dd>
473Convert the given text string into the corresponding locale encoding. 919Convert the given text string into the corresponding locale encoding.
474</dd> 920</dd>
475<p></p> 921<p></p>
476<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 922<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
477</dt> 923</dt>
478<dd> 924<dd>
479Convert the given locale-encoded octets into a perl string. 925Convert the given locale-encoded octets into a perl string.
926</dd>
927<p></p>
928<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 />
929</dt>
930<dd>
931XORs the rendition values in the given span with the provided value
932(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
933refresh hooks to provide effects similar to the selection.
934</dd>
935<p></p>
936<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 />
937</dt>
938<dd>
939Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
940whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
941to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
942it instead. Both styles <em>MUST NOT</em> contain font styles.
943</dd>
944<p></p>
945<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
946</dt>
947<dd>
948Ring the bell!
949</dd>
950<p></p>
951<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
952</dt>
953<dd>
954Write the given text string to the screen, as if output by the application
955running inside the terminal. It may not contain command sequences (escape
956codes), but is free to use line feeds, carriage returns and tabs. The
957string is a normal text string, not in locale-dependent encoding.
958</dd>
959<dd>
960<p>Normally its not a good idea to use this function, as programs might be
961confused by changes in cursor position or scrolling. Its useful inside a
962<code>on_add_lines</code> hook, though.</p>
963</dd>
964<p></p>
965<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
966</dt>
967<dd>
968Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
969locale-specific encoding of the terminal and can contain command sequences
970(escape codes) that will be interpreted.
480</dd> 971</dd>
481<p></p> 972<p></p>
482<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 973<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
483</dt> 974</dt>
484<dd> 975<dd>
485Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 976Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
486pass characters instead of octets, you should convert your strings first 977pass characters instead of octets, you should convert your strings first
487to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 978to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
488</dd> 979</dd>
489<p></p> 980<p></p>
981<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
982</dt>
983<dd>
984Replaces the event mask of the pty watcher by the given event mask. Can
985be used to suppress input and output handling to the pty/tty. See the
986description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
987the previous value.
988</dd>
989<p></p>
990<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
991</dt>
992<dd>
993Return the window id of the toplevel window.
994</dd>
995<p></p>
996<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
997</dt>
998<dd>
999Return the window id of the terminal window.
1000</dd>
1001<p></p>
1002<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1003</dt>
1004<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1005</dt>
1006<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1007</dt>
1008<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1009</dt>
1010<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1011</dt>
490<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 1012<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
491</dt> 1013</dt>
492<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1014<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
493</dt> 1015</dt>
494<dd> 1016<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
495Return the number of rows/columns of the terminal window (i.e. as 1017</dt>
496specified by <code>-geometry</code>, excluding any scrollback). 1018<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1019</dt>
1020<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1021</dt>
1022<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1023</dt>
1024<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
1025</dt>
497</dd> 1026<dd>
1027Return various integers describing terminal characteristics.
1028</dd>
498<p></p> 1029<p></p>
1030<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1031</dt>
1032<dd>
1033Return the DISPLAY used by rxvt-unicode.
1034</dd>
1035<p></p>
1036<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1037</dt>
1038<dd>
1039Returns the LC_CTYPE category string used by this rxvt-unicode.
1040</dd>
1041<p></p>
499<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1042<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
500</dt> 1043</dt>
1044<dd>
1045Returns a copy of the environment in effect for the terminal as a hashref
1046similar to <code>\%ENV</code>.
501<dd> 1047</dd>
502Returns the number of lines in the scrollback buffer. 1048<p></p>
1049<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1050</dt>
1051<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1052</dt>
1053<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1054</dt>
1055<dd>
1056Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1057AltGr), the meta key (often Alt) and the num lock key, if applicable.
503</dd> 1058</dd>
504<p></p> 1059<p></p>
505<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1060<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
506</dt> 1061</dt>
507<dd> 1062<dd>
… …
525</dt> 1080</dt>
526<dd> 1081<dd>
527Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1082Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
528is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1083is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
529terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1084terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
530line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. 1085line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
1086is requested.
531</dd> 1087</dd>
532<dd> 1088<dd>
533<p>If <code>$new_text</code> is specified, it will replace characters in the current 1089<p>If <code>$new_text</code> is specified, it will replace characters in the current
534line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1090line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
535to replace only parts of a line. The font index in the rendition will 1091to replace only parts of a line. The font index in the rendition will
536automatically be updated.</p> 1092automatically be updated.</p>
537</dd> 1093</dd>
538<dd> 1094<dd>
539<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1095<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
540than one cell when displayed are padded with urxvt::NOCHAR characters 1096than one cell when displayed are padded with urxvt::NOCHAR characters
541(<code>chr 65535</code>). Characters with combining characters and other characters 1097(<code>chr 65535</code>). Characters with combining characters and other characters
542that do not fit into the normal tetx encoding will be replaced with 1098that do not fit into the normal tetx encoding will be replaced with
543characters in the private use area.</p> 1099characters in the private use area.</p>
544</dd> 1100</dd>
… …
567</dd> 1123</dd>
568<p></p> 1124<p></p>
569<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 1125<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
570</dt> 1126</dt>
571<dd> 1127<dd>
572Returns the number of screen cells that are in use (``the line length''). If 1128Returns the number of screen cells that are in use (``the line
573it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which 1129length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
574means all characters are in use and it is continued on the next row. 1130line is joined with the following one.
1131</dd>
1132<p></p>
1133<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1134</dt>
575</dd> 1135<dd>
1136Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1137joined with the following row), which means all characters are in use
1138and it is continued on the next row (and possibly a continuation of the
1139previous row(s)).
1140</dd>
576<p></p> 1141<p></p>
1142<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1143</dt>
1144<dd>
1145Create and return a new <code>urxvt::line</code> object that stores information
1146about the logical line that row <code>$row_number</code> is part of. It supports the
1147following methods:
1148</dd>
1149<dl>
1150<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1151</dt>
1152<dd>
1153Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1154</dd>
1155<p></p>
1156<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1157</dt>
1158<dd>
1159Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1160</dd>
1161<p></p>
1162<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1163</dt>
1164<dd>
1165Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1166</dd>
1167<p></p>
1168<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1169</dt>
1170<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1171</dt>
1172<dd>
1173Return the row number of the first/last row of the line, respectively.
1174</dd>
1175<p></p>
1176<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1177</dt>
1178<dd>
1179Returns the character offset of the given row|col pair within the logical
1180line. Works for rows outside the line, too, and returns corresponding
1181offsets outside the string.
1182</dd>
1183<p></p>
1184<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1185</dt>
1186<dd>
1187Translates a string offset into terminal coordinates again.
1188</dd>
1189<p></p></dl>
577<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 1190<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
578</dt> 1191</dt>
579<dd> 1192<dd>
580Converts a perl string into the special encoding used by rxvt-unicode, 1193Converts a perl string into the special encoding used by rxvt-unicode,
581where one character corresponds to one screen cell. See 1194where one character corresponds to one screen cell. See
… …
585<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1198<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
586</dt> 1199</dt>
587<dd> 1200<dd>
588Converts rxvt-unicodes text reprsentation into a perl string. See 1201Converts rxvt-unicodes text reprsentation into a perl string. See
589<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1202<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1203</dd>
1204<p></p>
1205<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1206</dt>
1207<dd>
1208Registers a synchronous button grab. See the XGrabButton manpage.
1209</dd>
1210<p></p>
1211<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1212</dt>
1213<dd>
1214Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1215synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1216</dd>
1217<p></p>
1218<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1219</dt>
1220<dd>
1221Calls XAllowEvents with AsyncBoth for the most recent grab.
1222</dd>
1223<p></p>
1224<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1225</dt>
1226<dd>
1227Calls XAllowEvents with SyncBoth for the most recent grab.
1228</dd>
1229<p></p>
1230<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1231</dt>
1232<dd>
1233Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1234recent grab.
1235</dd>
1236<p></p>
1237<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1238</dt>
1239<dd>
1240Calls XUngrab for the most recent grab. Is called automatically on
1241evaluation errors, as it is better to lose the grab in the error case as
1242the session.
1243</dd>
1244<p></p></dl>
1245<p>
1246</p>
1247<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1248<dl>
1249<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1250</dt>
1251<dd>
1252Adds a non-clickable title to the popup.
1253</dd>
1254<p></p>
1255<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1256</dt>
1257<dd>
1258Creates a separator, optionally using the character given as <code>$sepchr</code>.
1259</dd>
1260<p></p>
1261<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1262</dt>
1263<dd>
1264Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1265selected.
1266</dd>
1267<p></p>
1268<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1269</dt>
1270<dd>
1271Adds a toggle/checkbox item to the popup. Teh callback gets called
1272whenever it gets toggled, with a boolean indicating its value as its first
1273argument.
1274</dd>
1275<p></p>
1276<dt><strong>$popup-&gt;show</strong><br />
1277</dt>
1278<dd>
1279Displays the popup (which is initially hidden).
590</dd> 1280</dd>
591<p></p></dl> 1281<p></p></dl>
592<p> 1282<p>
593</p> 1283</p>
594<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1284<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
662<pre> 1352<pre>
663 $term-&gt;{socket} = ... 1353 $term-&gt;{socket} = ...
664 $term-&gt;{iow} = urxvt::iow 1354 $term-&gt;{iow} = urxvt::iow
665 -&gt;new 1355 -&gt;new
666 -&gt;fd (fileno $term-&gt;{socket}) 1356 -&gt;fd (fileno $term-&gt;{socket})
667 -&gt;events (1) # wait for read data 1357 -&gt;events (urxvt::EVENT_READ)
668 -&gt;start 1358 -&gt;start
669 -&gt;cb (sub { 1359 -&gt;cb (sub {
670 my ($iow, $revents) = @_; 1360 my ($iow, $revents) = @_;
671 # $revents must be 1 here, no need to check 1361 # $revents must be 1 here, no need to check
672 sysread $term-&gt;{socket}, my $buf, 8192 1362 sysread $term-&gt;{socket}, my $buf, 8192
… …
693</dd> 1383</dd>
694<p></p> 1384<p></p>
695<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1385<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
696</dt> 1386</dt>
697<dd> 1387<dd>
698Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1388Set the event mask to watch. The only allowed values are
699data, Bit #1 (value <code>2</code>) enables watching for write data. 1389<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1390together, or <code>urxvt::EVENT_NONE</code>.
700</dd> 1391</dd>
701<p></p> 1392<p></p>
702<dt><strong>$iow = $iow-&gt;start</strong><br /> 1393<dt><strong>$iow = $iow-&gt;start</strong><br />
703</dt> 1394</dt>
704<dd> 1395<dd>
… …
718<p> 1409<p>
719</p> 1410</p>
720<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1411<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
721<p>This variable controls the verbosity level of the perl extension. Higher 1412<p>This variable controls the verbosity level of the perl extension. Higher
722numbers indicate more verbose output.</p> 1413numbers indicate more verbose output.</p>
723<ol> 1414<dl>
724<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1415<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
725</li> 1416</dt>
726<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1417<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1418</dt>
1419<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1420</dt>
1421<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1422</dt>
727</li> 1423</dl>
728<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
729</li>
730</ol>
731<p> 1424<p>
732</p> 1425</p>
733<hr /> 1426<hr />
734<h1><a name="author">AUTHOR</a></h1> 1427<h1><a name="author">AUTHOR</a></h1>
735<pre> 1428<pre>

Diff Legend

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