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.36 by root, Sat Jan 21 19:50:53 2006 UTC vs.
Revision 1.46 by root, Mon Aug 7 16:17:30 2006 UTC

1<?xml version="1.0" ?>
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml"> 3<html xmlns="http://www.w3.org/1999/xhtml">
3<head> 4<head>
4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> 5<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>
6<meta http-equiv="content-type" content="text/html; charset=utf-8" />
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 7<link rev="made" href="mailto:perl-binary@plan9.de" />
6</head> 8</head>
7 9
8<body style="background-color: white"> 10<body style="background-color: white">
9 11
… …
67 rxvt --perl-lib $HOME -pe grab_test</pre> 69 rxvt --perl-lib $HOME -pe grab_test</pre>
68<p> 70<p>
69</p> 71</p>
70<hr /> 72<hr />
71<h1><a name="description">DESCRIPTION</a></h1> 73<h1><a name="description">DESCRIPTION</a></h1>
72<p>Everytime a terminal object gets created, extension scripts specified via 74<p>Every time a terminal object gets created, extension scripts specified via
73the <code>perl</code> resource are loaded and associated with it.</p> 75the <code>perl</code> resource are loaded and associated with it.</p>
74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 76<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
75thus must be encoded as UTF-8.</p> 77thus must be encoded as UTF-8.</p>
76<p>Each script will only ever be loaded once, even in rxvtd, where 78<p>Each script will only ever be loaded once, even in rxvtd, where
77scripts will be shared (but not enabled) for all terminals.</p> 79scripts will be shared (but not enabled) for all terminals.</p>
… …
86 rxvt -pe &lt;extensionname&gt;</pre> 88 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p> 89<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre> 90<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> 91 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
90<dl> 92<dl>
91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 93<dt><strong><a name="item_selection">selection (enabled by default)</a></strong>
92</dt> 94
93<dd> 95<dd>
94(More) intelligent selection. This extension tries to be more intelligent 96<p>(More) intelligent selection. This extension tries to be more intelligent
95when the user extends selections (double-click and further clicks). Right 97when the user extends selections (double-click and further clicks). Right
96now, it tries to select words, urls and complete shell-quoted 98now, it tries to select words, urls and complete shell-quoted
97arguments, which is very convenient, too, if your <em>ls</em> supports 99arguments, which is very convenient, too, if your <em>ls</em> supports
98<code>--quoting-style=shell</code>. 100<code>--quoting-style=shell</code>.</p>
99</dd> 101</dd>
100<dd> 102<dd>
101<p>A double-click usually selects the word under the cursor, further clicks 103<p>A double-click usually selects the word under the cursor, further clicks
102will enlarge the selection.</p> 104will enlarge the selection.</p>
103</dd> 105</dd>
… …
113 ...</pre> 115 ...</pre>
114</dd> 116</dd>
115<dd> 117<dd>
116<p>The index number (0, 1...) must not have any holes, and each regex must 118<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 119contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything 120the match. For example, the following adds a regex that matches everything
119between two vertical bars:</p> 121between two vertical bars:</p>
120</dd> 122</dd>
121<dd> 123<dd>
122<pre> 124<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> 125 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
126</dd>
127<dd>
128<p>Another example: Programs I use often output ``absolute path: '' at the
129beginning of a line when they process multiple files. The following
130pattern matches the filename (note, there is a single space at the very
131end):</p>
132</dd>
133<dd>
134<pre>
135 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
124</dd> 136</dd>
125<dd> 137<dd>
126<p>You can look at the source of the selection extension to see more 138<p>You can look at the source of the selection extension to see more
127interesting uses, such as parsing a line from beginning to end.</p> 139interesting uses, such as parsing a line from beginning to end.</p>
128</dd> 140</dd>
129<dd> 141<dd>
130<p>This extension also offers following bindable keyboard commands:</p> 142<p>This extension also offers following bindable keyboard commands:</p>
131</dd> 143</dd>
132<dl> 144<dl>
133<dt><strong><a name="item_rot13">rot13</a></strong><br /> 145<dt><strong><a name="item_rot13">rot13</a></strong>
134</dt> 146
135<dd> 147<dd>
136Rot-13 the selection when activated. Used via keyboard trigger: 148<p>Rot-13 the selection when activated. Used via keyboard trigger:</p>
137</dd> 149</dd>
138<dd> 150<dd>
139<pre> 151<pre>
140 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 152 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
141</dd> 153</dd>
142<p></p></dl> 154</li>
155</dl>
143<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> 156<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong>
144</dt> 157
145<dd> 158<dd>
146Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 159<p>Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
147runtime. 160runtime.</p>
161</dd>
148</dd> 162<dd>
149<p></p> 163<p>Other extensions can extend this popup menu by pushing a code reference
164onto <code>@{ $term-</code>{option_popup_hook} }&gt;, which gets called whenever the
165popup is being displayed.</p>
166</dd>
167<dd>
168<p>It's sole argument is the popup menu, which can be modified. It should
169either return nothing or a string, the initial boolean value and a code
170reference. The string will be used as button text and the code reference
171will be called when the toggle changes, with the new boolean value as
172first argument.</p>
173</dd>
174<dd>
175<p>The following will add an entry <code>myoption</code> that changes
176<code>$self-</code>{myoption}&gt;:</p>
177</dd>
178<dd>
179<pre>
180 push @{ $self-&gt;{term}{option_popup_hook} }, sub {
181 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] })
182 };</pre>
183</dd>
184</li>
150<dt><strong>selection-popup (enabled by default)</strong><br /> 185<dt><strong>selection-popup (enabled by default)</strong>
151</dt> 186
152<dd> 187<dd>
153Binds a popup menu to Ctrl-Button3 that lets you convert the selection 188<p>Binds a popup menu to Ctrl-Button3 that lets you convert the selection
154text into various other formats/action (such as uri unescaping, perl 189text into various other formats/action (such as uri unescaping, perl
155evaluation, web-browser starting etc.), depending on content. 190evaluation, web-browser starting etc.), depending on content.</p>
156</dd> 191</dd>
157<dd> 192<dd>
158<p>Other extensions can extend this popup menu by pushing a code reference 193<p>Other extensions can extend this popup menu by pushing a code reference
159onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the 194onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
160popup is displayed.</p> 195popup is being displayed.</p>
161</dd> 196</dd>
162<dd> 197<dd>
163<p>It's sole argument is the popup menu, which can be modified. The selection 198<p>It's sole argument is the popup menu, which can be modified. The selection
164is in <code>$_</code>, which can be used to decide wether to add something or not. 199is in <code>$_</code>, which can be used to decide whether to add something or not.
165It should either return nothing or a string and a code reference. The 200It should either return nothing or a string and a code reference. The
166string will be used as button text and the code reference will be called 201string will be used as button text and the code reference will be called
167when the button gets activated and should transform <code>$_</code>.</p> 202when the button gets activated and should transform <code>$_</code>.</p>
168</dd> 203</dd>
169<dd> 204<dd>
… …
176 push @{ $self-&gt;{term}{selection_popup_hook} }, sub { 211 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
177 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g } 212 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
178 : () 213 : ()
179 };</pre> 214 };</pre>
180</dd> 215</dd>
181<p></p> 216</li>
182<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 217<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong>
183</dt> 218
184<dd> 219<dd>
185Adds regex search functionality to the scrollback buffer, triggered 220<p>Adds regex search functionality to the scrollback buffer, triggered
186by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal 221by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
187input/output is suspended and a regex is displayed at the bottom of the 222input/output is suspended and a regex is displayed at the bottom of the
188screen. 223screen.</p>
189</dd> 224</dd>
190<dd> 225<dd>
191<p>Inputting characters appends them to the regex and continues incremental 226<p>Inputting characters appends them to the regex and continues incremental
192search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> 227search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
193search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the 228search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
194bottom. <code>Escape</code> leaves search mode and returns to the point where search 229bottom. <code>Escape</code> leaves search mode and returns to the point where search
195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 230was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
196additionally stores the first match in the current line into the primary 231additionally stores the first match in the current line into the primary
197selection.</p> 232selection.</p>
198</dd> 233</dd>
199<p></p> 234<dd>
235<p>The regex defaults to ``(?i)'', resulting in a case-insensitive search. To
236get a case-sensitive search you can delete this prefix using <code>BackSpace</code>
237or simply use an uppercase character which removes the ``(?i)'' prefix.</p>
238</dd>
239<dd>
240<p>See <em>perlre</em> for more info about perl regular expression syntax.</p>
241</dd>
242</li>
200<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> 243<dt><strong><a name="item_readline">readline (enabled by default)</a></strong>
201</dt> 244
202<dd> 245<dd>
203A support package that tries to make editing with readline easier. At the 246<p>A support package that tries to make editing with readline easier. At
204moment, it reacts to clicking with the left mouse button by trying to 247the moment, it reacts to clicking shift-left mouse button by trying to
205move the text cursor to this position. It does so by generating as many 248move the text cursor to this position. It does so by generating as many
206cursor-left or cursor-right keypresses as required (the this only works 249cursor-left or cursor-right keypresses as required (the this only works
207for programs that correctly support wide characters). 250for programs that correctly support wide characters).</p>
208</dd> 251</dd>
209<dd> 252<dd>
210<p>To avoid too many false positives, this is only done when:</p> 253<p>To avoid too many false positives, this is only done when:</p>
211</dd> 254</dd>
212<dl> 255<dl>
213<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> 256<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong>
214</dt> 257
258<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong>
259
215<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> 260<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong>
216</dt> 261
217<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> 262<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong>
218</dt> 263
219</dl> 264</dl>
220<p>The normal selection mechanism isn't disabled, so quick successive clicks 265<p>The normal selection mechanism isn't disabled, so quick successive clicks
221might interfere with selection creation in harmless ways.</p> 266might interfere with selection creation in harmless ways.</p>
222<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 267<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong>
223</dt> 268
224<dd> 269<dd>
225This selection allows you to do automatic transforms on a selection 270<p>This selection allows you to do automatic transforms on a selection
226whenever a selection is made. 271whenever a selection is made.</p>
227</dd> 272</dd>
228<dd> 273<dd>
229<p>It works by specifying perl snippets (most useful is a single <code>s///</code> 274<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
230operator) that modify <code>$_</code> as resources:</p> 275operator) that modify <code>$_</code> as resources:</p>
231</dd> 276</dd>
… …
267<dd> 312<dd>
268<p>The first line tells the selection code to treat the unchanging part of 313<p>The first line tells the selection code to treat the unchanging part of
269every error message as a selection pattern, and the second line transforms 314every error message as a selection pattern, and the second line transforms
270the message into vi commands to load the file.</p> 315the message into vi commands to load the file.</p>
271</dd> 316</dd>
272<p></p> 317</li>
273<dt><strong><a name="item_tabbed">tabbed</a></strong><br /> 318<dt><strong><a name="item_tabbed">tabbed</a></strong>
274</dt> 319
275<dd> 320<dd>
276This transforms the terminal into a tabbar with additional terminals, that 321<p>This transforms the terminal into a tabbar with additional terminals, that
277is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line 322is, it implements what is commonly referred to as ``tabbed terminal''. The topmost line
278displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one 323displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
279button per tab. 324button per tab.</p>
280</dd> 325</dd>
281<dd> 326<dd>
282<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and 327<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
283<strong>Shift-Right</strong> will switch to the tab left or right of the current one, 328<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
284while <strong>Shift-Down</strong> creates a new tab.</p> 329while <strong>Shift-Down</strong> creates a new tab.</p>
285</dd> 330</dd>
286<p></p> 331<dd>
332<p>The tabbar itself can be configured similarly to a normal terminal, but
333with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
334following four resources (shown with defaults):</p>
335</dd>
336<dd>
337<pre>
338 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
339 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
340 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
341 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
342</dd>
343<dd>
344<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
345indices.</p>
346</dd>
347</li>
287<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 348<dt><strong><a name="item_mark_2durls">mark-urls</a></strong>
288</dt> 349
289<dd> 350<dd>
290Uses per-line display filtering (<code>on_line_update</code>) to underline urls and 351<p>Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
291make them clickable. When middle-clicked, the program specified in the 352make them clickable. When middle-clicked, the program specified in the
292resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 353resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
293the URL as first argument. 354the URL as first argument.</p>
355</dd>
356</li>
357<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong>
358
294</dd> 359<dd>
295<p></p> 360<p>This (experimental) perl extension implements OnTheSpot editing. It does
361not work perfectly, and some input methods don't seem to work well with
362OnTheSpot editing in general, but it seems to work at leats for SCIM and
363kinput2.</p>
364</dd>
365<dd>
366<p>You enable it by specifying this extension and a preedit style of
367<code>OnTheSpot</code>, i.e.:</p>
368</dd>
369<dd>
370<pre>
371 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
372</dd>
373</li>
374<dt><strong><a name="item_kuake_3chotkey_3e">kuake&lt;hotkey&gt;</a></strong>
375
376<dd>
377<p>A very primitive quake-console-like extension. It was inspired by a
378description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the
379user presses a global accelerator key (by default <code>F10</code>), the terminal
380will show or hide itself. Another press of the accelerator key will hide
381or show it again.</p>
382</dd>
383<dd>
384<p>Initially, the window will not be shown when using this extension.</p>
385</dd>
386<dd>
387<p>This is useful if you need a single terminal thats not using any desktop
388space most of the time but is quickly available at the press of a key.</p>
389</dd>
390<dd>
391<p>The accelerator key is grabbed regardless of any modifiers, so this
392extension will actually grab a physical key just for this function.</p>
393</dd>
394<dd>
395<p>If you want a quake-like animation, tell your window manager to do so
396(fvwm can do it).</p>
397</dd>
398</li>
296<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> 399<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong>
297</dt> 400
298<dd> 401<dd>
299This is basically a one-line extension that dynamically changes the background pixmap offset 402<p>This is basically a very small extension that dynamically changes the
300to the window position, in effect creating the same effect as pseudo transparency with 403background pixmap offset to the window position, in effect creating the
301a custom pixmap. No scaling is supported in this mode. Exmaple: 404same effect as pseudo transparency with a custom pixmap. No scaling is
405supported in this mode. Example:</p>
302</dd> 406</dd>
303<dd> 407<dd>
304<pre> 408<pre>
305 rxvt -pixmap background.xpm -pe automove-background</pre> 409 rxvt -pixmap background.xpm -pe automove-background</pre>
306</dd> 410</dd>
307<p></p> 411</li>
308<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 412<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong>
309</dt> 413
310<dd> 414<dd>
311A not very useful example of filtering all text output to the terminal, 415<p>A not very useful example of filtering all text output to the terminal
312by replacing all line-drawing characters (U+2500 .. U+259F) by a 416by replacing all line-drawing characters (U+2500 .. U+259F) by a
313similar-looking ascii character. 417similar-looking ascii character.</p>
314</dd> 418</dd>
315<p></p> 419</li>
316<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 420<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong>
317</dt> 421
318<dd> 422<dd>
319Displays a digital clock using the built-in overlay. 423<p>Displays a digital clock using the built-in overlay.</p>
320</dd>
321<p></p>
322<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
323</dt>
324<dd> 424</dd>
325Displays a very simple digital clock in the upper right corner of the 425</li>
326window. Illustrates overwriting the refresh callbacks to create your own 426<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong>
327overlays or changes. 427
328</dd> 428<dd>
329<p></p> 429<p>Somewhat of a misnomer, this extension adds two menu entries to the
430selection popup that allows one ti run external commands to store the
431selection somewhere and fetch it again.</p>
432</dd>
433<dd>
434<p>We use it to implement a ``distributed selection mechanism'', which just
435means that one command uploads the file to a remote server, and another
436reads it.</p>
437</dd>
438<dd>
439<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
440<code>URxvt.remote-selection.fetch</code> resources. The first should read the
441selection to store from STDIN (always in UTF-8), the second should provide
442the selection data on STDOUT (also in UTF-8).</p>
443</dd>
444<dd>
445<p>The defaults (which are likely useless to you) use rsh and cat:</p>
446</dd>
447<dd>
448<pre>
449 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
450 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
451</dd>
452</li>
330<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> 453<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong>
331</dt> 454
332<dd> 455<dd>
333This is a little rarely useful extension that Uploads the selection as 456<p>This is a little rarely useful extension that Uploads the selection as
334textfile to a remote site (or does other things). (The implementation is 457textfile to a remote site (or does other things). (The implementation is
335not currently secure for use in a multiuser environment as it writes to 458not currently secure for use in a multiuser environment as it writes to
336<em>/tmp</em> directly.). 459<em>/tmp</em> directly.).</p>
337</dd> 460</dd>
338<dd> 461<dd>
339<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, 462<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
340i.e.</p> 463i.e.</p>
341</dd> 464</dd>
… …
366</dd> 489</dd>
367<dd> 490<dd>
368<pre> 491<pre>
369 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 492 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
370</dd> 493</dd>
371<p></p></dl> 494</li>
495<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong>
496
497<dd>
498<p>Displays a very simple digital clock in the upper right corner of the
499window. Illustrates overwriting the refresh callbacks to create your own
500overlays or changes.</p>
501</dd>
502</li>
503</dl>
372<p> 504<p>
373</p> 505</p>
374<hr /> 506<hr />
375<h1><a name="api_documentation">API DOCUMENTATION</a></h1> 507<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
376<p> 508<p>
… …
386the like inside the terminal object so they get destroyed as soon as the 518the like inside the terminal object so they get destroyed as soon as the
387terminal is destroyed.</p> 519terminal is destroyed.</p>
388<p>Argument names also often indicate the type of a parameter. Here are some 520<p>Argument names also often indicate the type of a parameter. Here are some
389hints on what they mean:</p> 521hints on what they mean:</p>
390<dl> 522<dl>
391<dt><strong><a name="item__24text">$text</a></strong><br /> 523<dt><strong><a name="item__text">$text</a></strong>
392</dt> 524
393<dd> 525<dd>
394Rxvt-unicodes special way of encoding text, where one ``unicode'' character 526<p>Rxvt-unicodes special way of encoding text, where one ``unicode'' character
395always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. 527always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.</p>
396</dd> 528</dd>
397<p></p> 529</li>
398<dt><strong><a name="item__24string">$string</a></strong><br /> 530<dt><strong><a name="item__string">$string</a></strong>
399</dt> 531
400<dd> 532<dd>
401A perl text string, with an emphasis on <em>text</em>. It can store all unicode 533<p>A perl text string, with an emphasis on <em>text</em>. It can store all unicode
402characters and is to be distinguished with text encoded in a specific 534characters and is to be distinguished with text encoded in a specific
403encoding (often locale-specific) and binary data. 535encoding (often locale-specific) and binary data.</p>
404</dd> 536</dd>
405<p></p> 537</li>
406<dt><strong><a name="item__24octets">$octets</a></strong><br /> 538<dt><strong><a name="item__octets">$octets</a></strong>
407</dt> 539
408<dd> 540<dd>
409Either binary data or - more common - a text string encoded in a 541<p>Either binary data or - more common - a text string encoded in a
410locale-specific way. 542locale-specific way.</p>
543</dd>
544</li>
411</dd> 545</dl>
412<p></p></dl>
413<p> 546<p>
414</p> 547</p>
415<h2><a name="extension_objects">Extension Objects</a></h2> 548<h2><a name="extension_objects">Extension Objects</a></h2>
416<p>Very perl extension is a perl class. A separate perl object is created 549<p>Every perl extension is a perl class. A separate perl object is created
417for each terminal and each extension and passed as the first parameter to 550for each terminal and each extension and passed as the first parameter to
418hooks. So extensions can use their <code>$self</code> object without having to think 551hooks. So extensions can use their <code>$self</code> object without having to think
419about other extensions, with the exception of methods and members that 552about other extensions, with the exception of methods and members that
420begin with an underscore character <code>_</code>: these are reserved for internal 553begin with an underscore character <code>_</code>: these are reserved for internal
421use.</p> 554use.</p>
422<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the 555<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
423<code>urxvt::term</code> class on this object.</p> 556<code>urxvt::term</code> class on this object.</p>
424<p>It has the following methods and data members:</p> 557<p>It has the following methods and data members:</p>
425<dl> 558<dl>
426<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br /> 559<dt><strong><a name="item__urxvt_term">$urxvt_term = $self-&gt;{term}</a></strong>
427</dt> 560
428<dd> 561<dd>
429Returns the <code>urxvt::term</code> object associated with this instance of the 562<p>Returns the <code>urxvt::term</code> object associated with this instance of the
430extension. This member <em>must not</em> be changed in any way. 563extension. This member <em>must not</em> be changed in any way.</p>
431</dd> 564</dd>
432<p></p> 565</li>
433<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br /> 566<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong>
434</dt> 567
435<dd> 568<dd>
436Dynamically enable the given hooks (named without the <code>on_</code> prefix) for 569<p>Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
437this extension, replacing any previous hook. This is useful when you want 570this extension, replacing any previous hook. This is useful when you want
438to overwrite time-critical hooks only temporarily. 571to overwrite time-critical hooks only temporarily.</p>
439</dd> 572</dd>
440<p></p> 573</li>
441<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br /> 574<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong>
442</dt> 575
443<dd> 576<dd>
444Dynamically disable the given hooks. 577<p>Dynamically disable the given hooks.</p>
578</dd>
579</li>
445</dd> 580</dl>
446<p></p></dl>
447<p> 581<p>
448</p> 582</p>
449<h2><a name="hooks">Hooks</a></h2> 583<h2><a name="hooks">Hooks</a></h2>
450<p>The following subroutines can be declared in extension files, and will be 584<p>The following subroutines can be declared in extension files, and will be
451called whenever the relevant event happens.</p> 585called whenever the relevant event happens.</p>
452<p>The first argument passed to them is an extension oject as described in 586<p>The first argument passed to them is an extension object as described in
453the in the <code>Extension Objects</code> section.</p> 587the in the <code>Extension Objects</code> section.</p>
454<p><strong>All</strong> of these hooks must return a boolean value. If any of the called 588<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
455hooks returns true, then the event counts as being <em>consumed</em>, and the 589hooks returns true, then the event counts as being <em>consumed</em>, and the
456relevant action might not be carried out by the C++ code.</p> 590relevant action might not be carried out by the C++ code.</p>
457<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 591<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
458<dl> 592<dl>
459<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 593<dt><strong><a name="item_on_init__24term">on_init $term</a></strong>
460</dt> 594
461<dd> 595<dd>
462Called after a new terminal object has been initialized, but before 596<p>Called after a new terminal object has been initialized, but before
463windows are created or the command gets run. Most methods are unsafe to 597windows are created or the command gets run. Most methods are unsafe to
464call or deliver senseless data, as terminal size and other characteristics 598call or deliver senseless data, as terminal size and other characteristics
465have not yet been determined. You can safely query and change resources 599have not yet been determined. You can safely query and change resources
466and options, though. For many purposes the <code>on_start</code> hook is a better 600and options, though. For many purposes the <code>on_start</code> hook is a better
467place. 601place.</p>
468</dd> 602</dd>
469<p></p> 603</li>
470<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 604<dt><strong><a name="item_on_start__24term">on_start $term</a></strong>
471</dt> 605
472<dd> 606<dd>
473Called at the very end of initialisation of a new terminal, just before 607<p>Called at the very end of initialisation of a new terminal, just before
474trying to map (display) the toplevel and returning to the mainloop. 608trying to map (display) the toplevel and returning to the main loop.</p>
475</dd> 609</dd>
476<p></p> 610</li>
477<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> 611<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong>
478</dt> 612
479<dd>
480Called whenever something tries to destroy terminal, before doing anything
481yet. If this hook returns true, then destruction is skipped, but this is
482rarely a good idea.
483</dd> 613<dd>
484<p></p> 614<p>Called whenever something tries to destroy terminal, when the terminal is
615still fully functional (not for long, though).</p>
616</dd>
617</li>
485<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 618<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong>
486</dt> 619
487<dd> 620<dd>
488Called after the screen is ``reset'' for any reason, such as resizing or 621<p>Called after the screen is ``reset'' for any reason, such as resizing or
489control sequences. Here is where you can react on changes to size-related 622control sequences. Here is where you can react on changes to size-related
490variables. 623variables.</p>
491</dd> 624</dd>
492<p></p> 625</li>
493<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> 626<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong>
494</dt> 627
495<dd> 628<dd>
496Called just after the child process has been <code>fork</code>ed. 629<p>Called just after the child process has been <code>fork</code>ed.</p>
497</dd> 630</dd>
498<p></p> 631</li>
499<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> 632<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong>
500</dt> 633
501<dd> 634<dd>
502Called just after the child process has exited. <code>$status</code> is the status 635<p>Called just after the child process has exited. <code>$status</code> is the status
503from <code>waitpid</code>. 636from <code>waitpid</code>.</p>
504</dd> 637</dd>
505<p></p> 638</li>
506<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 639<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong>
507</dt> 640
508<dd> 641<dd>
509Called whenever a selection has been made by the user, but before the 642<p>Called whenever a selection has been made by the user, but before the
510selection text is copied, so changes to the beginning, end or type of the 643selection text is copied, so changes to the beginning, end or type of the
511selection will be honored. 644selection will be honored.</p>
512</dd> 645</dd>
513<dd> 646<dd>
514<p>Returning a true value aborts selection making by urxvt, in which case you 647<p>Returning a true value aborts selection making by urxvt, in which case you
515have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term-&gt;selection_grab</code></a>.</p> 648have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term-&gt;selection_grab</code></a>.</p>
516</dd> 649</dd>
517<p></p> 650</li>
518<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> 651<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong>
519</dt> 652
520<dd> 653<dd>
521Called whenever a selection has been copied, but before the selection is 654<p>Called whenever a selection has been copied, but before the selection is
522requested from the server. The selection text can be queried and changed 655requested from the server. The selection text can be queried and changed
523by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>. 656by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.</p>
524</dd>
525<dd> 657</dd>
658<dd>
526<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 659<p>Returning a true value aborts selection grabbing. It will still be highlighted.</p>
527</dd> 660</dd>
528<p></p> 661</li>
529<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> 662<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong>
530</dt> 663
531<dd> 664<dd>
532Called whenever the user tries to extend the selection (e.g. with a double 665<p>Called whenever the user tries to extend the selection (e.g. with a double
533click) and is either supposed to return false (normal operation), or 666click) and is either supposed to return false (normal operation), or
534should extend the selection itelf and return true to suppress the built-in 667should extend the selection itself and return true to suppress the built-in
535processing. This can happen multiple times, as long as the callback 668processing. This can happen multiple times, as long as the callback
536returns true, it will be called on every further click by the user and is 669returns true, it will be called on every further click by the user and is
537supposed to enlarge the selection more and more, if possible. 670supposed to enlarge the selection more and more, if possible.</p>
538</dd> 671</dd>
539<dd> 672<dd>
540<p>See the <em>selection</em> example extension.</p> 673<p>See the <em>selection</em> example extension.</p>
541</dd> 674</dd>
542<p></p> 675</li>
543<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 676<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong>
544</dt> 677
545<dd> 678<dd>
546Called whenever the view offset changes, i..e the user or program 679<p>Called whenever the view offset changes, i.e. the user or program
547scrolls. Offset <code>0</code> means display the normal terminal, positive values 680scrolls. Offset <code>0</code> means display the normal terminal, positive values
548show this many lines of scrollback. 681show this many lines of scrollback.</p>
549</dd> 682</dd>
550<p></p> 683</li>
551<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> 684<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong>
552</dt> 685
553<dd> 686<dd>
554Called whenever lines scroll out of the terminal area into the scrollback 687<p>Called whenever lines scroll out of the terminal area into the scrollback
555buffer. <code>$lines</code> is the number of lines scrolled out and may be larger 688buffer. <code>$lines</code> is the number of lines scrolled out and may be larger
556than the scroll back buffer or the terminal. 689than the scroll back buffer or the terminal.</p>
557</dd> 690</dd>
558<dd> 691<dd>
559<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 692<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
560$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 693$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
561number of lines that will be in the scrollback buffer.</p> 694number of lines that will be in the scrollback buffer.</p>
562</dd> 695</dd>
563<p></p> 696</li>
697<dt><strong><a name="item_on_osc_seq__24term_2c__24op_2c__24args">on_osc_seq $term, $op, $args</a></strong>
698
699<dd>
700<p>Called on every OSC sequence and can be used to suppress it or modify its
701behaviour. The default should be to return an empty list. A true value
702suppresses execution of the request completely. Make sure you don't get
703confused by recursive invocations when you output an osc sequence within
704this callback.</p>
705</dd>
706<dd>
707<p><code>on_osc_seq_perl</code> should be used for new behaviour.</p>
708</dd>
709</li>
564<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 710<dt><strong><a name="item_on_osc_seq_perl__24term_2c__24string">on_osc_seq_perl $term, $string</a></strong>
565</dt> 711
566<dd> 712<dd>
567Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = 713<p>Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
568operating system command) is processed. Cursor position and other state 714operating system command) is processed. Cursor position and other state
569information is up-to-date when this happens. For interoperability, the 715information is up-to-date when this happens. For interoperability, the
570string should start with the extension name and a colon, to distinguish 716string should start with the extension name and a colon, to distinguish
571it from commands for other extensions, and this might be enforced in the 717it from commands for other extensions, and this might be enforced in the
572future. 718future.</p>
573</dd> 719</dd>
574<dd> 720<dd>
575<p>Be careful not ever to trust (in a security sense) the data you receive, 721<p>Be careful not ever to trust (in a security sense) the data you receive,
576as its source can not easily be controleld (e-mail content, messages from 722as its source can not easily be controlled (e-mail content, messages from
577other users on the same system etc.).</p> 723other users on the same system etc.).</p>
578</dd> 724</dd>
579<p></p> 725</li>
580<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> 726<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong>
581</dt> 727
582<dd> 728<dd>
583Called whenever text is about to be output, with the text as argument. You 729<p>Called whenever text is about to be output, with the text as argument. You
584can filter/change and output the text yourself by returning a true value 730can filter/change and output the text yourself by returning a true value
585and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 731and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
586might be very slow, however, as your hook is called for <strong>all</strong> text being 732might be very slow, however, as your hook is called for <strong>all</strong> text being
587output. 733output.</p>
588</dd> 734</dd>
589<p></p> 735</li>
590<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> 736<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong>
591</dt> 737
592<dd> 738<dd>
593Called whenever some data is written to the tty/pty and can be used to 739<p>Called whenever some data is written to the tty/pty and can be used to
594suppress or filter tty input. 740suppress or filter tty input.</p>
595</dd> 741</dd>
596<p></p> 742</li>
597<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 743<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong>
598</dt> 744
599<dd> 745<dd>
600Called whenever a line was updated or changed. Can be used to filter 746<p>Called whenever a line was updated or changed. Can be used to filter
601screen output (e.g. underline urls or other useless stuff). Only lines 747screen output (e.g. underline urls or other useless stuff). Only lines
602that are being shown will be filtered, and, due to performance reasons, 748that are being shown will be filtered, and, due to performance reasons,
603not always immediately. 749not always immediately.</p>
604</dd> 750</dd>
605<dd> 751<dd>
606<p>The row number is always the topmost row of the line if the line spans 752<p>The row number is always the topmost row of the line if the line spans
607multiple rows.</p> 753multiple rows.</p>
608</dd> 754</dd>
609<dd> 755<dd>
610<p>Please note that, if you change the line, then the hook might get called 756<p>Please note that, if you change the line, then the hook might get called
611later with the already-modified line (e.g. if unrelated parts change), so 757later with the already-modified line (e.g. if unrelated parts change), so
612you cannot just toggle rendition bits, but only set them.</p> 758you cannot just toggle rendition bits, but only set them.</p>
613</dd> 759</dd>
614<p></p> 760</li>
615<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 761<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong>
616</dt> 762
617<dd> 763<dd>
618Called just before the screen gets redrawn. Can be used for overlay 764<p>Called just before the screen gets redrawn. Can be used for overlay
619or similar effects by modify terminal contents in refresh_begin, and 765or similar effects by modify terminal contents in refresh_begin, and
620restoring them in refresh_end. The built-in overlay and selection display 766restoring them in refresh_end. The built-in overlay and selection display
621code is run after this hook, and takes precedence. 767code is run after this hook, and takes precedence.</p>
622</dd> 768</dd>
623<p></p> 769</li>
624<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 770<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong>
625</dt> 771
626<dd> 772<dd>
627Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 773<p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p>
628</dd> 774</dd>
629<p></p> 775</li>
630<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 776<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong>
631</dt> 777
632<dd> 778<dd>
633Called whenever the user presses a key combination that has a 779<p>Called whenever a user-configured event is being activated (e.g. via
634<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 780a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
635resource in the <code>rxvt(1)</code> manpage). 781resource in the <code>rxvt(1)</code> manpage).</p>
782</dd>
636</dd> 783<dd>
637<p></p> 784<p>The event is simply the action string. This interface is assumed to change
785slightly in the future.</p>
786</dd>
787</li>
788<dt><strong><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong>
789
790<dd>
791<p>Called just after the new window size has been calculated, but before
792windows are actually being resized or hints are being set. If this hook
793returns TRUE, setting of the window hints is being skipped.</p>
794</dd>
795</li>
638<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 796<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong>
639</dt> 797
640<dd> 798<dd>
641Called on every X event received on the vt window (and possibly other 799<p>Called on every X event received on the vt window (and possibly other
642windows). Should only be used as a last resort. Most event structure 800windows). Should only be used as a last resort. Most event structure
643members are not passed. 801members are not passed.</p>
802</dd>
803</li>
804<dt><strong><a name="item_on_root_event__24term_2c__24event">on_root_event $term, $event</a></strong>
805
644</dd> 806<dd>
645<p></p> 807<p>Like <code>on_x_event</code>, but is called for events on the root window.</p>
808</dd>
809</li>
646<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 810<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong>
647</dt> 811
648<dd> 812<dd>
649Called whenever the window gets the keyboard focus, before rxvt-unicode 813<p>Called whenever the window gets the keyboard focus, before rxvt-unicode
650does focus in processing. 814does focus in processing.</p>
651</dd> 815</dd>
652<p></p> 816</li>
653<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 817<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong>
654</dt> 818
655<dd> 819<dd>
656Called wheneever the window loses keyboard focus, before rxvt-unicode does 820<p>Called whenever the window loses keyboard focus, before rxvt-unicode does
657focus out processing. 821focus out processing.</p>
658</dd> 822</dd>
659<p></p> 823</li>
660<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> 824<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong>
661</dt> 825
662<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> 826<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong>
663</dt> 827
664<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 828<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong>
665</dt> 829
666<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 830<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong>
667</dt> 831
668<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 832<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong>
669</dt> 833
670<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 834<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong>
671</dt> 835
672<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> 836<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong>
673</dt> 837
674<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> 838<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong>
675</dt> 839
676<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> 840<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong>
677</dt> 841
678<dd> 842<dd>
679Called whenever the corresponding X event is received for the terminal If 843<p>Called whenever the corresponding X event is received for the terminal If
680the hook returns true, then the even will be ignored by rxvt-unicode. 844the hook returns true, then the even will be ignored by rxvt-unicode.</p>
681</dd> 845</dd>
682<dd> 846<dd>
683<p>The event is a hash with most values as named by Xlib (see the XEvent 847<p>The event is a hash with most values as named by Xlib (see the XEvent
684manpage), with the additional members <code>row</code> and <code>col</code>, which are the 848manpage), with the additional members <code>row</code> and <code>col</code>, which are the
685(real, not screen-based) row and column under the mouse cursor.</p> 849(real, not screen-based) row and column under the mouse cursor.</p>
… …
689output, if any, in locale-specific encoding.</p> 853output, if any, in locale-specific encoding.</p>
690</dd> 854</dd>
691<dd> 855<dd>
692<p>subwindow.</p> 856<p>subwindow.</p>
693</dd> 857</dd>
694<p></p> 858</li>
695<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> 859<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong>
696</dt> 860
697<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> 861<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong>
698</dt> 862
699<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> 863<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong>
700</dt> 864
701<dd> 865<dd>
702Called when various types of ClientMessage events are received (all with 866<p>Called when various types of ClientMessage events are received (all with
703format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 867format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p>
868</dd>
869</li>
704</dd> 870</dl>
705<p></p></dl>
706<p> 871<p>
707</p> 872</p>
708<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 873<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
709<dl> 874<dl>
710<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> 875<dt><strong><a name="item__urxvt__libdir">$urxvt::LIBDIR</a></strong>
711</dt> 876
712<dd> 877<dd>
713The rxvt-unicode library directory, where, among other things, the perl 878<p>The rxvt-unicode library directory, where, among other things, the perl
714modules and scripts are stored. 879modules and scripts are stored.</p>
715</dd>
716<p></p>
717<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
718</dt>
719<dd> 880</dd>
881</li>
882<dt><strong><a name="item__urxvt__resclass_">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong>
883
884<dd>
720The resource class and name rxvt-unicode uses to look up X resources. 885<p>The resource class and name rxvt-unicode uses to look up X resources.</p>
721</dd> 886</dd>
722<p></p> 887</li>
723<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> 888<dt><strong><a name="item__urxvt__rxvtname">$urxvt::RXVTNAME</a></strong>
724</dt> 889
725<dd> 890<dd>
726The basename of the installed binaries, usually <code>urxvt</code>. 891<p>The basename of the installed binaries, usually <code>urxvt</code>.</p>
727</dd> 892</dd>
728<p></p> 893</li>
729<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 894<dt><strong><a name="item__urxvt__term">$urxvt::TERM</a></strong>
730</dt> 895
731<dd> 896<dd>
732The current terminal. This variable stores the current <code>urxvt::term</code> 897<p>The current terminal. This variable stores the current <code>urxvt::term</code>
733object, whenever a callback/hook is executing. 898object, whenever a callback/hook is executing.</p>
734</dd> 899</dd>
735<p></p> 900</li>
736<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> 901<dt><strong><a name="item__urxvt__term_init">@urxvt::TERM_INIT</a></strong>
737</dt> 902
738<dd> 903<dd>
739All coderefs in this array will be called as methods of the next newly 904<p>All code references in this array will be called as methods of the next newly
740created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array 905created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
741gets cleared before the codereferences that were in it are being executed, 906gets cleared before the code references that were in it are being executed,
742so coderefs can push themselves onto it again if they so desire. 907so references can push themselves onto it again if they so desire.</p>
743</dd>
744<dd> 908</dd>
909<dd>
745<p>This complements to the perl-eval commandline option, but gets executed 910<p>This complements to the perl-eval command line option, but gets executed
746first.</p> 911first.</p>
747</dd> 912</dd>
748<p></p> 913</li>
749<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> 914<dt><strong><a name="item__urxvt__term_ext">@urxvt::TERM_EXT</a></strong>
750</dt> 915
751<dd> 916<dd>
752Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which 917<p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
753get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> 918get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
754but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. 919but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p>
920</dd>
921</li>
755</dd> 922</dl>
756<p></p></dl>
757<p> 923<p>
758</p> 924</p>
759<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 925<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
760<dl> 926<dl>
761<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 927<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong>
762</dt> 928
763<dd> 929<dd>
764Fatally aborts execution with the given error message. Avoid at all 930<p>Fatally aborts execution with the given error message. Avoid at all
765costs! The only time this is acceptable is when the terminal process 931costs! The only time this is acceptable is when the terminal process
766starts up. 932starts up.</p>
767</dd> 933</dd>
768<p></p> 934</li>
769<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> 935<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong>
770</dt> 936
771<dd> 937<dd>
772Calls <code>rxvt_warn</code> with the given string which should not include a 938<p>Calls <code>rxvt_warn</code> with the given string which should not include a
773newline. The module also overwrites the <code>warn</code> builtin with a function 939newline. The module also overwrites the <code>warn</code> builtin with a function
774that calls this function. 940that calls this function.</p>
775</dd> 941</dd>
776<dd> 942<dd>
777<p>Using this function has the advantage that its output ends up in the 943<p>Using this function has the advantage that its output ends up in the
778correct place, e.g. on stderr of the connecting urxvtc client.</p> 944correct place, e.g. on stderr of the connecting urxvtc client.</p>
779</dd> 945</dd>
780<dd> 946<dd>
781<p>Messages have a size limit of 1023 bytes currently.</p> 947<p>Messages have a size limit of 1023 bytes currently.</p>
782</dd> 948</dd>
783<p></p> 949</li>
784<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 950<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong>
785</dt> 951
952<dd>
953<p>Returns all urxvt::term objects that exist in this process, regardless of
954whether they are started, being destroyed etc., so be careful. Only term
955objects that have perl extensions attached will be returned (because there
956is no urxvt::term objet associated with others).</p>
786<dd> 957</dd>
958</li>
959<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong>
960
961<dd>
787Returns the ``current time'' (as per the event loop). 962<p>Returns the ``current time'' (as per the event loop).</p>
788</dd> 963</dd>
789<p></p> 964</li>
790<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 965<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong>
791</dt> 966
792<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 967<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
793Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 968Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
794Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 969Button4Mask, Button5Mask, AnyModifier</a></strong>
795</dt> 970
796<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, 971<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
797ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, 972ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
798PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, 973PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
799Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, 974Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
800KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, 975KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
801ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, 976ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
802FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> 977FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong>
803</dt> 978
804<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, 979<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
805EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, 980EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
806GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, 981GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
807UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, 982UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
808ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, 983ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
809CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 984CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
810SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> 985SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong>
811</dt> 986
812<dd> 987<dd>
813Various constants for use in X calls and event processing. 988<p>Various constants for use in X calls and event processing.</p>
989</dd>
990</li>
814</dd> 991</dl>
815<p></p></dl>
816<p> 992<p>
817</p> 993</p>
818<h2><a name="rendition">RENDITION</a></h2> 994<h2><a name="rendition">RENDITION</a></h2>
819<p>Rendition bitsets contain information about colour, font, font styles and 995<p>Rendition bitsets contain information about colour, font, font styles and
820similar information for each screen cell.</p> 996similar information for each screen cell.</p>
821<p>The following ``macros'' deal with changes in rendition sets. You should 997<p>The following ``macros'' deal with changes in rendition sets. You should
822never just create a bitset, you should always modify an existing one, 998never just create a bitset, you should always modify an existing one,
823as they contain important information required for correct operation of 999as they contain important information required for correct operation of
824rxvt-unicode.</p> 1000rxvt-unicode.</p>
825<dl> 1001<dl>
826<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> 1002<dt><strong><a name="item__rend">$rend = urxvt::DEFAULT_RSTYLE</a></strong>
827</dt> 1003
828<dd> 1004<dd>
829Returns the default rendition, as used when the terminal is starting up or 1005<p>Returns the default rendition, as used when the terminal is starting up or
830being reset. Useful as a base to start when creating renditions. 1006being reset. Useful as a base to start when creating renditions.</p>
831</dd>
832<p></p>
833<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
834</dt>
835<dd> 1007</dd>
1008</li>
1009<dt><strong>$rend = urxvt::OVERLAY_RSTYLE</strong>
1010
1011<dd>
836Return the rendition mask used for overlays by default. 1012<p>Return the rendition mask used for overlays by default.</p>
837</dd>
838<p></p>
839<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
840</dt>
841<dd> 1013</dd>
1014</li>
1015<dt><strong><a name="item__rendbit">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong>
1016
1017<dd>
842Return the bit that enabled bold, italic, blink, reverse-video and 1018<p>Return the bit that enabled bold, italic, blink, reverse-video and
843underline, respectively. To enable such a style, just logically OR it into 1019underline, respectively. To enable such a style, just logically OR it into
844the bitset. 1020the bitset.</p>
845</dd>
846<p></p>
847<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
848</dt>
849<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
850</dt>
851<dd> 1021</dd>
1022</li>
1023<dt><strong><a name="item__foreground">$foreground = urxvt::GET_BASEFG $rend</a></strong>
1024
1025<dt><strong><a name="item__background">$background = urxvt::GET_BASEBG $rend</a></strong>
1026
1027<dd>
852Return the foreground/background colour index, respectively. 1028<p>Return the foreground/background colour index, respectively.</p>
853</dd>
854<p></p>
855<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
856</dt>
857<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
858</dt>
859<dd> 1029</dd>
1030</li>
1031<dt><strong>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</strong>
1032
1033<dt><strong>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</strong>
1034
1035<dt><strong>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</strong>
1036
1037<dd>
860Replace the foreground/background colour in the rendition mask with the 1038<p>Replace the foreground/background colour in the rendition mask with the
861specified one. 1039specified one.</p>
862</dd>
863<p></p>
864<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
865</dt>
866<dd> 1040</dd>
1041</li>
1042<dt><strong><a name="item__value">$value = urxvt::GET_CUSTOM $rend</a></strong>
1043
1044<dd>
867Return the ``custom'' value: Every rendition has 5 bits for use by 1045<p>Return the ``custom'' value: Every rendition has 5 bits for use by
868extensions. They can be set and changed as you like and are initially 1046extensions. They can be set and changed as you like and are initially
869zero. 1047zero.</p>
870</dd>
871<p></p>
872<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
873</dt>
874<dd> 1048</dd>
875Change the custom value. 1049</li>
1050<dt><strong>$rend = urxvt::SET_CUSTOM $rend, $new_value</strong>
1051
876</dd> 1052<dd>
877<p></p></dl> 1053<p>Change the custom value.</p>
1054</dd>
1055</li>
1056</dl>
878<p> 1057<p>
879</p> 1058</p>
880<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 1059<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
881<p>The sole purpose of this class is to deliver an interface to the 1060<p>The sole purpose of this class is to deliver an interface to the
882<code>AnyEvent</code> module - any module using it will work inside urxvt without 1061<code>AnyEvent</code> module - any module using it will work inside urxvt without
… …
886work.</p> 1065work.</p>
887<p> 1066<p>
888</p> 1067</p>
889<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 1068<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
890<dl> 1069<dl>
891<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> 1070<dt><strong><a name="item__term">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong>
892</dt> 1071
893<dd> 1072<dd>
894Creates a new terminal, very similar as if you had started it with system 1073<p>Creates a new terminal, very similar as if you had started it with system
895<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like 1074<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
896hash which defines the environment of the new terminal. 1075hash which defines the environment of the new terminal.</p>
897</dd> 1076</dd>
898<dd> 1077<dd>
899<p>Croaks (and probably outputs an error message) if the new instance 1078<p>Croaks (and probably outputs an error message) if the new instance
900couldn't be created. Returns <code>undef</code> if the new instance didn't 1079couldn't be created. Returns <code>undef</code> if the new instance didn't
901initialise perl, and the terminal object otherwise. The <code>init</code> and 1080initialise perl, and the terminal object otherwise. The <code>init</code> and
902<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 1081<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
1082refer to global data (which is race free).</p>
903</dd> 1083</dd>
904<p></p> 1084</li>
905<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1085<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong>
906</dt> 1086
907<dd> 1087<dd>
908Destroy the terminal object (close the window, free resources 1088<p>Destroy the terminal object (close the window, free resources
909etc.). Please note that rxvt will not exit as long as any event 1089etc.). Please note that rxvt will not exit as long as any event
910watchers (timers, io watchers) are still active. 1090watchers (timers, io watchers) are still active.</p>
911</dd> 1091</dd>
912<p></p> 1092</li>
913<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br /> 1093<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong>
914</dt> 1094
915<dd> 1095<dd>
916Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes 1096<p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
917(``starts'') programs in the background. This function takes care of setting 1097(``starts'') programs in the background. This function takes care of setting
918the user environment before exec'ing the command (e.g. <code>PATH</code>) and should 1098the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
919be preferred over explicit calls to <code>exec</code> or <code>system</code>. 1099be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p>
920</dd> 1100</dd>
921<dd> 1101<dd>
922<p>Returns the pid of the subprocess or <code>undef</code> on error.</p> 1102<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
923</dd> 1103</dd>
924<p></p> 1104</li>
925<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 1105<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong>
926</dt> 1106
927<dd> 1107<dd>
928Returns true if the option specified by <code>$optval</code> is enabled, and 1108<p>Returns true if the option specified by <code>$optval</code> is enabled, and
929optionally change it. All option values are stored by name in the hash 1109optionally change it. All option values are stored by name in the hash
930<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. 1110<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p>
931</dd>
932<dd> 1111</dd>
1112<dd>
933<p>Here is a a likely non-exhaustive list of option names, please see the 1113<p>Here is a likely non-exhaustive list of option names, please see the
934source file <em>/src/optinc.h</em> to see the actual list:</p> 1114source file <em>/src/optinc.h</em> to see the actual list:</p>
935</dd> 1115</dd>
936<dd> 1116<dd>
937<pre> 1117<pre>
938 borderLess console cursorBlink cursorUnderline hold iconic insecure 1118 borderLess console cursorBlink cursorUnderline hold iconic insecure
… …
940 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1120 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
941 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1121 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
942 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1122 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
943 transparent tripleclickwords utmpInhibit visualBell</pre> 1123 transparent tripleclickwords utmpInhibit visualBell</pre>
944</dd> 1124</dd>
945<p></p> 1125</li>
946<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 1126<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong>
947</dt> 1127
948<dd> 1128<dd>
949Returns the current resource value associated with a given name and 1129<p>Returns the current resource value associated with a given name and
950optionally sets a new value. Setting values is most useful in the <code>init</code> 1130optionally sets a new value. Setting values is most useful in the <code>init</code>
951hook. Unset resources are returned and accepted as <code>undef</code>. 1131hook. Unset resources are returned and accepted as <code>undef</code>.</p>
952</dd> 1132</dd>
953<dd> 1133<dd>
954<p>The new value must be properly encoded to a suitable character encoding 1134<p>The new value must be properly encoded to a suitable character encoding
955before passing it to this method. Similarly, the returned value may need 1135before passing it to this method. Similarly, the returned value may need
956to be converted from the used encoding to text.</p> 1136to be converted from the used encoding to text.</p>
… …
963<dd> 1143<dd>
964<p>Please note that resource strings will currently only be freed when the 1144<p>Please note that resource strings will currently only be freed when the
965terminal is destroyed, so changing options frequently will eat memory.</p> 1145terminal is destroyed, so changing options frequently will eat memory.</p>
966</dd> 1146</dd>
967<dd> 1147<dd>
968<p>Here is a a likely non-exhaustive list of resource names, not all of which 1148<p>Here is a likely non-exhaustive list of resource names, not all of which
969are supported in every build, please see the source file <em>/src/rsinc.h</em> 1149are supported in every build, please see the source file <em>/src/rsinc.h</em>
970to see the actual list:</p> 1150to see the actual list:</p>
971</dd> 1151</dd>
972<dd> 1152<dd>
973<pre> 1153<pre>
… …
983 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1163 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
984 secondaryScreen secondaryScroll selectstyle shade term_name title 1164 secondaryScreen secondaryScroll selectstyle shade term_name title
985 transient_for transparent transparent_all tripleclickwords utmpInhibit 1165 transient_for transparent transparent_all tripleclickwords utmpInhibit
986 visualBell</pre> 1166 visualBell</pre>
987</dd> 1167</dd>
988<p></p> 1168</li>
989<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 1169<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong>
990</dt> 1170
991<dd> 1171<dd>
992Returns the X-Resource for the given pattern, excluding the program or 1172<p>Returns the X-Resource for the given pattern, excluding the program or
993class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the 1173class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
994same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no 1174same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
995resource with that pattern exists. 1175resource with that pattern exists.</p>
996</dd> 1176</dd>
997<dd> 1177<dd>
998<p>This method should only be called during the <code>on_start</code> hook, as there is 1178<p>This method should only be called during the <code>on_start</code> hook, as there is
999only one resource database per display, and later invocations might return 1179only one resource database per display, and later invocations might return
1000the wrong resources.</p> 1180the wrong resources.</p>
1001</dd> 1181</dd>
1002<p></p> 1182</li>
1003<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 1183<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong>
1004</dt> 1184
1005<dd> 1185<dd>
1006Adds a keymap translation exactly as specified via a resource. See the 1186<p>Adds a keymap translation exactly as specified via a resource. See the
1007<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 1187<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.</p>
1008</dd> 1188</dd>
1009<p></p> 1189</li>
1010<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 1190<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong>
1011</dt> 1191
1012<dd> 1192<dd>
1013Return and optionally change the current rendition. Text that is output by 1193<p>Return and optionally change the current rendition. Text that is output by
1014the terminal application will use this style. 1194the terminal application will use this style.</p>
1015</dd> 1195</dd>
1016<p></p> 1196</li>
1017<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br /> 1197<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong>
1018</dt> 1198
1019<dd> 1199<dd>
1020Return the current coordinates of the text cursor position and optionally 1200<p>Return the current coordinates of the text cursor position and optionally
1021set it (which is usually bad as applications don't expect that). 1201set it (which is usually bad as applications don't expect that).</p>
1022</dd> 1202</dd>
1023<p></p> 1203</li>
1024<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1204<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong>
1025</dt> 1205
1026<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 1206<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong>
1027</dt> 1207
1028<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 1208<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong>
1029</dt> 1209
1030<dd> 1210<dd>
1031Return the current values of the selection mark, begin or end positions, 1211<p>Return the current values of the selection mark, begin or end positions,
1032and optionally set them to new values. 1212and optionally set them to new values.</p>
1033</dd> 1213</dd>
1034<p></p> 1214</li>
1035<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br /> 1215<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong>
1036</dt> 1216
1037<dd> 1217<dd>
1038Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and 1218<p>Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1039<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a 1219<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1040rectangular selection will be made. This is the prefered function to make 1220rectangular selection will be made. This is the prefered function to make
1041a selection. 1221a selection.</p>
1042</dd> 1222</dd>
1043<p></p> 1223</li>
1044<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1224<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong>
1045</dt> 1225
1046<dd> 1226<dd>
1047Try to request the primary selection text from the server (for example, as 1227<p>Try to request the primary selection text from the server (for example, as
1048set by the next method). No visual feedback will be given. This function 1228set by the next method). No visual feedback will be given. This function
1049is mostly useful from within <code>on_sel_grab</code> hooks. 1229is mostly useful from within <code>on_sel_grab</code> hooks.</p>
1050</dd> 1230</dd>
1051<p></p> 1231</li>
1052<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1232<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong>
1053</dt> 1233
1054<dd> 1234<dd>
1055Return the current selection text and optionally replace it by <code>$newtext</code>. 1235<p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p>
1056</dd> 1236</dd>
1057<p></p> 1237</li>
1058<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br /> 1238<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong>
1059</dt> 1239
1060<dd> 1240<dd>
1061Create a simple multi-line overlay box. See the next method for details. 1241<p>Create a simple multi-line overlay box. See the next method for details.</p>
1062</dd> 1242</dd>
1063<p></p> 1243</li>
1064<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 1244<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong>
1065</dt> 1245
1066<dd> 1246<dd>
1067Create a new (empty) overlay at the given position with the given 1247<p>Create a new (empty) overlay at the given position with the given
1068width/height. <code>$rstyle</code> defines the initial rendition style 1248width/height. <code>$rstyle</code> defines the initial rendition style
1069(default: <code>OVERLAY_RSTYLE</code>). 1249(default: <code>OVERLAY_RSTYLE</code>).</p>
1070</dd> 1250</dd>
1071<dd> 1251<dd>
1072<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put 1252<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
1073around the box.</p> 1253around the box.</p>
1074</dd> 1254</dd>
… …
1082</dd> 1262</dd>
1083<dd> 1263<dd>
1084<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> 1264<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
1085</dd> 1265</dd>
1086<dl> 1266<dl>
1087<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 1267<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong>
1088</dt> 1268
1089<dd> 1269<dd>
1090Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts 1270<p>Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
1091text in rxvt-unicode's special encoding and an array of rendition values 1271text in rxvt-unicode's special encoding and an array of rendition values
1092at a specific position inside the overlay. 1272at a specific position inside the overlay.</p>
1093</dd> 1273</dd>
1094<p></p> 1274</li>
1095<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br /> 1275<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong>
1096</dt> 1276
1097<dd> 1277<dd>
1098If visible, hide the overlay, but do not destroy it. 1278<p>If visible, hide the overlay, but do not destroy it.</p>
1099</dd> 1279</dd>
1100<p></p> 1280</li>
1101<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br /> 1281<dt><strong><a name="item_show">$overlay-&gt;show</a></strong>
1102</dt> 1282
1103<dd> 1283<dd>
1104If hidden, display the overlay again. 1284<p>If hidden, display the overlay again.</p>
1285</dd>
1286</li>
1105</dd> 1287</dl>
1106<p></p></dl>
1107<dt><strong>$popup = $term-&gt;popup ($event)</strong><br /> 1288<dt><strong>$popup = $term-&gt;popup ($event)</strong>
1108</dt> 1289
1109<dd> 1290<dd>
1110Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 1291<p>Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1111<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, 1292<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1112currently). 1293currently).</p>
1113</dd> 1294</dd>
1114<p></p> 1295</li>
1115<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br /> 1296<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong>
1116</dt> 1297
1117<dd> 1298<dd>
1118Returns the number of screen-cells this string would need. Correctly 1299<p>Returns the number of screen-cells this string would need. Correctly
1119accounts for wide and combining characters. 1300accounts for wide and combining characters.</p>
1120</dd> 1301</dd>
1121<p></p> 1302</li>
1122<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br /> 1303<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong>
1123</dt> 1304
1124<dd> 1305<dd>
1125Convert the given text string into the corresponding locale encoding. 1306<p>Convert the given text string into the corresponding locale encoding.</p>
1126</dd> 1307</dd>
1127<p></p> 1308</li>
1128<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 1309<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong>
1129</dt> 1310
1130<dd> 1311<dd>
1131Convert the given locale-encoded octets into a perl string. 1312<p>Convert the given locale-encoded octets into a perl string.</p>
1132</dd> 1313</dd>
1133<p></p> 1314</li>
1134<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 /> 1315<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong>
1135</dt> 1316
1136<dd> 1317<dd>
1137XORs the rendition values in the given span with the provided value 1318<p>XORs the rendition values in the given span with the provided value
1138(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in 1319(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1139refresh hooks to provide effects similar to the selection. 1320refresh hooks to provide effects similar to the selection.</p>
1140</dd> 1321</dd>
1141<p></p> 1322</li>
1142<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 /> 1323<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>
1143</dt> 1324
1144<dd> 1325<dd>
1145Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 1326<p>Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1146whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 1327whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1147to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 1328to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1148it instead. Both styles <em>MUST NOT</em> contain font styles. 1329it instead. Both styles <em>MUST NOT</em> contain font styles.</p>
1149</dd> 1330</dd>
1150<p></p> 1331</li>
1151<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 1332<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong>
1152</dt> 1333
1153<dd>
1154Ring the bell!
1155</dd> 1334<dd>
1156<p></p> 1335<p>Ring the bell!</p>
1336</dd>
1337</li>
1157<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 1338<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong>
1158</dt> 1339
1159<dd> 1340<dd>
1160Write the given text string to the screen, as if output by the application 1341<p>Write the given text string to the screen, as if output by the application
1161running inside the terminal. It may not contain command sequences (escape 1342running inside the terminal. It may not contain command sequences (escape
1162codes), but is free to use line feeds, carriage returns and tabs. The 1343codes), but is free to use line feeds, carriage returns and tabs. The
1163string is a normal text string, not in locale-dependent encoding. 1344string is a normal text string, not in locale-dependent encoding.</p>
1164</dd> 1345</dd>
1165<dd> 1346<dd>
1166<p>Normally its not a good idea to use this function, as programs might be 1347<p>Normally its not a good idea to use this function, as programs might be
1167confused by changes in cursor position or scrolling. Its useful inside a 1348confused by changes in cursor position or scrolling. Its useful inside a
1168<code>on_add_lines</code> hook, though.</p> 1349<code>on_add_lines</code> hook, though.</p>
1169</dd> 1350</dd>
1170<p></p> 1351</li>
1171<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br /> 1352<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong>
1172</dt> 1353
1173<dd> 1354<dd>
1174Switch to given screen - 0 primary, 1 secondary. 1355<p>Switch to given screen - 0 primary, 1 secondary.</p>
1175</dd> 1356</dd>
1176<p></p> 1357</li>
1177<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1358<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong>
1178</dt> 1359
1179<dd> 1360<dd>
1180Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1361<p>Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1181locale-specific encoding of the terminal and can contain command sequences 1362locale-specific encoding of the terminal and can contain command sequences
1182(escape codes) that will be interpreted. 1363(escape codes) that will be interpreted.</p>
1183</dd> 1364</dd>
1184<p></p> 1365</li>
1185<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1366<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong>
1186</dt> 1367
1187<dd> 1368<dd>
1188Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1369<p>Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
1189pass characters instead of octets, you should convert your strings first 1370pass characters instead of octets, you should convert your strings first
1190to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1371to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.</p>
1191</dd> 1372</dd>
1192<p></p> 1373</li>
1193<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br /> 1374<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong>
1194</dt> 1375
1195<dd> 1376<dd>
1196Replaces the event mask of the pty watcher by the given event mask. Can 1377<p>Replaces the event mask of the pty watcher by the given event mask. Can
1197be used to suppress input and output handling to the pty/tty. See the 1378be used to suppress input and output handling to the pty/tty. See the
1198description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1379description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1199the previous value. 1380the previous value.</p>
1381</dd>
1382</li>
1383<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong>
1384
1200</dd> 1385<dd>
1201<p></p> 1386<p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1387is used.</p>
1388</dd>
1389</li>
1202<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1390<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong>
1203</dt> 1391
1204<dd> 1392<dd>
1205Return the window id of the toplevel window. 1393<p>Return the window id of the toplevel window.</p>
1206</dd> 1394</dd>
1207<p></p> 1395</li>
1208<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br /> 1396<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong>
1209</dt> 1397
1210<dd> 1398<dd>
1211Return the window id of the terminal window. 1399<p>Return the window id of the terminal window.</p>
1212</dd> 1400</dd>
1213<p></p> 1401</li>
1214<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br /> 1402<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong>
1215</dt> 1403
1216<dd> 1404<dd>
1217Adds the specified events to the vt event mask. Useful e.g. when you want 1405<p>Adds the specified events to the vt event mask. Useful e.g. when you want
1218to receive pointer events all the times: 1406to receive pointer events all the times:</p>
1219</dd> 1407</dd>
1220<dd> 1408<dd>
1221<pre> 1409<pre>
1222 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1410 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1223</dd> 1411</dd>
1224<p></p> 1412</li>
1413<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong>
1414
1415<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong>
1416
1417<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong>
1418
1419<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong>
1420
1421<dd>
1422<p>Deliver various fake events to to terminal.</p>
1423</dd>
1424</li>
1225<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1425<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong>
1226</dt> 1426
1227<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1427<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong>
1228</dt> 1428
1229<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1429<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong>
1230</dt> 1430
1231<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br /> 1431<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong>
1232</dt> 1432
1233<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br /> 1433<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong>
1234</dt> 1434
1235<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br /> 1435<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong>
1236</dt> 1436
1237<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br /> 1437<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong>
1238</dt> 1438
1239<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br /> 1439<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong>
1240</dt> 1440
1241<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br /> 1441<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong>
1242</dt> 1442
1243<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1443<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong>
1244</dt> 1444
1245<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1445<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong>
1246</dt> 1446
1247<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br /> 1447<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong>
1248</dt> 1448
1249<dd> 1449<dd>
1250Return various integers describing terminal characteristics. 1450<p>Return various integers describing terminal characteristics.</p>
1251</dd> 1451</dd>
1252<p></p> 1452</li>
1253<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 1453<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong>
1254</dt> 1454
1255<dd> 1455<dd>
1256Return the DISPLAY used by rxvt-unicode. 1456<p>Return the DISPLAY used by rxvt-unicode.</p>
1257</dd> 1457</dd>
1258<p></p> 1458</li>
1259<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 1459<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong>
1260</dt> 1460
1261<dd> 1461<dd>
1262Returns the LC_CTYPE category string used by this rxvt-unicode. 1462<p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>
1263</dd> 1463</dd>
1264<p></p> 1464</li>
1265<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br /> 1465<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong>
1266</dt> 1466
1267<dd> 1467<dd>
1268Returns a copy of the environment in effect for the terminal as a hashref 1468<p>Returns a copy of the environment in effect for the terminal as a hashref
1269similar to <code>\%ENV</code>. 1469similar to <code>\%ENV</code>.</p>
1470</dd>
1471</li>
1472<dt><strong><a name="item_envv">@envv = $term-&gt;envv</a></strong>
1473
1270</dd> 1474<dd>
1271<p></p> 1475<p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p>
1476</dd>
1477</li>
1478<dt><strong><a name="item_argv">@argv = $term-&gt;argv</a></strong>
1479
1480<dd>
1481<p>Return the argument vector as this terminal, similar to @ARGV, but
1482includes the program name as first element.</p>
1483</dd>
1484</li>
1272<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1485<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong>
1273</dt> 1486
1274<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1487<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong>
1275</dt> 1488
1276<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br /> 1489<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong>
1277</dt> 1490
1278<dd> 1491<dd>
1279Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1492<p>Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1280AltGr), the meta key (often Alt) and the num lock key, if applicable. 1493AltGr), the meta key (often Alt) and the num lock key, if applicable.</p>
1281</dd> 1494</dd>
1282<p></p> 1495</li>
1283<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br /> 1496<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong>
1284</dt> 1497
1285<dd> 1498<dd>
1286Returns the currently displayed screen (0 primary, 1 secondary). 1499<p>Returns the currently displayed screen (0 primary, 1 secondary).</p>
1287</dd> 1500</dd>
1288<p></p> 1501</li>
1289<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br /> 1502<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong>
1290</dt> 1503
1291<dd> 1504<dd>
1292Returns wether the cursor is currently hidden or not. 1505<p>Returns whether the cursor is currently hidden or not.</p>
1293</dd> 1506</dd>
1294<p></p> 1507</li>
1295<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1508<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong>
1296</dt> 1509
1297<dd> 1510<dd>
1298Returns the row number of the topmost displayed line. Maximum value is 1511<p>Returns the row number of the topmost displayed line. Maximum value is
1299<code>0</code>, which displays the normal terminal contents. Lower values scroll 1512<code>0</code>, which displays the normal terminal contents. Lower values scroll
1300this many lines into the scrollback buffer. 1513this many lines into the scrollback buffer.</p>
1301</dd> 1514</dd>
1302<p></p> 1515</li>
1303<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1516<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong>
1304</dt> 1517
1305<dd> 1518<dd>
1306Requests a screen refresh. At the next opportunity, rxvt-unicode will 1519<p>Requests a screen refresh. At the next opportunity, rxvt-unicode will
1307compare the on-screen display with its stored representation. If they 1520compare the on-screen display with its stored representation. If they
1308differ, it redraws the differences. 1521differ, it redraws the differences.</p>
1309</dd> 1522</dd>
1310<dd> 1523<dd>
1311<p>Used after changing terminal contents to display them.</p> 1524<p>Used after changing terminal contents to display them.</p>
1312</dd> 1525</dd>
1313<p></p> 1526</li>
1314<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> 1527<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong>
1315</dt> 1528
1316<dd> 1529<dd>
1317Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1530<p>Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1318is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1531is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1319terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1532terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1320line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line 1533line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1321is requested. 1534is requested.</p>
1322</dd> 1535</dd>
1323<dd> 1536<dd>
1324<p>If <code>$new_text</code> is specified, it will replace characters in the current 1537<p>If <code>$new_text</code> is specified, it will replace characters in the current
1325line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1538line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1326to replace only parts of a line. The font index in the rendition will 1539to replace only parts of a line. The font index in the rendition will
1327automatically be updated.</p> 1540automatically be updated.</p>
1328</dd> 1541</dd>
1329<dd> 1542<dd>
1330<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use 1543<p><a href="#item__text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1331more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> 1544than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1332characters. Characters with combining characters and other characters that 1545characters. Characters with combining characters and other characters that
1333do not fit into the normal tetx encoding will be replaced with characters 1546do not fit into the normal tetx encoding will be replaced with characters
1334in the private use area.</p> 1547in the private use area.</p>
1335</dd> 1548</dd>
1336<dd> 1549<dd>
… …
1340</dd> 1553</dd>
1341<dd> 1554<dd>
1342<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1555<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
1343can be used to convert normal strings into this encoding and vice versa.</p> 1556can be used to convert normal strings into this encoding and vice versa.</p>
1344</dd> 1557</dd>
1345<p></p> 1558</li>
1346<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1559<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong>
1347</dt> 1560
1348<dd> 1561<dd>
1349Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition 1562<p>Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1350bitsets. Rendition bitsets contain information about colour, font, font 1563bitsets. Rendition bitsets contain information about colour, font, font
1351styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>. 1564styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.</p>
1352</dd> 1565</dd>
1353<dd> 1566<dd>
1354<p>When setting rendition, the font mask will be ignored.</p> 1567<p>When setting rendition, the font mask will be ignored.</p>
1355</dd> 1568</dd>
1356<dd> 1569<dd>
1357<p>See the section on RENDITION, above.</p> 1570<p>See the section on RENDITION, above.</p>
1358</dd> 1571</dd>
1359<p></p> 1572</li>
1360<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 1573<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong>
1361</dt> 1574
1362<dd> 1575<dd>
1363Returns the number of screen cells that are in use (``the line 1576<p>Returns the number of screen cells that are in use (``the line
1364length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the 1577length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1365line is joined with the following one. 1578line is joined with the following one.</p>
1366</dd> 1579</dd>
1367<p></p> 1580</li>
1368<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br /> 1581<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong>
1369</dt> 1582
1370<dd> 1583<dd>
1371Returns true if the row is part of a multiple-row logical ``line'' (i.e. 1584<p>Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1372joined with the following row), which means all characters are in use 1585joined with the following row), which means all characters are in use
1373and it is continued on the next row (and possibly a continuation of the 1586and it is continued on the next row (and possibly a continuation of the
1374previous row(s)). 1587previous row(s)).</p>
1375</dd> 1588</dd>
1376<p></p> 1589</li>
1377<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br /> 1590<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong>
1378</dt> 1591
1379<dd> 1592<dd>
1380Create and return a new <code>urxvt::line</code> object that stores information 1593<p>Create and return a new <code>urxvt::line</code> object that stores information
1381about the logical line that row <code>$row_number</code> is part of. It supports the 1594about the logical line that row <code>$row_number</code> is part of. It supports the
1382following methods: 1595following methods:</p>
1383</dd> 1596</dd>
1384<dl> 1597<dl>
1385<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br /> 1598<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong>
1386</dt> 1599
1387<dd> 1600<dd>
1388Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1601<p>Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a></p>
1389</dd> 1602</dd>
1390<p></p> 1603</li>
1391<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br /> 1604<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong>
1392</dt> 1605
1393<dd> 1606<dd>
1394Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1607<p>Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a></p>
1395</dd> 1608</dd>
1396<p></p> 1609</li>
1397<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1610<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong>
1398</dt> 1611
1399<dd> 1612<dd>
1400Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. 1613<p>Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.</p>
1401</dd> 1614</dd>
1402<p></p> 1615</li>
1403<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br /> 1616<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong>
1404</dt> 1617
1405<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br /> 1618<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong>
1406</dt> 1619
1407<dd> 1620<dd>
1408Return the row number of the first/last row of the line, respectively. 1621<p>Return the row number of the first/last row of the line, respectively.</p>
1409</dd> 1622</dd>
1410<p></p> 1623</li>
1411<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1624<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong>
1412</dt> 1625
1413<dd> 1626<dd>
1414Returns the character offset of the given row|col pair within the logical 1627<p>Returns the character offset of the given row|col pair within the logical
1415line. Works for rows outside the line, too, and returns corresponding 1628line. Works for rows outside the line, too, and returns corresponding
1416offsets outside the string. 1629offsets outside the string.</p>
1417</dd> 1630</dd>
1418<p></p> 1631</li>
1419<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1632<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong>
1420</dt> 1633
1421<dd> 1634<dd>
1422Translates a string offset into terminal coordinates again. 1635<p>Translates a string offset into terminal coordinates again.</p>
1636</dd>
1637</li>
1423</dd> 1638</dl>
1424<p></p></dl>
1425<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 1639<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong>
1426</dt> 1640
1427<dd> 1641<dd>
1428Converts a perl string into the special encoding used by rxvt-unicode, 1642<p>Converts a perl string into the special encoding used by rxvt-unicode,
1429where one character corresponds to one screen cell. See 1643where one character corresponds to one screen cell. See
1430<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1644<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.</p>
1431</dd> 1645</dd>
1432<p></p> 1646</li>
1433<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1647<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong>
1434</dt> 1648
1435<dd> 1649<dd>
1436Converts rxvt-unicodes text reprsentation into a perl string. See 1650<p>Converts rxvt-unicodes text representation into a perl string. See
1437<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1651<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.</p>
1438</dd>
1439<p></p>
1440<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1441</dt>
1442<dd> 1652</dd>
1443Registers a synchronous button grab. See the XGrabButton manpage. 1653</li>
1654<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong>
1655
1656<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong>
1657
1444</dd> 1658<dd>
1445<p></p> 1659<p>Register/unregister a synchronous button grab. See the XGrabButton
1660manpage.</p>
1661</dd>
1662</li>
1446<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1663<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong>
1447</dt> 1664
1448<dd> 1665<dd>
1449Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1666<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1450synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. 1667synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
1451</dd> 1668</dd>
1452<p></p> 1669</li>
1453<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br /> 1670<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong>
1454</dt> 1671
1455<dd> 1672<dd>
1456Calls XAllowEvents with AsyncBoth for the most recent grab. 1673<p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>
1457</dd> 1674</dd>
1458<p></p> 1675</li>
1459<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br /> 1676<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong>
1460</dt> 1677
1461<dd> 1678<dd>
1462Calls XAllowEvents with SyncBoth for the most recent grab. 1679<p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>
1463</dd> 1680</dd>
1464<p></p> 1681</li>
1465<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br /> 1682<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong>
1466</dt> 1683
1467<dd> 1684<dd>
1468Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1685<p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1469recent grab. 1686recent grab.</p>
1470</dd> 1687</dd>
1471<p></p> 1688</li>
1472<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br /> 1689<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong>
1473</dt> 1690
1474<dd> 1691<dd>
1475Calls XUngrab for the most recent grab. Is called automatically on 1692<p>Calls XUngrab for the most recent grab. Is called automatically on
1476evaluation errors, as it is better to lose the grab in the error case as 1693evaluation errors, as it is better to lose the grab in the error case as
1477the session. 1694the session.</p>
1478</dd> 1695</dd>
1479<p></p> 1696</li>
1480<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> 1697<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong>
1481</dt> 1698
1482<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br /> 1699<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong>
1483</dt> 1700
1484<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br /> 1701<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong>
1485</dt> 1702
1486<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br /> 1703<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong>
1487</dt> 1704
1488<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> 1705<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong>
1489</dt> 1706
1490<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br /> 1707<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong>
1491</dt> 1708
1492<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br /> 1709<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong>
1493</dt> 1710
1494<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> 1711<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong>
1495</dt> 1712
1496<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br /> 1713<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong>
1497</dt> 1714
1498<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br /> 1715<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong>
1499</dt> 1716
1500<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> 1717<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong>
1501</dt> 1718
1502<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> 1719<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong>
1503</dt> 1720
1504<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> 1721<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong>
1505</dt> 1722
1506<dd> 1723<dd>
1507Various X or X-related functions. The <code>$term</code> object only serves as 1724<p>Various X or X-related functions. The <a href="#item__term"><code>$term</code></a> object only serves as
1508the source of the display, otherwise those functions map more-or-less 1725the source of the display, otherwise those functions map more-or-less
1509directory onto the X functions of the same name. 1726directory onto the X functions of the same name.</p>
1727</dd>
1728</li>
1510</dd> 1729</dl>
1511<p></p></dl>
1512<p> 1730<p>
1513</p> 1731</p>
1514<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1732<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1515<dl> 1733<dl>
1516<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br /> 1734<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong>
1517</dt> 1735
1518<dd> 1736<dd>
1519Adds a non-clickable title to the popup. 1737<p>Adds a non-clickable title to the popup.</p>
1520</dd> 1738</dd>
1521<p></p> 1739</li>
1522<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br /> 1740<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong>
1523</dt> 1741
1524<dd> 1742<dd>
1525Creates a separator, optionally using the character given as <code>$sepchr</code>. 1743<p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p>
1526</dd> 1744</dd>
1527<p></p> 1745</li>
1528<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br /> 1746<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong>
1529</dt> 1747
1530<dd> 1748<dd>
1531Adds a clickable button to the popup. <code>$cb</code> is called whenever it is 1749<p>Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1532selected. 1750selected.</p>
1533</dd> 1751</dd>
1534<p></p> 1752</li>
1535<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br /> 1753<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong>
1536</dt> 1754
1537<dd> 1755<dd>
1538Adds a toggle/checkbox item to the popup. Teh callback gets called 1756<p>Adds a toggle/checkbox item to the popup. The callback gets called
1539whenever it gets toggled, with a boolean indicating its value as its first 1757whenever it gets toggled, with a boolean indicating its new value as its
1540argument. 1758first argument.</p>
1541</dd> 1759</dd>
1542<p></p> 1760</li>
1543<dt><strong>$popup-&gt;show</strong><br /> 1761<dt><strong>$popup-&gt;show</strong>
1544</dt> 1762
1545<dd> 1763<dd>
1546Displays the popup (which is initially hidden). 1764<p>Displays the popup (which is initially hidden).</p>
1765</dd>
1766</li>
1547</dd> 1767</dl>
1548<p></p></dl>
1549<p> 1768<p>
1550</p> 1769</p>
1551<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1770<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1552<p>This class implements timer watchers/events. Time is represented as a 1771<p>This class implements timer watchers/events. Time is represented as a
1553fractional number of seconds since the epoch. Example:</p> 1772fractional number of seconds since the epoch. Example:</p>
… …
1559 -&gt;cb (sub { 1778 -&gt;cb (sub {
1560 $term-&gt;{overlay}-&gt;set (0, 0, 1779 $term-&gt;{overlay}-&gt;set (0, 0,
1561 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]); 1780 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
1562 });</pre> 1781 });</pre>
1563<dl> 1782<dl>
1564<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1783<dt><strong><a name="item__timer">$timer = new urxvt::timer</a></strong>
1565</dt> 1784
1566<dd> 1785<dd>
1567Create a new timer object in started state. It is scheduled to fire 1786<p>Create a new timer object in started state. It is scheduled to fire
1568immediately. 1787immediately.</p>
1569</dd> 1788</dd>
1570<p></p> 1789</li>
1571<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1790<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong>
1572</dt> 1791
1573<dd> 1792<dd>
1574Set the callback to be called when the timer triggers. 1793<p>Set the callback to be called when the timer triggers.</p>
1575</dd> 1794</dd>
1576<p></p> 1795</li>
1577<dt><strong><a name="item_at">$tstamp = $timer-&gt;at</a></strong><br /> 1796<dt><strong><a name="item_at">$tstamp = $timer-&gt;at</a></strong>
1578</dt> 1797
1579<dd> 1798<dd>
1580Return the time this watcher will fire next. 1799<p>Return the time this watcher will fire next.</p>
1581</dd> 1800</dd>
1582<p></p> 1801</li>
1583<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br /> 1802<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong>
1584</dt> 1803
1585<dd> 1804<dd>
1586Set the time the event is generated to $tstamp. 1805<p>Set the time the event is generated to $tstamp.</p>
1587</dd> 1806</dd>
1588<p></p> 1807</li>
1589<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br /> 1808<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong>
1590</dt> 1809
1591<dd> 1810<dd>
1592Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically 1811<p>Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1593stop after it has fired once. If <code>$interval</code> is non-zero, then the timer 1812stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1594is automatically rescheduled at the given intervals. 1813is automatically rescheduled at the given intervals.</p>
1595</dd> 1814</dd>
1596<p></p> 1815</li>
1597<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1816<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong>
1598</dt> 1817
1599<dd>
1600Start the timer.
1601</dd> 1818<dd>
1602<p></p> 1819<p>Start the timer.</p>
1820</dd>
1821</li>
1603<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1822<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong>
1604</dt> 1823
1605<dd> 1824<dd>
1606Set the event trigger time to <code>$tstamp</code> and start the timer. 1825<p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p>
1607</dd> 1826</dd>
1608<p></p> 1827</li>
1609<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br /> 1828<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong>
1610</dt> 1829
1611<dd> 1830<dd>
1612Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;. 1831<p>Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.</p>
1613</dd> 1832</dd>
1614<p></p> 1833</li>
1615<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1834<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong>
1616</dt> 1835
1617<dd>
1618Stop the timer.
1619</dd> 1836<dd>
1620<p></p></dl> 1837<p>Stop the timer.</p>
1838</dd>
1839</li>
1840</dl>
1621<p> 1841<p>
1622</p> 1842</p>
1623<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> 1843<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2>
1624<p>This class implements io watchers/events. Example:</p> 1844<p>This class implements io watchers/events. Example:</p>
1625<pre> 1845<pre>
… …
1634 # $revents must be 1 here, no need to check 1854 # $revents must be 1 here, no need to check
1635 sysread $term-&gt;{socket}, my $buf, 8192 1855 sysread $term-&gt;{socket}, my $buf, 8192
1636 or end-of-file; 1856 or end-of-file;
1637 });</pre> 1857 });</pre>
1638<dl> 1858<dl>
1639<dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> 1859<dt><strong><a name="item__iow">$iow = new urxvt::iow</a></strong>
1640</dt> 1860
1641<dd> 1861<dd>
1642Create a new io watcher object in stopped state. 1862<p>Create a new io watcher object in stopped state.</p>
1643</dd> 1863</dd>
1644<p></p> 1864</li>
1645<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> 1865<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong>
1646</dt> 1866
1647<dd> 1867<dd>
1648Set the callback to be called when io events are triggered. <code>$reventmask</code> 1868<p>Set the callback to be called when io events are triggered. <code>$reventmask</code>
1649is a bitset as described in the <a href="#item_events"><code>events</code></a> method. 1869is a bitset as described in the <a href="#item_events"><code>events</code></a> method.</p>
1650</dd> 1870</dd>
1651<p></p> 1871</li>
1652<dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong><br /> 1872<dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong>
1653</dt> 1873
1654<dd> 1874<dd>
1655Set the filedescriptor (not handle) to watch. 1875<p>Set the file descriptor (not handle) to watch.</p>
1656</dd> 1876</dd>
1657<p></p> 1877</li>
1658<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1878<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong>
1659</dt> 1879
1660<dd> 1880<dd>
1661Set the event mask to watch. The only allowed values are 1881<p>Set the event mask to watch. The only allowed values are
1662<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed 1882<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1663together, or <code>urxvt::EVENT_NONE</code>. 1883together, or <code>urxvt::EVENT_NONE</code>.</p>
1664</dd> 1884</dd>
1665<p></p> 1885</li>
1666<dt><strong>$iow = $iow-&gt;start</strong><br /> 1886<dt><strong>$iow = $iow-&gt;start</strong>
1667</dt> 1887
1668<dd> 1888<dd>
1669Start watching for requested events on the given handle. 1889<p>Start watching for requested events on the given handle.</p>
1670</dd> 1890</dd>
1671<p></p> 1891</li>
1672<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1892<dt><strong>$iow = $iow-&gt;stop</strong>
1673</dt> 1893
1674<dd> 1894<dd>
1675Stop watching for events on the given filehandle. 1895<p>Stop watching for events on the given file handle.</p>
1896</dd>
1897</li>
1676</dd> 1898</dl>
1677<p></p></dl>
1678<p> 1899<p>
1679</p> 1900</p>
1680<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> 1901<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1681<p>This class implements idle watchers, that get called automatically when 1902<p>This class implements idle watchers, that get called automatically when
1682the process is idle. They should return as fast as possible, after doing 1903the process is idle. They should return as fast as possible, after doing
1683some useful work.</p> 1904some useful work.</p>
1684<dl> 1905<dl>
1685<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> 1906<dt><strong><a name="item__iw">$iw = new urxvt::iw</a></strong>
1686</dt> 1907
1687<dd> 1908<dd>
1688Create a new idle watcher object in stopped state. 1909<p>Create a new idle watcher object in stopped state.</p>
1689</dd> 1910</dd>
1690<p></p> 1911</li>
1691<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br /> 1912<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong>
1692</dt> 1913
1693<dd> 1914<dd>
1694Set the callback to be called when the watcher triggers. 1915<p>Set the callback to be called when the watcher triggers.</p>
1695</dd> 1916</dd>
1696<p></p> 1917</li>
1697<dt><strong>$timer = $timer-&gt;start</strong><br /> 1918<dt><strong>$timer = $timer-&gt;start</strong>
1698</dt> 1919
1699<dd>
1700Start the watcher.
1701</dd> 1920<dd>
1702<p></p> 1921<p>Start the watcher.</p>
1922</dd>
1923</li>
1703<dt><strong>$timer = $timer-&gt;stop</strong><br /> 1924<dt><strong>$timer = $timer-&gt;stop</strong>
1704</dt> 1925
1705<dd>
1706Stop the watcher.
1707</dd> 1926<dd>
1708<p></p></dl> 1927<p>Stop the watcher.</p>
1928</dd>
1929</li>
1930</dl>
1709<p> 1931<p>
1710</p> 1932</p>
1711<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> 1933<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1712<p>This class implements process watchers. They create an event whenever a 1934<p>This class implements process watchers. They create an event whenever a
1713process exits, after which they stop automatically.</p> 1935process exits, after which they stop automatically.</p>
… …
1720 -&gt;cb (sub { 1942 -&gt;cb (sub {
1721 my ($pw, $exit_status) = @_; 1943 my ($pw, $exit_status) = @_;
1722 ... 1944 ...
1723 });</pre> 1945 });</pre>
1724<dl> 1946<dl>
1725<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> 1947<dt><strong><a name="item__pw">$pw = new urxvt::pw</a></strong>
1726</dt> 1948
1727<dd> 1949<dd>
1728Create a new process watcher in stopped state. 1950<p>Create a new process watcher in stopped state.</p>
1729</dd> 1951</dd>
1730<p></p> 1952</li>
1731<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> 1953<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong>
1732</dt> 1954
1733<dd> 1955<dd>
1734Set the callback to be called when the timer triggers. 1956<p>Set the callback to be called when the timer triggers.</p>
1735</dd> 1957</dd>
1736<p></p> 1958</li>
1737<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br /> 1959<dt><strong>$pw = $timer-&gt;start ($pid)</strong>
1738</dt> 1960
1739<dd> 1961<dd>
1740Tells the wqtcher to start watching for process <code>$pid</code>. 1962<p>Tells the watcher to start watching for process <code>$pid</code>.</p>
1741</dd> 1963</dd>
1742<p></p> 1964</li>
1743<dt><strong>$pw = $pw-&gt;stop</strong><br /> 1965<dt><strong>$pw = $pw-&gt;stop</strong>
1744</dt> 1966
1745<dd>
1746Stop the watcher.
1747</dd> 1967<dd>
1748<p></p></dl> 1968<p>Stop the watcher.</p>
1969</dd>
1970</li>
1971</dl>
1749<p> 1972<p>
1750</p> 1973</p>
1751<hr /> 1974<hr />
1752<h1><a name="environment">ENVIRONMENT</a></h1> 1975<h1><a name="environment">ENVIRONMENT</a></h1>
1753<p> 1976<p>
1754</p> 1977</p>
1755<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1978<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1756<p>This variable controls the verbosity level of the perl extension. Higher 1979<p>This variable controls the verbosity level of the perl extension. Higher
1757numbers indicate more verbose output.</p> 1980numbers indicate more verbose output.</p>
1758<dl> 1981<dl>
1759<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1982<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong>
1760</dt> 1983
1761<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1984<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong>
1762</dt> 1985
1763<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br /> 1986<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong>
1764</dt> 1987
1765<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br /> 1988<dt><strong><a name="item__3e_3d11__2d_hook_return_values">&gt;=11 - hook return values</a></strong>
1766</dt> 1989
1767</dl> 1990</dl>
1768<p> 1991<p>
1769</p> 1992</p>
1770<hr /> 1993<hr />
1771<h1><a name="author">AUTHOR</a></h1> 1994<h1><a name="author">AUTHOR</a></h1>

Diff Legend

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