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.15 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.23 by root, Wed Jan 11 01:01:52 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>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
30 </ul> 33 </ul>
… …
70thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
71<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
72scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
73<p> 76<p>
74</p> 77</p>
75<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
76<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
77find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
78<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
79<pre> 83<pre>
80 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
81<dl> 85<dl>
82<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
83</dt> 87</dt>
84<dd> 88<dd>
85Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
86the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click). Right now, it tries to
87urls and complete shell-quoted arguments, which is very convenient, too, 91select urls and complete shell-quoted arguments, which is very convenient,
88if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>.
89</dd>
90<dd> 93</dd>
94<dd>
91<p>It also offers the following bindable event:</p> 95<p>It also offers the following bindable keyboard command:</p>
92</dd> 96</dd>
93<dl> 97<dl>
94<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
95</dt> 99</dt>
96<dd> 100<dd>
… …
99<dd> 103<dd>
100<pre> 104<pre>
101 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 105 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
102</dd> 106</dd>
103<p></p></dl> 107<p></p></dl>
108<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
109</dt>
110<dd>
111Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
112runtime.
113</dd>
114<p></p>
115<dt><strong>selection-popup (enabled by default)</strong><br />
116</dt>
117<dd>
118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119text into various other formats/action (such as uri unescaping, perl
120evalution, web-browser starting etc.), depending on content.
121</dd>
122<p></p>
123<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt>
125<dd>
126Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal
128input/output is suspended.
129</dd>
130<dd>
131<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
132<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns to the original position.</p>
135</dd>
136<p></p>
104<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
105</dt> 138</dt>
106<dd> 139<dd>
107Displays a digital clock using the built-in overlay. 140Displays a digital clock using the built-in overlay.
108</dd> 141</dd>
… …
127Displays a very simple digital clock in the upper right corner of the 160Displays a very simple digital clock in the upper right corner of the
128window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
129overlays or changes. 162overlays or changes.
130</dd> 163</dd>
131<p></p></dl> 164<p></p></dl>
165<p>
166</p>
167<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
132<p> 169<p>
133</p> 170</p>
134<h2><a name="general_api_considerations">General API Considerations</a></h2> 171<h2><a name="general_api_considerations">General API Considerations</a></h2>
135<p>All objects (such as terminals, time watchers etc.) are typical 172<p>All objects (such as terminals, time watchers etc.) are typical
136reference-to-hash objects. The hash can be used to store anything you 173reference-to-hash objects. The hash can be used to store anything you
… …
146<dl> 183<dl>
147<dt><strong><a name="item__24text">$text</a></strong><br /> 184<dt><strong><a name="item__24text">$text</a></strong><br />
148</dt> 185</dt>
149<dd> 186<dd>
150Rxvt-unicodes special way of encoding text, where one ``unicode'' character 187Rxvt-unicodes special way of encoding text, where one ``unicode'' character
151always represents one screen cell. See <em>row_t</em> for a discussion of this format. 188always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
152</dd> 189</dd>
153<p></p> 190<p></p>
154<dt><strong><a name="item__24string">$string</a></strong><br /> 191<dt><strong><a name="item__24string">$string</a></strong><br />
155</dt> 192</dt>
156<dd> 193<dd>
… …
166locale-specific way. 203locale-specific way.
167</dd> 204</dd>
168<p></p></dl> 205<p></p></dl>
169<p> 206<p>
170</p> 207</p>
208<h2><a name="extension_objects">Extension Objects</a></h2>
209<p>Very perl extension is a perl class. A separate perl object is created
210for each terminal and each extension and passed as the first parameter to
211hooks. So extensions can use their <code>$self</code> object without having to think
212about other extensions, with the exception of methods and members that
213begin with an underscore character <code>_</code>: these are reserved for internal
214use.</p>
215<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
216<code>urxvt::term</code> class on this object.</p>
217<p>It has the following methods and data members:</p>
218<dl>
219<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
220</dt>
221<dd>
222Returns the <code>urxvt::term</code> object associated with this instance of the
223extension. This member <em>must not</em> be changed in any way.
224</dd>
225<p></p>
226<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
227</dt>
228<dd>
229Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
230this extension, replacing any previous hook. This is useful when you want
231to overwrite time-critical hooks only temporarily.
232</dd>
233<p></p>
234<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
235</dt>
236<dd>
237Dynamically disable the given hooks.
238</dd>
239<p></p></dl>
240<p>
241</p>
171<h2><a name="hooks">Hooks</a></h2> 242<h2><a name="hooks">Hooks</a></h2>
172<p>The following subroutines can be declared in extension files, and will be 243<p>The following subroutines can be declared in extension files, and will be
173called whenever the relevant event happens.</p> 244called whenever the relevant event happens.</p>
174<p>The first argument passed to them is an object private to each terminal 245<p>The first argument passed to them is an extension oject as described in
175and extension package. You can call all <code>urxvt::term</code> methods on it, but 246the in the <code>Extension Objects</code> section.</p>
176its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
177object that is shared between all packages is stored in the <code>term</code>
178member. It is, however, blessed intot he package of the extension script,
179so for all practical purposes you can treat an extension script as a class.</p>
180<p>All of them must return a boolean value. If it is true, then the event 247<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
181counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 248event counts as being <em>consumed</em>, and the invocation of other hooks is
182and the relevant action might not be carried out by the C++ code.</p> 249skipped, and the relevant action might not be carried out by the C++ code.</p>
183<p>When in doubt, return a false value (preferably <code>()</code>).</p> 250<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
184<dl> 251<dl>
185<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 252<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
186</dt> 253</dt>
187<dd> 254<dd>
188Called after a new terminal object has been initialized, but before 255Called after a new terminal object has been initialized, but before
… …
259</dd> 326</dd>
260<dd> 327<dd>
261<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 328<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
262$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 329$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
263number of lines that will be in the scrollback buffer.</p> 330number of lines that will be in the scrollback buffer.</p>
264</dd>
265<p></p>
266<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
267</dt>
268<dd>
269Called whenever the <code>program(s)</code> running in the urxvt window send output.
270</dd> 331</dd>
271<p></p> 332<p></p>
272<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 333<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
273</dt> 334</dt>
274<dd> 335<dd>
… …
293and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 354and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
294might be very slow, however, as your hook is called for <strong>all</strong> text being 355might be very slow, however, as your hook is called for <strong>all</strong> text being
295output. 356output.
296</dd> 357</dd>
297<p></p> 358<p></p>
359<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
360</dt>
361<dd>
362Called whenever some data is written to the tty/pty and can be used to
363suppress or filter tty input.
364</dd>
365<p></p>
298<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 366<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
299</dt> 367</dt>
300<dd> 368<dd>
301Called whenever a line was updated or changed. Can be used to filter 369Called whenever a line was updated or changed. Can be used to filter
302screen output (e.g. underline urls or other useless stuff). Only lines 370screen output (e.g. underline urls or other useless stuff). Only lines
… …
348<dd> 416<dd>
349Called wheneever the window loses keyboard focus, before rxvt-unicode does 417Called wheneever the window loses keyboard focus, before rxvt-unicode does
350focus out processing. 418focus out processing.
351</dd> 419</dd>
352<p></p> 420<p></p>
353<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 421<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
354</dt> 422</dt>
355<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 423<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
356</dt> 424</dt>
357<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 425<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
358</dt> 426</dt>
359<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 427<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
360</dt> 428</dt>
… …
383<p></p></dl> 451<p></p></dl>
384<p> 452<p>
385</p> 453</p>
386<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 454<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
387<dl> 455<dl>
456<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
457</dt>
458<dd>
459The rxvt-unicode library directory, where, among other things, the perl
460modules and scripts are stored.
461</dd>
462<p></p>
463<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
464</dt>
465<dd>
466The resource class and name rxvt-unicode uses to look up X resources.
467</dd>
468<p></p>
469<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
470</dt>
471<dd>
472The basename of the installed binaries, usually <code>urxvt</code>.
473</dd>
474<p></p>
388<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 475<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
389</dt> 476</dt>
390<dd> 477<dd>
391The current terminal. This variable stores the current <code>urxvt::term</code> 478The current terminal. This variable stores the current <code>urxvt::term</code>
392object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
… …
394<p></p></dl> 481<p></p></dl>
395<p> 482<p>
396</p> 483</p>
397<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 484<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
398<dl> 485<dl>
399<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
400</dt>
401<dd>
402Creates a new terminal, very similar as if you had started it with
403<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
404if the new instance couldn't be created. Returns <code>undef</code> if the new
405instance didn't initialise perl, and the terminal object otherwise. The
406<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
407</dd>
408<p></p>
409<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 486<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
410</dt> 487</dt>
411<dd> 488<dd>
412Fatally aborts execution with the given error message. Avoid at all 489Fatally aborts execution with the given error message. Avoid at all
413costs! The only time this is acceptable is when the terminal process 490costs! The only time this is acceptable is when the terminal process
… …
423</dd> 500</dd>
424<dd> 501<dd>
425<p>Using this function has the advantage that its output ends up in the 502<p>Using this function has the advantage that its output ends up in the
426correct place, e.g. on stderr of the connecting urxvtc client.</p> 503correct place, e.g. on stderr of the connecting urxvtc client.</p>
427</dd> 504</dd>
505<dd>
506<p>Messages have a size limit of 1023 bytes currently.</p>
507</dd>
508<p></p>
509<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
510</dt>
511<dd>
512Returns true when it is safe to do potentially unsafe things, such as
513evaluating perl code specified by the user. This is true when urxvt was
514started setuid or setgid.
515</dd>
428<p></p> 516<p></p>
429<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 517<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
430</dt> 518</dt>
431<dd> 519<dd>
432Returns the ``current time'' (as per the event loop). 520Returns the ``current time'' (as per the event loop).
… …
437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 525<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 526Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
439Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 527Button4Mask, Button5Mask, AnyModifier</a></strong><br />
440</dt> 528</dt>
441<dd> 529<dd>
442Various constants for use in X events. 530Various constants for use in X calls and event processing.
443</dd> 531</dd>
444<p></p></dl> 532<p></p></dl>
445<p> 533<p>
446</p> 534</p>
447<h2><a name="rendition">RENDITION</a></h2> 535<h2><a name="rendition">RENDITION</a></h2>
… …
479</dt> 567</dt>
480<dd> 568<dd>
481Return the foreground/background colour index, respectively. 569Return the foreground/background colour index, respectively.
482</dd> 570</dd>
483<p></p> 571<p></p>
484<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 572<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
485</dt> 573</dt>
486<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 574<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
487</dt> 575</dt>
488<dd> 576<dd>
489Replace the foreground/background colour in the rendition mask with the 577Replace the foreground/background colour in the rendition mask with the
490specified one. 578specified one.
491</dd> 579</dd>
492<p></p> 580<p></p>
493<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 581<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
494</dt> 582</dt>
495<dd> 583<dd>
496Return the ``custom'' value: Every rendition has 5 bits for use by 584Return the ``custom'' value: Every rendition has 5 bits for use by
497extensions. They can be set and changed as you like and are initially 585extensions. They can be set and changed as you like and are initially
498zero. 586zero.
499</dd> 587</dd>
500<p></p> 588<p></p>
501<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 589<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
502</dt> 590</dt>
503<dd> 591<dd>
504Change the custom value. 592Change the custom value.
505</dd> 593</dd>
506<p></p></dl> 594<p></p></dl>
507<p> 595<p>
508</p> 596</p>
597<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
598<p>The sole purpose of this class is to deliver an interface to the
599<code>AnyEvent</code> module - any module using it will work inside urxvt without
600further programming. The only exception is that you cannot wait on
601condition variables, but non-blocking condvar use is ok. What this means
602is that you cannot use blocking APIs, but the non-blocking variant should
603work.</p>
604<p>
605</p>
509<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 606<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
510<dl> 607<dl>
608<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
609</dt>
610<dd>
611Creates a new terminal, very similar as if you had started it with system
612<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
613hash which defines the environment of the new terminal.
614</dd>
615<dd>
616<p>Croaks (and probably outputs an error message) if the new instance
617couldn't be created. Returns <code>undef</code> if the new instance didn't
618initialise perl, and the terminal object otherwise. The <code>init</code> and
619<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
620</dd>
621<p></p>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 622<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
512</dt> 623</dt>
513<dd> 624<dd>
514Destroy the terminal object (close the window, free resources etc.). 625Destroy the terminal object (close the window, free resources
626etc.). Please note that rxvt will not exit as long as any event
627watchers (timers, io watchers) are still active.
515</dd> 628</dd>
516<p></p> 629<p></p>
517<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 630<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
518</dt> 631</dt>
519<dd> 632<dd>
… …
575 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 688 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
576 shade term_name title transparent transparent_all tripleclickwords 689 shade term_name title transparent transparent_all tripleclickwords
577 utmpInhibit visualBell</pre> 690 utmpInhibit visualBell</pre>
578</dd> 691</dd>
579<p></p> 692<p></p>
693<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
694</dt>
695<dd>
696Adds a keymap translation exactly as specified via a resource. See the
697<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
698</dd>
699<p></p>
580<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 700<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
581</dt> 701</dt>
582<dd> 702<dd>
583Return and optionally change the current rendition. Text that is output by 703Return and optionally change the current rendition. Text that is output by
584the terminal application will use this style. 704the terminal application will use this style.
… …
612<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 732<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
613</dt> 733</dt>
614<dd> 734<dd>
615Return the current selection text and optionally replace it by <code>$newtext</code>. 735Return the current selection text and optionally replace it by <code>$newtext</code>.
616</dd> 736</dd>
737<p></p>
738<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
739</dt>
617<dd> 740<dd>
618<p>#=item $term-&gt;overlay ($x, $y, $text)
619#
620#Create a simple multi-line overlay box. See the next method for details. 741Create a simple multi-line overlay box. See the next method for details.
621#
622#=cut
623#
624#sub urxvt::term::scr_overlay {
625# my ($self, $x, $y, $text) = @_;
626#
627# my @lines = split /\n/, $text;
628#
629# my $w = 0;
630# for (map $self-&gt;strwidth ($_), @lines) {
631# $w = $_ if $w &lt; $_;
632# }
633#
634# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
635# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
636#}</p>
637</dd> 742</dd>
638<p></p> 743<p></p>
639<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 744<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
640</dt> 745</dt>
641<dd> 746<dd>
… …
677</dt> 782</dt>
678<dd> 783<dd>
679If hidden, display the overlay again. 784If hidden, display the overlay again.
680</dd> 785</dd>
681<p></p></dl> 786<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br /> 787<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
683</dt> 788</dt>
684<dd> 789<dd>
685Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 790Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
686<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, 791<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
687currently). 792currently).
… …
702<p></p> 807<p></p>
703<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 808<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
704</dt> 809</dt>
705<dd> 810<dd>
706Convert the given locale-encoded octets into a perl string. 811Convert the given locale-encoded octets into a perl string.
812</dd>
813<p></p>
814<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 />
815</dt>
816<dd>
817XORs the rendition values in the given span with the provided value
818(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
819to the selection.
820</dd>
821<p></p>
822<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 />
823</dt>
824<dd>
825Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
826whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
827to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
828it instead.
829</dd>
830<p></p>
831<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
832</dt>
833<dd>
834Ring the bell!
707</dd> 835</dd>
708<p></p> 836<p></p>
709<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 837<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
710</dt> 838</dt>
711<dd> 839<dd>
… …
734Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 862Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
735pass characters instead of octets, you should convert your strings first 863pass characters instead of octets, you should convert your strings first
736to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 864to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
737</dd> 865</dd>
738<p></p> 866<p></p>
867<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
868</dt>
869<dd>
870Replaces the event mask of the pty watcher by the given event mask. Can
871be used to suppress input and output handling to the pty/tty. See the
872description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
873the previous value.
874</dd>
875<p></p>
739<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 876<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
740</dt> 877</dt>
741<dd> 878<dd>
742Return the window id of the toplevel window. 879Return the window id of the toplevel window.
743</dd> 880</dd>
… …
772</dt> 909</dt>
773<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 910<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
774</dt> 911</dt>
775<dd> 912<dd>
776Return various integers describing terminal characteristics. 913Return various integers describing terminal characteristics.
914</dd>
915<p></p>
916<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
917</dt>
918<dd>
919Return the DISPLAY used by rxvt-unicode.
920</dd>
921<p></p>
922<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
923</dt>
924<dd>
925Returns the LC_CTYPE category string used by this rxvt-unicode.
926</dd>
927<p></p>
928<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
929</dt>
930<dd>
931Returns a copy of the environment in effect for the terminal as a hashref
932similar to <code>\%ENV</code>.
777</dd> 933</dd>
778<p></p> 934<p></p>
779<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 935<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
780</dt> 936</dt>
781<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 937<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
832<p>You have to obey this encoding when changing text. The advantage is 988<p>You have to obey this encoding when changing text. The advantage is
833that <code>substr</code> and similar functions work on screen cells and not on 989that <code>substr</code> and similar functions work on screen cells and not on
834characters.</p> 990characters.</p>
835</dd> 991</dd>
836<dd> 992<dd>
837<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 993<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
838can be used to convert normal strings into this encoding and vice versa.</p> 994can be used to convert normal strings into this encoding and vice versa.</p>
839</dd> 995</dd>
840<p></p> 996<p></p>
841<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 997<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
842</dt> 998</dt>
… …
914</dt> 1070</dt>
915<dd> 1071<dd>
916Translates a string offset into terminal coordinates again. 1072Translates a string offset into terminal coordinates again.
917</dd> 1073</dd>
918<p></p></dl> 1074<p></p></dl>
919<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1075<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
920=item $text = $term-&gt;special_encode $string</strong><br />
921</dt> 1076</dt>
922<dd> 1077<dd>
923Converts a perl string into the special encoding used by rxvt-unicode, 1078Converts a perl string into the special encoding used by rxvt-unicode,
924where one character corresponds to one screen cell. See 1079where one character corresponds to one screen cell. See
925<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1080<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
929</dt> 1084</dt>
930<dd> 1085<dd>
931Converts rxvt-unicodes text reprsentation into a perl string. See 1086Converts rxvt-unicodes text reprsentation into a perl string. See
932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1087<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
933</dd> 1088</dd>
1089<p></p>
1090<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1091</dt>
1092<dd>
1093Registers a synchronous button grab. See the XGrabButton manpage.
1094</dd>
1095<p></p>
1096<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1097</dt>
1098<dd>
1099Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1100synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1101</dd>
1102<p></p>
1103<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1104</dt>
1105<dd>
1106Calls XAllowEvents with AsyncBoth for the most recent grab.
1107</dd>
1108<p></p>
1109<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1110</dt>
1111<dd>
1112Calls XAllowEvents with SyncBoth for the most recent grab.
1113</dd>
1114<p></p>
1115<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1116</dt>
1117<dd>
1118Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1119recent grab.
1120</dd>
1121<p></p>
1122<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1123</dt>
1124<dd>
1125Calls XUngrab for the most recent grab. Is called automatically on
1126evaluation errors, as it is better to lose the grab in the error case as
1127the session.
1128</dd>
934<p></p></dl> 1129<p></p></dl>
935<p> 1130<p>
936</p> 1131</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1132<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1133<dl>
1134<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1135</dt>
1136<dd>
1137Adds a non-clickable title to the popup.
1138</dd>
1139<p></p>
1140<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1141</dt>
1142<dd>
1143Creates a separator, optionally using the character given as <code>$sepchr</code>.
1144</dd>
1145<p></p>
1146<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1147</dt>
1148<dd>
1149Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1150selected.
1151</dd>
1152<p></p>
1153<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1154</dt>
1155<dd>
1156Adds a toggle/checkbox item to the popup. Teh callback gets called
1157whenever it gets toggled, with a boolean indicating its value as its first
1158argument.
1159</dd>
1160<p></p>
1161<dt><strong>$popup-&gt;show</strong><br />
1162</dt>
1163<dd>
1164Displays the popup (which is initially hidden).
1165</dd>
1166<p></p></dl>
938<p> 1167<p>
939</p> 1168</p>
940<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1169<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
941<p>This class implements timer watchers/events. Time is represented as a 1170<p>This class implements timer watchers/events. Time is represented as a
942fractional number of seconds since the epoch. Example:</p> 1171fractional number of seconds since the epoch. Example:</p>
… …
1008<pre> 1237<pre>
1009 $term-&gt;{socket} = ... 1238 $term-&gt;{socket} = ...
1010 $term-&gt;{iow} = urxvt::iow 1239 $term-&gt;{iow} = urxvt::iow
1011 -&gt;new 1240 -&gt;new
1012 -&gt;fd (fileno $term-&gt;{socket}) 1241 -&gt;fd (fileno $term-&gt;{socket})
1013 -&gt;events (1) # wait for read data 1242 -&gt;events (urxvt::EVENT_READ)
1014 -&gt;start 1243 -&gt;start
1015 -&gt;cb (sub { 1244 -&gt;cb (sub {
1016 my ($iow, $revents) = @_; 1245 my ($iow, $revents) = @_;
1017 # $revents must be 1 here, no need to check 1246 # $revents must be 1 here, no need to check
1018 sysread $term-&gt;{socket}, my $buf, 8192 1247 sysread $term-&gt;{socket}, my $buf, 8192
… …
1039</dd> 1268</dd>
1040<p></p> 1269<p></p>
1041<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1270<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1042</dt> 1271</dt>
1043<dd> 1272<dd>
1044Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1273Set the event mask to watch. The only allowed values are
1045data, Bit #1 (value <code>2</code>) enables watching for write data. 1274<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1275together, or <code>urxvt::EVENT_NONE</code>.
1046</dd> 1276</dd>
1047<p></p> 1277<p></p>
1048<dt><strong>$iow = $iow-&gt;start</strong><br /> 1278<dt><strong>$iow = $iow-&gt;start</strong><br />
1049</dt> 1279</dt>
1050<dd> 1280<dd>
… …
1065</p> 1295</p>
1066<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1296<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1067<p>This variable controls the verbosity level of the perl extension. Higher 1297<p>This variable controls the verbosity level of the perl extension. Higher
1068numbers indicate more verbose output.</p> 1298numbers indicate more verbose output.</p>
1069<dl> 1299<dl>
1070<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1300<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1071</dt> 1301</dt>
1072<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1302<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1073</dt> 1303</dt>
1074<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1304<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1075</dt> 1305</dt>
1076</dl> 1306</dl>
1077<p> 1307<p>
1078</p> 1308</p>
1079<hr /> 1309<hr />

Diff Legend

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