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.28 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.36 by root, Sat Jan 21 19:50:53 2006 UTC

… …
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
… …
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>/opt/rxvt/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 rxvt -pe &lt;extensionname&gt;</pre> 86 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
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>
… …
166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167additionally stores the first match in the current line into the primary 196additionally stores the first match in the current line into the primary
168selection.</p> 197selection.</p>
169</dd> 198</dd>
170<p></p> 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>
171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 222<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172</dt> 223</dt>
173<dd> 224<dd>
174This selection allows you to do automatic transforms on a selection 225This selection allows you to do automatic transforms on a selection
175whenever a selection is made. 226whenever a selection is made.
… …
189<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename 240<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
190$word</code>:</p> 241$word</code>:</p>
191</dd> 242</dd>
192<dd> 243<dd>
193<pre> 244<pre>
194 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> 245 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
195</dd> 246</dd>
196<dd> 247<dd>
197<p>And this example matches the same,but replaces it with vi-commands you can 248<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p> 249paste directly into your (vi :) editor:</p>
199</dd> 250</dd>
200<dd> 251<dd>
201<pre> 252<pre>
202 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> 253 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd> 254</dd>
204<dd> 255<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p> 256<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd> 257</dd>
207<dd> 258<dd>
208<p>To expand the example above to typical perl error messages (``XXX at 259<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p> 260FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd> 261</dd>
211<dd> 262<dd>
212<pre> 263<pre>
213 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 264 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> 265 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
215</dd> 266</dd>
216<dd> 267<dd>
217<p>The first line tells the selection code to treat the unchanging part of 268<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 269every error message as a selection pattern, and the second line transforms
219the message into vi commands to load the file.</p> 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>
220</dd> 285</dd>
221<p></p> 286<p></p>
222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 287<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
223</dt> 288</dt>
224<dd> 289<dd>
… …
226make them clickable. When middle-clicked, the program specified in the 291make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 292resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument. 293the URL as first argument.
229</dd> 294</dd>
230<p></p> 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>
231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 308<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
232</dt> 309</dt>
233<dd> 310<dd>
234A not very useful example of filtering all text output to the terminal, 311A not very useful example of filtering all text output to the terminal,
235by replacing all line-drawing characters (U+2500 .. U+259F) by a 312by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
246</dt> 323</dt>
247<dd> 324<dd>
248Displays a very simple digital clock in the upper right corner of the 325Displays a very simple digital clock in the upper right corner of the
249window. Illustrates overwriting the refresh callbacks to create your own 326window. Illustrates overwriting the refresh callbacks to create your own
250overlays or changes. 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>
251</dd> 370</dd>
252<p></p></dl> 371<p></p></dl>
253<p> 372<p>
254</p> 373</p>
255<hr /> 374<hr />
… …
330<h2><a name="hooks">Hooks</a></h2> 449<h2><a name="hooks">Hooks</a></h2>
331<p>The following subroutines can be declared in extension files, and will be 450<p>The following subroutines can be declared in extension files, and will be
332called whenever the relevant event happens.</p> 451called whenever the relevant event happens.</p>
333<p>The first argument passed to them is an extension oject as described in 452<p>The first argument passed to them is an extension oject as described in
334the in the <code>Extension Objects</code> section.</p> 453the 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 454<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 455hooks 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> 456relevant 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> 457<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
339<dl> 458<dl>
340<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 />
341</dt> 460</dt>
342<dd> 461<dd>
343Called after a new terminal object has been initialized, but before 462Called after a new terminal object has been initialized, but before
344windows are created or the command gets run. Most methods are unsafe to 463windows are created or the command gets run. Most methods are unsafe to
345call or deliver senseless data, as terminal size and other characteristics 464call or deliver senseless data, as terminal size and other characteristics
346have not yet been determined. You can safely query and change resources, 465have not yet been determined. You can safely query and change resources
347though. 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.
348</dd> 483</dd>
349<p></p> 484<p></p>
350<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 />
351</dt> 486</dt>
352<dd> 487<dd>
353Called 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
354control 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
355variables. 490variables.
356</dd> 491</dd>
357<p></p> 492<p></p>
358<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 />
359</dt> 494</dt>
495<dd>
496Called just after the child process has been <code>fork</code>ed.
360<dd> 497</dd>
361Called at the very end of initialisation of a new terminal, just before 498<p></p>
362returning 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>.
363</dd> 504</dd>
364<p></p> 505<p></p>
365<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 />
366</dt> 507</dt>
367<dd> 508<dd>
… …
492Called whenever the user presses a key combination that has a 633Called 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> 634<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
494resource in the <code>rxvt(1)</code> manpage). 635resource in the <code>rxvt(1)</code> manpage).
495</dd> 636</dd>
496<p></p> 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>
497<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 646<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
498</dt> 647</dt>
499<dd> 648<dd>
500Called whenever the window gets the keyboard focus, before rxvt-unicode 649Called whenever the window gets the keyboard focus, before rxvt-unicode
501does focus in processing. 650does focus in processing.
… …
506<dd> 655<dd>
507Called wheneever the window loses keyboard focus, before rxvt-unicode does 656Called wheneever the window loses keyboard focus, before rxvt-unicode does
508focus out processing. 657focus out processing.
509</dd> 658</dd>
510<p></p> 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>
511<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 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 />
512</dt> 665</dt>
513<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 666<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
514</dt> 667</dt>
515<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 668<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
526Called whenever the corresponding X event is received for the terminal If 679Called whenever the corresponding X event is received for the terminal If
527the hook returns true, then the even will be ignored by rxvt-unicode. 680the hook returns true, then the even will be ignored by rxvt-unicode.
528</dd> 681</dd>
529<dd> 682<dd>
530<p>The event is a hash with most values as named by Xlib (see the XEvent 683<p>The event is a hash with most values as named by Xlib (see the XEvent
531manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 684manpage), with the additional members <code>row</code> and <code>col</code>, which are the
532and column under the mouse cursor.</p> 685(real, not screen-based) row and column under the mouse cursor.</p>
533</dd> 686</dd>
534<dd> 687<dd>
535<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 688<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
536output, if any, in locale-specific encoding.</p> 689output, if any, in locale-specific encoding.</p>
537</dd> 690</dd>
538<dd> 691<dd>
539<p>subwindow.</p> 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).
540</dd> 704</dd>
541<p></p></dl> 705<p></p></dl>
542<p> 706<p>
543</p> 707</p>
544<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 708<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
… …
566</dt> 730</dt>
567<dd> 731<dd>
568The current terminal. This variable stores the current <code>urxvt::term</code> 732The current terminal. This variable stores the current <code>urxvt::term</code>
569object, whenever a callback/hook is executing. 733object, whenever a callback/hook is executing.
570</dd> 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>
571<p></p></dl> 756<p></p></dl>
572<p> 757<p>
573</p> 758</p>
574<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>
575<dl> 760<dl>
… …
594</dd> 779</dd>
595<dd> 780<dd>
596<p>Messages have a size limit of 1023 bytes currently.</p> 781<p>Messages have a size limit of 1023 bytes currently.</p>
597</dd> 782</dd>
598<p></p> 783<p></p>
599<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
600</dt>
601<dd>
602Returns true when it is safe to do potentially unsafe things, such as
603evaluating perl code specified by the user. This is true when urxvt was
604started setuid or setgid.
605</dd>
606<p></p>
607<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 />
608</dt> 785</dt>
609<dd> 786<dd>
610Returns the ``current time'' (as per the event loop). 787Returns the ``current time'' (as per the event loop).
611</dd> 788</dd>
… …
613<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 790<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
614</dt> 791</dt>
615<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 792<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
616Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 793Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
617Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 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 />
618</dt> 811</dt>
619<dd> 812<dd>
620Various constants for use in X calls and event processing. 813Various constants for use in X calls and event processing.
621</dd> 814</dd>
622<p></p></dl> 815<p></p></dl>
… …
715Destroy the terminal object (close the window, free resources 908Destroy the terminal object (close the window, free resources
716etc.). Please note that rxvt will not exit as long as any event 909etc.). Please note that rxvt will not exit as long as any event
717watchers (timers, io watchers) are still active. 910watchers (timers, io watchers) are still active.
718</dd> 911</dd>
719<p></p> 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>
720<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 925<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
721</dt> 926</dt>
722<dd> 927<dd>
723Returns true if the option specified by <code>$optval</code> is enabled, and 928Returns true if the option specified by <code>$optval</code> is enabled, and
724optionally change it. All option values are stored by name in the hash 929optionally change it. All option values are stored by name in the hash
… …
730</dd> 935</dd>
731<dd> 936<dd>
732<pre> 937<pre>
733 borderLess console cursorBlink cursorUnderline hold iconic insecure 938 borderLess console cursorBlink cursorUnderline hold iconic insecure
734 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 939 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
735 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 940 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
736 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 941 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
737 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 942 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
738 tripleclickwords utmpInhibit visualBell</pre> 943 transparent tripleclickwords utmpInhibit visualBell</pre>
739</dd> 944</dd>
740<p></p> 945<p></p>
741<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 />
742</dt> 947</dt>
743<dd> 948<dd>
… …
768<pre> 973<pre>
769 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 974 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
770 borderLess color cursorBlink cursorUnderline cutchars delete_key 975 borderLess color cursorBlink cursorUnderline cutchars delete_key
771 display_name embed ext_bwidth fade font geometry hold iconName 976 display_name embed ext_bwidth fade font geometry hold iconName
772 imFont imLocale inputMethod insecure int_bwidth intensityStyles 977 imFont imLocale inputMethod insecure int_bwidth intensityStyles
773 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 978 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
774 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 979 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
775 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 980 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
776 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 981 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
777 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 982 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
778 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 983 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
779 shade term_name title transparent transparent_all tripleclickwords 984 secondaryScreen secondaryScroll selectstyle shade term_name title
985 transient_for transparent transparent_all tripleclickwords utmpInhibit
780 utmpInhibit visualBell</pre> 986 visualBell</pre>
781</dd> 987</dd>
782<p></p> 988<p></p>
783<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 989<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
784</dt> 990</dt>
785<dd> 991<dd>
… …
960<p>Normally its not a good idea to use this function, as programs might be 1166<p>Normally its not a good idea to use this function, as programs might be
961confused by changes in cursor position or scrolling. Its useful inside a 1167confused by changes in cursor position or scrolling. Its useful inside a
962<code>on_add_lines</code> hook, though.</p> 1168<code>on_add_lines</code> hook, though.</p>
963</dd> 1169</dd>
964<p></p> 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>
965<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1177<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
966</dt> 1178</dt>
967<dd> 1179<dd>
968Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1180Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
969locale-specific encoding of the terminal and can contain command sequences 1181locale-specific encoding of the terminal and can contain command sequences
… …
997</dt> 1209</dt>
998<dd> 1210<dd>
999Return the window id of the terminal window. 1211Return the window id of the terminal window.
1000</dd> 1212</dd>
1001<p></p> 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>
1002<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1225<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1003</dt> 1226</dt>
1004<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1227<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1005</dt> 1228</dt>
1006<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1229<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
1019</dt> 1242</dt>
1020<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1243<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1021</dt> 1244</dt>
1022<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1245<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1023</dt> 1246</dt>
1024<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1247<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1025</dt> 1248</dt>
1026<dd> 1249<dd>
1027Return various integers describing terminal characteristics. 1250Return various integers describing terminal characteristics.
1028</dd> 1251</dd>
1029<p></p> 1252<p></p>
… …
1055<dd> 1278<dd>
1056Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1279Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1057AltGr), the meta key (often Alt) and the num lock key, if applicable. 1280AltGr), the meta key (often Alt) and the num lock key, if applicable.
1058</dd> 1281</dd>
1059<p></p> 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>
1060<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1295<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1061</dt> 1296</dt>
1062<dd> 1297<dd>
1063Returns the negative row number of the topmost line. Minimum value is 1298Returns the row number of the topmost displayed line. Maximum value is
1064<code>0</code>, which displays the normal terminal contents. Larger values scroll 1299<code>0</code>, which displays the normal terminal contents. Lower values scroll
1065this many lines into the scrollback buffer. 1300this many lines into the scrollback buffer.
1066</dd> 1301</dd>
1067<p></p> 1302<p></p>
1068<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1303<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1069</dt> 1304</dt>
… …
1080</dt> 1315</dt>
1081<dd> 1316<dd>
1082Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1317Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1083is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1318is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1084terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1319terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1085line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1320line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1086is requested. 1321is requested.
1087</dd> 1322</dd>
1088<dd> 1323<dd>
1089<p>If <code>$new_text</code> is specified, it will replace characters in the current 1324<p>If <code>$new_text</code> is specified, it will replace characters in the current
1090line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1325line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1091to replace only parts of a line. The font index in the rendition will 1326to replace only parts of a line. The font index in the rendition will
1092automatically be updated.</p> 1327automatically be updated.</p>
1093</dd> 1328</dd>
1094<dd> 1329<dd>
1095<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1330<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use
1096than one cell when displayed are padded with urxvt::NOCHAR characters 1331more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code>
1097(<code>chr 65535</code>). Characters with combining characters and other characters 1332characters. Characters with combining characters and other characters that
1098that do not fit into the normal tetx encoding will be replaced with 1333do not fit into the normal tetx encoding will be replaced with characters
1099characters in the private use area.</p> 1334in the private use area.</p>
1100</dd> 1335</dd>
1101<dd> 1336<dd>
1102<p>You have to obey this encoding when changing text. The advantage is 1337<p>You have to obey this encoding when changing text. The advantage is
1103that <code>substr</code> and similar functions work on screen cells and not on 1338that <code>substr</code> and similar functions work on screen cells and not on
1104characters.</p> 1339characters.</p>
… …
1238</dt> 1473</dt>
1239<dd> 1474<dd>
1240Calls XUngrab for the most recent grab. Is called automatically on 1475Calls XUngrab for the most recent grab. Is called automatically on
1241evaluation errors, as it is better to lose the grab in the error case as 1476evaluation errors, as it is better to lose the grab in the error case as
1242the session. 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.
1243</dd> 1510</dd>
1244<p></p></dl> 1511<p></p></dl>
1245<p> 1512<p>
1246</p> 1513</p>
1247<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1514<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
… …
1335<p></p> 1602<p></p>
1336<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1603<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1337</dt> 1604</dt>
1338<dd> 1605<dd>
1339Set 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;.
1340</dd> 1613</dd>
1341<p></p> 1614<p></p>
1342<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 />
1343</dt> 1616</dt>
1344<dd> 1617<dd>
… …
1402Stop watching for events on the given filehandle. 1675Stop watching for events on the given filehandle.
1403</dd> 1676</dd>
1404<p></p></dl> 1677<p></p></dl>
1405<p> 1678<p>
1406</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.
1747</dd>
1748<p></p></dl>
1749<p>
1750</p>
1407<hr /> 1751<hr />
1408<h1><a name="environment">ENVIRONMENT</a></h1> 1752<h1><a name="environment">ENVIRONMENT</a></h1>
1409<p> 1753<p>
1410</p> 1754</p>
1411<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1755<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>

Diff Legend

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