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.19 by root, Tue Jan 10 04:26:54 2006 UTC

… …
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <ul> 18 <ul>
19 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> 20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 21 <li><a href="#general_api_considerations">General API Considerations</a></li>
22 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 23 <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> 24 <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> 25 <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> 26 <li><a href="#rendition">RENDITION</a></li>
27 <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> 28 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
29 <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> 30 <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> 31 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29 </ul> 32 </ul>
30 33
31 <li><a href="#environment">ENVIRONMENT</a></li> 34 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 64 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 65<p>
63</p> 66</p>
64<hr /> 67<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 68<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 69<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 70the <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 71<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 72thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where 73<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 74scripts will be shared (but not enabled) for all terminals.</p>
72<p> 75<p>
… …
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 79find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 80<p>You can activate them like this:</p>
78<pre> 81<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 82 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 83<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 84<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 85</dt>
83<dd> 86<dd>
84Intelligent selection. This etxension tries to be more intelligent when the user 87Intelligent selection. This extension tries to be more intelligent when
85extends selections (double-click). 88the user extends selections (double-click). Right now, it tries to select
89urls and complete shell-quoted arguments, which is very convenient, too,
90if your <em>ls</em> supports <code>--quoting-style=shell</code>.
86</dd> 91</dd>
87<dd> 92<dd>
88<p>It also offers the following bindable event:</p> 93<p>It also offers the following bindable event:</p>
89</dd> 94</dd>
90<dl> 95<dl>
… …
96<dd> 101<dd>
97<pre> 102<pre>
98 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 103 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
99</dd> 104</dd>
100<p></p></dl> 105<p></p></dl>
106<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
107</dt>
108<dd>
109Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
110runtime.
111</dd>
112<p></p>
113<dt><strong>selection-popup (enabled by default)</strong><br />
114</dt>
115<dd>
116Binds a popup menu to Ctrl-Button3 that lets you convert the selection
117text into various other formats/action.
118</dd>
119<p></p>
120<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
121</dt>
122<dd>
123Adds regex search functionality to the scrollback buffer, triggered
124by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal
125input/output is suspended.
126</dd>
127<dd>
128<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
129<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
130history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
131returns to the original position.</p>
132</dd>
133<p></p>
101<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 134<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
102</dt> 135</dt>
103<dd> 136<dd>
104Displays a digital clock using the built-in overlay. 137Displays a digital clock using the built-in overlay.
138</dd>
139<p></p>
140<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
141</dt>
142<dd>
143Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
144</dd>
145<p></p>
146<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
147</dt>
148<dd>
149A not very useful example of filtering all text output to the terminal,
150by replacing all line-drawing characters (U+2500 .. U+259F) by a
151similar-looking ascii character.
105</dd> 152</dd>
106<p></p> 153<p></p>
107<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 154<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
108</dt> 155</dt>
109<dd> 156<dd>
… …
122modified).</p> 169modified).</p>
123<p>When objects are destroyed on the C++ side, the perl object hashes are 170<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 171emptied, 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 172the like inside the terminal object so they get destroyed as soon as the
126terminal is destroyed.</p> 173terminal is destroyed.</p>
174<p>Argument names also often indicate the type of a parameter. Here are some
175hints on what they mean:</p>
176<dl>
177<dt><strong><a name="item__24text">$text</a></strong><br />
178</dt>
179<dd>
180Rxvt-unicodes special way of encoding text, where one ``unicode'' character
181always represents one screen cell. See <em>row_t</em> for a discussion of this format.
182</dd>
183<p></p>
184<dt><strong><a name="item__24string">$string</a></strong><br />
185</dt>
186<dd>
187A perl text string, with an emphasis on <em>text</em>. It can store all unicode
188characters and is to be distinguished with text encoded in a specific
189encoding (often locale-specific) and binary data.
190</dd>
191<p></p>
192<dt><strong><a name="item__24octets">$octets</a></strong><br />
193</dt>
194<dd>
195Either binary data or - more common - a text string encoded in a
196locale-specific way.
197</dd>
198<p></p></dl>
199<p>
200</p>
201<h2><a name="extension_objects">Extension Objects</a></h2>
202<p>Very perl extension is a perl class. A separate perl object is created
203for each terminal and each extension and passed as the first parameter to
204hooks. So extensions can use their <code>$self</code> object without having to think
205about other extensions, with the exception of methods and members that
206begin with an underscore character <code>_</code>: these are reserved for internal
207use.</p>
208<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
209<code>urxvt::term</code> class on this object.</p>
210<p>It has the following methods and data members:</p>
211<dl>
212<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
213</dt>
214<dd>
215Returns the <code>urxvt::term</code> object associated with this instance of the
216extension. This member <em>must not</em> be changed in any way.
217</dd>
218<p></p>
219<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
220</dt>
221<dd>
222Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
223this extension, replacing any previous hook. This is useful when you want
224to overwrite time-critical hooks only temporarily.
225</dd>
226<p></p>
227<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
228</dt>
229<dd>
230Dynamically disable the given hooks.
231</dd>
232<p></p></dl>
127<p> 233<p>
128</p> 234</p>
129<h2><a name="hooks">Hooks</a></h2> 235<h2><a name="hooks">Hooks</a></h2>
130<p>The following subroutines can be declared in loaded scripts, and will be 236<p>The following subroutines can be declared in extension files, and will be
131called whenever the relevant event happens.</p> 237called whenever the relevant event happens.</p>
132<p>The first argument passed to them is an object private to each terminal 238<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 239the 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 240<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, 241event 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> 242skipped, 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> 243<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
141<dl> 244<dl>
142<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 245<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
143</dt> 246</dt>
144<dd> 247<dd>
145Called after a new terminal object has been initialized, but before 248Called after a new terminal object has been initialized, but before
146windows are created or the command gets run. 249windows are created or the command gets run. Most methods are unsafe to
250call or deliver senseless data, as terminal size and other characteristics
251have not yet been determined. You can safely query and change resources,
252though.
147</dd> 253</dd>
148<p></p> 254<p></p>
149<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 255<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
150</dt> 256</dt>
151<dd> 257<dd>
… …
194</dd> 300</dd>
195<dd> 301<dd>
196<p>See the <em>selection</em> example extension.</p> 302<p>See the <em>selection</em> example extension.</p>
197</dd> 303</dd>
198<p></p> 304<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 /> 305<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
214</dt> 306</dt>
215<dd> 307<dd>
216Called whenever the view offset changes, i..e the user or program 308Called whenever the view offset changes, i..e the user or program
217scrolls. Offset <code>0</code> means display the normal terminal, positive values 309scrolls. 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, 321<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 322$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> 323number of lines that will be in the scrollback buffer.</p>
232</dd> 324</dd>
233<p></p> 325<p></p>
234<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 326<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
235</dt> 327</dt>
328<dd>
329Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
330operating system command) is processed. Cursor position and other state
331information is up-to-date when this happens. For interoperability, the
332string should start with the extension name and a colon, to distinguish
333it from commands for other extensions, and this might be enforced in the
334future.
236<dd> 335</dd>
237Called whenever the <code>program(s)</code> running in the urxvt window send output. 336<dd>
337<p>Be careful not ever to trust (in a security sense) the data you receive,
338as its source can not easily be controleld (e-mail content, messages from
339other users on the same system etc.).</p>
340</dd>
341<p></p>
342<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
343</dt>
344<dd>
345Called whenever text is about to be output, with the text as argument. You
346can filter/change and output the text yourself by returning a true value
347and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
348might be very slow, however, as your hook is called for <strong>all</strong> text being
349output.
350</dd>
351<p></p>
352<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
353</dt>
354<dd>
355Called whenever some data is written to the tty/pty and can be used to
356suppress or filter tty input.
357</dd>
358<p></p>
359<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
360</dt>
361<dd>
362Called whenever a line was updated or changed. Can be used to filter
363screen output (e.g. underline urls or other useless stuff). Only lines
364that are being shown will be filtered, and, due to performance reasons,
365not always immediately.
366</dd>
367<dd>
368<p>The row number is always the topmost row of the line if the line spans
369multiple rows.</p>
370</dd>
371<dd>
372<p>Please note that, if you change the line, then the hook might get called
373later with the already-modified line (e.g. if unrelated parts change), so
374you cannot just toggle rendition bits, but only set them.</p>
238</dd> 375</dd>
239<p></p> 376<p></p>
240<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 377<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
241</dt> 378</dt>
242<dd> 379<dd>
… …
257<dd> 394<dd>
258Called whenever the user presses a key combination that has a 395Called 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> 396<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
260resource in the <code>rxvt(1)</code> manpage). 397resource in the <code>rxvt(1)</code> manpage).
261</dd> 398</dd>
399<p></p>
400<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
401</dt>
402<dd>
403Called whenever the window gets the keyboard focus, before rxvt-unicode
404does focus in processing.
405</dd>
406<p></p>
407<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
408</dt>
409<dd>
410Called wheneever the window loses keyboard focus, before rxvt-unicode does
411focus out processing.
412</dd>
413<p></p>
414<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
415</dt>
416<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
417</dt>
418<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
419</dt>
420<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
421</dt>
422<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
423</dt>
424<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
425</dt>
426<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
427</dt>
428<dd>
429Called whenever the corresponding X event is received for the terminal If
430the hook returns true, then the even will be ignored by rxvt-unicode.
431</dd>
432<dd>
433<p>The event is a hash with most values as named by Xlib (see the XEvent
434manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
435and column under the mouse cursor.</p>
436</dd>
437<dd>
438<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
439output, if any, in locale-specific encoding.</p>
440</dd>
441<dd>
442<p>subwindow.</p>
443</dd>
262<p></p></dl> 444<p></p></dl>
263<p> 445<p>
264</p> 446</p>
265<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 447<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
266<dl> 448<dl>
267<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 449<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
268</dt> 450</dt>
269<dd> 451<dd>
270The current terminal. Whenever a callback/Hook is bein executed, this 452The current terminal. This variable stores the current <code>urxvt::term</code>
271variable stores the current <code>urxvt::term</code> object. 453object, whenever a callback/hook is executing.
272</dd> 454</dd>
273<p></p></dl> 455<p></p></dl>
274<p> 456<p>
275</p> 457</p>
276<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 458<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
277<dl> 459<dl>
460<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
461</dt>
462<dd>
463Creates a new terminal, very similar as if you had started it with
464<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
465if the new instance couldn't be created. Returns <code>undef</code> if the new
466instance didn't initialise perl, and the terminal object otherwise. The
467<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
468</dd>
469<p></p>
278<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 470<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
279</dt> 471</dt>
280<dd> 472<dd>
281Fatally aborts execution with the given error message. Avoid at all 473Fatally aborts execution with the given error message. Avoid at all
282costs! The only time this is acceptable is when the terminal process 474costs! The only time this is acceptable is when the terminal process
… …
293<dd> 485<dd>
294<p>Using this function has the advantage that its output ends up in the 486<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> 487correct place, e.g. on stderr of the connecting urxvtc client.</p>
296</dd> 488</dd>
297<p></p> 489<p></p>
490<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
491</dt>
492<dd>
493Returns true when it is safe to do potentially unsafe things, such as
494evaluating perl code specified by the user. This is true when urxvt was
495started setuid or setgid.
496</dd>
497<p></p>
298<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 498<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
299</dt> 499</dt>
300<dd> 500<dd>
301Returns the ``current time'' (as per the event loop). 501Returns the ``current time'' (as per the event loop).
502</dd>
503<p></p>
504<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
505</dt>
506<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
507Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
508Button4Mask, Button5Mask, AnyModifier</a></strong><br />
509</dt>
510<dd>
511Various constants for use in X calls and event processing.
302</dd> 512</dd>
303<p></p></dl> 513<p></p></dl>
304<p> 514<p>
305</p> 515</p>
306<h2><a name="rendition">RENDITION</a></h2> 516<h2><a name="rendition">RENDITION</a></h2>
… …
363Change the custom value. 573Change the custom value.
364</dd> 574</dd>
365<p></p></dl> 575<p></p></dl>
366<p> 576<p>
367</p> 577</p>
578<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
579<p>The sole purpose of this class is to deliver an interface to the
580<code>AnyEvent</code> module - any module using it will work inside urxvt without
581further work. The only exception is that you cannot wait on condition
582variables, but non-blocking condvar use is ok. What this means is that you
583cannot use blocking APIs, but the non-blocking variant should work.</p>
584<p>
585</p>
368<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 586<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
369<dl> 587<dl>
588<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
589</dt>
590<dd>
591Destroy the terminal object (close the window, free resources etc.).
592</dd>
593<p></p>
594<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
595</dt>
596<dd>
597Returns true if the option specified by <code>$optval</code> is enabled, and
598optionally change it. All option values are stored by name in the hash
599<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
600</dd>
601<dd>
602<p>Here is a a likely non-exhaustive list of option names, please see the
603source file <em>/src/optinc.h</em> to see the actual list:</p>
604</dd>
605<dd>
606<pre>
607 borderLess console cursorBlink cursorUnderline hold iconic insecure
608 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
609 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
610 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
611 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
612 tripleclickwords utmpInhibit visualBell</pre>
613</dd>
614<p></p>
370<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 615<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
371</dt> 616</dt>
372<dd> 617<dd>
373Returns the current resource value associated with a given name and 618Returns 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> 619optionally 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 633<p>Please note that resource strings will currently only be freed when the
389terminal is destroyed, so changing options frequently will eat memory.</p> 634terminal is destroyed, so changing options frequently will eat memory.</p>
390</dd> 635</dd>
391<dd> 636<dd>
392<p>Here is a a likely non-exhaustive list of resource names, not all of which 637<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 638are supported in every build, please see the source file <em>/src/rsinc.h</em>
394list:</p> 639to see the actual list:</p>
395</dd> 640</dd>
396<dd> 641<dd>
397<pre> 642<pre>
398 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 643 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
399 borderLess color cursorBlink cursorUnderline cutchars delete_key 644 borderLess color cursorBlink cursorUnderline cutchars delete_key
400 display_name embed ext_bwidth fade font geometry hold iconName 645 display_name embed ext_bwidth fade font geometry hold iconName
401 imFont imLocale inputMethod insecure int_bwidth intensityStyles 646 imFont imLocale inputMethod insecure int_bwidth intensityStyles
402 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 647 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
403 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 648 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
404 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 649 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
405 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 650 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
406 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 651 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
407 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 652 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
408 shade term_name title transparent transparent_all tripleclickwords 653 shade term_name title transparent transparent_all tripleclickwords
409 utmpInhibit visualBell</pre> 654 utmpInhibit visualBell</pre>
410</dd> 655</dd>
411<p></p> 656<p></p>
657<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
658</dt>
659<dd>
660Adds a keymap translation exactly as specified via a resource. See the
661<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
662</dd>
663<p></p>
664<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
665</dt>
666<dd>
667Return and optionally change the current rendition. Text that is output by
668the terminal application will use this style.
669</dd>
670<p></p>
671<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
672</dt>
673<dd>
674Return the current coordinates of the text cursor position and optionally
675set it (which is usually bad as applications don't expect that).
676</dd>
677<p></p>
412<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 678<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
413</dt> 679</dt>
414<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 680<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
415</dt> 681</dt>
416<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 682<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 /> 696<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
431</dt> 697</dt>
432<dd> 698<dd>
433Return the current selection text and optionally replace it by <code>$newtext</code>. 699Return the current selection text and optionally replace it by <code>$newtext</code>.
434</dd> 700</dd>
701<p></p>
702<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
703</dt>
435<dd> 704<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. 705Create 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> 706</dd>
464<p></p> 707<p></p>
465<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 708<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
466</dt> 709</dt>
467<dd> 710<dd>
… …
503</dt> 746</dt>
504<dd> 747<dd>
505If hidden, display the overlay again. 748If hidden, display the overlay again.
506</dd> 749</dd>
507<p></p></dl> 750<p></p></dl>
751<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
752</dt>
753<dd>
754Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
755<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
756currently).
757</dd>
758<p></p>
508<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 759<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
509</dt> 760</dt>
510<dd> 761<dd>
511Returns the number of screen-cells this string would need. Correctly 762Returns the number of screen-cells this string would need. Correctly
512accounts for wide and combining characters. 763accounts for wide and combining characters.
513</dd> 764</dd>
514<p></p> 765<p></p>
515<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 766<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
516</dt> 767</dt>
517<dd> 768<dd>
518Convert the given text string into the corresponding locale encoding. 769Convert the given text string into the corresponding locale encoding.
519</dd> 770</dd>
520<p></p> 771<p></p>
521<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 772<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
522</dt> 773</dt>
523<dd> 774<dd>
524Convert the given locale-encoded octets into a perl string. 775Convert the given locale-encoded octets into a perl string.
776</dd>
777<p></p>
778<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 />
779</dt>
780<dd>
781XORs the rendition values in the given span with the provided value
782(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
783to the selection.
784</dd>
785<p></p>
786<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 />
787</dt>
788<dd>
789Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
790whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
791to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
792it instead.
793</dd>
794<p></p>
795<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
796</dt>
797<dd>
798Ring the bell!
799</dd>
800<p></p>
801<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
802</dt>
803<dd>
804Write the given text string to the screen, as if output by the application
805running inside the terminal. It may not contain command sequences (escape
806codes), but is free to use line feeds, carriage returns and tabs. The
807string is a normal text string, not in locale-dependent encoding.
808</dd>
809<dd>
810<p>Normally its not a good idea to use this function, as programs might be
811confused by changes in cursor position or scrolling. Its useful inside a
812<code>on_add_lines</code> hook, though.</p>
813</dd>
814<p></p>
815<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
816</dt>
817<dd>
818Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
819locale-specific encoding of the terminal and can contain command sequences
820(escape codes) that will be interpreted.
525</dd> 821</dd>
526<p></p> 822<p></p>
527<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 823<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
528</dt> 824</dt>
529<dd> 825<dd>
530Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 826Write 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 827pass 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>. 828to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
533</dd> 829</dd>
534<p></p> 830<p></p>
831<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
832</dt>
833<dd>
834Replaces the event mask of the pty watcher by the given event mask. Can
835be used to suppress input and output handling to the pty/tty. See the
836description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
837the previous value.
838</dd>
839<p></p>
840<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
841</dt>
842<dd>
843Return the window id of the toplevel window.
844</dd>
845<p></p>
846<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
847</dt>
848<dd>
849Return the window id of the terminal window.
850</dd>
851<p></p>
852<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
853</dt>
854<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
855</dt>
856<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
857</dt>
858<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
859</dt>
860<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
861</dt>
535<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 862<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
536</dt> 863</dt>
537<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 864<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
538</dt>
539<dd>
540Return the number of rows/columns of the terminal window (i.e. as
541specified by <code>-geometry</code>, excluding any scrollback).
542</dd> 865</dt>
543<p></p> 866<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
867</dt>
868<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
869</dt>
870<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
871</dt>
872<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
873</dt>
544<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 874<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
545</dt> 875</dt>
876<dd>
877Return various integers describing terminal characteristics.
546<dd> 878</dd>
547Returns the number of lines in the scrollback buffer. 879<p></p>
880<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
881</dt>
882<dd>
883Returns the LC_CTYPE category string used by this rxvt-unicode.
884</dd>
885<p></p>
886<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
887</dt>
888<dd>
889Return the DISPLAY used by rxvt-unicode.
890</dd>
891<p></p>
892<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
893</dt>
894<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
895</dt>
896<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
897</dt>
898<dd>
899Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
900AltGr), the meta key (often Alt) and the num lock key, if applicable.
548</dd> 901</dd>
549<p></p> 902<p></p>
550<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 903<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
551</dt> 904</dt>
552<dd> 905<dd>
… …
580line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 933line, 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 934to replace only parts of a line. The font index in the rendition will
582automatically be updated.</p> 935automatically be updated.</p>
583</dd> 936</dd>
584<dd> 937<dd>
585<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 938<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 939than one cell when displayed are padded with urxvt::NOCHAR characters
587(<code>chr 65535</code>). Characters with combining characters and other characters 940(<code>chr 65535</code>). Characters with combining characters and other characters
588that do not fit into the normal tetx encoding will be replaced with 941that do not fit into the normal tetx encoding will be replaced with
589characters in the private use area.</p> 942characters in the private use area.</p>
590</dd> 943</dd>
… …
592<p>You have to obey this encoding when changing text. The advantage is 945<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 946that <code>substr</code> and similar functions work on screen cells and not on
594characters.</p> 947characters.</p>
595</dd> 948</dd>
596<dd> 949<dd>
597<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 950<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> 951can be used to convert normal strings into this encoding and vice versa.</p>
599</dd> 952</dd>
600<p></p> 953<p></p>
601<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 954<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
602</dt> 955</dt>
… …
635Create and return a new <code>urxvt::line</code> object that stores information 988Create 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 989about the logical line that row <code>$row_number</code> is part of. It supports the
637following methods: 990following methods:
638</dd> 991</dd>
639<dl> 992<dl>
640<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 993<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
641</dt> 994</dt>
642<dd> 995<dd>
643Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 996Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
644</dd> 997</dd>
645<p></p> 998<p></p>
646<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 999<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
647</dt> 1000</dt>
648<dd> 1001<dd>
649Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1002Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
650</dd> 1003</dd>
651<p></p> 1004<p></p>
652<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1005<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
653</dt> 1006</dt>
654<dd> 1007<dd>
… …
674</dt> 1027</dt>
675<dd> 1028<dd>
676Translates a string offset into terminal coordinates again. 1029Translates a string offset into terminal coordinates again.
677</dd> 1030</dd>
678<p></p></dl> 1031<p></p></dl>
679<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1032<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> 1033</dt>
682<dd> 1034<dd>
683Converts a perl string into the special encoding used by rxvt-unicode, 1035Converts a perl string into the special encoding used by rxvt-unicode,
684where one character corresponds to one screen cell. See 1036where one character corresponds to one screen cell. See
685<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1037<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
689</dt> 1041</dt>
690<dd> 1042<dd>
691Converts rxvt-unicodes text reprsentation into a perl string. See 1043Converts rxvt-unicodes text reprsentation into a perl string. See
692<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1044<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
693</dd> 1045</dd>
1046<p></p>
1047<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1048</dt>
1049<dd>
1050Registers a synchronous button grab. See the XGrabButton manpage.
1051</dd>
1052<p></p>
1053<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1054</dt>
1055<dd>
1056Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1057synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1058</dd>
1059<p></p>
1060<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1061</dt>
1062<dd>
1063Calls XAllowEvents with AsyncBoth for the most recent grab.
1064</dd>
1065<p></p>
1066<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1067</dt>
1068<dd>
1069Calls XAllowEvents with SyncBoth for the most recent grab.
1070</dd>
1071<p></p>
1072<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1073</dt>
1074<dd>
1075Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1076recent grab.
1077</dd>
1078<p></p>
1079<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1080</dt>
1081<dd>
1082Calls XUngrab for the most recent grab. Is called automatically on
1083evaluation errors, as it is better to lose the grab in the error case as
1084the session.
1085</dd>
694<p></p></dl> 1086<p></p></dl>
1087<p>
1088</p>
1089<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
695<p> 1090<p>
696</p> 1091</p>
697<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1092<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
698<p>This class implements timer watchers/events. Time is represented as a 1093<p>This class implements timer watchers/events. Time is represented as a
699fractional number of seconds since the epoch. Example:</p> 1094fractional number of seconds since the epoch. Example:</p>
… …
765<pre> 1160<pre>
766 $term-&gt;{socket} = ... 1161 $term-&gt;{socket} = ...
767 $term-&gt;{iow} = urxvt::iow 1162 $term-&gt;{iow} = urxvt::iow
768 -&gt;new 1163 -&gt;new
769 -&gt;fd (fileno $term-&gt;{socket}) 1164 -&gt;fd (fileno $term-&gt;{socket})
770 -&gt;events (1) # wait for read data 1165 -&gt;events (urxvt::EVENT_READ)
771 -&gt;start 1166 -&gt;start
772 -&gt;cb (sub { 1167 -&gt;cb (sub {
773 my ($iow, $revents) = @_; 1168 my ($iow, $revents) = @_;
774 # $revents must be 1 here, no need to check 1169 # $revents must be 1 here, no need to check
775 sysread $term-&gt;{socket}, my $buf, 8192 1170 sysread $term-&gt;{socket}, my $buf, 8192
… …
796</dd> 1191</dd>
797<p></p> 1192<p></p>
798<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1193<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
799</dt> 1194</dt>
800<dd> 1195<dd>
801Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1196Set the event mask to watch. The only allowed values are
802data, Bit #1 (value <code>2</code>) enables watching for write data. 1197<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1198together, or <code>urxvt::EVENT_NONE</code>.
803</dd> 1199</dd>
804<p></p> 1200<p></p>
805<dt><strong>$iow = $iow-&gt;start</strong><br /> 1201<dt><strong>$iow = $iow-&gt;start</strong><br />
806</dt> 1202</dt>
807<dd> 1203<dd>
… …
821<p> 1217<p>
822</p> 1218</p>
823<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1219<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
824<p>This variable controls the verbosity level of the perl extension. Higher 1220<p>This variable controls the verbosity level of the perl extension. Higher
825numbers indicate more verbose output.</p> 1221numbers indicate more verbose output.</p>
826<ol> 1222<dl>
827<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1223<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
828</li> 1224</dt>
829<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1225<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
830</li> 1226</dt>
831<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 1227<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1228</dt>
832</li> 1229</dl>
833</ol>
834<p> 1230<p>
835</p> 1231</p>
836<hr /> 1232<hr />
837<h1><a name="author">AUTHOR</a></h1> 1233<h1><a name="author">AUTHOR</a></h1>
838<pre> 1234<pre>

Diff Legend

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