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.19 by root, Tue Jan 10 04:26:54 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
… …
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>
22 <li><a href="#extension_objects">Extension Objects</a></li> 23 <li><a href="#extension_objects">Extension Objects</a></li>
23 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
24 <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>
25 <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>
… …
44<hr /> 45<hr />
45<p> 46<p>
46</p> 47</p>
47<hr /> 48<hr />
48<h1><a name="name">NAME</a></h1> 49<h1><a name="name">NAME</a></h1>
49<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 50<p>urxvtperl - rxvt-unicode's embedded perl interpreter</p>
50<p> 51<p>
51</p> 52</p>
52<hr /> 53<hr />
53<h1><a name="synopsis">SYNOPSIS</a></h1> 54<h1><a name="synopsis">SYNOPSIS</a></h1>
54<pre> 55<pre>
… …
57 sub on_sel_grab { 58 sub on_sel_grab {
58 warn &quot;you selected &quot;, $_[0]-&gt;selection; 59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
59 () 60 ()
60 }</pre> 61 }</pre>
61<pre> 62<pre>
62 # start a rxvt using it:</pre> 63 # start a urxvt using it:</pre>
63<pre> 64<pre>
64 rxvt --perl-lib $HOME -pe grab_test</pre> 65 urxvt --perl-lib $HOME -pe grab_test</pre>
65<p> 66<p>
66</p> 67</p>
67<hr /> 68<hr />
68<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
69<p>Everytime a terminal object gets created, extension scripts specified via 70<p>Everytime a terminal object gets created, extension scripts specified via
70the <code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
71<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
72thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
73<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
74scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
75<p> 76<p>
76</p> 77</p>
77<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
78<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
79find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/usr/local/lib/urxvt/perl/</em>.</p>
80<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
81<pre> 83<pre>
82 rxvt -pe &lt;extensionname&gt;</pre> 84 urxvt -pe &lt;extensionname&gt;</pre>
83<dl> 85<dl>
84<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 />
85</dt> 87</dt>
86<dd> 88<dd>
87Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
88the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click and further clicks). Right
89urls and complete shell-quoted arguments, which is very convenient, too, 91now, it tries to select words, urls and complete shell-quoted
90if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92arguments, which is very convenient, too, if your <em>ls</em> supports
91</dd> 93<code>--quoting-style=shell</code>.
92<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>
93<p>It also offers the following bindable event:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
94</dd> 126</dd>
95<dl> 127<dl>
96<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
97</dt> 129</dt>
98<dd> 130<dd>
… …
112<p></p> 144<p></p>
113<dt><strong>selection-popup (enabled by default)</strong><br /> 145<dt><strong>selection-popup (enabled by default)</strong><br />
114</dt> 146</dt>
115<dd> 147<dd>
116Binds a popup menu to Ctrl-Button3 that lets you convert the selection 148Binds a popup menu to Ctrl-Button3 that lets you convert the selection
117text into various other formats/action. 149text into various other formats/action (such as uri unescaping, perl
150evalution, web-browser starting etc.), depending on content.
118</dd> 151</dd>
119<p></p> 152<p></p>
120<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 />
121</dt> 154</dt>
122<dd> 155<dd>
123Adds regex search functionality to the scrollback buffer, triggered 156Adds regex search functionality to the scrollback buffer, triggered
124by 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
125input/output is suspended. 158input/output is suspended and a regex is displayed at the bottom of the
126</dd> 159screen.
127<dd> 160</dd>
128<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
129<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
130history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
131returns to the original position.</p>
132</dd> 161<dd>
133<p></p> 162<p>Inputting characters appends them to the regex and continues incremental
134<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>
135</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>
136<dd> 169</dd>
137Displays 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>
138</dd> 220</dd>
139<p></p> 221<p></p>
140<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 />
141</dt> 223</dt>
142<dd> 224<dd>
143Uses 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.
144</dd> 229</dd>
145<p></p> 230<p></p>
146<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 />
147</dt> 232</dt>
148<dd> 233<dd>
149A 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,
150by replacing all line-drawing characters (U+2500 .. U+259F) by a 235by replacing all line-drawing characters (U+2500 .. U+259F) by a
151similar-looking ascii character. 236similar-looking ascii character.
152</dd> 237</dd>
153<p></p> 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.
243</dd>
244<p></p>
154<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 />
155</dt> 246</dt>
156<dd> 247<dd>
157Displays a very simple digital clock in the upper right corner of the 248Displays a very simple digital clock in the upper right corner of the
158window. Illustrates overwriting the refresh callbacks to create your own 249window. Illustrates overwriting the refresh callbacks to create your own
159overlays or changes. 250overlays or changes.
160</dd> 251</dd>
161<p></p></dl> 252<p></p></dl>
253<p>
254</p>
255<hr />
256<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
162<p> 257<p>
163</p> 258</p>
164<h2><a name="general_api_considerations">General API Considerations</a></h2> 259<h2><a name="general_api_considerations">General API Considerations</a></h2>
165<p>All objects (such as terminals, time watchers etc.) are typical 260<p>All objects (such as terminals, time watchers etc.) are typical
166reference-to-hash objects. The hash can be used to store anything you 261reference-to-hash objects. The hash can be used to store anything you
… …
176<dl> 271<dl>
177<dt><strong><a name="item__24text">$text</a></strong><br /> 272<dt><strong><a name="item__24text">$text</a></strong><br />
178</dt> 273</dt>
179<dd> 274<dd>
180Rxvt-unicodes special way of encoding text, where one ``unicode'' character 275Rxvt-unicodes special way of encoding text, where one ``unicode'' character
181always 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.
182</dd> 277</dd>
183<p></p> 278<p></p>
184<dt><strong><a name="item__24string">$string</a></strong><br /> 279<dt><strong><a name="item__24string">$string</a></strong><br />
185</dt> 280</dt>
186<dd> 281<dd>
… …
294</dt> 389</dt>
295<dd> 390<dd>
296Called 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
297click) and is either supposed to return false (normal operation), or 392click) and is either supposed to return false (normal operation), or
298should 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
299processing. 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.
300</dd> 397</dd>
301<dd> 398<dd>
302<p>See the <em>selection</em> example extension.</p> 399<p>See the <em>selection</em> example extension.</p>
303</dd> 400</dd>
304<p></p> 401<p></p>
… …
392<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 />
393</dt> 490</dt>
394<dd> 491<dd>
395Called whenever the user presses a key combination that has a 492Called whenever the user presses a key combination that has a
396<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>
397resource 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.
398</dd> 503</dd>
399<p></p> 504<p></p>
400<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 />
401</dt> 506</dt>
402<dd> 507<dd>
… …
444<p></p></dl> 549<p></p></dl>
445<p> 550<p>
446</p> 551</p>
447<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 552<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
448<dl> 553<dl>
554<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
555</dt>
556<dd>
557The rxvt-unicode library directory, where, among other things, the perl
558modules and scripts are stored.
559</dd>
560<p></p>
561<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
562</dt>
563<dd>
564The resource class and name rxvt-unicode uses to look up X resources.
565</dd>
566<p></p>
567<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
568</dt>
569<dd>
570The basename of the installed binaries, usually <code>urxvt</code>.
571</dd>
572<p></p>
449<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 573<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
450</dt> 574</dt>
451<dd> 575<dd>
452The current terminal. This variable stores the current <code>urxvt::term</code> 576The current terminal. This variable stores the current <code>urxvt::term</code>
453object, whenever a callback/hook is executing. 577object, whenever a callback/hook is executing.
… …
455<p></p></dl> 579<p></p></dl>
456<p> 580<p>
457</p> 581</p>
458<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>
459<dl> 583<dl>
460<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
461</dt>
462<dd>
463Creates a new terminal, very similar as if you had started it with
464<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
465if the new instance couldn't be created. Returns <code>undef</code> if the new
466instance didn't initialise perl, and the terminal object otherwise. The
467<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
468</dd>
469<p></p>
470<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 />
471</dt> 585</dt>
472<dd> 586<dd>
473Fatally aborts execution with the given error message. Avoid at all 587Fatally aborts execution with the given error message. Avoid at all
474costs! The only time this is acceptable is when the terminal process 588costs! The only time this is acceptable is when the terminal process
… …
484</dd> 598</dd>
485<dd> 599<dd>
486<p>Using this function has the advantage that its output ends up in the 600<p>Using this function has the advantage that its output ends up in the
487correct place, e.g. on stderr of the connecting urxvtc client.</p> 601correct place, e.g. on stderr of the connecting urxvtc client.</p>
488</dd> 602</dd>
603<dd>
604<p>Messages have a size limit of 1023 bytes currently.</p>
605</dd>
489<p></p> 606<p></p>
490<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 607<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
491</dt> 608</dt>
492<dd> 609<dd>
493Returns true when it is safe to do potentially unsafe things, such as 610Returns true when it is safe to do potentially unsafe things, such as
… …
504<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 />
505</dt> 622</dt>
506<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,
507Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 624Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
508Button4Mask, 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 />
509</dt> 642</dt>
510<dd> 643<dd>
511Various constants for use in X calls and event processing. 644Various constants for use in X calls and event processing.
512</dd> 645</dd>
513<p></p></dl> 646<p></p></dl>
… …
548</dt> 681</dt>
549<dd> 682<dd>
550Return the foreground/background colour index, respectively. 683Return the foreground/background colour index, respectively.
551</dd> 684</dd>
552<p></p> 685<p></p>
553<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 686<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
554</dt> 687</dt>
555<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 688<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
556</dt> 689</dt>
557<dd> 690<dd>
558Replace the foreground/background colour in the rendition mask with the 691Replace the foreground/background colour in the rendition mask with the
559specified one. 692specified one.
560</dd> 693</dd>
561<p></p> 694<p></p>
562<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 695<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
563</dt> 696</dt>
564<dd> 697<dd>
565Return the ``custom'' value: Every rendition has 5 bits for use by 698Return the ``custom'' value: Every rendition has 5 bits for use by
566extensions. They can be set and changed as you like and are initially 699extensions. They can be set and changed as you like and are initially
567zero. 700zero.
568</dd> 701</dd>
569<p></p> 702<p></p>
570<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 703<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
571</dt> 704</dt>
572<dd> 705<dd>
573Change the custom value. 706Change the custom value.
574</dd> 707</dd>
575<p></p></dl> 708<p></p></dl>
576<p> 709<p>
577</p> 710</p>
578<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 711<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
579<p>The sole purpose of this class is to deliver an interface to the 712<p>The sole purpose of this class is to deliver an interface to the
580<code>AnyEvent</code> module - any module using it will work inside urxvt without 713<code>AnyEvent</code> module - any module using it will work inside urxvt without
581further work. The only exception is that you cannot wait on condition 714further programming. The only exception is that you cannot wait on
582variables, but non-blocking condvar use is ok. What this means is that you 715condition variables, but non-blocking condvar use is ok. What this means
583cannot use blocking APIs, but the non-blocking variant should work.</p> 716is that you cannot use blocking APIs, but the non-blocking variant should
717work.</p>
584<p> 718<p>
585</p> 719</p>
586<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 720<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
587<dl> 721<dl>
722<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
723</dt>
724<dd>
725Creates a new terminal, very similar as if you had started it with system
726<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
727hash which defines the environment of the new terminal.
728</dd>
729<dd>
730<p>Croaks (and probably outputs an error message) if the new instance
731couldn't be created. Returns <code>undef</code> if the new instance didn't
732initialise perl, and the terminal object otherwise. The <code>init</code> and
733<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
734</dd>
735<p></p>
588<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 />
589</dt> 737</dt>
590<dd> 738<dd>
591Destroy the terminal object (close the window, free resources etc.). 739Destroy the terminal object (close the window, free resources
740etc.). Please note that urxvt will not exit as long as any event
741watchers (timers, io watchers) are still active.
592</dd> 742</dd>
593<p></p> 743<p></p>
594<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 />
595</dt> 745</dt>
596<dd> 746<dd>
… …
652 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
653 shade term_name title transparent transparent_all tripleclickwords 803 shade term_name title transparent transparent_all tripleclickwords
654 utmpInhibit visualBell</pre> 804 utmpInhibit visualBell</pre>
655</dd> 805</dd>
656<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>
657<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 />
658</dt> 822</dt>
659<dd> 823<dd>
660Adds a keymap translation exactly as specified via a resource. See the 824Adds a keymap translation exactly as specified via a resource. See the
661<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage.
662</dd> 826</dd>
663<p></p> 827<p></p>
664<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 />
665</dt> 829</dt>
666<dd> 830<dd>
… …
684<dd> 848<dd>
685Return the current values of the selection mark, begin or end positions, 849Return the current values of the selection mark, begin or end positions,
686and optionally set them to new values. 850and optionally set them to new values.
687</dd> 851</dd>
688<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>
689<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 />
690</dt> 863</dt>
691<dd> 864<dd>
692Try 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
693by 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.
694</dd> 868</dd>
695<p></p> 869<p></p>
696<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 870<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
697</dt> 871</dt>
698<dd> 872<dd>
… …
777<p></p> 951<p></p>
778<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 />
779</dt> 953</dt>
780<dd> 954<dd>
781XORs the rendition values in the given span with the provided value 955XORs the rendition values in the given span with the provided value
782(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
783to the selection. 957refresh hooks to provide effects similar to the selection.
784</dd> 958</dd>
785<p></p> 959<p></p>
786<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 />
787</dt> 961</dt>
788<dd> 962<dd>
789Similar 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
790whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 964whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
791to <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
792it instead. 966it instead. Both styles <em>MUST NOT</em> contain font styles.
793</dd> 967</dd>
794<p></p> 968<p></p>
795<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 />
796</dt> 970</dt>
797<dd> 971<dd>
… …
847</dt> 1021</dt>
848<dd> 1022<dd>
849Return the window id of the terminal window. 1023Return the window id of the terminal window.
850</dd> 1024</dd>
851<p></p> 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>
1035</dd>
1036<p></p>
852<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 />
853</dt> 1038</dt>
854<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 />
855</dt> 1040</dt>
856<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1041<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
875</dt> 1060</dt>
876<dd> 1061<dd>
877Return various integers describing terminal characteristics. 1062Return various integers describing terminal characteristics.
878</dd> 1063</dd>
879<p></p> 1064<p></p>
1065<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1066</dt>
1067<dd>
1068Return the DISPLAY used by rxvt-unicode.
1069</dd>
1070<p></p>
880<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 1071<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
881</dt> 1072</dt>
882<dd> 1073<dd>
883Returns the LC_CTYPE category string used by this rxvt-unicode. 1074Returns the LC_CTYPE category string used by this rxvt-unicode.
884</dd> 1075</dd>
885<p></p> 1076<p></p>
886<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 1077<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
887</dt> 1078</dt>
888<dd> 1079<dd>
889Return the DISPLAY used by rxvt-unicode. 1080Returns a copy of the environment in effect for the terminal as a hashref
1081similar to <code>\%ENV</code>.
890</dd> 1082</dd>
891<p></p> 1083<p></p>
892<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1084<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
893</dt> 1085</dt>
894<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1086<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
1018<p></p> 1210<p></p>
1019<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 />
1020</dt> 1212</dt>
1021<dd> 1213<dd>
1022Returns 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
1023line. 1215line. Works for rows outside the line, too, and returns corresponding
1216offsets outside the string.
1024</dd> 1217</dd>
1025<p></p> 1218<p></p>
1026<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 />
1027</dt> 1220</dt>
1028<dd> 1221<dd>
… …
1085</dd> 1278</dd>
1086<p></p></dl> 1279<p></p></dl>
1087<p> 1280<p>
1088</p> 1281</p>
1089<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1282<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1283<dl>
1284<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1285</dt>
1286<dd>
1287Adds a non-clickable title to the popup.
1288</dd>
1289<p></p>
1290<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1291</dt>
1292<dd>
1293Creates a separator, optionally using the character given as <code>$sepchr</code>.
1294</dd>
1295<p></p>
1296<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1297</dt>
1298<dd>
1299Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1300selected.
1301</dd>
1302<p></p>
1303<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1304</dt>
1305<dd>
1306Adds a toggle/checkbox item to the popup. Teh callback gets called
1307whenever it gets toggled, with a boolean indicating its value as its first
1308argument.
1309</dd>
1310<p></p>
1311<dt><strong>$popup-&gt;show</strong><br />
1312</dt>
1313<dd>
1314Displays the popup (which is initially hidden).
1315</dd>
1316<p></p></dl>
1090<p> 1317<p>
1091</p> 1318</p>
1092<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1319<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1093<p>This class implements timer watchers/events. Time is represented as a 1320<p>This class implements timer watchers/events. Time is represented as a
1094fractional number of seconds since the epoch. Example:</p> 1321fractional number of seconds since the epoch. Example:</p>
… …
1222<dl> 1449<dl>
1223<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 />
1224</dt> 1451</dt>
1225<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 />
1226</dt> 1453</dt>
1227<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 />
1228</dt> 1457</dt>
1229</dl> 1458</dl>
1230<p> 1459<p>
1231</p> 1460</p>
1232<hr /> 1461<hr />

Diff Legend

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