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.32 by root, Wed Jan 18 09:40:53 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>
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>
… …
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 rxvtd, 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>/opt/rxvt/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 rxvt -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>
93<p>It also offers the following bindable event:</p> 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>
125<p>This extension also offers following bindable keyboard commands:</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>
252<p></p>
253<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
254</dt>
255<dd>
256This is a little rarely useful extension that Uploads the selection as
257textfile to a remote site (or does other things). (The implementation is
258not currently secure for use in a multiuser environment as it writes to
259<em>/tmp</em> directly.).
260</dd>
261<dd>
262<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
263i.e.</p>
264</dd>
265<dd>
266<pre>
267 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
268</dd>
269<dd>
270<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
271the textfile. This command can be set via a resource:</p>
272</dd>
273<dd>
274<pre>
275 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
276</dd>
277<dd>
278<p>And the default is likely not useful to anybody but the few people around
279here :)</p>
280</dd>
281<dd>
282<p>The name of the textfile is the hex encoded md5 sum of the selection, so
283the same content should lead to the same filename.</p>
284</dd>
285<dd>
286<p>After a successful upload the selection will be replaced by the text given
287in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
288for the filename):</p>
289</dd>
290<dd>
291<pre>
292 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
293</dd>
161<p></p></dl> 294<p></p></dl>
295<p>
296</p>
297<hr />
298<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
162<p> 299<p>
163</p> 300</p>
164<h2><a name="general_api_considerations">General API Considerations</a></h2> 301<h2><a name="general_api_considerations">General API Considerations</a></h2>
165<p>All objects (such as terminals, time watchers etc.) are typical 302<p>All objects (such as terminals, time watchers etc.) are typical
166reference-to-hash objects. The hash can be used to store anything you 303reference-to-hash objects. The hash can be used to store anything you
… …
176<dl> 313<dl>
177<dt><strong><a name="item__24text">$text</a></strong><br /> 314<dt><strong><a name="item__24text">$text</a></strong><br />
178</dt> 315</dt>
179<dd> 316<dd>
180Rxvt-unicodes special way of encoding text, where one ``unicode'' character 317Rxvt-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. 318always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
182</dd> 319</dd>
183<p></p> 320<p></p>
184<dt><strong><a name="item__24string">$string</a></strong><br /> 321<dt><strong><a name="item__24string">$string</a></strong><br />
185</dt> 322</dt>
186<dd> 323<dd>
… …
294</dt> 431</dt>
295<dd> 432<dd>
296Called whenever the user tries to extend the selection (e.g. with a double 433Called whenever the user tries to extend the selection (e.g. with a double
297click) and is either supposed to return false (normal operation), or 434click) and is either supposed to return false (normal operation), or
298should extend the selection itelf and return true to suppress the built-in 435should extend the selection itelf and return true to suppress the built-in
299processing. 436processing. This can happen multiple times, as long as the callback
437returns true, it will be called on every further click by the user and is
438supposed to enlarge the selection more and more, if possible.
300</dd> 439</dd>
301<dd> 440<dd>
302<p>See the <em>selection</em> example extension.</p> 441<p>See the <em>selection</em> example extension.</p>
303</dd> 442</dd>
304<p></p> 443<p></p>
… …
395Called whenever the user presses a key combination that has a 534Called 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> 535<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
397resource in the <code>rxvt(1)</code> manpage). 536resource in the <code>rxvt(1)</code> manpage).
398</dd> 537</dd>
399<p></p> 538<p></p>
539<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
540</dt>
541<dd>
542Called on every X event received on the vt window (and possibly other
543windows). Should only be used as a last resort. Most event structure
544members are not passed.
545</dd>
546<p></p>
400<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 547<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
401</dt> 548</dt>
402<dd> 549<dd>
403Called whenever the window gets the keyboard focus, before rxvt-unicode 550Called whenever the window gets the keyboard focus, before rxvt-unicode
404does focus in processing. 551does focus in processing.
… …
444<p></p></dl> 591<p></p></dl>
445<p> 592<p>
446</p> 593</p>
447<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 594<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
448<dl> 595<dl>
596<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
597</dt>
598<dd>
599The rxvt-unicode library directory, where, among other things, the perl
600modules and scripts are stored.
601</dd>
602<p></p>
603<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
604</dt>
605<dd>
606The resource class and name rxvt-unicode uses to look up X resources.
607</dd>
608<p></p>
609<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
610</dt>
611<dd>
612The basename of the installed binaries, usually <code>urxvt</code>.
613</dd>
614<p></p>
449<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 615<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
450</dt> 616</dt>
451<dd> 617<dd>
452The current terminal. This variable stores the current <code>urxvt::term</code> 618The current terminal. This variable stores the current <code>urxvt::term</code>
453object, whenever a callback/hook is executing. 619object, whenever a callback/hook is executing.
… …
455<p></p></dl> 621<p></p></dl>
456<p> 622<p>
457</p> 623</p>
458<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 624<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
459<dl> 625<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 /> 626<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
471</dt> 627</dt>
472<dd> 628<dd>
473Fatally aborts execution with the given error message. Avoid at all 629Fatally aborts execution with the given error message. Avoid at all
474costs! The only time this is acceptable is when the terminal process 630costs! The only time this is acceptable is when the terminal process
… …
484</dd> 640</dd>
485<dd> 641<dd>
486<p>Using this function has the advantage that its output ends up in the 642<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> 643correct place, e.g. on stderr of the connecting urxvtc client.</p>
488</dd> 644</dd>
489<p></p>
490<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
491</dt>
492<dd> 645<dd>
493Returns true when it is safe to do potentially unsafe things, such as 646<p>Messages have a size limit of 1023 bytes currently.</p>
494evaluating perl code specified by the user. This is true when urxvt was
495started setuid or setgid.
496</dd> 647</dd>
497<p></p> 648<p></p>
498<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 649<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
499</dt> 650</dt>
500<dd> 651<dd>
… …
504<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 655<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
505</dt> 656</dt>
506<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 657<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, 658Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
508Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 659Button4Mask, Button5Mask, AnyModifier</a></strong><br />
660</dt>
661<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
662ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
663PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
664Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
665KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
666ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
667FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
668</dt>
669<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
670EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
671GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
672UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
673ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
674CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
675SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
509</dt> 676</dt>
510<dd> 677<dd>
511Various constants for use in X calls and event processing. 678Various constants for use in X calls and event processing.
512</dd> 679</dd>
513<p></p></dl> 680<p></p></dl>
… …
548</dt> 715</dt>
549<dd> 716<dd>
550Return the foreground/background colour index, respectively. 717Return the foreground/background colour index, respectively.
551</dd> 718</dd>
552<p></p> 719<p></p>
553<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 720<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> 721</dt>
555<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 722<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> 723</dt>
557<dd> 724<dd>
558Replace the foreground/background colour in the rendition mask with the 725Replace the foreground/background colour in the rendition mask with the
559specified one. 726specified one.
560</dd> 727</dd>
561<p></p> 728<p></p>
562<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 729<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
563</dt> 730</dt>
564<dd> 731<dd>
565Return the ``custom'' value: Every rendition has 5 bits for use by 732Return the ``custom'' value: Every rendition has 5 bits for use by
566extensions. They can be set and changed as you like and are initially 733extensions. They can be set and changed as you like and are initially
567zero. 734zero.
568</dd> 735</dd>
569<p></p> 736<p></p>
570<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 737<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> 738</dt>
572<dd> 739<dd>
573Change the custom value. 740Change the custom value.
574</dd> 741</dd>
575<p></p></dl> 742<p></p></dl>
576<p> 743<p>
577</p> 744</p>
578<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 745<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 746<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 747<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 748further programming. The only exception is that you cannot wait on
582variables, but non-blocking condvar use is ok. What this means is that you 749condition variables, but non-blocking condvar use is ok. What this means
583cannot use blocking APIs, but the non-blocking variant should work.</p> 750is that you cannot use blocking APIs, but the non-blocking variant should
751work.</p>
584<p> 752<p>
585</p> 753</p>
586<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 754<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
587<dl> 755<dl>
756<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
757</dt>
758<dd>
759Creates a new terminal, very similar as if you had started it with system
760<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
761hash which defines the environment of the new terminal.
762</dd>
763<dd>
764<p>Croaks (and probably outputs an error message) if the new instance
765couldn't be created. Returns <code>undef</code> if the new instance didn't
766initialise perl, and the terminal object otherwise. The <code>init</code> and
767<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
768</dd>
769<p></p>
588<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 770<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
589</dt> 771</dt>
590<dd> 772<dd>
591Destroy the terminal object (close the window, free resources etc.). 773Destroy the terminal object (close the window, free resources
774etc.). Please note that rxvt will not exit as long as any event
775watchers (timers, io watchers) are still active.
592</dd> 776</dd>
593<p></p> 777<p></p>
594<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 778<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
595</dt> 779</dt>
596<dd> 780<dd>
… …
652 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 836 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
653 shade term_name title transparent transparent_all tripleclickwords 837 shade term_name title transparent transparent_all tripleclickwords
654 utmpInhibit visualBell</pre> 838 utmpInhibit visualBell</pre>
655</dd> 839</dd>
656<p></p> 840<p></p>
841<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
842</dt>
843<dd>
844Returns the X-Resource for the given pattern, excluding the program or
845class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
846same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
847resource with that pattern exists.
848</dd>
849<dd>
850<p>This method should only be called during the <code>on_start</code> hook, as there is
851only one resource database per display, and later invocations might return
852the wrong resources.</p>
853</dd>
854<p></p>
657<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 855<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
658</dt> 856</dt>
659<dd> 857<dd>
660Adds a keymap translation exactly as specified via a resource. See the 858Adds a keymap translation exactly as specified via a resource. See the
661<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 859<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
… …
684<dd> 882<dd>
685Return the current values of the selection mark, begin or end positions, 883Return the current values of the selection mark, begin or end positions,
686and optionally set them to new values. 884and optionally set them to new values.
687</dd> 885</dd>
688<p></p> 886<p></p>
887<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
888</dt>
889<dd>
890Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
891<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
892rectangular selection will be made. This is the prefered function to make
893a selection.
894</dd>
895<p></p>
689<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 896<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
690</dt> 897</dt>
691<dd> 898<dd>
692Try to request the primary selection from the server (for example, as set 899Try to request the primary selection text from the server (for example, as
693by the next method). 900set by the next method). No visual feedback will be given. This function
901is mostly useful from within <code>on_sel_grab</code> hooks.
694</dd> 902</dd>
695<p></p> 903<p></p>
696<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 904<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
697</dt> 905</dt>
698<dd> 906<dd>
… …
777<p></p> 985<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 /> 986<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> 987</dt>
780<dd> 988<dd>
781XORs the rendition values in the given span with the provided value 989XORs 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 990(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
783to the selection. 991refresh hooks to provide effects similar to the selection.
784</dd> 992</dd>
785<p></p> 993<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 /> 994<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> 995</dt>
788<dd> 996<dd>
789Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 997Similar 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 998whitespace 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 999to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
792it instead. 1000it instead. Both styles <em>MUST NOT</em> contain font styles.
793</dd> 1001</dd>
794<p></p> 1002<p></p>
795<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 1003<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
796</dt> 1004</dt>
797<dd> 1005<dd>
… …
847</dt> 1055</dt>
848<dd> 1056<dd>
849Return the window id of the terminal window. 1057Return the window id of the terminal window.
850</dd> 1058</dd>
851<p></p> 1059<p></p>
1060<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1061</dt>
1062<dd>
1063Adds the specified events to the vt event mask. Useful e.g. when you want
1064to receive pointer events all the times:
1065</dd>
1066<dd>
1067<pre>
1068 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1069</dd>
1070<p></p>
852<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1071<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
853</dt> 1072</dt>
854<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1073<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
855</dt> 1074</dt>
856<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1075<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
869</dt> 1088</dt>
870<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1089<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
871</dt> 1090</dt>
872<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1091<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
873</dt> 1092</dt>
874<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1093<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
875</dt> 1094</dt>
876<dd> 1095<dd>
877Return various integers describing terminal characteristics. 1096Return various integers describing terminal characteristics.
878</dd> 1097</dd>
879<p></p> 1098<p></p>
1099<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1100</dt>
1101<dd>
1102Return the DISPLAY used by rxvt-unicode.
1103</dd>
1104<p></p>
880<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 1105<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
881</dt> 1106</dt>
882<dd> 1107<dd>
883Returns the LC_CTYPE category string used by this rxvt-unicode. 1108Returns the LC_CTYPE category string used by this rxvt-unicode.
884</dd> 1109</dd>
885<p></p> 1110<p></p>
886<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 1111<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
887</dt> 1112</dt>
888<dd> 1113<dd>
889Return the DISPLAY used by rxvt-unicode. 1114Returns a copy of the environment in effect for the terminal as a hashref
1115similar to <code>\%ENV</code>.
890</dd> 1116</dd>
891<p></p> 1117<p></p>
892<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1118<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
893</dt> 1119</dt>
894<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1120<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
901</dd> 1127</dd>
902<p></p> 1128<p></p>
903<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1129<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
904</dt> 1130</dt>
905<dd> 1131<dd>
906Returns the negative row number of the topmost line. Minimum value is 1132Returns the row number of the topmost displayed line. Maximum value is
907<code>0</code>, which displays the normal terminal contents. Larger values scroll 1133<code>0</code>, which displays the normal terminal contents. Lower values scroll
908this many lines into the scrollback buffer. 1134this many lines into the scrollback buffer.
909</dd> 1135</dd>
910<p></p> 1136<p></p>
911<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1137<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
912</dt> 1138</dt>
… …
923</dt> 1149</dt>
924<dd> 1150<dd>
925Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1151Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
926is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1152is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
927terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1153terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
928line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1154line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
929is requested. 1155is requested.
930</dd> 1156</dd>
931<dd> 1157<dd>
932<p>If <code>$new_text</code> is specified, it will replace characters in the current 1158<p>If <code>$new_text</code> is specified, it will replace characters in the current
933line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1159line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
… …
1018<p></p> 1244<p></p>
1019<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1245<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1020</dt> 1246</dt>
1021<dd> 1247<dd>
1022Returns the character offset of the given row|col pair within the logical 1248Returns the character offset of the given row|col pair within the logical
1023line. 1249line. Works for rows outside the line, too, and returns corresponding
1250offsets outside the string.
1024</dd> 1251</dd>
1025<p></p> 1252<p></p>
1026<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1253<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1027</dt> 1254</dt>
1028<dd> 1255<dd>
… …
1085</dd> 1312</dd>
1086<p></p></dl> 1313<p></p></dl>
1087<p> 1314<p>
1088</p> 1315</p>
1089<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1316<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1317<dl>
1318<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1319</dt>
1320<dd>
1321Adds a non-clickable title to the popup.
1322</dd>
1323<p></p>
1324<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1325</dt>
1326<dd>
1327Creates a separator, optionally using the character given as <code>$sepchr</code>.
1328</dd>
1329<p></p>
1330<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1331</dt>
1332<dd>
1333Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1334selected.
1335</dd>
1336<p></p>
1337<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1338</dt>
1339<dd>
1340Adds a toggle/checkbox item to the popup. Teh callback gets called
1341whenever it gets toggled, with a boolean indicating its value as its first
1342argument.
1343</dd>
1344<p></p>
1345<dt><strong>$popup-&gt;show</strong><br />
1346</dt>
1347<dd>
1348Displays the popup (which is initially hidden).
1349</dd>
1350<p></p></dl>
1090<p> 1351<p>
1091</p> 1352</p>
1092<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1353<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 1354<p>This class implements timer watchers/events. Time is represented as a
1094fractional number of seconds since the epoch. Example:</p> 1355fractional number of seconds since the epoch. Example:</p>
… …
1222<dl> 1483<dl>
1223<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1484<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1224</dt> 1485</dt>
1225<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1486<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1226</dt> 1487</dt>
1227<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1488<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1489</dt>
1490<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1228</dt> 1491</dt>
1229</dl> 1492</dl>
1230<p> 1493<p>
1231</p> 1494</p>
1232<hr /> 1495<hr />

Diff Legend

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