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

Diff Legend

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