ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/rxvt-unicode/doc/rxvtperl.3.html
Revision: 1.10
Committed: Tue Jan 3 23:41:37 2006 UTC (20 years, 9 months ago) by root
Content type: text/html
Branch: MAIN
Changes since 1.9: +12 -10 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2     <html xmlns="http://www.w3.org/1999/xhtml">
3     <head>
4     <title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>
5     <link rev="made" href="mailto:perl-binary@plan9.de" />
6     </head>
7    
8     <body style="background-color: white">
9    
10     <p><a name="__index__"></a></p>
11     <!-- INDEX BEGIN -->
12    
13     <ul>
14    
15     <li><a href="#name">NAME</a></li>
16     <li><a href="#synopsis">SYNOPSIS</a></li>
17     <li><a href="#description">DESCRIPTION</a></li>
18     <ul>
19    
20 root 1.7 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 root 1.3 <li><a href="#general_api_considerations">General API Considerations</a></li>
22 root 1.1 <li><a href="#hooks">Hooks</a></li>
23 root 1.9 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 root 1.1 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 root 1.8 <li><a href="#rendition">RENDITION</a></li>
26 root 1.1 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
27     <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
28     <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29     </ul>
30    
31 root 1.2 <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    
37 root 1.1 <li><a href="#author">AUTHOR</a></li>
38     </ul>
39     <!-- INDEX END -->
40    
41     <hr />
42     <p>
43     </p>
44 root 1.7 <hr />
45 root 1.1 <h1><a name="name">NAME</a></h1>
46     <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
47     <p>
48     </p>
49     <hr />
50     <h1><a name="synopsis">SYNOPSIS</a></h1>
51 root 1.5 <pre>
52     # create a file grab_test in $HOME:</pre>
53 root 1.1 <pre>
54     sub on_sel_grab {
55     warn &quot;you selected &quot;, $_[0]-&gt;selection;
56     ()
57     }</pre>
58     <pre>
59 root 1.5 # start a rxvt using it:</pre>
60     <pre>
61     rxvt --perl-lib $HOME -pe grab_test</pre>
62 root 1.1 <p>
63     </p>
64     <hr />
65     <h1><a name="description">DESCRIPTION</a></h1>
66 root 1.4 <p>Everytime a terminal object gets created, scripts specified via the
67 root 1.5 <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
69     thus must be encoded as UTF-8.</p>
70 root 1.3 <p>Each script will only ever be loaded once, even in rxvtd, where
71 root 1.7 scripts will be shared (but not enabled) for all terminals.</p>
72 root 1.3 <p>
73     </p>
74 root 1.7 <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2>
75 root 1.6 <p>This section describes the extensiosn delivered with this version. You can
76     find 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>
84 root 1.10 Intelligent selection. This extension tries to be more intelligent when
85     the user extends selections (double-click). Right now, it tries to select
86     urls and complete shell-quoted arguments, which is very convenient, too,
87     if your <em>ls</em> supports <code>--quoting-style=shell</code>.
88 root 1.9 </dd>
89     <dd>
90     <p>It also offers the following bindable event:</p>
91 root 1.6 </dd>
92     <dl>
93     <dt><strong><a name="item_rot13">rot13</a></strong><br />
94     </dt>
95     <dd>
96     Rot-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>
106 root 1.8 Displays a digital clock using the built-in overlay.
107 root 1.6 </dd>
108     <p></p>
109 root 1.8 <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
110 root 1.6 </dt>
111     <dd>
112 root 1.8 Displays a very simple digital clock in the upper right corner of the
113     window. Illustrates overwriting the refresh callbacks to create your own
114     overlays or changes.
115 root 1.6 </dd>
116     <p></p></dl>
117     <p>
118     </p>
119 root 1.3 <h2><a name="general_api_considerations">General API Considerations</a></h2>
120     <p>All objects (such as terminals, time watchers etc.) are typical
121     reference-to-hash objects. The hash can be used to store anything you
122     like. All members starting with an underscore (such as <code>_ptr</code> or
123 root 1.9 <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
124 root 1.3 modified).</p>
125     <p>When objects are destroyed on the C++ side, the perl object hashes are
126     emptied, so its best to store related objects such as time watchers and
127     the like inside the terminal object so they get destroyed as soon as the
128     terminal is destroyed.</p>
129 root 1.1 <p>
130     </p>
131     <h2><a name="hooks">Hooks</a></h2>
132 root 1.9 <p>The following subroutines can be declared in loaded scripts, and will be
133     called whenever the relevant event happens.</p>
134     <p>The first argument passed to them is an object private to each terminal
135     and extension package. You can call all <code>urxvt::term</code> methods on it, but
136     its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
137     object that is shared between all packages is stored in the <code>term</code>
138     member.</p>
139 root 1.1 <p>All of them must return a boolean value. If it is true, then the event
140     counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
141     and the relevant action might not be carried out by the C++ code.</p>
142     <p>When in doubt, return a false value (preferably <code>()</code>).</p>
143     <dl>
144     <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145     </dt>
146     <dd>
147     Called after a new terminal object has been initialized, but before
148     windows are created or the command gets run.
149     </dd>
150     <p></p>
151     <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152     </dt>
153     <dd>
154     Called after the screen is ``reset'' for any reason, such as resizing or
155     control sequences. Here is where you can react on changes to size-related
156     variables.
157     </dd>
158     <p></p>
159     <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
160     </dt>
161     <dd>
162     Called at the very end of initialisation of a new terminal, just before
163     returning to the mainloop.
164     </dd>
165     <p></p>
166     <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
167     </dt>
168     <dd>
169     Called whenever a selection has been made by the user, but before the
170     selection text is copied, so changes to the beginning, end or type of the
171     selection will be honored.
172     </dd>
173     <dd>
174     <p>Returning a true value aborts selection making by urxvt, in which case you
175     have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term-&gt;selection_grab</code></a>.</p>
176     </dd>
177     <p></p>
178     <dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br />
179     </dt>
180     <dd>
181     Called whenever a selection has been copied, but before the selection is
182     requested from the server. The selection text can be queried and changed
183     by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.
184     </dd>
185     <dd>
186     <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
187     </dd>
188     <p></p>
189 root 1.9 <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
190     </dt>
191     <dd>
192     Called whenever the user tries to extend the selection (e.g. with a double
193     click) and is either supposed to return false (normal operation), or
194     should extend the selection itelf and return true to suppress the built-in
195     processing.
196     </dd>
197     <dd>
198     <p>See the <em>selection</em> example extension.</p>
199     </dd>
200     <p></p>
201 root 1.1 <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
202     </dt>
203     <dd>
204     Called whenever the window gets the keyboard focus, before urxvt does
205     focus in processing.
206     </dd>
207     <p></p>
208     <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
209     </dt>
210     <dd>
211     Called wheneever the window loses keyboard focus, before urxvt does focus
212     out processing.
213     </dd>
214     <p></p>
215     <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
216     </dt>
217     <dd>
218     Called whenever the view offset changes, i..e the user or program
219     scrolls. Offset <code>0</code> means display the normal terminal, positive values
220     show this many lines of scrollback.
221     </dd>
222     <p></p>
223     <dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br />
224     </dt>
225     <dd>
226     Called whenever lines scroll out of the terminal area into the scrollback
227     buffer. <code>$lines</code> is the number of lines scrolled out and may be larger
228     than the scroll back buffer or the terminal.
229     </dd>
230     <dd>
231     <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
232     $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
233     number of lines that will be in the scrollback buffer.</p>
234     </dd>
235     <p></p>
236     <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
237     </dt>
238     <dd>
239     Called 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_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
243     </dt>
244     <dd>
245     Called just before the screen gets redrawn. Can be used for overlay
246     or similar effects by modify terminal contents in refresh_begin, and
247     restoring them in refresh_end. The built-in overlay and selection display
248     code is run after this hook, and takes precedence.
249     </dd>
250     <p></p>
251     <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
252     </dt>
253     <dd>
254     Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
255     </dd>
256 root 1.5 <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>
260     Called 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>
262     resource in the <code>rxvt(1)</code> manpage).
263     </dd>
264 root 1.1 <p></p></dl>
265     <p>
266     </p>
267 root 1.9 <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>
272     The current terminal. Whenever a callback/Hook is bein executed, this
273     variable stores the current <code>urxvt::term</code> object.
274     </dd>
275     <p></p></dl>
276     <p>
277     </p>
278 root 1.1 <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
279     <dl>
280     <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
281     </dt>
282     <dd>
283     Fatally aborts execution with the given error message. Avoid at all
284     costs! The only time this is acceptable is when the terminal process
285     starts up.
286     </dd>
287     <p></p>
288     <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
289     </dt>
290     <dd>
291 root 1.3 Calls <code>rxvt_warn</code> with the given string which should not include a
292 root 1.1 newline. The module also overwrites the <code>warn</code> builtin with a function
293     that calls this function.
294     </dd>
295     <dd>
296     <p>Using this function has the advantage that its output ends up in the
297     correct place, e.g. on stderr of the connecting urxvtc client.</p>
298     </dd>
299     <p></p>
300     <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
301     </dt>
302     <dd>
303     Returns the ``current time'' (as per the event loop).
304     </dd>
305     <p></p></dl>
306     <p>
307     </p>
308 root 1.8 <h2><a name="rendition">RENDITION</a></h2>
309     <p>Rendition bitsets contain information about colour, font, font styles and
310     similar information for each screen cell.</p>
311     <p>The following ``macros'' deal with changes in rendition sets. You should
312     never just create a bitset, you should always modify an existing one,
313     as they contain important information required for correct operation of
314     rxvt-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>
319     Returns the default rendition, as used when the terminal is starting up or
320     being 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>
326     Return 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>
332     Return the bit that enabled bold, italic, blink, reverse-video and
333     underline, respectively. To enable such a style, just logically OR it into
334     the 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>
342     Return 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>
350     Replace the foreground/background colour in the rendition mask with the
351     specified 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>
357     Return the ``custom'' value: Every rendition has 5 bits for use by
358     extensions. They can be set and changed as you like and are initially
359     zero.
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>
365     Change the custom value.
366     </dd>
367     <p></p></dl>
368     <p>
369     </p>
370 root 1.1 <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
371     <dl>
372 root 1.2 <dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
373     </dt>
374     <dd>
375     Returns the current resource value associated with a given name and
376     optionally sets a new value. Setting values is most useful in the <code>init</code>
377     hook. 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
381     before passing it to this method. Similarly, the returned value may need
382     to 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
386     as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
387     likely change).</p>
388     </dd>
389     <dd>
390     <p>Please note that resource strings will currently only be freed when the
391     terminal 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
395     are supported in every build, please see the source to see the actual
396     list:</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 root 1.4 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
405     mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
406 root 1.3 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 root 1.2 </dd>
413     <p></p>
414 root 1.1 <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>
421     Return the current values of the selection mark, begin or end positions,
422     and 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>
428     Try to request the primary selection from the server (for example, as set
429     by the next method).
430     </dd>
431     <p></p>
432 root 1.6 <dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
433 root 1.1 </dt>
434     <dd>
435     Return the current selection text and optionally replace it by <code>$newtext</code>.
436     </dd>
437     <dd>
438 root 1.8 <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 {
446     die;
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 root 1.1 </dd>
466     <p></p>
467 root 1.8 <dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
468 root 1.1 </dt>
469     <dd>
470     Create a new (empty) overlay at the given position with the given
471 root 1.8 width/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
476     around 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
480     right/bottom side, respectively.</p>
481 root 1.1 </dd>
482     <dd>
483 root 1.8 <p>This method returns an urxvt::overlay object. The overlay will be visible
484     as long as the perl object is referenced.</p>
485 root 1.1 </dd>
486     <dd>
487 root 1.9 <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
488 root 1.1 </dd>
489 root 1.9 <dl>
490 root 1.8 <dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
491 root 1.1 </dt>
492     <dd>
493 root 1.8 Similar 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
494     text in rxvt-unicode's special encoding and an array of rendition values
495     at a specific position inside the overlay.
496 root 1.1 </dd>
497 root 1.3 <p></p>
498 root 1.9 <dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
499     </dt>
500     <dd>
501     If 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>
507     If hidden, display the overlay again.
508     </dd>
509     <p></p></dl>
510 root 1.3 <dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br />
511     </dt>
512     <dd>
513     Returns the number of screen-cells this string would need. Correctly
514     accounts for wide and combining characters.
515     </dd>
516     <p></p>
517     <dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br />
518     </dt>
519     <dd>
520     Convert the given text string into the corresponding locale encoding.
521     </dd>
522     <p></p>
523     <dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br />
524     </dt>
525     <dd>
526     Convert the given locale-encoded octets into a perl string.
527     </dd>
528     <p></p>
529     <dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
530     </dt>
531     <dd>
532     Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
533 root 1.6 pass characters instead of octets, you should convert your strings first
534     to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
535     </dd>
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>
541     <dd>
542     Return the number of rows/columns of the terminal window (i.e. as
543     specified by <code>-geometry</code>, excluding any scrollback).
544     </dd>
545     <p></p>
546     <dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br />
547     </dt>
548     <dd>
549     Returns the number of lines in the scrollback buffer.
550     </dd>
551     <p></p>
552     <dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
553     </dt>
554     <dd>
555     Returns the negative row number of the topmost line. Minimum value is
556     <code>0</code>, which displays the normal terminal contents. Larger values scroll
557     this many lines into the scrollback buffer.
558     </dd>
559     <p></p>
560     <dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
561     </dt>
562     <dd>
563     Requests a screen refresh. At the next opportunity, rxvt-unicode will
564     compare the on-screen display with its stored representation. If they
565     differ, it redraws the differences.
566     </dd>
567     <dd>
568     <p>Used after changing terminal contents to display them.</p>
569     </dd>
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>
574     Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
575     is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
576     terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
577 root 1.9 line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
578     is requested.
579 root 1.6 </dd>
580     <dd>
581     <p>If <code>$new_text</code> is specified, it will replace characters in the current
582     line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
583 root 1.8 to replace only parts of a line. The font index in the rendition will
584 root 1.6 automatically be updated.</p>
585     </dd>
586     <dd>
587     <p><code>$text</code> is in a special encoding: tabs and wide characters that use more
588     than one cell when displayed are padded with urxvt::NOCHAR characters
589     (<code>chr 65535</code>). Characters with combining characters and other characters
590     that do not fit into the normal tetx encoding will be replaced with
591     characters in the private use area.</p>
592     </dd>
593     <dd>
594     <p>You have to obey this encoding when changing text. The advantage is
595     that <code>substr</code> and similar functions work on screen cells and not on
596     characters.</p>
597     </dd>
598     <dd>
599 root 1.9 <p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
600 root 1.6 can 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>
606     Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
607     bitsets. Rendition bitsets contain information about colour, font, font
608     styles 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 root 1.8 <p>See the section on RENDITION, above.</p>
615 root 1.6 </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>
620 root 1.9 Returns the number of screen cells that are in use (``the line
621     length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
622     line 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>
628     Returns true if the row is part of a multiple-row logical ``line'' (i.e.
629     joined with the following row), which means all characters are in use
630     and it is continued on the next row (and possibly a continuation of the
631     previous row(s)).
632 root 1.6 </dd>
633     <p></p>
634 root 1.9 <dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
635     </dt>
636     <dd>
637     Create and return a new <code>urxvt::line</code> object that stores information
638     about the logical line that row <code>$row_number</code> is part of. It supports the
639     following methods:
640     </dd>
641     <dl>
642     <dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br />
643     </dt>
644     <dd>
645     Returns 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>
651     Returns 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>
657     Returns 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>
665     Return 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>
671     Returns the character offset of the given row|col pair within the logical
672     line.
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>
678     Translates 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 root 1.6 </dt>
684     <dd>
685     Converts a perl string into the special encoding used by rxvt-unicode,
686     where 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>
693     Converts rxvt-unicodes text reprsentation into a perl string. See
694     <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
695     </dd>
696     <p></p></dl>
697     <p>
698     </p>
699 root 1.1 <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
700     <p>This class implements timer watchers/events. Time is represented as a
701     fractional number of seconds since the epoch. Example:</p>
702     <pre>
703 root 1.8 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
704 root 1.1 $term-&gt;{timer} = urxvt::timer
705     -&gt;new
706 root 1.8 -&gt;interval (1)
707 root 1.1 -&gt;cb (sub {
708 root 1.8 $term-&gt;{overlay}-&gt;set (0, 0,
709     sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
710 root 1.1 });</pre>
711     <dl>
712     <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
713     </dt>
714     <dd>
715 root 1.8 Create a new timer object in started state. It is scheduled to fire
716     immediately.
717 root 1.1 </dd>
718     <p></p>
719     <dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
720     </dt>
721     <dd>
722     Set the callback to be called when the timer triggers.
723     </dd>
724     <p></p>
725     <dt><strong><a name="item_at">$tstamp = $timer-&gt;at</a></strong><br />
726     </dt>
727     <dd>
728     Return the time this watcher will fire next.
729     </dd>
730     <p></p>
731 root 1.8 <dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
732 root 1.1 </dt>
733     <dd>
734     Set the time the event is generated to $tstamp.
735     </dd>
736     <p></p>
737 root 1.8 <dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
738     </dt>
739     <dd>
740     Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
741     stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
742     is automatically rescheduled at the given intervals.
743     </dd>
744     <p></p>
745 root 1.1 <dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
746     </dt>
747     <dd>
748     Start the timer.
749     </dd>
750     <p></p>
751     <dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
752     </dt>
753     <dd>
754     Set the event trigger time to <code>$tstamp</code> and start the timer.
755     </dd>
756     <p></p>
757     <dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
758     </dt>
759     <dd>
760     Stop the timer.
761     </dd>
762     <p></p></dl>
763     <p>
764     </p>
765     <h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2>
766     <p>This class implements io watchers/events. Example:</p>
767     <pre>
768     $term-&gt;{socket} = ...
769     $term-&gt;{iow} = urxvt::iow
770     -&gt;new
771     -&gt;fd (fileno $term-&gt;{socket})
772     -&gt;events (1) # wait for read data
773     -&gt;start
774     -&gt;cb (sub {
775     my ($iow, $revents) = @_;
776     # $revents must be 1 here, no need to check
777     sysread $term-&gt;{socket}, my $buf, 8192
778     or end-of-file;
779     });</pre>
780     <dl>
781     <dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br />
782     </dt>
783     <dd>
784     Create a new io watcher object in stopped state.
785     </dd>
786     <p></p>
787     <dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br />
788     </dt>
789     <dd>
790     Set the callback to be called when io events are triggered. <code>$reventmask</code>
791     is a bitset as described in the <a href="#item_events"><code>events</code></a> method.
792     </dd>
793     <p></p>
794     <dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong><br />
795     </dt>
796     <dd>
797     Set the filedescriptor (not handle) to watch.
798     </dd>
799     <p></p>
800     <dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
801     </dt>
802     <dd>
803     Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read
804     data, Bit #1 (value <code>2</code>) enables watching for write data.
805     </dd>
806     <p></p>
807     <dt><strong>$iow = $iow-&gt;start</strong><br />
808     </dt>
809     <dd>
810     Start watching for requested events on the given handle.
811     </dd>
812     <p></p>
813     <dt><strong>$iow = $iow-&gt;stop</strong><br />
814     </dt>
815     <dd>
816     Stop watching for events on the given filehandle.
817     </dd>
818     <p></p></dl>
819     <p>
820     </p>
821     <hr />
822 root 1.2 <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
827     numbers indicate more verbose output.</p>
828 root 1.10 <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 root 1.2 <p>
837     </p>
838     <hr />
839 root 1.1 <h1><a name="author">AUTHOR</a></h1>
840     <pre>
841     Marc Lehmann &lt;pcg@goof.com&gt;
842     <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre>
843    
844     </body>
845    
846     </html>