ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.1 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.13 by root, Wed Jan 4 21:37:55 2006 UTC

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

Diff Legend

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