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.9 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.22 by root, Wed Jan 11 01:00:03 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>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
27 <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>
28 <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>
29 </ul> 33 </ul>
30 34
31 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 66<p>
63</p> 67</p>
64<hr /> 68<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 71the <code>perl</code> resource are loaded and associated with it.</p>
68<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
69thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
70<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
71scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
72<p> 76<p>
73</p> 77</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
75<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
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
78<pre> 83<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 85<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 87</dt>
83<dd>
84Intelligent selection. This etxension tries to be more intelligent when the user
85extends selections (double-click).
86</dd> 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>.
87<dd> 93</dd>
94<dd>
88<p>It also offers the following bindable event:</p> 95<p>It also offers the following bindable keyboard command:</p>
89</dd> 96</dd>
90<dl> 97<dl>
91<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
92</dt> 99</dt>
93<dd> 100<dd>
… …
96<dd> 103<dd>
97<pre> 104<pre>
98 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 105 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
99</dd> 106</dd>
100<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>
101<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 />
102</dt> 138</dt>
103<dd> 139<dd>
104Displays 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.
105</dd> 155</dd>
106<p></p> 156<p></p>
107<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 />
108</dt> 158</dt>
109<dd> 159<dd>
110Displays 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
111window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
112overlays or changes. 162overlays or changes.
113</dd> 163</dd>
114<p></p></dl> 164<p></p></dl>
165<p>
166</p>
167<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
115<p> 169<p>
116</p> 170</p>
117<h2><a name="general_api_considerations">General API Considerations</a></h2> 171<h2><a name="general_api_considerations">General API Considerations</a></h2>
118<p>All objects (such as terminals, time watchers etc.) are typical 172<p>All objects (such as terminals, time watchers etc.) are typical
119reference-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
… …
122modified).</p> 176modified).</p>
123<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
124emptied, 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
125the 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
126terminal 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 <em>row_t</em> 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>
127<p> 240<p>
128</p> 241</p>
129<h2><a name="hooks">Hooks</a></h2> 242<h2><a name="hooks">Hooks</a></h2>
130<p>The following subroutines can be declared in loaded scripts, and will be 243<p>The following subroutines can be declared in extension files, and will be
131called whenever the relevant event happens.</p> 244called whenever the relevant event happens.</p>
132<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
133and extension package. You can call all <code>urxvt::term</code> methods on it, but 246the in the <code>Extension Objects</code> section.</p>
134its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
135object that is shared between all packages is stored in the <code>term</code>
136member.</p>
137<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
138counts 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
139and 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>
140<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>
141<dl> 251<dl>
142<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 />
143</dt> 253</dt>
144<dd> 254<dd>
145Called after a new terminal object has been initialized, but before 255Called after a new terminal object has been initialized, but before
146windows 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.
147</dd> 260</dd>
148<p></p> 261<p></p>
149<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 />
150</dt> 263</dt>
151<dd> 264<dd>
… …
194</dd> 307</dd>
195<dd> 308<dd>
196<p>See the <em>selection</em> example extension.</p> 309<p>See the <em>selection</em> example extension.</p>
197</dd> 310</dd>
198<p></p> 311<p></p>
199<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
200</dt>
201<dd>
202Called whenever the window gets the keyboard focus, before urxvt does
203focus in processing.
204</dd>
205<p></p>
206<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
207</dt>
208<dd>
209Called wheneever the window loses keyboard focus, before urxvt does focus
210out processing.
211</dd>
212<p></p>
213<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 />
214</dt> 313</dt>
215<dd> 314<dd>
216Called whenever the view offset changes, i..e the user or program 315Called whenever the view offset changes, i..e the user or program
217scrolls. Offset <code>0</code> means display the normal terminal, positive values 316scrolls. Offset <code>0</code> means display the normal terminal, positive values
… …
229<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,
230$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
231number of lines that will be in the scrollback buffer.</p> 330number of lines that will be in the scrollback buffer.</p>
232</dd> 331</dd>
233<p></p> 332<p></p>
234<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 />
235</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.
236<dd> 342</dd>
237Called 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>
238</dd> 382</dd>
239<p></p> 383<p></p>
240<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 />
241</dt> 385</dt>
242<dd> 386<dd>
… …
257<dd> 401<dd>
258Called whenever the user presses a key combination that has a 402Called whenever the user presses a key combination that has a
259<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>
260resource in the <code>rxvt(1)</code> manpage). 404resource in the <code>rxvt(1)</code> manpage).
261</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>
262<p></p></dl> 451<p></p></dl>
263<p> 452<p>
264</p> 453</p>
265<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>
266<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>
267<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 />
268</dt> 476</dt>
269<dd> 477<dd>
270The current terminal. Whenever a callback/Hook is bein executed, this 478The current terminal. This variable stores the current <code>urxvt::term</code>
271variable stores the current <code>urxvt::term</code> object. 479object, whenever a callback/hook is executing.
480</dd>
481<p></p>
482<dt></dt>
272</dd> 483</dl>
273<p></p></dl>
274<p> 484<p>
275</p> 485</p>
276<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
277<dl> 487<dl>
278<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 488<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
… …
292</dd> 502</dd>
293<dd> 503<dd>
294<p>Using this function has the advantage that its output ends up in the 504<p>Using this function has the advantage that its output ends up in the
295correct place, e.g. on stderr of the connecting urxvtc client.</p> 505correct place, e.g. on stderr of the connecting urxvtc client.</p>
296</dd> 506</dd>
507<dd>
508<p>Messages have a size limit of 1023 bytes currently.</p>
509</dd>
510<p></p>
511<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
512</dt>
513<dd>
514Returns true when it is safe to do potentially unsafe things, such as
515evaluating perl code specified by the user. This is true when urxvt was
516started setuid or setgid.
517</dd>
297<p></p> 518<p></p>
298<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 519<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
299</dt> 520</dt>
300<dd> 521<dd>
301Returns the ``current time'' (as per the event loop). 522Returns the ``current time'' (as per the event loop).
523</dd>
524<p></p>
525<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
526</dt>
527<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
528Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
529Button4Mask, Button5Mask, AnyModifier</a></strong><br />
530</dt>
531<dd>
532Various constants for use in X calls and event processing.
302</dd> 533</dd>
303<p></p></dl> 534<p></p></dl>
304<p> 535<p>
305</p> 536</p>
306<h2><a name="rendition">RENDITION</a></h2> 537<h2><a name="rendition">RENDITION</a></h2>
… …
338</dt> 569</dt>
339<dd> 570<dd>
340Return the foreground/background colour index, respectively. 571Return the foreground/background colour index, respectively.
341</dd> 572</dd>
342<p></p> 573<p></p>
343<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 574<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
344</dt> 575</dt>
345<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 576<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
346</dt> 577</dt>
347<dd> 578<dd>
348Replace the foreground/background colour in the rendition mask with the 579Replace the foreground/background colour in the rendition mask with the
349specified one. 580specified one.
350</dd> 581</dd>
351<p></p> 582<p></p>
352<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 583<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
353</dt> 584</dt>
354<dd> 585<dd>
355Return the ``custom'' value: Every rendition has 5 bits for use by 586Return the ``custom'' value: Every rendition has 5 bits for use by
356extensions. They can be set and changed as you like and are initially 587extensions. They can be set and changed as you like and are initially
357zero. 588zero.
358</dd> 589</dd>
359<p></p> 590<p></p>
360<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 591<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
361</dt> 592</dt>
362<dd> 593<dd>
363Change the custom value. 594Change the custom value.
364</dd> 595</dd>
365<p></p></dl> 596<p></p></dl>
366<p> 597<p>
367</p> 598</p>
599<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
600<p>The sole purpose of this class is to deliver an interface to the
601<code>AnyEvent</code> module - any module using it will work inside urxvt without
602further programming. The only exception is that you cannot wait on
603condition variables, but non-blocking condvar use is ok. What this means
604is that you cannot use blocking APIs, but the non-blocking variant should
605work.</p>
606<p>
607</p>
368<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 608<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
369<dl> 609<dl>
610<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
611</dt>
612<dd>
613Creates a new terminal, very similar as if you had started it with system
614<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a %ENV&gt;-like
615<code></code>hash which defines the environment of the new terminal.
616</dd>
617<dd>
618<p>&gt;Croaks (and probably outputs an error message) if the new instance
619couldn't be created. Returns <code>undef</code> if the new instance didn't
620initialise perl, and the terminal object otherwise. The <code>init</code> and
621<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
622</dd>
623<p></p>
624<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
625</dt>
626<dd>
627Destroy the terminal object (close the window, free resources
628etc.). Please note that rxvt will not exit as long as any event
629watchers (timers, io watchers) are still active.
630</dd>
631<p></p>
632<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
633</dt>
634<dd>
635Returns true if the option specified by <code>$optval</code> is enabled, and
636optionally change it. All option values are stored by name in the hash
637<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
638</dd>
639<dd>
640<p>Here is a a likely non-exhaustive list of option names, please see the
641source file <em>/src/optinc.h</em> to see the actual list:</p>
642</dd>
643<dd>
644<pre>
645 borderLess console cursorBlink cursorUnderline hold iconic insecure
646 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
647 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
648 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
649 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
650 tripleclickwords utmpInhibit visualBell</pre>
651</dd>
652<p></p>
370<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 653<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
371</dt> 654</dt>
372<dd> 655<dd>
373Returns the current resource value associated with a given name and 656Returns the current resource value associated with a given name and
374optionally sets a new value. Setting values is most useful in the <code>init</code> 657optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
388<p>Please note that resource strings will currently only be freed when the 671<p>Please note that resource strings will currently only be freed when the
389terminal is destroyed, so changing options frequently will eat memory.</p> 672terminal is destroyed, so changing options frequently will eat memory.</p>
390</dd> 673</dd>
391<dd> 674<dd>
392<p>Here is a a likely non-exhaustive list of resource names, not all of which 675<p>Here is a a likely non-exhaustive list of resource names, not all of which
393are supported in every build, please see the source to see the actual 676are supported in every build, please see the source file <em>/src/rsinc.h</em>
394list:</p> 677to see the actual list:</p>
395</dd> 678</dd>
396<dd> 679<dd>
397<pre> 680<pre>
398 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 681 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
399 borderLess color cursorBlink cursorUnderline cutchars delete_key 682 borderLess color cursorBlink cursorUnderline cutchars delete_key
400 display_name embed ext_bwidth fade font geometry hold iconName 683 display_name embed ext_bwidth fade font geometry hold iconName
401 imFont imLocale inputMethod insecure int_bwidth intensityStyles 684 imFont imLocale inputMethod insecure int_bwidth intensityStyles
402 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 685 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
403 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 686 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
404 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 687 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
405 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 688 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
406 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 689 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
407 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 690 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
408 shade term_name title transparent transparent_all tripleclickwords 691 shade term_name title transparent transparent_all tripleclickwords
409 utmpInhibit visualBell</pre> 692 utmpInhibit visualBell</pre>
410</dd> 693</dd>
411<p></p> 694<p></p>
695<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
696</dt>
697<dd>
698Adds a keymap translation exactly as specified via a resource. See the
699<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
700</dd>
701<p></p>
702<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
703</dt>
704<dd>
705Return and optionally change the current rendition. Text that is output by
706the terminal application will use this style.
707</dd>
708<p></p>
709<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
710</dt>
711<dd>
712Return the current coordinates of the text cursor position and optionally
713set it (which is usually bad as applications don't expect that).
714</dd>
715<p></p>
412<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 716<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
413</dt> 717</dt>
414<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 718<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
415</dt> 719</dt>
416<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 720<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
430<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 734<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
431</dt> 735</dt>
432<dd> 736<dd>
433Return the current selection text and optionally replace it by <code>$newtext</code>. 737Return the current selection text and optionally replace it by <code>$newtext</code>.
434</dd> 738</dd>
739<p></p>
740<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
741</dt>
435<dd> 742<dd>
436<p>#=item $term-&gt;overlay ($x, $y, $text)
437#
438#Create a simple multi-line overlay box. See the next method for details. 743Create a simple multi-line overlay box. See the next method for details.
439#
440#=cut</p>
441</dd>
442<dd>
443<p>sub urxvt::term::scr_overlay {
444die;
445 my ($self, $x, $y, $text) = @_;</p>
446</dd>
447<dd>
448<pre>
449 my @lines = split /\n/, $text;</pre>
450</dd>
451<dd>
452<pre>
453 my $w = 0;
454 for (map $self-&gt;strwidth ($_), @lines) {
455 $w = $_ if $w &lt; $_;
456 }</pre>
457</dd>
458<dd>
459<pre>
460 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
461 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
462}</pre>
463</dd> 744</dd>
464<p></p> 745<p></p>
465<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 746<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
466</dt> 747</dt>
467<dd> 748<dd>
… …
503</dt> 784</dt>
504<dd> 785<dd>
505If hidden, display the overlay again. 786If hidden, display the overlay again.
506</dd> 787</dd>
507<p></p></dl> 788<p></p></dl>
789<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
790</dt>
791<dd>
792Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
793<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
794currently).
795</dd>
796<p></p>
508<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 797<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
509</dt> 798</dt>
510<dd> 799<dd>
511Returns the number of screen-cells this string would need. Correctly 800Returns the number of screen-cells this string would need. Correctly
512accounts for wide and combining characters. 801accounts for wide and combining characters.
513</dd> 802</dd>
514<p></p> 803<p></p>
515<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 804<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
516</dt> 805</dt>
517<dd> 806<dd>
518Convert the given text string into the corresponding locale encoding. 807Convert the given text string into the corresponding locale encoding.
519</dd> 808</dd>
520<p></p> 809<p></p>
521<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 810<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
522</dt> 811</dt>
523<dd> 812<dd>
524Convert the given locale-encoded octets into a perl string. 813Convert the given locale-encoded octets into a perl string.
814</dd>
815<p></p>
816<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 />
817</dt>
818<dd>
819XORs the rendition values in the given span with the provided value
820(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
821to the selection.
822</dd>
823<p></p>
824<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 />
825</dt>
826<dd>
827Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
828whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
829to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
830it instead.
831</dd>
832<p></p>
833<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
834</dt>
835<dd>
836Ring the bell!
837</dd>
838<p></p>
839<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
840</dt>
841<dd>
842Write the given text string to the screen, as if output by the application
843running inside the terminal. It may not contain command sequences (escape
844codes), but is free to use line feeds, carriage returns and tabs. The
845string is a normal text string, not in locale-dependent encoding.
846</dd>
847<dd>
848<p>Normally its not a good idea to use this function, as programs might be
849confused by changes in cursor position or scrolling. Its useful inside a
850<code>on_add_lines</code> hook, though.</p>
851</dd>
852<p></p>
853<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
854</dt>
855<dd>
856Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
857locale-specific encoding of the terminal and can contain command sequences
858(escape codes) that will be interpreted.
525</dd> 859</dd>
526<p></p> 860<p></p>
527<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 861<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
528</dt> 862</dt>
529<dd> 863<dd>
530Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 864Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
531pass characters instead of octets, you should convert your strings first 865pass characters instead of octets, you should convert your strings first
532to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 866to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
533</dd> 867</dd>
534<p></p> 868<p></p>
869<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
870</dt>
871<dd>
872Replaces the event mask of the pty watcher by the given event mask. Can
873be used to suppress input and output handling to the pty/tty. See the
874description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
875the previous value.
876</dd>
877<p></p>
878<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
879</dt>
880<dd>
881Return the window id of the toplevel window.
882</dd>
883<p></p>
884<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
885</dt>
886<dd>
887Return the window id of the terminal window.
888</dd>
889<p></p>
890<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
891</dt>
892<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
893</dt>
894<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
895</dt>
896<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
897</dt>
898<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
899</dt>
535<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 900<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
536</dt> 901</dt>
537<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 902<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
538</dt> 903</dt>
539<dd> 904<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
540Return the number of rows/columns of the terminal window (i.e. as 905</dt>
541specified by <code>-geometry</code>, excluding any scrollback). 906<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
907</dt>
908<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
909</dt>
910<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
911</dt>
912<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
913</dt>
542</dd> 914<dd>
915Return various integers describing terminal characteristics.
916</dd>
543<p></p> 917<p></p>
918<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
919</dt>
920<dd>
921Return the DISPLAY used by rxvt-unicode.
922</dd>
923<p></p>
924<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
925</dt>
926<dd>
927Returns the LC_CTYPE category string used by this rxvt-unicode.
928</dd>
929<p></p>
544<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 930<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
545</dt> 931</dt>
932<dd>
933Returns a copy of the environment in effect for the terminal as a hashref
934similar to <code>\%ENV</code>.
546<dd> 935</dd>
547Returns the number of lines in the scrollback buffer. 936<p></p>
937<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
938</dt>
939<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
940</dt>
941<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
942</dt>
943<dd>
944Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
945AltGr), the meta key (often Alt) and the num lock key, if applicable.
548</dd> 946</dd>
549<p></p> 947<p></p>
550<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 948<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
551</dt> 949</dt>
552<dd> 950<dd>
… …
580line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 978line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
581to replace only parts of a line. The font index in the rendition will 979to replace only parts of a line. The font index in the rendition will
582automatically be updated.</p> 980automatically be updated.</p>
583</dd> 981</dd>
584<dd> 982<dd>
585<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 983<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
586than one cell when displayed are padded with urxvt::NOCHAR characters 984than one cell when displayed are padded with urxvt::NOCHAR characters
587(<code>chr 65535</code>). Characters with combining characters and other characters 985(<code>chr 65535</code>). Characters with combining characters and other characters
588that do not fit into the normal tetx encoding will be replaced with 986that do not fit into the normal tetx encoding will be replaced with
589characters in the private use area.</p> 987characters in the private use area.</p>
590</dd> 988</dd>
… …
592<p>You have to obey this encoding when changing text. The advantage is 990<p>You have to obey this encoding when changing text. The advantage is
593that <code>substr</code> and similar functions work on screen cells and not on 991that <code>substr</code> and similar functions work on screen cells and not on
594characters.</p> 992characters.</p>
595</dd> 993</dd>
596<dd> 994<dd>
597<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 995<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>
598can be used to convert normal strings into this encoding and vice versa.</p> 996can be used to convert normal strings into this encoding and vice versa.</p>
599</dd> 997</dd>
600<p></p> 998<p></p>
601<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 999<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
602</dt> 1000</dt>
… …
635Create and return a new <code>urxvt::line</code> object that stores information 1033Create and return a new <code>urxvt::line</code> object that stores information
636about the logical line that row <code>$row_number</code> is part of. It supports the 1034about the logical line that row <code>$row_number</code> is part of. It supports the
637following methods: 1035following methods:
638</dd> 1036</dd>
639<dl> 1037<dl>
640<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 1038<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
641</dt> 1039</dt>
642<dd> 1040<dd>
643Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1041Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
644</dd> 1042</dd>
645<p></p> 1043<p></p>
646<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 1044<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
647</dt> 1045</dt>
648<dd> 1046<dd>
649Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1047Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
650</dd> 1048</dd>
651<p></p> 1049<p></p>
652<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1050<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
653</dt> 1051</dt>
654<dd> 1052<dd>
… …
674</dt> 1072</dt>
675<dd> 1073<dd>
676Translates a string offset into terminal coordinates again. 1074Translates a string offset into terminal coordinates again.
677</dd> 1075</dd>
678<p></p></dl> 1076<p></p></dl>
679<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1077<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
680=item $text = $term-&gt;special_encode $string</strong><br />
681</dt> 1078</dt>
682<dd> 1079<dd>
683Converts a perl string into the special encoding used by rxvt-unicode, 1080Converts a perl string into the special encoding used by rxvt-unicode,
684where one character corresponds to one screen cell. See 1081where one character corresponds to one screen cell. See
685<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1082<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
688<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1085<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
689</dt> 1086</dt>
690<dd> 1087<dd>
691Converts rxvt-unicodes text reprsentation into a perl string. See 1088Converts rxvt-unicodes text reprsentation into a perl string. See
692<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1089<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1090</dd>
1091<p></p>
1092<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1093</dt>
1094<dd>
1095Registers a synchronous button grab. See the XGrabButton manpage.
1096</dd>
1097<p></p>
1098<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1099</dt>
1100<dd>
1101Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1102synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1103</dd>
1104<p></p>
1105<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1106</dt>
1107<dd>
1108Calls XAllowEvents with AsyncBoth for the most recent grab.
1109</dd>
1110<p></p>
1111<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1112</dt>
1113<dd>
1114Calls XAllowEvents with SyncBoth for the most recent grab.
1115</dd>
1116<p></p>
1117<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1118</dt>
1119<dd>
1120Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1121recent grab.
1122</dd>
1123<p></p>
1124<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1125</dt>
1126<dd>
1127Calls XUngrab for the most recent grab. Is called automatically on
1128evaluation errors, as it is better to lose the grab in the error case as
1129the session.
1130</dd>
1131<p></p></dl>
1132<p>
1133</p>
1134<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1135<dl>
1136<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1137</dt>
1138<dd>
1139Adds a non-clickable title to the popup.
1140</dd>
1141<p></p>
1142<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1143</dt>
1144<dd>
1145Creates a separator, optionally using the character given as <code>$sepchr</code>.
1146</dd>
1147<p></p>
1148<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1149</dt>
1150<dd>
1151Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1152selected.
1153</dd>
1154<p></p>
1155<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1156</dt>
1157<dd>
1158Adds a toggle/checkbox item to the popup. Teh callback gets called
1159whenever it gets toggled, with a boolean indicating its value as its first
1160argument.
1161</dd>
1162<p></p>
1163<dt><strong>$popup-&gt;show</strong><br />
1164</dt>
1165<dd>
1166Displays the popup (which is initially hidden).
693</dd> 1167</dd>
694<p></p></dl> 1168<p></p></dl>
695<p> 1169<p>
696</p> 1170</p>
697<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1171<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
765<pre> 1239<pre>
766 $term-&gt;{socket} = ... 1240 $term-&gt;{socket} = ...
767 $term-&gt;{iow} = urxvt::iow 1241 $term-&gt;{iow} = urxvt::iow
768 -&gt;new 1242 -&gt;new
769 -&gt;fd (fileno $term-&gt;{socket}) 1243 -&gt;fd (fileno $term-&gt;{socket})
770 -&gt;events (1) # wait for read data 1244 -&gt;events (urxvt::EVENT_READ)
771 -&gt;start 1245 -&gt;start
772 -&gt;cb (sub { 1246 -&gt;cb (sub {
773 my ($iow, $revents) = @_; 1247 my ($iow, $revents) = @_;
774 # $revents must be 1 here, no need to check 1248 # $revents must be 1 here, no need to check
775 sysread $term-&gt;{socket}, my $buf, 8192 1249 sysread $term-&gt;{socket}, my $buf, 8192
… …
796</dd> 1270</dd>
797<p></p> 1271<p></p>
798<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1272<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
799</dt> 1273</dt>
800<dd> 1274<dd>
801Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1275Set the event mask to watch. The only allowed values are
802data, Bit #1 (value <code>2</code>) enables watching for write data. 1276<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1277together, or <code>urxvt::EVENT_NONE</code>.
803</dd> 1278</dd>
804<p></p> 1279<p></p>
805<dt><strong>$iow = $iow-&gt;start</strong><br /> 1280<dt><strong>$iow = $iow-&gt;start</strong><br />
806</dt> 1281</dt>
807<dd> 1282<dd>
… …
821<p> 1296<p>
822</p> 1297</p>
823<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1298<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
824<p>This variable controls the verbosity level of the perl extension. Higher 1299<p>This variable controls the verbosity level of the perl extension. Higher
825numbers indicate more verbose output.</p> 1300numbers indicate more verbose output.</p>
826<ol> 1301<dl>
827<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1302<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
828</li> 1303</dt>
829<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1304<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
830</li> 1305</dt>
831<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 1306<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1307</dt>
832</li> 1308</dl>
833</ol>
834<p> 1309<p>
835</p> 1310</p>
836<hr /> 1311<hr />
837<h1><a name="author">AUTHOR</a></h1> 1312<h1><a name="author">AUTHOR</a></h1>
838<pre> 1313<pre>

Diff Legend

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