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.13 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.14 by root, Sat Jan 7 04:19:43 2006 UTC

… …
104</dt> 104</dt>
105<dd> 105<dd>
106Displays a digital clock using the built-in overlay. 106Displays a digital clock using the built-in overlay.
107</dd> 107</dd>
108<p></p> 108<p></p>
109<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
110</dt>
111<dd>
112Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
113</dd>
114<p></p>
115<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
116</dt>
117<dd>
118A not very useful example of filtering all text output to the terminal,
119by replacing all line-drawing characters (U+2500 .. U+259F) by a
120similar-looking ascii character.
121</dd>
122<p></p>
109<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 123<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
110</dt> 124</dt>
111<dd> 125<dd>
112Displays a very simple digital clock in the upper right corner of the 126Displays a very simple digital clock in the upper right corner of the
113window. Illustrates overwriting the refresh callbacks to create your own 127window. Illustrates overwriting the refresh callbacks to create your own
… …
124modified).</p> 138modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are 139<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 140emptied, 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 141the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p> 142terminal is destroyed.</p>
143<p>Argument names also often indicate the type of a parameter. Here are some
144hints on what they mean:</p>
145<dl>
146<dt><strong><a name="item__24text">$text</a></strong><br />
147</dt>
148<dd>
149Rxvt-unicodes special way of encoding text, where one ``unicode'' character
150always represents one screen cell. See <em>row_t</em> for a discussion of this format.
151</dd>
152<p></p>
153<dt><strong><a name="item__24string">$string</a></strong><br />
154</dt>
155<dd>
156A perl text string, with an emphasis on <em>text</em>. It can store all unicode
157characters and is to be distinguished with text encoded in a specific
158encoding (often locale-specific) and binary data.
159</dd>
160<p></p>
161<dt><strong><a name="item__24octets">$octets</a></strong><br />
162</dt>
163<dd>
164Either binary data or - more common - a text string encoded in a
165locale-specific way.
166</dd>
167<p></p></dl>
129<p> 168<p>
130</p> 169</p>
131<h2><a name="hooks">Hooks</a></h2> 170<h2><a name="hooks">Hooks</a></h2>
132<p>The following subroutines can be declared in loaded scripts, and will be 171<p>The following subroutines can be declared in extension files, and will be
133called whenever the relevant event happens.</p> 172called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal 173<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 174and 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> 175its 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> 176object that is shared between all packages is stored in the <code>term</code>
… …
143<dl> 182<dl>
144<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 183<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145</dt> 184</dt>
146<dd> 185<dd>
147Called after a new terminal object has been initialized, but before 186Called after a new terminal object has been initialized, but before
148windows are created or the command gets run. 187windows are created or the command gets run. Most methods are unsafe to
188call or deliver senseless data, as terminal size and other characteristics
189have not yet been determined. You can safely query and change resources,
190though.
149</dd> 191</dd>
150<p></p> 192<p></p>
151<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 193<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152</dt> 194</dt>
153<dd> 195<dd>
… …
253<p>Be careful not ever to trust (in a security sense) the data you receive, 295<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 296as its source can not easily be controleld (e-mail content, messages from
255other users on the same system etc.).</p> 297other users on the same system etc.).</p>
256</dd> 298</dd>
257<p></p> 299<p></p>
300<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
301</dt>
302<dd>
303Called whenever text is about to be output, with the text as argument. You
304can filter/change and output the text yourself by returning a true value
305and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
306might be very slow, however, as your hook is called for <strong>all</strong> text being
307output.
308</dd>
309<p></p>
310<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
311</dt>
312<dd>
313Called whenever a line was updated or changed. Can be used to filter
314screen output (e.g. underline urls or other useless stuff). Only lines
315that are being shown will be filtered, and, due to performance reasons,
316not always immediately.
317</dd>
318<dd>
319<p>The row number is always the topmost row of the line if the line spans
320multiple rows.</p>
321</dd>
322<dd>
323<p>Please note that, if you change the line, then the hook might get called
324later with the already-modified line (e.g. if unrelated parts change), so
325you cannot just toggle rendition bits, but only set them.</p>
326</dd>
327<p></p>
258<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 328<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
259</dt> 329</dt>
260<dd> 330<dd>
261Called just before the screen gets redrawn. Can be used for overlay 331Called just before the screen gets redrawn. Can be used for overlay
262or similar effects by modify terminal contents in refresh_begin, and 332or similar effects by modify terminal contents in refresh_begin, and
… …
275<dd> 345<dd>
276Called whenever the user presses a key combination that has a 346Called whenever the user presses a key combination that has a
277<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 347<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
278resource in the <code>rxvt(1)</code> manpage). 348resource in the <code>rxvt(1)</code> manpage).
279</dd> 349</dd>
350<p></p>
351<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
352</dt>
353<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
354</dt>
355<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
356</dt>
357<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
358</dt>
359<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
360</dt>
361<dd>
362Called whenever the corresponding X event is received for the terminal If
363the hook returns true, then the even will be ignored by rxvt-unicode.
364</dd>
365<dd>
366<p>The event is a hash with most values as named by Xlib (see the XEvent
367manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
368and column under the mouse cursor.</p>
369</dd>
370<dd>
371<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
372output, if any, in locale-specific encoding.</p>
373</dd>
374<dd>
375<p>subwindow.</p>
376</dd>
280<p></p></dl> 377<p></p></dl>
281<p> 378<p>
282</p> 379</p>
283<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 380<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
284<dl> 381<dl>
285<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 382<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
286</dt> 383</dt>
287<dd> 384<dd>
288The current terminal. Whenever a callback/Hook is bein executed, this 385The current terminal. This variable stores the current <code>urxvt::term</code>
289variable stores the current <code>urxvt::term</code> object. 386object, whenever a callback/hook is executing.
290</dd> 387</dd>
291<p></p></dl> 388<p></p></dl>
292<p> 389<p>
293</p> 390</p>
294<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 391<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
295<dl> 392<dl>
393<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
394</dt>
395<dd>
396Creates a new terminal, very similar as if you had started it with
397<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
398if the new instance couldn't be created. Returns <code>undef</code> if the new
399instance didn't initialise perl, and the terminal object otherwise. The
400<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
401</dd>
402<p></p>
296<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 403<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
297</dt> 404</dt>
298<dd> 405<dd>
299Fatally aborts execution with the given error message. Avoid at all 406Fatally aborts execution with the given error message. Avoid at all
300costs! The only time this is acceptable is when the terminal process 407costs! The only time this is acceptable is when the terminal process
… …
383<p></p></dl> 490<p></p></dl>
384<p> 491<p>
385</p> 492</p>
386<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 493<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
387<dl> 494<dl>
495<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
496</dt>
497<dd>
498Destroy the terminal object (close the window, free resources etc.).
499</dd>
500<p></p>
388<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 501<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
389</dt> 502</dt>
390<dd> 503<dd>
391Returns the current resource value associated with a given name and 504Returns the current resource value associated with a given name and
392optionally sets a new value. Setting values is most useful in the <code>init</code> 505optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
425 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 538 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
426 shade term_name title transparent transparent_all tripleclickwords 539 shade term_name title transparent transparent_all tripleclickwords
427 utmpInhibit visualBell</pre> 540 utmpInhibit visualBell</pre>
428</dd> 541</dd>
429<p></p> 542<p></p>
430<dt><strong><a name="item_screen_rstyle">$rend = $term-&gt;screen_rstyle ([$new_rstyle])</a></strong><br /> 543<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
431</dt> 544</dt>
432<dd> 545<dd>
433Return and optionally change the current rendition. Text thta is output by 546Return and optionally change the current rendition. Text that is output by
434the temrianl application will use this style. 547the terminal application will use this style.
435</dd> 548</dd>
436<p></p> 549<p></p>
437<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br /> 550<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
438</dt> 551</dt>
439<dd> 552<dd>
… …
467<dd> 580<dd>
468<p>#=item $term-&gt;overlay ($x, $y, $text) 581<p>#=item $term-&gt;overlay ($x, $y, $text)
469# 582#
470#Create a simple multi-line overlay box. See the next method for details. 583#Create a simple multi-line overlay box. See the next method for details.
471# 584#
472#=cut</p> 585#=cut
473</dd> 586#
474<dd>
475<p>sub urxvt::term::scr_overlay { 587#sub urxvt::term::scr_overlay {
476die;
477 my ($self, $x, $y, $text) = @_;</p> 588# my ($self, $x, $y, $text) = @_;
478</dd> 589#
479<dd>
480<pre>
481 my @lines = split /\n/, $text;</pre> 590# my @lines = split /\n/, $text;
482</dd> 591#
483<dd>
484<pre>
485 my $w = 0; 592# my $w = 0;
486 for (map $self-&gt;strwidth ($_), @lines) { 593# for (map $self-&gt;strwidth ($_), @lines) {
487 $w = $_ if $w &lt; $_; 594# $w = $_ if $w &lt; $_;
488 }</pre> 595# }
489</dd> 596#
490<dd>
491<pre>
492 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines); 597# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
493 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 598# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
494}</pre> 599#}</p>
495</dd> 600</dd>
496<p></p> 601<p></p>
497<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 602<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
498</dt> 603</dt>
499<dd> 604<dd>
… …
535</dt> 640</dt>
536<dd> 641<dd>
537If hidden, display the overlay again. 642If hidden, display the overlay again.
538</dd> 643</dd>
539<p></p></dl> 644<p></p></dl>
540<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 645<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
541</dt> 646</dt>
542<dd> 647<dd>
543Returns the number of screen-cells this string would need. Correctly 648Returns the number of screen-cells this string would need. Correctly
544accounts for wide and combining characters. 649accounts for wide and combining characters.
545</dd> 650</dd>
546<p></p> 651<p></p>
547<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 652<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
548</dt> 653</dt>
549<dd> 654<dd>
550Convert the given text string into the corresponding locale encoding. 655Convert the given text string into the corresponding locale encoding.
551</dd> 656</dd>
552<p></p> 657<p></p>
553<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 658<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
554</dt> 659</dt>
555<dd> 660<dd>
556Convert the given locale-encoded octets into a perl string. 661Convert the given locale-encoded octets into a perl string.
662</dd>
663<p></p>
664<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
665</dt>
666<dd>
667Write the given text string to the screen, as if output by the application
668running inside the terminal. It may not contain command sequences (escape
669codes), but is free to use line feeds, carriage returns and tabs. The
670string is a normal text string, not in locale-dependent encoding.
671</dd>
672<dd>
673<p>Normally its not a good idea to use this function, as programs might be
674confused by changes in cursor position or scrolling. Its useful inside a
675<code>on_add_lines</code> hook, though.</p>
676</dd>
677<p></p>
678<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
679</dt>
680<dd>
681Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
682locale-specific encoding of the terminal and can contain command sequences
683(escape codes) that will be interpreted.
557</dd> 684</dd>
558<p></p> 685<p></p>
559<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 686<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
560</dt> 687</dt>
561<dd> 688<dd>
562Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 689Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
563pass characters instead of octets, you should convert your strings first 690pass characters instead of octets, you should convert your strings first
564to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 691to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
692</dd>
693<p></p>
694<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
695</dt>
696<dd>
697Return the window id of the toplevel window.
698</dd>
699<p></p>
700<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
701</dt>
702<dd>
703Return the window id of the terminal window.
565</dd> 704</dd>
566<p></p> 705<p></p>
567<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 706<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
568</dt> 707</dt>
569<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 708<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
… …
625line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 764line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
626to replace only parts of a line. The font index in the rendition will 765to replace only parts of a line. The font index in the rendition will
627automatically be updated.</p> 766automatically be updated.</p>
628</dd> 767</dd>
629<dd> 768<dd>
630<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 769<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
631than one cell when displayed are padded with urxvt::NOCHAR characters 770than one cell when displayed are padded with urxvt::NOCHAR characters
632(<code>chr 65535</code>). Characters with combining characters and other characters 771(<code>chr 65535</code>). Characters with combining characters and other characters
633that do not fit into the normal tetx encoding will be replaced with 772that do not fit into the normal tetx encoding will be replaced with
634characters in the private use area.</p> 773characters in the private use area.</p>
635</dd> 774</dd>
… …
680Create and return a new <code>urxvt::line</code> object that stores information 819Create and return a new <code>urxvt::line</code> object that stores information
681about the logical line that row <code>$row_number</code> is part of. It supports the 820about the logical line that row <code>$row_number</code> is part of. It supports the
682following methods: 821following methods:
683</dd> 822</dd>
684<dl> 823<dl>
685<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 824<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
686</dt> 825</dt>
687<dd> 826<dd>
688Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 827Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
689</dd> 828</dd>
690<p></p> 829<p></p>
691<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 830<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
692</dt> 831</dt>
693<dd> 832<dd>
694Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 833Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
695</dd> 834</dd>
696<p></p> 835<p></p>
697<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 836<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
698</dt> 837</dt>
699<dd> 838<dd>

Diff Legend

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