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.17 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.20 by root, Tue Jan 10 18:09:22 2006 UTC

… …
13<ul> 13<ul>
14 14
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 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <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> 25 <li><a href="#variables_in_the_urxvt_package">Variables 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> 26 <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> 27 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
… …
71thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
72<p>Each script will only ever be loaded once, even in rxvtd, where 74<p>Each script will only ever be loaded once, even in rxvtd, where
73scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
74<p> 76<p>
75</p> 77</p>
76<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
77<p>This section describes the extensiosn delivered with this version. You can 80<p>This section describes the extensions delivered with this release. You can
78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
79<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
80<pre> 83<pre>
81 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
82<dl> 85<dl>
83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
84</dt> 87</dt>
85<dd> 88<dd>
86Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
87the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click). Right now, it tries to
88urls and complete shell-quoted arguments, which is very convenient, too, 91select urls and complete shell-quoted arguments, which is very convenient,
89if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>.
90</dd>
91<dd> 93</dd>
94<dd>
92<p>It also offers the following bindable event:</p> 95<p>It also offers the following bindable keyboard command:</p>
93</dd> 96</dd>
94<dl> 97<dl>
95<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
96</dt> 99</dt>
97<dd> 100<dd>
… …
111<p></p> 114<p></p>
112<dt><strong>selection-popup (enabled by default)</strong><br /> 115<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt> 116</dt>
114<dd> 117<dd>
115Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
116text into various other formats/action. 119text into various other formats/action (such as uri unescaping, perl
120evalution, web-browser starting etc.), depending on content.
121</dd>
122<p></p>
123<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt>
125<dd>
126Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal
128input/output is suspended.
129</dd>
130<dd>
131<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
132<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns to the original position.</p>
117</dd> 135</dd>
118<p></p> 136<p></p>
119<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
120</dt> 138</dt>
121<dd> 139<dd>
… …
142Displays a very simple digital clock in the upper right corner of the 160Displays a very simple digital clock in the upper right corner of the
143window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
144overlays or changes. 162overlays or changes.
145</dd> 163</dd>
146<p></p></dl> 164<p></p></dl>
165<p>
166</p>
167<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
147<p> 169<p>
148</p> 170</p>
149<h2><a name="general_api_considerations">General API Considerations</a></h2> 171<h2><a name="general_api_considerations">General API Considerations</a></h2>
150<p>All objects (such as terminals, time watchers etc.) are typical 172<p>All objects (such as terminals, time watchers etc.) are typical
151reference-to-hash objects. The hash can be used to store anything you 173reference-to-hash objects. The hash can be used to store anything you
… …
181locale-specific way. 203locale-specific way.
182</dd> 204</dd>
183<p></p></dl> 205<p></p></dl>
184<p> 206<p>
185</p> 207</p>
208<h2><a name="extension_objects">Extension Objects</a></h2>
209<p>Very perl extension is a perl class. A separate perl object is created
210for each terminal and each extension and passed as the first parameter to
211hooks. So extensions can use their <code>$self</code> object without having to think
212about other extensions, with the exception of methods and members that
213begin with an underscore character <code>_</code>: these are reserved for internal
214use.</p>
215<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
216<code>urxvt::term</code> class on this object.</p>
217<p>It has the following methods and data members:</p>
218<dl>
219<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
220</dt>
221<dd>
222Returns the <code>urxvt::term</code> object associated with this instance of the
223extension. This member <em>must not</em> be changed in any way.
224</dd>
225<p></p>
226<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
227</dt>
228<dd>
229Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
230this extension, replacing any previous hook. This is useful when you want
231to overwrite time-critical hooks only temporarily.
232</dd>
233<p></p>
234<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
235</dt>
236<dd>
237Dynamically disable the given hooks.
238</dd>
239<p></p></dl>
240<p>
241</p>
186<h2><a name="hooks">Hooks</a></h2> 242<h2><a name="hooks">Hooks</a></h2>
187<p>The following subroutines can be declared in extension files, and will be 243<p>The following subroutines can be declared in extension files, and will be
188called whenever the relevant event happens.</p> 244called whenever the relevant event happens.</p>
189<p>The first argument passed to them is an object private to each terminal 245<p>The first argument passed to them is an extension oject as described in
190and extension package. You can call all <code>urxvt::term</code> methods on it, but 246the in the <code>Extension Objects</code> section.</p>
191its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
192object that is shared between all packages is stored in the <code>term</code>
193member. It is, however, blessed intot he package of the extension script,
194so for all practical purposes you can treat an extension script as a class.</p>
195<p>All of them must return a boolean value. If it is true, then the event 247<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
196counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 248event counts as being <em>consumed</em>, and the invocation of other hooks is
197and the relevant action might not be carried out by the C++ code.</p> 249skipped, and the relevant action might not be carried out by the C++ code.</p>
198<p>When in doubt, return a false value (preferably <code>()</code>).</p> 250<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
199<dl> 251<dl>
200<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 252<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
201</dt> 253</dt>
202<dd> 254<dd>
203Called after a new terminal object has been initialized, but before 255Called after a new terminal object has been initialized, but before
… …
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 354and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
303might be very slow, however, as your hook is called for <strong>all</strong> text being 355might be very slow, however, as your hook is called for <strong>all</strong> text being
304output. 356output.
305</dd> 357</dd>
306<p></p> 358<p></p>
359<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
360</dt>
361<dd>
362Called whenever some data is written to the tty/pty and can be used to
363suppress or filter tty input.
364</dd>
365<p></p>
307<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 366<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
308</dt> 367</dt>
309<dd> 368<dd>
310Called whenever a line was updated or changed. Can be used to filter 369Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines 370screen output (e.g. underline urls or other useless stuff). Only lines
… …
357<dd> 416<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does 417Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing. 418focus out processing.
360</dd> 419</dd>
361<p></p> 420<p></p>
362<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 421<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
363</dt> 422</dt>
364<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 423<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
365</dt> 424</dt>
366<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 425<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
367</dt> 426</dt>
368<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 427<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
369</dt> 428</dt>
… …
431that calls this function. 490that calls this function.
432</dd> 491</dd>
433<dd> 492<dd>
434<p>Using this function has the advantage that its output ends up in the 493<p>Using this function has the advantage that its output ends up in the
435correct place, e.g. on stderr of the connecting urxvtc client.</p> 494correct place, e.g. on stderr of the connecting urxvtc client.</p>
495</dd>
496<p></p>
497<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
498</dt>
499<dd>
500Returns true when it is safe to do potentially unsafe things, such as
501evaluating perl code specified by the user. This is true when urxvt was
502started setuid or setgid.
436</dd> 503</dd>
437<p></p> 504<p></p>
438<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 505<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
439</dt> 506</dt>
440<dd> 507<dd>
… …
592 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 659 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
593 shade term_name title transparent transparent_all tripleclickwords 660 shade term_name title transparent transparent_all tripleclickwords
594 utmpInhibit visualBell</pre> 661 utmpInhibit visualBell</pre>
595</dd> 662</dd>
596<p></p> 663<p></p>
664<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
665</dt>
666<dd>
667Adds a keymap translation exactly as specified via a resource. See the
668<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
669</dd>
670<p></p>
597<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 671<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
598</dt> 672</dt>
599<dd> 673<dd>
600Return and optionally change the current rendition. Text that is output by 674Return and optionally change the current rendition. Text that is output by
601the terminal application will use this style. 675the terminal application will use this style.
… …
629<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 703<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
630</dt> 704</dt>
631<dd> 705<dd>
632Return the current selection text and optionally replace it by <code>$newtext</code>. 706Return the current selection text and optionally replace it by <code>$newtext</code>.
633</dd> 707</dd>
708<p></p>
709<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
710</dt>
634<dd> 711<dd>
635<p>#=item $term-&gt;overlay ($x, $y, $text)
636#
637#Create a simple multi-line overlay box. See the next method for details. 712Create a simple multi-line overlay box. See the next method for details.
638#
639#=cut
640#
641#sub urxvt::term::scr_overlay {
642# my ($self, $x, $y, $text) = @_;
643#
644# my @lines = split /\n/, $text;
645#
646# my $w = 0;
647# for (map $self-&gt;strwidth ($_), @lines) {
648# $w = $_ if $w &lt; $_;
649# }
650#
651# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
652# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
653#}</p>
654</dd> 713</dd>
655<p></p> 714<p></p>
656<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 715<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
657</dt> 716</dt>
658<dd> 717<dd>
… …
719<p></p> 778<p></p>
720<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 779<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
721</dt> 780</dt>
722<dd> 781<dd>
723Convert the given locale-encoded octets into a perl string. 782Convert the given locale-encoded octets into a perl string.
783</dd>
784<p></p>
785<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
786</dt>
787<dd>
788XORs the rendition values in the given span with the provided value
789(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
790to the selection.
791</dd>
792<p></p>
793<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
794</dt>
795<dd>
796Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
797whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
798to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
799it instead.
800</dd>
801<p></p>
802<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
803</dt>
804<dd>
805Ring the bell!
724</dd> 806</dd>
725<p></p> 807<p></p>
726<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 808<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
727</dt> 809</dt>
728<dd> 810<dd>
… …
751Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 833Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
752pass characters instead of octets, you should convert your strings first 834pass characters instead of octets, you should convert your strings first
753to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 835to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
754</dd> 836</dd>
755<p></p> 837<p></p>
838<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
839</dt>
840<dd>
841Replaces the event mask of the pty watcher by the given event mask. Can
842be used to suppress input and output handling to the pty/tty. See the
843description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
844the previous value.
845</dd>
846<p></p>
756<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 847<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
757</dt> 848</dt>
758<dd> 849<dd>
759Return the window id of the toplevel window. 850Return the window id of the toplevel window.
760</dd> 851</dd>
… …
789</dt> 880</dt>
790<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 881<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
791</dt> 882</dt>
792<dd> 883<dd>
793Return various integers describing terminal characteristics. 884Return various integers describing terminal characteristics.
885</dd>
886<p></p>
887<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
888</dt>
889<dd>
890Returns the LC_CTYPE category string used by this rxvt-unicode.
891</dd>
892<p></p>
893<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
894</dt>
895<dd>
896Return the DISPLAY used by rxvt-unicode.
794</dd> 897</dd>
795<p></p> 898<p></p>
796<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 899<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
797</dt> 900</dt>
798<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 901<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
949</dd> 1052</dd>
950<p></p> 1053<p></p>
951<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1054<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
952</dt> 1055</dt>
953<dd> 1056<dd>
954Registers a synchronous button grab. See XGrabButton. 1057Registers a synchronous button grab. See the XGrabButton manpage.
955</dd> 1058</dd>
956<p></p> 1059<p></p>
957<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1060<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
958</dt> 1061</dt>
959<dd> 1062<dd>
… …
1064<pre> 1167<pre>
1065 $term-&gt;{socket} = ... 1168 $term-&gt;{socket} = ...
1066 $term-&gt;{iow} = urxvt::iow 1169 $term-&gt;{iow} = urxvt::iow
1067 -&gt;new 1170 -&gt;new
1068 -&gt;fd (fileno $term-&gt;{socket}) 1171 -&gt;fd (fileno $term-&gt;{socket})
1069 -&gt;events (1) # wait for read data 1172 -&gt;events (urxvt::EVENT_READ)
1070 -&gt;start 1173 -&gt;start
1071 -&gt;cb (sub { 1174 -&gt;cb (sub {
1072 my ($iow, $revents) = @_; 1175 my ($iow, $revents) = @_;
1073 # $revents must be 1 here, no need to check 1176 # $revents must be 1 here, no need to check
1074 sysread $term-&gt;{socket}, my $buf, 8192 1177 sysread $term-&gt;{socket}, my $buf, 8192
… …
1095</dd> 1198</dd>
1096<p></p> 1199<p></p>
1097<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1200<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1098</dt> 1201</dt>
1099<dd> 1202<dd>
1100Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1203Set the event mask to watch. The only allowed values are
1101data, Bit #1 (value <code>2</code>) enables watching for write data. 1204<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1205together, or <code>urxvt::EVENT_NONE</code>.
1102</dd> 1206</dd>
1103<p></p> 1207<p></p>
1104<dt><strong>$iow = $iow-&gt;start</strong><br /> 1208<dt><strong>$iow = $iow-&gt;start</strong><br />
1105</dt> 1209</dt>
1106<dd> 1210<dd>

Diff Legend

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