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.8 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.14 by root, Sat Jan 7 04:19:43 2006 UTC

… …
18 <ul> 18 <ul>
19 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> 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>
24 <li><a href="#rendition">RENDITION</a></li> 25 <li><a href="#rendition">RENDITION</a></li>
25 <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>
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>
… …
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>
… …
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 />
97</dt> 104</dt>
98<dd> 105<dd>
99Displays a digital clock using the built-in overlay. 106Displays a digital clock using the built-in overlay.
107</dd>
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.
100</dd> 121</dd>
101<p></p> 122<p></p>
102<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 />
103</dt> 124</dt>
104<dd> 125<dd>
… …
111</p> 132</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 133<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 134<p>All objects (such as terminals, time watchers etc.) are typical
114reference-to-hash objects. The hash can be used to store anything you 135reference-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 136like. 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 137<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 138modified).</p>
118<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
119emptied, 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
120the 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
121terminal 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>
122<p> 168<p>
123</p> 169</p>
124<h2><a name="hooks">Hooks</a></h2> 170<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 171<p>The following subroutines can be declared in extension files, and will be
126whenever the relevant event happens.</p> 172called whenever the relevant event happens.</p>
173<p>The first argument passed to them is an object private to each terminal
174and extension package. You can call all <code>urxvt::term</code> methods on it, but
175its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
176object that is shared between all packages is stored in the <code>term</code>
177member.</p>
127<p>All of them must return a boolean value. If it is true, then the event 178<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, 179counts 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> 180and 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> 181<p>When in doubt, return a false value (preferably <code>()</code>).</p>
131<dl> 182<dl>
132<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 />
133</dt> 184</dt>
134<dd> 185<dd>
135Called after a new terminal object has been initialized, but before 186Called after a new terminal object has been initialized, but before
136windows 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.
137</dd> 191</dd>
138<p></p> 192<p></p>
139<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 />
140</dt> 194</dt>
141<dd> 195<dd>
… …
172</dd> 226</dd>
173<dd> 227<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 228<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 229</dd>
176<p></p> 230<p></p>
231<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
232</dt>
233<dd>
234Called whenever the user tries to extend the selection (e.g. with a double
235click) and is either supposed to return false (normal operation), or
236should extend the selection itelf and return true to suppress the built-in
237processing.
238</dd>
239<dd>
240<p>See the <em>selection</em> example extension.</p>
241</dd>
242<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 243<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
178</dt> 244</dt>
179<dd> 245<dd>
180Called whenever the window gets the keyboard focus, before urxvt does 246Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing. 247focus in processing.
… …
211<p></p> 277<p></p>
212<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 278<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
213</dt> 279</dt>
214<dd> 280<dd>
215Called whenever the <code>program(s)</code> running in the urxvt window send output. 281Called whenever the <code>program(s)</code> running in the urxvt window send output.
282</dd>
283<p></p>
284<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
285</dt>
286<dd>
287Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
288operating system command) is processed. Cursor position and other state
289information is up-to-date when this happens. For interoperability, the
290string should start with the extension name and a colon, to distinguish
291it from commands for other extensions, and this might be enforced in the
292future.
293</dd>
294<dd>
295<p>Be careful not ever to trust (in a security sense) the data you receive,
296as its source can not easily be controleld (e-mail content, messages from
297other users on the same system etc.).</p>
298</dd>
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>
216</dd> 326</dd>
217<p></p> 327<p></p>
218<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 />
219</dt> 329</dt>
220<dd> 330<dd>
… …
235<dd> 345<dd>
236Called whenever the user presses a key combination that has a 346Called whenever the user presses a key combination that has a
237<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>
238resource in the <code>rxvt(1)</code> manpage). 348resource in the <code>rxvt(1)</code> manpage).
239</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>
377<p></p></dl>
378<p>
379</p>
380<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
381<dl>
382<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
383</dt>
384<dd>
385The current terminal. This variable stores the current <code>urxvt::term</code>
386object, whenever a callback/hook is executing.
387</dd>
240<p></p></dl> 388<p></p></dl>
241<p> 389<p>
242</p> 390</p>
243<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>
244<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>
245<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 />
246</dt> 404</dt>
247<dd> 405<dd>
248Fatally aborts execution with the given error message. Avoid at all 406Fatally aborts execution with the given error message. Avoid at all
249costs! The only time this is acceptable is when the terminal process 407costs! The only time this is acceptable is when the terminal process
… …
332<p></p></dl> 490<p></p></dl>
333<p> 491<p>
334</p> 492</p>
335<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>
336<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>
337<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 />
338</dt> 502</dt>
339<dd> 503<dd>
340Returns the current resource value associated with a given name and 504Returns the current resource value associated with a given name and
341optionally 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>
… …
365 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 529 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
366 borderLess color cursorBlink cursorUnderline cutchars delete_key 530 borderLess color cursorBlink cursorUnderline cutchars delete_key
367 display_name embed ext_bwidth fade font geometry hold iconName 531 display_name embed ext_bwidth fade font geometry hold iconName
368 imFont imLocale inputMethod insecure int_bwidth intensityStyles 532 imFont imLocale inputMethod insecure int_bwidth intensityStyles
369 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 533 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
370 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 534 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
371 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 535 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
372 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 536 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
373 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 537 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
374 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 538 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
375 shade term_name title transparent transparent_all tripleclickwords 539 shade term_name title transparent transparent_all tripleclickwords
376 utmpInhibit visualBell</pre> 540 utmpInhibit visualBell</pre>
377</dd> 541</dd>
378<p></p> 542<p></p>
543<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
544</dt>
545<dd>
546Return and optionally change the current rendition. Text that is output by
547the terminal application will use this style.
548</dd>
549<p></p>
550<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
551</dt>
552<dd>
553Return the current coordinates of the text cursor position and optionally
554set it (which is usually bad as applications don't expect that).
555</dd>
556<p></p>
379<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 557<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
380</dt> 558</dt>
381<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 559<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
382</dt> 560</dt>
383<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 561<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
402<dd> 580<dd>
403<p>#=item $term-&gt;overlay ($x, $y, $text) 581<p>#=item $term-&gt;overlay ($x, $y, $text)
404# 582#
405#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.
406# 584#
407#=cut</p> 585#=cut
408</dd> 586#
409<dd>
410<p>sub urxvt::term::scr_overlay { 587#sub urxvt::term::scr_overlay {
411die;
412 my ($self, $x, $y, $text) = @_;</p> 588# my ($self, $x, $y, $text) = @_;
413</dd> 589#
414<dd>
415<pre>
416 my @lines = split /\n/, $text;</pre> 590# my @lines = split /\n/, $text;
417</dd> 591#
418<dd>
419<pre>
420 my $w = 0; 592# my $w = 0;
421 for (map $self-&gt;strwidth ($_), @lines) { 593# for (map $self-&gt;strwidth ($_), @lines) {
422 $w = $_ if $w &lt; $_; 594# $w = $_ if $w &lt; $_;
423 }</pre> 595# }
424</dd> 596#
425<dd>
426<pre>
427 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines); 597# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
428 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 598# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
429}</pre> 599#}</p>
430</dd> 600</dd>
431<p></p> 601<p></p>
432<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 />
433</dt> 603</dt>
434<dd> 604<dd>
… …
447<dd> 617<dd>
448<p>This method returns an urxvt::overlay object. The overlay will be visible 618<p>This method returns an urxvt::overlay object. The overlay will be visible
449as long as the perl object is referenced.</p> 619as long as the perl object is referenced.</p>
450</dd> 620</dd>
451<dd> 621<dd>
452<p>Currently, the only method on the <code>urxvt::overlay</code> object is <a href="#item_set"><code>set</code></a>:</p> 622<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
453</dd> 623</dd>
454<p></p> 624<dl>
455<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 625<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
456</dt> 626</dt>
457<dd> 627<dd>
458Similar 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 628Similar 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
459text in rxvt-unicode's special encoding and an array of rendition values 629text in rxvt-unicode's special encoding and an array of rendition values
460at a specific position inside the overlay. 630at a specific position inside the overlay.
461</dd> 631</dd>
462<p></p> 632<p></p>
633<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
634</dt>
635<dd>
636If visible, hide the overlay, but do not destroy it.
637</dd>
638<p></p>
639<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
640</dt>
641<dd>
642If hidden, display the overlay again.
643</dd>
644<p></p></dl>
463<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 />
464</dt> 646</dt>
465<dd> 647<dd>
466Returns the number of screen-cells this string would need. Correctly 648Returns the number of screen-cells this string would need. Correctly
467accounts for wide and combining characters. 649accounts for wide and combining characters.
468</dd> 650</dd>
469<p></p> 651<p></p>
470<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 />
471</dt> 653</dt>
472<dd> 654<dd>
473Convert the given text string into the corresponding locale encoding. 655Convert the given text string into the corresponding locale encoding.
474</dd> 656</dd>
475<p></p> 657<p></p>
476<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 />
477</dt> 659</dt>
478<dd> 660<dd>
479Convert 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.
480</dd> 684</dd>
481<p></p> 685<p></p>
482<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 />
483</dt> 687</dt>
484<dd> 688<dd>
485Write 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
486pass characters instead of octets, you should convert your strings first 690pass characters instead of octets, you should convert your strings first
487to 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>.
488</dd> 692</dd>
489<p></p> 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.
704</dd>
705<p></p>
706<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
707</dt>
708<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
709</dt>
710<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
711</dt>
712<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
713</dt>
714<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
715</dt>
490<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 716<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
491</dt> 717</dt>
492<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 718<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
493</dt>
494<dd>
495Return the number of rows/columns of the terminal window (i.e. as
496specified by <code>-geometry</code>, excluding any scrollback).
497</dd> 719</dt>
498<p></p> 720<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
721</dt>
722<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
723</dt>
724<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
725</dt>
726<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
727</dt>
499<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 728<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
500</dt> 729</dt>
501<dd> 730<dd>
502Returns the number of lines in the scrollback buffer. 731Return various integers describing terminal characteristics.
503</dd> 732</dd>
504<p></p> 733<p></p>
505<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 734<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
506</dt> 735</dt>
507<dd> 736<dd>
… …
525</dt> 754</dt>
526<dd> 755<dd>
527Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 756Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
528is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 757is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
529terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 758terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
530line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. 759line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
760is requested.
531</dd> 761</dd>
532<dd> 762<dd>
533<p>If <code>$new_text</code> is specified, it will replace characters in the current 763<p>If <code>$new_text</code> is specified, it will replace characters in the current
534line, 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
535to 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
536automatically be updated.</p> 766automatically be updated.</p>
537</dd> 767</dd>
538<dd> 768<dd>
539<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
540than one cell when displayed are padded with urxvt::NOCHAR characters 770than one cell when displayed are padded with urxvt::NOCHAR characters
541(<code>chr 65535</code>). Characters with combining characters and other characters 771(<code>chr 65535</code>). Characters with combining characters and other characters
542that 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
543characters in the private use area.</p> 773characters in the private use area.</p>
544</dd> 774</dd>
… …
546<p>You have to obey this encoding when changing text. The advantage is 776<p>You have to obey this encoding when changing text. The advantage is
547that <code>substr</code> and similar functions work on screen cells and not on 777that <code>substr</code> and similar functions work on screen cells and not on
548characters.</p> 778characters.</p>
549</dd> 779</dd>
550<dd> 780<dd>
551<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> 781<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
552can be used to convert normal strings into this encoding and vice versa.</p> 782can be used to convert normal strings into this encoding and vice versa.</p>
553</dd> 783</dd>
554<p></p> 784<p></p>
555<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 785<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
556</dt> 786</dt>
… …
567</dd> 797</dd>
568<p></p> 798<p></p>
569<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 799<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
570</dt> 800</dt>
571<dd> 801<dd>
572Returns the number of screen cells that are in use (``the line length''). If 802Returns the number of screen cells that are in use (``the line
573it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which 803length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
574means all characters are in use and it is continued on the next row. 804line is joined with the following one.
805</dd>
806<p></p>
807<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
808</dt>
575</dd> 809<dd>
810Returns true if the row is part of a multiple-row logical ``line'' (i.e.
811joined with the following row), which means all characters are in use
812and it is continued on the next row (and possibly a continuation of the
813previous row(s)).
814</dd>
576<p></p> 815<p></p>
577<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 816<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
817</dt>
818<dd>
819Create and return a new <code>urxvt::line</code> object that stores information
820about the logical line that row <code>$row_number</code> is part of. It supports the
821following methods:
822</dd>
823<dl>
824<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
825</dt>
826<dd>
827Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
828</dd>
829<p></p>
830<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
831</dt>
832<dd>
833Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
834</dd>
835<p></p>
836<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
837</dt>
838<dd>
839Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
840</dd>
841<p></p>
842<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
843</dt>
844<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
845</dt>
846<dd>
847Return the row number of the first/last row of the line, respectively.
848</dd>
849<p></p>
850<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
851</dt>
852<dd>
853Returns the character offset of the given row|col pair within the logical
854line.
855</dd>
856<p></p>
857<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
858</dt>
859<dd>
860Translates a string offset into terminal coordinates again.
861</dd>
862<p></p></dl>
863<dt><strong>($row, $col) = $line-&gt;coord_of ($offset)
864=item $text = $term-&gt;special_encode $string</strong><br />
578</dt> 865</dt>
579<dd> 866<dd>
580Converts a perl string into the special encoding used by rxvt-unicode, 867Converts a perl string into the special encoding used by rxvt-unicode,
581where one character corresponds to one screen cell. See 868where one character corresponds to one screen cell. See
582<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 869<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
718<p> 1005<p>
719</p> 1006</p>
720<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1007<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
721<p>This variable controls the verbosity level of the perl extension. Higher 1008<p>This variable controls the verbosity level of the perl extension. Higher
722numbers indicate more verbose output.</p> 1009numbers indicate more verbose output.</p>
723<ol> 1010<dl>
724<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1011<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br />
725</li> 1012</dt>
726<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1013<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br />
727</li> 1014</dt>
728<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 1015<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br />
1016</dt>
729</li> 1017</dl>
730</ol>
731<p> 1018<p>
732</p> 1019</p>
733<hr /> 1020<hr />
734<h1><a name="author">AUTHOR</a></h1> 1021<h1><a name="author">AUTHOR</a></h1>
735<pre> 1022<pre>

Diff Legend

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