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.1 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.10 by root, Tue Jan 3 23:41:37 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>
20 <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>
21 <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>
22 <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>
23 <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>
24 <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>
25 </ul> 29 </ul>
26 30
31 <li><a href="#environment">ENVIRONMENT</a></li>
32 <ul>
33
34 <li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li>
35 </ul>
36
27 <li><a href="#author">AUTHOR</a></li> 37 <li><a href="#author">AUTHOR</a></li>
28</ul> 38</ul>
29<!-- INDEX END --> 39<!-- INDEX END -->
30 40
31<hr /> 41<hr />
32<p> 42<p>
33</p> 43</p>
44<hr />
34<h1><a name="name">NAME</a></h1> 45<h1><a name="name">NAME</a></h1>
35<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 46<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
36<p> 47<p>
37</p> 48</p>
38<hr /> 49<hr />
39<h1><a name="synopsis">SYNOPSIS</a></h1> 50<h1><a name="synopsis">SYNOPSIS</a></h1>
40<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 51<pre>
41<p>* Each script will only be loaded once, even in urxvtd, and will be valid 52 # create a file grab_test in $HOME:</pre>
42globally.</p>
43<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
44thus must be encoded as UTF-8.</p>
45<pre> 53<pre>
46 sub on_sel_grab { 54 sub on_sel_grab {
47 warn &quot;you selected &quot;, $_[0]-&gt;selection; 55 warn &quot;you selected &quot;, $_[0]-&gt;selection;
48 () 56 ()
49 }</pre> 57 }</pre>
50<pre> 58<pre>
51 1</pre> 59 # start a rxvt using it:</pre>
60<pre>
61 rxvt --perl-lib $HOME -pe grab_test</pre>
52<p> 62<p>
53</p> 63</p>
54<hr /> 64<hr />
55<h1><a name="description">DESCRIPTION</a></h1> 65<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the
67<code>perl</code> resource are loaded and associated with it.</p>
68<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p>
72<p>
73</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2>
75<p>This section describes the extensiosn delivered with this version. You can
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p>
78<pre>
79 rxvt -pe &lt;extensionname&gt;</pre>
80<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br />
82</dt>
83<dd>
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>
91</dd>
92<dl>
93<dt><strong><a name="item_rot13">rot13</a></strong><br />
94</dt>
95<dd>
96Rot-13 the selection when activated. Used via keyboard trigger:
97</dd>
98<dd>
99<pre>
100 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
101</dd>
102<p></p></dl>
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 />
110</dt>
111<dd>
112Displays a very simple digital clock in the upper right corner of the
113window. Illustrates overwriting the refresh callbacks to create your own
114overlays or changes.
115</dd>
116<p></p></dl>
117<p>
118</p>
119<h2><a name="general_api_considerations">General API Considerations</a></h2>
120<p>All objects (such as terminals, time watchers etc.) are typical
121reference-to-hash objects. The hash can be used to store anything you
122like. All members starting with an underscore (such as <code>_ptr</code> or
123<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
124modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are
126emptied, so its best to store related objects such as time watchers and
127the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p>
56<p> 129<p>
57</p> 130</p>
58<h2><a name="hooks">Hooks</a></h2> 131<h2><a name="hooks">Hooks</a></h2>
59<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
60whenever 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>
61<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
62counts 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,
63and 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>
64<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>
65<dl> 143<dl>
… …
106</dd> 184</dd>
107<dd> 185<dd>
108<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>
109</dd> 187</dd>
110<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>
111<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 />
112</dt> 202</dt>
113<dd> 203<dd>
114Called whenever the window gets the keyboard focus, before urxvt does 204Called whenever the window gets the keyboard focus, before urxvt does
115focus in processing. 205focus in processing.
… …
161<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 251<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
162</dt> 252</dt>
163<dd> 253<dd>
164Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 254Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
165</dd> 255</dd>
256<p></p>
257<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
258</dt>
259<dd>
260Called whenever the user presses a key combination that has a
261<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
262resource in the <code>rxvt(1)</code> manpage).
263</dd>
264<p></p></dl>
265<p>
266</p>
267<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
268<dl>
269<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
270</dt>
271<dd>
272The current terminal. Whenever a callback/Hook is bein executed, this
273variable stores the current <code>urxvt::term</code> object.
274</dd>
166<p></p></dl> 275<p></p></dl>
167<p> 276<p>
168</p> 277</p>
169<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 278<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
170<dl> 279<dl>
… …
177</dd> 286</dd>
178<p></p> 287<p></p>
179<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> 288<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
180</dt> 289</dt>
181<dd> 290<dd>
182Calls <code>rxvt_warn</code> witht eh given string which should not include a 291Calls <code>rxvt_warn</code> with the given string which should not include a
183newline. The module also overwrites the <code>warn</code> builtin with a function 292newline. The module also overwrites the <code>warn</code> builtin with a function
184that calls this function. 293that calls this function.
185</dd> 294</dd>
186<dd> 295<dd>
187<p>Using this function has the advantage that its output ends up in the 296<p>Using this function has the advantage that its output ends up in the
188correct place, e.g. on stderr of the connecting urxvtc client.</p> 297correct place, e.g. on stderr of the connecting urxvtc client.</p>
189</dd> 298</dd>
190<p></p> 299<p></p>
191<dt><strong><a name="item__24cellwidth__3d_urxvt_3a_3awcswidth__24string">$cellwidth = urxvt::wcswidth $string</a></strong><br /> 300<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
301</dt>
302<dd>
303Returns the ``current time'' (as per the event loop).
304</dd>
305<p></p></dl>
306<p>
307</p>
308<h2><a name="rendition">RENDITION</a></h2>
309<p>Rendition bitsets contain information about colour, font, font styles and
310similar information for each screen cell.</p>
311<p>The following ``macros'' deal with changes in rendition sets. You should
312never just create a bitset, you should always modify an existing one,
313as they contain important information required for correct operation of
314rxvt-unicode.</p>
315<dl>
316<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
317</dt>
318<dd>
319Returns the default rendition, as used when the terminal is starting up or
320being reset. Useful as a base to start when creating renditions.
321</dd>
322<p></p>
323<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
324</dt>
325<dd>
326Return the rendition mask used for overlays by default.
327</dd>
328<p></p>
329<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 />
330</dt>
331<dd>
332Return the bit that enabled bold, italic, blink, reverse-video and
333underline, respectively. To enable such a style, just logically OR it into
334the bitset.
335</dd>
336<p></p>
337<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
338</dt>
339<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
340</dt>
341<dd>
342Return the foreground/background colour index, respectively.
343</dd>
344<p></p>
345<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br />
346</dt>
347<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br />
348</dt>
349<dd>
350Replace the foreground/background colour in the rendition mask with the
351specified one.
352</dd>
353<p></p>
354<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br />
355</dt>
356<dd>
357Return the ``custom'' value: Every rendition has 5 bits for use by
358extensions. They can be set and changed as you like and are initially
359zero.
360</dd>
361<p></p>
362<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br />
363</dt>
364<dd>
365Change the custom value.
366</dd>
367<p></p></dl>
368<p>
369</p>
370<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
371<dl>
372<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
373</dt>
374<dd>
375Returns the current resource value associated with a given name and
376optionally sets a new value. Setting values is most useful in the <code>init</code>
377hook. Unset resources are returned and accepted as <code>undef</code>.
378</dd>
379<dd>
380<p>The new value must be properly encoded to a suitable character encoding
381before passing it to this method. Similarly, the returned value may need
382to be converted from the used encoding to text.</p>
383</dd>
384<dd>
385<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
386as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
387likely change).</p>
388</dd>
389<dd>
390<p>Please note that resource strings will currently only be freed when the
391terminal is destroyed, so changing options frequently will eat memory.</p>
392</dd>
393<dd>
394<p>Here is a a likely non-exhaustive list of resource names, not all of which
395are supported in every build, please see the source to see the actual
396list:</p>
397</dd>
398<dd>
399<pre>
400 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
401 borderLess color cursorBlink cursorUnderline cutchars delete_key
402 display_name embed ext_bwidth fade font geometry hold iconName
403 imFont imLocale inputMethod insecure int_bwidth intensityStyles
404 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
405 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
406 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
407 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
408 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
409 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
410 shade term_name title transparent transparent_all tripleclickwords
411 utmpInhibit visualBell</pre>
412</dd>
413<p></p>
414<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
415</dt>
416<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
417</dt>
418<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
419</dt>
420<dd>
421Return the current values of the selection mark, begin or end positions,
422and optionally set them to new values.
423</dd>
424<p></p>
425<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
426</dt>
427<dd>
428Try to request the primary selection from the server (for example, as set
429by the next method).
430</dd>
431<p></p>
432<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
433</dt>
434<dd>
435Return the current selection text and optionally replace it by <code>$newtext</code>.
436</dd>
437<dd>
438<p>#=item $term-&gt;overlay ($x, $y, $text)
439#
440#Create a simple multi-line overlay box. See the next method for details.
441#
442#=cut</p>
443</dd>
444<dd>
445<p>sub urxvt::term::scr_overlay {
446die;
447 my ($self, $x, $y, $text) = @_;</p>
448</dd>
449<dd>
450<pre>
451 my @lines = split /\n/, $text;</pre>
452</dd>
453<dd>
454<pre>
455 my $w = 0;
456 for (map $self-&gt;strwidth ($_), @lines) {
457 $w = $_ if $w &lt; $_;
458 }</pre>
459</dd>
460<dd>
461<pre>
462 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
463 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
464}</pre>
465</dd>
466<p></p>
467<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
468</dt>
469<dd>
470Create a new (empty) overlay at the given position with the given
471width/height. <code>$rstyle</code> defines the initial rendition style
472(default: <code>OVERLAY_RSTYLE</code>).
473</dd>
474<dd>
475<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
476around the box.</p>
477</dd>
478<dd>
479<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
480right/bottom side, respectively.</p>
481</dd>
482<dd>
483<p>This method returns an urxvt::overlay object. The overlay will be visible
484as long as the perl object is referenced.</p>
485</dd>
486<dd>
487<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
488</dd>
489<dl>
490<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
491</dt>
492<dd>
493Similar 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
494text in rxvt-unicode's special encoding and an array of rendition values
495at a specific position inside the overlay.
496</dd>
497<p></p>
498<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
499</dt>
500<dd>
501If visible, hide the overlay, but do not destroy it.
502</dd>
503<p></p>
504<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
505</dt>
506<dd>
507If hidden, display the overlay again.
508</dd>
509<p></p></dl>
510<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br />
192</dt> 511</dt>
193<dd> 512<dd>
194Returns the number of screen-cells this string would need. Correctly 513Returns the number of screen-cells this string would need. Correctly
195accounts for wide and combining characters. 514accounts for wide and combining characters.
196</dd> 515</dd>
197<p></p> 516<p></p>
198<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 517<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br />
199</dt> 518</dt>
200<dd>
201Returns the ``current time'' (as per the event loop).
202</dd> 519<dd>
203<p></p></dl> 520Convert the given text string into the corresponding locale encoding.
204<p>
205</p>
206<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
207<dl>
208<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
209</dt>
210<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
211</dt>
212<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
213</dt>
214<dd> 521</dd>
215Return the current values of the selection mark, begin or end positions, 522<p></p>
216and optionally set them to new values. 523<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br />
524</dt>
217</dd> 525<dd>
218<p></p> 526Convert the given locale-encoded octets into a perl string.
219<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
220</dt>
221<dd> 527</dd>
222Try to request the primary selection from the server (for example, as set 528<p></p>
223by the next method). 529<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
530</dt>
224</dd> 531<dd>
225<p></p> 532Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
226<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 533pass characters instead of octets, you should convert your strings first
227</dt> 534to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
228<dd> 535</dd>
229Return the current selection text and optionally replace it by <code>$newtext</code>. 536<p></p>
537<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br />
538</dt>
539<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br />
540</dt>
230</dd> 541<dd>
231<p></p> 542Return the number of rows/columns of the terminal window (i.e. as
232<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 543specified by <code>-geometry</code>, excluding any scrollback).
233</dt>
234<dd> 544</dd>
235Create a simple multi-line overlay box. See the next method for details. 545<p></p>
546<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br />
547</dt>
236</dd> 548<dd>
237<p></p> 549Returns the number of lines in the scrollback buffer.
238<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br />
239</dt>
240<dd> 550</dd>
241Create a new (empty) overlay at the given position with the given 551<p></p>
242width/height. A border will be put around the box. If either <code>$x</code> or 552<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
243<code>$y</code> is negative, then this is counted from the right/bottom side, 553</dt>
244respectively.
245</dd> 554<dd>
246<p></p> 555Returns the negative row number of the topmost line. Minimum value is
247<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br /> 556<code>0</code>, which displays the normal terminal contents. Larger values scroll
248</dt> 557this many lines into the scrollback buffer.
249<dd> 558</dd>
250Switch the overlay off again. 559<p></p>
560<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
561</dt>
251</dd> 562<dd>
252<p></p> 563Requests a screen refresh. At the next opportunity, rxvt-unicode will
253<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 564compare the on-screen display with its stored representation. If they
254</dt> 565differ, it redraws the differences.
255<dd> 566</dd>
256Put a single character (specified numerically) at the given overlay
257position.
258</dd> 567<dd>
259<p></p> 568<p>Used after changing terminal contents to display them.</p>
260<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br />
261</dt>
262<dd> 569</dd>
263Write a string at the given position into the overlay. 570<p></p>
571<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
572</dt>
573<dd>
574Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
575is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
576terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
577line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
578is requested.
579</dd>
580<dd>
581<p>If <code>$new_text</code> is specified, it will replace characters in the current
582line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
583to replace only parts of a line. The font index in the rendition will
584automatically be updated.</p>
585</dd>
586<dd>
587<p><code>$text</code> is in a special encoding: tabs and wide characters that use more
588than one cell when displayed are padded with urxvt::NOCHAR characters
589(<code>chr 65535</code>). Characters with combining characters and other characters
590that do not fit into the normal tetx encoding will be replaced with
591characters in the private use area.</p>
592</dd>
593<dd>
594<p>You have to obey this encoding when changing text. The advantage is
595that <code>substr</code> and similar functions work on screen cells and not on
596characters.</p>
597</dd>
598<dd>
599<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
600can be used to convert normal strings into this encoding and vice versa.</p>
601</dd>
602<p></p>
603<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
604</dt>
605<dd>
606Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
607bitsets. Rendition bitsets contain information about colour, font, font
608styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
609</dd>
610<dd>
611<p>When setting rendition, the font mask will be ignored.</p>
612</dd>
613<dd>
614<p>See the section on RENDITION, above.</p>
615</dd>
616<p></p>
617<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
618</dt>
619<dd>
620Returns the number of screen cells that are in use (``the line
621length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
622line is joined with the following one.
623</dd>
624<p></p>
625<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
626</dt>
627<dd>
628Returns true if the row is part of a multiple-row logical ``line'' (i.e.
629joined with the following row), which means all characters are in use
630and it is continued on the next row (and possibly a continuation of the
631previous row(s)).
632</dd>
633<p></p>
634<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
635</dt>
636<dd>
637Create and return a new <code>urxvt::line</code> object that stores information
638about the logical line that row <code>$row_number</code> is part of. It supports the
639following methods:
640</dd>
641<dl>
642<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br />
643</dt>
644<dd>
645Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
646</dd>
647<p></p>
648<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br />
649</dt>
650<dd>
651Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
652</dd>
653<p></p>
654<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
655</dt>
656<dd>
657Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
658</dd>
659<p></p>
660<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
661</dt>
662<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
663</dt>
664<dd>
665Return the row number of the first/last row of the line, respectively.
666</dd>
667<p></p>
668<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
669</dt>
670<dd>
671Returns the character offset of the given row|col pair within the logical
672line.
673</dd>
674<p></p>
675<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
676</dt>
677<dd>
678Translates a string offset into terminal coordinates again.
679</dd>
680<p></p></dl>
681<dt><strong>($row, $col) = $line-&gt;coord_of ($offset)
682=item $text = $term-&gt;special_encode $string</strong><br />
683</dt>
684<dd>
685Converts a perl string into the special encoding used by rxvt-unicode,
686where one character corresponds to one screen cell. See
687<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
688</dd>
689<p></p>
690<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
691</dt>
692<dd>
693Converts rxvt-unicodes text reprsentation into a perl string. See
694<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
264</dd> 695</dd>
265<p></p></dl> 696<p></p></dl>
266<p> 697<p>
267</p> 698</p>
268<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 699<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
269<p>This class implements timer watchers/events. Time is represented as a 700<p>This class implements timer watchers/events. Time is represented as a
270fractional number of seconds since the epoch. Example:</p> 701fractional number of seconds since the epoch. Example:</p>
271<pre> 702<pre>
272 # create a digital clock display in upper right corner 703 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
273 $term-&gt;{timer} = urxvt::timer 704 $term-&gt;{timer} = urxvt::timer
274 -&gt;new 705 -&gt;new
275 -&gt;start (urxvt::NOW) 706 -&gt;interval (1)
276 -&gt;cb (sub { 707 -&gt;cb (sub {
277 my ($timer) = @_;
278 my $time = $timer-&gt;at;
279 $timer-&gt;start ($time + 1);
280 $self-&gt;scr_overlay (-1, 0, 708 $term-&gt;{overlay}-&gt;set (0, 0,
281 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 709 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
282 });</pre> 710 });</pre>
283<dl> 711<dl>
284<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 712<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
285</dt> 713</dt>
286<dd> 714<dd>
287Create a new timer object in stopped state. 715Create a new timer object in started state. It is scheduled to fire
716immediately.
288</dd> 717</dd>
289<p></p> 718<p></p>
290<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 719<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
291</dt> 720</dt>
292<dd> 721<dd>
… …
297</dt> 726</dt>
298<dd> 727<dd>
299Return the time this watcher will fire next. 728Return the time this watcher will fire next.
300</dd> 729</dd>
301<p></p> 730<p></p>
302<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 731<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
303</dt> 732</dt>
304<dd> 733<dd>
305Set the time the event is generated to $tstamp. 734Set the time the event is generated to $tstamp.
735</dd>
736<p></p>
737<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
738</dt>
739<dd>
740Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
741stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
742is automatically rescheduled at the given intervals.
306</dd> 743</dd>
307<p></p> 744<p></p>
308<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 745<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
309</dt> 746</dt>
310<dd> 747<dd>
… …
380</dd> 817</dd>
381<p></p></dl> 818<p></p></dl>
382<p> 819<p>
383</p> 820</p>
384<hr /> 821<hr />
822<h1><a name="environment">ENVIRONMENT</a></h1>
823<p>
824</p>
825<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
826<p>This variable controls the verbosity level of the perl extension. Higher
827numbers indicate more verbose output.</p>
828<dl>
829<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br />
830</dt>
831<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br />
832</dt>
833<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br />
834</dt>
835</dl>
836<p>
837</p>
838<hr />
385<h1><a name="author">AUTHOR</a></h1> 839<h1><a name="author">AUTHOR</a></h1>
386<pre> 840<pre>
387 Marc Lehmann &lt;pcg@goof.com&gt; 841 Marc Lehmann &lt;pcg@goof.com&gt;
388 <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> 842 <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre>
389 843

Diff Legend

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