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.8 by root, Tue Jan 3 04:20:37 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>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
23 <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>
24 <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>
25 <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>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
26 <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>
27 <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>
28 </ul> 33 </ul>
29 34
30 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
60 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
61<p> 66<p>
62</p> 67</p>
63<hr /> 68<hr />
64<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
65<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
66<code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
67<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
68thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
69<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
70scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
71<p> 76<p>
72</p> 77</p>
73<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
74<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
75find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
76<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
77<pre> 83<pre>
78 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
79<dl> 85<dl>
80<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
81</dt> 87</dt>
88<dd>
89(More) intelligent selection. This extension tries to be more intelligent
90when the user extends selections (double-click). Right now, it tries to
91select urls and complete shell-quoted arguments, which is very convenient,
92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>.
82<dd> 93</dd>
83Miscellaneous selection modifications. 94<dd>
95<p>It also offers the following bindable keyboard command:</p>
84</dd> 96</dd>
85<dl> 97<dl>
86<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
87</dt> 99</dt>
88<dd> 100<dd>
… …
91<dd> 103<dd>
92<pre> 104<pre>
93 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 105 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
94</dd> 106</dd>
95<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>
96<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 />
97</dt> 138</dt>
98<dd> 139<dd>
99Displays a digital clock using the built-in overlay. 140Displays a digital clock using the built-in overlay.
141</dd>
142<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt>
145<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
147</dd>
148<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt>
151<dd>
152A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character.
100</dd> 155</dd>
101<p></p> 156<p></p>
102<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 157<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
103</dt> 158</dt>
104<dd> 159<dd>
105Displays 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
106window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
107overlays or changes. 162overlays or changes.
108</dd> 163</dd>
109<p></p></dl> 164<p></p></dl>
165<p>
166</p>
167<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
110<p> 169<p>
111</p> 170</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 171<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 172<p>All objects (such as terminals, time watchers etc.) are typical
114reference-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
115like. All members starting with an underscore (such as <code>_ptr</code> or 174like. All members starting with an underscore (such as <code>_ptr</code> or
116<code>_hook</code>) are reserved for internal uses and must not be accessed or 175<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 176modified).</p>
118<p>When objects are destroyed on the C++ side, the perl object hashes are 177<p>When objects are destroyed on the C++ side, the perl object hashes are
119emptied, so its best to store related objects such as time watchers and 178emptied, so its best to store related objects such as time watchers and
120the like inside the terminal object so they get destroyed as soon as the 179the like inside the terminal object so they get destroyed as soon as the
121terminal is destroyed.</p> 180terminal is destroyed.</p>
181<p>Argument names also often indicate the type of a parameter. Here are some
182hints on what they mean:</p>
183<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br />
185</dt>
186<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character
188always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
189</dd>
190<p></p>
191<dt><strong><a name="item__24string">$string</a></strong><br />
192</dt>
193<dd>
194A perl text string, with an emphasis on <em>text</em>. It can store all unicode
195characters and is to be distinguished with text encoded in a specific
196encoding (often locale-specific) and binary data.
197</dd>
198<p></p>
199<dt><strong><a name="item__24octets">$octets</a></strong><br />
200</dt>
201<dd>
202Either binary data or - more common - a text string encoded in a
203locale-specific way.
204</dd>
205<p></p></dl>
206<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>
122<p> 240<p>
123</p> 241</p>
124<h2><a name="hooks">Hooks</a></h2> 242<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 243<p>The following subroutines can be declared in extension files, and will be
126whenever the relevant event happens.</p> 244called whenever the relevant event happens.</p>
245<p>The first argument passed to them is an extension oject as described in
246the in the <code>Extension Objects</code> section.</p>
127<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
128counts 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
129and 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>
130<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>
131<dl> 251<dl>
132<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 />
133</dt> 253</dt>
134<dd> 254<dd>
135Called after a new terminal object has been initialized, but before 255Called after a new terminal object has been initialized, but before
136windows are created or the command gets run. 256windows are created or the command gets run. Most methods are unsafe to
257call or deliver senseless data, as terminal size and other characteristics
258have not yet been determined. You can safely query and change resources,
259though.
137</dd> 260</dd>
138<p></p> 261<p></p>
139<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 262<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
140</dt> 263</dt>
141<dd> 264<dd>
… …
172</dd> 295</dd>
173<dd> 296<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 297<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 298</dd>
176<p></p> 299<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 300<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
178</dt> 301</dt>
179<dd>
180Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing.
182</dd> 302<dd>
183<p></p> 303Called whenever the user tries to extend the selection (e.g. with a double
184<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 304click) and is either supposed to return false (normal operation), or
185</dt> 305should extend the selection itelf and return true to suppress the built-in
306processing.
186<dd> 307</dd>
187Called wheneever the window loses keyboard focus, before urxvt does focus 308<dd>
188out processing. 309<p>See the <em>selection</em> example extension.</p>
189</dd> 310</dd>
190<p></p> 311<p></p>
191<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 312<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
192</dt> 313</dt>
193<dd> 314<dd>
… …
207<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,
208$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
209number of lines that will be in the scrollback buffer.</p> 330number of lines that will be in the scrollback buffer.</p>
210</dd> 331</dd>
211<p></p> 332<p></p>
212<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 333<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
213</dt> 334</dt>
335<dd>
336Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
337operating system command) is processed. Cursor position and other state
338information is up-to-date when this happens. For interoperability, the
339string should start with the extension name and a colon, to distinguish
340it from commands for other extensions, and this might be enforced in the
341future.
214<dd> 342</dd>
215Called whenever the <code>program(s)</code> running in the urxvt window send output. 343<dd>
344<p>Be careful not ever to trust (in a security sense) the data you receive,
345as its source can not easily be controleld (e-mail content, messages from
346other users on the same system etc.).</p>
347</dd>
348<p></p>
349<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
350</dt>
351<dd>
352Called whenever text is about to be output, with the text as argument. You
353can filter/change and output the text yourself by returning a true value
354and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
355might be very slow, however, as your hook is called for <strong>all</strong> text being
356output.
357</dd>
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>
366<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
367</dt>
368<dd>
369Called whenever a line was updated or changed. Can be used to filter
370screen output (e.g. underline urls or other useless stuff). Only lines
371that are being shown will be filtered, and, due to performance reasons,
372not always immediately.
373</dd>
374<dd>
375<p>The row number is always the topmost row of the line if the line spans
376multiple rows.</p>
377</dd>
378<dd>
379<p>Please note that, if you change the line, then the hook might get called
380later with the already-modified line (e.g. if unrelated parts change), so
381you cannot just toggle rendition bits, but only set them.</p>
216</dd> 382</dd>
217<p></p> 383<p></p>
218<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 384<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
219</dt> 385</dt>
220<dd> 386<dd>
… …
235<dd> 401<dd>
236Called whenever the user presses a key combination that has a 402Called whenever the user presses a key combination that has a
237<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 403<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
238resource in the <code>rxvt(1)</code> manpage). 404resource in the <code>rxvt(1)</code> manpage).
239</dd> 405</dd>
406<p></p>
407<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
408</dt>
409<dd>
410Called whenever the window gets the keyboard focus, before rxvt-unicode
411does focus in processing.
412</dd>
413<p></p>
414<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
415</dt>
416<dd>
417Called wheneever the window loses keyboard focus, before rxvt-unicode does
418focus out processing.
419</dd>
420<p></p>
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 />
422</dt>
423<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
424</dt>
425<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
426</dt>
427<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
428</dt>
429<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
430</dt>
431<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
432</dt>
433<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
434</dt>
435<dd>
436Called whenever the corresponding X event is received for the terminal If
437the hook returns true, then the even will be ignored by rxvt-unicode.
438</dd>
439<dd>
440<p>The event is a hash with most values as named by Xlib (see the XEvent
441manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
442and column under the mouse cursor.</p>
443</dd>
444<dd>
445<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
446output, if any, in locale-specific encoding.</p>
447</dd>
448<dd>
449<p>subwindow.</p>
450</dd>
451<p></p></dl>
452<p>
453</p>
454<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
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>
475<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
476</dt>
477<dd>
478The current terminal. This variable stores the current <code>urxvt::term</code>
479object, whenever a callback/hook is executing.
480</dd>
240<p></p></dl> 481<p></p></dl>
241<p> 482<p>
242</p> 483</p>
243<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>
244<dl> 485<dl>
… …
259</dd> 500</dd>
260<dd> 501<dd>
261<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
262correct place, e.g. on stderr of the connecting urxvtc client.</p> 503correct place, e.g. on stderr of the connecting urxvtc client.</p>
263</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>
264<p></p> 516<p></p>
265<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 />
266</dt> 518</dt>
267<dd> 519<dd>
268Returns the ``current time'' (as per the event loop). 520Returns the ``current time'' (as per the event loop).
521</dd>
522<p></p>
523<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
524</dt>
525<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
526Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
527Button4Mask, Button5Mask, AnyModifier</a></strong><br />
528</dt>
529<dd>
530Various constants for use in X calls and event processing.
269</dd> 531</dd>
270<p></p></dl> 532<p></p></dl>
271<p> 533<p>
272</p> 534</p>
273<h2><a name="rendition">RENDITION</a></h2> 535<h2><a name="rendition">RENDITION</a></h2>
… …
305</dt> 567</dt>
306<dd> 568<dd>
307Return the foreground/background colour index, respectively. 569Return the foreground/background colour index, respectively.
308</dd> 570</dd>
309<p></p> 571<p></p>
310<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 />
311</dt> 573</dt>
312<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 />
313</dt> 575</dt>
314<dd> 576<dd>
315Replace the foreground/background colour in the rendition mask with the 577Replace the foreground/background colour in the rendition mask with the
316specified one. 578specified one.
317</dd> 579</dd>
318<p></p> 580<p></p>
319<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 />
320</dt> 582</dt>
321<dd> 583<dd>
322Return the ``custom'' value: Every rendition has 5 bits for use by 584Return the ``custom'' value: Every rendition has 5 bits for use by
323extensions. 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
324zero. 586zero.
325</dd> 587</dd>
326<p></p> 588<p></p>
327<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 />
328</dt> 590</dt>
329<dd> 591<dd>
330Change the custom value. 592Change the custom value.
331</dd> 593</dd>
332<p></p></dl> 594<p></p></dl>
333<p> 595<p>
334</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>
335<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>
336<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>
622<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
623</dt>
624<dd>
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.
628</dd>
629<p></p>
630<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
631</dt>
632<dd>
633Returns true if the option specified by <code>$optval</code> is enabled, and
634optionally change it. All option values are stored by name in the hash
635<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
636</dd>
637<dd>
638<p>Here is a a likely non-exhaustive list of option names, please see the
639source file <em>/src/optinc.h</em> to see the actual list:</p>
640</dd>
641<dd>
642<pre>
643 borderLess console cursorBlink cursorUnderline hold iconic insecure
644 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
645 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
646 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
647 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
648 tripleclickwords utmpInhibit visualBell</pre>
649</dd>
650<p></p>
337<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 651<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
338</dt> 652</dt>
339<dd> 653<dd>
340Returns the current resource value associated with a given name and 654Returns the current resource value associated with a given name and
341optionally sets a new value. Setting values is most useful in the <code>init</code> 655optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
355<p>Please note that resource strings will currently only be freed when the 669<p>Please note that resource strings will currently only be freed when the
356terminal is destroyed, so changing options frequently will eat memory.</p> 670terminal is destroyed, so changing options frequently will eat memory.</p>
357</dd> 671</dd>
358<dd> 672<dd>
359<p>Here is a a likely non-exhaustive list of resource names, not all of which 673<p>Here is a a likely non-exhaustive list of resource names, not all of which
360are supported in every build, please see the source to see the actual 674are supported in every build, please see the source file <em>/src/rsinc.h</em>
361list:</p> 675to see the actual list:</p>
362</dd> 676</dd>
363<dd> 677<dd>
364<pre> 678<pre>
365 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 679 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
366 borderLess color cursorBlink cursorUnderline cutchars delete_key 680 borderLess color cursorBlink cursorUnderline cutchars delete_key
367 display_name embed ext_bwidth fade font geometry hold iconName 681 display_name embed ext_bwidth fade font geometry hold iconName
368 imFont imLocale inputMethod insecure int_bwidth intensityStyles 682 imFont imLocale inputMethod insecure int_bwidth intensityStyles
369 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 683 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
370 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 684 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
371 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 685 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
372 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 686 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
373 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 687 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
374 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 688 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
375 shade term_name title transparent transparent_all tripleclickwords 689 shade term_name title transparent transparent_all tripleclickwords
376 utmpInhibit visualBell</pre> 690 utmpInhibit visualBell</pre>
377</dd> 691</dd>
378<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>
700<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
701</dt>
702<dd>
703Return and optionally change the current rendition. Text that is output by
704the terminal application will use this style.
705</dd>
706<p></p>
707<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
708</dt>
709<dd>
710Return the current coordinates of the text cursor position and optionally
711set it (which is usually bad as applications don't expect that).
712</dd>
713<p></p>
379<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 714<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
380</dt> 715</dt>
381<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 716<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
382</dt> 717</dt>
383<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 718<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
397<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 732<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
398</dt> 733</dt>
399<dd> 734<dd>
400Return 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>.
401</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>
402<dd> 740<dd>
403<p>#=item $term-&gt;overlay ($x, $y, $text)
404#
405#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.
406#
407#=cut</p>
408</dd>
409<dd>
410<p>sub urxvt::term::scr_overlay {
411die;
412 my ($self, $x, $y, $text) = @_;</p>
413</dd>
414<dd>
415<pre>
416 my @lines = split /\n/, $text;</pre>
417</dd>
418<dd>
419<pre>
420 my $w = 0;
421 for (map $self-&gt;strwidth ($_), @lines) {
422 $w = $_ if $w &lt; $_;
423 }</pre>
424</dd>
425<dd>
426<pre>
427 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
428 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
429}</pre>
430</dd> 742</dd>
431<p></p> 743<p></p>
432<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 />
433</dt> 745</dt>
434<dd> 746<dd>
… …
447<dd> 759<dd>
448<p>This method returns an urxvt::overlay object. The overlay will be visible 760<p>This method returns an urxvt::overlay object. The overlay will be visible
449as long as the perl object is referenced.</p> 761as long as the perl object is referenced.</p>
450</dd> 762</dd>
451<dd> 763<dd>
452<p>Currently, the only method on the <code>urxvt::overlay</code> object is <a href="#item_set"><code>set</code></a>:</p> 764<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
453</dd> 765</dd>
454<p></p> 766<dl>
455<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 767<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
456</dt> 768</dt>
457<dd> 769<dd>
458Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts 770Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
459text in rxvt-unicode's special encoding and an array of rendition values 771text in rxvt-unicode's special encoding and an array of rendition values
460at a specific position inside the overlay. 772at a specific position inside the overlay.
461</dd> 773</dd>
462<p></p> 774<p></p>
775<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
776</dt>
777<dd>
778If visible, hide the overlay, but do not destroy it.
779</dd>
780<p></p>
781<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
782</dt>
783<dd>
784If hidden, display the overlay again.
785</dd>
786<p></p></dl>
787<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
788</dt>
789<dd>
790Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
791<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
792currently).
793</dd>
794<p></p>
463<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 795<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
464</dt> 796</dt>
465<dd> 797<dd>
466Returns the number of screen-cells this string would need. Correctly 798Returns the number of screen-cells this string would need. Correctly
467accounts for wide and combining characters. 799accounts for wide and combining characters.
468</dd> 800</dd>
469<p></p> 801<p></p>
470<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 802<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
471</dt> 803</dt>
472<dd> 804<dd>
473Convert the given text string into the corresponding locale encoding. 805Convert the given text string into the corresponding locale encoding.
474</dd> 806</dd>
475<p></p> 807<p></p>
476<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 />
477</dt> 809</dt>
478<dd> 810<dd>
479Convert 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!
835</dd>
836<p></p>
837<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
838</dt>
839<dd>
840Write the given text string to the screen, as if output by the application
841running inside the terminal. It may not contain command sequences (escape
842codes), but is free to use line feeds, carriage returns and tabs. The
843string is a normal text string, not in locale-dependent encoding.
844</dd>
845<dd>
846<p>Normally its not a good idea to use this function, as programs might be
847confused by changes in cursor position or scrolling. Its useful inside a
848<code>on_add_lines</code> hook, though.</p>
849</dd>
850<p></p>
851<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
852</dt>
853<dd>
854Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
855locale-specific encoding of the terminal and can contain command sequences
856(escape codes) that will be interpreted.
480</dd> 857</dd>
481<p></p> 858<p></p>
482<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 859<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
483</dt> 860</dt>
484<dd> 861<dd>
485Write 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
486pass characters instead of octets, you should convert your strings first 863pass characters instead of octets, you should convert your strings first
487to 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>.
488</dd> 865</dd>
489<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>
876<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
877</dt>
878<dd>
879Return the window id of the toplevel window.
880</dd>
881<p></p>
882<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
883</dt>
884<dd>
885Return the window id of the terminal window.
886</dd>
887<p></p>
888<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
889</dt>
890<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
891</dt>
892<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
893</dt>
894<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
895</dt>
896<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
897</dt>
490<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 898<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
491</dt> 899</dt>
492<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 900<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
493</dt> 901</dt>
494<dd> 902<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
495Return the number of rows/columns of the terminal window (i.e. as 903</dt>
496specified by <code>-geometry</code>, excluding any scrollback). 904<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
905</dt>
906<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
907</dt>
908<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
909</dt>
910<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
911</dt>
497</dd> 912<dd>
913Return various integers describing terminal characteristics.
914</dd>
498<p></p> 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>
499<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 928<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
500</dt> 929</dt>
930<dd>
931Returns a copy of the environment in effect for the terminal as a hashref
932similar to <code>\%ENV</code>.
501<dd> 933</dd>
502Returns the number of lines in the scrollback buffer. 934<p></p>
935<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
936</dt>
937<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
938</dt>
939<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
940</dt>
941<dd>
942Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
943AltGr), the meta key (often Alt) and the num lock key, if applicable.
503</dd> 944</dd>
504<p></p> 945<p></p>
505<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 946<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
506</dt> 947</dt>
507<dd> 948<dd>
… …
525</dt> 966</dt>
526<dd> 967<dd>
527Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 968Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
528is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 969is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
529terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 970terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
530line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. 971line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
972is requested.
531</dd> 973</dd>
532<dd> 974<dd>
533<p>If <code>$new_text</code> is specified, it will replace characters in the current 975<p>If <code>$new_text</code> is specified, it will replace characters in the current
534line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 976line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
535to replace only parts of a line. The font index in the rendition will 977to replace only parts of a line. The font index in the rendition will
536automatically be updated.</p> 978automatically be updated.</p>
537</dd> 979</dd>
538<dd> 980<dd>
539<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 981<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
540than one cell when displayed are padded with urxvt::NOCHAR characters 982than one cell when displayed are padded with urxvt::NOCHAR characters
541(<code>chr 65535</code>). Characters with combining characters and other characters 983(<code>chr 65535</code>). Characters with combining characters and other characters
542that do not fit into the normal tetx encoding will be replaced with 984that do not fit into the normal tetx encoding will be replaced with
543characters in the private use area.</p> 985characters in the private use area.</p>
544</dd> 986</dd>
… …
567</dd> 1009</dd>
568<p></p> 1010<p></p>
569<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 1011<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
570</dt> 1012</dt>
571<dd> 1013<dd>
572Returns the number of screen cells that are in use (``the line length''). If 1014Returns the number of screen cells that are in use (``the line
573it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which 1015length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
574means all characters are in use and it is continued on the next row. 1016line is joined with the following one.
1017</dd>
1018<p></p>
1019<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1020</dt>
575</dd> 1021<dd>
1022Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1023joined with the following row), which means all characters are in use
1024and it is continued on the next row (and possibly a continuation of the
1025previous row(s)).
1026</dd>
576<p></p> 1027<p></p>
1028<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1029</dt>
1030<dd>
1031Create and return a new <code>urxvt::line</code> object that stores information
1032about the logical line that row <code>$row_number</code> is part of. It supports the
1033following methods:
1034</dd>
1035<dl>
1036<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1037</dt>
1038<dd>
1039Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1040</dd>
1041<p></p>
1042<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1043</dt>
1044<dd>
1045Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1046</dd>
1047<p></p>
1048<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1049</dt>
1050<dd>
1051Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1052</dd>
1053<p></p>
1054<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1055</dt>
1056<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1057</dt>
1058<dd>
1059Return the row number of the first/last row of the line, respectively.
1060</dd>
1061<p></p>
1062<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1063</dt>
1064<dd>
1065Returns the character offset of the given row|col pair within the logical
1066line.
1067</dd>
1068<p></p>
1069<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1070</dt>
1071<dd>
1072Translates a string offset into terminal coordinates again.
1073</dd>
1074<p></p></dl>
577<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 1075<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
578</dt> 1076</dt>
579<dd> 1077<dd>
580Converts a perl string into the special encoding used by rxvt-unicode, 1078Converts a perl string into the special encoding used by rxvt-unicode,
581where one character corresponds to one screen cell. See 1079where one character corresponds to one screen cell. See
… …
585<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1083<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
586</dt> 1084</dt>
587<dd> 1085<dd>
588Converts rxvt-unicodes text reprsentation into a perl string. See 1086Converts rxvt-unicodes text reprsentation into a perl string. See
589<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.
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>
1129<p></p></dl>
1130<p>
1131</p>
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).
590</dd> 1165</dd>
591<p></p></dl> 1166<p></p></dl>
592<p> 1167<p>
593</p> 1168</p>
594<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>
… …
662<pre> 1237<pre>
663 $term-&gt;{socket} = ... 1238 $term-&gt;{socket} = ...
664 $term-&gt;{iow} = urxvt::iow 1239 $term-&gt;{iow} = urxvt::iow
665 -&gt;new 1240 -&gt;new
666 -&gt;fd (fileno $term-&gt;{socket}) 1241 -&gt;fd (fileno $term-&gt;{socket})
667 -&gt;events (1) # wait for read data 1242 -&gt;events (urxvt::EVENT_READ)
668 -&gt;start 1243 -&gt;start
669 -&gt;cb (sub { 1244 -&gt;cb (sub {
670 my ($iow, $revents) = @_; 1245 my ($iow, $revents) = @_;
671 # $revents must be 1 here, no need to check 1246 # $revents must be 1 here, no need to check
672 sysread $term-&gt;{socket}, my $buf, 8192 1247 sysread $term-&gt;{socket}, my $buf, 8192
… …
693</dd> 1268</dd>
694<p></p> 1269<p></p>
695<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 />
696</dt> 1271</dt>
697<dd> 1272<dd>
698Set 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
699data, 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>.
700</dd> 1276</dd>
701<p></p> 1277<p></p>
702<dt><strong>$iow = $iow-&gt;start</strong><br /> 1278<dt><strong>$iow = $iow-&gt;start</strong><br />
703</dt> 1279</dt>
704<dd> 1280<dd>
… …
718<p> 1294<p>
719</p> 1295</p>
720<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1296<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
721<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
722numbers indicate more verbose output.</p> 1298numbers indicate more verbose output.</p>
723<ol> 1299<dl>
724<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1300<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
725</li> 1301</dt>
726<li><strong><a name="item__2d_script_loading_and_management">- 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 />
727</li> 1303</dt>
728<li><strong><a name="item__2d_all_events_received">- 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 />
1305</dt>
729</li> 1306</dl>
730</ol>
731<p> 1307<p>
732</p> 1308</p>
733<hr /> 1309<hr />
734<h1><a name="author">AUTHOR</a></h1> 1310<h1><a name="author">AUTHOR</a></h1>
735<pre> 1311<pre>

Diff Legend

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