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.25 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.41 by root, Mon Feb 6 05:55:33 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
… …
95<dd> 100<dd>
96<p>A double-click usually selects the word under the cursor, further clicks 101<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p> 102will enlarge the selection.</p>
98</dd> 103</dd>
99<dd> 104<dd>
105<p>The selection works by trying to match a number of regexes and displaying
106them in increasing order of length. You can add your own regexes by
107specifying resources of the form:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.selection.pattern-0: perl-regex
112 URxvt.selection.pattern-1: perl-regex
113 ...</pre>
114</dd>
115<dd>
116<p>The index number (0, 1...) must not have any holes, and each regex must
117contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything
119between two vertical bars:</p>
120</dd>
121<dd>
122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd>
125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
136<p>You can look at the source of the selection extension to see more
137interesting uses, such as parsing a line from beginning to end.</p>
138</dd>
139<dd>
100<p>It also offers the following bindable keyboard command:</p> 140<p>This extension also offers following bindable keyboard commands:</p>
101</dd> 141</dd>
102<dl> 142<dl>
103<dt><strong><a name="item_rot13">rot13</a></strong><br /> 143<dt><strong><a name="item_rot13">rot13</a></strong><br />
104</dt> 144</dt>
105<dd> 145<dd>
… …
120<dt><strong>selection-popup (enabled by default)</strong><br /> 160<dt><strong>selection-popup (enabled by default)</strong><br />
121</dt> 161</dt>
122<dd> 162<dd>
123Binds a popup menu to Ctrl-Button3 that lets you convert the selection 163Binds a popup menu to Ctrl-Button3 that lets you convert the selection
124text into various other formats/action (such as uri unescaping, perl 164text into various other formats/action (such as uri unescaping, perl
125evalution, web-browser starting etc.), depending on content. 165evaluation, web-browser starting etc.), depending on content.
166</dd>
167<dd>
168<p>Other extensions can extend this popup menu by pushing a code reference
169onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
170popup is displayed.</p>
171</dd>
172<dd>
173<p>It's sole argument is the popup menu, which can be modified. The selection
174is in <code>$_</code>, which can be used to decide wether to add something or not.
175It should either return nothing or a string and a code reference. The
176string will be used as button text and the code reference will be called
177when the button gets activated and should transform <code>$_</code>.</p>
178</dd>
179<dd>
180<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
181the selection to <code>b</code>s, but only if the selection currently contains any
182<code>a</code>s:</p>
183</dd>
184<dd>
185<pre>
186 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
187 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
188 : ()
189 };</pre>
126</dd> 190</dd>
127<p></p> 191<p></p>
128<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 192<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
129</dt> 193</dt>
130<dd> 194<dd>
… …
141was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 205was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
142additionally stores the first match in the current line into the primary 206additionally stores the first match in the current line into the primary
143selection.</p> 207selection.</p>
144</dd> 208</dd>
145<p></p> 209<p></p>
146<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 210<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
147</dt> 211</dt>
212<dd>
213A support package that tries to make editing with readline easier. At the
214moment, it reacts to clicking with the left mouse button by trying to
215move the text cursor to this position. It does so by generating as many
216cursor-left or cursor-right keypresses as required (the this only works
217for programs that correctly support wide characters).
148<dd> 218</dd>
149Displays a digital clock using the built-in overlay. 219<dd>
220<p>To avoid too many false positives, this is only done when:</p>
221</dd>
222<dl>
223<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
224</dt>
225<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
226</dt>
227<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
228</dt>
229<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
230</dt>
231</dl>
232<p>The normal selection mechanism isn't disabled, so quick successive clicks
233might interfere with selection creation in harmless ways.</p>
234<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
235</dt>
236<dd>
237This selection allows you to do automatic transforms on a selection
238whenever a selection is made.
239</dd>
240<dd>
241<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
242operator) that modify <code>$_</code> as resources:</p>
243</dd>
244<dd>
245<pre>
246 URxvt.selection-autotransform.0: transform
247 URxvt.selection-autotransform.1: transform
248 ...</pre>
249</dd>
250<dd>
251<p>For example, the following will transform selections of the form
252<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
253$word</code>:</p>
254</dd>
255<dd>
256<pre>
257 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
258</dd>
259<dd>
260<p>And this example matches the same,but replaces it with vi-commands you can
261paste directly into your (vi :) editor:</p>
262</dd>
263<dd>
264<pre>
265 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
266</dd>
267<dd>
268<p>Of course, this can be modified to suit your needs and your editor :)</p>
269</dd>
270<dd>
271<p>To expand the example above to typical perl error messages (``XXX at
272FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
273</dd>
274<dd>
275<pre>
276 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
277 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
278</dd>
279<dd>
280<p>The first line tells the selection code to treat the unchanging part of
281every error message as a selection pattern, and the second line transforms
282the message into vi commands to load the file.</p>
283</dd>
284<p></p>
285<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
286</dt>
287<dd>
288This transforms the terminal into a tabbar with additional terminals, that
289is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
290displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
291button per tab.
292</dd>
293<dd>
294<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
295<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
296while <strong>Shift-Down</strong> creates a new tab.</p>
297</dd>
298<dd>
299<p>The tabbar itself can be configured similarly to a normal terminal, but
300with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
301following four resources (shown with defaults):</p>
302</dd>
303<dd>
304<pre>
305 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
306 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
307 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
308 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
309</dd>
310<dd>
311<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
312indices.</p>
150</dd> 313</dd>
151<p></p> 314<p></p>
152<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 315<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
153</dt> 316</dt>
154<dd> 317<dd>
… …
156make them clickable. When middle-clicked, the program specified in the 319make them clickable. When middle-clicked, the program specified in the
157resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 320resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
158the URL as first argument. 321the URL as first argument.
159</dd> 322</dd>
160<p></p> 323<p></p>
324<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
325</dt>
326<dd>
327This (experimental) perl extension implements OnTheSpot editing. It does
328not work perfectly, and some input methods don't seem to work well with
329OnTheSpot editing in general, but it seems to work at leats for SCIM and
330kinput2.
331</dd>
332<dd>
333<p>You enable it by specifying this extension and a preedit style of
334<code>OnTheSpot</code>, i.e.:</p>
335</dd>
336<dd>
337<pre>
338 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
339</dd>
340<p></p>
341<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
342</dt>
343<dd>
344This is basically a one-line extension that dynamically changes the background pixmap offset
345to the window position, in effect creating the same effect as pseudo transparency with
346a custom pixmap. No scaling is supported in this mode. Exmaple:
347</dd>
348<dd>
349<pre>
350 rxvt -pixmap background.xpm -pe automove-background</pre>
351</dd>
352<p></p>
161<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 353<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
162</dt> 354</dt>
163<dd> 355<dd>
164A not very useful example of filtering all text output to the terminal, 356A not very useful example of filtering all text output to the terminal,
165by replacing all line-drawing characters (U+2500 .. U+259F) by a 357by replacing all line-drawing characters (U+2500 .. U+259F) by a
166similar-looking ascii character. 358similar-looking ascii character.
359</dd>
360<p></p>
361<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
362</dt>
363<dd>
364Displays a digital clock using the built-in overlay.
365</dd>
366<p></p>
367<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
368</dt>
369<dd>
370Somewhat of a misnomer, this extension adds two menu entries to the
371selection popup that allows one ti run external commands to store the
372selection somewhere and fetch it again.
373</dd>
374<dd>
375<p>We use it to implement a ``distributed selection mechanism'', which just
376means that one command uploads the file to a remote server, and another
377reads it.</p>
378</dd>
379<dd>
380<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
381<code>URxvt.remote-selection.fetch</code> resources. The first should read the
382selection to store from STDIN (always in UTF-8), the second should provide
383the selection data on STDOUT (also in UTF-8).</p>
384</dd>
385<dd>
386<p>The defaults (which are likely useless to you) use rsh and cat:</p>
387</dd>
388<dd>
389<pre>
390 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
391 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
392</dd>
393<p></p>
394<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
395</dt>
396<dd>
397This is a little rarely useful extension that Uploads the selection as
398textfile to a remote site (or does other things). (The implementation is
399not currently secure for use in a multiuser environment as it writes to
400<em>/tmp</em> directly.).
401</dd>
402<dd>
403<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
404i.e.</p>
405</dd>
406<dd>
407<pre>
408 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
409</dd>
410<dd>
411<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
412the textfile. This command can be set via a resource:</p>
413</dd>
414<dd>
415<pre>
416 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
417</dd>
418<dd>
419<p>And the default is likely not useful to anybody but the few people around
420here :)</p>
421</dd>
422<dd>
423<p>The name of the textfile is the hex encoded md5 sum of the selection, so
424the same content should lead to the same filename.</p>
425</dd>
426<dd>
427<p>After a successful upload the selection will be replaced by the text given
428in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
429for the filename):</p>
430</dd>
431<dd>
432<pre>
433 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
167</dd> 434</dd>
168<p></p> 435<p></p>
169<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 436<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
170</dt> 437</dt>
171<dd> 438<dd>
… …
254<h2><a name="hooks">Hooks</a></h2> 521<h2><a name="hooks">Hooks</a></h2>
255<p>The following subroutines can be declared in extension files, and will be 522<p>The following subroutines can be declared in extension files, and will be
256called whenever the relevant event happens.</p> 523called whenever the relevant event happens.</p>
257<p>The first argument passed to them is an extension oject as described in 524<p>The first argument passed to them is an extension oject as described in
258the in the <code>Extension Objects</code> section.</p> 525the in the <code>Extension Objects</code> section.</p>
259<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the 526<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
260event counts as being <em>consumed</em>, and the invocation of other hooks is 527hooks returns true, then the event counts as being <em>consumed</em>, and the
261skipped, and the relevant action might not be carried out by the C++ code.</p> 528relevant action might not be carried out by the C++ code.</p>
262<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 529<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
263<dl> 530<dl>
264<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 531<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
265</dt> 532</dt>
266<dd> 533<dd>
267Called after a new terminal object has been initialized, but before 534Called after a new terminal object has been initialized, but before
268windows are created or the command gets run. Most methods are unsafe to 535windows are created or the command gets run. Most methods are unsafe to
269call or deliver senseless data, as terminal size and other characteristics 536call or deliver senseless data, as terminal size and other characteristics
270have not yet been determined. You can safely query and change resources, 537have not yet been determined. You can safely query and change resources
271though. 538and options, though. For many purposes the <code>on_start</code> hook is a better
539place.
540</dd>
541<p></p>
542<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
543</dt>
544<dd>
545Called at the very end of initialisation of a new terminal, just before
546trying to map (display) the toplevel and returning to the mainloop.
547</dd>
548<p></p>
549<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
550</dt>
551<dd>
552Called whenever something tries to destroy terminal, when the terminal is
553still fully functional (not for long, though).
272</dd> 554</dd>
273<p></p> 555<p></p>
274<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 556<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
275</dt> 557</dt>
276<dd> 558<dd>
277Called after the screen is ``reset'' for any reason, such as resizing or 559Called after the screen is ``reset'' for any reason, such as resizing or
278control sequences. Here is where you can react on changes to size-related 560control sequences. Here is where you can react on changes to size-related
279variables. 561variables.
280</dd> 562</dd>
281<p></p> 563<p></p>
282<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 564<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
283</dt> 565</dt>
566<dd>
567Called just after the child process has been <code>fork</code>ed.
284<dd> 568</dd>
285Called at the very end of initialisation of a new terminal, just before 569<p></p>
286returning to the mainloop. 570<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
571</dt>
572<dd>
573Called just after the child process has exited. <code>$status</code> is the status
574from <code>waitpid</code>.
287</dd> 575</dd>
288<p></p> 576<p></p>
289<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 577<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
290</dt> 578</dt>
291<dd> 579<dd>
… …
408</dt> 696</dt>
409<dd> 697<dd>
410Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 698Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
411</dd> 699</dd>
412<p></p> 700<p></p>
413<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 701<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
414</dt> 702</dt>
415<dd> 703<dd>
416Called whenever the user presses a key combination that has a 704Called whenever the a user-configured event is being activated (e.g. via
417<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 705a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
418resource in the <code>rxvt(1)</code> manpage). 706resource in the <code>rxvt(1)</code> manpage).
707</dd>
708<dd>
709<p>The event is simply the action string. This interface is assumed to change
710slightly in the future.</p>
711</dd>
712<p></p>
713<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
714</dt>
715<dd>
716Called on every X event received on the vt window (and possibly other
717windows). Should only be used as a last resort. Most event structure
718members are not passed.
419</dd> 719</dd>
420<p></p> 720<p></p>
421<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 721<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
422</dt> 722</dt>
423<dd> 723<dd>
… …
430<dd> 730<dd>
431Called wheneever the window loses keyboard focus, before rxvt-unicode does 731Called wheneever the window loses keyboard focus, before rxvt-unicode does
432focus out processing. 732focus out processing.
433</dd> 733</dd>
434<p></p> 734<p></p>
735<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
736</dt>
737<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
738</dt>
435<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 739<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
436</dt> 740</dt>
437<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 741<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
438</dt> 742</dt>
439<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 743<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
450Called whenever the corresponding X event is received for the terminal If 754Called whenever the corresponding X event is received for the terminal If
451the hook returns true, then the even will be ignored by rxvt-unicode. 755the hook returns true, then the even will be ignored by rxvt-unicode.
452</dd> 756</dd>
453<dd> 757<dd>
454<p>The event is a hash with most values as named by Xlib (see the XEvent 758<p>The event is a hash with most values as named by Xlib (see the XEvent
455manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 759manpage), with the additional members <code>row</code> and <code>col</code>, which are the
456and column under the mouse cursor.</p> 760(real, not screen-based) row and column under the mouse cursor.</p>
457</dd> 761</dd>
458<dd> 762<dd>
459<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 763<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
460output, if any, in locale-specific encoding.</p> 764output, if any, in locale-specific encoding.</p>
461</dd> 765</dd>
462<dd> 766<dd>
463<p>subwindow.</p> 767<p>subwindow.</p>
768</dd>
769<p></p>
770<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
771</dt>
772<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
773</dt>
774<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
775</dt>
776<dd>
777Called when various types of ClientMessage events are received (all with
778format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464</dd> 779</dd>
465<p></p></dl> 780<p></p></dl>
466<p> 781<p>
467</p> 782</p>
468<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 783<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
… …
490</dt> 805</dt>
491<dd> 806<dd>
492The current terminal. This variable stores the current <code>urxvt::term</code> 807The current terminal. This variable stores the current <code>urxvt::term</code>
493object, whenever a callback/hook is executing. 808object, whenever a callback/hook is executing.
494</dd> 809</dd>
810<p></p>
811<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
812</dt>
813<dd>
814All coderefs in this array will be called as methods of the next newly
815created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
816gets cleared before the codereferences that were in it are being executed,
817so coderefs can push themselves onto it again if they so desire.
818</dd>
819<dd>
820<p>This complements to the perl-eval commandline option, but gets executed
821first.</p>
822</dd>
823<p></p>
824<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
825</dt>
826<dd>
827Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
828get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
829but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
830</dd>
495<p></p></dl> 831<p></p></dl>
496<p> 832<p>
497</p> 833</p>
498<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 834<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
499<dl> 835<dl>
… …
518</dd> 854</dd>
519<dd> 855<dd>
520<p>Messages have a size limit of 1023 bytes currently.</p> 856<p>Messages have a size limit of 1023 bytes currently.</p>
521</dd> 857</dd>
522<p></p> 858<p></p>
523<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 859<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
524</dt> 860</dt>
525<dd> 861<dd>
526Returns true when it is safe to do potentially unsafe things, such as 862Returns all urxvt::term objects that exist in this process, regardless of
527evaluating perl code specified by the user. This is true when urxvt was 863wether they are started, being destroyed etc., so be careful. Only term
528started setuid or setgid. 864objects that have perl extensions attached will be returned (because there
865is no urxvt::term objet associated with others).
529</dd> 866</dd>
530<p></p> 867<p></p>
531<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 868<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
532</dt> 869</dt>
533<dd> 870<dd>
… …
537<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 874<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
538</dt> 875</dt>
539<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 876<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
540Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 877Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
541Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 878Button4Mask, Button5Mask, AnyModifier</a></strong><br />
879</dt>
880<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
881ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
882PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
883Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
884KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
885ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
886FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
887</dt>
888<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
889EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
890GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
891UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
892ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
893CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
894SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
542</dt> 895</dt>
543<dd> 896<dd>
544Various constants for use in X calls and event processing. 897Various constants for use in X calls and event processing.
545</dd> 898</dd>
546<p></p></dl> 899<p></p></dl>
… …
585<p></p> 938<p></p>
586<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> 939<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
587</dt> 940</dt>
588<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> 941<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
589</dt> 942</dt>
943<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
944</dt>
590<dd> 945<dd>
591Replace the foreground/background colour in the rendition mask with the 946Replace the foreground/background colour in the rendition mask with the
592specified one. 947specified one.
593</dd> 948</dd>
594<p></p> 949<p></p>
… …
628</dd> 983</dd>
629<dd> 984<dd>
630<p>Croaks (and probably outputs an error message) if the new instance 985<p>Croaks (and probably outputs an error message) if the new instance
631couldn't be created. Returns <code>undef</code> if the new instance didn't 986couldn't be created. Returns <code>undef</code> if the new instance didn't
632initialise perl, and the terminal object otherwise. The <code>init</code> and 987initialise perl, and the terminal object otherwise. The <code>init</code> and
633<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 988<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
989refer to global data (which is race free).</p>
634</dd> 990</dd>
635<p></p> 991<p></p>
636<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 992<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
637</dt> 993</dt>
638<dd> 994<dd>
639Destroy the terminal object (close the window, free resources 995Destroy the terminal object (close the window, free resources
640etc.). Please note that rxvt will not exit as long as any event 996etc.). Please note that rxvt will not exit as long as any event
641watchers (timers, io watchers) are still active. 997watchers (timers, io watchers) are still active.
642</dd> 998</dd>
643<p></p> 999<p></p>
1000<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
1001</dt>
1002<dd>
1003Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
1004(``starts'') programs in the background. This function takes care of setting
1005the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
1006be preferred over explicit calls to <code>exec</code> or <code>system</code>.
1007</dd>
1008<dd>
1009<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
1010</dd>
1011<p></p>
644<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 1012<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
645</dt> 1013</dt>
646<dd> 1014<dd>
647Returns true if the option specified by <code>$optval</code> is enabled, and 1015Returns true if the option specified by <code>$optval</code> is enabled, and
648optionally change it. All option values are stored by name in the hash 1016optionally change it. All option values are stored by name in the hash
… …
654</dd> 1022</dd>
655<dd> 1023<dd>
656<pre> 1024<pre>
657 borderLess console cursorBlink cursorUnderline hold iconic insecure 1025 borderLess console cursorBlink cursorUnderline hold iconic insecure
658 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1026 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
659 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1027 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
660 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1028 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
661 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1029 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
662 tripleclickwords utmpInhibit visualBell</pre> 1030 transparent tripleclickwords utmpInhibit visualBell</pre>
663</dd> 1031</dd>
664<p></p> 1032<p></p>
665<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 1033<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
666</dt> 1034</dt>
667<dd> 1035<dd>
… …
692<pre> 1060<pre>
693 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1061 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
694 borderLess color cursorBlink cursorUnderline cutchars delete_key 1062 borderLess color cursorBlink cursorUnderline cutchars delete_key
695 display_name embed ext_bwidth fade font geometry hold iconName 1063 display_name embed ext_bwidth fade font geometry hold iconName
696 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1064 imFont imLocale inputMethod insecure int_bwidth intensityStyles
697 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1065 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
698 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1066 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
699 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1067 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
700 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1068 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
701 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1069 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
702 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1070 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
703 shade term_name title transparent transparent_all tripleclickwords 1071 secondaryScreen secondaryScroll selectstyle shade term_name title
1072 transient_for transparent transparent_all tripleclickwords utmpInhibit
704 utmpInhibit visualBell</pre> 1073 visualBell</pre>
705</dd> 1074</dd>
706<p></p> 1075<p></p>
707<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 1076<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
708</dt> 1077</dt>
709<dd> 1078<dd>
… …
884<p>Normally its not a good idea to use this function, as programs might be 1253<p>Normally its not a good idea to use this function, as programs might be
885confused by changes in cursor position or scrolling. Its useful inside a 1254confused by changes in cursor position or scrolling. Its useful inside a
886<code>on_add_lines</code> hook, though.</p> 1255<code>on_add_lines</code> hook, though.</p>
887</dd> 1256</dd>
888<p></p> 1257<p></p>
1258<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1259</dt>
1260<dd>
1261Switch to given screen - 0 primary, 1 secondary.
1262</dd>
1263<p></p>
889<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1264<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
890</dt> 1265</dt>
891<dd> 1266<dd>
892Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1267Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
893locale-specific encoding of the terminal and can contain command sequences 1268locale-specific encoding of the terminal and can contain command sequences
… …
909be used to suppress input and output handling to the pty/tty. See the 1284be used to suppress input and output handling to the pty/tty. See the
910description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1285description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
911the previous value. 1286the previous value.
912</dd> 1287</dd>
913<p></p> 1288<p></p>
1289<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1290</dt>
1291<dd>
1292Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1293is used.
1294</dd>
1295<p></p>
914<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1296<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
915</dt> 1297</dt>
916<dd> 1298<dd>
917Return the window id of the toplevel window. 1299Return the window id of the toplevel window.
918</dd> 1300</dd>
… …
921</dt> 1303</dt>
922<dd> 1304<dd>
923Return the window id of the terminal window. 1305Return the window id of the terminal window.
924</dd> 1306</dd>
925<p></p> 1307<p></p>
1308<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1309</dt>
1310<dd>
1311Adds the specified events to the vt event mask. Useful e.g. when you want
1312to receive pointer events all the times:
1313</dd>
1314<dd>
1315<pre>
1316 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1317</dd>
1318<p></p>
1319<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1320</dt>
1321<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1322</dt>
1323<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1324</dt>
1325<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1326</dt>
1327<dd>
1328Deliver various fake events to to terminal.
1329</dd>
1330<p></p>
926<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1331<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
927</dt> 1332</dt>
928<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1333<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
929</dt> 1334</dt>
930<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1335<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
943</dt> 1348</dt>
944<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1349<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
945</dt> 1350</dt>
946<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1351<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
947</dt> 1352</dt>
948<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1353<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
949</dt> 1354</dt>
950<dd> 1355<dd>
951Return various integers describing terminal characteristics. 1356Return various integers describing terminal characteristics.
952</dd> 1357</dd>
953<p></p> 1358<p></p>
… …
979<dd> 1384<dd>
980Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1385Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
981AltGr), the meta key (often Alt) and the num lock key, if applicable. 1386AltGr), the meta key (often Alt) and the num lock key, if applicable.
982</dd> 1387</dd>
983<p></p> 1388<p></p>
1389<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1390</dt>
1391<dd>
1392Returns the currently displayed screen (0 primary, 1 secondary).
1393</dd>
1394<p></p>
1395<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1396</dt>
1397<dd>
1398Returns wether the cursor is currently hidden or not.
1399</dd>
1400<p></p>
984<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1401<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
985</dt> 1402</dt>
986<dd> 1403<dd>
987Returns the negative row number of the topmost line. Minimum value is 1404Returns the row number of the topmost displayed line. Maximum value is
988<code>0</code>, which displays the normal terminal contents. Larger values scroll 1405<code>0</code>, which displays the normal terminal contents. Lower values scroll
989this many lines into the scrollback buffer. 1406this many lines into the scrollback buffer.
990</dd> 1407</dd>
991<p></p> 1408<p></p>
992<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1409<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
993</dt> 1410</dt>
… …
1004</dt> 1421</dt>
1005<dd> 1422<dd>
1006Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1423Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1007is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1424is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1008terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1425terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1009line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1426line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1010is requested. 1427is requested.
1011</dd> 1428</dd>
1012<dd> 1429<dd>
1013<p>If <code>$new_text</code> is specified, it will replace characters in the current 1430<p>If <code>$new_text</code> is specified, it will replace characters in the current
1014line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1431line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1015to replace only parts of a line. The font index in the rendition will 1432to replace only parts of a line. The font index in the rendition will
1016automatically be updated.</p> 1433automatically be updated.</p>
1017</dd> 1434</dd>
1018<dd> 1435<dd>
1019<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1436<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1020than one cell when displayed are padded with urxvt::NOCHAR characters 1437than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1021(<code>chr 65535</code>). Characters with combining characters and other characters 1438characters. Characters with combining characters and other characters that
1022that do not fit into the normal tetx encoding will be replaced with 1439do not fit into the normal tetx encoding will be replaced with characters
1023characters in the private use area.</p> 1440in the private use area.</p>
1024</dd> 1441</dd>
1025<dd> 1442<dd>
1026<p>You have to obey this encoding when changing text. The advantage is 1443<p>You have to obey this encoding when changing text. The advantage is
1027that <code>substr</code> and similar functions work on screen cells and not on 1444that <code>substr</code> and similar functions work on screen cells and not on
1028characters.</p> 1445characters.</p>
… …
1124<dd> 1541<dd>
1125Converts rxvt-unicodes text reprsentation into a perl string. See 1542Converts rxvt-unicodes text reprsentation into a perl string. See
1126<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1543<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1127</dd> 1544</dd>
1128<p></p> 1545<p></p>
1129<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1546<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1130</dt> 1547</dt>
1548<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1549</dt>
1131<dd> 1550<dd>
1132Registers a synchronous button grab. See the XGrabButton manpage. 1551Register/unregister a synchronous button grab. See the XGrabButton
1552manpage.
1133</dd> 1553</dd>
1134<p></p> 1554<p></p>
1135<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1555<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1136</dt> 1556</dt>
1137<dd> 1557<dd>
… …
1162</dt> 1582</dt>
1163<dd> 1583<dd>
1164Calls XUngrab for the most recent grab. Is called automatically on 1584Calls XUngrab for the most recent grab. Is called automatically on
1165evaluation errors, as it is better to lose the grab in the error case as 1585evaluation errors, as it is better to lose the grab in the error case as
1166the session. 1586the session.
1587</dd>
1588<p></p>
1589<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1590</dt>
1591<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1592</dt>
1593<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1594</dt>
1595<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1596</dt>
1597<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1598</dt>
1599<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1600</dt>
1601<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1602</dt>
1603<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1604</dt>
1605<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1606</dt>
1607<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1608</dt>
1609<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1610</dt>
1611<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1612</dt>
1613<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1614</dt>
1615<dd>
1616Various X or X-related functions. The <code>$term</code> object only serves as
1617the source of the display, otherwise those functions map more-or-less
1618directory onto the X functions of the same name.
1167</dd> 1619</dd>
1168<p></p></dl> 1620<p></p></dl>
1169<p> 1621<p>
1170</p> 1622</p>
1171<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1623<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
… …
1259<p></p> 1711<p></p>
1260<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1712<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1261</dt> 1713</dt>
1262<dd> 1714<dd>
1263Set the event trigger time to <code>$tstamp</code> and start the timer. 1715Set the event trigger time to <code>$tstamp</code> and start the timer.
1716</dd>
1717<p></p>
1718<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1719</dt>
1720<dd>
1721Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1264</dd> 1722</dd>
1265<p></p> 1723<p></p>
1266<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1724<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1267</dt> 1725</dt>
1268<dd> 1726<dd>
… …
1326Stop watching for events on the given filehandle. 1784Stop watching for events on the given filehandle.
1327</dd> 1785</dd>
1328<p></p></dl> 1786<p></p></dl>
1329<p> 1787<p>
1330</p> 1788</p>
1789<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1790<p>This class implements idle watchers, that get called automatically when
1791the process is idle. They should return as fast as possible, after doing
1792some useful work.</p>
1793<dl>
1794<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1795</dt>
1796<dd>
1797Create a new idle watcher object in stopped state.
1798</dd>
1799<p></p>
1800<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1801</dt>
1802<dd>
1803Set the callback to be called when the watcher triggers.
1804</dd>
1805<p></p>
1806<dt><strong>$timer = $timer-&gt;start</strong><br />
1807</dt>
1808<dd>
1809Start the watcher.
1810</dd>
1811<p></p>
1812<dt><strong>$timer = $timer-&gt;stop</strong><br />
1813</dt>
1814<dd>
1815Stop the watcher.
1816</dd>
1817<p></p></dl>
1818<p>
1819</p>
1820<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1821<p>This class implements process watchers. They create an event whenever a
1822process exits, after which they stop automatically.</p>
1823<pre>
1824 my $pid = fork;
1825 ...
1826 $term-&gt;{pw} = urxvt::pw
1827 -&gt;new
1828 -&gt;start ($pid)
1829 -&gt;cb (sub {
1830 my ($pw, $exit_status) = @_;
1831 ...
1832 });</pre>
1833<dl>
1834<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1835</dt>
1836<dd>
1837Create a new process watcher in stopped state.
1838</dd>
1839<p></p>
1840<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1841</dt>
1842<dd>
1843Set the callback to be called when the timer triggers.
1844</dd>
1845<p></p>
1846<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1847</dt>
1848<dd>
1849Tells the wqtcher to start watching for process <code>$pid</code>.
1850</dd>
1851<p></p>
1852<dt><strong>$pw = $pw-&gt;stop</strong><br />
1853</dt>
1854<dd>
1855Stop the watcher.
1856</dd>
1857<p></p></dl>
1858<p>
1859</p>
1331<hr /> 1860<hr />
1332<h1><a name="environment">ENVIRONMENT</a></h1> 1861<h1><a name="environment">ENVIRONMENT</a></h1>
1333<p> 1862<p>
1334</p> 1863</p>
1335<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1864<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>

Diff Legend

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