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.19 by root, Tue Jan 10 04:26:54 2006 UTC

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

Diff Legend

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