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.29 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.34 by root, Fri Jan 20 16:02:20 2006 UTC

1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml"> 2<html xmlns="http://www.w3.org/1999/xhtml">
3<head> 3<head>
4<title>urxvtperl - rxvt-unicode's embedded perl interpreter</title> 4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 5<link rev="made" href="mailto:perl-binary@plan9.de" />
6</head> 6</head>
7 7
8<body style="background-color: white"> 8<body style="background-color: white">
9 9
… …
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
29 <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> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
31 <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>
32 <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>
33 </ul> 35 </ul>
34 36
35 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
36 <ul> 38 <ul>
37 39
… …
45<hr /> 47<hr />
46<p> 48<p>
47</p> 49</p>
48<hr /> 50<hr />
49<h1><a name="name">NAME</a></h1> 51<h1><a name="name">NAME</a></h1>
50<p>urxvtperl - rxvt-unicode's embedded perl interpreter</p> 52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
51<p> 53<p>
52</p> 54</p>
53<hr /> 55<hr />
54<h1><a name="synopsis">SYNOPSIS</a></h1> 56<h1><a name="synopsis">SYNOPSIS</a></h1>
55<pre> 57<pre>
… …
58 sub on_sel_grab { 60 sub on_sel_grab {
59 warn &quot;you selected &quot;, $_[0]-&gt;selection; 61 warn &quot;you selected &quot;, $_[0]-&gt;selection;
60 () 62 ()
61 }</pre> 63 }</pre>
62<pre> 64<pre>
63 # start a urxvt using it:</pre> 65 # start a rxvt using it:</pre>
64<pre> 66<pre>
65 urxvt --perl-lib $HOME -pe grab_test</pre> 67 rxvt --perl-lib $HOME -pe grab_test</pre>
66<p> 68<p>
67</p> 69</p>
68<hr /> 70<hr />
69<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
70<p>Everytime a terminal object gets created, extension scripts specified via 72<p>Everytime a terminal object gets created, extension scripts specified via
71the <code>perl</code> resource are loaded and associated with it.</p> 73the <code>perl</code> resource are loaded and associated with it.</p>
72<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
73thus must be encoded as UTF-8.</p> 75thus must be encoded as UTF-8.</p>
74<p>Each script will only ever be loaded once, even in urxvtd, where 76<p>Each script will only ever be loaded once, even in rxvtd, where
75scripts will be shared (but not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
76<p> 78<p>
77</p> 79</p>
78<hr /> 80<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> 81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
80<p>This section describes the extensions delivered with this release. You can 82<p>This section describes the extensions delivered with this release. You can
81find them in <em>/usr/local/lib/urxvt/perl/</em>.</p> 83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
82<p>You can activate them like this:</p> 84<p>You can activate them like this:</p>
83<pre> 85<pre>
84 urxvt -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>
85<dl> 90<dl>
86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
87</dt> 92</dt>
88<dd> 93<dd>
89(More) intelligent selection. This extension tries to be more intelligent 94(More) intelligent selection. This extension tries to be more intelligent
… …
120<dd> 125<dd>
121<p>You can look at the source of the selection extension to see more 126<p>You can look at the source of the selection extension to see more
122interesting uses, such as parsing a line from beginning to end.</p> 127interesting uses, such as parsing a line from beginning to end.</p>
123</dd> 128</dd>
124<dd> 129<dd>
125<p>This extension also offers the following bindable keyboard command:</p> 130<p>This extension also offers following bindable keyboard commands:</p>
126</dd> 131</dd>
127<dl> 132<dl>
128<dt><strong><a name="item_rot13">rot13</a></strong><br /> 133<dt><strong><a name="item_rot13">rot13</a></strong><br />
129</dt> 134</dt>
130<dd> 135<dd>
… …
146</dt> 151</dt>
147<dd> 152<dd>
148Binds a popup menu to Ctrl-Button3 that lets you convert the selection 153Binds a popup menu to Ctrl-Button3 that lets you convert the selection
149text into various other formats/action (such as uri unescaping, perl 154text into various other formats/action (such as uri unescaping, perl
150evalution, web-browser starting etc.), depending on content. 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>
151</dd> 180</dd>
152<p></p> 181<p></p>
153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 182<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
154</dt> 183</dt>
155<dd> 184<dd>
… …
197<p>And this example matches the same,but replaces it with vi-commands you can 226<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p> 227paste directly into your (vi :) editor:</p>
199</dd> 228</dd>
200<dd> 229<dd>
201<pre> 230<pre>
202 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> 231 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd> 232</dd>
204<dd> 233<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p> 234<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd> 235</dd>
207<dd> 236<dd>
208<p>To expand the example above to typical perl error messages (``XXX at 237<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p> 238FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd> 239</dd>
211<dd> 240<dd>
212<pre> 241<pre>
213 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 242 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
214 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> 243 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
215</dd> 244</dd>
216<dd> 245<dd>
217<p>The first line tells the selection code to treat the unchanging part of 246<p>The first line tells the selection code to treat the unchanging part of
218every error message as a selection pattern, and the second line transforms 247every error message as a selection pattern, and the second line transforms
219the message into vi commands to load the file.</p> 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>
220</dd> 262</dd>
221<p></p> 263<p></p>
222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 264<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
223</dt> 265</dt>
224<dd> 266<dd>
… …
226make them clickable. When middle-clicked, the program specified in the 268make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 269resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument. 270the URL as first argument.
229</dd> 271</dd>
230<p></p> 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>
231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 285<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
232</dt> 286</dt>
233<dd> 287<dd>
234A not very useful example of filtering all text output to the terminal, 288A not very useful example of filtering all text output to the terminal,
235by replacing all line-drawing characters (U+2500 .. U+259F) by a 289by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
246</dt> 300</dt>
247<dd> 301<dd>
248Displays 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
249window. Illustrates overwriting the refresh callbacks to create your own 303window. Illustrates overwriting the refresh callbacks to create your own
250overlays or changes. 304overlays or changes.
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>
251</dd> 347</dd>
252<p></p></dl> 348<p></p></dl>
253<p> 349<p>
254</p> 350</p>
255<hr /> 351<hr />
… …
330<h2><a name="hooks">Hooks</a></h2> 426<h2><a name="hooks">Hooks</a></h2>
331<p>The following subroutines can be declared in extension files, and will be 427<p>The following subroutines can be declared in extension files, and will be
332called whenever the relevant event happens.</p> 428called whenever the relevant event happens.</p>
333<p>The first argument passed to them is an extension oject as described in 429<p>The first argument passed to them is an extension oject as described in
334the in the <code>Extension Objects</code> section.</p> 430the in the <code>Extension Objects</code> section.</p>
335<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the 431<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
336event counts as being <em>consumed</em>, and the invocation of other hooks is 432hooks returns true, then the event counts as being <em>consumed</em>, and the
337skipped, and 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>
338<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 434<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
339<dl> 435<dl>
340<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 />
341</dt> 437</dt>
342<dd> 438<dd>
343Called after a new terminal object has been initialized, but before 439Called after a new terminal object has been initialized, but before
344windows are created or the command gets run. Most methods are unsafe to 440windows are created or the command gets run. Most methods are unsafe to
345call or deliver senseless data, as terminal size and other characteristics 441call or deliver senseless data, as terminal size and other characteristics
346have not yet been determined. You can safely query and change resources, 442have not yet been determined. You can safely query and change resources
347though. 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.
348</dd> 460</dd>
349<p></p> 461<p></p>
350<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 />
351</dt> 463</dt>
352<dd> 464<dd>
353Called 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
354control 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
355variables. 467variables.
356</dd> 468</dd>
357<p></p> 469<p></p>
358<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 />
359</dt> 471</dt>
472<dd>
473Called just after the child process has been <code>fork</code>ed.
360<dd> 474</dd>
361Called at the very end of initialisation of a new terminal, just before 475<p></p>
362returning 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>.
363</dd> 481</dd>
364<p></p> 482<p></p>
365<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 />
366</dt> 484</dt>
367<dd> 485<dd>
… …
489<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 607<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
490</dt> 608</dt>
491<dd> 609<dd>
492Called whenever the user presses a key combination that has a 610Called whenever the user presses a key combination that has a
493<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>
494resource in the <code>urxvt(1)</code> manpage). 612resource in the <code>rxvt(1)</code> manpage).
495</dd> 613</dd>
496<p></p> 614<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 615<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt> 616</dt>
499<dd> 617<dd>
… …
514<dd> 632<dd>
515Called wheneever the window loses keyboard focus, before rxvt-unicode does 633Called wheneever the window loses keyboard focus, before rxvt-unicode does
516focus out processing. 634focus out processing.
517</dd> 635</dd>
518<p></p> 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>
519<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 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 />
520</dt> 640</dt>
521<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 641<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
522</dt> 642</dt>
523<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 643<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
544output, if any, in locale-specific encoding.</p> 664output, if any, in locale-specific encoding.</p>
545</dd> 665</dd>
546<dd> 666<dd>
547<p>subwindow.</p> 667<p>subwindow.</p>
548</dd> 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>
549<p></p></dl> 680<p></p></dl>
550<p> 681<p>
551</p> 682</p>
552<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>
553<dl> 684<dl>
… …
574</dt> 705</dt>
575<dd> 706<dd>
576The current terminal. This variable stores the current <code>urxvt::term</code> 707The current terminal. This variable stores the current <code>urxvt::term</code>
577object, whenever a callback/hook is executing. 708object, whenever a callback/hook is executing.
578</dd> 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>.
730</dd>
579<p></p></dl> 731<p></p></dl>
580<p> 732<p>
581</p> 733</p>
582<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>
583<dl> 735<dl>
… …
600<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
601correct place, e.g. on stderr of the connecting urxvtc client.</p> 753correct place, e.g. on stderr of the connecting urxvtc client.</p>
602</dd> 754</dd>
603<dd> 755<dd>
604<p>Messages have a size limit of 1023 bytes currently.</p> 756<p>Messages have a size limit of 1023 bytes currently.</p>
605</dd>
606<p></p>
607<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
608</dt>
609<dd>
610Returns true when it is safe to do potentially unsafe things, such as
611evaluating perl code specified by the user. This is true when urxvt was
612started setuid or setgid.
613</dd> 757</dd>
614<p></p> 758<p></p>
615<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 />
616</dt> 760</dt>
617<dd> 761<dd>
… …
735<p></p> 879<p></p>
736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 880<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
737</dt> 881</dt>
738<dd> 882<dd>
739Destroy the terminal object (close the window, free resources 883Destroy the terminal object (close the window, free resources
740etc.). Please note that urxvt will not exit as long as any event 884etc.). Please note that rxvt will not exit as long as any event
741watchers (timers, io watchers) are still active. 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>
742</dd> 898</dd>
743<p></p> 899<p></p>
744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 900<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
745</dt> 901</dt>
746<dd> 902<dd>
… …
754</dd> 910</dd>
755<dd> 911<dd>
756<pre> 912<pre>
757 borderLess console cursorBlink cursorUnderline hold iconic insecure 913 borderLess console cursorBlink cursorUnderline hold iconic insecure
758 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 914 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
759 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 915 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
760 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 916 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
761 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 917 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
762 tripleclickwords utmpInhibit visualBell</pre> 918 transparent tripleclickwords utmpInhibit visualBell</pre>
763</dd> 919</dd>
764<p></p> 920<p></p>
765<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 />
766</dt> 922</dt>
767<dd> 923<dd>
… …
792<pre> 948<pre>
793 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 949 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
794 borderLess color cursorBlink cursorUnderline cutchars delete_key 950 borderLess color cursorBlink cursorUnderline cutchars delete_key
795 display_name embed ext_bwidth fade font geometry hold iconName 951 display_name embed ext_bwidth fade font geometry hold iconName
796 imFont imLocale inputMethod insecure int_bwidth intensityStyles 952 imFont imLocale inputMethod insecure int_bwidth intensityStyles
797 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 953 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
798 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 954 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
799 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 955 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
800 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 956 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
801 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 957 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 958 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
803 shade term_name title transparent transparent_all tripleclickwords 959 secondaryScreen secondaryScroll selectstyle shade term_name title
960 transient_for transparent transparent_all tripleclickwords utmpInhibit
804 utmpInhibit visualBell</pre> 961 visualBell</pre>
805</dd> 962</dd>
806<p></p> 963<p></p>
807<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 964<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
808</dt> 965</dt>
809<dd> 966<dd>
… …
820<p></p> 977<p></p>
821<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 978<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
822</dt> 979</dt>
823<dd> 980<dd>
824Adds a keymap translation exactly as specified via a resource. See the 981Adds a keymap translation exactly as specified via a resource. See the
825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage. 982<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
826</dd> 983</dd>
827<p></p> 984<p></p>
828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 985<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
829</dt> 986</dt>
830<dd> 987<dd>
… …
1054</dt> 1211</dt>
1055<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1212<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1056</dt> 1213</dt>
1057<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1214<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1058</dt> 1215</dt>
1059<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1216<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1060</dt> 1217</dt>
1061<dd> 1218<dd>
1062Return various integers describing terminal characteristics. 1219Return various integers describing terminal characteristics.
1063</dd> 1220</dd>
1064<p></p> 1221<p></p>
… …
1093</dd> 1250</dd>
1094<p></p> 1251<p></p>
1095<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 />
1096</dt> 1253</dt>
1097<dd> 1254<dd>
1098Returns the negative row number of the topmost line. Minimum value is 1255Returns the row number of the topmost displayed line. Maximum value is
1099<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
1100this many lines into the scrollback buffer. 1257this many lines into the scrollback buffer.
1101</dd> 1258</dd>
1102<p></p> 1259<p></p>
1103<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 />
1104</dt> 1261</dt>
… …
1115</dt> 1272</dt>
1116<dd> 1273<dd>
1117Returns 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>
1118is 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
1119terminal 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
1120line <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
1121is requested. 1278is requested.
1122</dd> 1279</dd>
1123<dd> 1280<dd>
1124<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
1125line, 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
… …
1370<p></p> 1527<p></p>
1371<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1528<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1372</dt> 1529</dt>
1373<dd> 1530<dd>
1374Set 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.
1532</dd>
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;.
1375</dd> 1538</dd>
1376<p></p> 1539<p></p>
1377<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 />
1378</dt> 1541</dt>
1379<dd> 1542<dd>
… …
1437Stop watching for events on the given filehandle. 1600Stop watching for events on the given filehandle.
1438</dd> 1601</dd>
1439<p></p></dl> 1602<p></p></dl>
1440<p> 1603<p>
1441</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.
1672</dd>
1673<p></p></dl>
1674<p>
1675</p>
1442<hr /> 1676<hr />
1443<h1><a name="environment">ENVIRONMENT</a></h1> 1677<h1><a name="environment">ENVIRONMENT</a></h1>
1444<p> 1678<p>
1445</p> 1679</p>
1446<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1680<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>

Diff Legend

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