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.18 by root, Mon Jan 9 07:17:24 2006 UTC vs.
Revision 1.38 by root, Wed Jan 25 00:57:57 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 27 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
27 <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>
28 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
29 <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>
30 <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>
33 <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li>
34 <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li>
31 </ul> 35 </ul>
32 36
33 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
34 <ul> 38 <ul>
35 39
… …
71thus must be encoded as UTF-8.</p> 75thus must be encoded as UTF-8.</p>
72<p>Each script will only ever be loaded once, even in rxvtd, where 76<p>Each script will only ever be loaded once, even in rxvtd, where
73scripts will be shared (but not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
74<p> 78<p>
75</p> 79</p>
76<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 80<hr />
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
77<p>This section describes the extensiosn delivered with this version. You can 82<p>This section describes the extensions delivered with this release. You can
78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
79<p>You can activate them like this:</p> 84<p>You can activate them like this:</p>
80<pre> 85<pre>
81 rxvt -pe &lt;extensionname&gt;</pre> 86 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
82<dl> 90<dl>
83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
84</dt> 92</dt>
85<dd> 93<dd>
86Intelligent selection. This extension tries to be more intelligent when 94(More) intelligent selection. This extension tries to be more intelligent
87the user extends selections (double-click). Right now, it tries to select 95when the user extends selections (double-click and further clicks). Right
88urls and complete shell-quoted arguments, which is very convenient, too, 96now, it tries to select words, urls and complete shell-quoted
89if your <em>ls</em> supports <code>--quoting-style=shell</code>. 97arguments, which is very convenient, too, if your <em>ls</em> supports
90</dd> 98<code>--quoting-style=shell</code>.
91<dd> 99</dd>
92<p>It also offers the following bindable event:</p> 100<dd>
101<p>A double-click usually selects the word under the cursor, further clicks
102will enlarge the selection.</p>
103</dd>
104<dd>
105<p>The selection works by trying to match a number of regexes and displaying
106them in increasing order of length. You can add your own regexes by
107specifying resources of the form:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.selection.pattern-0: perl-regex
112 URxvt.selection.pattern-1: perl-regex
113 ...</pre>
114</dd>
115<dd>
116<p>The index number (0, 1...) must not have any holes, and each regex must
117contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything
119between two vertical bars:</p>
120</dd>
121<dd>
122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd>
125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
136<p>You can look at the source of the selection extension to see more
137interesting uses, such as parsing a line from beginning to end.</p>
138</dd>
139<dd>
140<p>This extension also offers following bindable keyboard commands:</p>
93</dd> 141</dd>
94<dl> 142<dl>
95<dt><strong><a name="item_rot13">rot13</a></strong><br /> 143<dt><strong><a name="item_rot13">rot13</a></strong><br />
96</dt> 144</dt>
97<dd> 145<dd>
… …
111<p></p> 159<p></p>
112<dt><strong>selection-popup (enabled by default)</strong><br /> 160<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt> 161</dt>
114<dd> 162<dd>
115Binds a popup menu to Ctrl-Button3 that lets you convert the selection 163Binds a popup menu to Ctrl-Button3 that lets you convert the selection
116text into various other formats/action. 164text into various other formats/action (such as uri unescaping, perl
117</dd> 165evaluation, web-browser starting etc.), depending on content.
118<p></p>
119<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
120</dt>
121<dd> 166</dd>
122Displays a digital clock using the built-in overlay. 167<dd>
168<p>Other extensions can extend this popup menu by pushing a code reference
169onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
170popup is displayed.</p>
171</dd>
172<dd>
173<p>It's sole argument is the popup menu, which can be modified. The selection
174is in <code>$_</code>, which can be used to decide wether to add something or not.
175It should either return nothing or a string and a code reference. The
176string will be used as button text and the code reference will be called
177when the button gets activated and should transform <code>$_</code>.</p>
178</dd>
179<dd>
180<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
181the selection to <code>b</code>s, but only if the selection currently contains any
182<code>a</code>s:</p>
183</dd>
184<dd>
185<pre>
186 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
187 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
188 : ()
189 };</pre>
190</dd>
191<p></p>
192<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
193</dt>
194<dd>
195Adds regex search functionality to the scrollback buffer, triggered
196by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
197input/output is suspended and a regex is displayed at the bottom of the
198screen.
199</dd>
200<dd>
201<p>Inputting characters appends them to the regex and continues incremental
202search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
203search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
204bottom. <code>Escape</code> leaves search mode and returns to the point where search
205was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
206additionally stores the first match in the current line into the primary
207selection.</p>
208</dd>
209<p></p>
210<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
211</dt>
212<dd>
213A support package that tries to make editing with readline easier. At the
214moment, it reacts to clicking with the left mouse button by trying to
215move the text cursor to this position. It does so by generating as many
216cursor-left or cursor-right keypresses as required (the this only works
217for programs that correctly support wide characters).
218</dd>
219<dd>
220<p>To avoid too many false positives, this is only done when:</p>
221</dd>
222<dl>
223<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
224</dt>
225<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
226</dt>
227<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
228</dt>
229<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
230</dt>
231</dl>
232<p>The normal selection mechanism isn't disabled, so quick successive clicks
233might interfere with selection creation in harmless ways.</p>
234<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
235</dt>
236<dd>
237This selection allows you to do automatic transforms on a selection
238whenever a selection is made.
239</dd>
240<dd>
241<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
242operator) that modify <code>$_</code> as resources:</p>
243</dd>
244<dd>
245<pre>
246 URxvt.selection-autotransform.0: transform
247 URxvt.selection-autotransform.1: transform
248 ...</pre>
249</dd>
250<dd>
251<p>For example, the following will transform selections of the form
252<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
253$word</code>:</p>
254</dd>
255<dd>
256<pre>
257 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
258</dd>
259<dd>
260<p>And this example matches the same,but replaces it with vi-commands you can
261paste directly into your (vi :) editor:</p>
262</dd>
263<dd>
264<pre>
265 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
266</dd>
267<dd>
268<p>Of course, this can be modified to suit your needs and your editor :)</p>
269</dd>
270<dd>
271<p>To expand the example above to typical perl error messages (``XXX at
272FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
273</dd>
274<dd>
275<pre>
276 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
277 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
278</dd>
279<dd>
280<p>The first line tells the selection code to treat the unchanging part of
281every error message as a selection pattern, and the second line transforms
282the message into vi commands to load the file.</p>
283</dd>
284<p></p>
285<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
286</dt>
287<dd>
288This transforms the terminal into a tabbar with additional terminals, that
289is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
290displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
291button per tab.
292</dd>
293<dd>
294<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
295<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
296while <strong>Shift-Down</strong> creates a new tab.</p>
123</dd> 297</dd>
124<p></p> 298<p></p>
125<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 299<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
126</dt> 300</dt>
127<dd> 301<dd>
128Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 302Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
303make them clickable. When middle-clicked, the program specified in the
304resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
305the URL as first argument.
306</dd>
307<p></p>
308<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
309</dt>
310<dd>
311This (experimental) perl extension implements OnTheSpot editing. It does
312not work perfectly, and some input methods don't seem to work well with
313OnTheSpot editing in general, but it seems to work at leats for SCIM and
314kinput2.
315</dd>
316<dd>
317<p>You enable it by specifying this extension and a preedit style of
318<code>OnTheSpot</code>, i.e.:</p>
319</dd>
320<dd>
321<pre>
322 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
323</dd>
324<p></p>
325<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
326</dt>
327<dd>
328This is basically a one-line extension that dynamically changes the background pixmap offset
329to the window position, in effect creating the same effect as pseudo transparency with
330a custom pixmap. No scaling is supported in this mode. Exmaple:
331</dd>
332<dd>
333<pre>
334 rxvt -pixmap background.xpm -pe automove-background</pre>
129</dd> 335</dd>
130<p></p> 336<p></p>
131<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 337<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
132</dt> 338</dt>
133<dd> 339<dd>
134A not very useful example of filtering all text output to the terminal, 340A not very useful example of filtering all text output to the terminal,
135by replacing all line-drawing characters (U+2500 .. U+259F) by a 341by replacing all line-drawing characters (U+2500 .. U+259F) by a
136similar-looking ascii character. 342similar-looking ascii character.
137</dd> 343</dd>
138<p></p> 344<p></p>
345<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
346</dt>
347<dd>
348Displays a digital clock using the built-in overlay.
349</dd>
350<p></p>
139<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 351<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
140</dt> 352</dt>
141<dd> 353<dd>
142Displays a very simple digital clock in the upper right corner of the 354Displays a very simple digital clock in the upper right corner of the
143window. Illustrates overwriting the refresh callbacks to create your own 355window. Illustrates overwriting the refresh callbacks to create your own
144overlays or changes. 356overlays or changes.
145</dd> 357</dd>
358<p></p>
359<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
360</dt>
361<dd>
362This is a little rarely useful extension that Uploads the selection as
363textfile to a remote site (or does other things). (The implementation is
364not currently secure for use in a multiuser environment as it writes to
365<em>/tmp</em> directly.).
366</dd>
367<dd>
368<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
369i.e.</p>
370</dd>
371<dd>
372<pre>
373 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
374</dd>
375<dd>
376<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
377the textfile. This command can be set via a resource:</p>
378</dd>
379<dd>
380<pre>
381 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
382</dd>
383<dd>
384<p>And the default is likely not useful to anybody but the few people around
385here :)</p>
386</dd>
387<dd>
388<p>The name of the textfile is the hex encoded md5 sum of the selection, so
389the same content should lead to the same filename.</p>
390</dd>
391<dd>
392<p>After a successful upload the selection will be replaced by the text given
393in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
394for the filename):</p>
395</dd>
396<dd>
397<pre>
398 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
399</dd>
146<p></p></dl> 400<p></p></dl>
401<p>
402</p>
403<hr />
404<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
147<p> 405<p>
148</p> 406</p>
149<h2><a name="general_api_considerations">General API Considerations</a></h2> 407<h2><a name="general_api_considerations">General API Considerations</a></h2>
150<p>All objects (such as terminals, time watchers etc.) are typical 408<p>All objects (such as terminals, time watchers etc.) are typical
151reference-to-hash objects. The hash can be used to store anything you 409reference-to-hash objects. The hash can be used to store anything you
… …
161<dl> 419<dl>
162<dt><strong><a name="item__24text">$text</a></strong><br /> 420<dt><strong><a name="item__24text">$text</a></strong><br />
163</dt> 421</dt>
164<dd> 422<dd>
165Rxvt-unicodes special way of encoding text, where one ``unicode'' character 423Rxvt-unicodes special way of encoding text, where one ``unicode'' character
166always represents one screen cell. See <em>row_t</em> for a discussion of this format. 424always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
167</dd> 425</dd>
168<p></p> 426<p></p>
169<dt><strong><a name="item__24string">$string</a></strong><br /> 427<dt><strong><a name="item__24string">$string</a></strong><br />
170</dt> 428</dt>
171<dd> 429<dd>
… …
181locale-specific way. 439locale-specific way.
182</dd> 440</dd>
183<p></p></dl> 441<p></p></dl>
184<p> 442<p>
185</p> 443</p>
444<h2><a name="extension_objects">Extension Objects</a></h2>
445<p>Very perl extension is a perl class. A separate perl object is created
446for each terminal and each extension and passed as the first parameter to
447hooks. So extensions can use their <code>$self</code> object without having to think
448about other extensions, with the exception of methods and members that
449begin with an underscore character <code>_</code>: these are reserved for internal
450use.</p>
451<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
452<code>urxvt::term</code> class on this object.</p>
453<p>It has the following methods and data members:</p>
454<dl>
455<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
456</dt>
457<dd>
458Returns the <code>urxvt::term</code> object associated with this instance of the
459extension. This member <em>must not</em> be changed in any way.
460</dd>
461<p></p>
462<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
463</dt>
464<dd>
465Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
466this extension, replacing any previous hook. This is useful when you want
467to overwrite time-critical hooks only temporarily.
468</dd>
469<p></p>
470<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
471</dt>
472<dd>
473Dynamically disable the given hooks.
474</dd>
475<p></p></dl>
476<p>
477</p>
186<h2><a name="hooks">Hooks</a></h2> 478<h2><a name="hooks">Hooks</a></h2>
187<p>The following subroutines can be declared in extension files, and will be 479<p>The following subroutines can be declared in extension files, and will be
188called whenever the relevant event happens.</p> 480called whenever the relevant event happens.</p>
189<p>The first argument passed to them is an object private to each terminal 481<p>The first argument passed to them is an extension oject as described in
190and extension package. You can call all <code>urxvt::term</code> methods on it, but 482the in the <code>Extension Objects</code> section.</p>
191its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> 483<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
192object that is shared between all packages is stored in the <code>term</code> 484hooks returns true, then the event counts as being <em>consumed</em>, and the
193member. It is, however, blessed intot he package of the extension script,
194so for all practical purposes you can treat an extension script as a class.</p>
195<p>All of them must return a boolean value. If it is true, then the event
196counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
197and the relevant action might not be carried out by the C++ code.</p> 485relevant action might not be carried out by the C++ code.</p>
198<p>When in doubt, return a false value (preferably <code>()</code>).</p> 486<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
199<dl> 487<dl>
200<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 488<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
201</dt> 489</dt>
202<dd> 490<dd>
203Called after a new terminal object has been initialized, but before 491Called after a new terminal object has been initialized, but before
204windows are created or the command gets run. Most methods are unsafe to 492windows are created or the command gets run. Most methods are unsafe to
205call or deliver senseless data, as terminal size and other characteristics 493call or deliver senseless data, as terminal size and other characteristics
206have not yet been determined. You can safely query and change resources, 494have not yet been determined. You can safely query and change resources
207though. 495and options, though. For many purposes the <code>on_start</code> hook is a better
496place.
497</dd>
498<p></p>
499<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
500</dt>
501<dd>
502Called at the very end of initialisation of a new terminal, just before
503trying to map (display) the toplevel and returning to the mainloop.
504</dd>
505<p></p>
506<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
507</dt>
508<dd>
509Called whenever something tries to destroy terminal, when the terminal is
510still fully functional (not for long, though).
208</dd> 511</dd>
209<p></p> 512<p></p>
210<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 513<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
211</dt> 514</dt>
212<dd> 515<dd>
213Called after the screen is ``reset'' for any reason, such as resizing or 516Called after the screen is ``reset'' for any reason, such as resizing or
214control sequences. Here is where you can react on changes to size-related 517control sequences. Here is where you can react on changes to size-related
215variables. 518variables.
216</dd> 519</dd>
217<p></p> 520<p></p>
218<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 521<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
219</dt> 522</dt>
523<dd>
524Called just after the child process has been <code>fork</code>ed.
220<dd> 525</dd>
221Called at the very end of initialisation of a new terminal, just before 526<p></p>
222returning to the mainloop. 527<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
528</dt>
529<dd>
530Called just after the child process has exited. <code>$status</code> is the status
531from <code>waitpid</code>.
223</dd> 532</dd>
224<p></p> 533<p></p>
225<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 534<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
226</dt> 535</dt>
227<dd> 536<dd>
… …
249</dt> 558</dt>
250<dd> 559<dd>
251Called whenever the user tries to extend the selection (e.g. with a double 560Called whenever the user tries to extend the selection (e.g. with a double
252click) and is either supposed to return false (normal operation), or 561click) and is either supposed to return false (normal operation), or
253should extend the selection itelf and return true to suppress the built-in 562should extend the selection itelf and return true to suppress the built-in
254processing. 563processing. This can happen multiple times, as long as the callback
564returns true, it will be called on every further click by the user and is
565supposed to enlarge the selection more and more, if possible.
255</dd> 566</dd>
256<dd> 567<dd>
257<p>See the <em>selection</em> example extension.</p> 568<p>See the <em>selection</em> example extension.</p>
258</dd> 569</dd>
259<p></p> 570<p></p>
… …
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 613and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
303might be very slow, however, as your hook is called for <strong>all</strong> text being 614might be very slow, however, as your hook is called for <strong>all</strong> text being
304output. 615output.
305</dd> 616</dd>
306<p></p> 617<p></p>
618<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
619</dt>
620<dd>
621Called whenever some data is written to the tty/pty and can be used to
622suppress or filter tty input.
623</dd>
624<p></p>
307<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 625<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
308</dt> 626</dt>
309<dd> 627<dd>
310Called whenever a line was updated or changed. Can be used to filter 628Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines 629screen output (e.g. underline urls or other useless stuff). Only lines
… …
343Called whenever the user presses a key combination that has a 661Called whenever the user presses a key combination that has a
344<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 662<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
345resource in the <code>rxvt(1)</code> manpage). 663resource in the <code>rxvt(1)</code> manpage).
346</dd> 664</dd>
347<p></p> 665<p></p>
666<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
667</dt>
668<dd>
669Called on every X event received on the vt window (and possibly other
670windows). Should only be used as a last resort. Most event structure
671members are not passed.
672</dd>
673<p></p>
348<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 674<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
349</dt> 675</dt>
350<dd> 676<dd>
351Called whenever the window gets the keyboard focus, before rxvt-unicode 677Called whenever the window gets the keyboard focus, before rxvt-unicode
352does focus in processing. 678does focus in processing.
… …
357<dd> 683<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing. 685focus out processing.
360</dd> 686</dd>
361<p></p> 687<p></p>
688<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
689</dt>
690<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
691</dt>
362<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 692<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
363</dt> 693</dt>
364<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 694<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
365</dt> 695</dt>
366<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 696<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
367</dt> 697</dt>
368<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 698<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
369</dt> 699</dt>
… …
377Called whenever the corresponding X event is received for the terminal If 707Called whenever the corresponding X event is received for the terminal If
378the hook returns true, then the even will be ignored by rxvt-unicode. 708the hook returns true, then the even will be ignored by rxvt-unicode.
379</dd> 709</dd>
380<dd> 710<dd>
381<p>The event is a hash with most values as named by Xlib (see the XEvent 711<p>The event is a hash with most values as named by Xlib (see the XEvent
382manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 712manpage), with the additional members <code>row</code> and <code>col</code>, which are the
383and column under the mouse cursor.</p> 713(real, not screen-based) row and column under the mouse cursor.</p>
384</dd> 714</dd>
385<dd> 715<dd>
386<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 716<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
387output, if any, in locale-specific encoding.</p> 717output, if any, in locale-specific encoding.</p>
388</dd> 718</dd>
389<dd> 719<dd>
390<p>subwindow.</p> 720<p>subwindow.</p>
391</dd> 721</dd>
722<p></p>
723<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
724</dt>
725<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
726</dt>
727<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
728</dt>
729<dd>
730Called when various types of ClientMessage events are received (all with
731format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
732</dd>
392<p></p></dl> 733<p></p></dl>
393<p> 734<p>
394</p> 735</p>
395<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 736<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
396<dl> 737<dl>
738<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
739</dt>
740<dd>
741The rxvt-unicode library directory, where, among other things, the perl
742modules and scripts are stored.
743</dd>
744<p></p>
745<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
746</dt>
747<dd>
748The resource class and name rxvt-unicode uses to look up X resources.
749</dd>
750<p></p>
751<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
752</dt>
753<dd>
754The basename of the installed binaries, usually <code>urxvt</code>.
755</dd>
756<p></p>
397<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 757<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
398</dt> 758</dt>
399<dd> 759<dd>
400The current terminal. This variable stores the current <code>urxvt::term</code> 760The current terminal. This variable stores the current <code>urxvt::term</code>
401object, whenever a callback/hook is executing. 761object, whenever a callback/hook is executing.
402</dd> 762</dd>
763<p></p>
764<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
765</dt>
766<dd>
767All coderefs in this array will be called as methods of the next newly
768created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
769gets cleared before the codereferences that were in it are being executed,
770so coderefs can push themselves onto it again if they so desire.
771</dd>
772<dd>
773<p>This complements to the perl-eval commandline option, but gets executed
774first.</p>
775</dd>
776<p></p>
777<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
778</dt>
779<dd>
780Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
781get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
782but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
783</dd>
403<p></p></dl> 784<p></p></dl>
404<p> 785<p>
405</p> 786</p>
406<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 787<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
407<dl> 788<dl>
408<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
409</dt>
410<dd>
411Creates a new terminal, very similar as if you had started it with
412<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
413if the new instance couldn't be created. Returns <code>undef</code> if the new
414instance didn't initialise perl, and the terminal object otherwise. The
415<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
416</dd>
417<p></p>
418<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 789<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
419</dt> 790</dt>
420<dd> 791<dd>
421Fatally aborts execution with the given error message. Avoid at all 792Fatally aborts execution with the given error message. Avoid at all
422costs! The only time this is acceptable is when the terminal process 793costs! The only time this is acceptable is when the terminal process
… …
432</dd> 803</dd>
433<dd> 804<dd>
434<p>Using this function has the advantage that its output ends up in the 805<p>Using this function has the advantage that its output ends up in the
435correct place, e.g. on stderr of the connecting urxvtc client.</p> 806correct place, e.g. on stderr of the connecting urxvtc client.</p>
436</dd> 807</dd>
437<p></p>
438<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
439</dt>
440<dd> 808<dd>
441Returns true when it is safe to do potentially unsafe things, such as 809<p>Messages have a size limit of 1023 bytes currently.</p>
442evaluating perl code specified by the user. This is true when urxvt was
443started setuid or setgid.
444</dd> 810</dd>
445<p></p> 811<p></p>
446<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 812<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
447</dt> 813</dt>
448<dd> 814<dd>
… …
452<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 818<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
453</dt> 819</dt>
454<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 820<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
455Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 821Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
456Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 822Button4Mask, Button5Mask, AnyModifier</a></strong><br />
823</dt>
824<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
825ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
826PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
827Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
828KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
829ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
830FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
831</dt>
832<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
833EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
834GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
835UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
836ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
837CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
838SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
457</dt> 839</dt>
458<dd> 840<dd>
459Various constants for use in X calls and event processing. 841Various constants for use in X calls and event processing.
460</dd> 842</dd>
461<p></p></dl> 843<p></p></dl>
… …
496</dt> 878</dt>
497<dd> 879<dd>
498Return the foreground/background colour index, respectively. 880Return the foreground/background colour index, respectively.
499</dd> 881</dd>
500<p></p> 882<p></p>
501<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 883<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
502</dt> 884</dt>
503<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 885<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
504</dt> 886</dt>
505<dd> 887<dd>
506Replace the foreground/background colour in the rendition mask with the 888Replace the foreground/background colour in the rendition mask with the
507specified one. 889specified one.
508</dd> 890</dd>
509<p></p> 891<p></p>
510<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 892<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
511</dt> 893</dt>
512<dd> 894<dd>
513Return the ``custom'' value: Every rendition has 5 bits for use by 895Return the ``custom'' value: Every rendition has 5 bits for use by
514extensions. They can be set and changed as you like and are initially 896extensions. They can be set and changed as you like and are initially
515zero. 897zero.
516</dd> 898</dd>
517<p></p> 899<p></p>
518<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 900<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
519</dt> 901</dt>
520<dd> 902<dd>
521Change the custom value. 903Change the custom value.
522</dd> 904</dd>
523<p></p></dl> 905<p></p></dl>
524<p> 906<p>
525</p> 907</p>
526<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 908<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
527<p>The sole purpose of this class is to deliver an interface to the 909<p>The sole purpose of this class is to deliver an interface to the
528<code>AnyEvent</code> module - any module using it will work inside urxvt without 910<code>AnyEvent</code> module - any module using it will work inside urxvt without
529further work. The only exception is that you cannot wait on condition 911further programming. The only exception is that you cannot wait on
530variables, but non-blocking condvar use is ok. What this means is that you 912condition variables, but non-blocking condvar use is ok. What this means
531cannot use blocking APIs, but the non-blocking variant should work.</p> 913is that you cannot use blocking APIs, but the non-blocking variant should
914work.</p>
532<p> 915<p>
533</p> 916</p>
534<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 917<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
535<dl> 918<dl>
919<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
920</dt>
921<dd>
922Creates a new terminal, very similar as if you had started it with system
923<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
924hash which defines the environment of the new terminal.
925</dd>
926<dd>
927<p>Croaks (and probably outputs an error message) if the new instance
928couldn't be created. Returns <code>undef</code> if the new instance didn't
929initialise perl, and the terminal object otherwise. The <code>init</code> and
930<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
931</dd>
932<p></p>
536<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 933<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
537</dt> 934</dt>
538<dd> 935<dd>
539Destroy the terminal object (close the window, free resources etc.). 936Destroy the terminal object (close the window, free resources
937etc.). Please note that rxvt will not exit as long as any event
938watchers (timers, io watchers) are still active.
939</dd>
940<p></p>
941<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
942</dt>
943<dd>
944Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
945(``starts'') programs in the background. This function takes care of setting
946the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
947be preferred over explicit calls to <code>exec</code> or <code>system</code>.
948</dd>
949<dd>
950<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
540</dd> 951</dd>
541<p></p> 952<p></p>
542<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 953<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
543</dt> 954</dt>
544<dd> 955<dd>
… …
552</dd> 963</dd>
553<dd> 964<dd>
554<pre> 965<pre>
555 borderLess console cursorBlink cursorUnderline hold iconic insecure 966 borderLess console cursorBlink cursorUnderline hold iconic insecure
556 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 967 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
557 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 968 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
558 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 969 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
559 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 970 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
560 tripleclickwords utmpInhibit visualBell</pre> 971 transparent tripleclickwords utmpInhibit visualBell</pre>
561</dd> 972</dd>
562<p></p> 973<p></p>
563<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 974<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
564</dt> 975</dt>
565<dd> 976<dd>
… …
590<pre> 1001<pre>
591 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1002 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
592 borderLess color cursorBlink cursorUnderline cutchars delete_key 1003 borderLess color cursorBlink cursorUnderline cutchars delete_key
593 display_name embed ext_bwidth fade font geometry hold iconName 1004 display_name embed ext_bwidth fade font geometry hold iconName
594 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1005 imFont imLocale inputMethod insecure int_bwidth intensityStyles
595 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1006 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
596 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1007 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
597 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1008 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
598 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1009 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
599 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1010 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
600 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1011 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
601 shade term_name title transparent transparent_all tripleclickwords 1012 secondaryScreen secondaryScroll selectstyle shade term_name title
1013 transient_for transparent transparent_all tripleclickwords utmpInhibit
602 utmpInhibit visualBell</pre> 1014 visualBell</pre>
1015</dd>
1016<p></p>
1017<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1018</dt>
1019<dd>
1020Returns the X-Resource for the given pattern, excluding the program or
1021class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
1022same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1023resource with that pattern exists.
1024</dd>
1025<dd>
1026<p>This method should only be called during the <code>on_start</code> hook, as there is
1027only one resource database per display, and later invocations might return
1028the wrong resources.</p>
1029</dd>
1030<p></p>
1031<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1032</dt>
1033<dd>
1034Adds a keymap translation exactly as specified via a resource. See the
1035<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
603</dd> 1036</dd>
604<p></p> 1037<p></p>
605<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 1038<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
606</dt> 1039</dt>
607<dd> 1040<dd>
… …
625<dd> 1058<dd>
626Return the current values of the selection mark, begin or end positions, 1059Return the current values of the selection mark, begin or end positions,
627and optionally set them to new values. 1060and optionally set them to new values.
628</dd> 1061</dd>
629<p></p> 1062<p></p>
1063<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1064</dt>
1065<dd>
1066Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1067<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1068rectangular selection will be made. This is the prefered function to make
1069a selection.
1070</dd>
1071<p></p>
630<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1072<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
631</dt> 1073</dt>
632<dd> 1074<dd>
633Try to request the primary selection from the server (for example, as set 1075Try to request the primary selection text from the server (for example, as
634by the next method). 1076set by the next method). No visual feedback will be given. This function
1077is mostly useful from within <code>on_sel_grab</code> hooks.
635</dd> 1078</dd>
636<p></p> 1079<p></p>
637<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1080<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
638</dt> 1081</dt>
639<dd> 1082<dd>
640Return the current selection text and optionally replace it by <code>$newtext</code>. 1083Return the current selection text and optionally replace it by <code>$newtext</code>.
641</dd> 1084</dd>
1085<p></p>
1086<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1087</dt>
642<dd> 1088<dd>
643<p>#=item $term-&gt;overlay ($x, $y, $text)
644#
645#Create a simple multi-line overlay box. See the next method for details. 1089Create a simple multi-line overlay box. See the next method for details.
646#
647#=cut
648#
649#sub urxvt::term::scr_overlay {
650# my ($self, $x, $y, $text) = @_;
651#
652# my @lines = split /\n/, $text;
653#
654# my $w = 0;
655# for (map $self-&gt;strwidth ($_), @lines) {
656# $w = $_ if $w &lt; $_;
657# }
658#
659# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
660# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
661#}</p>
662</dd> 1090</dd>
663<p></p> 1091<p></p>
664<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 1092<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
665</dt> 1093</dt>
666<dd> 1094<dd>
… …
727<p></p> 1155<p></p>
728<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 1156<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
729</dt> 1157</dt>
730<dd> 1158<dd>
731Convert the given locale-encoded octets into a perl string. 1159Convert the given locale-encoded octets into a perl string.
1160</dd>
1161<p></p>
1162<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 />
1163</dt>
1164<dd>
1165XORs the rendition values in the given span with the provided value
1166(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1167refresh hooks to provide effects similar to the selection.
1168</dd>
1169<p></p>
1170<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 />
1171</dt>
1172<dd>
1173Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1174whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1175to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1176it instead. Both styles <em>MUST NOT</em> contain font styles.
1177</dd>
1178<p></p>
1179<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1180</dt>
1181<dd>
1182Ring the bell!
732</dd> 1183</dd>
733<p></p> 1184<p></p>
734<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 1185<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
735</dt> 1186</dt>
736<dd> 1187<dd>
… …
743<p>Normally its not a good idea to use this function, as programs might be 1194<p>Normally its not a good idea to use this function, as programs might be
744confused by changes in cursor position or scrolling. Its useful inside a 1195confused by changes in cursor position or scrolling. Its useful inside a
745<code>on_add_lines</code> hook, though.</p> 1196<code>on_add_lines</code> hook, though.</p>
746</dd> 1197</dd>
747<p></p> 1198<p></p>
1199<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1200</dt>
1201<dd>
1202Switch to given screen - 0 primary, 1 secondary.
1203</dd>
1204<p></p>
748<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1205<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
749</dt> 1206</dt>
750<dd> 1207<dd>
751Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1208Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
752locale-specific encoding of the terminal and can contain command sequences 1209locale-specific encoding of the terminal and can contain command sequences
… …
759Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1216Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
760pass characters instead of octets, you should convert your strings first 1217pass characters instead of octets, you should convert your strings first
761to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1218to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
762</dd> 1219</dd>
763<p></p> 1220<p></p>
1221<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1222</dt>
1223<dd>
1224Replaces the event mask of the pty watcher by the given event mask. Can
1225be used to suppress input and output handling to the pty/tty. See the
1226description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1227the previous value.
1228</dd>
1229<p></p>
1230<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1231</dt>
1232<dd>
1233Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1234is used.
1235</dd>
1236<p></p>
764<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1237<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
765</dt> 1238</dt>
766<dd> 1239<dd>
767Return the window id of the toplevel window. 1240Return the window id of the toplevel window.
768</dd> 1241</dd>
… …
771</dt> 1244</dt>
772<dd> 1245<dd>
773Return the window id of the terminal window. 1246Return the window id of the terminal window.
774</dd> 1247</dd>
775<p></p> 1248<p></p>
1249<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1250</dt>
1251<dd>
1252Adds the specified events to the vt event mask. Useful e.g. when you want
1253to receive pointer events all the times:
1254</dd>
1255<dd>
1256<pre>
1257 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1258</dd>
1259<p></p>
776<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1260<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
777</dt> 1261</dt>
778<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1262<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
779</dt> 1263</dt>
780<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1264<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
793</dt> 1277</dt>
794<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1278<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
795</dt> 1279</dt>
796<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1280<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
797</dt> 1281</dt>
798<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1282<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
799</dt> 1283</dt>
800<dd> 1284<dd>
801Return various integers describing terminal characteristics. 1285Return various integers describing terminal characteristics.
1286</dd>
1287<p></p>
1288<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1289</dt>
1290<dd>
1291Return the DISPLAY used by rxvt-unicode.
1292</dd>
1293<p></p>
1294<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1295</dt>
1296<dd>
1297Returns the LC_CTYPE category string used by this rxvt-unicode.
1298</dd>
1299<p></p>
1300<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1301</dt>
1302<dd>
1303Returns a copy of the environment in effect for the terminal as a hashref
1304similar to <code>\%ENV</code>.
802</dd> 1305</dd>
803<p></p> 1306<p></p>
804<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1307<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
805</dt> 1308</dt>
806<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1309<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
810<dd> 1313<dd>
811Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1314Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
812AltGr), the meta key (often Alt) and the num lock key, if applicable. 1315AltGr), the meta key (often Alt) and the num lock key, if applicable.
813</dd> 1316</dd>
814<p></p> 1317<p></p>
1318<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1319</dt>
1320<dd>
1321Returns the currently displayed screen (0 primary, 1 secondary).
1322</dd>
1323<p></p>
1324<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1325</dt>
1326<dd>
1327Returns wether the cursor is currently hidden or not.
1328</dd>
1329<p></p>
815<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1330<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
816</dt> 1331</dt>
817<dd> 1332<dd>
818Returns the negative row number of the topmost line. Minimum value is 1333Returns the row number of the topmost displayed line. Maximum value is
819<code>0</code>, which displays the normal terminal contents. Larger values scroll 1334<code>0</code>, which displays the normal terminal contents. Lower values scroll
820this many lines into the scrollback buffer. 1335this many lines into the scrollback buffer.
821</dd> 1336</dd>
822<p></p> 1337<p></p>
823<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1338<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
824</dt> 1339</dt>
… …
835</dt> 1350</dt>
836<dd> 1351<dd>
837Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1352Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
838is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1353is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
839terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1354terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
840line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1355line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
841is requested. 1356is requested.
842</dd> 1357</dd>
843<dd> 1358<dd>
844<p>If <code>$new_text</code> is specified, it will replace characters in the current 1359<p>If <code>$new_text</code> is specified, it will replace characters in the current
845line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1360line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
846to replace only parts of a line. The font index in the rendition will 1361to replace only parts of a line. The font index in the rendition will
847automatically be updated.</p> 1362automatically be updated.</p>
848</dd> 1363</dd>
849<dd> 1364<dd>
850<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1365<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
851than one cell when displayed are padded with urxvt::NOCHAR characters 1366than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
852(<code>chr 65535</code>). Characters with combining characters and other characters 1367characters. Characters with combining characters and other characters that
853that do not fit into the normal tetx encoding will be replaced with 1368do not fit into the normal tetx encoding will be replaced with characters
854characters in the private use area.</p> 1369in the private use area.</p>
855</dd> 1370</dd>
856<dd> 1371<dd>
857<p>You have to obey this encoding when changing text. The advantage is 1372<p>You have to obey this encoding when changing text. The advantage is
858that <code>substr</code> and similar functions work on screen cells and not on 1373that <code>substr</code> and similar functions work on screen cells and not on
859characters.</p> 1374characters.</p>
… …
930<p></p> 1445<p></p>
931<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1446<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
932</dt> 1447</dt>
933<dd> 1448<dd>
934Returns the character offset of the given row|col pair within the logical 1449Returns the character offset of the given row|col pair within the logical
935line. 1450line. Works for rows outside the line, too, and returns corresponding
1451offsets outside the string.
936</dd> 1452</dd>
937<p></p> 1453<p></p>
938<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1454<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
939</dt> 1455</dt>
940<dd> 1456<dd>
… …
993<dd> 1509<dd>
994Calls XUngrab for the most recent grab. Is called automatically on 1510Calls XUngrab for the most recent grab. Is called automatically on
995evaluation errors, as it is better to lose the grab in the error case as 1511evaluation errors, as it is better to lose the grab in the error case as
996the session. 1512the session.
997</dd> 1513</dd>
1514<p></p>
1515<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1516</dt>
1517<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1518</dt>
1519<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1520</dt>
1521<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1522</dt>
1523<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1524</dt>
1525<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1526</dt>
1527<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1528</dt>
1529<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1530</dt>
1531<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1532</dt>
1533<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1534</dt>
1535<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1536</dt>
1537<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1538</dt>
1539<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1540</dt>
1541<dd>
1542Various X or X-related functions. The <code>$term</code> object only serves as
1543the source of the display, otherwise those functions map more-or-less
1544directory onto the X functions of the same name.
1545</dd>
998<p></p></dl> 1546<p></p></dl>
999<p> 1547<p>
1000</p> 1548</p>
1001<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1549<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1550<dl>
1551<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1552</dt>
1553<dd>
1554Adds a non-clickable title to the popup.
1555</dd>
1556<p></p>
1557<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1558</dt>
1559<dd>
1560Creates a separator, optionally using the character given as <code>$sepchr</code>.
1561</dd>
1562<p></p>
1563<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1564</dt>
1565<dd>
1566Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1567selected.
1568</dd>
1569<p></p>
1570<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1571</dt>
1572<dd>
1573Adds a toggle/checkbox item to the popup. Teh callback gets called
1574whenever it gets toggled, with a boolean indicating its value as its first
1575argument.
1576</dd>
1577<p></p>
1578<dt><strong>$popup-&gt;show</strong><br />
1579</dt>
1580<dd>
1581Displays the popup (which is initially hidden).
1582</dd>
1583<p></p></dl>
1002<p> 1584<p>
1003</p> 1585</p>
1004<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1586<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1005<p>This class implements timer watchers/events. Time is represented as a 1587<p>This class implements timer watchers/events. Time is represented as a
1006fractional number of seconds since the epoch. Example:</p> 1588fractional number of seconds since the epoch. Example:</p>
… …
1057</dt> 1639</dt>
1058<dd> 1640<dd>
1059Set the event trigger time to <code>$tstamp</code> and start the timer. 1641Set the event trigger time to <code>$tstamp</code> and start the timer.
1060</dd> 1642</dd>
1061<p></p> 1643<p></p>
1644<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1645</dt>
1646<dd>
1647Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1648</dd>
1649<p></p>
1062<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1650<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1063</dt> 1651</dt>
1064<dd> 1652<dd>
1065Stop the timer. 1653Stop the timer.
1066</dd> 1654</dd>
… …
1072<pre> 1660<pre>
1073 $term-&gt;{socket} = ... 1661 $term-&gt;{socket} = ...
1074 $term-&gt;{iow} = urxvt::iow 1662 $term-&gt;{iow} = urxvt::iow
1075 -&gt;new 1663 -&gt;new
1076 -&gt;fd (fileno $term-&gt;{socket}) 1664 -&gt;fd (fileno $term-&gt;{socket})
1077 -&gt;events (1) # wait for read data 1665 -&gt;events (urxvt::EVENT_READ)
1078 -&gt;start 1666 -&gt;start
1079 -&gt;cb (sub { 1667 -&gt;cb (sub {
1080 my ($iow, $revents) = @_; 1668 my ($iow, $revents) = @_;
1081 # $revents must be 1 here, no need to check 1669 # $revents must be 1 here, no need to check
1082 sysread $term-&gt;{socket}, my $buf, 8192 1670 sysread $term-&gt;{socket}, my $buf, 8192
… …
1103</dd> 1691</dd>
1104<p></p> 1692<p></p>
1105<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1693<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1106</dt> 1694</dt>
1107<dd> 1695<dd>
1108Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1696Set the event mask to watch. The only allowed values are
1109data, Bit #1 (value <code>2</code>) enables watching for write data. 1697<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1698together, or <code>urxvt::EVENT_NONE</code>.
1110</dd> 1699</dd>
1111<p></p> 1700<p></p>
1112<dt><strong>$iow = $iow-&gt;start</strong><br /> 1701<dt><strong>$iow = $iow-&gt;start</strong><br />
1113</dt> 1702</dt>
1114<dd> 1703<dd>
… …
1117<p></p> 1706<p></p>
1118<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1707<dt><strong>$iow = $iow-&gt;stop</strong><br />
1119</dt> 1708</dt>
1120<dd> 1709<dd>
1121Stop watching for events on the given filehandle. 1710Stop watching for events on the given filehandle.
1711</dd>
1712<p></p></dl>
1713<p>
1714</p>
1715<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1716<p>This class implements idle watchers, that get called automatically when
1717the process is idle. They should return as fast as possible, after doing
1718some useful work.</p>
1719<dl>
1720<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1721</dt>
1722<dd>
1723Create a new idle watcher object in stopped state.
1724</dd>
1725<p></p>
1726<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1727</dt>
1728<dd>
1729Set the callback to be called when the watcher triggers.
1730</dd>
1731<p></p>
1732<dt><strong>$timer = $timer-&gt;start</strong><br />
1733</dt>
1734<dd>
1735Start the watcher.
1736</dd>
1737<p></p>
1738<dt><strong>$timer = $timer-&gt;stop</strong><br />
1739</dt>
1740<dd>
1741Stop the watcher.
1742</dd>
1743<p></p></dl>
1744<p>
1745</p>
1746<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1747<p>This class implements process watchers. They create an event whenever a
1748process exits, after which they stop automatically.</p>
1749<pre>
1750 my $pid = fork;
1751 ...
1752 $term-&gt;{pw} = urxvt::pw
1753 -&gt;new
1754 -&gt;start ($pid)
1755 -&gt;cb (sub {
1756 my ($pw, $exit_status) = @_;
1757 ...
1758 });</pre>
1759<dl>
1760<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1761</dt>
1762<dd>
1763Create a new process watcher in stopped state.
1764</dd>
1765<p></p>
1766<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1767</dt>
1768<dd>
1769Set the callback to be called when the timer triggers.
1770</dd>
1771<p></p>
1772<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1773</dt>
1774<dd>
1775Tells the wqtcher to start watching for process <code>$pid</code>.
1776</dd>
1777<p></p>
1778<dt><strong>$pw = $pw-&gt;stop</strong><br />
1779</dt>
1780<dd>
1781Stop the watcher.
1122</dd> 1782</dd>
1123<p></p></dl> 1783<p></p></dl>
1124<p> 1784<p>
1125</p> 1785</p>
1126<hr /> 1786<hr />
… …
1133<dl> 1793<dl>
1134<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1794<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1135</dt> 1795</dt>
1136<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1796<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1137</dt> 1797</dt>
1138<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1798<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1799</dt>
1800<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1139</dt> 1801</dt>
1140</dl> 1802</dl>
1141<p> 1803<p>
1142</p> 1804</p>
1143<hr /> 1805<hr />

Diff Legend

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