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

Diff Legend

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