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.34 by root, Fri Jan 20 16:02:20 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
27 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
28 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
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>
29 </ul> 35 </ul>
30 36
31 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
32 <ul> 38 <ul>
33 39
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 67 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 68<p>
63</p> 69</p>
64<hr /> 70<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 72<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 73the <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 74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 75thus must be encoded as UTF-8.</p>
70<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
71scripts will be shared (but not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
72<p> 78<p>
73</p> 79</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 80<hr />
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
75<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
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 84<p>You can activate them like this:</p>
78<pre> 85<pre>
79 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>
80<dl> 90<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 92</dt>
83<dd>
84Intelligent selection. This etxension tries to be more intelligent when the user
85extends selections (double-click).
86</dd> 93<dd>
94(More) intelligent selection. This extension tries to be more intelligent
95when the user extends selections (double-click and further clicks). Right
96now, it tries to select words, urls and complete shell-quoted
97arguments, which is very convenient, too, if your <em>ls</em> supports
98<code>--quoting-style=shell</code>.
87<dd> 99</dd>
88<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>You can look at the source of the selection extension to see more
127interesting uses, such as parsing a line from beginning to end.</p>
128</dd>
129<dd>
130<p>This extension also offers following bindable keyboard commands:</p>
89</dd> 131</dd>
90<dl> 132<dl>
91<dt><strong><a name="item_rot13">rot13</a></strong><br /> 133<dt><strong><a name="item_rot13">rot13</a></strong><br />
92</dt> 134</dt>
93<dd> 135<dd>
… …
96<dd> 138<dd>
97<pre> 139<pre>
98 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 140 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
99</dd> 141</dd>
100<p></p></dl> 142<p></p></dl>
143<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
144</dt>
145<dd>
146Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
147runtime.
148</dd>
149<p></p>
150<dt><strong>selection-popup (enabled by default)</strong><br />
151</dt>
152<dd>
153Binds a popup menu to Ctrl-Button3 that lets you convert the selection
154text into various other formats/action (such as uri unescaping, perl
155evalution, web-browser starting etc.), depending on content.
156</dd>
157<dd>
158<p>Other extensions can extend this popup menu by pushing a code reference
159onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
160popup is displayed.</p>
161</dd>
162<dd>
163<p>It's sole argument is the popup menu, which can be modified. The selection
164is in <code>$_</code>, which can be used to decide wether to add something or not.
165It should either return nothing or a string and a code reference. The
166string will be used as button text and the code reference will be called
167when the button gets activated and should transform <code>$_</code>.</p>
168</dd>
169<dd>
170<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
171the selection to <code>b</code>s, but only if the selection currently contains any
172<code>a</code>s:</p>
173</dd>
174<dd>
175<pre>
176 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
177 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
178 : ()
179 };</pre>
180</dd>
181<p></p>
182<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
183</dt>
184<dd>
185Adds regex search functionality to the scrollback buffer, triggered
186by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
187input/output is suspended and a regex is displayed at the bottom of the
188screen.
189</dd>
190<dd>
191<p>Inputting characters appends them to the regex and continues incremental
192search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
193search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
194bottom. <code>Escape</code> leaves search mode and returns to the point where search
195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
196additionally stores the first match in the current line into the primary
197selection.</p>
198</dd>
199<p></p>
200<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
201</dt>
202<dd>
203This selection allows you to do automatic transforms on a selection
204whenever a selection is made.
205</dd>
206<dd>
207<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
208operator) that modify <code>$_</code> as resources:</p>
209</dd>
210<dd>
211<pre>
212 URxvt.selection-autotransform.0: transform
213 URxvt.selection-autotransform.1: transform
214 ...</pre>
215</dd>
216<dd>
217<p>For example, the following will transform selections of the form
218<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
219$word</code>:</p>
220</dd>
221<dd>
222<pre>
223 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
224</dd>
225<dd>
226<p>And this example matches the same,but replaces it with vi-commands you can
227paste directly into your (vi :) editor:</p>
228</dd>
229<dd>
230<pre>
231 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
232</dd>
233<dd>
234<p>Of course, this can be modified to suit your needs and your editor :)</p>
235</dd>
236<dd>
237<p>To expand the example above to typical perl error messages (``XXX at
238FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
239</dd>
240<dd>
241<pre>
242 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
243 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
244</dd>
245<dd>
246<p>The first line tells the selection code to treat the unchanging part of
247every error message as a selection pattern, and the second line transforms
248the message into vi commands to load the file.</p>
249</dd>
250<p></p>
251<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
252</dt>
253<dd>
254This transforms the terminal into a tabbar with additional terminals, that
255is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
256displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
257button per tab.
258</dd>
259<dd>
260<p>Clicking a button will activate that tab. Pressing Shift-Left and
261Shift-Right will switch to the tab left or right of the current one.</p>
262</dd>
263<p></p>
264<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
265</dt>
266<dd>
267Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
268make them clickable. When middle-clicked, the program specified in the
269resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
270the URL as first argument.
271</dd>
272<p></p>
273<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
274</dt>
275<dd>
276This is basically a one-line extension that dynamically changes the background pixmap offset
277to the window position, in effect creating the same effect as pseudo transparency with
278a custom pixmap. No scaling is supported in this mode. Exmaple:
279</dd>
280<dd>
281<pre>
282 rxvt -pixmap background.xpm -pe automove-background</pre>
283</dd>
284<p></p>
285<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
286</dt>
287<dd>
288A not very useful example of filtering all text output to the terminal,
289by replacing all line-drawing characters (U+2500 .. U+259F) by a
290similar-looking ascii character.
291</dd>
292<p></p>
101<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 293<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
102</dt> 294</dt>
103<dd> 295<dd>
104Displays a digital clock using the built-in overlay. 296Displays a digital clock using the built-in overlay.
105</dd> 297</dd>
… …
109<dd> 301<dd>
110Displays a very simple digital clock in the upper right corner of the 302Displays a very simple digital clock in the upper right corner of the
111window. Illustrates overwriting the refresh callbacks to create your own 303window. Illustrates overwriting the refresh callbacks to create your own
112overlays or changes. 304overlays or changes.
113</dd> 305</dd>
306<p></p>
307<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
308</dt>
309<dd>
310This is a little rarely useful extension that Uploads the selection as
311textfile to a remote site (or does other things). (The implementation is
312not currently secure for use in a multiuser environment as it writes to
313<em>/tmp</em> directly.).
314</dd>
315<dd>
316<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
317i.e.</p>
318</dd>
319<dd>
320<pre>
321 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
322</dd>
323<dd>
324<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
325the textfile. This command can be set via a resource:</p>
326</dd>
327<dd>
328<pre>
329 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
330</dd>
331<dd>
332<p>And the default is likely not useful to anybody but the few people around
333here :)</p>
334</dd>
335<dd>
336<p>The name of the textfile is the hex encoded md5 sum of the selection, so
337the same content should lead to the same filename.</p>
338</dd>
339<dd>
340<p>After a successful upload the selection will be replaced by the text given
341in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
342for the filename):</p>
343</dd>
344<dd>
345<pre>
346 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
347</dd>
114<p></p></dl> 348<p></p></dl>
349<p>
350</p>
351<hr />
352<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
115<p> 353<p>
116</p> 354</p>
117<h2><a name="general_api_considerations">General API Considerations</a></h2> 355<h2><a name="general_api_considerations">General API Considerations</a></h2>
118<p>All objects (such as terminals, time watchers etc.) are typical 356<p>All objects (such as terminals, time watchers etc.) are typical
119reference-to-hash objects. The hash can be used to store anything you 357reference-to-hash objects. The hash can be used to store anything you
… …
122modified).</p> 360modified).</p>
123<p>When objects are destroyed on the C++ side, the perl object hashes are 361<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 362emptied, 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 363the like inside the terminal object so they get destroyed as soon as the
126terminal is destroyed.</p> 364terminal is destroyed.</p>
365<p>Argument names also often indicate the type of a parameter. Here are some
366hints on what they mean:</p>
367<dl>
368<dt><strong><a name="item__24text">$text</a></strong><br />
369</dt>
370<dd>
371Rxvt-unicodes special way of encoding text, where one ``unicode'' character
372always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
373</dd>
374<p></p>
375<dt><strong><a name="item__24string">$string</a></strong><br />
376</dt>
377<dd>
378A perl text string, with an emphasis on <em>text</em>. It can store all unicode
379characters and is to be distinguished with text encoded in a specific
380encoding (often locale-specific) and binary data.
381</dd>
382<p></p>
383<dt><strong><a name="item__24octets">$octets</a></strong><br />
384</dt>
385<dd>
386Either binary data or - more common - a text string encoded in a
387locale-specific way.
388</dd>
389<p></p></dl>
390<p>
391</p>
392<h2><a name="extension_objects">Extension Objects</a></h2>
393<p>Very perl extension is a perl class. A separate perl object is created
394for each terminal and each extension and passed as the first parameter to
395hooks. So extensions can use their <code>$self</code> object without having to think
396about other extensions, with the exception of methods and members that
397begin with an underscore character <code>_</code>: these are reserved for internal
398use.</p>
399<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
400<code>urxvt::term</code> class on this object.</p>
401<p>It has the following methods and data members:</p>
402<dl>
403<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
404</dt>
405<dd>
406Returns the <code>urxvt::term</code> object associated with this instance of the
407extension. This member <em>must not</em> be changed in any way.
408</dd>
409<p></p>
410<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
411</dt>
412<dd>
413Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
414this extension, replacing any previous hook. This is useful when you want
415to overwrite time-critical hooks only temporarily.
416</dd>
417<p></p>
418<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
419</dt>
420<dd>
421Dynamically disable the given hooks.
422</dd>
423<p></p></dl>
127<p> 424<p>
128</p> 425</p>
129<h2><a name="hooks">Hooks</a></h2> 426<h2><a name="hooks">Hooks</a></h2>
130<p>The following subroutines can be declared in loaded scripts, and will be 427<p>The following subroutines can be declared in extension files, and will be
131called whenever the relevant event happens.</p> 428called whenever the relevant event happens.</p>
132<p>The first argument passed to them is an object private to each terminal 429<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 430the in the <code>Extension Objects</code> section.</p>
134its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> 431<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
135object that is shared between all packages is stored in the <code>term</code> 432hooks returns true, then the event counts as being <em>consumed</em>, and the
136member.</p>
137<p>All of them must return a boolean value. If it is true, then the event
138counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
139and the relevant action might not be carried out by the C++ code.</p> 433relevant action might not be carried out by the C++ code.</p>
140<p>When in doubt, return a false value (preferably <code>()</code>).</p> 434<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
141<dl> 435<dl>
142<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 436<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
143</dt> 437</dt>
144<dd> 438<dd>
145Called after a new terminal object has been initialized, but before 439Called after a new terminal object has been initialized, but before
146windows are created or the command gets run. 440windows are created or the command gets run. Most methods are unsafe to
441call or deliver senseless data, as terminal size and other characteristics
442have not yet been determined. You can safely query and change resources
443and options, though. For many purposes the <code>on_start</code> hook is a better
444place.
445</dd>
446<p></p>
447<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
448</dt>
449<dd>
450Called at the very end of initialisation of a new terminal, just before
451trying to map (display) the toplevel and returning to the mainloop.
452</dd>
453<p></p>
454<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
455</dt>
456<dd>
457Called whenever something tries to destroy terminal, before doing anything
458yet. If this hook returns true, then destruction is skipped, but this is
459rarely a good idea.
147</dd> 460</dd>
148<p></p> 461<p></p>
149<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 462<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
150</dt> 463</dt>
151<dd> 464<dd>
152Called after the screen is ``reset'' for any reason, such as resizing or 465Called after the screen is ``reset'' for any reason, such as resizing or
153control sequences. Here is where you can react on changes to size-related 466control sequences. Here is where you can react on changes to size-related
154variables. 467variables.
155</dd> 468</dd>
156<p></p> 469<p></p>
157<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 470<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
158</dt> 471</dt>
472<dd>
473Called just after the child process has been <code>fork</code>ed.
159<dd> 474</dd>
160Called at the very end of initialisation of a new terminal, just before 475<p></p>
161returning to the mainloop. 476<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
477</dt>
478<dd>
479Called just after the child process has exited. <code>$status</code> is the status
480from <code>waitpid</code>.
162</dd> 481</dd>
163<p></p> 482<p></p>
164<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 483<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
165</dt> 484</dt>
166<dd> 485<dd>
… …
188</dt> 507</dt>
189<dd> 508<dd>
190Called whenever the user tries to extend the selection (e.g. with a double 509Called whenever the user tries to extend the selection (e.g. with a double
191click) and is either supposed to return false (normal operation), or 510click) and is either supposed to return false (normal operation), or
192should extend the selection itelf and return true to suppress the built-in 511should extend the selection itelf and return true to suppress the built-in
193processing. 512processing. This can happen multiple times, as long as the callback
513returns true, it will be called on every further click by the user and is
514supposed to enlarge the selection more and more, if possible.
194</dd> 515</dd>
195<dd> 516<dd>
196<p>See the <em>selection</em> example extension.</p> 517<p>See the <em>selection</em> example extension.</p>
197</dd>
198<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> 518</dd>
212<p></p> 519<p></p>
213<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 520<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
214</dt> 521</dt>
215<dd> 522<dd>
… …
229<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 536<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 537$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> 538number of lines that will be in the scrollback buffer.</p>
232</dd> 539</dd>
233<p></p> 540<p></p>
234<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 541<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
235</dt> 542</dt>
543<dd>
544Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
545operating system command) is processed. Cursor position and other state
546information is up-to-date when this happens. For interoperability, the
547string should start with the extension name and a colon, to distinguish
548it from commands for other extensions, and this might be enforced in the
549future.
236<dd> 550</dd>
237Called whenever the <code>program(s)</code> running in the urxvt window send output. 551<dd>
552<p>Be careful not ever to trust (in a security sense) the data you receive,
553as its source can not easily be controleld (e-mail content, messages from
554other users on the same system etc.).</p>
555</dd>
556<p></p>
557<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
558</dt>
559<dd>
560Called whenever text is about to be output, with the text as argument. You
561can filter/change and output the text yourself by returning a true value
562and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
563might be very slow, however, as your hook is called for <strong>all</strong> text being
564output.
565</dd>
566<p></p>
567<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
568</dt>
569<dd>
570Called whenever some data is written to the tty/pty and can be used to
571suppress or filter tty input.
572</dd>
573<p></p>
574<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
575</dt>
576<dd>
577Called whenever a line was updated or changed. Can be used to filter
578screen output (e.g. underline urls or other useless stuff). Only lines
579that are being shown will be filtered, and, due to performance reasons,
580not always immediately.
581</dd>
582<dd>
583<p>The row number is always the topmost row of the line if the line spans
584multiple rows.</p>
585</dd>
586<dd>
587<p>Please note that, if you change the line, then the hook might get called
588later with the already-modified line (e.g. if unrelated parts change), so
589you cannot just toggle rendition bits, but only set them.</p>
238</dd> 590</dd>
239<p></p> 591<p></p>
240<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 592<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
241</dt> 593</dt>
242<dd> 594<dd>
… …
257<dd> 609<dd>
258Called whenever the user presses a key combination that has a 610Called 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> 611<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
260resource in the <code>rxvt(1)</code> manpage). 612resource in the <code>rxvt(1)</code> manpage).
261</dd> 613</dd>
614<p></p>
615<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
616</dt>
617<dd>
618Called on every X event received on the vt window (and possibly other
619windows). Should only be used as a last resort. Most event structure
620members are not passed.
621</dd>
622<p></p>
623<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
624</dt>
625<dd>
626Called whenever the window gets the keyboard focus, before rxvt-unicode
627does focus in processing.
628</dd>
629<p></p>
630<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
631</dt>
632<dd>
633Called wheneever the window loses keyboard focus, before rxvt-unicode does
634focus out processing.
635</dd>
636<p></p>
637<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
638</dt>
639<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
640</dt>
641<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
642</dt>
643<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
644</dt>
645<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
646</dt>
647<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
648</dt>
649<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
650</dt>
651<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
652</dt>
653<dd>
654Called whenever the corresponding X event is received for the terminal If
655the hook returns true, then the even will be ignored by rxvt-unicode.
656</dd>
657<dd>
658<p>The event is a hash with most values as named by Xlib (see the XEvent
659manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
660and column under the mouse cursor.</p>
661</dd>
662<dd>
663<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
664output, if any, in locale-specific encoding.</p>
665</dd>
666<dd>
667<p>subwindow.</p>
668</dd>
669<p></p>
670<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
671</dt>
672<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
673</dt>
674<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
675</dt>
676<dd>
677Called when various types of ClientMessage events are received (all with
678format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
679</dd>
262<p></p></dl> 680<p></p></dl>
263<p> 681<p>
264</p> 682</p>
265<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 683<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
266<dl> 684<dl>
685<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
686</dt>
687<dd>
688The rxvt-unicode library directory, where, among other things, the perl
689modules and scripts are stored.
690</dd>
691<p></p>
692<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
693</dt>
694<dd>
695The resource class and name rxvt-unicode uses to look up X resources.
696</dd>
697<p></p>
698<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
699</dt>
700<dd>
701The basename of the installed binaries, usually <code>urxvt</code>.
702</dd>
703<p></p>
267<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 704<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
268</dt> 705</dt>
269<dd> 706<dd>
270The current terminal. Whenever a callback/Hook is bein executed, this 707The current terminal. This variable stores the current <code>urxvt::term</code>
271variable stores the current <code>urxvt::term</code> object. 708object, whenever a callback/hook is executing.
709</dd>
710<p></p>
711<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
712</dt>
713<dd>
714All coderefs in this array will be called as methods of the next newly
715created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
716gets cleared before the codereferences that were in it are being executed,
717so coderefs can push themselves onto it again if they so desire.
718</dd>
719<dd>
720<p>This complements to the perl-eval commandline option, but gets executed
721first.</p>
722</dd>
723<p></p>
724<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
725</dt>
726<dd>
727Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
728get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
729but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
272</dd> 730</dd>
273<p></p></dl> 731<p></p></dl>
274<p> 732<p>
275</p> 733</p>
276<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 734<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
… …
292</dd> 750</dd>
293<dd> 751<dd>
294<p>Using this function has the advantage that its output ends up in the 752<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> 753correct place, e.g. on stderr of the connecting urxvtc client.</p>
296</dd> 754</dd>
755<dd>
756<p>Messages have a size limit of 1023 bytes currently.</p>
757</dd>
297<p></p> 758<p></p>
298<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 759<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
299</dt> 760</dt>
300<dd> 761<dd>
301Returns the ``current time'' (as per the event loop). 762Returns the ``current time'' (as per the event loop).
763</dd>
764<p></p>
765<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
766</dt>
767<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
768Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
769Button4Mask, Button5Mask, AnyModifier</a></strong><br />
770</dt>
771<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
772ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
773PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
774Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
775KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
776ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
777FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
778</dt>
779<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
780EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
781GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
782UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
783ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
784CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
785SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
786</dt>
787<dd>
788Various constants for use in X calls and event processing.
302</dd> 789</dd>
303<p></p></dl> 790<p></p></dl>
304<p> 791<p>
305</p> 792</p>
306<h2><a name="rendition">RENDITION</a></h2> 793<h2><a name="rendition">RENDITION</a></h2>
… …
338</dt> 825</dt>
339<dd> 826<dd>
340Return the foreground/background colour index, respectively. 827Return the foreground/background colour index, respectively.
341</dd> 828</dd>
342<p></p> 829<p></p>
343<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 830<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
344</dt> 831</dt>
345<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 832<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
346</dt> 833</dt>
347<dd> 834<dd>
348Replace the foreground/background colour in the rendition mask with the 835Replace the foreground/background colour in the rendition mask with the
349specified one. 836specified one.
350</dd> 837</dd>
351<p></p> 838<p></p>
352<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 839<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
353</dt> 840</dt>
354<dd> 841<dd>
355Return the ``custom'' value: Every rendition has 5 bits for use by 842Return the ``custom'' value: Every rendition has 5 bits for use by
356extensions. They can be set and changed as you like and are initially 843extensions. They can be set and changed as you like and are initially
357zero. 844zero.
358</dd> 845</dd>
359<p></p> 846<p></p>
360<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 847<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
361</dt> 848</dt>
362<dd> 849<dd>
363Change the custom value. 850Change the custom value.
364</dd> 851</dd>
365<p></p></dl> 852<p></p></dl>
853<p>
854</p>
855<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
856<p>The sole purpose of this class is to deliver an interface to the
857<code>AnyEvent</code> module - any module using it will work inside urxvt without
858further programming. The only exception is that you cannot wait on
859condition variables, but non-blocking condvar use is ok. What this means
860is that you cannot use blocking APIs, but the non-blocking variant should
861work.</p>
366<p> 862<p>
367</p> 863</p>
368<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 864<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
369<dl> 865<dl>
866<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
867</dt>
868<dd>
869Creates a new terminal, very similar as if you had started it with system
870<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
871hash which defines the environment of the new terminal.
872</dd>
873<dd>
874<p>Croaks (and probably outputs an error message) if the new instance
875couldn't be created. Returns <code>undef</code> if the new instance didn't
876initialise perl, and the terminal object otherwise. The <code>init</code> and
877<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
878</dd>
879<p></p>
880<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
881</dt>
882<dd>
883Destroy the terminal object (close the window, free resources
884etc.). Please note that rxvt will not exit as long as any event
885watchers (timers, io watchers) are still active.
886</dd>
887<p></p>
888<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
889</dt>
890<dd>
891Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
892(``starts'') programs in the background. This function takes care of setting
893the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
894be preferred over explicit calls to <code>exec</code> or <code>system</code>.
895</dd>
896<dd>
897<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
898</dd>
899<p></p>
900<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
901</dt>
902<dd>
903Returns true if the option specified by <code>$optval</code> is enabled, and
904optionally change it. All option values are stored by name in the hash
905<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
906</dd>
907<dd>
908<p>Here is a a likely non-exhaustive list of option names, please see the
909source file <em>/src/optinc.h</em> to see the actual list:</p>
910</dd>
911<dd>
912<pre>
913 borderLess console cursorBlink cursorUnderline hold iconic insecure
914 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
915 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
916 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
917 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
918 transparent tripleclickwords utmpInhibit visualBell</pre>
919</dd>
920<p></p>
370<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 921<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
371</dt> 922</dt>
372<dd> 923<dd>
373Returns the current resource value associated with a given name and 924Returns 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> 925optionally 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 939<p>Please note that resource strings will currently only be freed when the
389terminal is destroyed, so changing options frequently will eat memory.</p> 940terminal is destroyed, so changing options frequently will eat memory.</p>
390</dd> 941</dd>
391<dd> 942<dd>
392<p>Here is a a likely non-exhaustive list of resource names, not all of which 943<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 944are supported in every build, please see the source file <em>/src/rsinc.h</em>
394list:</p> 945to see the actual list:</p>
395</dd> 946</dd>
396<dd> 947<dd>
397<pre> 948<pre>
398 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 949 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
399 borderLess color cursorBlink cursorUnderline cutchars delete_key 950 borderLess color cursorBlink cursorUnderline cutchars delete_key
400 display_name embed ext_bwidth fade font geometry hold iconName 951 display_name embed ext_bwidth fade font geometry hold iconName
401 imFont imLocale inputMethod insecure int_bwidth intensityStyles 952 imFont imLocale inputMethod insecure int_bwidth intensityStyles
402 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 953 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
403 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 954 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
404 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 955 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
405 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 956 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
406 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 957 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
407 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 958 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
408 shade term_name title transparent transparent_all tripleclickwords 959 secondaryScreen secondaryScroll selectstyle shade term_name title
960 transient_for transparent transparent_all tripleclickwords utmpInhibit
409 utmpInhibit visualBell</pre> 961 visualBell</pre>
962</dd>
963<p></p>
964<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
965</dt>
966<dd>
967Returns the X-Resource for the given pattern, excluding the program or
968class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
969same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
970resource with that pattern exists.
971</dd>
972<dd>
973<p>This method should only be called during the <code>on_start</code> hook, as there is
974only one resource database per display, and later invocations might return
975the wrong resources.</p>
976</dd>
977<p></p>
978<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
979</dt>
980<dd>
981Adds a keymap translation exactly as specified via a resource. See the
982<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
983</dd>
984<p></p>
985<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
986</dt>
987<dd>
988Return and optionally change the current rendition. Text that is output by
989the terminal application will use this style.
990</dd>
991<p></p>
992<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
993</dt>
994<dd>
995Return the current coordinates of the text cursor position and optionally
996set it (which is usually bad as applications don't expect that).
410</dd> 997</dd>
411<p></p> 998<p></p>
412<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 999<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
413</dt> 1000</dt>
414<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 1001<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
418<dd> 1005<dd>
419Return the current values of the selection mark, begin or end positions, 1006Return the current values of the selection mark, begin or end positions,
420and optionally set them to new values. 1007and optionally set them to new values.
421</dd> 1008</dd>
422<p></p> 1009<p></p>
1010<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1011</dt>
1012<dd>
1013Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1014<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1015rectangular selection will be made. This is the prefered function to make
1016a selection.
1017</dd>
1018<p></p>
423<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1019<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
424</dt> 1020</dt>
425<dd> 1021<dd>
426Try to request the primary selection from the server (for example, as set 1022Try to request the primary selection text from the server (for example, as
427by the next method). 1023set by the next method). No visual feedback will be given. This function
1024is mostly useful from within <code>on_sel_grab</code> hooks.
428</dd> 1025</dd>
429<p></p> 1026<p></p>
430<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1027<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
431</dt> 1028</dt>
432<dd> 1029<dd>
433Return the current selection text and optionally replace it by <code>$newtext</code>. 1030Return the current selection text and optionally replace it by <code>$newtext</code>.
434</dd> 1031</dd>
1032<p></p>
1033<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1034</dt>
435<dd> 1035<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. 1036Create 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> 1037</dd>
464<p></p> 1038<p></p>
465<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 1039<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
466</dt> 1040</dt>
467<dd> 1041<dd>
… …
503</dt> 1077</dt>
504<dd> 1078<dd>
505If hidden, display the overlay again. 1079If hidden, display the overlay again.
506</dd> 1080</dd>
507<p></p></dl> 1081<p></p></dl>
1082<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1083</dt>
1084<dd>
1085Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1086<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1087currently).
1088</dd>
1089<p></p>
508<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 1090<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
509</dt> 1091</dt>
510<dd> 1092<dd>
511Returns the number of screen-cells this string would need. Correctly 1093Returns the number of screen-cells this string would need. Correctly
512accounts for wide and combining characters. 1094accounts for wide and combining characters.
513</dd> 1095</dd>
514<p></p> 1096<p></p>
515<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 1097<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
516</dt> 1098</dt>
517<dd> 1099<dd>
518Convert the given text string into the corresponding locale encoding. 1100Convert the given text string into the corresponding locale encoding.
519</dd> 1101</dd>
520<p></p> 1102<p></p>
521<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 1103<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
522</dt> 1104</dt>
523<dd> 1105<dd>
524Convert the given locale-encoded octets into a perl string. 1106Convert the given locale-encoded octets into a perl string.
1107</dd>
1108<p></p>
1109<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 />
1110</dt>
1111<dd>
1112XORs the rendition values in the given span with the provided value
1113(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1114refresh hooks to provide effects similar to the selection.
1115</dd>
1116<p></p>
1117<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 />
1118</dt>
1119<dd>
1120Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1121whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1122to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1123it instead. Both styles <em>MUST NOT</em> contain font styles.
1124</dd>
1125<p></p>
1126<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1127</dt>
1128<dd>
1129Ring the bell!
1130</dd>
1131<p></p>
1132<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1133</dt>
1134<dd>
1135Write the given text string to the screen, as if output by the application
1136running inside the terminal. It may not contain command sequences (escape
1137codes), but is free to use line feeds, carriage returns and tabs. The
1138string is a normal text string, not in locale-dependent encoding.
1139</dd>
1140<dd>
1141<p>Normally its not a good idea to use this function, as programs might be
1142confused by changes in cursor position or scrolling. Its useful inside a
1143<code>on_add_lines</code> hook, though.</p>
1144</dd>
1145<p></p>
1146<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1147</dt>
1148<dd>
1149Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1150locale-specific encoding of the terminal and can contain command sequences
1151(escape codes) that will be interpreted.
525</dd> 1152</dd>
526<p></p> 1153<p></p>
527<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1154<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
528</dt> 1155</dt>
529<dd> 1156<dd>
530Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1157Write 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 1158pass 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>. 1159to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
533</dd> 1160</dd>
534<p></p> 1161<p></p>
1162<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1163</dt>
1164<dd>
1165Replaces the event mask of the pty watcher by the given event mask. Can
1166be used to suppress input and output handling to the pty/tty. See the
1167description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1168the previous value.
1169</dd>
1170<p></p>
1171<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1172</dt>
1173<dd>
1174Return the window id of the toplevel window.
1175</dd>
1176<p></p>
1177<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1178</dt>
1179<dd>
1180Return the window id of the terminal window.
1181</dd>
1182<p></p>
1183<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1184</dt>
1185<dd>
1186Adds the specified events to the vt event mask. Useful e.g. when you want
1187to receive pointer events all the times:
1188</dd>
1189<dd>
1190<pre>
1191 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1192</dd>
1193<p></p>
1194<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1195</dt>
1196<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1197</dt>
1198<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1199</dt>
1200<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1201</dt>
1202<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1203</dt>
535<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 1204<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
536</dt> 1205</dt>
537<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1206<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
538</dt> 1207</dt>
539<dd> 1208<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
540Return the number of rows/columns of the terminal window (i.e. as 1209</dt>
541specified by <code>-geometry</code>, excluding any scrollback). 1210<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1211</dt>
1212<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1213</dt>
1214<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1215</dt>
1216<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1217</dt>
542</dd> 1218<dd>
1219Return various integers describing terminal characteristics.
1220</dd>
543<p></p> 1221<p></p>
1222<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1223</dt>
1224<dd>
1225Return the DISPLAY used by rxvt-unicode.
1226</dd>
1227<p></p>
1228<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1229</dt>
1230<dd>
1231Returns the LC_CTYPE category string used by this rxvt-unicode.
1232</dd>
1233<p></p>
544<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1234<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
545</dt> 1235</dt>
1236<dd>
1237Returns a copy of the environment in effect for the terminal as a hashref
1238similar to <code>\%ENV</code>.
546<dd> 1239</dd>
547Returns the number of lines in the scrollback buffer. 1240<p></p>
1241<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1242</dt>
1243<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1244</dt>
1245<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1246</dt>
1247<dd>
1248Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1249AltGr), the meta key (often Alt) and the num lock key, if applicable.
548</dd> 1250</dd>
549<p></p> 1251<p></p>
550<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1252<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
551</dt> 1253</dt>
552<dd> 1254<dd>
553Returns the negative row number of the topmost line. Minimum value is 1255Returns the row number of the topmost displayed line. Maximum value is
554<code>0</code>, which displays the normal terminal contents. Larger values scroll 1256<code>0</code>, which displays the normal terminal contents. Lower values scroll
555this many lines into the scrollback buffer. 1257this many lines into the scrollback buffer.
556</dd> 1258</dd>
557<p></p> 1259<p></p>
558<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1260<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
559</dt> 1261</dt>
… …
570</dt> 1272</dt>
571<dd> 1273<dd>
572Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1274Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
573is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1275is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
574terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1276terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
575line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1277line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
576is requested. 1278is requested.
577</dd> 1279</dd>
578<dd> 1280<dd>
579<p>If <code>$new_text</code> is specified, it will replace characters in the current 1281<p>If <code>$new_text</code> is specified, it will replace characters in the current
580line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1282line, 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 1283to replace only parts of a line. The font index in the rendition will
582automatically be updated.</p> 1284automatically be updated.</p>
583</dd> 1285</dd>
584<dd> 1286<dd>
585<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1287<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 1288than one cell when displayed are padded with urxvt::NOCHAR characters
587(<code>chr 65535</code>). Characters with combining characters and other characters 1289(<code>chr 65535</code>). Characters with combining characters and other characters
588that do not fit into the normal tetx encoding will be replaced with 1290that do not fit into the normal tetx encoding will be replaced with
589characters in the private use area.</p> 1291characters in the private use area.</p>
590</dd> 1292</dd>
… …
592<p>You have to obey this encoding when changing text. The advantage is 1294<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 1295that <code>substr</code> and similar functions work on screen cells and not on
594characters.</p> 1296characters.</p>
595</dd> 1297</dd>
596<dd> 1298<dd>
597<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1299<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> 1300can be used to convert normal strings into this encoding and vice versa.</p>
599</dd> 1301</dd>
600<p></p> 1302<p></p>
601<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1303<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
602</dt> 1304</dt>
… …
635Create and return a new <code>urxvt::line</code> object that stores information 1337Create 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 1338about the logical line that row <code>$row_number</code> is part of. It supports the
637following methods: 1339following methods:
638</dd> 1340</dd>
639<dl> 1341<dl>
640<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 1342<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
641</dt> 1343</dt>
642<dd> 1344<dd>
643Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1345Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
644</dd> 1346</dd>
645<p></p> 1347<p></p>
646<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 1348<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
647</dt> 1349</dt>
648<dd> 1350<dd>
649Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1351Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
650</dd> 1352</dd>
651<p></p> 1353<p></p>
652<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1354<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
653</dt> 1355</dt>
654<dd> 1356<dd>
… …
665<p></p> 1367<p></p>
666<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1368<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
667</dt> 1369</dt>
668<dd> 1370<dd>
669Returns the character offset of the given row|col pair within the logical 1371Returns the character offset of the given row|col pair within the logical
670line. 1372line. Works for rows outside the line, too, and returns corresponding
1373offsets outside the string.
671</dd> 1374</dd>
672<p></p> 1375<p></p>
673<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1376<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
674</dt> 1377</dt>
675<dd> 1378<dd>
676Translates a string offset into terminal coordinates again. 1379Translates a string offset into terminal coordinates again.
677</dd> 1380</dd>
678<p></p></dl> 1381<p></p></dl>
679<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1382<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> 1383</dt>
682<dd> 1384<dd>
683Converts a perl string into the special encoding used by rxvt-unicode, 1385Converts a perl string into the special encoding used by rxvt-unicode,
684where one character corresponds to one screen cell. See 1386where one character corresponds to one screen cell. See
685<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1387<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
688<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1390<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
689</dt> 1391</dt>
690<dd> 1392<dd>
691Converts rxvt-unicodes text reprsentation into a perl string. See 1393Converts rxvt-unicodes text reprsentation into a perl string. See
692<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1394<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1395</dd>
1396<p></p>
1397<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1398</dt>
1399<dd>
1400Registers a synchronous button grab. See the XGrabButton manpage.
1401</dd>
1402<p></p>
1403<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1404</dt>
1405<dd>
1406Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1407synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1408</dd>
1409<p></p>
1410<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1411</dt>
1412<dd>
1413Calls XAllowEvents with AsyncBoth for the most recent grab.
1414</dd>
1415<p></p>
1416<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1417</dt>
1418<dd>
1419Calls XAllowEvents with SyncBoth for the most recent grab.
1420</dd>
1421<p></p>
1422<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1423</dt>
1424<dd>
1425Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1426recent grab.
1427</dd>
1428<p></p>
1429<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1430</dt>
1431<dd>
1432Calls XUngrab for the most recent grab. Is called automatically on
1433evaluation errors, as it is better to lose the grab in the error case as
1434the session.
1435</dd>
1436<p></p></dl>
1437<p>
1438</p>
1439<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1440<dl>
1441<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1442</dt>
1443<dd>
1444Adds a non-clickable title to the popup.
1445</dd>
1446<p></p>
1447<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1448</dt>
1449<dd>
1450Creates a separator, optionally using the character given as <code>$sepchr</code>.
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1454</dt>
1455<dd>
1456Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1457selected.
1458</dd>
1459<p></p>
1460<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1461</dt>
1462<dd>
1463Adds a toggle/checkbox item to the popup. Teh callback gets called
1464whenever it gets toggled, with a boolean indicating its value as its first
1465argument.
1466</dd>
1467<p></p>
1468<dt><strong>$popup-&gt;show</strong><br />
1469</dt>
1470<dd>
1471Displays the popup (which is initially hidden).
693</dd> 1472</dd>
694<p></p></dl> 1473<p></p></dl>
695<p> 1474<p>
696</p> 1475</p>
697<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1476<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
750</dt> 1529</dt>
751<dd> 1530<dd>
752Set the event trigger time to <code>$tstamp</code> and start the timer. 1531Set the event trigger time to <code>$tstamp</code> and start the timer.
753</dd> 1532</dd>
754<p></p> 1533<p></p>
1534<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1535</dt>
1536<dd>
1537Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1538</dd>
1539<p></p>
755<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1540<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
756</dt> 1541</dt>
757<dd> 1542<dd>
758Stop the timer. 1543Stop the timer.
759</dd> 1544</dd>
… …
765<pre> 1550<pre>
766 $term-&gt;{socket} = ... 1551 $term-&gt;{socket} = ...
767 $term-&gt;{iow} = urxvt::iow 1552 $term-&gt;{iow} = urxvt::iow
768 -&gt;new 1553 -&gt;new
769 -&gt;fd (fileno $term-&gt;{socket}) 1554 -&gt;fd (fileno $term-&gt;{socket})
770 -&gt;events (1) # wait for read data 1555 -&gt;events (urxvt::EVENT_READ)
771 -&gt;start 1556 -&gt;start
772 -&gt;cb (sub { 1557 -&gt;cb (sub {
773 my ($iow, $revents) = @_; 1558 my ($iow, $revents) = @_;
774 # $revents must be 1 here, no need to check 1559 # $revents must be 1 here, no need to check
775 sysread $term-&gt;{socket}, my $buf, 8192 1560 sysread $term-&gt;{socket}, my $buf, 8192
… …
796</dd> 1581</dd>
797<p></p> 1582<p></p>
798<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1583<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
799</dt> 1584</dt>
800<dd> 1585<dd>
801Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1586Set the event mask to watch. The only allowed values are
802data, Bit #1 (value <code>2</code>) enables watching for write data. 1587<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1588together, or <code>urxvt::EVENT_NONE</code>.
803</dd> 1589</dd>
804<p></p> 1590<p></p>
805<dt><strong>$iow = $iow-&gt;start</strong><br /> 1591<dt><strong>$iow = $iow-&gt;start</strong><br />
806</dt> 1592</dt>
807<dd> 1593<dd>
… …
810<p></p> 1596<p></p>
811<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1597<dt><strong>$iow = $iow-&gt;stop</strong><br />
812</dt> 1598</dt>
813<dd> 1599<dd>
814Stop watching for events on the given filehandle. 1600Stop watching for events on the given filehandle.
1601</dd>
1602<p></p></dl>
1603<p>
1604</p>
1605<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1606<p>This class implements idle watchers, that get called automatically when
1607the process is idle. They should return as fast as possible, after doing
1608some useful work.</p>
1609<dl>
1610<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1611</dt>
1612<dd>
1613Create a new idle watcher object in stopped state.
1614</dd>
1615<p></p>
1616<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1617</dt>
1618<dd>
1619Set the callback to be called when the watcher triggers.
1620</dd>
1621<p></p>
1622<dt><strong>$timer = $timer-&gt;start</strong><br />
1623</dt>
1624<dd>
1625Start the watcher.
1626</dd>
1627<p></p>
1628<dt><strong>$timer = $timer-&gt;stop</strong><br />
1629</dt>
1630<dd>
1631Stop the watcher.
1632</dd>
1633<p></p></dl>
1634<p>
1635</p>
1636<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1637<p>This class implements process watchers. They create an event whenever a
1638process exits, after which they stop automatically.</p>
1639<pre>
1640 my $pid = fork;
1641 ...
1642 $term-&gt;{pw} = urxvt::pw
1643 -&gt;new
1644 -&gt;start ($pid)
1645 -&gt;cb (sub {
1646 my ($pw, $exit_status) = @_;
1647 ...
1648 });</pre>
1649<dl>
1650<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1651</dt>
1652<dd>
1653Create a new process watcher in stopped state.
1654</dd>
1655<p></p>
1656<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1657</dt>
1658<dd>
1659Set the callback to be called when the timer triggers.
1660</dd>
1661<p></p>
1662<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1663</dt>
1664<dd>
1665Tells the wqtcher to start watching for process <code>$pid</code>.
1666</dd>
1667<p></p>
1668<dt><strong>$pw = $pw-&gt;stop</strong><br />
1669</dt>
1670<dd>
1671Stop the watcher.
815</dd> 1672</dd>
816<p></p></dl> 1673<p></p></dl>
817<p> 1674<p>
818</p> 1675</p>
819<hr /> 1676<hr />
… …
821<p> 1678<p>
822</p> 1679</p>
823<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1680<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
824<p>This variable controls the verbosity level of the perl extension. Higher 1681<p>This variable controls the verbosity level of the perl extension. Higher
825numbers indicate more verbose output.</p> 1682numbers indicate more verbose output.</p>
826<ol> 1683<dl>
827<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1684<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
828</li> 1685</dt>
829<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1686<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1687</dt>
1688<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1689</dt>
1690<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1691</dt>
830</li> 1692</dl>
831<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
832</li>
833</ol>
834<p> 1693<p>
835</p> 1694</p>
836<hr /> 1695<hr />
837<h1><a name="author">AUTHOR</a></h1> 1696<h1><a name="author">AUTHOR</a></h1>
838<pre> 1697<pre>

Diff Legend

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