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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.17 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.27 by root, Thu Jan 12 12:15:10 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 27 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
… …
71thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
72<p>Each script will only ever be loaded once, even in rxvtd, where 74<p>Each script will only ever be loaded once, even in rxvtd, where
73scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
74<p> 76<p>
75</p> 77</p>
76<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
77<p>This section describes the extensiosn delivered with this version. You can 80<p>This section describes the extensions delivered with this release. You can
78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
79<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
80<pre> 83<pre>
81 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
82<dl> 85<dl>
83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
84</dt> 87</dt>
85<dd> 88<dd>
86Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
87the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click and further clicks). Right
88urls and complete shell-quoted arguments, which is very convenient, too, 91now, it tries to select words, urls and complete shell-quoted
89if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92arguments, which is very convenient, too, if your <em>ls</em> supports
90</dd> 93<code>--quoting-style=shell</code>.
91<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>
92<p>It also offers the following bindable event:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
93</dd> 126</dd>
94<dl> 127<dl>
95<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
96</dt> 129</dt>
97<dd> 130<dd>
… …
111<p></p> 144<p></p>
112<dt><strong>selection-popup (enabled by default)</strong><br /> 145<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt> 146</dt>
114<dd> 147<dd>
115Binds 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
116text into various other formats/action. 149text into various other formats/action (such as uri unescaping, perl
117</dd> 150evalution, web-browser starting etc.), depending on content.
118<p></p>
119<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
120</dt>
121<dd> 151</dd>
122Displays a digital clock using the built-in overlay. 152<p></p>
153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
154</dt>
155<dd>
156Adds regex search functionality to the scrollback buffer, triggered
157by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
158input/output is suspended and a regex is displayed at the bottom of the
159screen.
160</dd>
161<dd>
162<p>Inputting characters appends them to the regex and continues incremental
163search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
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>
169</dd>
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/^(\\S+):(\\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/^(S+):(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>
123</dd> 206</dd>
124<p></p> 207<p></p>
125<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 208<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
126</dt> 209</dt>
127<dd> 210<dd>
128Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 211Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
212make them clickable. When middle-clicked, the program specified in the
213resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
214the URL as first argument.
129</dd> 215</dd>
130<p></p> 216<p></p>
131<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 217<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
132</dt> 218</dt>
133<dd> 219<dd>
134A not very useful example of filtering all text output to the terminal, 220A not very useful example of filtering all text output to the terminal,
135by replacing all line-drawing characters (U+2500 .. U+259F) by a 221by replacing all line-drawing characters (U+2500 .. U+259F) by a
136similar-looking ascii character. 222similar-looking ascii character.
137</dd> 223</dd>
138<p></p> 224<p></p>
225<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
226</dt>
227<dd>
228Displays a digital clock using the built-in overlay.
229</dd>
230<p></p>
139<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 231<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
140</dt> 232</dt>
141<dd> 233<dd>
142Displays a very simple digital clock in the upper right corner of the 234Displays a very simple digital clock in the upper right corner of the
143window. Illustrates overwriting the refresh callbacks to create your own 235window. Illustrates overwriting the refresh callbacks to create your own
144overlays or changes. 236overlays or changes.
145</dd> 237</dd>
146<p></p></dl> 238<p></p></dl>
239<p>
240</p>
241<hr />
242<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
147<p> 243<p>
148</p> 244</p>
149<h2><a name="general_api_considerations">General API Considerations</a></h2> 245<h2><a name="general_api_considerations">General API Considerations</a></h2>
150<p>All objects (such as terminals, time watchers etc.) are typical 246<p>All objects (such as terminals, time watchers etc.) are typical
151reference-to-hash objects. The hash can be used to store anything you 247reference-to-hash objects. The hash can be used to store anything you
… …
161<dl> 257<dl>
162<dt><strong><a name="item__24text">$text</a></strong><br /> 258<dt><strong><a name="item__24text">$text</a></strong><br />
163</dt> 259</dt>
164<dd> 260<dd>
165Rxvt-unicodes special way of encoding text, where one ``unicode'' character 261Rxvt-unicodes special way of encoding text, where one ``unicode'' character
166always represents one screen cell. See <em>row_t</em> for a discussion of this format. 262always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
167</dd> 263</dd>
168<p></p> 264<p></p>
169<dt><strong><a name="item__24string">$string</a></strong><br /> 265<dt><strong><a name="item__24string">$string</a></strong><br />
170</dt> 266</dt>
171<dd> 267<dd>
… …
181locale-specific way. 277locale-specific way.
182</dd> 278</dd>
183<p></p></dl> 279<p></p></dl>
184<p> 280<p>
185</p> 281</p>
282<h2><a name="extension_objects">Extension Objects</a></h2>
283<p>Very perl extension is a perl class. A separate perl object is created
284for each terminal and each extension and passed as the first parameter to
285hooks. So extensions can use their <code>$self</code> object without having to think
286about other extensions, with the exception of methods and members that
287begin with an underscore character <code>_</code>: these are reserved for internal
288use.</p>
289<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
290<code>urxvt::term</code> class on this object.</p>
291<p>It has the following methods and data members:</p>
292<dl>
293<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
294</dt>
295<dd>
296Returns the <code>urxvt::term</code> object associated with this instance of the
297extension. This member <em>must not</em> be changed in any way.
298</dd>
299<p></p>
300<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
301</dt>
302<dd>
303Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
304this extension, replacing any previous hook. This is useful when you want
305to overwrite time-critical hooks only temporarily.
306</dd>
307<p></p>
308<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
309</dt>
310<dd>
311Dynamically disable the given hooks.
312</dd>
313<p></p></dl>
314<p>
315</p>
186<h2><a name="hooks">Hooks</a></h2> 316<h2><a name="hooks">Hooks</a></h2>
187<p>The following subroutines can be declared in extension files, and will be 317<p>The following subroutines can be declared in extension files, and will be
188called whenever the relevant event happens.</p> 318called whenever the relevant event happens.</p>
189<p>The first argument passed to them is an object private to each terminal 319<p>The first argument passed to them is an extension oject as described in
190and extension package. You can call all <code>urxvt::term</code> methods on it, but 320the in the <code>Extension Objects</code> section.</p>
191its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
192object that is shared between all packages is stored in the <code>term</code>
193member. It is, however, blessed intot he package of the extension script,
194so for all practical purposes you can treat an extension script as a class.</p>
195<p>All of them must return a boolean value. If it is true, then the event 321<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
196counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 322event counts as being <em>consumed</em>, and the invocation of other hooks is
197and the relevant action might not be carried out by the C++ code.</p> 323skipped, and the relevant action might not be carried out by the C++ code.</p>
198<p>When in doubt, return a false value (preferably <code>()</code>).</p> 324<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
199<dl> 325<dl>
200<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 326<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
201</dt> 327</dt>
202<dd> 328<dd>
203Called after a new terminal object has been initialized, but before 329Called after a new terminal object has been initialized, but before
… …
249</dt> 375</dt>
250<dd> 376<dd>
251Called whenever the user tries to extend the selection (e.g. with a double 377Called whenever the user tries to extend the selection (e.g. with a double
252click) and is either supposed to return false (normal operation), or 378click) and is either supposed to return false (normal operation), or
253should extend the selection itelf and return true to suppress the built-in 379should extend the selection itelf and return true to suppress the built-in
254processing. 380processing. This can happen multiple times, as long as the callback
381returns true, it will be called on every further click by the user and is
382supposed to enlarge the selection more and more, if possible.
255</dd> 383</dd>
256<dd> 384<dd>
257<p>See the <em>selection</em> example extension.</p> 385<p>See the <em>selection</em> example extension.</p>
258</dd> 386</dd>
259<p></p> 387<p></p>
… …
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 430and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
303might be very slow, however, as your hook is called for <strong>all</strong> text being 431might be very slow, however, as your hook is called for <strong>all</strong> text being
304output. 432output.
305</dd> 433</dd>
306<p></p> 434<p></p>
435<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
436</dt>
437<dd>
438Called whenever some data is written to the tty/pty and can be used to
439suppress or filter tty input.
440</dd>
441<p></p>
307<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 442<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
308</dt> 443</dt>
309<dd> 444<dd>
310Called whenever a line was updated or changed. Can be used to filter 445Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines 446screen output (e.g. underline urls or other useless stuff). Only lines
… …
357<dd> 492<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does 493Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing. 494focus out processing.
360</dd> 495</dd>
361<p></p> 496<p></p>
362<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 497<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
363</dt> 498</dt>
364<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 499<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
365</dt> 500</dt>
366<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 501<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
367</dt> 502</dt>
368<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 503<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
369</dt> 504</dt>
… …
392<p></p></dl> 527<p></p></dl>
393<p> 528<p>
394</p> 529</p>
395<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 530<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
396<dl> 531<dl>
532<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
533</dt>
534<dd>
535The rxvt-unicode library directory, where, among other things, the perl
536modules and scripts are stored.
537</dd>
538<p></p>
539<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
540</dt>
541<dd>
542The resource class and name rxvt-unicode uses to look up X resources.
543</dd>
544<p></p>
545<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
546</dt>
547<dd>
548The basename of the installed binaries, usually <code>urxvt</code>.
549</dd>
550<p></p>
397<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 551<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
398</dt> 552</dt>
399<dd> 553<dd>
400The current terminal. This variable stores the current <code>urxvt::term</code> 554The current terminal. This variable stores the current <code>urxvt::term</code>
401object, whenever a callback/hook is executing. 555object, whenever a callback/hook is executing.
… …
403<p></p></dl> 557<p></p></dl>
404<p> 558<p>
405</p> 559</p>
406<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 560<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
407<dl> 561<dl>
408<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
409</dt>
410<dd>
411Creates a new terminal, very similar as if you had started it with
412<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
413if the new instance couldn't be created. Returns <code>undef</code> if the new
414instance didn't initialise perl, and the terminal object otherwise. The
415<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
416</dd>
417<p></p>
418<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 562<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
419</dt> 563</dt>
420<dd> 564<dd>
421Fatally aborts execution with the given error message. Avoid at all 565Fatally aborts execution with the given error message. Avoid at all
422costs! The only time this is acceptable is when the terminal process 566costs! The only time this is acceptable is when the terminal process
… …
431that calls this function. 575that calls this function.
432</dd> 576</dd>
433<dd> 577<dd>
434<p>Using this function has the advantage that its output ends up in the 578<p>Using this function has the advantage that its output ends up in the
435correct place, e.g. on stderr of the connecting urxvtc client.</p> 579correct place, e.g. on stderr of the connecting urxvtc client.</p>
580</dd>
581<dd>
582<p>Messages have a size limit of 1023 bytes currently.</p>
583</dd>
584<p></p>
585<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
586</dt>
587<dd>
588Returns true when it is safe to do potentially unsafe things, such as
589evaluating perl code specified by the user. This is true when urxvt was
590started setuid or setgid.
436</dd> 591</dd>
437<p></p> 592<p></p>
438<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 593<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
439</dt> 594</dt>
440<dd> 595<dd>
… …
488</dt> 643</dt>
489<dd> 644<dd>
490Return the foreground/background colour index, respectively. 645Return the foreground/background colour index, respectively.
491</dd> 646</dd>
492<p></p> 647<p></p>
493<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 648<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
494</dt> 649</dt>
495<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 650<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
496</dt> 651</dt>
497<dd> 652<dd>
498Replace the foreground/background colour in the rendition mask with the 653Replace the foreground/background colour in the rendition mask with the
499specified one. 654specified one.
500</dd> 655</dd>
501<p></p> 656<p></p>
502<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 657<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
503</dt> 658</dt>
504<dd> 659<dd>
505Return the ``custom'' value: Every rendition has 5 bits for use by 660Return the ``custom'' value: Every rendition has 5 bits for use by
506extensions. They can be set and changed as you like and are initially 661extensions. They can be set and changed as you like and are initially
507zero. 662zero.
508</dd> 663</dd>
509<p></p> 664<p></p>
510<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 665<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
511</dt> 666</dt>
512<dd> 667<dd>
513Change the custom value. 668Change the custom value.
514</dd> 669</dd>
515<p></p></dl> 670<p></p></dl>
516<p> 671<p>
517</p> 672</p>
518<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 673<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
519<p>The sole purpose of this class is to deliver an interface to the 674<p>The sole purpose of this class is to deliver an interface to the
520<code>AnyEvent</code> module - any module using it will work inside urxvt without 675<code>AnyEvent</code> module - any module using it will work inside urxvt without
521further work. The only exception is that you cannot wait on condition 676further programming. The only exception is that you cannot wait on
522variables, but non-blocking condvar use is ok. What this means is that you 677condition variables, but non-blocking condvar use is ok. What this means
523cannot use blocking APIs, but the non-blocking variant should work.</p> 678is that you cannot use blocking APIs, but the non-blocking variant should
679work.</p>
524<p> 680<p>
525</p> 681</p>
526<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 682<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
527<dl> 683<dl>
684<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
685</dt>
686<dd>
687Creates a new terminal, very similar as if you had started it with system
688<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
689hash which defines the environment of the new terminal.
690</dd>
691<dd>
692<p>Croaks (and probably outputs an error message) if the new instance
693couldn't be created. Returns <code>undef</code> if the new instance didn't
694initialise perl, and the terminal object otherwise. The <code>init</code> and
695<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
696</dd>
697<p></p>
528<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 698<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
529</dt> 699</dt>
530<dd> 700<dd>
531Destroy the terminal object (close the window, free resources etc.). 701Destroy the terminal object (close the window, free resources
702etc.). Please note that rxvt will not exit as long as any event
703watchers (timers, io watchers) are still active.
532</dd> 704</dd>
533<p></p> 705<p></p>
534<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 706<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
535</dt> 707</dt>
536<dd> 708<dd>
… …
592 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 764 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
593 shade term_name title transparent transparent_all tripleclickwords 765 shade term_name title transparent transparent_all tripleclickwords
594 utmpInhibit visualBell</pre> 766 utmpInhibit visualBell</pre>
595</dd> 767</dd>
596<p></p> 768<p></p>
769<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
770</dt>
771<dd>
772Returns the X-Resource for the given pattern, excluding the program or
773class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
774same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
775resource with that pattern exists.
776</dd>
777<dd>
778<p>This method should only be called during the <code>on_start</code> hook, as there is
779only one resource database per display, and later invocations might return
780the wrong resources.</p>
781</dd>
782<p></p>
783<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
784</dt>
785<dd>
786Adds a keymap translation exactly as specified via a resource. See the
787<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
788</dd>
789<p></p>
597<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 790<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
598</dt> 791</dt>
599<dd> 792<dd>
600Return and optionally change the current rendition. Text that is output by 793Return and optionally change the current rendition. Text that is output by
601the terminal application will use this style. 794the terminal application will use this style.
… …
617<dd> 810<dd>
618Return the current values of the selection mark, begin or end positions, 811Return the current values of the selection mark, begin or end positions,
619and optionally set them to new values. 812and optionally set them to new values.
620</dd> 813</dd>
621<p></p> 814<p></p>
815<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
816</dt>
817<dd>
818Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
819<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
820rectangular selection will be made. This is the prefered function to make
821a selection.
822</dd>
823<p></p>
622<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 824<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
623</dt> 825</dt>
624<dd> 826<dd>
625Try to request the primary selection from the server (for example, as set 827Try to request the primary selection text from the server (for example, as
626by the next method). 828set by the next method). No visual feedback will be given. This function
829is mostly useful from within <code>on_sel_grab</code> hooks.
627</dd> 830</dd>
628<p></p> 831<p></p>
629<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 832<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
630</dt> 833</dt>
631<dd> 834<dd>
632Return the current selection text and optionally replace it by <code>$newtext</code>. 835Return the current selection text and optionally replace it by <code>$newtext</code>.
633</dd> 836</dd>
837<p></p>
838<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
839</dt>
634<dd> 840<dd>
635<p>#=item $term-&gt;overlay ($x, $y, $text)
636#
637#Create a simple multi-line overlay box. See the next method for details. 841Create a simple multi-line overlay box. See the next method for details.
638#
639#=cut
640#
641#sub urxvt::term::scr_overlay {
642# my ($self, $x, $y, $text) = @_;
643#
644# my @lines = split /\n/, $text;
645#
646# my $w = 0;
647# for (map $self-&gt;strwidth ($_), @lines) {
648# $w = $_ if $w &lt; $_;
649# }
650#
651# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
652# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
653#}</p>
654</dd> 842</dd>
655<p></p> 843<p></p>
656<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 844<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
657</dt> 845</dt>
658<dd> 846<dd>
… …
719<p></p> 907<p></p>
720<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 908<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
721</dt> 909</dt>
722<dd> 910<dd>
723Convert the given locale-encoded octets into a perl string. 911Convert the given locale-encoded octets into a perl string.
912</dd>
913<p></p>
914<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 />
915</dt>
916<dd>
917XORs the rendition values in the given span with the provided value
918(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
919refresh hooks to provide effects similar to the selection.
920</dd>
921<p></p>
922<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 />
923</dt>
924<dd>
925Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
926whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
927to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
928it instead. Both styles <em>MUST NOT</em> contain font styles.
929</dd>
930<p></p>
931<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
932</dt>
933<dd>
934Ring the bell!
724</dd> 935</dd>
725<p></p> 936<p></p>
726<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 937<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
727</dt> 938</dt>
728<dd> 939<dd>
… …
751Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 962Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
752pass characters instead of octets, you should convert your strings first 963pass characters instead of octets, you should convert your strings first
753to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 964to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
754</dd> 965</dd>
755<p></p> 966<p></p>
967<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
968</dt>
969<dd>
970Replaces the event mask of the pty watcher by the given event mask. Can
971be used to suppress input and output handling to the pty/tty. See the
972description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
973the previous value.
974</dd>
975<p></p>
756<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 976<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
757</dt> 977</dt>
758<dd> 978<dd>
759Return the window id of the toplevel window. 979Return the window id of the toplevel window.
760</dd> 980</dd>
… …
789</dt> 1009</dt>
790<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1010<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
791</dt> 1011</dt>
792<dd> 1012<dd>
793Return various integers describing terminal characteristics. 1013Return various integers describing terminal characteristics.
1014</dd>
1015<p></p>
1016<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1017</dt>
1018<dd>
1019Return the DISPLAY used by rxvt-unicode.
1020</dd>
1021<p></p>
1022<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1023</dt>
1024<dd>
1025Returns the LC_CTYPE category string used by this rxvt-unicode.
1026</dd>
1027<p></p>
1028<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1029</dt>
1030<dd>
1031Returns a copy of the environment in effect for the terminal as a hashref
1032similar to <code>\%ENV</code>.
794</dd> 1033</dd>
795<p></p> 1034<p></p>
796<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1035<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
797</dt> 1036</dt>
798<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1037<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
922<p></p> 1161<p></p>
923<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1162<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
924</dt> 1163</dt>
925<dd> 1164<dd>
926Returns the character offset of the given row|col pair within the logical 1165Returns the character offset of the given row|col pair within the logical
927line. 1166line. Works for rows outside the line, too, and returns corresponding
1167offsets outside the string.
928</dd> 1168</dd>
929<p></p> 1169<p></p>
930<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1170<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
931</dt> 1171</dt>
932<dd> 1172<dd>
… …
949</dd> 1189</dd>
950<p></p> 1190<p></p>
951<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1191<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
952</dt> 1192</dt>
953<dd> 1193<dd>
954Registers a synchronous button grab. See XGrabButton. 1194Registers a synchronous button grab. See the XGrabButton manpage.
955</dd> 1195</dd>
956<p></p> 1196<p></p>
957<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1197<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
958</dt> 1198</dt>
959<dd> 1199<dd>
… …
989</dd> 1229</dd>
990<p></p></dl> 1230<p></p></dl>
991<p> 1231<p>
992</p> 1232</p>
993<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1233<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1234<dl>
1235<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1236</dt>
1237<dd>
1238Adds a non-clickable title to the popup.
1239</dd>
1240<p></p>
1241<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1242</dt>
1243<dd>
1244Creates a separator, optionally using the character given as <code>$sepchr</code>.
1245</dd>
1246<p></p>
1247<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1248</dt>
1249<dd>
1250Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1251selected.
1252</dd>
1253<p></p>
1254<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1255</dt>
1256<dd>
1257Adds a toggle/checkbox item to the popup. Teh callback gets called
1258whenever it gets toggled, with a boolean indicating its value as its first
1259argument.
1260</dd>
1261<p></p>
1262<dt><strong>$popup-&gt;show</strong><br />
1263</dt>
1264<dd>
1265Displays the popup (which is initially hidden).
1266</dd>
1267<p></p></dl>
994<p> 1268<p>
995</p> 1269</p>
996<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1270<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
997<p>This class implements timer watchers/events. Time is represented as a 1271<p>This class implements timer watchers/events. Time is represented as a
998fractional number of seconds since the epoch. Example:</p> 1272fractional number of seconds since the epoch. Example:</p>
… …
1064<pre> 1338<pre>
1065 $term-&gt;{socket} = ... 1339 $term-&gt;{socket} = ...
1066 $term-&gt;{iow} = urxvt::iow 1340 $term-&gt;{iow} = urxvt::iow
1067 -&gt;new 1341 -&gt;new
1068 -&gt;fd (fileno $term-&gt;{socket}) 1342 -&gt;fd (fileno $term-&gt;{socket})
1069 -&gt;events (1) # wait for read data 1343 -&gt;events (urxvt::EVENT_READ)
1070 -&gt;start 1344 -&gt;start
1071 -&gt;cb (sub { 1345 -&gt;cb (sub {
1072 my ($iow, $revents) = @_; 1346 my ($iow, $revents) = @_;
1073 # $revents must be 1 here, no need to check 1347 # $revents must be 1 here, no need to check
1074 sysread $term-&gt;{socket}, my $buf, 8192 1348 sysread $term-&gt;{socket}, my $buf, 8192
… …
1095</dd> 1369</dd>
1096<p></p> 1370<p></p>
1097<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1371<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1098</dt> 1372</dt>
1099<dd> 1373<dd>
1100Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1374Set the event mask to watch. The only allowed values are
1101data, Bit #1 (value <code>2</code>) enables watching for write data. 1375<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1376together, or <code>urxvt::EVENT_NONE</code>.
1102</dd> 1377</dd>
1103<p></p> 1378<p></p>
1104<dt><strong>$iow = $iow-&gt;start</strong><br /> 1379<dt><strong>$iow = $iow-&gt;start</strong><br />
1105</dt> 1380</dt>
1106<dd> 1381<dd>
… …
1125<dl> 1400<dl>
1126<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1401<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1127</dt> 1402</dt>
1128<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1403<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1129</dt> 1404</dt>
1130<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1405<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1406</dt>
1407<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1131</dt> 1408</dt>
1132</dl> 1409</dl>
1133<p> 1410<p>
1134</p> 1411</p>
1135<hr /> 1412<hr />

Diff Legend

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