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.35 by root, Fri Jan 20 22:49:34 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>
… …
145<dt><strong>selection-popup (enabled by default)</strong><br /> 150<dt><strong>selection-popup (enabled by default)</strong><br />
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. 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>
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_readline">readline</a></strong><br />
252</dt>
253<dd>
254A support package that tries to make editing with readline easier. At the
255moment, it reacts to clicking with the left mouse button by trying to
256move the text cursor to this position. It does so by generating as many
257cursor-left or cursor-right keypresses as required (the this only works
258for programs that correctly support wide characters).
259</dd>
260<dd>
261<p>It only works when clicking into the same line (possibly extended over
262multiple rows) as the text cursor and on the primary screen, to reduce the
263risk of misinterpreting. The normal selection isn't disabled, so quick
264successive clicks might interfere with selection creation in harmless
265ways.</p>
266</dd>
267<p></p>
268<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
269</dt>
270<dd>
271This transforms the terminal into a tabbar with additional terminals, that
272is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
273displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
274button per tab.
275</dd>
276<dd>
277<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
278<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
279while <strong>Shift-Down</strong> creates a new tab.</p>
220</dd> 280</dd>
221<p></p> 281<p></p>
222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 282<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
223</dt> 283</dt>
224<dd> 284<dd>
… …
226make them clickable. When middle-clicked, the program specified in the 286make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 287resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument. 288the URL as first argument.
229</dd> 289</dd>
230<p></p> 290<p></p>
291<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
292</dt>
293<dd>
294This is basically a one-line extension that dynamically changes the background pixmap offset
295to the window position, in effect creating the same effect as pseudo transparency with
296a custom pixmap. No scaling is supported in this mode. Exmaple:
297</dd>
298<dd>
299<pre>
300 rxvt -pixmap background.xpm -pe automove-background</pre>
301</dd>
302<p></p>
231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 303<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
232</dt> 304</dt>
233<dd> 305<dd>
234A not very useful example of filtering all text output to the terminal, 306A not very useful example of filtering all text output to the terminal,
235by replacing all line-drawing characters (U+2500 .. U+259F) by a 307by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
246</dt> 318</dt>
247<dd> 319<dd>
248Displays a very simple digital clock in the upper right corner of the 320Displays a very simple digital clock in the upper right corner of the
249window. Illustrates overwriting the refresh callbacks to create your own 321window. Illustrates overwriting the refresh callbacks to create your own
250overlays or changes. 322overlays or changes.
323</dd>
324<p></p>
325<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
326</dt>
327<dd>
328This is a little rarely useful extension that Uploads the selection as
329textfile to a remote site (or does other things). (The implementation is
330not currently secure for use in a multiuser environment as it writes to
331<em>/tmp</em> directly.).
332</dd>
333<dd>
334<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
335i.e.</p>
336</dd>
337<dd>
338<pre>
339 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
340</dd>
341<dd>
342<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
343the textfile. This command can be set via a resource:</p>
344</dd>
345<dd>
346<pre>
347 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
348</dd>
349<dd>
350<p>And the default is likely not useful to anybody but the few people around
351here :)</p>
352</dd>
353<dd>
354<p>The name of the textfile is the hex encoded md5 sum of the selection, so
355the same content should lead to the same filename.</p>
356</dd>
357<dd>
358<p>After a successful upload the selection will be replaced by the text given
359in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
360for the filename):</p>
361</dd>
362<dd>
363<pre>
364 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
251</dd> 365</dd>
252<p></p></dl> 366<p></p></dl>
253<p> 367<p>
254</p> 368</p>
255<hr /> 369<hr />
… …
330<h2><a name="hooks">Hooks</a></h2> 444<h2><a name="hooks">Hooks</a></h2>
331<p>The following subroutines can be declared in extension files, and will be 445<p>The following subroutines can be declared in extension files, and will be
332called whenever the relevant event happens.</p> 446called whenever the relevant event happens.</p>
333<p>The first argument passed to them is an extension oject as described in 447<p>The first argument passed to them is an extension oject as described in
334the in the <code>Extension Objects</code> section.</p> 448the 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 449<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 450hooks 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> 451relevant 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> 452<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
339<dl> 453<dl>
340<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 454<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
341</dt> 455</dt>
342<dd> 456<dd>
343Called after a new terminal object has been initialized, but before 457Called after a new terminal object has been initialized, but before
344windows are created or the command gets run. Most methods are unsafe to 458windows are created or the command gets run. Most methods are unsafe to
345call or deliver senseless data, as terminal size and other characteristics 459call or deliver senseless data, as terminal size and other characteristics
346have not yet been determined. You can safely query and change resources, 460have not yet been determined. You can safely query and change resources
347though. 461and options, though. For many purposes the <code>on_start</code> hook is a better
462place.
463</dd>
464<p></p>
465<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
466</dt>
467<dd>
468Called at the very end of initialisation of a new terminal, just before
469trying to map (display) the toplevel and returning to the mainloop.
470</dd>
471<p></p>
472<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
473</dt>
474<dd>
475Called whenever something tries to destroy terminal, before doing anything
476yet. If this hook returns true, then destruction is skipped, but this is
477rarely a good idea.
348</dd> 478</dd>
349<p></p> 479<p></p>
350<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 480<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
351</dt> 481</dt>
352<dd> 482<dd>
353Called after the screen is ``reset'' for any reason, such as resizing or 483Called 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 484control sequences. Here is where you can react on changes to size-related
355variables. 485variables.
356</dd> 486</dd>
357<p></p> 487<p></p>
358<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 488<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
359</dt> 489</dt>
490<dd>
491Called just after the child process has been <code>fork</code>ed.
360<dd> 492</dd>
361Called at the very end of initialisation of a new terminal, just before 493<p></p>
362returning to the mainloop. 494<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
495</dt>
496<dd>
497Called just after the child process has exited. <code>$status</code> is the status
498from <code>waitpid</code>.
363</dd> 499</dd>
364<p></p> 500<p></p>
365<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 501<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
366</dt> 502</dt>
367<dd> 503<dd>
… …
489<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 625<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
490</dt> 626</dt>
491<dd> 627<dd>
492Called whenever the user presses a key combination that has a 628Called 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> 629<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
494resource in the <code>urxvt(1)</code> manpage). 630resource in the <code>rxvt(1)</code> manpage).
495</dd> 631</dd>
496<p></p> 632<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 633<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt> 634</dt>
499<dd> 635<dd>
… …
514<dd> 650<dd>
515Called wheneever the window loses keyboard focus, before rxvt-unicode does 651Called wheneever the window loses keyboard focus, before rxvt-unicode does
516focus out processing. 652focus out processing.
517</dd> 653</dd>
518<p></p> 654<p></p>
655<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
656</dt>
657<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
658</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 /> 659<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> 660</dt>
521<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 661<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
522</dt> 662</dt>
523<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 663<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
534Called whenever the corresponding X event is received for the terminal If 674Called whenever the corresponding X event is received for the terminal If
535the hook returns true, then the even will be ignored by rxvt-unicode. 675the hook returns true, then the even will be ignored by rxvt-unicode.
536</dd> 676</dd>
537<dd> 677<dd>
538<p>The event is a hash with most values as named by Xlib (see the XEvent 678<p>The event is a hash with most values as named by Xlib (see the XEvent
539manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 679manpage), with the additional members <code>row</code> and <code>col</code>, which are the
540and column under the mouse cursor.</p> 680(real, not screen-based) row and column under the mouse cursor.</p>
541</dd> 681</dd>
542<dd> 682<dd>
543<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 683<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
544output, if any, in locale-specific encoding.</p> 684output, if any, in locale-specific encoding.</p>
545</dd> 685</dd>
546<dd> 686<dd>
547<p>subwindow.</p> 687<p>subwindow.</p>
688</dd>
689<p></p>
690<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
691</dt>
692<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
693</dt>
694<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
695</dt>
696<dd>
697Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
548</dd> 699</dd>
549<p></p></dl> 700<p></p></dl>
550<p> 701<p>
551</p> 702</p>
552<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 703<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
… …
574</dt> 725</dt>
575<dd> 726<dd>
576The current terminal. This variable stores the current <code>urxvt::term</code> 727The current terminal. This variable stores the current <code>urxvt::term</code>
577object, whenever a callback/hook is executing. 728object, whenever a callback/hook is executing.
578</dd> 729</dd>
730<p></p>
731<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
732</dt>
733<dd>
734All coderefs in this array will be called as methods of the next newly
735created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
736gets cleared before the codereferences that were in it are being executed,
737so coderefs can push themselves onto it again if they so desire.
738</dd>
739<dd>
740<p>This complements to the perl-eval commandline option, but gets executed
741first.</p>
742</dd>
743<p></p>
744<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
745</dt>
746<dd>
747Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
748get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
749but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
750</dd>
579<p></p></dl> 751<p></p></dl>
580<p> 752<p>
581</p> 753</p>
582<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 754<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
583<dl> 755<dl>
… …
600<p>Using this function has the advantage that its output ends up in the 772<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> 773correct place, e.g. on stderr of the connecting urxvtc client.</p>
602</dd> 774</dd>
603<dd> 775<dd>
604<p>Messages have a size limit of 1023 bytes currently.</p> 776<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> 777</dd>
614<p></p> 778<p></p>
615<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 779<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
616</dt> 780</dt>
617<dd> 781<dd>
… …
735<p></p> 899<p></p>
736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 900<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
737</dt> 901</dt>
738<dd> 902<dd>
739Destroy the terminal object (close the window, free resources 903Destroy the terminal object (close the window, free resources
740etc.). Please note that urxvt will not exit as long as any event 904etc.). Please note that rxvt will not exit as long as any event
741watchers (timers, io watchers) are still active. 905watchers (timers, io watchers) are still active.
906</dd>
907<p></p>
908<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
909</dt>
910<dd>
911Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
912(``starts'') programs in the background. This function takes care of setting
913the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
914be preferred over explicit calls to <code>exec</code> or <code>system</code>.
915</dd>
916<dd>
917<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
742</dd> 918</dd>
743<p></p> 919<p></p>
744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 920<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
745</dt> 921</dt>
746<dd> 922<dd>
… …
754</dd> 930</dd>
755<dd> 931<dd>
756<pre> 932<pre>
757 borderLess console cursorBlink cursorUnderline hold iconic insecure 933 borderLess console cursorBlink cursorUnderline hold iconic insecure
758 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 934 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
759 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 935 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
760 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 936 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
761 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 937 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
762 tripleclickwords utmpInhibit visualBell</pre> 938 transparent tripleclickwords utmpInhibit visualBell</pre>
763</dd> 939</dd>
764<p></p> 940<p></p>
765<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 941<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
766</dt> 942</dt>
767<dd> 943<dd>
… …
792<pre> 968<pre>
793 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 969 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
794 borderLess color cursorBlink cursorUnderline cutchars delete_key 970 borderLess color cursorBlink cursorUnderline cutchars delete_key
795 display_name embed ext_bwidth fade font geometry hold iconName 971 display_name embed ext_bwidth fade font geometry hold iconName
796 imFont imLocale inputMethod insecure int_bwidth intensityStyles 972 imFont imLocale inputMethod insecure int_bwidth intensityStyles
797 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 973 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
798 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 974 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
799 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 975 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
800 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 976 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
801 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 977 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 978 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
803 shade term_name title transparent transparent_all tripleclickwords 979 secondaryScreen secondaryScroll selectstyle shade term_name title
980 transient_for transparent transparent_all tripleclickwords utmpInhibit
804 utmpInhibit visualBell</pre> 981 visualBell</pre>
805</dd> 982</dd>
806<p></p> 983<p></p>
807<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 984<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
808</dt> 985</dt>
809<dd> 986<dd>
… …
820<p></p> 997<p></p>
821<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 998<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
822</dt> 999</dt>
823<dd> 1000<dd>
824Adds a keymap translation exactly as specified via a resource. See the 1001Adds a keymap translation exactly as specified via a resource. See the
825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage. 1002<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
826</dd> 1003</dd>
827<p></p> 1004<p></p>
828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 1005<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
829</dt> 1006</dt>
830<dd> 1007<dd>
… …
984<p>Normally its not a good idea to use this function, as programs might be 1161<p>Normally its not a good idea to use this function, as programs might be
985confused by changes in cursor position or scrolling. Its useful inside a 1162confused by changes in cursor position or scrolling. Its useful inside a
986<code>on_add_lines</code> hook, though.</p> 1163<code>on_add_lines</code> hook, though.</p>
987</dd> 1164</dd>
988<p></p> 1165<p></p>
1166<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1167</dt>
1168<dd>
1169Switch to given screen - 0 primary, 1 secondary.
1170</dd>
1171<p></p>
989<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1172<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
990</dt> 1173</dt>
991<dd> 1174<dd>
992Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1175Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
993locale-specific encoding of the terminal and can contain command sequences 1176locale-specific encoding of the terminal and can contain command sequences
… …
1054</dt> 1237</dt>
1055<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1238<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1056</dt> 1239</dt>
1057<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1240<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1058</dt> 1241</dt>
1059<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1242<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1060</dt> 1243</dt>
1061<dd> 1244<dd>
1062Return various integers describing terminal characteristics. 1245Return various integers describing terminal characteristics.
1063</dd> 1246</dd>
1064<p></p> 1247<p></p>
… …
1090<dd> 1273<dd>
1091Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1274Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1092AltGr), the meta key (often Alt) and the num lock key, if applicable. 1275AltGr), the meta key (often Alt) and the num lock key, if applicable.
1093</dd> 1276</dd>
1094<p></p> 1277<p></p>
1278<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1279</dt>
1280<dd>
1281Returns the currently displayed screen (0 primary, 1 secondary).
1282</dd>
1283<p></p>
1095<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1284<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1096</dt> 1285</dt>
1097<dd> 1286<dd>
1098Returns the negative row number of the topmost line. Minimum value is 1287Returns the row number of the topmost displayed line. Maximum value is
1099<code>0</code>, which displays the normal terminal contents. Larger values scroll 1288<code>0</code>, which displays the normal terminal contents. Lower values scroll
1100this many lines into the scrollback buffer. 1289this many lines into the scrollback buffer.
1101</dd> 1290</dd>
1102<p></p> 1291<p></p>
1103<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1292<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1104</dt> 1293</dt>
… …
1115</dt> 1304</dt>
1116<dd> 1305<dd>
1117Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1306Returns 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 1307is 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 1308terminal 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 1309line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1121is requested. 1310is requested.
1122</dd> 1311</dd>
1123<dd> 1312<dd>
1124<p>If <code>$new_text</code> is specified, it will replace characters in the current 1313<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 1314line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1126to replace only parts of a line. The font index in the rendition will 1315to replace only parts of a line. The font index in the rendition will
1127automatically be updated.</p> 1316automatically be updated.</p>
1128</dd> 1317</dd>
1129<dd> 1318<dd>
1130<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1319<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use
1131than one cell when displayed are padded with urxvt::NOCHAR characters 1320more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code>
1132(<code>chr 65535</code>). Characters with combining characters and other characters 1321characters. Characters with combining characters and other characters that
1133that do not fit into the normal tetx encoding will be replaced with 1322do not fit into the normal tetx encoding will be replaced with characters
1134characters in the private use area.</p> 1323in the private use area.</p>
1135</dd> 1324</dd>
1136<dd> 1325<dd>
1137<p>You have to obey this encoding when changing text. The advantage is 1326<p>You have to obey this encoding when changing text. The advantage is
1138that <code>substr</code> and similar functions work on screen cells and not on 1327that <code>substr</code> and similar functions work on screen cells and not on
1139characters.</p> 1328characters.</p>
… …
1273</dt> 1462</dt>
1274<dd> 1463<dd>
1275Calls XUngrab for the most recent grab. Is called automatically on 1464Calls XUngrab for the most recent grab. Is called automatically on
1276evaluation errors, as it is better to lose the grab in the error case as 1465evaluation errors, as it is better to lose the grab in the error case as
1277the session. 1466the session.
1467</dd>
1468<p></p>
1469<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1470</dt>
1471<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1472</dt>
1473<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1474</dt>
1475<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1476</dt>
1477<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1478</dt>
1479<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1480</dt>
1481<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1482</dt>
1483<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1484</dt>
1485<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1486</dt>
1487<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1488</dt>
1489<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1490</dt>
1491<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1492</dt>
1493<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1494</dt>
1495<dd>
1496Various X or X-related functions. The <code>$term</code> object only serves as
1497the source of the display, otherwise those functions map more-or-less
1498directory onto the X functions of the same name.
1278</dd> 1499</dd>
1279<p></p></dl> 1500<p></p></dl>
1280<p> 1501<p>
1281</p> 1502</p>
1282<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1503<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
… …
1370<p></p> 1591<p></p>
1371<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1592<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1372</dt> 1593</dt>
1373<dd> 1594<dd>
1374Set the event trigger time to <code>$tstamp</code> and start the timer. 1595Set the event trigger time to <code>$tstamp</code> and start the timer.
1596</dd>
1597<p></p>
1598<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1599</dt>
1600<dd>
1601Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1375</dd> 1602</dd>
1376<p></p> 1603<p></p>
1377<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1604<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1378</dt> 1605</dt>
1379<dd> 1606<dd>
… …
1437Stop watching for events on the given filehandle. 1664Stop watching for events on the given filehandle.
1438</dd> 1665</dd>
1439<p></p></dl> 1666<p></p></dl>
1440<p> 1667<p>
1441</p> 1668</p>
1669<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1670<p>This class implements idle watchers, that get called automatically when
1671the process is idle. They should return as fast as possible, after doing
1672some useful work.</p>
1673<dl>
1674<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1675</dt>
1676<dd>
1677Create a new idle watcher object in stopped state.
1678</dd>
1679<p></p>
1680<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1681</dt>
1682<dd>
1683Set the callback to be called when the watcher triggers.
1684</dd>
1685<p></p>
1686<dt><strong>$timer = $timer-&gt;start</strong><br />
1687</dt>
1688<dd>
1689Start the watcher.
1690</dd>
1691<p></p>
1692<dt><strong>$timer = $timer-&gt;stop</strong><br />
1693</dt>
1694<dd>
1695Stop the watcher.
1696</dd>
1697<p></p></dl>
1698<p>
1699</p>
1700<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1701<p>This class implements process watchers. They create an event whenever a
1702process exits, after which they stop automatically.</p>
1703<pre>
1704 my $pid = fork;
1705 ...
1706 $term-&gt;{pw} = urxvt::pw
1707 -&gt;new
1708 -&gt;start ($pid)
1709 -&gt;cb (sub {
1710 my ($pw, $exit_status) = @_;
1711 ...
1712 });</pre>
1713<dl>
1714<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1715</dt>
1716<dd>
1717Create a new process watcher in stopped state.
1718</dd>
1719<p></p>
1720<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1721</dt>
1722<dd>
1723Set the callback to be called when the timer triggers.
1724</dd>
1725<p></p>
1726<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1727</dt>
1728<dd>
1729Tells the wqtcher to start watching for process <code>$pid</code>.
1730</dd>
1731<p></p>
1732<dt><strong>$pw = $pw-&gt;stop</strong><br />
1733</dt>
1734<dd>
1735Stop the watcher.
1736</dd>
1737<p></p></dl>
1738<p>
1739</p>
1442<hr /> 1740<hr />
1443<h1><a name="environment">ENVIRONMENT</a></h1> 1741<h1><a name="environment">ENVIRONMENT</a></h1>
1444<p> 1742<p>
1445</p> 1743</p>
1446<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1744<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>

Diff Legend

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