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.25 by root, Thu Jan 12 05:37:34 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>
92<p>It also offers the following bindable event:</p> 100<p>It also offers the following bindable keyboard command:</p>
93</dd> 101</dd>
94<dl> 102<dl>
95<dt><strong><a name="item_rot13">rot13</a></strong><br /> 103<dt><strong><a name="item_rot13">rot13</a></strong><br />
96</dt> 104</dt>
97<dd> 105<dd>
… …
111<p></p> 119<p></p>
112<dt><strong>selection-popup (enabled by default)</strong><br /> 120<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt> 121</dt>
114<dd> 122<dd>
115Binds a popup menu to Ctrl-Button3 that lets you convert the selection 123Binds a popup menu to Ctrl-Button3 that lets you convert the selection
116text into various other formats/action. 124text into various other formats/action (such as uri unescaping, perl
125evalution, web-browser starting etc.), depending on content.
126</dd>
127<p></p>
128<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
129</dt>
130<dd>
131Adds regex search functionality to the scrollback buffer, triggered
132by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
133input/output is suspended and a regex is displayed at the bottom of the
134screen.
135</dd>
136<dd>
137<p>Inputting characters appends them to the regex and continues incremental
138search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
139search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
140bottom. <code>Escape</code> leaves search mode and returns to the point where search
141was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
142additionally stores the first match in the current line into the primary
143selection.</p>
117</dd> 144</dd>
118<p></p> 145<p></p>
119<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 146<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
120</dt> 147</dt>
121<dd> 148<dd>
… …
123</dd> 150</dd>
124<p></p> 151<p></p>
125<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 152<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
126</dt> 153</dt>
127<dd> 154<dd>
128Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 155Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
156make them clickable. When middle-clicked, the program specified in the
157resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
158the URL as first argument.
129</dd> 159</dd>
130<p></p> 160<p></p>
131<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 161<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
132</dt> 162</dt>
133<dd> 163<dd>
… …
142Displays a very simple digital clock in the upper right corner of the 172Displays a very simple digital clock in the upper right corner of the
143window. Illustrates overwriting the refresh callbacks to create your own 173window. Illustrates overwriting the refresh callbacks to create your own
144overlays or changes. 174overlays or changes.
145</dd> 175</dd>
146<p></p></dl> 176<p></p></dl>
177<p>
178</p>
179<hr />
180<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
147<p> 181<p>
148</p> 182</p>
149<h2><a name="general_api_considerations">General API Considerations</a></h2> 183<h2><a name="general_api_considerations">General API Considerations</a></h2>
150<p>All objects (such as terminals, time watchers etc.) are typical 184<p>All objects (such as terminals, time watchers etc.) are typical
151reference-to-hash objects. The hash can be used to store anything you 185reference-to-hash objects. The hash can be used to store anything you
… …
161<dl> 195<dl>
162<dt><strong><a name="item__24text">$text</a></strong><br /> 196<dt><strong><a name="item__24text">$text</a></strong><br />
163</dt> 197</dt>
164<dd> 198<dd>
165Rxvt-unicodes special way of encoding text, where one ``unicode'' character 199Rxvt-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. 200always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
167</dd> 201</dd>
168<p></p> 202<p></p>
169<dt><strong><a name="item__24string">$string</a></strong><br /> 203<dt><strong><a name="item__24string">$string</a></strong><br />
170</dt> 204</dt>
171<dd> 205<dd>
… …
181locale-specific way. 215locale-specific way.
182</dd> 216</dd>
183<p></p></dl> 217<p></p></dl>
184<p> 218<p>
185</p> 219</p>
220<h2><a name="extension_objects">Extension Objects</a></h2>
221<p>Very perl extension is a perl class. A separate perl object is created
222for each terminal and each extension and passed as the first parameter to
223hooks. So extensions can use their <code>$self</code> object without having to think
224about other extensions, with the exception of methods and members that
225begin with an underscore character <code>_</code>: these are reserved for internal
226use.</p>
227<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
228<code>urxvt::term</code> class on this object.</p>
229<p>It has the following methods and data members:</p>
230<dl>
231<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
232</dt>
233<dd>
234Returns the <code>urxvt::term</code> object associated with this instance of the
235extension. This member <em>must not</em> be changed in any way.
236</dd>
237<p></p>
238<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
239</dt>
240<dd>
241Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
242this extension, replacing any previous hook. This is useful when you want
243to overwrite time-critical hooks only temporarily.
244</dd>
245<p></p>
246<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
247</dt>
248<dd>
249Dynamically disable the given hooks.
250</dd>
251<p></p></dl>
252<p>
253</p>
186<h2><a name="hooks">Hooks</a></h2> 254<h2><a name="hooks">Hooks</a></h2>
187<p>The following subroutines can be declared in extension files, and will be 255<p>The following subroutines can be declared in extension files, and will be
188called whenever the relevant event happens.</p> 256called whenever the relevant event happens.</p>
189<p>The first argument passed to them is an object private to each terminal 257<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 258the 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 259<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, 260event 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> 261skipped, 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> 262<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
199<dl> 263<dl>
200<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 264<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
201</dt> 265</dt>
202<dd> 266<dd>
203Called after a new terminal object has been initialized, but before 267Called after a new terminal object has been initialized, but before
… …
249</dt> 313</dt>
250<dd> 314<dd>
251Called whenever the user tries to extend the selection (e.g. with a double 315Called whenever the user tries to extend the selection (e.g. with a double
252click) and is either supposed to return false (normal operation), or 316click) and is either supposed to return false (normal operation), or
253should extend the selection itelf and return true to suppress the built-in 317should extend the selection itelf and return true to suppress the built-in
254processing. 318processing. This can happen multiple times, as long as the callback
319returns true, it will be called on every further click by the user and is
320supposed to enlarge the selection more and more, if possible.
255</dd> 321</dd>
256<dd> 322<dd>
257<p>See the <em>selection</em> example extension.</p> 323<p>See the <em>selection</em> example extension.</p>
258</dd> 324</dd>
259<p></p> 325<p></p>
… …
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 368and 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 369might be very slow, however, as your hook is called for <strong>all</strong> text being
304output. 370output.
305</dd> 371</dd>
306<p></p> 372<p></p>
373<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
374</dt>
375<dd>
376Called whenever some data is written to the tty/pty and can be used to
377suppress or filter tty input.
378</dd>
379<p></p>
307<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 380<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
308</dt> 381</dt>
309<dd> 382<dd>
310Called whenever a line was updated or changed. Can be used to filter 383Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines 384screen output (e.g. underline urls or other useless stuff). Only lines
… …
357<dd> 430<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does 431Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing. 432focus out processing.
360</dd> 433</dd>
361<p></p> 434<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 /> 435<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> 436</dt>
364<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 437<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
365</dt> 438</dt>
366<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 439<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
367</dt> 440</dt>
368<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 441<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
369</dt> 442</dt>
… …
392<p></p></dl> 465<p></p></dl>
393<p> 466<p>
394</p> 467</p>
395<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 468<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
396<dl> 469<dl>
470<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
471</dt>
472<dd>
473The rxvt-unicode library directory, where, among other things, the perl
474modules and scripts are stored.
475</dd>
476<p></p>
477<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
478</dt>
479<dd>
480The resource class and name rxvt-unicode uses to look up X resources.
481</dd>
482<p></p>
483<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
484</dt>
485<dd>
486The basename of the installed binaries, usually <code>urxvt</code>.
487</dd>
488<p></p>
397<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 489<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
398</dt> 490</dt>
399<dd> 491<dd>
400The current terminal. This variable stores the current <code>urxvt::term</code> 492The current terminal. This variable stores the current <code>urxvt::term</code>
401object, whenever a callback/hook is executing. 493object, whenever a callback/hook is executing.
… …
403<p></p></dl> 495<p></p></dl>
404<p> 496<p>
405</p> 497</p>
406<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 498<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
407<dl> 499<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 /> 500<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
419</dt> 501</dt>
420<dd> 502<dd>
421Fatally aborts execution with the given error message. Avoid at all 503Fatally aborts execution with the given error message. Avoid at all
422costs! The only time this is acceptable is when the terminal process 504costs! The only time this is acceptable is when the terminal process
… …
431that calls this function. 513that calls this function.
432</dd> 514</dd>
433<dd> 515<dd>
434<p>Using this function has the advantage that its output ends up in the 516<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> 517correct place, e.g. on stderr of the connecting urxvtc client.</p>
518</dd>
519<dd>
520<p>Messages have a size limit of 1023 bytes currently.</p>
521</dd>
522<p></p>
523<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
524</dt>
525<dd>
526Returns true when it is safe to do potentially unsafe things, such as
527evaluating perl code specified by the user. This is true when urxvt was
528started setuid or setgid.
436</dd> 529</dd>
437<p></p> 530<p></p>
438<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 531<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
439</dt> 532</dt>
440<dd> 533<dd>
… …
488</dt> 581</dt>
489<dd> 582<dd>
490Return the foreground/background colour index, respectively. 583Return the foreground/background colour index, respectively.
491</dd> 584</dd>
492<p></p> 585<p></p>
493<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 586<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> 587</dt>
495<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 588<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> 589</dt>
497<dd> 590<dd>
498Replace the foreground/background colour in the rendition mask with the 591Replace the foreground/background colour in the rendition mask with the
499specified one. 592specified one.
500</dd> 593</dd>
501<p></p> 594<p></p>
502<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 595<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
503</dt> 596</dt>
504<dd> 597<dd>
505Return the ``custom'' value: Every rendition has 5 bits for use by 598Return the ``custom'' value: Every rendition has 5 bits for use by
506extensions. They can be set and changed as you like and are initially 599extensions. They can be set and changed as you like and are initially
507zero. 600zero.
508</dd> 601</dd>
509<p></p> 602<p></p>
510<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 603<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> 604</dt>
512<dd> 605<dd>
513Change the custom value. 606Change the custom value.
514</dd> 607</dd>
515<p></p></dl> 608<p></p></dl>
516<p> 609<p>
517</p> 610</p>
518<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 611<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 612<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 613<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 614further programming. The only exception is that you cannot wait on
522variables, but non-blocking condvar use is ok. What this means is that you 615condition variables, but non-blocking condvar use is ok. What this means
523cannot use blocking APIs, but the non-blocking variant should work.</p> 616is that you cannot use blocking APIs, but the non-blocking variant should
617work.</p>
524<p> 618<p>
525</p> 619</p>
526<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 620<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
527<dl> 621<dl>
622<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
623</dt>
624<dd>
625Creates a new terminal, very similar as if you had started it with system
626<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
627hash which defines the environment of the new terminal.
628</dd>
629<dd>
630<p>Croaks (and probably outputs an error message) if the new instance
631couldn't be created. Returns <code>undef</code> if the new instance didn't
632initialise perl, and the terminal object otherwise. The <code>init</code> and
633<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
634</dd>
635<p></p>
528<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 636<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
529</dt> 637</dt>
530<dd> 638<dd>
531Destroy the terminal object (close the window, free resources etc.). 639Destroy the terminal object (close the window, free resources
640etc.). Please note that rxvt will not exit as long as any event
641watchers (timers, io watchers) are still active.
532</dd> 642</dd>
533<p></p> 643<p></p>
534<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 644<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
535</dt> 645</dt>
536<dd> 646<dd>
… …
592 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 702 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
593 shade term_name title transparent transparent_all tripleclickwords 703 shade term_name title transparent transparent_all tripleclickwords
594 utmpInhibit visualBell</pre> 704 utmpInhibit visualBell</pre>
595</dd> 705</dd>
596<p></p> 706<p></p>
707<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
708</dt>
709<dd>
710Returns the X-Resource for the given pattern, excluding the program or
711class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
712same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
713resource with that pattern exists.
714</dd>
715<dd>
716<p>This method should only be called during the <code>on_start</code> hook, as there is
717only one resource database per display, and later invocations might return
718the wrong resources.</p>
719</dd>
720<p></p>
721<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
722</dt>
723<dd>
724Adds a keymap translation exactly as specified via a resource. See the
725<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
726</dd>
727<p></p>
597<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 728<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
598</dt> 729</dt>
599<dd> 730<dd>
600Return and optionally change the current rendition. Text that is output by 731Return and optionally change the current rendition. Text that is output by
601the terminal application will use this style. 732the terminal application will use this style.
… …
617<dd> 748<dd>
618Return the current values of the selection mark, begin or end positions, 749Return the current values of the selection mark, begin or end positions,
619and optionally set them to new values. 750and optionally set them to new values.
620</dd> 751</dd>
621<p></p> 752<p></p>
753<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
754</dt>
755<dd>
756Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
757<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
758rectangular selection will be made. This is the prefered function to make
759a selection.
760</dd>
761<p></p>
622<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 762<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
623</dt> 763</dt>
624<dd> 764<dd>
625Try to request the primary selection from the server (for example, as set 765Try to request the primary selection text from the server (for example, as
626by the next method). 766set by the next method). No visual feedback will be given. This function
767is mostly useful from within <code>on_sel_grab</code> hooks.
627</dd> 768</dd>
628<p></p> 769<p></p>
629<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 770<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
630</dt> 771</dt>
631<dd> 772<dd>
632Return the current selection text and optionally replace it by <code>$newtext</code>. 773Return the current selection text and optionally replace it by <code>$newtext</code>.
633</dd> 774</dd>
775<p></p>
776<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
777</dt>
634<dd> 778<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. 779Create 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> 780</dd>
655<p></p> 781<p></p>
656<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 782<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
657</dt> 783</dt>
658<dd> 784<dd>
… …
719<p></p> 845<p></p>
720<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 846<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
721</dt> 847</dt>
722<dd> 848<dd>
723Convert the given locale-encoded octets into a perl string. 849Convert the given locale-encoded octets into a perl string.
850</dd>
851<p></p>
852<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 />
853</dt>
854<dd>
855XORs the rendition values in the given span with the provided value
856(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
857refresh hooks to provide effects similar to the selection.
858</dd>
859<p></p>
860<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 />
861</dt>
862<dd>
863Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
864whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
865to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
866it instead. Both styles <em>MUST NOT</em> contain font styles.
867</dd>
868<p></p>
869<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
870</dt>
871<dd>
872Ring the bell!
724</dd> 873</dd>
725<p></p> 874<p></p>
726<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 875<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
727</dt> 876</dt>
728<dd> 877<dd>
… …
751Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 900Write 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 901pass 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>. 902to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
754</dd> 903</dd>
755<p></p> 904<p></p>
905<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
906</dt>
907<dd>
908Replaces the event mask of the pty watcher by the given event mask. Can
909be used to suppress input and output handling to the pty/tty. See the
910description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
911the previous value.
912</dd>
913<p></p>
756<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 914<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
757</dt> 915</dt>
758<dd> 916<dd>
759Return the window id of the toplevel window. 917Return the window id of the toplevel window.
760</dd> 918</dd>
… …
789</dt> 947</dt>
790<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 948<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
791</dt> 949</dt>
792<dd> 950<dd>
793Return various integers describing terminal characteristics. 951Return various integers describing terminal characteristics.
952</dd>
953<p></p>
954<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
955</dt>
956<dd>
957Return the DISPLAY used by rxvt-unicode.
958</dd>
959<p></p>
960<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
961</dt>
962<dd>
963Returns the LC_CTYPE category string used by this rxvt-unicode.
964</dd>
965<p></p>
966<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
967</dt>
968<dd>
969Returns a copy of the environment in effect for the terminal as a hashref
970similar to <code>\%ENV</code>.
794</dd> 971</dd>
795<p></p> 972<p></p>
796<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 973<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
797</dt> 974</dt>
798<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 975<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
922<p></p> 1099<p></p>
923<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1100<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
924</dt> 1101</dt>
925<dd> 1102<dd>
926Returns the character offset of the given row|col pair within the logical 1103Returns the character offset of the given row|col pair within the logical
927line. 1104line. Works for rows outside the line, too, and returns corresponding
1105offsets outside the string.
928</dd> 1106</dd>
929<p></p> 1107<p></p>
930<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1108<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
931</dt> 1109</dt>
932<dd> 1110<dd>
… …
949</dd> 1127</dd>
950<p></p> 1128<p></p>
951<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1129<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
952</dt> 1130</dt>
953<dd> 1131<dd>
954Registers a synchronous button grab. See XGrabButton. 1132Registers a synchronous button grab. See the XGrabButton manpage.
955</dd> 1133</dd>
956<p></p> 1134<p></p>
957<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1135<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
958</dt> 1136</dt>
959<dd> 1137<dd>
… …
989</dd> 1167</dd>
990<p></p></dl> 1168<p></p></dl>
991<p> 1169<p>
992</p> 1170</p>
993<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1171<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1172<dl>
1173<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1174</dt>
1175<dd>
1176Adds a non-clickable title to the popup.
1177</dd>
1178<p></p>
1179<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1180</dt>
1181<dd>
1182Creates a separator, optionally using the character given as <code>$sepchr</code>.
1183</dd>
1184<p></p>
1185<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1186</dt>
1187<dd>
1188Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1189selected.
1190</dd>
1191<p></p>
1192<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1193</dt>
1194<dd>
1195Adds a toggle/checkbox item to the popup. Teh callback gets called
1196whenever it gets toggled, with a boolean indicating its value as its first
1197argument.
1198</dd>
1199<p></p>
1200<dt><strong>$popup-&gt;show</strong><br />
1201</dt>
1202<dd>
1203Displays the popup (which is initially hidden).
1204</dd>
1205<p></p></dl>
994<p> 1206<p>
995</p> 1207</p>
996<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1208<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 1209<p>This class implements timer watchers/events. Time is represented as a
998fractional number of seconds since the epoch. Example:</p> 1210fractional number of seconds since the epoch. Example:</p>
… …
1064<pre> 1276<pre>
1065 $term-&gt;{socket} = ... 1277 $term-&gt;{socket} = ...
1066 $term-&gt;{iow} = urxvt::iow 1278 $term-&gt;{iow} = urxvt::iow
1067 -&gt;new 1279 -&gt;new
1068 -&gt;fd (fileno $term-&gt;{socket}) 1280 -&gt;fd (fileno $term-&gt;{socket})
1069 -&gt;events (1) # wait for read data 1281 -&gt;events (urxvt::EVENT_READ)
1070 -&gt;start 1282 -&gt;start
1071 -&gt;cb (sub { 1283 -&gt;cb (sub {
1072 my ($iow, $revents) = @_; 1284 my ($iow, $revents) = @_;
1073 # $revents must be 1 here, no need to check 1285 # $revents must be 1 here, no need to check
1074 sysread $term-&gt;{socket}, my $buf, 8192 1286 sysread $term-&gt;{socket}, my $buf, 8192
… …
1095</dd> 1307</dd>
1096<p></p> 1308<p></p>
1097<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1309<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1098</dt> 1310</dt>
1099<dd> 1311<dd>
1100Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1312Set the event mask to watch. The only allowed values are
1101data, Bit #1 (value <code>2</code>) enables watching for write data. 1313<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1314together, or <code>urxvt::EVENT_NONE</code>.
1102</dd> 1315</dd>
1103<p></p> 1316<p></p>
1104<dt><strong>$iow = $iow-&gt;start</strong><br /> 1317<dt><strong>$iow = $iow-&gt;start</strong><br />
1105</dt> 1318</dt>
1106<dd> 1319<dd>
… …
1125<dl> 1338<dl>
1126<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1339<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1127</dt> 1340</dt>
1128<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1341<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1129</dt> 1342</dt>
1130<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1343<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1344</dt>
1345<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1131</dt> 1346</dt>
1132</dl> 1347</dl>
1133<p> 1348<p>
1134</p> 1349</p>
1135<hr /> 1350<hr />

Diff Legend

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