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.20 by root, Tue Jan 10 18:09:22 2006 UTC vs.
Revision 1.40 by root, Sun Jan 29 21:45:47 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
90when the user extends selections (double-click). Right now, it tries to 95when the user extends selections (double-click and further clicks). Right
91select urls and complete shell-quoted arguments, which is very convenient, 96now, it tries to select words, urls and complete shell-quoted
92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. 97arguments, which is very convenient, too, if your <em>ls</em> supports
93</dd> 98<code>--quoting-style=shell</code>.
94<dd> 99</dd>
100<dd>
101<p>A double-click usually selects the word under the cursor, further clicks
102will enlarge the selection.</p>
103</dd>
104<dd>
105<p>The selection works by trying to match a number of regexes and displaying
106them in increasing order of length. You can add your own regexes by
107specifying resources of the form:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.selection.pattern-0: perl-regex
112 URxvt.selection.pattern-1: perl-regex
113 ...</pre>
114</dd>
115<dd>
116<p>The index number (0, 1...) must not have any holes, and each regex must
117contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything
119between two vertical bars:</p>
120</dd>
121<dd>
122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd>
125<dd>
126<p>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>
95<p>It also offers the following bindable keyboard command:</p> 140<p>This extension also offers following bindable keyboard commands:</p>
96</dd> 141</dd>
97<dl> 142<dl>
98<dt><strong><a name="item_rot13">rot13</a></strong><br /> 143<dt><strong><a name="item_rot13">rot13</a></strong><br />
99</dt> 144</dt>
100<dd> 145<dd>
115<dt><strong>selection-popup (enabled by default)</strong><br /> 160<dt><strong>selection-popup (enabled by default)</strong><br />
116</dt> 161</dt>
117<dd> 162<dd>
118Binds 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
119text into various other formats/action (such as uri unescaping, perl 164text into various other formats/action (such as uri unescaping, perl
120evalution, 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>
121</dd> 190</dd>
122<p></p> 191<p></p>
123<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 />
124</dt> 193</dt>
125<dd> 194<dd>
126Adds regex search functionality to the scrollback buffer, triggered 195Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal 196by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
128input/output is suspended. 197input/output is suspended and a regex is displayed at the bottom of the
129</dd> 198screen.
130<dd> 199</dd>
131<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
132<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns to the original position.</p>
135</dd> 200<dd>
136<p></p> 201<p>Inputting characters appends them to the regex and continues incremental
137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 202search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
138</dt> 203search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
204bottom. <code>Escape</code> leaves search mode and returns to the point where search
205was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
206additionally stores the first match in the current line into the primary
207selection.</p>
139<dd> 208</dd>
140Displays a digital clock using the built-in overlay. 209<p></p>
210<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
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).
218</dd>
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>
141</dd> 297</dd>
142<p></p> 298<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 299<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt> 300</dt>
145<dd> 301<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 302Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
303make them clickable. When middle-clicked, the program specified in the
304resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
305the URL as first argument.
306</dd>
307<p></p>
308<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
309</dt>
310<dd>
311This (experimental) perl extension implements OnTheSpot editing. It does
312not work perfectly, and some input methods don't seem to work well with
313OnTheSpot editing in general, but it seems to work at leats for SCIM and
314kinput2.
315</dd>
316<dd>
317<p>You enable it by specifying this extension and a preedit style of
318<code>OnTheSpot</code>, i.e.:</p>
319</dd>
320<dd>
321<pre>
322 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
323</dd>
324<p></p>
325<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
326</dt>
327<dd>
328This is basically a one-line extension that dynamically changes the background pixmap offset
329to the window position, in effect creating the same effect as pseudo transparency with
330a custom pixmap. No scaling is supported in this mode. Exmaple:
331</dd>
332<dd>
333<pre>
334 rxvt -pixmap background.xpm -pe automove-background</pre>
147</dd> 335</dd>
148<p></p> 336<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 337<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt> 338</dt>
151<dd> 339<dd>
152A not very useful example of filtering all text output to the terminal, 340A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 341by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 342similar-looking ascii character.
343</dd>
344<p></p>
345<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
346</dt>
347<dd>
348Displays a digital clock using the built-in overlay.
349</dd>
350<p></p>
351<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
352</dt>
353<dd>
354Somewhat of a misnomer, this extension adds two menu entries to the
355selection popup that allows one ti run external commands to store the
356selection somewhere and fetch it again.
357</dd>
358<dd>
359<p>We use it to implement a ``distributed selection mechanism'', which just
360means that one command uploads the file to a remote server, and another
361reads it.</p>
362</dd>
363<dd>
364<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
365<code>URxvt.remote-selection.fetch</code> resources. The first should read the
366selection to store from STDIN (always in UTF-8), the second should provide
367the selection data on STDOUT (also in UTF-8).</p>
368</dd>
369<dd>
370<p>The defaults (which are likely useless to you) use rsh and cat:</p>
371</dd>
372<dd>
373<pre>
374 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
375 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
376</dd>
377<p></p>
378<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
379</dt>
380<dd>
381This is a little rarely useful extension that Uploads the selection as
382textfile to a remote site (or does other things). (The implementation is
383not currently secure for use in a multiuser environment as it writes to
384<em>/tmp</em> directly.).
385</dd>
386<dd>
387<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
388i.e.</p>
389</dd>
390<dd>
391<pre>
392 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
393</dd>
394<dd>
395<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
396the textfile. This command can be set via a resource:</p>
397</dd>
398<dd>
399<pre>
400 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
401</dd>
402<dd>
403<p>And the default is likely not useful to anybody but the few people around
404here :)</p>
405</dd>
406<dd>
407<p>The name of the textfile is the hex encoded md5 sum of the selection, so
408the same content should lead to the same filename.</p>
409</dd>
410<dd>
411<p>After a successful upload the selection will be replaced by the text given
412in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
413for the filename):</p>
414</dd>
415<dd>
416<pre>
417 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
155</dd> 418</dd>
156<p></p> 419<p></p>
157<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 420<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
158</dt> 421</dt>
159<dd> 422<dd>
183<dl> 446<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br /> 447<dt><strong><a name="item__24text">$text</a></strong><br />
185</dt> 448</dt>
186<dd> 449<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 450Rxvt-unicodes special way of encoding text, where one ``unicode'' character
188always represents one screen cell. See <em>row_t</em> for a discussion of this format. 451always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
189</dd> 452</dd>
190<p></p> 453<p></p>
191<dt><strong><a name="item__24string">$string</a></strong><br /> 454<dt><strong><a name="item__24string">$string</a></strong><br />
192</dt> 455</dt>
193<dd> 456<dd>
242<h2><a name="hooks">Hooks</a></h2> 505<h2><a name="hooks">Hooks</a></h2>
243<p>The following subroutines can be declared in extension files, and will be 506<p>The following subroutines can be declared in extension files, and will be
244called whenever the relevant event happens.</p> 507called whenever the relevant event happens.</p>
245<p>The first argument passed to them is an extension oject as described in 508<p>The first argument passed to them is an extension oject as described in
246the in the <code>Extension Objects</code> section.</p> 509the in the <code>Extension Objects</code> section.</p>
247<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the 510<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
248event counts as being <em>consumed</em>, and the invocation of other hooks is 511hooks returns true, then the event counts as being <em>consumed</em>, and the
249skipped, and the relevant action might not be carried out by the C++ code.</p> 512relevant action might not be carried out by the C++ code.</p>
250<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 513<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
251<dl> 514<dl>
252<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 515<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
253</dt> 516</dt>
254<dd> 517<dd>
255Called after a new terminal object has been initialized, but before 518Called after a new terminal object has been initialized, but before
256windows are created or the command gets run. Most methods are unsafe to 519windows are created or the command gets run. Most methods are unsafe to
257call or deliver senseless data, as terminal size and other characteristics 520call or deliver senseless data, as terminal size and other characteristics
258have not yet been determined. You can safely query and change resources, 521have not yet been determined. You can safely query and change resources
259though. 522and options, though. For many purposes the <code>on_start</code> hook is a better
523place.
524</dd>
525<p></p>
526<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
527</dt>
528<dd>
529Called at the very end of initialisation of a new terminal, just before
530trying to map (display) the toplevel and returning to the mainloop.
531</dd>
532<p></p>
533<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
534</dt>
535<dd>
536Called whenever something tries to destroy terminal, when the terminal is
537still fully functional (not for long, though).
260</dd> 538</dd>
261<p></p> 539<p></p>
262<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 540<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
263</dt> 541</dt>
264<dd> 542<dd>
265Called after the screen is ``reset'' for any reason, such as resizing or 543Called after the screen is ``reset'' for any reason, such as resizing or
266control sequences. Here is where you can react on changes to size-related 544control sequences. Here is where you can react on changes to size-related
267variables. 545variables.
268</dd> 546</dd>
269<p></p> 547<p></p>
270<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 548<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
271</dt> 549</dt>
550<dd>
551Called just after the child process has been <code>fork</code>ed.
272<dd> 552</dd>
273Called at the very end of initialisation of a new terminal, just before 553<p></p>
274returning to the mainloop. 554<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
555</dt>
556<dd>
557Called just after the child process has exited. <code>$status</code> is the status
558from <code>waitpid</code>.
275</dd> 559</dd>
276<p></p> 560<p></p>
277<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 561<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
278</dt> 562</dt>
279<dd> 563<dd>
301</dt> 585</dt>
302<dd> 586<dd>
303Called whenever the user tries to extend the selection (e.g. with a double 587Called whenever the user tries to extend the selection (e.g. with a double
304click) and is either supposed to return false (normal operation), or 588click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 589should extend the selection itelf and return true to suppress the built-in
306processing. 590processing. This can happen multiple times, as long as the callback
591returns true, it will be called on every further click by the user and is
592supposed to enlarge the selection more and more, if possible.
307</dd> 593</dd>
308<dd> 594<dd>
309<p>See the <em>selection</em> example extension.</p> 595<p>See the <em>selection</em> example extension.</p>
310</dd> 596</dd>
311<p></p> 597<p></p>
394</dt> 680</dt>
395<dd> 681<dd>
396Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 682Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
397</dd> 683</dd>
398<p></p> 684<p></p>
399<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 685<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
400</dt> 686</dt>
401<dd> 687<dd>
402Called whenever the user presses a key combination that has a 688Called whenever the a user-configured event is being activated (e.g. via
403<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 689a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
404resource in the <code>rxvt(1)</code> manpage). 690resource in the <code>rxvt(1)</code> manpage).
691</dd>
692<dd>
693<p>The event is simply the action string. This interface is assumed to change
694slightly in the future.</p>
695</dd>
696<p></p>
697<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
698</dt>
699<dd>
700Called on every X event received on the vt window (and possibly other
701windows). Should only be used as a last resort. Most event structure
702members are not passed.
405</dd> 703</dd>
406<p></p> 704<p></p>
407<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 705<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
408</dt> 706</dt>
409<dd> 707<dd>
416<dd> 714<dd>
417Called wheneever the window loses keyboard focus, before rxvt-unicode does 715Called wheneever the window loses keyboard focus, before rxvt-unicode does
418focus out processing. 716focus out processing.
419</dd> 717</dd>
420<p></p> 718<p></p>
719<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
720</dt>
721<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
722</dt>
421<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 723<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
422</dt> 724</dt>
423<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 725<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
424</dt> 726</dt>
425<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 727<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
436Called whenever the corresponding X event is received for the terminal If 738Called whenever the corresponding X event is received for the terminal If
437the hook returns true, then the even will be ignored by rxvt-unicode. 739the hook returns true, then the even will be ignored by rxvt-unicode.
438</dd> 740</dd>
439<dd> 741<dd>
440<p>The event is a hash with most values as named by Xlib (see the XEvent 742<p>The event is a hash with most values as named by Xlib (see the XEvent
441manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 743manpage), with the additional members <code>row</code> and <code>col</code>, which are the
442and column under the mouse cursor.</p> 744(real, not screen-based) row and column under the mouse cursor.</p>
443</dd> 745</dd>
444<dd> 746<dd>
445<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 747<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
446output, if any, in locale-specific encoding.</p> 748output, if any, in locale-specific encoding.</p>
447</dd> 749</dd>
448<dd> 750<dd>
449<p>subwindow.</p> 751<p>subwindow.</p>
450</dd> 752</dd>
753<p></p>
754<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
755</dt>
756<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
757</dt>
758<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
759</dt>
760<dd>
761Called when various types of ClientMessage events are received (all with
762format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
763</dd>
451<p></p></dl> 764<p></p></dl>
452<p> 765<p>
453</p> 766</p>
454<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 767<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
455<dl> 768<dl>
769<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
770</dt>
771<dd>
772The rxvt-unicode library directory, where, among other things, the perl
773modules and scripts are stored.
774</dd>
775<p></p>
776<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
777</dt>
778<dd>
779The resource class and name rxvt-unicode uses to look up X resources.
780</dd>
781<p></p>
782<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
783</dt>
784<dd>
785The basename of the installed binaries, usually <code>urxvt</code>.
786</dd>
787<p></p>
456<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 788<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
457</dt> 789</dt>
458<dd> 790<dd>
459The current terminal. This variable stores the current <code>urxvt::term</code> 791The current terminal. This variable stores the current <code>urxvt::term</code>
460object, whenever a callback/hook is executing. 792object, whenever a callback/hook is executing.
461</dd> 793</dd>
794<p></p>
795<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
796</dt>
797<dd>
798All coderefs in this array will be called as methods of the next newly
799created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
800gets cleared before the codereferences that were in it are being executed,
801so coderefs can push themselves onto it again if they so desire.
802</dd>
803<dd>
804<p>This complements to the perl-eval commandline option, but gets executed
805first.</p>
806</dd>
807<p></p>
808<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
809</dt>
810<dd>
811Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
812get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
813but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
814</dd>
462<p></p></dl> 815<p></p></dl>
463<p> 816<p>
464</p> 817</p>
465<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 818<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
466<dl> 819<dl>
467<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
468</dt>
469<dd>
470Creates a new terminal, very similar as if you had started it with
471<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
472if the new instance couldn't be created. Returns <code>undef</code> if the new
473instance didn't initialise perl, and the terminal object otherwise. The
474<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
475</dd>
476<p></p>
477<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 820<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
478</dt> 821</dt>
479<dd> 822<dd>
480Fatally aborts execution with the given error message. Avoid at all 823Fatally aborts execution with the given error message. Avoid at all
481costs! The only time this is acceptable is when the terminal process 824costs! The only time this is acceptable is when the terminal process
491</dd> 834</dd>
492<dd> 835<dd>
493<p>Using this function has the advantage that its output ends up in the 836<p>Using this function has the advantage that its output ends up in the
494correct place, e.g. on stderr of the connecting urxvtc client.</p> 837correct place, e.g. on stderr of the connecting urxvtc client.</p>
495</dd> 838</dd>
496<p></p> 839<dd>
497<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 840<p>Messages have a size limit of 1023 bytes currently.</p>
498</dt>
499<dd> 841</dd>
500Returns true when it is safe to do potentially unsafe things, such as 842<p></p>
501evaluating perl code specified by the user. This is true when urxvt was 843<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
502started setuid or setgid. 844</dt>
845<dd>
846Returns all urxvt::term objects that exist in this process, regardless of
847wether they are started, being destroyed etc., so be careful. Only term
848objects that have perl extensions attached will be returned (because there
849is no urxvt::term objet associated with others).
503</dd> 850</dd>
504<p></p> 851<p></p>
505<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 852<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
506</dt> 853</dt>
507<dd> 854<dd>
511<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 858<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
512</dt> 859</dt>
513<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 860<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
514Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 861Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
515Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 862Button4Mask, Button5Mask, AnyModifier</a></strong><br />
863</dt>
864<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
865ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
866PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
867Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
868KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
869ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
870FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
871</dt>
872<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
873EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
874GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
875UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
876ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
877CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
878SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
516</dt> 879</dt>
517<dd> 880<dd>
518Various constants for use in X calls and event processing. 881Various constants for use in X calls and event processing.
519</dd> 882</dd>
520<p></p></dl> 883<p></p></dl>
555</dt> 918</dt>
556<dd> 919<dd>
557Return the foreground/background colour index, respectively. 920Return the foreground/background colour index, respectively.
558</dd> 921</dd>
559<p></p> 922<p></p>
560<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 923<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
561</dt> 924</dt>
562<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 925<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
563</dt> 926</dt>
564<dd> 927<dd>
565Replace the foreground/background colour in the rendition mask with the 928Replace the foreground/background colour in the rendition mask with the
566specified one. 929specified one.
567</dd> 930</dd>
568<p></p> 931<p></p>
569<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 932<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
570</dt> 933</dt>
571<dd> 934<dd>
572Return the ``custom'' value: Every rendition has 5 bits for use by 935Return the ``custom'' value: Every rendition has 5 bits for use by
573extensions. They can be set and changed as you like and are initially 936extensions. They can be set and changed as you like and are initially
574zero. 937zero.
575</dd> 938</dd>
576<p></p> 939<p></p>
577<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 940<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
578</dt> 941</dt>
579<dd> 942<dd>
580Change the custom value. 943Change the custom value.
581</dd> 944</dd>
582<p></p></dl> 945<p></p></dl>
583<p> 946<p>
584</p> 947</p>
585<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 948<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
586<p>The sole purpose of this class is to deliver an interface to the 949<p>The sole purpose of this class is to deliver an interface to the
587<code>AnyEvent</code> module - any module using it will work inside urxvt without 950<code>AnyEvent</code> module - any module using it will work inside urxvt without
588further work. The only exception is that you cannot wait on condition 951further programming. The only exception is that you cannot wait on
589variables, but non-blocking condvar use is ok. What this means is that you 952condition variables, but non-blocking condvar use is ok. What this means
590cannot use blocking APIs, but the non-blocking variant should work.</p> 953is that you cannot use blocking APIs, but the non-blocking variant should
954work.</p>
591<p> 955<p>
592</p> 956</p>
593<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 957<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
594<dl> 958<dl>
959<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
960</dt>
961<dd>
962Creates a new terminal, very similar as if you had started it with system
963<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
964hash which defines the environment of the new terminal.
965</dd>
966<dd>
967<p>Croaks (and probably outputs an error message) if the new instance
968couldn't be created. Returns <code>undef</code> if the new instance didn't
969initialise perl, and the terminal object otherwise. The <code>init</code> and
970<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
971refer to global data (which is race free).</p>
972</dd>
973<p></p>
595<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 974<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
596</dt> 975</dt>
597<dd> 976<dd>
598Destroy the terminal object (close the window, free resources etc.). 977Destroy the terminal object (close the window, free resources
978etc.). Please note that rxvt will not exit as long as any event
979watchers (timers, io watchers) are still active.
980</dd>
981<p></p>
982<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
983</dt>
984<dd>
985Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
986(``starts'') programs in the background. This function takes care of setting
987the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
988be preferred over explicit calls to <code>exec</code> or <code>system</code>.
989</dd>
990<dd>
991<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
599</dd> 992</dd>
600<p></p> 993<p></p>
601<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 994<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
602</dt> 995</dt>
603<dd> 996<dd>
611</dd> 1004</dd>
612<dd> 1005<dd>
613<pre> 1006<pre>
614 borderLess console cursorBlink cursorUnderline hold iconic insecure 1007 borderLess console cursorBlink cursorUnderline hold iconic insecure
615 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1008 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
616 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1009 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
617 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1010 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
618 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1011 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
619 tripleclickwords utmpInhibit visualBell</pre> 1012 transparent tripleclickwords utmpInhibit visualBell</pre>
620</dd> 1013</dd>
621<p></p> 1014<p></p>
622<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 1015<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
623</dt> 1016</dt>
624<dd> 1017<dd>
649<pre> 1042<pre>
650 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1043 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
651 borderLess color cursorBlink cursorUnderline cutchars delete_key 1044 borderLess color cursorBlink cursorUnderline cutchars delete_key
652 display_name embed ext_bwidth fade font geometry hold iconName 1045 display_name embed ext_bwidth fade font geometry hold iconName
653 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1046 imFont imLocale inputMethod insecure int_bwidth intensityStyles
654 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1047 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
655 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1048 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
656 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1049 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
657 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1050 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
658 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1051 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
659 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1052 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
660 shade term_name title transparent transparent_all tripleclickwords 1053 secondaryScreen secondaryScroll selectstyle shade term_name title
1054 transient_for transparent transparent_all tripleclickwords utmpInhibit
661 utmpInhibit visualBell</pre> 1055 visualBell</pre>
1056</dd>
1057<p></p>
1058<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1059</dt>
1060<dd>
1061Returns the X-Resource for the given pattern, excluding the program or
1062class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
1063same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1064resource with that pattern exists.
1065</dd>
1066<dd>
1067<p>This method should only be called during the <code>on_start</code> hook, as there is
1068only one resource database per display, and later invocations might return
1069the wrong resources.</p>
662</dd> 1070</dd>
663<p></p> 1071<p></p>
664<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 1072<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
665</dt> 1073</dt>
666<dd> 1074<dd>
691<dd> 1099<dd>
692Return the current values of the selection mark, begin or end positions, 1100Return the current values of the selection mark, begin or end positions,
693and optionally set them to new values. 1101and optionally set them to new values.
694</dd> 1102</dd>
695<p></p> 1103<p></p>
1104<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1105</dt>
1106<dd>
1107Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1108<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1109rectangular selection will be made. This is the prefered function to make
1110a selection.
1111</dd>
1112<p></p>
696<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1113<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
697</dt> 1114</dt>
698<dd> 1115<dd>
699Try to request the primary selection from the server (for example, as set 1116Try to request the primary selection text from the server (for example, as
700by the next method). 1117set by the next method). No visual feedback will be given. This function
1118is mostly useful from within <code>on_sel_grab</code> hooks.
701</dd> 1119</dd>
702<p></p> 1120<p></p>
703<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1121<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
704</dt> 1122</dt>
705<dd> 1123<dd>
784<p></p> 1202<p></p>
785<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> 1203<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
786</dt> 1204</dt>
787<dd> 1205<dd>
788XORs the rendition values in the given span with the provided value 1206XORs the rendition values in the given span with the provided value
789(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar 1207(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
790to the selection. 1208refresh hooks to provide effects similar to the selection.
791</dd> 1209</dd>
792<p></p> 1210<p></p>
793<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br /> 1211<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
794</dt> 1212</dt>
795<dd> 1213<dd>
796Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 1214Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
797whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 1215whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
798to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 1216to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
799it instead. 1217it instead. Both styles <em>MUST NOT</em> contain font styles.
800</dd> 1218</dd>
801<p></p> 1219<p></p>
802<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 1220<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
803</dt> 1221</dt>
804<dd> 1222<dd>
817<p>Normally its not a good idea to use this function, as programs might be 1235<p>Normally its not a good idea to use this function, as programs might be
818confused by changes in cursor position or scrolling. Its useful inside a 1236confused by changes in cursor position or scrolling. Its useful inside a
819<code>on_add_lines</code> hook, though.</p> 1237<code>on_add_lines</code> hook, though.</p>
820</dd> 1238</dd>
821<p></p> 1239<p></p>
1240<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1241</dt>
1242<dd>
1243Switch to given screen - 0 primary, 1 secondary.
1244</dd>
1245<p></p>
822<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1246<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
823</dt> 1247</dt>
824<dd> 1248<dd>
825Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1249Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
826locale-specific encoding of the terminal and can contain command sequences 1250locale-specific encoding of the terminal and can contain command sequences
842be used to suppress input and output handling to the pty/tty. See the 1266be used to suppress input and output handling to the pty/tty. See the
843description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1267description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
844the previous value. 1268the previous value.
845</dd> 1269</dd>
846<p></p> 1270<p></p>
1271<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1272</dt>
1273<dd>
1274Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1275is used.
1276</dd>
1277<p></p>
847<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1278<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
848</dt> 1279</dt>
849<dd> 1280<dd>
850Return the window id of the toplevel window. 1281Return the window id of the toplevel window.
851</dd> 1282</dd>
854</dt> 1285</dt>
855<dd> 1286<dd>
856Return the window id of the terminal window. 1287Return the window id of the terminal window.
857</dd> 1288</dd>
858<p></p> 1289<p></p>
1290<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1291</dt>
1292<dd>
1293Adds the specified events to the vt event mask. Useful e.g. when you want
1294to receive pointer events all the times:
1295</dd>
1296<dd>
1297<pre>
1298 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1299</dd>
1300<p></p>
859<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1301<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
860</dt> 1302</dt>
861<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1303<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
862</dt> 1304</dt>
863<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1305<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
876</dt> 1318</dt>
877<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1319<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
878</dt> 1320</dt>
879<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1321<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
880</dt> 1322</dt>
881<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1323<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
882</dt> 1324</dt>
883<dd> 1325<dd>
884Return various integers describing terminal characteristics. 1326Return various integers describing terminal characteristics.
885</dd> 1327</dd>
886<p></p> 1328<p></p>
1329<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1330</dt>
1331<dd>
1332Return the DISPLAY used by rxvt-unicode.
1333</dd>
1334<p></p>
887<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 1335<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
888</dt> 1336</dt>
889<dd> 1337<dd>
890Returns the LC_CTYPE category string used by this rxvt-unicode. 1338Returns the LC_CTYPE category string used by this rxvt-unicode.
891</dd> 1339</dd>
892<p></p> 1340<p></p>
893<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 1341<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
894</dt> 1342</dt>
895<dd> 1343<dd>
896Return the DISPLAY used by rxvt-unicode. 1344Returns a copy of the environment in effect for the terminal as a hashref
1345similar to <code>\%ENV</code>.
897</dd> 1346</dd>
898<p></p> 1347<p></p>
899<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1348<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
900</dt> 1349</dt>
901<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1350<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
905<dd> 1354<dd>
906Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1355Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
907AltGr), the meta key (often Alt) and the num lock key, if applicable. 1356AltGr), the meta key (often Alt) and the num lock key, if applicable.
908</dd> 1357</dd>
909<p></p> 1358<p></p>
1359<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1360</dt>
1361<dd>
1362Returns the currently displayed screen (0 primary, 1 secondary).
1363</dd>
1364<p></p>
1365<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1366</dt>
1367<dd>
1368Returns wether the cursor is currently hidden or not.
1369</dd>
1370<p></p>
910<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1371<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
911</dt> 1372</dt>
912<dd> 1373<dd>
913Returns the negative row number of the topmost line. Minimum value is 1374Returns the row number of the topmost displayed line. Maximum value is
914<code>0</code>, which displays the normal terminal contents. Larger values scroll 1375<code>0</code>, which displays the normal terminal contents. Lower values scroll
915this many lines into the scrollback buffer. 1376this many lines into the scrollback buffer.
916</dd> 1377</dd>
917<p></p> 1378<p></p>
918<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1379<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
919</dt> 1380</dt>
930</dt> 1391</dt>
931<dd> 1392<dd>
932Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1393Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
933is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1394is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
934terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1395terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
935line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1396line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
936is requested. 1397is requested.
937</dd> 1398</dd>
938<dd> 1399<dd>
939<p>If <code>$new_text</code> is specified, it will replace characters in the current 1400<p>If <code>$new_text</code> is specified, it will replace characters in the current
940line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1401line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
941to replace only parts of a line. The font index in the rendition will 1402to replace only parts of a line. The font index in the rendition will
942automatically be updated.</p> 1403automatically be updated.</p>
943</dd> 1404</dd>
944<dd> 1405<dd>
945<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1406<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
946than one cell when displayed are padded with urxvt::NOCHAR characters 1407than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
947(<code>chr 65535</code>). Characters with combining characters and other characters 1408characters. Characters with combining characters and other characters that
948that do not fit into the normal tetx encoding will be replaced with 1409do not fit into the normal tetx encoding will be replaced with characters
949characters in the private use area.</p> 1410in the private use area.</p>
950</dd> 1411</dd>
951<dd> 1412<dd>
952<p>You have to obey this encoding when changing text. The advantage is 1413<p>You have to obey this encoding when changing text. The advantage is
953that <code>substr</code> and similar functions work on screen cells and not on 1414that <code>substr</code> and similar functions work on screen cells and not on
954characters.</p> 1415characters.</p>
1025<p></p> 1486<p></p>
1026<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1487<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1027</dt> 1488</dt>
1028<dd> 1489<dd>
1029Returns the character offset of the given row|col pair within the logical 1490Returns the character offset of the given row|col pair within the logical
1030line. 1491line. Works for rows outside the line, too, and returns corresponding
1492offsets outside the string.
1031</dd> 1493</dd>
1032<p></p> 1494<p></p>
1033<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1495<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1034</dt> 1496</dt>
1035<dd> 1497<dd>
1049<dd> 1511<dd>
1050Converts rxvt-unicodes text reprsentation into a perl string. See 1512Converts rxvt-unicodes text reprsentation into a perl string. See
1051<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1513<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1052</dd> 1514</dd>
1053<p></p> 1515<p></p>
1054<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1516<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1055</dt> 1517</dt>
1518<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1519</dt>
1056<dd> 1520<dd>
1057Registers a synchronous button grab. See the XGrabButton manpage. 1521Register/unregister a synchronous button grab. See the XGrabButton
1522manpage.
1058</dd> 1523</dd>
1059<p></p> 1524<p></p>
1060<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1525<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1061</dt> 1526</dt>
1062<dd> 1527<dd>
1088<dd> 1553<dd>
1089Calls XUngrab for the most recent grab. Is called automatically on 1554Calls XUngrab for the most recent grab. Is called automatically on
1090evaluation errors, as it is better to lose the grab in the error case as 1555evaluation errors, as it is better to lose the grab in the error case as
1091the session. 1556the session.
1092</dd> 1557</dd>
1558<p></p>
1559<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1560</dt>
1561<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1562</dt>
1563<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1564</dt>
1565<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1566</dt>
1567<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1568</dt>
1569<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1570</dt>
1571<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1572</dt>
1573<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1574</dt>
1575<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1576</dt>
1577<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1578</dt>
1579<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1580</dt>
1581<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1582</dt>
1583<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1584</dt>
1585<dd>
1586Various X or X-related functions. The <code>$term</code> object only serves as
1587the source of the display, otherwise those functions map more-or-less
1588directory onto the X functions of the same name.
1589</dd>
1093<p></p></dl> 1590<p></p></dl>
1094<p> 1591<p>
1095</p> 1592</p>
1096<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1593<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1594<dl>
1595<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1596</dt>
1597<dd>
1598Adds a non-clickable title to the popup.
1599</dd>
1600<p></p>
1601<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1602</dt>
1603<dd>
1604Creates a separator, optionally using the character given as <code>$sepchr</code>.
1605</dd>
1606<p></p>
1607<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1608</dt>
1609<dd>
1610Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1611selected.
1612</dd>
1613<p></p>
1614<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1615</dt>
1616<dd>
1617Adds a toggle/checkbox item to the popup. Teh callback gets called
1618whenever it gets toggled, with a boolean indicating its value as its first
1619argument.
1620</dd>
1621<p></p>
1622<dt><strong>$popup-&gt;show</strong><br />
1623</dt>
1624<dd>
1625Displays the popup (which is initially hidden).
1626</dd>
1627<p></p></dl>
1097<p> 1628<p>
1098</p> 1629</p>
1099<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1630<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1100<p>This class implements timer watchers/events. Time is represented as a 1631<p>This class implements timer watchers/events. Time is represented as a
1101fractional number of seconds since the epoch. Example:</p> 1632fractional number of seconds since the epoch. Example:</p>
1150<p></p> 1681<p></p>
1151<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1682<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1152</dt> 1683</dt>
1153<dd> 1684<dd>
1154Set the event trigger time to <code>$tstamp</code> and start the timer. 1685Set the event trigger time to <code>$tstamp</code> and start the timer.
1686</dd>
1687<p></p>
1688<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1689</dt>
1690<dd>
1691Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1155</dd> 1692</dd>
1156<p></p> 1693<p></p>
1157<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1694<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1158</dt> 1695</dt>
1159<dd> 1696<dd>
1217Stop watching for events on the given filehandle. 1754Stop watching for events on the given filehandle.
1218</dd> 1755</dd>
1219<p></p></dl> 1756<p></p></dl>
1220<p> 1757<p>
1221</p> 1758</p>
1759<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1760<p>This class implements idle watchers, that get called automatically when
1761the process is idle. They should return as fast as possible, after doing
1762some useful work.</p>
1763<dl>
1764<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1765</dt>
1766<dd>
1767Create a new idle watcher object in stopped state.
1768</dd>
1769<p></p>
1770<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1771</dt>
1772<dd>
1773Set the callback to be called when the watcher triggers.
1774</dd>
1775<p></p>
1776<dt><strong>$timer = $timer-&gt;start</strong><br />
1777</dt>
1778<dd>
1779Start the watcher.
1780</dd>
1781<p></p>
1782<dt><strong>$timer = $timer-&gt;stop</strong><br />
1783</dt>
1784<dd>
1785Stop the watcher.
1786</dd>
1787<p></p></dl>
1788<p>
1789</p>
1790<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1791<p>This class implements process watchers. They create an event whenever a
1792process exits, after which they stop automatically.</p>
1793<pre>
1794 my $pid = fork;
1795 ...
1796 $term-&gt;{pw} = urxvt::pw
1797 -&gt;new
1798 -&gt;start ($pid)
1799 -&gt;cb (sub {
1800 my ($pw, $exit_status) = @_;
1801 ...
1802 });</pre>
1803<dl>
1804<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1805</dt>
1806<dd>
1807Create a new process watcher in stopped state.
1808</dd>
1809<p></p>
1810<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1811</dt>
1812<dd>
1813Set the callback to be called when the timer triggers.
1814</dd>
1815<p></p>
1816<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1817</dt>
1818<dd>
1819Tells the wqtcher to start watching for process <code>$pid</code>.
1820</dd>
1821<p></p>
1822<dt><strong>$pw = $pw-&gt;stop</strong><br />
1823</dt>
1824<dd>
1825Stop the watcher.
1826</dd>
1827<p></p></dl>
1828<p>
1829</p>
1222<hr /> 1830<hr />
1223<h1><a name="environment">ENVIRONMENT</a></h1> 1831<h1><a name="environment">ENVIRONMENT</a></h1>
1224<p> 1832<p>
1225</p> 1833</p>
1226<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1834<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1229<dl> 1837<dl>
1230<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1838<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1231</dt> 1839</dt>
1232<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1840<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1233</dt> 1841</dt>
1234<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1842<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1843</dt>
1844<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1235</dt> 1845</dt>
1236</dl> 1846</dl>
1237<p> 1847<p>
1238</p> 1848</p>
1239<hr /> 1849<hr />

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines