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.41 by root, Mon Feb 6 05:55:33 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>
… …
138</dd> 140</dd>
139<dd> 141<dd>
140<p>This extension also offers following bindable keyboard commands:</p> 142<p>This extension also offers following bindable keyboard commands:</p>
141</dd> 143</dd>
142<dl> 144<dl>
143<dt><strong><a name="item_rot13">rot13</a></strong><br /> 145<dt><strong><a name="item_rot13">rot13</a></strong>
144</dt> 146
145<dd> 147<dd>
146Rot-13 the selection when activated. Used via keyboard trigger: 148<p>Rot-13 the selection when activated. Used via keyboard trigger:</p>
147</dd> 149</dd>
148<dd> 150<dd>
149<pre> 151<pre>
150 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 152 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
151</dd> 153</dd>
152<p></p></dl> 154</li>
155</dl>
153<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>
154</dt> 157
155<dd> 158<dd>
156Binds 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
157runtime. 160runtime.</p>
161</dd>
158</dd> 162<dd>
159<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>
160<dt><strong>selection-popup (enabled by default)</strong><br /> 185<dt><strong>selection-popup (enabled by default)</strong>
161</dt> 186
162<dd> 187<dd>
163Binds 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
164text into various other formats/action (such as uri unescaping, perl 189text into various other formats/action (such as uri unescaping, perl
165evaluation, web-browser starting etc.), depending on content. 190evaluation, web-browser starting etc.), depending on content.</p>
166</dd> 191</dd>
167<dd> 192<dd>
168<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
169onto <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
170popup is displayed.</p> 195popup is being displayed.</p>
171</dd> 196</dd>
172<dd> 197<dd>
173<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
174is 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.
175It 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
… …
186 push @{ $self-&gt;{term}{selection_popup_hook} }, sub { 211 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
187 /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 }
188 : () 213 : ()
189 };</pre> 214 };</pre>
190</dd> 215</dd>
191<p></p> 216</li>
192<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>
193</dt> 218
194<dd> 219<dd>
195Adds regex search functionality to the scrollback buffer, triggered 220<p>Adds regex search functionality to the scrollback buffer, triggered
196by 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
197input/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
198screen. 223screen.</p>
199</dd> 224</dd>
200<dd> 225<dd>
201<p>Inputting characters appends them to the regex and continues incremental 226<p>Inputting characters appends them to the regex and continues incremental
202search. <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>
203search 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
204bottom. <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
205was 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
206additionally stores the first match in the current line into the primary 231additionally stores the first match in the current line into the primary
207selection.</p> 232selection.</p>
208</dd> 233</dd>
209<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>
210<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>
211</dt> 244
212<dd> 245<dd>
213A 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
214moment, 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
215move 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
216cursor-left or cursor-right keypresses as required (the this only works 249cursor-left or cursor-right keypresses as required (the this only works
217for programs that correctly support wide characters). 250for programs that correctly support wide characters).</p>
218</dd> 251</dd>
219<dd> 252<dd>
220<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>
221</dd> 254</dd>
222<dl> 255<dl>
223<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</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>
224</dt> 257
225<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> 258<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong>
226</dt> 259
227<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>
228</dt> 261
229<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</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>
230</dt> 263
231</dl> 264</dl>
232<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
233might interfere with selection creation in harmless ways.</p> 266might interfere with selection creation in harmless ways.</p>
234<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 267<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong>
235</dt> 268
236<dd> 269<dd>
237This selection allows you to do automatic transforms on a selection 270<p>This selection allows you to do automatic transforms on a selection
238whenever a selection is made. 271whenever a selection is made.</p>
239</dd> 272</dd>
240<dd> 273<dd>
241<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>
242operator) that modify <code>$_</code> as resources:</p> 275operator) that modify <code>$_</code> as resources:</p>
243</dd> 276</dd>
… …
279<dd> 312<dd>
280<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
281every error message as a selection pattern, and the second line transforms 314every error message as a selection pattern, and the second line transforms
282the message into vi commands to load the file.</p> 315the message into vi commands to load the file.</p>
283</dd> 316</dd>
284<p></p> 317</li>
285<dt><strong><a name="item_tabbed">tabbed</a></strong><br /> 318<dt><strong><a name="item_tabbed">tabbed</a></strong>
286</dt> 319
287<dd> 320<dd>
288This transforms the terminal into a tabbar with additional terminals, that 321<p>This transforms the terminal into a tabbar with additional terminals, that
289is, 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
290displays 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
291button per tab. 324button per tab.</p>
292</dd> 325</dd>
293<dd> 326<dd>
294<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
295<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,
296while <strong>Shift-Down</strong> creates a new tab.</p> 329while <strong>Shift-Down</strong> creates a new tab.</p>
… …
309</dd> 342</dd>
310<dd> 343<dd>
311<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid 344<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
312indices.</p> 345indices.</p>
313</dd> 346</dd>
314<p></p> 347</li>
315<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 348<dt><strong><a name="item_mark_2durls">mark-urls</a></strong>
316</dt> 349
317<dd> 350<dd>
318Uses 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
319make them clickable. When middle-clicked, the program specified in the 352make them clickable. When middle-clicked, the program specified in the
320resource <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
321the URL as first argument. 354the URL as first argument.</p>
322</dd> 355</dd>
323<p></p> 356</li>
324<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> 357<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong>
325</dt> 358
326<dd> 359<dd>
327This (experimental) perl extension implements OnTheSpot editing. It does 360<p>This (experimental) perl extension implements OnTheSpot editing. It does
328not work perfectly, and some input methods don't seem to work well with 361not work perfectly, and some input methods don't seem to work well with
329OnTheSpot editing in general, but it seems to work at leats for SCIM and 362OnTheSpot editing in general, but it seems to work at leats for SCIM and
330kinput2. 363kinput2.</p>
331</dd> 364</dd>
332<dd> 365<dd>
333<p>You enable it by specifying this extension and a preedit style of 366<p>You enable it by specifying this extension and a preedit style of
334<code>OnTheSpot</code>, i.e.:</p> 367<code>OnTheSpot</code>, i.e.:</p>
335</dd> 368</dd>
336<dd> 369<dd>
337<pre> 370<pre>
338 rxvt -pt OnTheSpot -pe xim-onthespot</pre> 371 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
339</dd> 372</dd>
340<p></p> 373</li>
341<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> 374<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong>
342</dt> 375
343<dd> 376<dd>
344This 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
345to the window position, in effect creating the same effect as pseudo transparency with 378background pixmap offset to the window position, in effect creating the
346a 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>
347</dd> 381</dd>
348<dd> 382<dd>
349<pre> 383<pre>
350 rxvt -pixmap background.xpm -pe automove-background</pre> 384 rxvt -pixmap background.xpm -pe automove-background</pre>
351</dd> 385</dd>
352<p></p> 386</li>
353<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>
354</dt> 388
355<dd> 389<dd>
356A 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
357by replacing all line-drawing characters (U+2500 .. U+259F) by a 391by replacing all line-drawing characters (U+2500 .. U+259F) by a
358similar-looking ascii character. 392similar-looking ascii character.</p>
359</dd> 393</dd>
360<p></p> 394</li>
361<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 395<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong>
362</dt> 396
363<dd> 397<dd>
364Displays a digital clock using the built-in overlay. 398<p>Displays a digital clock using the built-in overlay.</p>
365</dd> 399</dd>
366<p></p> 400</li>
367<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> 401<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong>
368</dt> 402
369<dd> 403<dd>
370Somewhat of a misnomer, this extension adds two menu entries to the 404<p>Somewhat of a misnomer, this extension adds two menu entries to the
371selection popup that allows one ti run external commands to store the 405selection popup that allows one ti run external commands to store the
372selection somewhere and fetch it again. 406selection somewhere and fetch it again.</p>
373</dd> 407</dd>
374<dd> 408<dd>
375<p>We use it to implement a ``distributed selection mechanism'', which just 409<p>We use it to implement a ``distributed selection mechanism'', which just
376means that one command uploads the file to a remote server, and another 410means that one command uploads the file to a remote server, and another
377reads it.</p> 411reads it.</p>
… …
388<dd> 422<dd>
389<pre> 423<pre>
390 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection' 424 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
391 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> 425 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
392</dd> 426</dd>
393<p></p> 427</li>
394<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> 428<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong>
395</dt> 429
396<dd> 430<dd>
397This 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
398textfile to a remote site (or does other things). (The implementation is 432textfile to a remote site (or does other things). (The implementation is
399not 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
400<em>/tmp</em> directly.). 434<em>/tmp</em> directly.).</p>
401</dd> 435</dd>
402<dd> 436<dd>
403<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,
404i.e.</p> 438i.e.</p>
405</dd> 439</dd>
… …
430</dd> 464</dd>
431<dd> 465<dd>
432<pre> 466<pre>
433 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>
434</dd> 468</dd>
435<p></p> 469</li>
436<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 470<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong>
437</dt> 471
438<dd> 472<dd>
439Displays a very simple digital clock in the upper right corner of the 473<p>Displays a very simple digital clock in the upper right corner of the
440window. Illustrates overwriting the refresh callbacks to create your own 474window. Illustrates overwriting the refresh callbacks to create your own
441overlays or changes. 475overlays or changes.</p>
476</dd>
477</li>
442</dd> 478</dl>
443<p></p></dl>
444<p> 479<p>
445</p> 480</p>
446<hr /> 481<hr />
447<h1><a name="api_documentation">API DOCUMENTATION</a></h1> 482<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
448<p> 483<p>
… …
458the 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
459terminal is destroyed.</p> 494terminal is destroyed.</p>
460<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
461hints on what they mean:</p> 496hints on what they mean:</p>
462<dl> 497<dl>
463<dt><strong><a name="item__24text">$text</a></strong><br /> 498<dt><strong><a name="item__text">$text</a></strong>
464</dt> 499
465<dd> 500<dd>
466Rxvt-unicodes special way of encoding text, where one ``unicode'' character 501<p>Rxvt-unicodes special way of encoding text, where one ``unicode'' character
467always 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>
468</dd> 503</dd>
469<p></p> 504</li>
470<dt><strong><a name="item__24string">$string</a></strong><br /> 505<dt><strong><a name="item__string">$string</a></strong>
471</dt> 506
472<dd> 507<dd>
473A 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
474characters and is to be distinguished with text encoded in a specific 509characters and is to be distinguished with text encoded in a specific
475encoding (often locale-specific) and binary data. 510encoding (often locale-specific) and binary data.</p>
476</dd> 511</dd>
477<p></p> 512</li>
478<dt><strong><a name="item__24octets">$octets</a></strong><br /> 513<dt><strong><a name="item__octets">$octets</a></strong>
479</dt> 514
480<dd> 515<dd>
481Either 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
482locale-specific way. 517locale-specific way.</p>
518</dd>
519</li>
483</dd> 520</dl>
484<p></p></dl>
485<p> 521<p>
486</p> 522</p>
487<h2><a name="extension_objects">Extension Objects</a></h2> 523<h2><a name="extension_objects">Extension Objects</a></h2>
488<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
489for 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
490hooks. 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
491about other extensions, with the exception of methods and members that 527about other extensions, with the exception of methods and members that
492begin with an underscore character <code>_</code>: these are reserved for internal 528begin with an underscore character <code>_</code>: these are reserved for internal
493use.</p> 529use.</p>
494<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
495<code>urxvt::term</code> class on this object.</p> 531<code>urxvt::term</code> class on this object.</p>
496<p>It has the following methods and data members:</p> 532<p>It has the following methods and data members:</p>
497<dl> 533<dl>
498<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>
499</dt> 535
500<dd> 536<dd>
501Returns 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
502extension. This member <em>must not</em> be changed in any way. 538extension. This member <em>must not</em> be changed in any way.</p>
503</dd> 539</dd>
504<p></p> 540</li>
505<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>
506</dt> 542
507<dd> 543<dd>
508Dynamically 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
509this extension, replacing any previous hook. This is useful when you want 545this extension, replacing any previous hook. This is useful when you want
510to overwrite time-critical hooks only temporarily. 546to overwrite time-critical hooks only temporarily.</p>
511</dd> 547</dd>
512<p></p> 548</li>
513<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>
514</dt> 550
515<dd> 551<dd>
516Dynamically disable the given hooks. 552<p>Dynamically disable the given hooks.</p>
553</dd>
554</li>
517</dd> 555</dl>
518<p></p></dl>
519<p> 556<p>
520</p> 557</p>
521<h2><a name="hooks">Hooks</a></h2> 558<h2><a name="hooks">Hooks</a></h2>
522<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
523called whenever the relevant event happens.</p> 560called whenever the relevant event happens.</p>
… …
526<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
527hooks 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
528relevant action might not be carried out by the C++ code.</p> 565relevant action might not be carried out by the C++ code.</p>
529<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>
530<dl> 567<dl>
531<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>
532</dt> 569
533<dd> 570<dd>
534Called after a new terminal object has been initialized, but before 571<p>Called after a new terminal object has been initialized, but before
535windows 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
536call or deliver senseless data, as terminal size and other characteristics 573call or deliver senseless data, as terminal size and other characteristics
537have not yet been determined. You can safely query and change resources 574have not yet been determined. You can safely query and change resources
538and 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
539place. 576place.</p>
540</dd> 577</dd>
541<p></p> 578</li>
542<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>
543</dt> 580
544<dd> 581<dd>
545Called 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
546trying to map (display) the toplevel and returning to the mainloop. 583trying to map (display) the toplevel and returning to the mainloop.</p>
547</dd> 584</dd>
548<p></p> 585</li>
549<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>
550</dt> 587
551<dd> 588<dd>
552Called whenever something tries to destroy terminal, when the terminal is 589<p>Called whenever something tries to destroy terminal, when the terminal is
553still fully functional (not for long, though). 590still fully functional (not for long, though).</p>
554</dd> 591</dd>
555<p></p> 592</li>
556<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>
557</dt> 594
558<dd> 595<dd>
559Called 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
560control 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
561variables. 598variables.</p>
562</dd> 599</dd>
563<p></p> 600</li>
564<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>
565</dt> 602
566<dd> 603<dd>
567Called 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>
568</dd> 605</dd>
569<p></p> 606</li>
570<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>
571</dt> 608
572<dd> 609<dd>
573Called 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
574from <code>waitpid</code>. 611from <code>waitpid</code>.</p>
575</dd> 612</dd>
576<p></p> 613</li>
577<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>
578</dt> 615
579<dd> 616<dd>
580Called 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
581selection 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
582selection will be honored. 619selection will be honored.</p>
583</dd> 620</dd>
584<dd> 621<dd>
585<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
586have 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>
587</dd> 624</dd>
588<p></p> 625</li>
589<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>
590</dt> 627
591<dd> 628<dd>
592Called 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
593requested from the server. The selection text can be queried and changed 630requested from the server. The selection text can be queried and changed
594by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>. 631by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.</p>
595</dd> 632</dd>
596<dd> 633<dd>
597<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>
598</dd> 635</dd>
599<p></p> 636</li>
600<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>
601</dt> 638
602<dd> 639<dd>
603Called 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
604click) and is either supposed to return false (normal operation), or 641click) and is either supposed to return false (normal operation), or
605should 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
606processing. This can happen multiple times, as long as the callback 643processing. This can happen multiple times, as long as the callback
607returns 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
608supposed to enlarge the selection more and more, if possible. 645supposed to enlarge the selection more and more, if possible.</p>
609</dd> 646</dd>
610<dd> 647<dd>
611<p>See the <em>selection</em> example extension.</p> 648<p>See the <em>selection</em> example extension.</p>
612</dd> 649</dd>
613<p></p> 650</li>
614<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>
615</dt> 652
616<dd> 653<dd>
617Called 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
618scrolls. Offset <code>0</code> means display the normal terminal, positive values 655scrolls. Offset <code>0</code> means display the normal terminal, positive values
619show this many lines of scrollback. 656show this many lines of scrollback.</p>
620</dd> 657</dd>
621<p></p> 658</li>
622<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>
623</dt> 660
624<dd> 661<dd>
625Called 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
626buffer. <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
627than the scroll back buffer or the terminal. 664than the scroll back buffer or the terminal.</p>
628</dd> 665</dd>
629<dd> 666<dd>
630<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,
631$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
632number of lines that will be in the scrollback buffer.</p> 669number of lines that will be in the scrollback buffer.</p>
633</dd> 670</dd>
634<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>
635<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>
636</dt> 686
637<dd> 687<dd>
638Called 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 =
639operating system command) is processed. Cursor position and other state 689operating system command) is processed. Cursor position and other state
640information is up-to-date when this happens. For interoperability, the 690information is up-to-date when this happens. For interoperability, the
641string should start with the extension name and a colon, to distinguish 691string should start with the extension name and a colon, to distinguish
642it 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
643future. 693future.</p>
644</dd> 694</dd>
645<dd> 695<dd>
646<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,
647as 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
648other users on the same system etc.).</p> 698other users on the same system etc.).</p>
649</dd> 699</dd>
650<p></p> 700</li>
651<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>
652</dt> 702
653<dd> 703<dd>
654Called 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
655can 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
656and 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
657might 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
658output. 708output.</p>
659</dd> 709</dd>
660<p></p> 710</li>
661<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>
662</dt> 712
663<dd> 713<dd>
664Called 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
665suppress or filter tty input. 715suppress or filter tty input.</p>
666</dd> 716</dd>
667<p></p> 717</li>
668<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>
669</dt> 719
670<dd> 720<dd>
671Called 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
672screen output (e.g. underline urls or other useless stuff). Only lines 722screen output (e.g. underline urls or other useless stuff). Only lines
673that are being shown will be filtered, and, due to performance reasons, 723that are being shown will be filtered, and, due to performance reasons,
674not always immediately. 724not always immediately.</p>
675</dd> 725</dd>
676<dd> 726<dd>
677<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
678multiple rows.</p> 728multiple rows.</p>
679</dd> 729</dd>
680<dd> 730<dd>
681<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
682later 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
683you cannot just toggle rendition bits, but only set them.</p> 733you cannot just toggle rendition bits, but only set them.</p>
684</dd> 734</dd>
685<p></p> 735</li>
686<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>
687</dt> 737
688<dd> 738<dd>
689Called 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
690or similar effects by modify terminal contents in refresh_begin, and 740or similar effects by modify terminal contents in refresh_begin, and
691restoring them in refresh_end. The built-in overlay and selection display 741restoring them in refresh_end. The built-in overlay and selection display
692code is run after this hook, and takes precedence. 742code is run after this hook, and takes precedence.</p>
693</dd> 743</dd>
694<p></p> 744</li>
695<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>
696</dt> 746
697<dd> 747<dd>
698Called 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>
699</dd> 749</dd>
700<p></p> 750</li>
701<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_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>
702</dt> 752
703<dd> 753<dd>
704Called whenever the a user-configured event is being activated (e.g. via 754<p>Called whenever the a user-configured event is being activated (e.g. via
705a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> 755a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
706resource in the <code>rxvt(1)</code> manpage). 756resource in the <code>rxvt(1)</code> manpage).</p>
707</dd> 757</dd>
708<dd> 758<dd>
709<p>The event is simply the action string. This interface is assumed to change 759<p>The event is simply the action string. This interface is assumed to change
710slightly in the future.</p> 760slightly in the future.</p>
711</dd> 761</dd>
712<p></p> 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>
713<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>
714</dt> 772
715<dd> 773<dd>
716Called 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
717windows). Should only be used as a last resort. Most event structure 775windows). Should only be used as a last resort. Most event structure
718members are not passed. 776members are not passed.</p>
719</dd> 777</dd>
720<p></p> 778</li>
721<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>
722</dt> 780
723<dd> 781<dd>
724Called whenever the window gets the keyboard focus, before rxvt-unicode 782<p>Called whenever the window gets the keyboard focus, before rxvt-unicode
725does focus in processing. 783does focus in processing.</p>
726</dd> 784</dd>
727<p></p> 785</li>
728<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>
729</dt> 787
730<dd> 788<dd>
731Called wheneever the window loses keyboard focus, before rxvt-unicode does 789<p>Called wheneever the window loses keyboard focus, before rxvt-unicode does
732focus out processing. 790focus out processing.</p>
733</dd> 791</dd>
734<p></p> 792</li>
735<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>
736</dt> 794
737<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>
738</dt> 796
739<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 797<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong>
740</dt> 798
741<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>
742</dt> 800
743<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>
744</dt> 802
745<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>
746</dt> 804
747<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>
748</dt> 806
749<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>
750</dt> 808
751<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>
752</dt> 810
753<dd> 811<dd>
754Called 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
755the 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>
756</dd> 814</dd>
757<dd> 815<dd>
758<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
759manpage), 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
760(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>
… …
764output, if any, in locale-specific encoding.</p> 822output, if any, in locale-specific encoding.</p>
765</dd> 823</dd>
766<dd> 824<dd>
767<p>subwindow.</p> 825<p>subwindow.</p>
768</dd> 826</dd>
769<p></p> 827</li>
770<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>
771</dt> 829
772<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>
773</dt> 831
774<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>
775</dt> 833
776<dd> 834<dd>
777Called when various types of ClientMessage events are received (all with 835<p>Called when various types of ClientMessage events are received (all with
778format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 836format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p>
837</dd>
838</li>
779</dd> 839</dl>
780<p></p></dl>
781<p> 840<p>
782</p> 841</p>
783<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>
784<dl> 843<dl>
785<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>
786</dt> 845
787<dd> 846<dd>
788The rxvt-unicode library directory, where, among other things, the perl 847<p>The rxvt-unicode library directory, where, among other things, the perl
789modules and scripts are stored. 848modules and scripts are stored.</p>
790</dd>
791<p></p>
792<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
793</dt>
794<dd> 849</dd>
850</li>
851<dt><strong><a name="item__urxvt__resclass_">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong>
852
853<dd>
795The 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>
796</dd> 855</dd>
797<p></p> 856</li>
798<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>
799</dt> 858
800<dd> 859<dd>
801The basename of the installed binaries, usually <code>urxvt</code>. 860<p>The basename of the installed binaries, usually <code>urxvt</code>.</p>
802</dd> 861</dd>
803<p></p> 862</li>
804<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>
805</dt> 864
806<dd> 865<dd>
807The 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>
808object, whenever a callback/hook is executing. 867object, whenever a callback/hook is executing.</p>
809</dd> 868</dd>
810<p></p> 869</li>
811<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>
812</dt> 871
813<dd> 872<dd>
814All 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
815created <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
816gets cleared before the codereferences that were in it are being executed, 875gets cleared before the codereferences that were in it are being executed,
817so coderefs can push themselves onto it again if they so desire. 876so coderefs can push themselves onto it again if they so desire.</p>
818</dd> 877</dd>
819<dd> 878<dd>
820<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
821first.</p> 880first.</p>
822</dd> 881</dd>
823<p></p> 882</li>
824<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>
825</dt> 884
826<dd> 885<dd>
827Works 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
828get 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>
829but 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>
830</dd> 891</dl>
831<p></p></dl>
832<p> 892<p>
833</p> 893</p>
834<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>
835<dl> 895<dl>
836<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>
837</dt> 897
838<dd> 898<dd>
839Fatally aborts execution with the given error message. Avoid at all 899<p>Fatally aborts execution with the given error message. Avoid at all
840costs! The only time this is acceptable is when the terminal process 900costs! The only time this is acceptable is when the terminal process
841starts up. 901starts up.</p>
842</dd> 902</dd>
843<p></p> 903</li>
844<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>
845</dt> 905
846<dd> 906<dd>
847Calls <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
848newline. 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
849that calls this function. 909that calls this function.</p>
850</dd> 910</dd>
851<dd> 911<dd>
852<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
853correct place, e.g. on stderr of the connecting urxvtc client.</p> 913correct place, e.g. on stderr of the connecting urxvtc client.</p>
854</dd> 914</dd>
855<dd> 915<dd>
856<p>Messages have a size limit of 1023 bytes currently.</p> 916<p>Messages have a size limit of 1023 bytes currently.</p>
857</dd> 917</dd>
858<p></p> 918</li>
859<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> 919<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong>
860</dt> 920
861<dd> 921<dd>
862Returns all urxvt::term objects that exist in this process, regardless of 922<p>Returns all urxvt::term objects that exist in this process, regardless of
863wether they are started, being destroyed etc., so be careful. Only term 923wether they are started, being destroyed etc., so be careful. Only term
864objects that have perl extensions attached will be returned (because there 924objects that have perl extensions attached will be returned (because there
865is no urxvt::term objet associated with others). 925is no urxvt::term objet associated with others).</p>
866</dd>
867<p></p>
868<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
869</dt>
870<dd> 926</dd>
927</li>
928<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong>
929
930<dd>
871Returns the ``current time'' (as per the event loop). 931<p>Returns the ``current time'' (as per the event loop).</p>
872</dd> 932</dd>
873<p></p> 933</li>
874<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>
875</dt> 935
876<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,
877Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 937Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
878Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 938Button4Mask, Button5Mask, AnyModifier</a></strong>
879</dt> 939
880<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,
881ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, 941ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
882PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, 942PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
883Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, 943Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
884KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, 944KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
885ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, 945ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
886FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> 946FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong>
887</dt> 947
888<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,
889EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, 949EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
890GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, 950GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
891UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, 951UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
892ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, 952ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
893CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 953CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
894SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> 954SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong>
895</dt> 955
896<dd> 956<dd>
897Various 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>
898</dd> 960</dl>
899<p></p></dl>
900<p> 961<p>
901</p> 962</p>
902<h2><a name="rendition">RENDITION</a></h2> 963<h2><a name="rendition">RENDITION</a></h2>
903<p>Rendition bitsets contain information about colour, font, font styles and 964<p>Rendition bitsets contain information about colour, font, font styles and
904similar information for each screen cell.</p> 965similar information for each screen cell.</p>
905<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
906never just create a bitset, you should always modify an existing one, 967never just create a bitset, you should always modify an existing one,
907as they contain important information required for correct operation of 968as they contain important information required for correct operation of
908rxvt-unicode.</p> 969rxvt-unicode.</p>
909<dl> 970<dl>
910<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>
911</dt> 972
912<dd> 973<dd>
913Returns 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
914being reset. Useful as a base to start when creating renditions. 975being reset. Useful as a base to start when creating renditions.</p>
915</dd>
916<p></p>
917<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
918</dt>
919<dd> 976</dd>
977</li>
978<dt><strong>$rend = urxvt::OVERLAY_RSTYLE</strong>
979
980<dd>
920Return the rendition mask used for overlays by default. 981<p>Return the rendition mask used for overlays by default.</p>
921</dd>
922<p></p>
923<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 />
924</dt>
925<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>
926Return the bit that enabled bold, italic, blink, reverse-video and 987<p>Return the bit that enabled bold, italic, blink, reverse-video and
927underline, respectively. To enable such a style, just logically OR it into 988underline, respectively. To enable such a style, just logically OR it into
928the bitset. 989the bitset.</p>
929</dd>
930<p></p>
931<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
932</dt>
933<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
934</dt>
935<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>
936Return the foreground/background colour index, respectively. 997<p>Return the foreground/background colour index, respectively.</p>
937</dd>
938<p></p>
939<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
940</dt>
941<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
942</dt>
943<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
944</dt>
945<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>
946Replace the foreground/background colour in the rendition mask with the 1007<p>Replace the foreground/background colour in the rendition mask with the
947specified one. 1008specified one.</p>
948</dd>
949<p></p>
950<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
951</dt>
952<dd> 1009</dd>
1010</li>
1011<dt><strong><a name="item__value">$value = urxvt::GET_CUSTOM $rend</a></strong>
1012
1013<dd>
953Return 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
954extensions. 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
955zero. 1016zero.</p>
956</dd>
957<p></p>
958<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
959</dt>
960<dd> 1017</dd>
961Change the custom value. 1018</li>
1019<dt><strong>$rend = urxvt::SET_CUSTOM $rend, $new_value</strong>
1020
962</dd> 1021<dd>
963<p></p></dl> 1022<p>Change the custom value.</p>
1023</dd>
1024</li>
1025</dl>
964<p> 1026<p>
965</p> 1027</p>
966<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>
967<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
968<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
… …
972work.</p> 1034work.</p>
973<p> 1035<p>
974</p> 1036</p>
975<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>
976<dl> 1038<dl>
977<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>
978</dt> 1040
979<dd> 1041<dd>
980Creates 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
981<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
982hash which defines the environment of the new terminal. 1044hash which defines the environment of the new terminal.</p>
983</dd> 1045</dd>
984<dd> 1046<dd>
985<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
986couldn'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
987initialise perl, and the terminal object otherwise. The <code>init</code> and 1049initialise perl, and the terminal object otherwise. The <code>init</code> and
988<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to 1050<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
989refer to global data (which is race free).</p> 1051refer to global data (which is race free).</p>
990</dd> 1052</dd>
991<p></p> 1053</li>
992<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1054<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong>
993</dt> 1055
994<dd> 1056<dd>
995Destroy the terminal object (close the window, free resources 1057<p>Destroy the terminal object (close the window, free resources
996etc.). 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
997watchers (timers, io watchers) are still active. 1059watchers (timers, io watchers) are still active.</p>
998</dd> 1060</dd>
999<p></p> 1061</li>
1000<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>
1001</dt> 1063
1002<dd> 1064<dd>
1003Works 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
1004(``starts'') programs in the background. This function takes care of setting 1066(``starts'') programs in the background. This function takes care of setting
1005the user environment before exec'ing the command (e.g. <code>PATH</code>) and should 1067the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
1006be preferred over explicit calls to <code>exec</code> or <code>system</code>. 1068be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p>
1007</dd> 1069</dd>
1008<dd> 1070<dd>
1009<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>
1010</dd> 1072</dd>
1011<p></p> 1073</li>
1012<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>
1013</dt> 1075
1014<dd> 1076<dd>
1015Returns 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
1016optionally 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
1017<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>
1018</dd> 1080</dd>
1019<dd> 1081<dd>
1020<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
1021source 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>
1022</dd> 1084</dd>
… …
1027 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1089 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1028 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1090 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1029 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1091 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1030 transparent tripleclickwords utmpInhibit visualBell</pre> 1092 transparent tripleclickwords utmpInhibit visualBell</pre>
1031</dd> 1093</dd>
1032<p></p> 1094</li>
1033<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>
1034</dt> 1096
1035<dd> 1097<dd>
1036Returns the current resource value associated with a given name and 1098<p>Returns the current resource value associated with a given name and
1037optionally 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>
1038hook. Unset resources are returned and accepted as <code>undef</code>. 1100hook. Unset resources are returned and accepted as <code>undef</code>.</p>
1039</dd> 1101</dd>
1040<dd> 1102<dd>
1041<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
1042before passing it to this method. Similarly, the returned value may need 1104before passing it to this method. Similarly, the returned value may need
1043to be converted from the used encoding to text.</p> 1105to be converted from the used encoding to text.</p>
… …
1070 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1132 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1071 secondaryScreen secondaryScroll selectstyle shade term_name title 1133 secondaryScreen secondaryScroll selectstyle shade term_name title
1072 transient_for transparent transparent_all tripleclickwords utmpInhibit 1134 transient_for transparent transparent_all tripleclickwords utmpInhibit
1073 visualBell</pre> 1135 visualBell</pre>
1074</dd> 1136</dd>
1075<p></p> 1137</li>
1076<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>
1077</dt> 1139
1078<dd> 1140<dd>
1079Returns 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
1080class 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
1081same 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
1082resource with that pattern exists. 1144resource with that pattern exists.</p>
1083</dd> 1145</dd>
1084<dd> 1146<dd>
1085<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
1086only one resource database per display, and later invocations might return 1148only one resource database per display, and later invocations might return
1087the wrong resources.</p> 1149the wrong resources.</p>
1088</dd> 1150</dd>
1089<p></p> 1151</li>
1090<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>
1091</dt> 1153
1092<dd> 1154<dd>
1093Adds 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
1094<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 1156<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.</p>
1095</dd> 1157</dd>
1096<p></p> 1158</li>
1097<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>
1098</dt> 1160
1099<dd> 1161<dd>
1100Return 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
1101the terminal application will use this style. 1163the terminal application will use this style.</p>
1102</dd> 1164</dd>
1103<p></p> 1165</li>
1104<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>
1105</dt> 1167
1106<dd> 1168<dd>
1107Return the current coordinates of the text cursor position and optionally 1169<p>Return the current coordinates of the text cursor position and optionally
1108set it (which is usually bad as applications don't expect that). 1170set it (which is usually bad as applications don't expect that).</p>
1109</dd> 1171</dd>
1110<p></p> 1172</li>
1111<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>
1112</dt> 1174
1113<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>
1114</dt> 1176
1115<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>
1116</dt> 1178
1117<dd> 1179<dd>
1118Return 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,
1119and optionally set them to new values. 1181and optionally set them to new values.</p>
1120</dd> 1182</dd>
1121<p></p> 1183</li>
1122<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>
1123</dt> 1185
1124<dd> 1186<dd>
1125Tries 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
1126<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
1127rectangular selection will be made. This is the prefered function to make 1189rectangular selection will be made. This is the prefered function to make
1128a selection. 1190a selection.</p>
1129</dd> 1191</dd>
1130<p></p> 1192</li>
1131<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>
1132</dt> 1194
1133<dd> 1195<dd>
1134Try 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
1135set 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
1136is mostly useful from within <code>on_sel_grab</code> hooks. 1198is mostly useful from within <code>on_sel_grab</code> hooks.</p>
1137</dd> 1199</dd>
1138<p></p> 1200</li>
1139<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1201<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong>
1140</dt> 1202
1141<dd> 1203<dd>
1142Return 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>
1143</dd> 1205</dd>
1144<p></p> 1206</li>
1145<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>
1146</dt> 1208
1147<dd> 1209<dd>
1148Create 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>
1149</dd> 1211</dd>
1150<p></p> 1212</li>
1151<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>
1152</dt> 1214
1153<dd> 1215<dd>
1154Create 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
1155width/height. <code>$rstyle</code> defines the initial rendition style 1217width/height. <code>$rstyle</code> defines the initial rendition style
1156(default: <code>OVERLAY_RSTYLE</code>). 1218(default: <code>OVERLAY_RSTYLE</code>).</p>
1157</dd> 1219</dd>
1158<dd> 1220<dd>
1159<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
1160around the box.</p> 1222around the box.</p>
1161</dd> 1223</dd>
… …
1169</dd> 1231</dd>
1170<dd> 1232<dd>
1171<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>
1172</dd> 1234</dd>
1173<dl> 1235<dl>
1174<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>
1175</dt> 1237
1176<dd> 1238<dd>
1177Similar 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
1178text 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
1179at a specific position inside the overlay. 1241at a specific position inside the overlay.</p>
1180</dd> 1242</dd>
1181<p></p> 1243</li>
1182<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br /> 1244<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong>
1183</dt> 1245
1184<dd> 1246<dd>
1185If visible, hide the overlay, but do not destroy it. 1247<p>If visible, hide the overlay, but do not destroy it.</p>
1186</dd> 1248</dd>
1187<p></p> 1249</li>
1188<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br /> 1250<dt><strong><a name="item_show">$overlay-&gt;show</a></strong>
1189</dt> 1251
1190<dd> 1252<dd>
1191If hidden, display the overlay again. 1253<p>If hidden, display the overlay again.</p>
1254</dd>
1255</li>
1192</dd> 1256</dl>
1193<p></p></dl>
1194<dt><strong>$popup = $term-&gt;popup ($event)</strong><br /> 1257<dt><strong>$popup = $term-&gt;popup ($event)</strong>
1195</dt> 1258
1196<dd> 1259<dd>
1197Creates 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
1198<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,
1199currently). 1262currently).</p>
1200</dd> 1263</dd>
1201<p></p> 1264</li>
1202<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>
1203</dt> 1266
1204<dd> 1267<dd>
1205Returns the number of screen-cells this string would need. Correctly 1268<p>Returns the number of screen-cells this string would need. Correctly
1206accounts for wide and combining characters. 1269accounts for wide and combining characters.</p>
1207</dd> 1270</dd>
1208<p></p> 1271</li>
1209<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>
1210</dt> 1273
1211<dd> 1274<dd>
1212Convert the given text string into the corresponding locale encoding. 1275<p>Convert the given text string into the corresponding locale encoding.</p>
1213</dd> 1276</dd>
1214<p></p> 1277</li>
1215<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>
1216</dt> 1279
1217<dd> 1280<dd>
1218Convert the given locale-encoded octets into a perl string. 1281<p>Convert the given locale-encoded octets into a perl string.</p>
1219</dd> 1282</dd>
1220<p></p> 1283</li>
1221<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>
1222</dt> 1285
1223<dd> 1286<dd>
1224XORs 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
1225(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
1226refresh hooks to provide effects similar to the selection. 1289refresh hooks to provide effects similar to the selection.</p>
1227</dd> 1290</dd>
1228<p></p> 1291</li>
1229<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>
1230</dt> 1293
1231<dd> 1294<dd>
1232Similar 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
1233whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 1296whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1234to <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
1235it instead. Both styles <em>MUST NOT</em> contain font styles. 1298it instead. Both styles <em>MUST NOT</em> contain font styles.</p>
1236</dd> 1299</dd>
1237<p></p> 1300</li>
1238<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>
1239</dt> 1302
1240<dd>
1241Ring the bell!
1242</dd> 1303<dd>
1243<p></p> 1304<p>Ring the bell!</p>
1305</dd>
1306</li>
1244<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>
1245</dt> 1308
1246<dd> 1309<dd>
1247Write 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
1248running inside the terminal. It may not contain command sequences (escape 1311running inside the terminal. It may not contain command sequences (escape
1249codes), 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
1250string is a normal text string, not in locale-dependent encoding. 1313string is a normal text string, not in locale-dependent encoding.</p>
1251</dd> 1314</dd>
1252<dd> 1315<dd>
1253<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
1254confused by changes in cursor position or scrolling. Its useful inside a 1317confused by changes in cursor position or scrolling. Its useful inside a
1255<code>on_add_lines</code> hook, though.</p> 1318<code>on_add_lines</code> hook, though.</p>
1256</dd> 1319</dd>
1257<p></p> 1320</li>
1258<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>
1259</dt> 1322
1260<dd> 1323<dd>
1261Switch to given screen - 0 primary, 1 secondary. 1324<p>Switch to given screen - 0 primary, 1 secondary.</p>
1262</dd> 1325</dd>
1263<p></p> 1326</li>
1264<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>
1265</dt> 1328
1266<dd> 1329<dd>
1267Similar 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
1268locale-specific encoding of the terminal and can contain command sequences 1331locale-specific encoding of the terminal and can contain command sequences
1269(escape codes) that will be interpreted. 1332(escape codes) that will be interpreted.</p>
1270</dd> 1333</dd>
1271<p></p> 1334</li>
1272<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>
1273</dt> 1336
1274<dd> 1337<dd>
1275Write 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
1276pass characters instead of octets, you should convert your strings first 1339pass characters instead of octets, you should convert your strings first
1277to 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>
1278</dd> 1341</dd>
1279<p></p> 1342</li>
1280<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>
1281</dt> 1344
1282<dd> 1345<dd>
1283Replaces 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
1284be 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
1285description 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
1286the previous value. 1349the previous value.</p>
1287</dd> 1350</dd>
1288<p></p> 1351</li>
1289<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br /> 1352<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong>
1290</dt> 1353
1291<dd> 1354<dd>
1292Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty 1355<p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1293is used. 1356is used.</p>
1294</dd> 1357</dd>
1295<p></p> 1358</li>
1296<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>
1297</dt> 1360
1298<dd> 1361<dd>
1299Return the window id of the toplevel window. 1362<p>Return the window id of the toplevel window.</p>
1300</dd> 1363</dd>
1301<p></p> 1364</li>
1302<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>
1303</dt> 1366
1304<dd> 1367<dd>
1305Return the window id of the terminal window. 1368<p>Return the window id of the terminal window.</p>
1306</dd> 1369</dd>
1307<p></p> 1370</li>
1308<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>
1309</dt> 1372
1310<dd> 1373<dd>
1311Adds 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
1312to receive pointer events all the times: 1375to receive pointer events all the times:</p>
1313</dd> 1376</dd>
1314<dd> 1377<dd>
1315<pre> 1378<pre>
1316 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1379 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1317</dd> 1380</dd>
1318<p></p> 1381</li>
1319<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br /> 1382<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong>
1320</dt> 1383
1321<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br /> 1384<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong>
1322</dt> 1385
1323<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br /> 1386<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong>
1324</dt> 1387
1325<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br /> 1388<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong>
1326</dt> 1389
1327<dd> 1390<dd>
1328Deliver various fake events to to terminal. 1391<p>Deliver various fake events to to terminal.</p>
1329</dd> 1392</dd>
1330<p></p> 1393</li>
1331<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>
1332</dt> 1395
1333<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>
1334</dt> 1397
1335<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>
1336</dt> 1399
1337<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>
1338</dt> 1401
1339<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>
1340</dt> 1403
1341<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>
1342</dt> 1405
1343<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>
1344</dt> 1407
1345<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>
1346</dt> 1409
1347<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>
1348</dt> 1411
1349<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>
1350</dt> 1413
1351<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>
1352</dt> 1415
1353<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>
1354</dt> 1417
1355<dd> 1418<dd>
1356Return various integers describing terminal characteristics. 1419<p>Return various integers describing terminal characteristics.</p>
1357</dd> 1420</dd>
1358<p></p> 1421</li>
1359<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>
1360</dt> 1423
1361<dd> 1424<dd>
1362Return the DISPLAY used by rxvt-unicode. 1425<p>Return the DISPLAY used by rxvt-unicode.</p>
1363</dd> 1426</dd>
1364<p></p> 1427</li>
1365<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>
1366</dt> 1429
1367<dd> 1430<dd>
1368Returns the LC_CTYPE category string used by this rxvt-unicode. 1431<p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>
1369</dd> 1432</dd>
1370<p></p> 1433</li>
1371<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>
1372</dt> 1435
1373<dd> 1436<dd>
1374Returns 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
1375similar 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
1376</dd> 1443<dd>
1377<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>
1378<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>
1379</dt> 1455
1380<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>
1381</dt> 1457
1382<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>
1383</dt> 1459
1384<dd> 1460<dd>
1385Return 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
1386AltGr), 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>
1387</dd> 1463</dd>
1388<p></p> 1464</li>
1389<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>
1390</dt> 1466
1391<dd> 1467<dd>
1392Returns the currently displayed screen (0 primary, 1 secondary). 1468<p>Returns the currently displayed screen (0 primary, 1 secondary).</p>
1393</dd> 1469</dd>
1394<p></p> 1470</li>
1395<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>
1396</dt> 1472
1397<dd> 1473<dd>
1398Returns wether the cursor is currently hidden or not. 1474<p>Returns wether the cursor is currently hidden or not.</p>
1399</dd> 1475</dd>
1400<p></p> 1476</li>
1401<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>
1402</dt> 1478
1403<dd> 1479<dd>
1404Returns 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
1405<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
1406this many lines into the scrollback buffer. 1482this many lines into the scrollback buffer.</p>
1407</dd> 1483</dd>
1408<p></p> 1484</li>
1409<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>
1410</dt> 1486
1411<dd> 1487<dd>
1412Requests a screen refresh. At the next opportunity, rxvt-unicode will 1488<p>Requests a screen refresh. At the next opportunity, rxvt-unicode will
1413compare the on-screen display with its stored representation. If they 1489compare the on-screen display with its stored representation. If they
1414differ, it redraws the differences. 1490differ, it redraws the differences.</p>
1415</dd> 1491</dd>
1416<dd> 1492<dd>
1417<p>Used after changing terminal contents to display them.</p> 1493<p>Used after changing terminal contents to display them.</p>
1418</dd> 1494</dd>
1419<p></p> 1495</li>
1420<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>
1421</dt> 1497
1422<dd> 1498<dd>
1423Returns 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>
1424is 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
1425terminal 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
1426line <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
1427is requested. 1503is requested.</p>
1428</dd> 1504</dd>
1429<dd> 1505<dd>
1430<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
1431line, 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
1432to 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
1433automatically be updated.</p> 1509automatically be updated.</p>
1434</dd> 1510</dd>
1435<dd> 1511<dd>
1436<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1512<p><a href="#item__text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1437than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) 1513than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1438characters. Characters with combining characters and other characters that 1514characters. Characters with combining characters and other characters that
1439do 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
1440in the private use area.</p> 1516in the private use area.</p>
1441</dd> 1517</dd>
… …
1446</dd> 1522</dd>
1447<dd> 1523<dd>
1448<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>
1449can 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>
1450</dd> 1526</dd>
1451<p></p> 1527</li>
1452<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>
1453</dt> 1529
1454<dd> 1530<dd>
1455Like <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
1456bitsets. Rendition bitsets contain information about colour, font, font 1532bitsets. Rendition bitsets contain information about colour, font, font
1457styles 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>
1458</dd> 1534</dd>
1459<dd> 1535<dd>
1460<p>When setting rendition, the font mask will be ignored.</p> 1536<p>When setting rendition, the font mask will be ignored.</p>
1461</dd> 1537</dd>
1462<dd> 1538<dd>
1463<p>See the section on RENDITION, above.</p> 1539<p>See the section on RENDITION, above.</p>
1464</dd> 1540</dd>
1465<p></p> 1541</li>
1466<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>
1467</dt> 1543
1468<dd> 1544<dd>
1469Returns 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
1470length''). 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
1471line is joined with the following one. 1547line is joined with the following one.</p>
1472</dd> 1548</dd>
1473<p></p> 1549</li>
1474<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>
1475</dt> 1551
1476<dd> 1552<dd>
1477Returns 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.
1478joined with the following row), which means all characters are in use 1554joined with the following row), which means all characters are in use
1479and 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
1480previous row(s)). 1556previous row(s)).</p>
1481</dd> 1557</dd>
1482<p></p> 1558</li>
1483<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>
1484</dt> 1560
1485<dd> 1561<dd>
1486Create 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
1487about 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
1488following methods: 1564following methods:</p>
1489</dd> 1565</dd>
1490<dl> 1566<dl>
1491<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>
1492</dt> 1568
1493<dd> 1569<dd>
1494Returns 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>
1495</dd> 1571</dd>
1496<p></p> 1572</li>
1497<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>
1498</dt> 1574
1499<dd> 1575<dd>
1500Returns 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>
1501</dd> 1577</dd>
1502<p></p> 1578</li>
1503<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>
1504</dt> 1580
1505<dd> 1581<dd>
1506Returns 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>
1507</dd> 1583</dd>
1508<p></p> 1584</li>
1509<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>
1510</dt> 1586
1511<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>
1512</dt> 1588
1513<dd> 1589<dd>
1514Return 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>
1515</dd> 1591</dd>
1516<p></p> 1592</li>
1517<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>
1518</dt> 1594
1519<dd> 1595<dd>
1520Returns 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
1521line. Works for rows outside the line, too, and returns corresponding 1597line. Works for rows outside the line, too, and returns corresponding
1522offsets outside the string. 1598offsets outside the string.</p>
1523</dd> 1599</dd>
1524<p></p> 1600</li>
1525<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>
1526</dt> 1602
1527<dd> 1603<dd>
1528Translates a string offset into terminal coordinates again. 1604<p>Translates a string offset into terminal coordinates again.</p>
1605</dd>
1606</li>
1529</dd> 1607</dl>
1530<p></p></dl>
1531<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>
1532</dt> 1609
1533<dd> 1610<dd>
1534Converts 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,
1535where one character corresponds to one screen cell. See 1612where one character corresponds to one screen cell. See
1536<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>
1537</dd> 1614</dd>
1538<p></p> 1615</li>
1539<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>
1540</dt> 1617
1541<dd> 1618<dd>
1542Converts rxvt-unicodes text reprsentation into a perl string. See 1619<p>Converts rxvt-unicodes text reprsentation into a perl string. See
1543<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>
1544</dd> 1621</dd>
1545<p></p> 1622</li>
1546<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br /> 1623<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong>
1547</dt> 1624
1548<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br /> 1625<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong>
1549</dt> 1626
1550<dd> 1627<dd>
1551Register/unregister a synchronous button grab. See the XGrabButton 1628<p>Register/unregister a synchronous button grab. See the XGrabButton
1552manpage. 1629manpage.</p>
1553</dd> 1630</dd>
1554<p></p> 1631</li>
1555<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>
1556</dt> 1633
1557<dd> 1634<dd>
1558Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1635<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1559synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. 1636synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.</p>
1560</dd> 1637</dd>
1561<p></p> 1638</li>
1562<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>
1563</dt> 1640
1564<dd> 1641<dd>
1565Calls XAllowEvents with AsyncBoth for the most recent grab. 1642<p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>
1566</dd> 1643</dd>
1567<p></p> 1644</li>
1568<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>
1569</dt> 1646
1570<dd> 1647<dd>
1571Calls XAllowEvents with SyncBoth for the most recent grab. 1648<p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>
1572</dd> 1649</dd>
1573<p></p> 1650</li>
1574<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>
1575</dt> 1652
1576<dd> 1653<dd>
1577Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1654<p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1578recent grab. 1655recent grab.</p>
1579</dd> 1656</dd>
1580<p></p> 1657</li>
1581<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br /> 1658<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong>
1582</dt> 1659
1583<dd> 1660<dd>
1584Calls XUngrab for the most recent grab. Is called automatically on 1661<p>Calls XUngrab for the most recent grab. Is called automatically on
1585evaluation 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
1586the session. 1663the session.</p>
1587</dd> 1664</dd>
1588<p></p> 1665</li>
1589<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>
1590</dt> 1667
1591<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>
1592</dt> 1669
1593<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>
1594</dt> 1671
1595<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>
1596</dt> 1673
1597<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>
1598</dt> 1675
1599<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>
1600</dt> 1677
1601<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>
1602</dt> 1679
1603<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>
1604</dt> 1681
1605<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>
1606</dt> 1683
1607<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>
1608</dt> 1685
1609<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>
1610</dt> 1687
1611<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>
1612</dt> 1689
1613<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>
1614</dt> 1691
1615<dd> 1692<dd>
1616Various 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
1617the source of the display, otherwise those functions map more-or-less 1694the source of the display, otherwise those functions map more-or-less
1618directory onto the X functions of the same name. 1695directory onto the X functions of the same name.</p>
1696</dd>
1697</li>
1619</dd> 1698</dl>
1620<p></p></dl>
1621<p> 1699<p>
1622</p> 1700</p>
1623<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>
1624<dl> 1702<dl>
1625<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>
1626</dt> 1704
1627<dd> 1705<dd>
1628Adds a non-clickable title to the popup. 1706<p>Adds a non-clickable title to the popup.</p>
1629</dd> 1707</dd>
1630<p></p> 1708</li>
1631<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>
1632</dt> 1710
1633<dd> 1711<dd>
1634Creates 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>
1635</dd> 1713</dd>
1636<p></p> 1714</li>
1637<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>
1638</dt> 1716
1639<dd> 1717<dd>
1640Adds 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
1641selected. 1719selected.</p>
1642</dd> 1720</dd>
1643<p></p> 1721</li>
1644<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>
1645</dt> 1723
1646<dd> 1724<dd>
1647Adds 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
1648whenever 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
1649argument. 1727first argument.</p>
1650</dd> 1728</dd>
1651<p></p> 1729</li>
1652<dt><strong>$popup-&gt;show</strong><br /> 1730<dt><strong>$popup-&gt;show</strong>
1653</dt> 1731
1654<dd> 1732<dd>
1655Displays the popup (which is initially hidden). 1733<p>Displays the popup (which is initially hidden).</p>
1734</dd>
1735</li>
1656</dd> 1736</dl>
1657<p></p></dl>
1658<p> 1737<p>
1659</p> 1738</p>
1660<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>
1661<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
1662fractional number of seconds since the epoch. Example:</p> 1741fractional number of seconds since the epoch. Example:</p>
… …
1668 -&gt;cb (sub { 1747 -&gt;cb (sub {
1669 $term-&gt;{overlay}-&gt;set (0, 0, 1748 $term-&gt;{overlay}-&gt;set (0, 0,
1670 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]);
1671 });</pre> 1750 });</pre>
1672<dl> 1751<dl>
1673<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>
1674</dt> 1753
1675<dd> 1754<dd>
1676Create 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
1677immediately. 1756immediately.</p>
1678</dd> 1757</dd>
1679<p></p> 1758</li>
1680<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>
1681</dt> 1760
1682<dd> 1761<dd>
1683Set the callback to be called when the timer triggers. 1762<p>Set the callback to be called when the timer triggers.</p>
1684</dd> 1763</dd>
1685<p></p> 1764</li>
1686<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>
1687</dt> 1766
1688<dd> 1767<dd>
1689Return the time this watcher will fire next. 1768<p>Return the time this watcher will fire next.</p>
1690</dd> 1769</dd>
1691<p></p> 1770</li>
1692<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br /> 1771<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong>
1693</dt> 1772
1694<dd> 1773<dd>
1695Set the time the event is generated to $tstamp. 1774<p>Set the time the event is generated to $tstamp.</p>
1696</dd> 1775</dd>
1697<p></p> 1776</li>
1698<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>
1699</dt> 1778
1700<dd> 1779<dd>
1701Normally (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
1702stop 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
1703is automatically rescheduled at the given intervals. 1782is automatically rescheduled at the given intervals.</p>
1704</dd> 1783</dd>
1705<p></p> 1784</li>
1706<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>
1707</dt> 1786
1708<dd>
1709Start the timer.
1710</dd> 1787<dd>
1711<p></p> 1788<p>Start the timer.</p>
1789</dd>
1790</li>
1712<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1791<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong>
1713</dt> 1792
1714<dd> 1793<dd>
1715Set 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>
1716</dd> 1795</dd>
1717<p></p> 1796</li>
1718<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>
1719</dt> 1798
1720<dd> 1799<dd>
1721Like <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>
1722</dd> 1801</dd>
1723<p></p> 1802</li>
1724<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>
1725</dt> 1804
1726<dd>
1727Stop the timer.
1728</dd> 1805<dd>
1729<p></p></dl> 1806<p>Stop the timer.</p>
1807</dd>
1808</li>
1809</dl>
1730<p> 1810<p>
1731</p> 1811</p>
1732<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>
1733<p>This class implements io watchers/events. Example:</p> 1813<p>This class implements io watchers/events. Example:</p>
1734<pre> 1814<pre>
… …
1743 # $revents must be 1 here, no need to check 1823 # $revents must be 1 here, no need to check
1744 sysread $term-&gt;{socket}, my $buf, 8192 1824 sysread $term-&gt;{socket}, my $buf, 8192
1745 or end-of-file; 1825 or end-of-file;
1746 });</pre> 1826 });</pre>
1747<dl> 1827<dl>
1748<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>
1749</dt> 1829
1750<dd> 1830<dd>
1751Create a new io watcher object in stopped state. 1831<p>Create a new io watcher object in stopped state.</p>
1752</dd> 1832</dd>
1753<p></p> 1833</li>
1754<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> 1834<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong>
1755</dt> 1835
1756<dd> 1836<dd>
1757Set 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>
1758is 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>
1759</dd> 1839</dd>
1760<p></p> 1840</li>
1761<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>
1762</dt> 1842
1763<dd> 1843<dd>
1764Set the filedescriptor (not handle) to watch. 1844<p>Set the filedescriptor (not handle) to watch.</p>
1765</dd> 1845</dd>
1766<p></p> 1846</li>
1767<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>
1768</dt> 1848
1769<dd> 1849<dd>
1770Set the event mask to watch. The only allowed values are 1850<p>Set the event mask to watch. The only allowed values are
1771<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
1772together, or <code>urxvt::EVENT_NONE</code>. 1852together, or <code>urxvt::EVENT_NONE</code>.</p>
1773</dd> 1853</dd>
1774<p></p> 1854</li>
1775<dt><strong>$iow = $iow-&gt;start</strong><br /> 1855<dt><strong>$iow = $iow-&gt;start</strong>
1776</dt> 1856
1777<dd> 1857<dd>
1778Start watching for requested events on the given handle. 1858<p>Start watching for requested events on the given handle.</p>
1779</dd> 1859</dd>
1780<p></p> 1860</li>
1781<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1861<dt><strong>$iow = $iow-&gt;stop</strong>
1782</dt> 1862
1783<dd> 1863<dd>
1784Stop watching for events on the given filehandle. 1864<p>Stop watching for events on the given filehandle.</p>
1865</dd>
1866</li>
1785</dd> 1867</dl>
1786<p></p></dl>
1787<p> 1868<p>
1788</p> 1869</p>
1789<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>
1790<p>This class implements idle watchers, that get called automatically when 1871<p>This class implements idle watchers, that get called automatically when
1791the 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
1792some useful work.</p> 1873some useful work.</p>
1793<dl> 1874<dl>
1794<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>
1795</dt> 1876
1796<dd> 1877<dd>
1797Create a new idle watcher object in stopped state. 1878<p>Create a new idle watcher object in stopped state.</p>
1798</dd> 1879</dd>
1799<p></p> 1880</li>
1800<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br /> 1881<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong>
1801</dt> 1882
1802<dd> 1883<dd>
1803Set the callback to be called when the watcher triggers. 1884<p>Set the callback to be called when the watcher triggers.</p>
1804</dd> 1885</dd>
1805<p></p> 1886</li>
1806<dt><strong>$timer = $timer-&gt;start</strong><br /> 1887<dt><strong>$timer = $timer-&gt;start</strong>
1807</dt> 1888
1808<dd>
1809Start the watcher.
1810</dd> 1889<dd>
1811<p></p> 1890<p>Start the watcher.</p>
1891</dd>
1892</li>
1812<dt><strong>$timer = $timer-&gt;stop</strong><br /> 1893<dt><strong>$timer = $timer-&gt;stop</strong>
1813</dt> 1894
1814<dd>
1815Stop the watcher.
1816</dd> 1895<dd>
1817<p></p></dl> 1896<p>Stop the watcher.</p>
1897</dd>
1898</li>
1899</dl>
1818<p> 1900<p>
1819</p> 1901</p>
1820<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>
1821<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
1822process exits, after which they stop automatically.</p> 1904process exits, after which they stop automatically.</p>
… …
1829 -&gt;cb (sub { 1911 -&gt;cb (sub {
1830 my ($pw, $exit_status) = @_; 1912 my ($pw, $exit_status) = @_;
1831 ... 1913 ...
1832 });</pre> 1914 });</pre>
1833<dl> 1915<dl>
1834<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>
1835</dt> 1917
1836<dd> 1918<dd>
1837Create a new process watcher in stopped state. 1919<p>Create a new process watcher in stopped state.</p>
1838</dd> 1920</dd>
1839<p></p> 1921</li>
1840<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>
1841</dt> 1923
1842<dd> 1924<dd>
1843Set the callback to be called when the timer triggers. 1925<p>Set the callback to be called when the timer triggers.</p>
1844</dd> 1926</dd>
1845<p></p> 1927</li>
1846<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br /> 1928<dt><strong>$pw = $timer-&gt;start ($pid)</strong>
1847</dt> 1929
1848<dd> 1930<dd>
1849Tells the wqtcher to start watching for process <code>$pid</code>. 1931<p>Tells the wqtcher to start watching for process <code>$pid</code>.</p>
1850</dd> 1932</dd>
1851<p></p> 1933</li>
1852<dt><strong>$pw = $pw-&gt;stop</strong><br /> 1934<dt><strong>$pw = $pw-&gt;stop</strong>
1853</dt> 1935
1854<dd>
1855Stop the watcher.
1856</dd> 1936<dd>
1857<p></p></dl> 1937<p>Stop the watcher.</p>
1938</dd>
1939</li>
1940</dl>
1858<p> 1941<p>
1859</p> 1942</p>
1860<hr /> 1943<hr />
1861<h1><a name="environment">ENVIRONMENT</a></h1> 1944<h1><a name="environment">ENVIRONMENT</a></h1>
1862<p> 1945<p>
1863</p> 1946</p>
1864<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1947<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1865<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
1866numbers indicate more verbose output.</p> 1949numbers indicate more verbose output.</p>
1867<dl> 1950<dl>
1868<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>
1869</dt> 1952
1870<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>
1871</dt> 1954
1872<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>
1873</dt> 1956
1874<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>
1875</dt> 1958
1876</dl> 1959</dl>
1877<p> 1960<p>
1878</p> 1961</p>
1879<hr /> 1962<hr />
1880<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