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.3 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.26 by root, Thu Jan 12 12:10:06 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="#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>
21 <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>
22 <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>
27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
23 <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>
24 <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>
25 <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>
26 </ul> 33 </ul>
27 34
28 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
36<!-- INDEX END --> 43<!-- INDEX END -->
37 44
38<hr /> 45<hr />
39<p> 46<p>
40</p> 47</p>
48<hr />
41<h1><a name="name">NAME</a></h1> 49<h1><a name="name">NAME</a></h1>
42<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 50<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
43<p> 51<p>
44</p> 52</p>
45<hr /> 53<hr />
46<h1><a name="synopsis">SYNOPSIS</a></h1> 54<h1><a name="synopsis">SYNOPSIS</a></h1>
47<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 55<pre>
48<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and 56 # create a file grab_test in $HOME:</pre>
49thus must be encoded as UTF-8.</p>
50<pre> 57<pre>
51 sub on_sel_grab { 58 sub on_sel_grab {
52 warn &quot;you selected &quot;, $_[0]-&gt;selection; 59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
53 () 60 ()
54 }</pre> 61 }</pre>
55<pre> 62<pre>
56 1</pre> 63 # start a rxvt using it:</pre>
64<pre>
65 rxvt --perl-lib $HOME -pe grab_test</pre>
57<p> 66<p>
58</p> 67</p>
59<hr /> 68<hr />
60<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
61<p>On startup, rxvt will scan <em>/opt/rxvt/lib/urxvt/perl-ext/</em> 70<p>Everytime a terminal object gets created, extension scripts specified via
62for files and will load them. Everytime a terminal object gets created, 71the <code>perl</code> resource are loaded and associated with it.</p>
63the directory specified by the <code>perl-lib</code> resource will be additionally 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
64scanned.</p> 73thus must be encoded as UTF-8.</p>
65<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
66scripts will be shared for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
67<p>Hooks in scripts specified by <code>perl-lib</code> will only be called for the 76<p>
68terminals created with that specific option value.</p> 77</p>
78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
80<p>This section describes the extensions delivered with this release. You can
81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
82<p>You can activate them like this:</p>
83<pre>
84 rxvt -pe &lt;extensionname&gt;</pre>
85<dl>
86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
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>.
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>
125<p>This extension also offers the following bindable keyboard command:</p>
126</dd>
127<dl>
128<dt><strong><a name="item_rot13">rot13</a></strong><br />
129</dt>
130<dd>
131Rot-13 the selection when activated. Used via keyboard trigger:
132</dd>
133<dd>
134<pre>
135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
136</dd>
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<p></p>
205<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
206</dt>
207<dd>
208Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
209make them clickable. When middle-clicked, the program specified in the
210resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
211the URL as first argument.
212</dd>
213<p></p>
214<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
215</dt>
216<dd>
217A not very useful example of filtering all text output to the terminal,
218by replacing all line-drawing characters (U+2500 .. U+259F) by a
219similar-looking ascii character.
220</dd>
221<p></p>
222<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
223</dt>
224<dd>
225Displays a digital clock using the built-in overlay.
226</dd>
227<p></p>
228<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
229</dt>
230<dd>
231Displays a very simple digital clock in the upper right corner of the
232window. Illustrates overwriting the refresh callbacks to create your own
233overlays or changes.
234</dd>
235<p></p></dl>
236<p>
237</p>
238<hr />
239<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
69<p> 240<p>
70</p> 241</p>
71<h2><a name="general_api_considerations">General API Considerations</a></h2> 242<h2><a name="general_api_considerations">General API Considerations</a></h2>
72<p>All objects (such as terminals, time watchers etc.) are typical 243<p>All objects (such as terminals, time watchers etc.) are typical
73reference-to-hash objects. The hash can be used to store anything you 244reference-to-hash objects. The hash can be used to store anything you
74like. All members starting with an underscore (such as <code>_ptr</code> or 245like. All members starting with an underscore (such as <code>_ptr</code> or
75<code>_hook</code>) are reserved for internal uses and must not be accessed or 246<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
76modified).</p> 247modified).</p>
77<p>When objects are destroyed on the C++ side, the perl object hashes are 248<p>When objects are destroyed on the C++ side, the perl object hashes are
78emptied, so its best to store related objects such as time watchers and 249emptied, so its best to store related objects such as time watchers and
79the like inside the terminal object so they get destroyed as soon as the 250the like inside the terminal object so they get destroyed as soon as the
80terminal is destroyed.</p> 251terminal is destroyed.</p>
252<p>Argument names also often indicate the type of a parameter. Here are some
253hints on what they mean:</p>
254<dl>
255<dt><strong><a name="item__24text">$text</a></strong><br />
256</dt>
257<dd>
258Rxvt-unicodes special way of encoding text, where one ``unicode'' character
259always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
260</dd>
261<p></p>
262<dt><strong><a name="item__24string">$string</a></strong><br />
263</dt>
264<dd>
265A perl text string, with an emphasis on <em>text</em>. It can store all unicode
266characters and is to be distinguished with text encoded in a specific
267encoding (often locale-specific) and binary data.
268</dd>
269<p></p>
270<dt><strong><a name="item__24octets">$octets</a></strong><br />
271</dt>
272<dd>
273Either binary data or - more common - a text string encoded in a
274locale-specific way.
275</dd>
276<p></p></dl>
277<p>
278</p>
279<h2><a name="extension_objects">Extension Objects</a></h2>
280<p>Very perl extension is a perl class. A separate perl object is created
281for each terminal and each extension and passed as the first parameter to
282hooks. So extensions can use their <code>$self</code> object without having to think
283about other extensions, with the exception of methods and members that
284begin with an underscore character <code>_</code>: these are reserved for internal
285use.</p>
286<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
287<code>urxvt::term</code> class on this object.</p>
288<p>It has the following methods and data members:</p>
289<dl>
290<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
291</dt>
292<dd>
293Returns the <code>urxvt::term</code> object associated with this instance of the
294extension. This member <em>must not</em> be changed in any way.
295</dd>
296<p></p>
297<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
298</dt>
299<dd>
300Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
301this extension, replacing any previous hook. This is useful when you want
302to overwrite time-critical hooks only temporarily.
303</dd>
304<p></p>
305<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
306</dt>
307<dd>
308Dynamically disable the given hooks.
309</dd>
310<p></p></dl>
81<p> 311<p>
82</p> 312</p>
83<h2><a name="hooks">Hooks</a></h2> 313<h2><a name="hooks">Hooks</a></h2>
84<p>The following subroutines can be declared in loaded scripts, and will be called 314<p>The following subroutines can be declared in extension files, and will be
85whenever the relevant event happens.</p> 315called whenever the relevant event happens.</p>
316<p>The first argument passed to them is an extension oject as described in
317the in the <code>Extension Objects</code> section.</p>
86<p>All of them must return a boolean value. If it is true, then the event 318<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
87counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 319event counts as being <em>consumed</em>, and the invocation of other hooks is
88and the relevant action might not be carried out by the C++ code.</p> 320skipped, and the relevant action might not be carried out by the C++ code.</p>
89<p>When in doubt, return a false value (preferably <code>()</code>).</p> 321<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
90<dl> 322<dl>
91<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 323<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
92</dt> 324</dt>
93<dd> 325<dd>
94Called after a new terminal object has been initialized, but before 326Called after a new terminal object has been initialized, but before
95windows are created or the command gets run. 327windows are created or the command gets run. Most methods are unsafe to
328call or deliver senseless data, as terminal size and other characteristics
329have not yet been determined. You can safely query and change resources,
330though.
96</dd> 331</dd>
97<p></p> 332<p></p>
98<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 333<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
99</dt> 334</dt>
100<dd> 335<dd>
… …
131</dd> 366</dd>
132<dd> 367<dd>
133<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 368<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
134</dd> 369</dd>
135<p></p> 370<p></p>
136<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 371<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
137</dt> 372</dt>
138<dd>
139Called whenever the window gets the keyboard focus, before urxvt does
140focus in processing.
141</dd> 373<dd>
142<p></p> 374Called whenever the user tries to extend the selection (e.g. with a double
143<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 375click) and is either supposed to return false (normal operation), or
144</dt> 376should extend the selection itelf and return true to suppress the built-in
377processing. This can happen multiple times, as long as the callback
378returns true, it will be called on every further click by the user and is
379supposed to enlarge the selection more and more, if possible.
145<dd> 380</dd>
146Called wheneever the window loses keyboard focus, before urxvt does focus 381<dd>
147out processing. 382<p>See the <em>selection</em> example extension.</p>
148</dd> 383</dd>
149<p></p> 384<p></p>
150<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 385<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
151</dt> 386</dt>
152<dd> 387<dd>
… …
166<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 401<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
167$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 402$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
168number of lines that will be in the scrollback buffer.</p> 403number of lines that will be in the scrollback buffer.</p>
169</dd> 404</dd>
170<p></p> 405<p></p>
171<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 406<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
172</dt> 407</dt>
408<dd>
409Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
410operating system command) is processed. Cursor position and other state
411information is up-to-date when this happens. For interoperability, the
412string should start with the extension name and a colon, to distinguish
413it from commands for other extensions, and this might be enforced in the
414future.
173<dd> 415</dd>
174Called whenever the <code>program(s)</code> running in the urxvt window send output. 416<dd>
417<p>Be careful not ever to trust (in a security sense) the data you receive,
418as its source can not easily be controleld (e-mail content, messages from
419other users on the same system etc.).</p>
420</dd>
421<p></p>
422<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
423</dt>
424<dd>
425Called whenever text is about to be output, with the text as argument. You
426can filter/change and output the text yourself by returning a true value
427and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
428might be very slow, however, as your hook is called for <strong>all</strong> text being
429output.
430</dd>
431<p></p>
432<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
433</dt>
434<dd>
435Called whenever some data is written to the tty/pty and can be used to
436suppress or filter tty input.
437</dd>
438<p></p>
439<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
440</dt>
441<dd>
442Called whenever a line was updated or changed. Can be used to filter
443screen output (e.g. underline urls or other useless stuff). Only lines
444that are being shown will be filtered, and, due to performance reasons,
445not always immediately.
446</dd>
447<dd>
448<p>The row number is always the topmost row of the line if the line spans
449multiple rows.</p>
450</dd>
451<dd>
452<p>Please note that, if you change the line, then the hook might get called
453later with the already-modified line (e.g. if unrelated parts change), so
454you cannot just toggle rendition bits, but only set them.</p>
175</dd> 455</dd>
176<p></p> 456<p></p>
177<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 457<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
178</dt> 458</dt>
179<dd> 459<dd>
… …
186<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 466<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
187</dt> 467</dt>
188<dd> 468<dd>
189Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 469Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
190</dd> 470</dd>
471<p></p>
472<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
473</dt>
474<dd>
475Called whenever the user presses a key combination that has a
476<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
477resource in the <code>rxvt(1)</code> manpage).
478</dd>
479<p></p>
480<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
481</dt>
482<dd>
483Called whenever the window gets the keyboard focus, before rxvt-unicode
484does focus in processing.
485</dd>
486<p></p>
487<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
488</dt>
489<dd>
490Called wheneever the window loses keyboard focus, before rxvt-unicode does
491focus out processing.
492</dd>
493<p></p>
494<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
495</dt>
496<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
497</dt>
498<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
499</dt>
500<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
501</dt>
502<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
503</dt>
504<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
505</dt>
506<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
507</dt>
508<dd>
509Called whenever the corresponding X event is received for the terminal If
510the hook returns true, then the even will be ignored by rxvt-unicode.
511</dd>
512<dd>
513<p>The event is a hash with most values as named by Xlib (see the XEvent
514manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
515and column under the mouse cursor.</p>
516</dd>
517<dd>
518<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
519output, if any, in locale-specific encoding.</p>
520</dd>
521<dd>
522<p>subwindow.</p>
523</dd>
524<p></p></dl>
525<p>
526</p>
527<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
528<dl>
529<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
530</dt>
531<dd>
532The rxvt-unicode library directory, where, among other things, the perl
533modules and scripts are stored.
534</dd>
535<p></p>
536<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
537</dt>
538<dd>
539The resource class and name rxvt-unicode uses to look up X resources.
540</dd>
541<p></p>
542<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
543</dt>
544<dd>
545The basename of the installed binaries, usually <code>urxvt</code>.
546</dd>
547<p></p>
548<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
549</dt>
550<dd>
551The current terminal. This variable stores the current <code>urxvt::term</code>
552object, whenever a callback/hook is executing.
553</dd>
191<p></p></dl> 554<p></p></dl>
192<p> 555<p>
193</p> 556</p>
194<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 557<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
195<dl> 558<dl>
… …
210</dd> 573</dd>
211<dd> 574<dd>
212<p>Using this function has the advantage that its output ends up in the 575<p>Using this function has the advantage that its output ends up in the
213correct place, e.g. on stderr of the connecting urxvtc client.</p> 576correct place, e.g. on stderr of the connecting urxvtc client.</p>
214</dd> 577</dd>
578<dd>
579<p>Messages have a size limit of 1023 bytes currently.</p>
580</dd>
581<p></p>
582<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
583</dt>
584<dd>
585Returns true when it is safe to do potentially unsafe things, such as
586evaluating perl code specified by the user. This is true when urxvt was
587started setuid or setgid.
588</dd>
215<p></p> 589<p></p>
216<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 590<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
217</dt> 591</dt>
218<dd> 592<dd>
219Returns the ``current time'' (as per the event loop). 593Returns the ``current time'' (as per the event loop).
220</dd> 594</dd>
595<p></p>
596<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
597</dt>
598<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
599Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
600Button4Mask, Button5Mask, AnyModifier</a></strong><br />
601</dt>
602<dd>
603Various constants for use in X calls and event processing.
604</dd>
221<p></p></dl> 605<p></p></dl>
606<p>
607</p>
608<h2><a name="rendition">RENDITION</a></h2>
609<p>Rendition bitsets contain information about colour, font, font styles and
610similar information for each screen cell.</p>
611<p>The following ``macros'' deal with changes in rendition sets. You should
612never just create a bitset, you should always modify an existing one,
613as they contain important information required for correct operation of
614rxvt-unicode.</p>
615<dl>
616<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
617</dt>
618<dd>
619Returns the default rendition, as used when the terminal is starting up or
620being reset. Useful as a base to start when creating renditions.
621</dd>
622<p></p>
623<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
624</dt>
625<dd>
626Return the rendition mask used for overlays by default.
627</dd>
628<p></p>
629<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
630</dt>
631<dd>
632Return the bit that enabled bold, italic, blink, reverse-video and
633underline, respectively. To enable such a style, just logically OR it into
634the bitset.
635</dd>
636<p></p>
637<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
638</dt>
639<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
640</dt>
641<dd>
642Return the foreground/background colour index, respectively.
643</dd>
644<p></p>
645<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
646</dt>
647<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
648</dt>
649<dd>
650Replace the foreground/background colour in the rendition mask with the
651specified one.
652</dd>
653<p></p>
654<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
655</dt>
656<dd>
657Return the ``custom'' value: Every rendition has 5 bits for use by
658extensions. They can be set and changed as you like and are initially
659zero.
660</dd>
661<p></p>
662<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
663</dt>
664<dd>
665Change the custom value.
666</dd>
667<p></p></dl>
668<p>
669</p>
670<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
671<p>The sole purpose of this class is to deliver an interface to the
672<code>AnyEvent</code> module - any module using it will work inside urxvt without
673further programming. The only exception is that you cannot wait on
674condition variables, but non-blocking condvar use is ok. What this means
675is that you cannot use blocking APIs, but the non-blocking variant should
676work.</p>
222<p> 677<p>
223</p> 678</p>
224<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 679<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
225<dl> 680<dl>
681<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
682</dt>
683<dd>
684Creates a new terminal, very similar as if you had started it with system
685<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
686hash which defines the environment of the new terminal.
687</dd>
688<dd>
689<p>Croaks (and probably outputs an error message) if the new instance
690couldn't be created. Returns <code>undef</code> if the new instance didn't
691initialise perl, and the terminal object otherwise. The <code>init</code> and
692<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
693</dd>
694<p></p>
695<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
696</dt>
697<dd>
698Destroy the terminal object (close the window, free resources
699etc.). Please note that rxvt will not exit as long as any event
700watchers (timers, io watchers) are still active.
701</dd>
702<p></p>
703<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
704</dt>
705<dd>
706Returns true if the option specified by <code>$optval</code> is enabled, and
707optionally change it. All option values are stored by name in the hash
708<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
709</dd>
710<dd>
711<p>Here is a a likely non-exhaustive list of option names, please see the
712source file <em>/src/optinc.h</em> to see the actual list:</p>
713</dd>
714<dd>
715<pre>
716 borderLess console cursorBlink cursorUnderline hold iconic insecure
717 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
718 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
719 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
720 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
721 tripleclickwords utmpInhibit visualBell</pre>
722</dd>
723<p></p>
226<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 724<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
227</dt> 725</dt>
228<dd> 726<dd>
229Returns the current resource value associated with a given name and 727Returns the current resource value associated with a given name and
230optionally sets a new value. Setting values is most useful in the <code>init</code> 728optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
244<p>Please note that resource strings will currently only be freed when the 742<p>Please note that resource strings will currently only be freed when the
245terminal is destroyed, so changing options frequently will eat memory.</p> 743terminal is destroyed, so changing options frequently will eat memory.</p>
246</dd> 744</dd>
247<dd> 745<dd>
248<p>Here is a a likely non-exhaustive list of resource names, not all of which 746<p>Here is a a likely non-exhaustive list of resource names, not all of which
249are supported in every build, please see the source to see the actual 747are supported in every build, please see the source file <em>/src/rsinc.h</em>
250list:</p> 748to see the actual list:</p>
251</dd> 749</dd>
252<dd> 750<dd>
253<pre> 751<pre>
254 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 752 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
255 borderLess color cursorBlink cursorUnderline cutchars delete_key 753 borderLess color cursorBlink cursorUnderline cutchars delete_key
256 display_name embed ext_bwidth fade font geometry hold iconName 754 display_name embed ext_bwidth fade font geometry hold iconName
257 imFont imLocale inputMethod insecure int_bwidth intensityStyles 755 imFont imLocale inputMethod insecure int_bwidth intensityStyles
258 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 756 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
259 modifier mouseWheelScrollPage name pastableTabs path perl perl_eval 757 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
260 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 758 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
261 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 759 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
262 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 760 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
263 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 761 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
264 shade term_name title transparent transparent_all tripleclickwords 762 shade term_name title transparent transparent_all tripleclickwords
265 utmpInhibit visualBell</pre> 763 utmpInhibit visualBell</pre>
266</dd> 764</dd>
267<p></p> 765<p></p>
766<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
767</dt>
768<dd>
769Returns the X-Resource for the given pattern, excluding the program or
770class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
771same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
772resource with that pattern exists.
773</dd>
774<dd>
775<p>This method should only be called during the <code>on_start</code> hook, as there is
776only one resource database per display, and later invocations might return
777the wrong resources.</p>
778</dd>
779<p></p>
780<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
781</dt>
782<dd>
783Adds a keymap translation exactly as specified via a resource. See the
784<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
785</dd>
786<p></p>
787<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
788</dt>
789<dd>
790Return and optionally change the current rendition. Text that is output by
791the terminal application will use this style.
792</dd>
793<p></p>
794<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
795</dt>
796<dd>
797Return the current coordinates of the text cursor position and optionally
798set it (which is usually bad as applications don't expect that).
799</dd>
800<p></p>
268<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 801<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
269</dt> 802</dt>
270<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 803<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
271</dt> 804</dt>
272<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 805<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
274<dd> 807<dd>
275Return the current values of the selection mark, begin or end positions, 808Return the current values of the selection mark, begin or end positions,
276and optionally set them to new values. 809and optionally set them to new values.
277</dd> 810</dd>
278<p></p> 811<p></p>
812<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
813</dt>
814<dd>
815Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
816<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
817rectangular selection will be made. This is the prefered function to make
818a selection.
819</dd>
820<p></p>
279<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 821<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
280</dt> 822</dt>
281<dd> 823<dd>
282Try to request the primary selection from the server (for example, as set 824Try to request the primary selection text from the server (for example, as
283by the next method). 825set by the next method). No visual feedback will be given. This function
826is mostly useful from within <code>on_sel_grab</code> hooks.
284</dd> 827</dd>
285<p></p> 828<p></p>
286<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 829<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
287</dt> 830</dt>
288<dd> 831<dd>
289Return the current selection text and optionally replace it by <code>$newtext</code>. 832Return the current selection text and optionally replace it by <code>$newtext</code>.
290</dd> 833</dd>
291<p></p> 834<p></p>
292<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 835<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
293</dt> 836</dt>
294<dd> 837<dd>
295Create a simple multi-line overlay box. See the next method for details. 838Create a simple multi-line overlay box. See the next method for details.
296</dd> 839</dd>
297<p></p> 840<p></p>
298<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 841<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
299</dt> 842</dt>
300<dd> 843<dd>
301Create a new (empty) overlay at the given position with the given 844Create a new (empty) overlay at the given position with the given
302width/height. A border will be put around the box. If either <code>$x</code> or 845width/height. <code>$rstyle</code> defines the initial rendition style
303<code>$y</code> is negative, then this is counted from the right/bottom side, 846(default: <code>OVERLAY_RSTYLE</code>).
304respectively.
305</dd>
306<p></p>
307<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
308</dt>
309<dd> 847</dd>
310Switch the overlay off again.
311</dd> 848<dd>
312<p></p> 849<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
313<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 850around the box.</p>
314</dt>
315<dd> 851</dd>
316Put a single character (specified numerically) at the given overlay
317position.
318</dd> 852<dd>
319<p></p> 853<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
320<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 854right/bottom side, respectively.</p>
321</dt>
322<dd> 855</dd>
323Write a string at the given position into the overlay.
324</dd> 856<dd>
857<p>This method returns an urxvt::overlay object. The overlay will be visible
858as long as the perl object is referenced.</p>
859</dd>
860<dd>
861<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
862</dd>
863<dl>
864<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
865</dt>
866<dd>
867Similar 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
868text in rxvt-unicode's special encoding and an array of rendition values
869at a specific position inside the overlay.
870</dd>
325<p></p> 871<p></p>
872<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
873</dt>
874<dd>
875If visible, hide the overlay, but do not destroy it.
876</dd>
877<p></p>
878<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
879</dt>
880<dd>
881If hidden, display the overlay again.
882</dd>
883<p></p></dl>
884<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
885</dt>
886<dd>
887Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
888<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
889currently).
890</dd>
891<p></p>
326<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 892<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
327</dt> 893</dt>
328<dd> 894<dd>
329Returns the number of screen-cells this string would need. Correctly 895Returns the number of screen-cells this string would need. Correctly
330accounts for wide and combining characters. 896accounts for wide and combining characters.
331</dd> 897</dd>
332<p></p> 898<p></p>
333<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 899<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
334</dt> 900</dt>
335<dd> 901<dd>
336Convert the given text string into the corresponding locale encoding. 902Convert the given text string into the corresponding locale encoding.
337</dd> 903</dd>
338<p></p> 904<p></p>
339<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 905<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
340</dt> 906</dt>
341<dd> 907<dd>
342Convert the given locale-encoded octets into a perl string. 908Convert the given locale-encoded octets into a perl string.
343</dd> 909</dd>
344<p></p> 910<p></p>
911<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 />
912</dt>
913<dd>
914XORs the rendition values in the given span with the provided value
915(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
916refresh hooks to provide effects similar to the selection.
917</dd>
918<p></p>
919<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 />
920</dt>
921<dd>
922Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
923whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
924to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
925it instead. Both styles <em>MUST NOT</em> contain font styles.
926</dd>
927<p></p>
928<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
929</dt>
930<dd>
931Ring the bell!
932</dd>
933<p></p>
934<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
935</dt>
936<dd>
937Write the given text string to the screen, as if output by the application
938running inside the terminal. It may not contain command sequences (escape
939codes), but is free to use line feeds, carriage returns and tabs. The
940string is a normal text string, not in locale-dependent encoding.
941</dd>
942<dd>
943<p>Normally its not a good idea to use this function, as programs might be
944confused by changes in cursor position or scrolling. Its useful inside a
945<code>on_add_lines</code> hook, though.</p>
946</dd>
947<p></p>
948<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
949</dt>
950<dd>
951Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
952locale-specific encoding of the terminal and can contain command sequences
953(escape codes) that will be interpreted.
954</dd>
955<p></p>
345<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 956<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
346</dt> 957</dt>
347<dd> 958<dd>
348Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 959Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
349pass characters instead of octets, you should convetr you strings first to 960pass characters instead of octets, you should convert your strings first
350the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 961to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
962</dd>
963<p></p>
964<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
965</dt>
966<dd>
967Replaces the event mask of the pty watcher by the given event mask. Can
968be used to suppress input and output handling to the pty/tty. See the
969description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
970the previous value.
971</dd>
972<p></p>
973<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
974</dt>
975<dd>
976Return the window id of the toplevel window.
977</dd>
978<p></p>
979<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
980</dt>
981<dd>
982Return the window id of the terminal window.
983</dd>
984<p></p>
985<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
986</dt>
987<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
988</dt>
989<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
990</dt>
991<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
992</dt>
993<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
994</dt>
995<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
996</dt>
997<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
998</dt>
999<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1000</dt>
1001<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1002</dt>
1003<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1004</dt>
1005<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1006</dt>
1007<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
1008</dt>
1009<dd>
1010Return various integers describing terminal characteristics.
1011</dd>
1012<p></p>
1013<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1014</dt>
1015<dd>
1016Return the DISPLAY used by rxvt-unicode.
1017</dd>
1018<p></p>
1019<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1020</dt>
1021<dd>
1022Returns the LC_CTYPE category string used by this rxvt-unicode.
1023</dd>
1024<p></p>
1025<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1026</dt>
1027<dd>
1028Returns a copy of the environment in effect for the terminal as a hashref
1029similar to <code>\%ENV</code>.
1030</dd>
1031<p></p>
1032<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1033</dt>
1034<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1035</dt>
1036<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1037</dt>
1038<dd>
1039Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1040AltGr), the meta key (often Alt) and the num lock key, if applicable.
1041</dd>
1042<p></p>
1043<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1044</dt>
1045<dd>
1046Returns the negative row number of the topmost line. Minimum value is
1047<code>0</code>, which displays the normal terminal contents. Larger values scroll
1048this many lines into the scrollback buffer.
1049</dd>
1050<p></p>
1051<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1052</dt>
1053<dd>
1054Requests a screen refresh. At the next opportunity, rxvt-unicode will
1055compare the on-screen display with its stored representation. If they
1056differ, it redraws the differences.
1057</dd>
1058<dd>
1059<p>Used after changing terminal contents to display them.</p>
1060</dd>
1061<p></p>
1062<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1063</dt>
1064<dd>
1065Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1066is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1067terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1068line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
1069is requested.
1070</dd>
1071<dd>
1072<p>If <code>$new_text</code> is specified, it will replace characters in the current
1073line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1074to replace only parts of a line. The font index in the rendition will
1075automatically be updated.</p>
1076</dd>
1077<dd>
1078<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1079than one cell when displayed are padded with urxvt::NOCHAR characters
1080(<code>chr 65535</code>). Characters with combining characters and other characters
1081that do not fit into the normal tetx encoding will be replaced with
1082characters in the private use area.</p>
1083</dd>
1084<dd>
1085<p>You have to obey this encoding when changing text. The advantage is
1086that <code>substr</code> and similar functions work on screen cells and not on
1087characters.</p>
1088</dd>
1089<dd>
1090<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>
1091can be used to convert normal strings into this encoding and vice versa.</p>
1092</dd>
1093<p></p>
1094<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1095</dt>
1096<dd>
1097Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1098bitsets. Rendition bitsets contain information about colour, font, font
1099styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1100</dd>
1101<dd>
1102<p>When setting rendition, the font mask will be ignored.</p>
1103</dd>
1104<dd>
1105<p>See the section on RENDITION, above.</p>
1106</dd>
1107<p></p>
1108<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1109</dt>
1110<dd>
1111Returns the number of screen cells that are in use (``the line
1112length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1113line is joined with the following one.
1114</dd>
1115<p></p>
1116<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1117</dt>
1118<dd>
1119Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1120joined with the following row), which means all characters are in use
1121and it is continued on the next row (and possibly a continuation of the
1122previous row(s)).
1123</dd>
1124<p></p>
1125<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1126</dt>
1127<dd>
1128Create and return a new <code>urxvt::line</code> object that stores information
1129about the logical line that row <code>$row_number</code> is part of. It supports the
1130following methods:
1131</dd>
1132<dl>
1133<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1134</dt>
1135<dd>
1136Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1137</dd>
1138<p></p>
1139<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1140</dt>
1141<dd>
1142Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1143</dd>
1144<p></p>
1145<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1146</dt>
1147<dd>
1148Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1149</dd>
1150<p></p>
1151<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1152</dt>
1153<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1154</dt>
1155<dd>
1156Return the row number of the first/last row of the line, respectively.
1157</dd>
1158<p></p>
1159<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1160</dt>
1161<dd>
1162Returns the character offset of the given row|col pair within the logical
1163line. Works for rows outside the line, too, and returns corresponding
1164offsets outside the string.
1165</dd>
1166<p></p>
1167<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1168</dt>
1169<dd>
1170Translates a string offset into terminal coordinates again.
1171</dd>
1172<p></p></dl>
1173<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1174</dt>
1175<dd>
1176Converts a perl string into the special encoding used by rxvt-unicode,
1177where one character corresponds to one screen cell. See
1178<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1179</dd>
1180<p></p>
1181<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1182</dt>
1183<dd>
1184Converts rxvt-unicodes text reprsentation into a perl string. See
1185<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1186</dd>
1187<p></p>
1188<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1189</dt>
1190<dd>
1191Registers a synchronous button grab. See the XGrabButton manpage.
1192</dd>
1193<p></p>
1194<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1195</dt>
1196<dd>
1197Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1198synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1199</dd>
1200<p></p>
1201<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1202</dt>
1203<dd>
1204Calls XAllowEvents with AsyncBoth for the most recent grab.
1205</dd>
1206<p></p>
1207<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1208</dt>
1209<dd>
1210Calls XAllowEvents with SyncBoth for the most recent grab.
1211</dd>
1212<p></p>
1213<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1214</dt>
1215<dd>
1216Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1217recent grab.
1218</dd>
1219<p></p>
1220<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1221</dt>
1222<dd>
1223Calls XUngrab for the most recent grab. Is called automatically on
1224evaluation errors, as it is better to lose the grab in the error case as
1225the session.
1226</dd>
1227<p></p></dl>
1228<p>
1229</p>
1230<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1231<dl>
1232<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1233</dt>
1234<dd>
1235Adds a non-clickable title to the popup.
1236</dd>
1237<p></p>
1238<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1239</dt>
1240<dd>
1241Creates a separator, optionally using the character given as <code>$sepchr</code>.
1242</dd>
1243<p></p>
1244<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1245</dt>
1246<dd>
1247Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1248selected.
1249</dd>
1250<p></p>
1251<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1252</dt>
1253<dd>
1254Adds a toggle/checkbox item to the popup. Teh callback gets called
1255whenever it gets toggled, with a boolean indicating its value as its first
1256argument.
1257</dd>
1258<p></p>
1259<dt><strong>$popup-&gt;show</strong><br />
1260</dt>
1261<dd>
1262Displays the popup (which is initially hidden).
351</dd> 1263</dd>
352<p></p></dl> 1264<p></p></dl>
353<p> 1265<p>
354</p> 1266</p>
355<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1267<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
356<p>This class implements timer watchers/events. Time is represented as a 1268<p>This class implements timer watchers/events. Time is represented as a
357fractional number of seconds since the epoch. Example:</p> 1269fractional number of seconds since the epoch. Example:</p>
358<pre> 1270<pre>
359 # create a digital clock display in upper right corner 1271 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
360 $term-&gt;{timer} = urxvt::timer 1272 $term-&gt;{timer} = urxvt::timer
361 -&gt;new 1273 -&gt;new
362 -&gt;start (urxvt::NOW) 1274 -&gt;interval (1)
363 -&gt;cb (sub { 1275 -&gt;cb (sub {
364 my ($timer) = @_;
365 my $time = $timer-&gt;at;
366 $timer-&gt;start ($time + 1);
367 $self-&gt;scr_overlay (-1, 0, 1276 $term-&gt;{overlay}-&gt;set (0, 0,
368 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 1277 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
369 });</pre> 1278 });</pre>
370<dl> 1279<dl>
371<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1280<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
372</dt> 1281</dt>
373<dd> 1282<dd>
374Create a new timer object in stopped state. 1283Create a new timer object in started state. It is scheduled to fire
1284immediately.
375</dd> 1285</dd>
376<p></p> 1286<p></p>
377<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1287<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
378</dt> 1288</dt>
379<dd> 1289<dd>
… …
384</dt> 1294</dt>
385<dd> 1295<dd>
386Return the time this watcher will fire next. 1296Return the time this watcher will fire next.
387</dd> 1297</dd>
388<p></p> 1298<p></p>
389<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 1299<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
390</dt> 1300</dt>
391<dd> 1301<dd>
392Set the time the event is generated to $tstamp. 1302Set the time the event is generated to $tstamp.
1303</dd>
1304<p></p>
1305<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1306</dt>
1307<dd>
1308Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1309stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1310is automatically rescheduled at the given intervals.
393</dd> 1311</dd>
394<p></p> 1312<p></p>
395<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1313<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
396</dt> 1314</dt>
397<dd> 1315<dd>
… …
417<pre> 1335<pre>
418 $term-&gt;{socket} = ... 1336 $term-&gt;{socket} = ...
419 $term-&gt;{iow} = urxvt::iow 1337 $term-&gt;{iow} = urxvt::iow
420 -&gt;new 1338 -&gt;new
421 -&gt;fd (fileno $term-&gt;{socket}) 1339 -&gt;fd (fileno $term-&gt;{socket})
422 -&gt;events (1) # wait for read data 1340 -&gt;events (urxvt::EVENT_READ)
423 -&gt;start 1341 -&gt;start
424 -&gt;cb (sub { 1342 -&gt;cb (sub {
425 my ($iow, $revents) = @_; 1343 my ($iow, $revents) = @_;
426 # $revents must be 1 here, no need to check 1344 # $revents must be 1 here, no need to check
427 sysread $term-&gt;{socket}, my $buf, 8192 1345 sysread $term-&gt;{socket}, my $buf, 8192
… …
448</dd> 1366</dd>
449<p></p> 1367<p></p>
450<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1368<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
451</dt> 1369</dt>
452<dd> 1370<dd>
453Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1371Set the event mask to watch. The only allowed values are
454data, Bit #1 (value <code>2</code>) enables watching for write data. 1372<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1373together, or <code>urxvt::EVENT_NONE</code>.
455</dd> 1374</dd>
456<p></p> 1375<p></p>
457<dt><strong>$iow = $iow-&gt;start</strong><br /> 1376<dt><strong>$iow = $iow-&gt;start</strong><br />
458</dt> 1377</dt>
459<dd> 1378<dd>
… …
473<p> 1392<p>
474</p> 1393</p>
475<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1394<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
476<p>This variable controls the verbosity level of the perl extension. Higher 1395<p>This variable controls the verbosity level of the perl extension. Higher
477numbers indicate more verbose output.</p> 1396numbers indicate more verbose output.</p>
478<ol> 1397<dl>
479<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1398<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
480</li> 1399</dt>
481<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1400<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1401</dt>
1402<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1403</dt>
1404<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1405</dt>
482</li> 1406</dl>
483<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
484</li>
485</ol>
486<p> 1407<p>
487</p> 1408</p>
488<hr /> 1409<hr />
489<h1><a name="author">AUTHOR</a></h1> 1410<h1><a name="author">AUTHOR</a></h1>
490<pre> 1411<pre>

Diff Legend

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