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.6 by root, Tue Jan 3 01:39:56 2006 UTC vs.
Revision 1.11 by root, Wed Jan 4 00:12:12 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="#packaged_extensions">PACKAGED EXTENSIONS</a></li>
19 <ul> 18 <ul>
20 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 21 <li><a href="#general_api_considerations">General API Considerations</a></li>
22 <li><a href="#hooks">Hooks</a></li> 22 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
23 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li>
24 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
25 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 27 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
27 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 28 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
28 </ul> 29 </ul>
29 30
30 <li><a href="#environment">ENVIRONMENT</a></li> 31 <li><a href="#environment">ENVIRONMENT</a></li>
… …
38<!-- INDEX END --> 39<!-- INDEX END -->
39 40
40<hr /> 41<hr />
41<p> 42<p>
42</p> 43</p>
44<hr />
43<h1><a name="name">NAME</a></h1> 45<h1><a name="name">NAME</a></h1>
44<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 46<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
45<p> 47<p>
46</p> 48</p>
47<hr /> 49<hr />
… …
64<p>Everytime a terminal object gets created, scripts specified via the 66<p>Everytime a terminal object gets created, scripts specified via the
65<code>perl</code> resource are loaded and associated with it.</p> 67<code>perl</code> resource are loaded and associated with it.</p>
66<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 68<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
67thus must be encoded as UTF-8.</p> 69thus must be encoded as UTF-8.</p>
68<p>Each script will only ever be loaded once, even in rxvtd, where 70<p>Each script will only ever be loaded once, even in rxvtd, where
69scripts will be shared (But not enabled) for all terminals.</p> 71scripts will be shared (but not enabled) for all terminals.</p>
70<p>
71</p> 72<p>
72<hr /> 73</p>
73<h1><a name="packaged_extensions">PACKAGED EXTENSIONS</a></h1> 74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2>
74<p>This section describes the extensiosn delivered with this version. You can 75<p>This section describes the extensiosn delivered with this version. You can
75find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
76<p>You can activate them like this:</p> 77<p>You can activate them like this:</p>
77<pre> 78<pre>
78 rxvt -pe &lt;extensionname&gt;</pre> 79 rxvt -pe &lt;extensionname&gt;</pre>
79<dl> 80<dl>
80<dt><strong><a name="item_selection">selection</a></strong><br /> 81<dt><strong><a name="item_selection">selection</a></strong><br />
81</dt> 82</dt>
82<dd> 83<dd>
83Miscellaneous selection modifications. 84Intelligent selection. This extension tries to be more intelligent when
85the user extends selections (double-click). Right now, it tries to select
86urls and complete shell-quoted arguments, which is very convenient, too,
87if your <em>ls</em> supports <code>--quoting-style=shell</code>.
88</dd>
89<dd>
90<p>It also offers the following bindable event:</p>
84</dd> 91</dd>
85<dl> 92<dl>
86<dt><strong><a name="item_rot13">rot13</a></strong><br /> 93<dt><strong><a name="item_rot13">rot13</a></strong><br />
87</dt> 94</dt>
88<dd> 95<dd>
… …
92<pre> 99<pre>
93 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 100 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
94</dd> 101</dd>
95<p></p></dl> 102<p></p></dl>
96<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 103<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
104</dt>
105<dd>
106Displays a digital clock using the built-in overlay.
107</dd>
108<p></p>
109<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
97</dt> 110</dt>
98<dd> 111<dd>
99Displays a very simple digital clock in the upper right corner of the 112Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 113window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 114overlays or changes.
102</dd>
103<p></p>
104<dt><strong><a name="item_simple_2doverlay_2dclock">simple-overlay-clock</a></strong><br />
105</dt>
106<dd>
107Displays a digital clock using the built-in overlay (colorful, useless).
108</dd> 115</dd>
109<p></p></dl> 116<p></p></dl>
110<p> 117<p>
111</p> 118</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 119<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 120<p>All objects (such as terminals, time watchers etc.) are typical
114reference-to-hash objects. The hash can be used to store anything you 121reference-to-hash objects. The hash can be used to store anything you
115like. All members starting with an underscore (such as <code>_ptr</code> or 122like. All members starting with an underscore (such as <code>_ptr</code> or
116<code>_hook</code>) are reserved for internal uses and must not be accessed or 123<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 124modified).</p>
118<p>When objects are destroyed on the C++ side, the perl object hashes are 125<p>When objects are destroyed on the C++ side, the perl object hashes are
119emptied, so its best to store related objects such as time watchers and 126emptied, so its best to store related objects such as time watchers and
120the like inside the terminal object so they get destroyed as soon as the 127the like inside the terminal object so they get destroyed as soon as the
121terminal is destroyed.</p> 128terminal is destroyed.</p>
122<p> 129<p>
123</p> 130</p>
124<h2><a name="hooks">Hooks</a></h2> 131<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 132<p>The following subroutines can be declared in loaded scripts, and will be
126whenever the relevant event happens.</p> 133called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal
135and extension package. You can call all <code>urxvt::term</code> methods on it, but
136its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
137object that is shared between all packages is stored in the <code>term</code>
138member.</p>
127<p>All of them must return a boolean value. If it is true, then the event 139<p>All of them must return a boolean value. If it is true, then the event
128counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 140counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
129and the relevant action might not be carried out by the C++ code.</p> 141and the relevant action might not be carried out by the C++ code.</p>
130<p>When in doubt, return a false value (preferably <code>()</code>).</p> 142<p>When in doubt, return a false value (preferably <code>()</code>).</p>
131<dl> 143<dl>
… …
172</dd> 184</dd>
173<dd> 185<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 186<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 187</dd>
176<p></p> 188<p></p>
189<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
190</dt>
191<dd>
192Called whenever the user tries to extend the selection (e.g. with a double
193click) and is either supposed to return false (normal operation), or
194should extend the selection itelf and return true to suppress the built-in
195processing.
196</dd>
197<dd>
198<p>See the <em>selection</em> example extension.</p>
199</dd>
200<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 201<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
178</dt> 202</dt>
179<dd> 203<dd>
180Called whenever the window gets the keyboard focus, before urxvt does 204Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing. 205focus in processing.
… …
211<p></p> 235<p></p>
212<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 236<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
213</dt> 237</dt>
214<dd> 238<dd>
215Called whenever the <code>program(s)</code> running in the urxvt window send output. 239Called whenever the <code>program(s)</code> running in the urxvt window send output.
240</dd>
241<p></p>
242<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
243</dt>
244<dd>
245Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
246operating system command) is processed. Cursor position and other state
247information is up-to-date when this happens. For interoperability, the
248string should start with the extension name and a colon, to distinguish
249it from commands for other extensions, and this might be enforced in the
250future.
251</dd>
252<dd>
253<p>Be careful not ever to trust (in a security sense) the data you receive,
254as its source can not easily be controleld (e-mail content, messages from
255other users on the same system etc.).</p>
216</dd> 256</dd>
217<p></p> 257<p></p>
218<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 258<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
219</dt> 259</dt>
220<dd> 260<dd>
… …
238resource in the <code>rxvt(1)</code> manpage). 278resource in the <code>rxvt(1)</code> manpage).
239</dd> 279</dd>
240<p></p></dl> 280<p></p></dl>
241<p> 281<p>
242</p> 282</p>
283<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
284<dl>
285<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
286</dt>
287<dd>
288The current terminal. Whenever a callback/Hook is bein executed, this
289variable stores the current <code>urxvt::term</code> object.
290</dd>
291<p></p></dl>
292<p>
293</p>
243<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 294<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
244<dl> 295<dl>
245<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 296<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
246</dt> 297</dt>
247<dd> 298<dd>
… …
264<p></p> 315<p></p>
265<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 316<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
266</dt> 317</dt>
267<dd> 318<dd>
268Returns the ``current time'' (as per the event loop). 319Returns the ``current time'' (as per the event loop).
320</dd>
321<p></p></dl>
322<p>
323</p>
324<h2><a name="rendition">RENDITION</a></h2>
325<p>Rendition bitsets contain information about colour, font, font styles and
326similar information for each screen cell.</p>
327<p>The following ``macros'' deal with changes in rendition sets. You should
328never just create a bitset, you should always modify an existing one,
329as they contain important information required for correct operation of
330rxvt-unicode.</p>
331<dl>
332<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
333</dt>
334<dd>
335Returns the default rendition, as used when the terminal is starting up or
336being reset. Useful as a base to start when creating renditions.
337</dd>
338<p></p>
339<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
340</dt>
341<dd>
342Return the rendition mask used for overlays by default.
343</dd>
344<p></p>
345<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 />
346</dt>
347<dd>
348Return the bit that enabled bold, italic, blink, reverse-video and
349underline, respectively. To enable such a style, just logically OR it into
350the bitset.
351</dd>
352<p></p>
353<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
354</dt>
355<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
356</dt>
357<dd>
358Return the foreground/background colour index, respectively.
359</dd>
360<p></p>
361<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br />
362</dt>
363<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br />
364</dt>
365<dd>
366Replace the foreground/background colour in the rendition mask with the
367specified one.
368</dd>
369<p></p>
370<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br />
371</dt>
372<dd>
373Return the ``custom'' value: Every rendition has 5 bits for use by
374extensions. They can be set and changed as you like and are initially
375zero.
376</dd>
377<p></p>
378<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br />
379</dt>
380<dd>
381Change the custom value.
269</dd> 382</dd>
270<p></p></dl> 383<p></p></dl>
271<p> 384<p>
272</p> 385</p>
273<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 386<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
… …
335<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 448<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
336</dt> 449</dt>
337<dd> 450<dd>
338Return the current selection text and optionally replace it by <code>$newtext</code>. 451Return the current selection text and optionally replace it by <code>$newtext</code>.
339</dd> 452</dd>
340<p></p>
341<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br />
342</dt>
343<dd> 453<dd>
454<p>#=item $term-&gt;overlay ($x, $y, $text)
455#
344Create a simple multi-line overlay box. See the next method for details. 456#Create a simple multi-line overlay box. See the next method for details.
457#
458#=cut</p>
459</dd>
345</dd> 460<dd>
461<p>sub urxvt::term::scr_overlay {
462die;
463 my ($self, $x, $y, $text) = @_;</p>
464</dd>
465<dd>
466<pre>
467 my @lines = split /\n/, $text;</pre>
468</dd>
469<dd>
470<pre>
471 my $w = 0;
472 for (map $self-&gt;strwidth ($_), @lines) {
473 $w = $_ if $w &lt; $_;
474 }</pre>
475</dd>
476<dd>
477<pre>
478 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
479 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
480}</pre>
481</dd>
346<p></p> 482<p></p>
347<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 483<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
348</dt> 484</dt>
349<dd> 485<dd>
350Create a new (empty) overlay at the given position with the given 486Create a new (empty) overlay at the given position with the given
351width/height. A border will be put around the box. If either <code>$x</code> or 487width/height. <code>$rstyle</code> defines the initial rendition style
352<code>$y</code> is negative, then this is counted from the right/bottom side, 488(default: <code>OVERLAY_RSTYLE</code>).
353respectively.
354</dd>
355<p></p>
356<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
357</dt>
358<dd> 489</dd>
359Switch the overlay off again.
360</dd> 490<dd>
361<p></p> 491<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
362<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 492around the box.</p>
363</dt>
364<dd> 493</dd>
365Put a single character (specified numerically) at the given overlay
366position.
367</dd> 494<dd>
368<p></p> 495<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
369<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 496right/bottom side, respectively.</p>
370</dt>
371<dd> 497</dd>
372Write a string at the given position into the overlay.
373</dd> 498<dd>
499<p>This method returns an urxvt::overlay object. The overlay will be visible
500as long as the perl object is referenced.</p>
501</dd>
502<dd>
503<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
504</dd>
505<dl>
506<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
507</dt>
508<dd>
509Similar 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
510text in rxvt-unicode's special encoding and an array of rendition values
511at a specific position inside the overlay.
512</dd>
374<p></p> 513<p></p>
514<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
515</dt>
516<dd>
517If visible, hide the overlay, but do not destroy it.
518</dd>
519<p></p>
520<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
521</dt>
522<dd>
523If hidden, display the overlay again.
524</dd>
525<p></p></dl>
375<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 526<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br />
376</dt> 527</dt>
377<dd> 528<dd>
378Returns the number of screen-cells this string would need. Correctly 529Returns the number of screen-cells this string would need. Correctly
379accounts for wide and combining characters. 530accounts for wide and combining characters.
… …
437</dt> 588</dt>
438<dd> 589<dd>
439Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 590Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
440is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 591is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
441terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 592terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
442line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. 593line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
594is requested.
443</dd> 595</dd>
444<dd> 596<dd>
445<p>If <code>$new_text</code> is specified, it will replace characters in the current 597<p>If <code>$new_text</code> is specified, it will replace characters in the current
446line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 598line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
447to replace only parts of a line. The font iindex in the rendition will 599to replace only parts of a line. The font index in the rendition will
448automatically be updated.</p> 600automatically be updated.</p>
449</dd> 601</dd>
450<dd> 602<dd>
451<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 603<p><code>$text</code> is in a special encoding: tabs and wide characters that use more
452than one cell when displayed are padded with urxvt::NOCHAR characters 604than one cell when displayed are padded with urxvt::NOCHAR characters
… …
458<p>You have to obey this encoding when changing text. The advantage is 610<p>You have to obey this encoding when changing text. The advantage is
459that <code>substr</code> and similar functions work on screen cells and not on 611that <code>substr</code> and similar functions work on screen cells and not on
460characters.</p> 612characters.</p>
461</dd> 613</dd>
462<dd> 614<dd>
463<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> 615<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
464can be used to convert normal strings into this encoding and vice versa.</p> 616can be used to convert normal strings into this encoding and vice versa.</p>
465</dd> 617</dd>
466<p></p> 618<p></p>
467<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 619<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
468</dt> 620</dt>
… …
473</dd> 625</dd>
474<dd> 626<dd>
475<p>When setting rendition, the font mask will be ignored.</p> 627<p>When setting rendition, the font mask will be ignored.</p>
476</dd> 628</dd>
477<dd> 629<dd>
478<p>See the section on RENDITION, below.</p> 630<p>See the section on RENDITION, above.</p>
479</dd> 631</dd>
480<p></p> 632<p></p>
481<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 633<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
482</dt> 634</dt>
483<dd> 635<dd>
484Returns the number of screen cells that are in use (``the line length''). If 636Returns the number of screen cells that are in use (``the line
485it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which 637length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
486means all characters are in use and it is continued on the next row. 638line is joined with the following one.
639</dd>
640<p></p>
641<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
642</dt>
487</dd> 643<dd>
644Returns true if the row is part of a multiple-row logical ``line'' (i.e.
645joined with the following row), which means all characters are in use
646and it is continued on the next row (and possibly a continuation of the
647previous row(s)).
648</dd>
488<p></p> 649<p></p>
650<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
651</dt>
652<dd>
653Create and return a new <code>urxvt::line</code> object that stores information
654about the logical line that row <code>$row_number</code> is part of. It supports the
655following methods:
656</dd>
657<dl>
489<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 658<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br />
659</dt>
660<dd>
661Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
662</dd>
663<p></p>
664<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br />
665</dt>
666<dd>
667Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
668</dd>
669<p></p>
670<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
671</dt>
672<dd>
673Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
674</dd>
675<p></p>
676<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
677</dt>
678<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
679</dt>
680<dd>
681Return the row number of the first/last row of the line, respectively.
682</dd>
683<p></p>
684<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
685</dt>
686<dd>
687Returns the character offset of the given row|col pair within the logical
688line.
689</dd>
690<p></p>
691<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
692</dt>
693<dd>
694Translates a string offset into terminal coordinates again.
695</dd>
696<p></p></dl>
697<dt><strong>($row, $col) = $line-&gt;coord_of ($offset)
698=item $text = $term-&gt;special_encode $string</strong><br />
490</dt> 699</dt>
491<dd> 700<dd>
492Converts a perl string into the special encoding used by rxvt-unicode, 701Converts a perl string into the special encoding used by rxvt-unicode,
493where one character corresponds to one screen cell. See 702where one character corresponds to one screen cell. See
494<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 703<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
501<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 710<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
502</dd> 711</dd>
503<p></p></dl> 712<p></p></dl>
504<p> 713<p>
505</p> 714</p>
506<h2><a name="rendition">RENDITION</a></h2>
507<p>Rendition bitsets contain information about colour, font, font styles and
508similar information for each screen cell.</p>
509<p>The following ``macros'' deal with changes in rendition sets. You should
510never just create a bitset, you should always modify an existing one,
511as they contain important information required for correct operation of
512rxvt-unicode.</p>
513<dl>
514<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
515</dt>
516<dd>
517Returns the default rendition, as used when the terminal is starting up or
518being reset. Useful as a base
519</dd>
520<p></p></dl>
521<p>
522</p>
523<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 715<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
524<p>This class implements timer watchers/events. Time is represented as a 716<p>This class implements timer watchers/events. Time is represented as a
525fractional number of seconds since the epoch. Example:</p> 717fractional number of seconds since the epoch. Example:</p>
526<pre> 718<pre>
527 # create a digital clock display in upper right corner 719 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
528 $term-&gt;{timer} = urxvt::timer 720 $term-&gt;{timer} = urxvt::timer
529 -&gt;new 721 -&gt;new
530 -&gt;start (urxvt::NOW) 722 -&gt;interval (1)
531 -&gt;cb (sub { 723 -&gt;cb (sub {
532 my ($timer) = @_;
533 my $time = $timer-&gt;at;
534 $timer-&gt;start ($time + 1);
535 $self-&gt;scr_overlay (-1, 0, 724 $term-&gt;{overlay}-&gt;set (0, 0,
536 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 725 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
537 });</pre> 726 });</pre>
538<dl> 727<dl>
539<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 728<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
540</dt> 729</dt>
541<dd> 730<dd>
542Create a new timer object in stopped state. 731Create a new timer object in started state. It is scheduled to fire
732immediately.
543</dd> 733</dd>
544<p></p> 734<p></p>
545<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 735<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
546</dt> 736</dt>
547<dd> 737<dd>
… …
552</dt> 742</dt>
553<dd> 743<dd>
554Return the time this watcher will fire next. 744Return the time this watcher will fire next.
555</dd> 745</dd>
556<p></p> 746<p></p>
557<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 747<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
558</dt> 748</dt>
559<dd> 749<dd>
560Set the time the event is generated to $tstamp. 750Set the time the event is generated to $tstamp.
751</dd>
752<p></p>
753<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
754</dt>
755<dd>
756Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
757stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
758is automatically rescheduled at the given intervals.
561</dd> 759</dd>
562<p></p> 760<p></p>
563<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 761<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
564</dt> 762</dt>
565<dd> 763<dd>
… …
641<p> 839<p>
642</p> 840</p>
643<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 841<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
644<p>This variable controls the verbosity level of the perl extension. Higher 842<p>This variable controls the verbosity level of the perl extension. Higher
645numbers indicate more verbose output.</p> 843numbers indicate more verbose output.</p>
646<ol> 844<dl>
647<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 845<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br />
648</li> 846</dt>
649<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 847<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br />
650</li> 848</dt>
651<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 849<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br />
850</dt>
652</li> 851</dl>
653</ol>
654<p> 852<p>
655</p> 853</p>
656<hr /> 854<hr />
657<h1><a name="author">AUTHOR</a></h1> 855<h1><a name="author">AUTHOR</a></h1>
658<pre> 856<pre>

Diff Legend

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