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

Diff Legend

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