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.22 by root, Wed Jan 11 01:00:03 2006 UTC vs.
Revision 1.29 by root, Fri Jan 13 12:40:46 2006 UTC

1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml"> 2<html xmlns="http://www.w3.org/1999/xhtml">
3<head> 3<head>
4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> 4<title>urxvtperl - rxvt-unicode's embedded perl interpreter</title>
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 5<link rev="made" href="mailto:perl-binary@plan9.de" />
6</head> 6</head>
7 7
8<body style="background-color: white"> 8<body style="background-color: white">
9 9
… …
45<hr /> 45<hr />
46<p> 46<p>
47</p> 47</p>
48<hr /> 48<hr />
49<h1><a name="name">NAME</a></h1> 49<h1><a name="name">NAME</a></h1>
50<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 50<p>urxvtperl - rxvt-unicode's embedded perl interpreter</p>
51<p> 51<p>
52</p> 52</p>
53<hr /> 53<hr />
54<h1><a name="synopsis">SYNOPSIS</a></h1> 54<h1><a name="synopsis">SYNOPSIS</a></h1>
55<pre> 55<pre>
… …
58 sub on_sel_grab { 58 sub on_sel_grab {
59 warn &quot;you selected &quot;, $_[0]-&gt;selection; 59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
60 () 60 ()
61 }</pre> 61 }</pre>
62<pre> 62<pre>
63 # start a rxvt using it:</pre> 63 # start a urxvt using it:</pre>
64<pre> 64<pre>
65 rxvt --perl-lib $HOME -pe grab_test</pre> 65 urxvt --perl-lib $HOME -pe grab_test</pre>
66<p> 66<p>
67</p> 67</p>
68<hr /> 68<hr />
69<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
70<p>Everytime a terminal object gets created, extension scripts specified via 70<p>Everytime a terminal object gets created, extension scripts specified via
71the <code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
73thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
74<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 urxvtd, where
75scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
76<p> 76<p>
77</p> 77</p>
78<hr /> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> 79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
80<p>This section describes the extensions delivered with this release. You can 80<p>This section describes the extensions delivered with this release. You can
81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/usr/local/lib/urxvt/perl/</em>.</p>
82<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
83<pre> 83<pre>
84 rxvt -pe &lt;extensionname&gt;</pre> 84 urxvt -pe &lt;extensionname&gt;</pre>
85<dl> 85<dl>
86<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 />
87</dt> 87</dt>
88<dd> 88<dd>
89(More) intelligent selection. This extension tries to be more intelligent 89(More) intelligent selection. This extension tries to be more intelligent
90when the user extends selections (double-click). Right now, it tries to 90when the user extends selections (double-click and further clicks). Right
91select urls and complete shell-quoted arguments, which is very convenient, 91now, it tries to select words, urls and complete shell-quoted
92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92arguments, which is very convenient, too, if your <em>ls</em> supports
93</dd> 93<code>--quoting-style=shell</code>.
94<dd> 94</dd>
95<dd>
96<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p>
98</dd>
99<dd>
100<p>The selection works by trying to match a number of regexes and displaying
101them in increasing order of length. You can add your own regexes by
102specifying resources of the form:</p>
103</dd>
104<dd>
105<pre>
106 URxvt.selection.pattern-0: perl-regex
107 URxvt.selection.pattern-1: perl-regex
108 ...</pre>
109</dd>
110<dd>
111<p>The index number (0, 1...) must not have any holes, and each regex must
112contain at least one pair of capturing parentheses, which will be used for
113the match. For example, the followign adds a regex that matches everything
114between two vertical bars:</p>
115</dd>
116<dd>
117<pre>
118 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
119</dd>
120<dd>
121<p>You can look at the source of the selection extension to see more
122interesting uses, such as parsing a line from beginning to end.</p>
123</dd>
124<dd>
95<p>It also offers the following bindable keyboard command:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
96</dd> 126</dd>
97<dl> 127<dl>
98<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
99</dt> 129</dt>
100<dd> 130<dd>
… …
122<p></p> 152<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 /> 153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt> 154</dt>
125<dd> 155<dd>
126Adds regex search functionality to the scrollback buffer, triggered 156Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal 157by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
128input/output is suspended. 158input/output is suspended and a regex is displayed at the bottom of the
129</dd> 159screen.
130<dd> 160</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>
135</dd> 161<dd>
136<p></p> 162<p>Inputting characters appends them to the regex and continues incremental
137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 163search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
138</dt> 164search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
165bottom. <code>Escape</code> leaves search mode and returns to the point where search
166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167additionally stores the first match in the current line into the primary
168selection.</p>
139<dd> 169</dd>
140Displays a digital clock using the built-in overlay. 170<p></p>
171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172</dt>
173<dd>
174This selection allows you to do automatic transforms on a selection
175whenever a selection is made.
176</dd>
177<dd>
178<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
179operator) that modify <code>$_</code> as resources:</p>
180</dd>
181<dd>
182<pre>
183 URxvt.selection-autotransform.0: transform
184 URxvt.selection-autotransform.1: transform
185 ...</pre>
186</dd>
187<dd>
188<p>For example, the following will transform selections of the form
189<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
190$word</code>:</p>
191</dd>
192<dd>
193<pre>
194 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
195</dd>
196<dd>
197<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p>
199</dd>
200<dd>
201<pre>
202 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd>
204<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd>
207<dd>
208<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd>
211<dd>
212<pre>
213 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
214 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre>
215</dd>
216<dd>
217<p>The first line tells the selection code to treat the unchanging part of
218every error message as a selection pattern, and the second line transforms
219the message into vi commands to load the file.</p>
141</dd> 220</dd>
142<p></p> 221<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt> 223</dt>
145<dd> 224<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 225Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
226make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument.
147</dd> 229</dd>
148<p></p> 230<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt> 232</dt>
151<dd> 233<dd>
152A not very useful example of filtering all text output to the terminal, 234A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 235by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 236similar-looking ascii character.
237</dd>
238<p></p>
239<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
240</dt>
241<dd>
242Displays a digital clock using the built-in overlay.
155</dd> 243</dd>
156<p></p> 244<p></p>
157<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 245<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
158</dt> 246</dt>
159<dd> 247<dd>
… …
183<dl> 271<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br /> 272<dt><strong><a name="item__24text">$text</a></strong><br />
185</dt> 273</dt>
186<dd> 274<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 275Rxvt-unicodes special way of encoding text, where one ``unicode'' character
188always represents one screen cell. See <em>row_t</em> for a discussion of this format. 276always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
189</dd> 277</dd>
190<p></p> 278<p></p>
191<dt><strong><a name="item__24string">$string</a></strong><br /> 279<dt><strong><a name="item__24string">$string</a></strong><br />
192</dt> 280</dt>
193<dd> 281<dd>
… …
301</dt> 389</dt>
302<dd> 390<dd>
303Called whenever the user tries to extend the selection (e.g. with a double 391Called whenever the user tries to extend the selection (e.g. with a double
304click) and is either supposed to return false (normal operation), or 392click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 393should extend the selection itelf and return true to suppress the built-in
306processing. 394processing. This can happen multiple times, as long as the callback
395returns true, it will be called on every further click by the user and is
396supposed to enlarge the selection more and more, if possible.
307</dd> 397</dd>
308<dd> 398<dd>
309<p>See the <em>selection</em> example extension.</p> 399<p>See the <em>selection</em> example extension.</p>
310</dd> 400</dd>
311<p></p> 401<p></p>
… …
399<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 489<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
400</dt> 490</dt>
401<dd> 491<dd>
402Called whenever the user presses a key combination that has a 492Called whenever the user presses a key combination that has a
403<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 493<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
404resource in the <code>rxvt(1)</code> manpage). 494resource in the <code>urxvt(1)</code> manpage).
495</dd>
496<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt>
499<dd>
500Called on every X event received on the vt window (and possibly other
501windows). Should only be used as a last resort. Most event structure
502members are not passed.
405</dd> 503</dd>
406<p></p> 504<p></p>
407<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 505<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
408</dt> 506</dt>
409<dd> 507<dd>
… …
476</dt> 574</dt>
477<dd> 575<dd>
478The current terminal. This variable stores the current <code>urxvt::term</code> 576The current terminal. This variable stores the current <code>urxvt::term</code>
479object, whenever a callback/hook is executing. 577object, whenever a callback/hook is executing.
480</dd> 578</dd>
481<p></p> 579<p></p></dl>
482<dt></dt>
483</dl>
484<p> 580<p>
485</p> 581</p>
486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 582<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
487<dl> 583<dl>
488<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 584<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
… …
525<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 621<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
526</dt> 622</dt>
527<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 623<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
528Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 624Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
529Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 625Button4Mask, Button5Mask, AnyModifier</a></strong><br />
626</dt>
627<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
628ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
629PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
630Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
631KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
632ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
633FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
634</dt>
635<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
636EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
637GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
638UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
639ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
640CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
641SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
530</dt> 642</dt>
531<dd> 643<dd>
532Various constants for use in X calls and event processing. 644Various constants for use in X calls and event processing.
533</dd> 645</dd>
534<p></p></dl> 646<p></p></dl>
… …
609<dl> 721<dl>
610<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> 722<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
611</dt> 723</dt>
612<dd> 724<dd>
613Creates a new terminal, very similar as if you had started it with system 725Creates a new terminal, very similar as if you had started it with system
614<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a %ENV&gt;-like 726<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
615<code></code>hash which defines the environment of the new terminal. 727hash which defines the environment of the new terminal.
616</dd>
617<dd> 728</dd>
729<dd>
618<p>&gt;Croaks (and probably outputs an error message) if the new instance 730<p>Croaks (and probably outputs an error message) if the new instance
619couldn't be created. Returns <code>undef</code> if the new instance didn't 731couldn't be created. Returns <code>undef</code> if the new instance didn't
620initialise perl, and the terminal object otherwise. The <code>init</code> and 732initialise perl, and the terminal object otherwise. The <code>init</code> and
621<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 733<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
622</dd> 734</dd>
623<p></p> 735<p></p>
624<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
625</dt> 737</dt>
626<dd> 738<dd>
627Destroy the terminal object (close the window, free resources 739Destroy the terminal object (close the window, free resources
628etc.). Please note that rxvt will not exit as long as any event 740etc.). Please note that urxvt will not exit as long as any event
629watchers (timers, io watchers) are still active. 741watchers (timers, io watchers) are still active.
630</dd> 742</dd>
631<p></p> 743<p></p>
632<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
633</dt> 745</dt>
… …
690 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
691 shade term_name title transparent transparent_all tripleclickwords 803 shade term_name title transparent transparent_all tripleclickwords
692 utmpInhibit visualBell</pre> 804 utmpInhibit visualBell</pre>
693</dd> 805</dd>
694<p></p> 806<p></p>
807<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
808</dt>
809<dd>
810Returns the X-Resource for the given pattern, excluding the program or
811class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
812same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
813resource with that pattern exists.
814</dd>
815<dd>
816<p>This method should only be called during the <code>on_start</code> hook, as there is
817only one resource database per display, and later invocations might return
818the wrong resources.</p>
819</dd>
820<p></p>
695<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 821<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
696</dt> 822</dt>
697<dd> 823<dd>
698Adds a keymap translation exactly as specified via a resource. See the 824Adds a keymap translation exactly as specified via a resource. See the
699<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage.
700</dd> 826</dd>
701<p></p> 827<p></p>
702<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
703</dt> 829</dt>
704<dd> 830<dd>
… …
722<dd> 848<dd>
723Return the current values of the selection mark, begin or end positions, 849Return the current values of the selection mark, begin or end positions,
724and optionally set them to new values. 850and optionally set them to new values.
725</dd> 851</dd>
726<p></p> 852<p></p>
853<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
854</dt>
855<dd>
856Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
857<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
858rectangular selection will be made. This is the prefered function to make
859a selection.
860</dd>
861<p></p>
727<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 862<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
728</dt> 863</dt>
729<dd> 864<dd>
730Try to request the primary selection from the server (for example, as set 865Try to request the primary selection text from the server (for example, as
731by the next method). 866set by the next method). No visual feedback will be given. This function
867is mostly useful from within <code>on_sel_grab</code> hooks.
732</dd> 868</dd>
733<p></p> 869<p></p>
734<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 870<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
735</dt> 871</dt>
736<dd> 872<dd>
… …
815<p></p> 951<p></p>
816<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 /> 952<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 />
817</dt> 953</dt>
818<dd> 954<dd>
819XORs the rendition values in the given span with the provided value 955XORs the rendition values in the given span with the provided value
820(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar 956(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
821to the selection. 957refresh hooks to provide effects similar to the selection.
822</dd> 958</dd>
823<p></p> 959<p></p>
824<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 /> 960<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 />
825</dt> 961</dt>
826<dd> 962<dd>
827Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 963Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
828whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 964whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
829to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 965to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
830it instead. 966it instead. Both styles <em>MUST NOT</em> contain font styles.
831</dd> 967</dd>
832<p></p> 968<p></p>
833<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 969<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
834</dt> 970</dt>
835<dd> 971<dd>
… …
883<p></p> 1019<p></p>
884<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br /> 1020<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
885</dt> 1021</dt>
886<dd> 1022<dd>
887Return the window id of the terminal window. 1023Return the window id of the terminal window.
1024</dd>
1025<p></p>
1026<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1027</dt>
1028<dd>
1029Adds the specified events to the vt event mask. Useful e.g. when you want
1030to receive pointer events all the times:
1031</dd>
1032<dd>
1033<pre>
1034 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
888</dd> 1035</dd>
889<p></p> 1036<p></p>
890<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1037<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
891</dt> 1038</dt>
892<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1039<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
… …
1063<p></p> 1210<p></p>
1064<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1211<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1065</dt> 1212</dt>
1066<dd> 1213<dd>
1067Returns the character offset of the given row|col pair within the logical 1214Returns the character offset of the given row|col pair within the logical
1068line. 1215line. Works for rows outside the line, too, and returns corresponding
1216offsets outside the string.
1069</dd> 1217</dd>
1070<p></p> 1218<p></p>
1071<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1219<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1072</dt> 1220</dt>
1073<dd> 1221<dd>
… …
1301<dl> 1449<dl>
1302<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1450<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1303</dt> 1451</dt>
1304<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1452<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1305</dt> 1453</dt>
1306<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1454<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1455</dt>
1456<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1307</dt> 1457</dt>
1308</dl> 1458</dl>
1309<p> 1459<p>
1310</p> 1460</p>
1311<hr /> 1461<hr />

Diff Legend

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