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.4 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.36 by root, Sat Jan 21 19:50:53 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="#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>
21 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
22 <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>
27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
23 <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>
24 <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>
25 <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>
26 </ul> 35 </ul>
27 36
28 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
29 <ul> 38 <ul>
30 39
… …
36<!-- INDEX END --> 45<!-- INDEX END -->
37 46
38<hr /> 47<hr />
39<p> 48<p>
40</p> 49</p>
50<hr />
41<h1><a name="name">NAME</a></h1> 51<h1><a name="name">NAME</a></h1>
42<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
43<p> 53<p>
44</p> 54</p>
45<hr /> 55<hr />
46<h1><a name="synopsis">SYNOPSIS</a></h1> 56<h1><a name="synopsis">SYNOPSIS</a></h1>
47<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 57<pre>
48<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and 58 # create a file grab_test in $HOME:</pre>
49thus must be encoded as UTF-8.</p>
50<pre> 59<pre>
51 sub on_sel_grab { 60 sub on_sel_grab {
52 warn &quot;you selected &quot;, $_[0]-&gt;selection; 61 warn &quot;you selected &quot;, $_[0]-&gt;selection;
53 () 62 ()
54 }</pre> 63 }</pre>
55<pre> 64<pre>
56 1</pre> 65 # start a rxvt using it:</pre>
66<pre>
67 rxvt --perl-lib $HOME -pe grab_test</pre>
57<p> 68<p>
58</p> 69</p>
59<hr /> 70<hr />
60<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
61<p>Everytime a terminal object gets created, scripts specified via the 72<p>Everytime a terminal object gets created, extension scripts specified via
62<code>perl</code> resource are associated with it.</p> 73the <code>perl</code> resource are loaded and associated with it.</p>
74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
75thus must be encoded as UTF-8.</p>
63<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
64scripts will be shared (But not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
78<p>
79</p>
80<hr />
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
82<p>This section describes the extensions delivered with this release. You can
83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
84<p>You can activate them like this:</p>
85<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>
90<dl>
91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
92</dt>
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>.
99</dd>
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>
131</dd>
132<dl>
133<dt><strong><a name="item_rot13">rot13</a></strong><br />
134</dt>
135<dd>
136Rot-13 the selection when activated. Used via keyboard trigger:
137</dd>
138<dd>
139<pre>
140 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
141</dd>
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
155evaluation, 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_readline">readline (enabled by default)</a></strong><br />
201</dt>
202<dd>
203A support package that tries to make editing with readline easier. At the
204moment, it reacts to clicking with the left mouse button by trying to
205move the text cursor to this position. It does so by generating as many
206cursor-left or cursor-right keypresses as required (the this only works
207for programs that correctly support wide characters).
208</dd>
209<dd>
210<p>To avoid too many false positives, this is only done when:</p>
211</dd>
212<dl>
213<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
214</dt>
215<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
216</dt>
217<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
218</dt>
219</dl>
220<p>The normal selection mechanism isn't disabled, so quick successive clicks
221might interfere with selection creation in harmless ways.</p>
222<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
223</dt>
224<dd>
225This selection allows you to do automatic transforms on a selection
226whenever a selection is made.
227</dd>
228<dd>
229<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
230operator) that modify <code>$_</code> as resources:</p>
231</dd>
232<dd>
233<pre>
234 URxvt.selection-autotransform.0: transform
235 URxvt.selection-autotransform.1: transform
236 ...</pre>
237</dd>
238<dd>
239<p>For example, the following will transform selections of the form
240<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
241$word</code>:</p>
242</dd>
243<dd>
244<pre>
245 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
246</dd>
247<dd>
248<p>And this example matches the same,but replaces it with vi-commands you can
249paste directly into your (vi :) editor:</p>
250</dd>
251<dd>
252<pre>
253 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
254</dd>
255<dd>
256<p>Of course, this can be modified to suit your needs and your editor :)</p>
257</dd>
258<dd>
259<p>To expand the example above to typical perl error messages (``XXX at
260FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
261</dd>
262<dd>
263<pre>
264 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
265 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
266</dd>
267<dd>
268<p>The first line tells the selection code to treat the unchanging part of
269every error message as a selection pattern, and the second line transforms
270the message into vi commands to load the file.</p>
271</dd>
272<p></p>
273<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
274</dt>
275<dd>
276This transforms the terminal into a tabbar with additional terminals, that
277is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
278displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
279button per tab.
280</dd>
281<dd>
282<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
283<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
284while <strong>Shift-Down</strong> creates a new tab.</p>
285</dd>
286<p></p>
287<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
288</dt>
289<dd>
290Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
291make them clickable. When middle-clicked, the program specified in the
292resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
293the URL as first argument.
294</dd>
295<p></p>
296<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
297</dt>
298<dd>
299This is basically a one-line extension that dynamically changes the background pixmap offset
300to the window position, in effect creating the same effect as pseudo transparency with
301a custom pixmap. No scaling is supported in this mode. Exmaple:
302</dd>
303<dd>
304<pre>
305 rxvt -pixmap background.xpm -pe automove-background</pre>
306</dd>
307<p></p>
308<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
309</dt>
310<dd>
311A not very useful example of filtering all text output to the terminal,
312by replacing all line-drawing characters (U+2500 .. U+259F) by a
313similar-looking ascii character.
314</dd>
315<p></p>
316<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
317</dt>
318<dd>
319Displays a digital clock using the built-in overlay.
320</dd>
321<p></p>
322<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
323</dt>
324<dd>
325Displays a very simple digital clock in the upper right corner of the
326window. Illustrates overwriting the refresh callbacks to create your own
327overlays or changes.
328</dd>
329<p></p>
330<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
331</dt>
332<dd>
333This is a little rarely useful extension that Uploads the selection as
334textfile to a remote site (or does other things). (The implementation is
335not currently secure for use in a multiuser environment as it writes to
336<em>/tmp</em> directly.).
337</dd>
338<dd>
339<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
340i.e.</p>
341</dd>
342<dd>
343<pre>
344 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
345</dd>
346<dd>
347<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
348the textfile. This command can be set via a resource:</p>
349</dd>
350<dd>
351<pre>
352 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
353</dd>
354<dd>
355<p>And the default is likely not useful to anybody but the few people around
356here :)</p>
357</dd>
358<dd>
359<p>The name of the textfile is the hex encoded md5 sum of the selection, so
360the same content should lead to the same filename.</p>
361</dd>
362<dd>
363<p>After a successful upload the selection will be replaced by the text given
364in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
365for the filename):</p>
366</dd>
367<dd>
368<pre>
369 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
370</dd>
371<p></p></dl>
372<p>
373</p>
374<hr />
375<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
65<p> 376<p>
66</p> 377</p>
67<h2><a name="general_api_considerations">General API Considerations</a></h2> 378<h2><a name="general_api_considerations">General API Considerations</a></h2>
68<p>All objects (such as terminals, time watchers etc.) are typical 379<p>All objects (such as terminals, time watchers etc.) are typical
69reference-to-hash objects. The hash can be used to store anything you 380reference-to-hash objects. The hash can be used to store anything you
70like. All members starting with an underscore (such as <code>_ptr</code> or 381like. All members starting with an underscore (such as <code>_ptr</code> or
71<code>_hook</code>) are reserved for internal uses and must not be accessed or 382<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
72modified).</p> 383modified).</p>
73<p>When objects are destroyed on the C++ side, the perl object hashes are 384<p>When objects are destroyed on the C++ side, the perl object hashes are
74emptied, so its best to store related objects such as time watchers and 385emptied, so its best to store related objects such as time watchers and
75the like inside the terminal object so they get destroyed as soon as the 386the like inside the terminal object so they get destroyed as soon as the
76terminal is destroyed.</p> 387terminal is destroyed.</p>
388<p>Argument names also often indicate the type of a parameter. Here are some
389hints on what they mean:</p>
390<dl>
391<dt><strong><a name="item__24text">$text</a></strong><br />
392</dt>
393<dd>
394Rxvt-unicodes special way of encoding text, where one ``unicode'' character
395always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
396</dd>
397<p></p>
398<dt><strong><a name="item__24string">$string</a></strong><br />
399</dt>
400<dd>
401A perl text string, with an emphasis on <em>text</em>. It can store all unicode
402characters and is to be distinguished with text encoded in a specific
403encoding (often locale-specific) and binary data.
404</dd>
405<p></p>
406<dt><strong><a name="item__24octets">$octets</a></strong><br />
407</dt>
408<dd>
409Either binary data or - more common - a text string encoded in a
410locale-specific way.
411</dd>
412<p></p></dl>
413<p>
414</p>
415<h2><a name="extension_objects">Extension Objects</a></h2>
416<p>Very perl extension is a perl class. A separate perl object is created
417for each terminal and each extension and passed as the first parameter to
418hooks. So extensions can use their <code>$self</code> object without having to think
419about other extensions, with the exception of methods and members that
420begin with an underscore character <code>_</code>: these are reserved for internal
421use.</p>
422<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
423<code>urxvt::term</code> class on this object.</p>
424<p>It has the following methods and data members:</p>
425<dl>
426<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
427</dt>
428<dd>
429Returns the <code>urxvt::term</code> object associated with this instance of the
430extension. This member <em>must not</em> be changed in any way.
431</dd>
432<p></p>
433<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
434</dt>
435<dd>
436Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
437this extension, replacing any previous hook. This is useful when you want
438to overwrite time-critical hooks only temporarily.
439</dd>
440<p></p>
441<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
442</dt>
443<dd>
444Dynamically disable the given hooks.
445</dd>
446<p></p></dl>
77<p> 447<p>
78</p> 448</p>
79<h2><a name="hooks">Hooks</a></h2> 449<h2><a name="hooks">Hooks</a></h2>
80<p>The following subroutines can be declared in loaded scripts, and will be called 450<p>The following subroutines can be declared in extension files, and will be
81whenever the relevant event happens.</p> 451called whenever the relevant event happens.</p>
82<p>All of them must return a boolean value. If it is true, then the event 452<p>The first argument passed to them is an extension oject as described in
83counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 453the in the <code>Extension Objects</code> section.</p>
454<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
455hooks returns true, then the event counts as being <em>consumed</em>, and the
84and the relevant action might not be carried out by the C++ code.</p> 456relevant action might not be carried out by the C++ code.</p>
85<p>When in doubt, return a false value (preferably <code>()</code>).</p> 457<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
86<dl> 458<dl>
87<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 459<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
88</dt> 460</dt>
89<dd> 461<dd>
90Called after a new terminal object has been initialized, but before 462Called after a new terminal object has been initialized, but before
91windows are created or the command gets run. 463windows are created or the command gets run. Most methods are unsafe to
464call or deliver senseless data, as terminal size and other characteristics
465have not yet been determined. You can safely query and change resources
466and options, though. For many purposes the <code>on_start</code> hook is a better
467place.
468</dd>
469<p></p>
470<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
471</dt>
472<dd>
473Called at the very end of initialisation of a new terminal, just before
474trying to map (display) the toplevel and returning to the mainloop.
475</dd>
476<p></p>
477<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
478</dt>
479<dd>
480Called whenever something tries to destroy terminal, before doing anything
481yet. If this hook returns true, then destruction is skipped, but this is
482rarely a good idea.
92</dd> 483</dd>
93<p></p> 484<p></p>
94<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 485<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
95</dt> 486</dt>
96<dd> 487<dd>
97Called after the screen is ``reset'' for any reason, such as resizing or 488Called after the screen is ``reset'' for any reason, such as resizing or
98control sequences. Here is where you can react on changes to size-related 489control sequences. Here is where you can react on changes to size-related
99variables. 490variables.
100</dd> 491</dd>
101<p></p> 492<p></p>
102<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 493<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
103</dt> 494</dt>
495<dd>
496Called just after the child process has been <code>fork</code>ed.
104<dd> 497</dd>
105Called at the very end of initialisation of a new terminal, just before 498<p></p>
106returning to the mainloop. 499<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
500</dt>
501<dd>
502Called just after the child process has exited. <code>$status</code> is the status
503from <code>waitpid</code>.
107</dd> 504</dd>
108<p></p> 505<p></p>
109<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 506<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
110</dt> 507</dt>
111<dd> 508<dd>
… …
127</dd> 524</dd>
128<dd> 525<dd>
129<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 526<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
130</dd> 527</dd>
131<p></p> 528<p></p>
132<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 529<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
133</dt> 530</dt>
134<dd>
135Called whenever the window gets the keyboard focus, before urxvt does
136focus in processing.
137</dd> 531<dd>
138<p></p> 532Called whenever the user tries to extend the selection (e.g. with a double
139<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 533click) and is either supposed to return false (normal operation), or
140</dt> 534should extend the selection itelf and return true to suppress the built-in
535processing. This can happen multiple times, as long as the callback
536returns true, it will be called on every further click by the user and is
537supposed to enlarge the selection more and more, if possible.
141<dd> 538</dd>
142Called wheneever the window loses keyboard focus, before urxvt does focus 539<dd>
143out processing. 540<p>See the <em>selection</em> example extension.</p>
144</dd> 541</dd>
145<p></p> 542<p></p>
146<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 543<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
147</dt> 544</dt>
148<dd> 545<dd>
… …
162<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 559<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
163$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 560$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
164number of lines that will be in the scrollback buffer.</p> 561number of lines that will be in the scrollback buffer.</p>
165</dd> 562</dd>
166<p></p> 563<p></p>
167<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 564<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
168</dt> 565</dt>
566<dd>
567Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
568operating system command) is processed. Cursor position and other state
569information is up-to-date when this happens. For interoperability, the
570string should start with the extension name and a colon, to distinguish
571it from commands for other extensions, and this might be enforced in the
572future.
169<dd> 573</dd>
170Called whenever the <code>program(s)</code> running in the urxvt window send output. 574<dd>
575<p>Be careful not ever to trust (in a security sense) the data you receive,
576as its source can not easily be controleld (e-mail content, messages from
577other users on the same system etc.).</p>
578</dd>
579<p></p>
580<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
581</dt>
582<dd>
583Called whenever text is about to be output, with the text as argument. You
584can filter/change and output the text yourself by returning a true value
585and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
586might be very slow, however, as your hook is called for <strong>all</strong> text being
587output.
588</dd>
589<p></p>
590<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
591</dt>
592<dd>
593Called whenever some data is written to the tty/pty and can be used to
594suppress or filter tty input.
595</dd>
596<p></p>
597<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
598</dt>
599<dd>
600Called whenever a line was updated or changed. Can be used to filter
601screen output (e.g. underline urls or other useless stuff). Only lines
602that are being shown will be filtered, and, due to performance reasons,
603not always immediately.
604</dd>
605<dd>
606<p>The row number is always the topmost row of the line if the line spans
607multiple rows.</p>
608</dd>
609<dd>
610<p>Please note that, if you change the line, then the hook might get called
611later with the already-modified line (e.g. if unrelated parts change), so
612you cannot just toggle rendition bits, but only set them.</p>
171</dd> 613</dd>
172<p></p> 614<p></p>
173<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 615<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
174</dt> 616</dt>
175<dd> 617<dd>
… …
182<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 624<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
183</dt> 625</dt>
184<dd> 626<dd>
185Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 627Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
186</dd> 628</dd>
629<p></p>
630<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
631</dt>
632<dd>
633Called whenever the user presses a key combination that has a
634<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
635resource in the <code>rxvt(1)</code> manpage).
636</dd>
637<p></p>
638<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
639</dt>
640<dd>
641Called on every X event received on the vt window (and possibly other
642windows). Should only be used as a last resort. Most event structure
643members are not passed.
644</dd>
645<p></p>
646<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
647</dt>
648<dd>
649Called whenever the window gets the keyboard focus, before rxvt-unicode
650does focus in processing.
651</dd>
652<p></p>
653<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
654</dt>
655<dd>
656Called wheneever the window loses keyboard focus, before rxvt-unicode does
657focus out processing.
658</dd>
659<p></p>
660<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
661</dt>
662<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
663</dt>
664<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
665</dt>
666<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
667</dt>
668<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
669</dt>
670<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
671</dt>
672<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
673</dt>
674<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
675</dt>
676<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
677</dt>
678<dd>
679Called whenever the corresponding X event is received for the terminal If
680the hook returns true, then the even will be ignored by rxvt-unicode.
681</dd>
682<dd>
683<p>The event is a hash with most values as named by Xlib (see the XEvent
684manpage), with the additional members <code>row</code> and <code>col</code>, which are the
685(real, not screen-based) row and column under the mouse cursor.</p>
686</dd>
687<dd>
688<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
689output, if any, in locale-specific encoding.</p>
690</dd>
691<dd>
692<p>subwindow.</p>
693</dd>
694<p></p>
695<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
696</dt>
697<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
698</dt>
699<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
700</dt>
701<dd>
702Called when various types of ClientMessage events are received (all with
703format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
704</dd>
705<p></p></dl>
706<p>
707</p>
708<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
709<dl>
710<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
711</dt>
712<dd>
713The rxvt-unicode library directory, where, among other things, the perl
714modules and scripts are stored.
715</dd>
716<p></p>
717<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
718</dt>
719<dd>
720The resource class and name rxvt-unicode uses to look up X resources.
721</dd>
722<p></p>
723<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
724</dt>
725<dd>
726The basename of the installed binaries, usually <code>urxvt</code>.
727</dd>
728<p></p>
729<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
730</dt>
731<dd>
732The current terminal. This variable stores the current <code>urxvt::term</code>
733object, whenever a callback/hook is executing.
734</dd>
735<p></p>
736<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
737</dt>
738<dd>
739All coderefs in this array will be called as methods of the next newly
740created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
741gets cleared before the codereferences that were in it are being executed,
742so coderefs can push themselves onto it again if they so desire.
743</dd>
744<dd>
745<p>This complements to the perl-eval commandline option, but gets executed
746first.</p>
747</dd>
748<p></p>
749<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
750</dt>
751<dd>
752Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
753get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
754but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
755</dd>
187<p></p></dl> 756<p></p></dl>
188<p> 757<p>
189</p> 758</p>
190<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 759<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
191<dl> 760<dl>
… …
206</dd> 775</dd>
207<dd> 776<dd>
208<p>Using this function has the advantage that its output ends up in the 777<p>Using this function has the advantage that its output ends up in the
209correct place, e.g. on stderr of the connecting urxvtc client.</p> 778correct place, e.g. on stderr of the connecting urxvtc client.</p>
210</dd> 779</dd>
780<dd>
781<p>Messages have a size limit of 1023 bytes currently.</p>
782</dd>
211<p></p> 783<p></p>
212<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 784<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
213</dt> 785</dt>
214<dd> 786<dd>
215Returns the ``current time'' (as per the event loop). 787Returns the ``current time'' (as per the event loop).
216</dd> 788</dd>
789<p></p>
790<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
791</dt>
792<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
793Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
794Button4Mask, Button5Mask, AnyModifier</a></strong><br />
795</dt>
796<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
797ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
798PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
799Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
800KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
801ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
802FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
803</dt>
804<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
805EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
806GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
807UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
808ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
809CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
810SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
811</dt>
812<dd>
813Various constants for use in X calls and event processing.
814</dd>
217<p></p></dl> 815<p></p></dl>
816<p>
817</p>
818<h2><a name="rendition">RENDITION</a></h2>
819<p>Rendition bitsets contain information about colour, font, font styles and
820similar information for each screen cell.</p>
821<p>The following ``macros'' deal with changes in rendition sets. You should
822never just create a bitset, you should always modify an existing one,
823as they contain important information required for correct operation of
824rxvt-unicode.</p>
825<dl>
826<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
827</dt>
828<dd>
829Returns the default rendition, as used when the terminal is starting up or
830being reset. Useful as a base to start when creating renditions.
831</dd>
832<p></p>
833<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
834</dt>
835<dd>
836Return the rendition mask used for overlays by default.
837</dd>
838<p></p>
839<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
840</dt>
841<dd>
842Return the bit that enabled bold, italic, blink, reverse-video and
843underline, respectively. To enable such a style, just logically OR it into
844the bitset.
845</dd>
846<p></p>
847<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
848</dt>
849<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
850</dt>
851<dd>
852Return the foreground/background colour index, respectively.
853</dd>
854<p></p>
855<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
856</dt>
857<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
858</dt>
859<dd>
860Replace the foreground/background colour in the rendition mask with the
861specified one.
862</dd>
863<p></p>
864<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
865</dt>
866<dd>
867Return the ``custom'' value: Every rendition has 5 bits for use by
868extensions. They can be set and changed as you like and are initially
869zero.
870</dd>
871<p></p>
872<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
873</dt>
874<dd>
875Change the custom value.
876</dd>
877<p></p></dl>
878<p>
879</p>
880<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
881<p>The sole purpose of this class is to deliver an interface to the
882<code>AnyEvent</code> module - any module using it will work inside urxvt without
883further programming. The only exception is that you cannot wait on
884condition variables, but non-blocking condvar use is ok. What this means
885is that you cannot use blocking APIs, but the non-blocking variant should
886work.</p>
218<p> 887<p>
219</p> 888</p>
220<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 889<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
221<dl> 890<dl>
891<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
892</dt>
893<dd>
894Creates a new terminal, very similar as if you had started it with system
895<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
896hash which defines the environment of the new terminal.
897</dd>
898<dd>
899<p>Croaks (and probably outputs an error message) if the new instance
900couldn't be created. Returns <code>undef</code> if the new instance didn't
901initialise perl, and the terminal object otherwise. The <code>init</code> and
902<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
903</dd>
904<p></p>
905<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
906</dt>
907<dd>
908Destroy the terminal object (close the window, free resources
909etc.). Please note that rxvt will not exit as long as any event
910watchers (timers, io watchers) are still active.
911</dd>
912<p></p>
913<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
914</dt>
915<dd>
916Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
917(``starts'') programs in the background. This function takes care of setting
918the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
919be preferred over explicit calls to <code>exec</code> or <code>system</code>.
920</dd>
921<dd>
922<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
923</dd>
924<p></p>
925<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
926</dt>
927<dd>
928Returns true if the option specified by <code>$optval</code> is enabled, and
929optionally change it. All option values are stored by name in the hash
930<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
931</dd>
932<dd>
933<p>Here is a a likely non-exhaustive list of option names, please see the
934source file <em>/src/optinc.h</em> to see the actual list:</p>
935</dd>
936<dd>
937<pre>
938 borderLess console cursorBlink cursorUnderline hold iconic insecure
939 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
940 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
941 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
942 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
943 transparent tripleclickwords utmpInhibit visualBell</pre>
944</dd>
945<p></p>
222<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 946<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
223</dt> 947</dt>
224<dd> 948<dd>
225Returns the current resource value associated with a given name and 949Returns the current resource value associated with a given name and
226optionally sets a new value. Setting values is most useful in the <code>init</code> 950optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
240<p>Please note that resource strings will currently only be freed when the 964<p>Please note that resource strings will currently only be freed when the
241terminal is destroyed, so changing options frequently will eat memory.</p> 965terminal is destroyed, so changing options frequently will eat memory.</p>
242</dd> 966</dd>
243<dd> 967<dd>
244<p>Here is a a likely non-exhaustive list of resource names, not all of which 968<p>Here is a a likely non-exhaustive list of resource names, not all of which
245are supported in every build, please see the source to see the actual 969are supported in every build, please see the source file <em>/src/rsinc.h</em>
246list:</p> 970to see the actual list:</p>
247</dd> 971</dd>
248<dd> 972<dd>
249<pre> 973<pre>
250 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 974 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
251 borderLess color cursorBlink cursorUnderline cutchars delete_key 975 borderLess color cursorBlink cursorUnderline cutchars delete_key
252 display_name embed ext_bwidth fade font geometry hold iconName 976 display_name embed ext_bwidth fade font geometry hold iconName
253 imFont imLocale inputMethod insecure int_bwidth intensityStyles 977 imFont imLocale inputMethod insecure int_bwidth intensityStyles
254 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 978 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
255 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 979 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
256 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 980 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
257 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 981 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
258 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 982 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
259 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 983 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
260 shade term_name title transparent transparent_all tripleclickwords 984 secondaryScreen secondaryScroll selectstyle shade term_name title
985 transient_for transparent transparent_all tripleclickwords utmpInhibit
261 utmpInhibit visualBell</pre> 986 visualBell</pre>
987</dd>
988<p></p>
989<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
990</dt>
991<dd>
992Returns the X-Resource for the given pattern, excluding the program or
993class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
994same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
995resource with that pattern exists.
996</dd>
997<dd>
998<p>This method should only be called during the <code>on_start</code> hook, as there is
999only one resource database per display, and later invocations might return
1000the wrong resources.</p>
1001</dd>
1002<p></p>
1003<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1004</dt>
1005<dd>
1006Adds a keymap translation exactly as specified via a resource. See the
1007<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
1008</dd>
1009<p></p>
1010<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1011</dt>
1012<dd>
1013Return and optionally change the current rendition. Text that is output by
1014the terminal application will use this style.
1015</dd>
1016<p></p>
1017<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1018</dt>
1019<dd>
1020Return the current coordinates of the text cursor position and optionally
1021set it (which is usually bad as applications don't expect that).
262</dd> 1022</dd>
263<p></p> 1023<p></p>
264<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1024<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
265</dt> 1025</dt>
266<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 1026<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
270<dd> 1030<dd>
271Return the current values of the selection mark, begin or end positions, 1031Return the current values of the selection mark, begin or end positions,
272and optionally set them to new values. 1032and optionally set them to new values.
273</dd> 1033</dd>
274<p></p> 1034<p></p>
1035<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1036</dt>
1037<dd>
1038Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1039<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1040rectangular selection will be made. This is the prefered function to make
1041a selection.
1042</dd>
1043<p></p>
275<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1044<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
276</dt> 1045</dt>
277<dd> 1046<dd>
278Try to request the primary selection from the server (for example, as set 1047Try to request the primary selection text from the server (for example, as
279by the next method). 1048set by the next method). No visual feedback will be given. This function
1049is mostly useful from within <code>on_sel_grab</code> hooks.
280</dd> 1050</dd>
281<p></p> 1051<p></p>
282<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br /> 1052<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
283</dt> 1053</dt>
284<dd> 1054<dd>
285Return the current selection text and optionally replace it by <code>$newtext</code>. 1055Return the current selection text and optionally replace it by <code>$newtext</code>.
286</dd> 1056</dd>
287<p></p> 1057<p></p>
288<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 1058<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
289</dt> 1059</dt>
290<dd> 1060<dd>
291Create a simple multi-line overlay box. See the next method for details. 1061Create a simple multi-line overlay box. See the next method for details.
292</dd> 1062</dd>
293<p></p> 1063<p></p>
294<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 1064<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
295</dt> 1065</dt>
296<dd> 1066<dd>
297Create a new (empty) overlay at the given position with the given 1067Create a new (empty) overlay at the given position with the given
298width/height. A border will be put around the box. If either <code>$x</code> or 1068width/height. <code>$rstyle</code> defines the initial rendition style
299<code>$y</code> is negative, then this is counted from the right/bottom side, 1069(default: <code>OVERLAY_RSTYLE</code>).
300respectively.
301</dd>
302<p></p>
303<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
304</dt>
305<dd> 1070</dd>
306Switch the overlay off again.
307</dd> 1071<dd>
308<p></p> 1072<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
309<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> 1073around the box.</p>
310</dt>
311<dd> 1074</dd>
312Put a single character (specified numerically) at the given overlay
313position.
314</dd> 1075<dd>
315<p></p> 1076<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
316<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br /> 1077right/bottom side, respectively.</p>
317</dt>
318<dd> 1078</dd>
319Write a string at the given position into the overlay.
320</dd> 1079<dd>
1080<p>This method returns an urxvt::overlay object. The overlay will be visible
1081as long as the perl object is referenced.</p>
1082</dd>
1083<dd>
1084<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
1085</dd>
1086<dl>
1087<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
1088</dt>
1089<dd>
1090Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
1091text in rxvt-unicode's special encoding and an array of rendition values
1092at a specific position inside the overlay.
1093</dd>
321<p></p> 1094<p></p>
1095<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
1096</dt>
1097<dd>
1098If visible, hide the overlay, but do not destroy it.
1099</dd>
1100<p></p>
1101<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
1102</dt>
1103<dd>
1104If hidden, display the overlay again.
1105</dd>
1106<p></p></dl>
1107<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1108</dt>
1109<dd>
1110Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1111<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1112currently).
1113</dd>
1114<p></p>
322<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 1115<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
323</dt> 1116</dt>
324<dd> 1117<dd>
325Returns the number of screen-cells this string would need. Correctly 1118Returns the number of screen-cells this string would need. Correctly
326accounts for wide and combining characters. 1119accounts for wide and combining characters.
327</dd> 1120</dd>
328<p></p> 1121<p></p>
329<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 1122<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
330</dt> 1123</dt>
331<dd> 1124<dd>
332Convert the given text string into the corresponding locale encoding. 1125Convert the given text string into the corresponding locale encoding.
333</dd> 1126</dd>
334<p></p> 1127<p></p>
335<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 1128<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
336</dt> 1129</dt>
337<dd> 1130<dd>
338Convert the given locale-encoded octets into a perl string. 1131Convert the given locale-encoded octets into a perl string.
339</dd> 1132</dd>
340<p></p> 1133<p></p>
1134<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 />
1135</dt>
1136<dd>
1137XORs the rendition values in the given span with the provided value
1138(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1139refresh hooks to provide effects similar to the selection.
1140</dd>
1141<p></p>
1142<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 />
1143</dt>
1144<dd>
1145Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1146whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1147to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1148it instead. Both styles <em>MUST NOT</em> contain font styles.
1149</dd>
1150<p></p>
1151<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1152</dt>
1153<dd>
1154Ring the bell!
1155</dd>
1156<p></p>
1157<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1158</dt>
1159<dd>
1160Write the given text string to the screen, as if output by the application
1161running inside the terminal. It may not contain command sequences (escape
1162codes), but is free to use line feeds, carriage returns and tabs. The
1163string is a normal text string, not in locale-dependent encoding.
1164</dd>
1165<dd>
1166<p>Normally its not a good idea to use this function, as programs might be
1167confused by changes in cursor position or scrolling. Its useful inside a
1168<code>on_add_lines</code> hook, though.</p>
1169</dd>
1170<p></p>
1171<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1172</dt>
1173<dd>
1174Switch to given screen - 0 primary, 1 secondary.
1175</dd>
1176<p></p>
1177<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1178</dt>
1179<dd>
1180Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1181locale-specific encoding of the terminal and can contain command sequences
1182(escape codes) that will be interpreted.
1183</dd>
1184<p></p>
341<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1185<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
342</dt> 1186</dt>
343<dd> 1187<dd>
344Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1188Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
345pass characters instead of octets, you should convetr you strings first to 1189pass characters instead of octets, you should convert your strings first
346the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1190to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
1191</dd>
1192<p></p>
1193<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1194</dt>
1195<dd>
1196Replaces the event mask of the pty watcher by the given event mask. Can
1197be used to suppress input and output handling to the pty/tty. See the
1198description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1199the previous value.
1200</dd>
1201<p></p>
1202<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1203</dt>
1204<dd>
1205Return the window id of the toplevel window.
1206</dd>
1207<p></p>
1208<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1209</dt>
1210<dd>
1211Return the window id of the terminal window.
1212</dd>
1213<p></p>
1214<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1215</dt>
1216<dd>
1217Adds the specified events to the vt event mask. Useful e.g. when you want
1218to receive pointer events all the times:
1219</dd>
1220<dd>
1221<pre>
1222 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1223</dd>
1224<p></p>
1225<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1226</dt>
1227<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1228</dt>
1229<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1230</dt>
1231<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1232</dt>
1233<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1234</dt>
1235<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
1236</dt>
1237<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
1238</dt>
1239<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1240</dt>
1241<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1242</dt>
1243<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1244</dt>
1245<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1246</dt>
1247<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1248</dt>
1249<dd>
1250Return various integers describing terminal characteristics.
1251</dd>
1252<p></p>
1253<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1254</dt>
1255<dd>
1256Return the DISPLAY used by rxvt-unicode.
1257</dd>
1258<p></p>
1259<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1260</dt>
1261<dd>
1262Returns the LC_CTYPE category string used by this rxvt-unicode.
1263</dd>
1264<p></p>
1265<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1266</dt>
1267<dd>
1268Returns a copy of the environment in effect for the terminal as a hashref
1269similar to <code>\%ENV</code>.
1270</dd>
1271<p></p>
1272<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1273</dt>
1274<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1275</dt>
1276<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1277</dt>
1278<dd>
1279Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1280AltGr), the meta key (often Alt) and the num lock key, if applicable.
1281</dd>
1282<p></p>
1283<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1284</dt>
1285<dd>
1286Returns the currently displayed screen (0 primary, 1 secondary).
1287</dd>
1288<p></p>
1289<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1290</dt>
1291<dd>
1292Returns wether the cursor is currently hidden or not.
1293</dd>
1294<p></p>
1295<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1296</dt>
1297<dd>
1298Returns the row number of the topmost displayed line. Maximum value is
1299<code>0</code>, which displays the normal terminal contents. Lower values scroll
1300this many lines into the scrollback buffer.
1301</dd>
1302<p></p>
1303<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1304</dt>
1305<dd>
1306Requests a screen refresh. At the next opportunity, rxvt-unicode will
1307compare the on-screen display with its stored representation. If they
1308differ, it redraws the differences.
1309</dd>
1310<dd>
1311<p>Used after changing terminal contents to display them.</p>
1312</dd>
1313<p></p>
1314<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1315</dt>
1316<dd>
1317Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1318is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1319terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1320line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1321is requested.
1322</dd>
1323<dd>
1324<p>If <code>$new_text</code> is specified, it will replace characters in the current
1325line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1326to replace only parts of a line. The font index in the rendition will
1327automatically be updated.</p>
1328</dd>
1329<dd>
1330<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use
1331more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code>
1332characters. Characters with combining characters and other characters that
1333do not fit into the normal tetx encoding will be replaced with characters
1334in the private use area.</p>
1335</dd>
1336<dd>
1337<p>You have to obey this encoding when changing text. The advantage is
1338that <code>substr</code> and similar functions work on screen cells and not on
1339characters.</p>
1340</dd>
1341<dd>
1342<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>
1343can be used to convert normal strings into this encoding and vice versa.</p>
1344</dd>
1345<p></p>
1346<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1347</dt>
1348<dd>
1349Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1350bitsets. Rendition bitsets contain information about colour, font, font
1351styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1352</dd>
1353<dd>
1354<p>When setting rendition, the font mask will be ignored.</p>
1355</dd>
1356<dd>
1357<p>See the section on RENDITION, above.</p>
1358</dd>
1359<p></p>
1360<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1361</dt>
1362<dd>
1363Returns the number of screen cells that are in use (``the line
1364length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1365line is joined with the following one.
1366</dd>
1367<p></p>
1368<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1369</dt>
1370<dd>
1371Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1372joined with the following row), which means all characters are in use
1373and it is continued on the next row (and possibly a continuation of the
1374previous row(s)).
1375</dd>
1376<p></p>
1377<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1378</dt>
1379<dd>
1380Create and return a new <code>urxvt::line</code> object that stores information
1381about the logical line that row <code>$row_number</code> is part of. It supports the
1382following methods:
1383</dd>
1384<dl>
1385<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1386</dt>
1387<dd>
1388Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1389</dd>
1390<p></p>
1391<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1392</dt>
1393<dd>
1394Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1395</dd>
1396<p></p>
1397<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1398</dt>
1399<dd>
1400Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1401</dd>
1402<p></p>
1403<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1404</dt>
1405<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1406</dt>
1407<dd>
1408Return the row number of the first/last row of the line, respectively.
1409</dd>
1410<p></p>
1411<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1412</dt>
1413<dd>
1414Returns the character offset of the given row|col pair within the logical
1415line. Works for rows outside the line, too, and returns corresponding
1416offsets outside the string.
1417</dd>
1418<p></p>
1419<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1420</dt>
1421<dd>
1422Translates a string offset into terminal coordinates again.
1423</dd>
1424<p></p></dl>
1425<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1426</dt>
1427<dd>
1428Converts a perl string into the special encoding used by rxvt-unicode,
1429where one character corresponds to one screen cell. See
1430<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1431</dd>
1432<p></p>
1433<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1434</dt>
1435<dd>
1436Converts rxvt-unicodes text reprsentation into a perl string. See
1437<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1438</dd>
1439<p></p>
1440<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1441</dt>
1442<dd>
1443Registers a synchronous button grab. See the XGrabButton manpage.
1444</dd>
1445<p></p>
1446<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1447</dt>
1448<dd>
1449Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1450synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1454</dt>
1455<dd>
1456Calls XAllowEvents with AsyncBoth for the most recent grab.
1457</dd>
1458<p></p>
1459<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1460</dt>
1461<dd>
1462Calls XAllowEvents with SyncBoth for the most recent grab.
1463</dd>
1464<p></p>
1465<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1466</dt>
1467<dd>
1468Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1469recent grab.
1470</dd>
1471<p></p>
1472<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1473</dt>
1474<dd>
1475Calls XUngrab for the most recent grab. Is called automatically on
1476evaluation errors, as it is better to lose the grab in the error case as
1477the session.
1478</dd>
1479<p></p>
1480<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1481</dt>
1482<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1483</dt>
1484<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1485</dt>
1486<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1487</dt>
1488<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1489</dt>
1490<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1491</dt>
1492<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1493</dt>
1494<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1495</dt>
1496<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1497</dt>
1498<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1499</dt>
1500<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1501</dt>
1502<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1503</dt>
1504<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1505</dt>
1506<dd>
1507Various X or X-related functions. The <code>$term</code> object only serves as
1508the source of the display, otherwise those functions map more-or-less
1509directory onto the X functions of the same name.
1510</dd>
1511<p></p></dl>
1512<p>
1513</p>
1514<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1515<dl>
1516<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1517</dt>
1518<dd>
1519Adds a non-clickable title to the popup.
1520</dd>
1521<p></p>
1522<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1523</dt>
1524<dd>
1525Creates a separator, optionally using the character given as <code>$sepchr</code>.
1526</dd>
1527<p></p>
1528<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1529</dt>
1530<dd>
1531Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1532selected.
1533</dd>
1534<p></p>
1535<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1536</dt>
1537<dd>
1538Adds a toggle/checkbox item to the popup. Teh callback gets called
1539whenever it gets toggled, with a boolean indicating its value as its first
1540argument.
1541</dd>
1542<p></p>
1543<dt><strong>$popup-&gt;show</strong><br />
1544</dt>
1545<dd>
1546Displays the popup (which is initially hidden).
347</dd> 1547</dd>
348<p></p></dl> 1548<p></p></dl>
349<p> 1549<p>
350</p> 1550</p>
351<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1551<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
352<p>This class implements timer watchers/events. Time is represented as a 1552<p>This class implements timer watchers/events. Time is represented as a
353fractional number of seconds since the epoch. Example:</p> 1553fractional number of seconds since the epoch. Example:</p>
354<pre> 1554<pre>
355 # create a digital clock display in upper right corner 1555 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
356 $term-&gt;{timer} = urxvt::timer 1556 $term-&gt;{timer} = urxvt::timer
357 -&gt;new 1557 -&gt;new
358 -&gt;start (urxvt::NOW) 1558 -&gt;interval (1)
359 -&gt;cb (sub { 1559 -&gt;cb (sub {
360 my ($timer) = @_;
361 my $time = $timer-&gt;at;
362 $timer-&gt;start ($time + 1);
363 $self-&gt;scr_overlay (-1, 0, 1560 $term-&gt;{overlay}-&gt;set (0, 0,
364 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 1561 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
365 });</pre> 1562 });</pre>
366<dl> 1563<dl>
367<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1564<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
368</dt> 1565</dt>
369<dd> 1566<dd>
370Create a new timer object in stopped state. 1567Create a new timer object in started state. It is scheduled to fire
1568immediately.
371</dd> 1569</dd>
372<p></p> 1570<p></p>
373<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1571<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
374</dt> 1572</dt>
375<dd> 1573<dd>
… …
380</dt> 1578</dt>
381<dd> 1579<dd>
382Return the time this watcher will fire next. 1580Return the time this watcher will fire next.
383</dd> 1581</dd>
384<p></p> 1582<p></p>
385<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 1583<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
386</dt> 1584</dt>
387<dd> 1585<dd>
388Set the time the event is generated to $tstamp. 1586Set the time the event is generated to $tstamp.
389</dd> 1587</dd>
390<p></p> 1588<p></p>
1589<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1590</dt>
1591<dd>
1592Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1593stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1594is automatically rescheduled at the given intervals.
1595</dd>
1596<p></p>
391<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1597<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
392</dt> 1598</dt>
393<dd> 1599<dd>
394Start the timer. 1600Start the timer.
395</dd> 1601</dd>
396<p></p> 1602<p></p>
397<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1603<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
398</dt> 1604</dt>
399<dd> 1605<dd>
400Set the event trigger time to <code>$tstamp</code> and start the timer. 1606Set the event trigger time to <code>$tstamp</code> and start the timer.
1607</dd>
1608<p></p>
1609<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1610</dt>
1611<dd>
1612Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
401</dd> 1613</dd>
402<p></p> 1614<p></p>
403<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1615<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
404</dt> 1616</dt>
405<dd> 1617<dd>
… …
413<pre> 1625<pre>
414 $term-&gt;{socket} = ... 1626 $term-&gt;{socket} = ...
415 $term-&gt;{iow} = urxvt::iow 1627 $term-&gt;{iow} = urxvt::iow
416 -&gt;new 1628 -&gt;new
417 -&gt;fd (fileno $term-&gt;{socket}) 1629 -&gt;fd (fileno $term-&gt;{socket})
418 -&gt;events (1) # wait for read data 1630 -&gt;events (urxvt::EVENT_READ)
419 -&gt;start 1631 -&gt;start
420 -&gt;cb (sub { 1632 -&gt;cb (sub {
421 my ($iow, $revents) = @_; 1633 my ($iow, $revents) = @_;
422 # $revents must be 1 here, no need to check 1634 # $revents must be 1 here, no need to check
423 sysread $term-&gt;{socket}, my $buf, 8192 1635 sysread $term-&gt;{socket}, my $buf, 8192
… …
444</dd> 1656</dd>
445<p></p> 1657<p></p>
446<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1658<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
447</dt> 1659</dt>
448<dd> 1660<dd>
449Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1661Set the event mask to watch. The only allowed values are
450data, Bit #1 (value <code>2</code>) enables watching for write data. 1662<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1663together, or <code>urxvt::EVENT_NONE</code>.
451</dd> 1664</dd>
452<p></p> 1665<p></p>
453<dt><strong>$iow = $iow-&gt;start</strong><br /> 1666<dt><strong>$iow = $iow-&gt;start</strong><br />
454</dt> 1667</dt>
455<dd> 1668<dd>
… …
458<p></p> 1671<p></p>
459<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1672<dt><strong>$iow = $iow-&gt;stop</strong><br />
460</dt> 1673</dt>
461<dd> 1674<dd>
462Stop watching for events on the given filehandle. 1675Stop watching for events on the given filehandle.
1676</dd>
1677<p></p></dl>
1678<p>
1679</p>
1680<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1681<p>This class implements idle watchers, that get called automatically when
1682the process is idle. They should return as fast as possible, after doing
1683some useful work.</p>
1684<dl>
1685<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1686</dt>
1687<dd>
1688Create a new idle watcher object in stopped state.
1689</dd>
1690<p></p>
1691<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1692</dt>
1693<dd>
1694Set the callback to be called when the watcher triggers.
1695</dd>
1696<p></p>
1697<dt><strong>$timer = $timer-&gt;start</strong><br />
1698</dt>
1699<dd>
1700Start the watcher.
1701</dd>
1702<p></p>
1703<dt><strong>$timer = $timer-&gt;stop</strong><br />
1704</dt>
1705<dd>
1706Stop the watcher.
1707</dd>
1708<p></p></dl>
1709<p>
1710</p>
1711<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1712<p>This class implements process watchers. They create an event whenever a
1713process exits, after which they stop automatically.</p>
1714<pre>
1715 my $pid = fork;
1716 ...
1717 $term-&gt;{pw} = urxvt::pw
1718 -&gt;new
1719 -&gt;start ($pid)
1720 -&gt;cb (sub {
1721 my ($pw, $exit_status) = @_;
1722 ...
1723 });</pre>
1724<dl>
1725<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1726</dt>
1727<dd>
1728Create a new process watcher in stopped state.
1729</dd>
1730<p></p>
1731<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1732</dt>
1733<dd>
1734Set the callback to be called when the timer triggers.
1735</dd>
1736<p></p>
1737<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1738</dt>
1739<dd>
1740Tells the wqtcher to start watching for process <code>$pid</code>.
1741</dd>
1742<p></p>
1743<dt><strong>$pw = $pw-&gt;stop</strong><br />
1744</dt>
1745<dd>
1746Stop the watcher.
463</dd> 1747</dd>
464<p></p></dl> 1748<p></p></dl>
465<p> 1749<p>
466</p> 1750</p>
467<hr /> 1751<hr />
… …
469<p> 1753<p>
470</p> 1754</p>
471<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1755<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
472<p>This variable controls the verbosity level of the perl extension. Higher 1756<p>This variable controls the verbosity level of the perl extension. Higher
473numbers indicate more verbose output.</p> 1757numbers indicate more verbose output.</p>
474<ol> 1758<dl>
475<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1759<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
476</li> 1760</dt>
477<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1761<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1762</dt>
1763<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1764</dt>
1765<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1766</dt>
478</li> 1767</dl>
479<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
480</li>
481</ol>
482<p> 1768<p>
483</p> 1769</p>
484<hr /> 1770<hr />
485<h1><a name="author">AUTHOR</a></h1> 1771<h1><a name="author">AUTHOR</a></h1>
486<pre> 1772<pre>

Diff Legend

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