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.11 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.41 by root, Mon Feb 6 05:55:33 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
27 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
28 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
33 <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li>
34 <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li>
29 </ul> 35 </ul>
30 36
31 <li><a href="#environment">ENVIRONMENT</a></li> 37 <li><a href="#environment">ENVIRONMENT</a></li>
32 <ul> 38 <ul>
33 39
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 67 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 68<p>
63</p> 69</p>
64<hr /> 70<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 72<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 73the <code>perl</code> resource are loaded and associated with it.</p>
68<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 75thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where 76<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 77scripts will be shared (but not enabled) for all terminals.</p>
72<p> 78<p>
73</p> 79</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 80<hr />
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
75<p>This section describes the extensiosn delivered with this version. You can 82<p>This section describes the extensions delivered with this release. You can
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 84<p>You can activate them like this:</p>
78<pre> 85<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 86 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre>
80<dl> 90<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 92</dt>
83<dd>
84Intelligent selection. This extension tries to be more intelligent when
85the user extends selections (double-click). Right now, it tries to select
86urls and complete shell-quoted arguments, which is very convenient, too,
87if your <em>ls</em> supports <code>--quoting-style=shell</code>.
88</dd> 93<dd>
94(More) intelligent selection. This extension tries to be more intelligent
95when the user extends selections (double-click and further clicks). Right
96now, it tries to select words, urls and complete shell-quoted
97arguments, which is very convenient, too, if your <em>ls</em> supports
98<code>--quoting-style=shell</code>.
89<dd> 99</dd>
90<p>It also offers the following bindable event:</p> 100<dd>
101<p>A double-click usually selects the word under the cursor, further clicks
102will enlarge the selection.</p>
103</dd>
104<dd>
105<p>The selection works by trying to match a number of regexes and displaying
106them in increasing order of length. You can add your own regexes by
107specifying resources of the form:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.selection.pattern-0: perl-regex
112 URxvt.selection.pattern-1: perl-regex
113 ...</pre>
114</dd>
115<dd>
116<p>The index number (0, 1...) must not have any holes, and each regex must
117contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything
119between two vertical bars:</p>
120</dd>
121<dd>
122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd>
125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
136<p>You can look at the source of the selection extension to see more
137interesting uses, such as parsing a line from beginning to end.</p>
138</dd>
139<dd>
140<p>This extension also offers following bindable keyboard commands:</p>
91</dd> 141</dd>
92<dl> 142<dl>
93<dt><strong><a name="item_rot13">rot13</a></strong><br /> 143<dt><strong><a name="item_rot13">rot13</a></strong><br />
94</dt> 144</dt>
95<dd> 145<dd>
… …
98<dd> 148<dd>
99<pre> 149<pre>
100 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 150 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
101</dd> 151</dd>
102<p></p></dl> 152<p></p></dl>
153<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
154</dt>
155<dd>
156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
157runtime.
158</dd>
159<p></p>
160<dt><strong>selection-popup (enabled by default)</strong><br />
161</dt>
162<dd>
163Binds a popup menu to Ctrl-Button3 that lets you convert the selection
164text into various other formats/action (such as uri unescaping, perl
165evaluation, web-browser starting etc.), depending on content.
166</dd>
167<dd>
168<p>Other extensions can extend this popup menu by pushing a code reference
169onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
170popup is displayed.</p>
171</dd>
172<dd>
173<p>It's sole argument is the popup menu, which can be modified. The selection
174is in <code>$_</code>, which can be used to decide wether to add something or not.
175It should either return nothing or a string and a code reference. The
176string will be used as button text and the code reference will be called
177when the button gets activated and should transform <code>$_</code>.</p>
178</dd>
179<dd>
180<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
181the selection to <code>b</code>s, but only if the selection currently contains any
182<code>a</code>s:</p>
183</dd>
184<dd>
185<pre>
186 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
187 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
188 : ()
189 };</pre>
190</dd>
191<p></p>
192<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
193</dt>
194<dd>
195Adds regex search functionality to the scrollback buffer, triggered
196by 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
198screen.
199</dd>
200<dd>
201<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>
203search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
204bottom. <code>Escape</code> leaves search mode and returns to the point where search
205was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
206additionally stores the first match in the current line into the primary
207selection.</p>
208</dd>
209<p></p>
210<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
211</dt>
212<dd>
213A support package that tries to make editing with readline easier. At the
214moment, it reacts to clicking with the left mouse button by trying to
215move the text cursor to this position. It does so by generating as many
216cursor-left or cursor-right keypresses as required (the this only works
217for programs that correctly support wide characters).
218</dd>
219<dd>
220<p>To avoid too many false positives, this is only done when:</p>
221</dd>
222<dl>
223<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
224</dt>
225<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
226</dt>
227<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
228</dt>
229<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
230</dt>
231</dl>
232<p>The normal selection mechanism isn't disabled, so quick successive clicks
233might interfere with selection creation in harmless ways.</p>
234<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
235</dt>
236<dd>
237This selection allows you to do automatic transforms on a selection
238whenever a selection is made.
239</dd>
240<dd>
241<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
242operator) that modify <code>$_</code> as resources:</p>
243</dd>
244<dd>
245<pre>
246 URxvt.selection-autotransform.0: transform
247 URxvt.selection-autotransform.1: transform
248 ...</pre>
249</dd>
250<dd>
251<p>For example, the following will transform selections of the form
252<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
253$word</code>:</p>
254</dd>
255<dd>
256<pre>
257 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
258</dd>
259<dd>
260<p>And this example matches the same,but replaces it with vi-commands you can
261paste directly into your (vi :) editor:</p>
262</dd>
263<dd>
264<pre>
265 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
266</dd>
267<dd>
268<p>Of course, this can be modified to suit your needs and your editor :)</p>
269</dd>
270<dd>
271<p>To expand the example above to typical perl error messages (``XXX at
272FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
273</dd>
274<dd>
275<pre>
276 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
277 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
278</dd>
279<dd>
280<p>The first line tells the selection code to treat the unchanging part of
281every error message as a selection pattern, and the second line transforms
282the message into vi commands to load the file.</p>
283</dd>
284<p></p>
285<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
286</dt>
287<dd>
288This transforms the terminal into a tabbar with additional terminals, that
289is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
290displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
291button per tab.
292</dd>
293<dd>
294<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
295<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
296while <strong>Shift-Down</strong> creates a new tab.</p>
297</dd>
298<dd>
299<p>The tabbar itself can be configured similarly to a normal terminal, but
300with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
301following four resources (shown with defaults):</p>
302</dd>
303<dd>
304<pre>
305 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
306 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
307 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
308 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
309</dd>
310<dd>
311<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
312indices.</p>
313</dd>
314<p></p>
315<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
316</dt>
317<dd>
318Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
319make them clickable. When middle-clicked, the program specified in the
320resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
321the URL as first argument.
322</dd>
323<p></p>
324<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
325</dt>
326<dd>
327This (experimental) perl extension implements OnTheSpot editing. It does
328not work perfectly, and some input methods don't seem to work well with
329OnTheSpot editing in general, but it seems to work at leats for SCIM and
330kinput2.
331</dd>
332<dd>
333<p>You enable it by specifying this extension and a preedit style of
334<code>OnTheSpot</code>, i.e.:</p>
335</dd>
336<dd>
337<pre>
338 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
339</dd>
340<p></p>
341<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
342</dt>
343<dd>
344This is basically a one-line extension that dynamically changes the background pixmap offset
345to the window position, in effect creating the same effect as pseudo transparency with
346a custom pixmap. No scaling is supported in this mode. Exmaple:
347</dd>
348<dd>
349<pre>
350 rxvt -pixmap background.xpm -pe automove-background</pre>
351</dd>
352<p></p>
353<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
354</dt>
355<dd>
356A not very useful example of filtering all text output to the terminal,
357by replacing all line-drawing characters (U+2500 .. U+259F) by a
358similar-looking ascii character.
359</dd>
360<p></p>
103<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 361<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
104</dt> 362</dt>
105<dd> 363<dd>
106Displays a digital clock using the built-in overlay. 364Displays a digital clock using the built-in overlay.
365</dd>
366<p></p>
367<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
368</dt>
369<dd>
370Somewhat of a misnomer, this extension adds two menu entries to the
371selection popup that allows one ti run external commands to store the
372selection somewhere and fetch it again.
373</dd>
374<dd>
375<p>We use it to implement a ``distributed selection mechanism'', which just
376means that one command uploads the file to a remote server, and another
377reads it.</p>
378</dd>
379<dd>
380<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
381<code>URxvt.remote-selection.fetch</code> resources. The first should read the
382selection to store from STDIN (always in UTF-8), the second should provide
383the selection data on STDOUT (also in UTF-8).</p>
384</dd>
385<dd>
386<p>The defaults (which are likely useless to you) use rsh and cat:</p>
387</dd>
388<dd>
389<pre>
390 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
391 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
392</dd>
393<p></p>
394<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
395</dt>
396<dd>
397This is a little rarely useful extension that Uploads the selection as
398textfile to a remote site (or does other things). (The implementation is
399not currently secure for use in a multiuser environment as it writes to
400<em>/tmp</em> directly.).
401</dd>
402<dd>
403<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
404i.e.</p>
405</dd>
406<dd>
407<pre>
408 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
409</dd>
410<dd>
411<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
412the textfile. This command can be set via a resource:</p>
413</dd>
414<dd>
415<pre>
416 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
417</dd>
418<dd>
419<p>And the default is likely not useful to anybody but the few people around
420here :)</p>
421</dd>
422<dd>
423<p>The name of the textfile is the hex encoded md5 sum of the selection, so
424the same content should lead to the same filename.</p>
425</dd>
426<dd>
427<p>After a successful upload the selection will be replaced by the text given
428in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
429for the filename):</p>
430</dd>
431<dd>
432<pre>
433 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
107</dd> 434</dd>
108<p></p> 435<p></p>
109<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 436<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
110</dt> 437</dt>
111<dd> 438<dd>
112Displays a very simple digital clock in the upper right corner of the 439Displays a very simple digital clock in the upper right corner of the
113window. Illustrates overwriting the refresh callbacks to create your own 440window. Illustrates overwriting the refresh callbacks to create your own
114overlays or changes. 441overlays or changes.
115</dd> 442</dd>
116<p></p></dl> 443<p></p></dl>
444<p>
445</p>
446<hr />
447<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
117<p> 448<p>
118</p> 449</p>
119<h2><a name="general_api_considerations">General API Considerations</a></h2> 450<h2><a name="general_api_considerations">General API Considerations</a></h2>
120<p>All objects (such as terminals, time watchers etc.) are typical 451<p>All objects (such as terminals, time watchers etc.) are typical
121reference-to-hash objects. The hash can be used to store anything you 452reference-to-hash objects. The hash can be used to store anything you
… …
124modified).</p> 455modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are 456<p>When objects are destroyed on the C++ side, the perl object hashes are
126emptied, so its best to store related objects such as time watchers and 457emptied, so its best to store related objects such as time watchers and
127the like inside the terminal object so they get destroyed as soon as the 458the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p> 459terminal is destroyed.</p>
460<p>Argument names also often indicate the type of a parameter. Here are some
461hints on what they mean:</p>
462<dl>
463<dt><strong><a name="item__24text">$text</a></strong><br />
464</dt>
465<dd>
466Rxvt-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.
468</dd>
469<p></p>
470<dt><strong><a name="item__24string">$string</a></strong><br />
471</dt>
472<dd>
473A 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
475encoding (often locale-specific) and binary data.
476</dd>
477<p></p>
478<dt><strong><a name="item__24octets">$octets</a></strong><br />
479</dt>
480<dd>
481Either binary data or - more common - a text string encoded in a
482locale-specific way.
483</dd>
484<p></p></dl>
485<p>
486</p>
487<h2><a name="extension_objects">Extension Objects</a></h2>
488<p>Very 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
490hooks. So extensions can use their <code>$self</code> object without having to think
491about other extensions, with the exception of methods and members that
492begin with an underscore character <code>_</code>: these are reserved for internal
493use.</p>
494<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>
496<p>It has the following methods and data members:</p>
497<dl>
498<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
499</dt>
500<dd>
501Returns the <code>urxvt::term</code> object associated with this instance of the
502extension. This member <em>must not</em> be changed in any way.
503</dd>
504<p></p>
505<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
506</dt>
507<dd>
508Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
509this extension, replacing any previous hook. This is useful when you want
510to overwrite time-critical hooks only temporarily.
511</dd>
512<p></p>
513<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
514</dt>
515<dd>
516Dynamically disable the given hooks.
517</dd>
518<p></p></dl>
129<p> 519<p>
130</p> 520</p>
131<h2><a name="hooks">Hooks</a></h2> 521<h2><a name="hooks">Hooks</a></h2>
132<p>The following subroutines can be declared in loaded scripts, and will be 522<p>The following subroutines can be declared in extension files, and will be
133called whenever the relevant event happens.</p> 523called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal 524<p>The first argument passed to them is an extension oject as described in
135and extension package. You can call all <code>urxvt::term</code> methods on it, but 525the in the <code>Extension Objects</code> section.</p>
136its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> 526<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
137object that is shared between all packages is stored in the <code>term</code> 527hooks returns true, then the event counts as being <em>consumed</em>, and the
138member.</p>
139<p>All of them must return a boolean value. If it is true, then the event
140counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
141and the relevant action might not be carried out by the C++ code.</p> 528relevant action might not be carried out by the C++ code.</p>
142<p>When in doubt, return a false value (preferably <code>()</code>).</p> 529<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
143<dl> 530<dl>
144<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 531<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145</dt> 532</dt>
146<dd> 533<dd>
147Called after a new terminal object has been initialized, but before 534Called after a new terminal object has been initialized, but before
148windows are created or the command gets run. 535windows are created or the command gets run. Most methods are unsafe to
536call or deliver senseless data, as terminal size and other characteristics
537have 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
539place.
540</dd>
541<p></p>
542<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
543</dt>
544<dd>
545Called at the very end of initialisation of a new terminal, just before
546trying to map (display) the toplevel and returning to the mainloop.
547</dd>
548<p></p>
549<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
550</dt>
551<dd>
552Called whenever something tries to destroy terminal, when the terminal is
553still fully functional (not for long, though).
149</dd> 554</dd>
150<p></p> 555<p></p>
151<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 556<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152</dt> 557</dt>
153<dd> 558<dd>
154Called after the screen is ``reset'' for any reason, such as resizing or 559Called after the screen is ``reset'' for any reason, such as resizing or
155control sequences. Here is where you can react on changes to size-related 560control sequences. Here is where you can react on changes to size-related
156variables. 561variables.
157</dd> 562</dd>
158<p></p> 563<p></p>
159<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 564<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
160</dt> 565</dt>
566<dd>
567Called just after the child process has been <code>fork</code>ed.
161<dd> 568</dd>
162Called at the very end of initialisation of a new terminal, just before 569<p></p>
163returning to the mainloop. 570<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
571</dt>
572<dd>
573Called just after the child process has exited. <code>$status</code> is the status
574from <code>waitpid</code>.
164</dd> 575</dd>
165<p></p> 576<p></p>
166<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 577<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
167</dt> 578</dt>
168<dd> 579<dd>
… …
190</dt> 601</dt>
191<dd> 602<dd>
192Called whenever the user tries to extend the selection (e.g. with a double 603Called whenever the user tries to extend the selection (e.g. with a double
193click) and is either supposed to return false (normal operation), or 604click) and is either supposed to return false (normal operation), or
194should extend the selection itelf and return true to suppress the built-in 605should extend the selection itelf and return true to suppress the built-in
195processing. 606processing. 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
608supposed to enlarge the selection more and more, if possible.
196</dd> 609</dd>
197<dd> 610<dd>
198<p>See the <em>selection</em> example extension.</p> 611<p>See the <em>selection</em> example extension.</p>
199</dd>
200<p></p>
201<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
202</dt>
203<dd>
204Called whenever the window gets the keyboard focus, before urxvt does
205focus in processing.
206</dd>
207<p></p>
208<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
209</dt>
210<dd>
211Called wheneever the window loses keyboard focus, before urxvt does focus
212out processing.
213</dd> 612</dd>
214<p></p> 613<p></p>
215<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 614<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
216</dt> 615</dt>
217<dd> 616<dd>
… …
229</dd> 628</dd>
230<dd> 629<dd>
231<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 630<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
232$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 631$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
233number of lines that will be in the scrollback buffer.</p> 632number of lines that will be in the scrollback buffer.</p>
234</dd>
235<p></p>
236<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
237</dt>
238<dd>
239Called whenever the <code>program(s)</code> running in the urxvt window send output.
240</dd> 633</dd>
241<p></p> 634<p></p>
242<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 635<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
243</dt> 636</dt>
244<dd> 637<dd>
… …
253<p>Be careful not ever to trust (in a security sense) the data you receive, 646<p>Be careful not ever to trust (in a security sense) the data you receive,
254as its source can not easily be controleld (e-mail content, messages from 647as its source can not easily be controleld (e-mail content, messages from
255other users on the same system etc.).</p> 648other users on the same system etc.).</p>
256</dd> 649</dd>
257<p></p> 650<p></p>
651<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
652</dt>
653<dd>
654Called 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
656and 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
658output.
659</dd>
660<p></p>
661<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
662</dt>
663<dd>
664Called whenever some data is written to the tty/pty and can be used to
665suppress or filter tty input.
666</dd>
667<p></p>
668<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
669</dt>
670<dd>
671Called whenever a line was updated or changed. Can be used to filter
672screen output (e.g. underline urls or other useless stuff). Only lines
673that are being shown will be filtered, and, due to performance reasons,
674not always immediately.
675</dd>
676<dd>
677<p>The row number is always the topmost row of the line if the line spans
678multiple rows.</p>
679</dd>
680<dd>
681<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
683you cannot just toggle rendition bits, but only set them.</p>
684</dd>
685<p></p>
258<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 686<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
259</dt> 687</dt>
260<dd> 688<dd>
261Called just before the screen gets redrawn. Can be used for overlay 689Called just before the screen gets redrawn. Can be used for overlay
262or similar effects by modify terminal contents in refresh_begin, and 690or similar effects by modify terminal contents in refresh_begin, and
… …
268</dt> 696</dt>
269<dd> 697<dd>
270Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 698Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
271</dd> 699</dd>
272<p></p> 700<p></p>
273<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 701<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
274</dt> 702</dt>
275<dd> 703<dd>
276Called whenever the user presses a key combination that has a 704Called whenever the a user-configured event is being activated (e.g. via
277<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 705a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
278resource in the <code>rxvt(1)</code> manpage). 706resource in the <code>rxvt(1)</code> manpage).
707</dd>
708<dd>
709<p>The event is simply the action string. This interface is assumed to change
710slightly in the future.</p>
711</dd>
712<p></p>
713<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
714</dt>
715<dd>
716Called on every X event received on the vt window (and possibly other
717windows). Should only be used as a last resort. Most event structure
718members are not passed.
719</dd>
720<p></p>
721<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
722</dt>
723<dd>
724Called whenever the window gets the keyboard focus, before rxvt-unicode
725does focus in processing.
726</dd>
727<p></p>
728<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
729</dt>
730<dd>
731Called wheneever the window loses keyboard focus, before rxvt-unicode does
732focus out processing.
733</dd>
734<p></p>
735<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
736</dt>
737<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
738</dt>
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 />
740</dt>
741<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
742</dt>
743<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
744</dt>
745<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
746</dt>
747<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
748</dt>
749<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
750</dt>
751<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
752</dt>
753<dd>
754Called whenever the corresponding X event is received for the terminal If
755the hook returns true, then the even will be ignored by rxvt-unicode.
756</dd>
757<dd>
758<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
760(real, not screen-based) row and column under the mouse cursor.</p>
761</dd>
762<dd>
763<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
764output, if any, in locale-specific encoding.</p>
765</dd>
766<dd>
767<p>subwindow.</p>
768</dd>
769<p></p>
770<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
771</dt>
772<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
773</dt>
774<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
775</dt>
776<dd>
777Called when various types of ClientMessage events are received (all with
778format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
279</dd> 779</dd>
280<p></p></dl> 780<p></p></dl>
281<p> 781<p>
282</p> 782</p>
283<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 783<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
284<dl> 784<dl>
785<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
786</dt>
787<dd>
788The rxvt-unicode library directory, where, among other things, the perl
789modules and scripts are stored.
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>
795The resource class and name rxvt-unicode uses to look up X resources.
796</dd>
797<p></p>
798<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
799</dt>
800<dd>
801The basename of the installed binaries, usually <code>urxvt</code>.
802</dd>
803<p></p>
285<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 804<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
286</dt> 805</dt>
287<dd> 806<dd>
288The current terminal. Whenever a callback/Hook is bein executed, this 807The current terminal. This variable stores the current <code>urxvt::term</code>
289variable stores the current <code>urxvt::term</code> object. 808object, whenever a callback/hook is executing.
809</dd>
810<p></p>
811<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
812</dt>
813<dd>
814All coderefs in this array will be called as methods of the next newly
815created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
816gets cleared before the codereferences that were in it are being executed,
817so coderefs can push themselves onto it again if they so desire.
818</dd>
819<dd>
820<p>This complements to the perl-eval commandline option, but gets executed
821first.</p>
822</dd>
823<p></p>
824<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
825</dt>
826<dd>
827Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
828get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
829but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
290</dd> 830</dd>
291<p></p></dl> 831<p></p></dl>
292<p> 832<p>
293</p> 833</p>
294<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 834<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
… …
310</dd> 850</dd>
311<dd> 851<dd>
312<p>Using this function has the advantage that its output ends up in the 852<p>Using this function has the advantage that its output ends up in the
313correct place, e.g. on stderr of the connecting urxvtc client.</p> 853correct place, e.g. on stderr of the connecting urxvtc client.</p>
314</dd> 854</dd>
855<dd>
856<p>Messages have a size limit of 1023 bytes currently.</p>
857</dd>
858<p></p>
859<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
860</dt>
861<dd>
862Returns all urxvt::term objects that exist in this process, regardless of
863wether they are started, being destroyed etc., so be careful. Only term
864objects that have perl extensions attached will be returned (because there
865is no urxvt::term objet associated with others).
866</dd>
315<p></p> 867<p></p>
316<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 868<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
317</dt> 869</dt>
318<dd> 870<dd>
319Returns the ``current time'' (as per the event loop). 871Returns the ``current time'' (as per the event loop).
872</dd>
873<p></p>
874<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
875</dt>
876<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,
878Button4Mask, Button5Mask, AnyModifier</a></strong><br />
879</dt>
880<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
881ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
882PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
883Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
884KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
885ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
886FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
887</dt>
888<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
889EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
890GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
891UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
892ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
893CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
894SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
895</dt>
896<dd>
897Various constants for use in X calls and event processing.
320</dd> 898</dd>
321<p></p></dl> 899<p></p></dl>
322<p> 900<p>
323</p> 901</p>
324<h2><a name="rendition">RENDITION</a></h2> 902<h2><a name="rendition">RENDITION</a></h2>
… …
356</dt> 934</dt>
357<dd> 935<dd>
358Return the foreground/background colour index, respectively. 936Return the foreground/background colour index, respectively.
359</dd> 937</dd>
360<p></p> 938<p></p>
361<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 939<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
362</dt> 940</dt>
363<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 941<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
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 />
364</dt> 944</dt>
365<dd> 945<dd>
366Replace the foreground/background colour in the rendition mask with the 946Replace the foreground/background colour in the rendition mask with the
367specified one. 947specified one.
368</dd> 948</dd>
369<p></p> 949<p></p>
370<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 950<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
371</dt> 951</dt>
372<dd> 952<dd>
373Return the ``custom'' value: Every rendition has 5 bits for use by 953Return the ``custom'' value: Every rendition has 5 bits for use by
374extensions. They can be set and changed as you like and are initially 954extensions. They can be set and changed as you like and are initially
375zero. 955zero.
376</dd> 956</dd>
377<p></p> 957<p></p>
378<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 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 />
379</dt> 959</dt>
380<dd> 960<dd>
381Change the custom value. 961Change the custom value.
382</dd> 962</dd>
383<p></p></dl> 963<p></p></dl>
964<p>
965</p>
966<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
968<code>AnyEvent</code> module - any module using it will work inside urxvt without
969further programming. The only exception is that you cannot wait on
970condition variables, but non-blocking condvar use is ok. What this means
971is that you cannot use blocking APIs, but the non-blocking variant should
972work.</p>
384<p> 973<p>
385</p> 974</p>
386<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 975<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
387<dl> 976<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 />
978</dt>
979<dd>
980Creates 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
982hash which defines the environment of the new terminal.
983</dd>
984<dd>
985<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
987initialise 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
989refer to global data (which is race free).</p>
990</dd>
991<p></p>
992<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
993</dt>
994<dd>
995Destroy the terminal object (close the window, free resources
996etc.). Please note that rxvt will not exit as long as any event
997watchers (timers, io watchers) are still active.
998</dd>
999<p></p>
1000<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
1001</dt>
1002<dd>
1003Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
1004(``starts'') programs in the background. This function takes care of setting
1005the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
1006be preferred over explicit calls to <code>exec</code> or <code>system</code>.
1007</dd>
1008<dd>
1009<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
1010</dd>
1011<p></p>
1012<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
1013</dt>
1014<dd>
1015Returns 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
1017<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
1018</dd>
1019<dd>
1020<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>
1022</dd>
1023<dd>
1024<pre>
1025 borderLess console cursorBlink cursorUnderline hold iconic insecure
1026 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1027 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1028 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1029 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1030 transparent tripleclickwords utmpInhibit visualBell</pre>
1031</dd>
1032<p></p>
388<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 1033<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
389</dt> 1034</dt>
390<dd> 1035<dd>
391Returns the current resource value associated with a given name and 1036Returns the current resource value associated with a given name and
392optionally sets a new value. Setting values is most useful in the <code>init</code> 1037optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
406<p>Please note that resource strings will currently only be freed when the 1051<p>Please note that resource strings will currently only be freed when the
407terminal is destroyed, so changing options frequently will eat memory.</p> 1052terminal is destroyed, so changing options frequently will eat memory.</p>
408</dd> 1053</dd>
409<dd> 1054<dd>
410<p>Here is a a likely non-exhaustive list of resource names, not all of which 1055<p>Here is a a likely non-exhaustive list of resource names, not all of which
411are supported in every build, please see the source to see the actual 1056are supported in every build, please see the source file <em>/src/rsinc.h</em>
412list:</p> 1057to see the actual list:</p>
413</dd> 1058</dd>
414<dd> 1059<dd>
415<pre> 1060<pre>
416 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1061 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
417 borderLess color cursorBlink cursorUnderline cutchars delete_key 1062 borderLess color cursorBlink cursorUnderline cutchars delete_key
418 display_name embed ext_bwidth fade font geometry hold iconName 1063 display_name embed ext_bwidth fade font geometry hold iconName
419 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1064 imFont imLocale inputMethod insecure int_bwidth intensityStyles
420 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1065 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
421 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 1066 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
422 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1067 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
423 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1068 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
424 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1069 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
425 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1070 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
426 shade term_name title transparent transparent_all tripleclickwords 1071 secondaryScreen secondaryScroll selectstyle shade term_name title
1072 transient_for transparent transparent_all tripleclickwords utmpInhibit
427 utmpInhibit visualBell</pre> 1073 visualBell</pre>
1074</dd>
1075<p></p>
1076<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1077</dt>
1078<dd>
1079Returns 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
1081same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1082resource with that pattern exists.
1083</dd>
1084<dd>
1085<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
1087the wrong resources.</p>
1088</dd>
1089<p></p>
1090<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1091</dt>
1092<dd>
1093Adds a keymap translation exactly as specified via a resource. See the
1094<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
1095</dd>
1096<p></p>
1097<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1098</dt>
1099<dd>
1100Return and optionally change the current rendition. Text that is output by
1101the terminal application will use this style.
1102</dd>
1103<p></p>
1104<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1105</dt>
1106<dd>
1107Return the current coordinates of the text cursor position and optionally
1108set it (which is usually bad as applications don't expect that).
428</dd> 1109</dd>
429<p></p> 1110<p></p>
430<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1111<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
431</dt> 1112</dt>
432<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 1113<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
436<dd> 1117<dd>
437Return the current values of the selection mark, begin or end positions, 1118Return the current values of the selection mark, begin or end positions,
438and optionally set them to new values. 1119and optionally set them to new values.
439</dd> 1120</dd>
440<p></p> 1121<p></p>
1122<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1123</dt>
1124<dd>
1125Tries 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
1127rectangular selection will be made. This is the prefered function to make
1128a selection.
1129</dd>
1130<p></p>
441<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1131<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
442</dt> 1132</dt>
443<dd> 1133<dd>
444Try to request the primary selection from the server (for example, as set 1134Try to request the primary selection text from the server (for example, as
445by the next method). 1135set by the next method). No visual feedback will be given. This function
1136is mostly useful from within <code>on_sel_grab</code> hooks.
446</dd> 1137</dd>
447<p></p> 1138<p></p>
448<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1139<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
449</dt> 1140</dt>
450<dd> 1141<dd>
451Return the current selection text and optionally replace it by <code>$newtext</code>. 1142Return the current selection text and optionally replace it by <code>$newtext</code>.
452</dd> 1143</dd>
1144<p></p>
1145<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1146</dt>
453<dd> 1147<dd>
454<p>#=item $term-&gt;overlay ($x, $y, $text)
455#
456#Create a simple multi-line overlay box. See the next method for details. 1148Create a simple multi-line overlay box. See the next method for details.
457#
458#=cut</p>
459</dd>
460<dd>
461<p>sub urxvt::term::scr_overlay {
462die;
463 my ($self, $x, $y, $text) = @_;</p>
464</dd>
465<dd>
466<pre>
467 my @lines = split /\n/, $text;</pre>
468</dd>
469<dd>
470<pre>
471 my $w = 0;
472 for (map $self-&gt;strwidth ($_), @lines) {
473 $w = $_ if $w &lt; $_;
474 }</pre>
475</dd>
476<dd>
477<pre>
478 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
479 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
480}</pre>
481</dd> 1149</dd>
482<p></p> 1150<p></p>
483<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 1151<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
484</dt> 1152</dt>
485<dd> 1153<dd>
… …
521</dt> 1189</dt>
522<dd> 1190<dd>
523If hidden, display the overlay again. 1191If hidden, display the overlay again.
524</dd> 1192</dd>
525<p></p></dl> 1193<p></p></dl>
1194<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1195</dt>
1196<dd>
1197Creates 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,
1199currently).
1200</dd>
1201<p></p>
526<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 1202<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
527</dt> 1203</dt>
528<dd> 1204<dd>
529Returns the number of screen-cells this string would need. Correctly 1205Returns the number of screen-cells this string would need. Correctly
530accounts for wide and combining characters. 1206accounts for wide and combining characters.
531</dd> 1207</dd>
532<p></p> 1208<p></p>
533<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 1209<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
534</dt> 1210</dt>
535<dd> 1211<dd>
536Convert the given text string into the corresponding locale encoding. 1212Convert the given text string into the corresponding locale encoding.
537</dd> 1213</dd>
538<p></p> 1214<p></p>
539<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 1215<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
540</dt> 1216</dt>
541<dd> 1217<dd>
542Convert the given locale-encoded octets into a perl string. 1218Convert the given locale-encoded octets into a perl string.
1219</dd>
1220<p></p>
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 />
1222</dt>
1223<dd>
1224XORs 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
1226refresh hooks to provide effects similar to the selection.
1227</dd>
1228<p></p>
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 />
1230</dt>
1231<dd>
1232Similar 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
1234to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1235it instead. Both styles <em>MUST NOT</em> contain font styles.
1236</dd>
1237<p></p>
1238<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1239</dt>
1240<dd>
1241Ring the bell!
1242</dd>
1243<p></p>
1244<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1245</dt>
1246<dd>
1247Write the given text string to the screen, as if output by the application
1248running inside the terminal. It may not contain command sequences (escape
1249codes), but is free to use line feeds, carriage returns and tabs. The
1250string is a normal text string, not in locale-dependent encoding.
1251</dd>
1252<dd>
1253<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
1255<code>on_add_lines</code> hook, though.</p>
1256</dd>
1257<p></p>
1258<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1259</dt>
1260<dd>
1261Switch to given screen - 0 primary, 1 secondary.
1262</dd>
1263<p></p>
1264<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1265</dt>
1266<dd>
1267Similar 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
1269(escape codes) that will be interpreted.
543</dd> 1270</dd>
544<p></p> 1271<p></p>
545<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1272<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
546</dt> 1273</dt>
547<dd> 1274<dd>
548Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1275Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
549pass characters instead of octets, you should convert your strings first 1276pass characters instead of octets, you should convert your strings first
550to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1277to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
551</dd> 1278</dd>
552<p></p> 1279<p></p>
1280<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1281</dt>
1282<dd>
1283Replaces 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
1285description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1286the previous value.
1287</dd>
1288<p></p>
1289<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1290</dt>
1291<dd>
1292Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1293is used.
1294</dd>
1295<p></p>
1296<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1297</dt>
1298<dd>
1299Return the window id of the toplevel window.
1300</dd>
1301<p></p>
1302<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1303</dt>
1304<dd>
1305Return the window id of the terminal window.
1306</dd>
1307<p></p>
1308<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1309</dt>
1310<dd>
1311Adds the specified events to the vt event mask. Useful e.g. when you want
1312to receive pointer events all the times:
1313</dd>
1314<dd>
1315<pre>
1316 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1317</dd>
1318<p></p>
1319<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1320</dt>
1321<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1322</dt>
1323<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1324</dt>
1325<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1326</dt>
1327<dd>
1328Deliver various fake events to to terminal.
1329</dd>
1330<p></p>
1331<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1332</dt>
1333<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1334</dt>
1335<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1336</dt>
1337<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1338</dt>
1339<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1340</dt>
553<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 1341<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
554</dt> 1342</dt>
555<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1343<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
556</dt> 1344</dt>
557<dd> 1345<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
558Return the number of rows/columns of the terminal window (i.e. as 1346</dt>
559specified by <code>-geometry</code>, excluding any scrollback). 1347<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1348</dt>
1349<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1350</dt>
1351<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1352</dt>
1353<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1354</dt>
560</dd> 1355<dd>
1356Return various integers describing terminal characteristics.
1357</dd>
561<p></p> 1358<p></p>
1359<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1360</dt>
1361<dd>
1362Return the DISPLAY used by rxvt-unicode.
1363</dd>
1364<p></p>
1365<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1366</dt>
1367<dd>
1368Returns the LC_CTYPE category string used by this rxvt-unicode.
1369</dd>
1370<p></p>
562<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1371<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
563</dt> 1372</dt>
1373<dd>
1374Returns a copy of the environment in effect for the terminal as a hashref
1375similar to <code>\%ENV</code>.
564<dd> 1376</dd>
565Returns the number of lines in the scrollback buffer. 1377<p></p>
1378<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1379</dt>
1380<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1381</dt>
1382<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1383</dt>
1384<dd>
1385Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1386AltGr), the meta key (often Alt) and the num lock key, if applicable.
1387</dd>
1388<p></p>
1389<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1390</dt>
1391<dd>
1392Returns the currently displayed screen (0 primary, 1 secondary).
1393</dd>
1394<p></p>
1395<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1396</dt>
1397<dd>
1398Returns wether the cursor is currently hidden or not.
566</dd> 1399</dd>
567<p></p> 1400<p></p>
568<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1401<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
569</dt> 1402</dt>
570<dd> 1403<dd>
571Returns the negative row number of the topmost line. Minimum value is 1404Returns the row number of the topmost displayed line. Maximum value is
572<code>0</code>, which displays the normal terminal contents. Larger values scroll 1405<code>0</code>, which displays the normal terminal contents. Lower values scroll
573this many lines into the scrollback buffer. 1406this many lines into the scrollback buffer.
574</dd> 1407</dd>
575<p></p> 1408<p></p>
576<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1409<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
577</dt> 1410</dt>
… …
588</dt> 1421</dt>
589<dd> 1422<dd>
590Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1423Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
591is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1424is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
592terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1425terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
593line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1426line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
594is requested. 1427is requested.
595</dd> 1428</dd>
596<dd> 1429<dd>
597<p>If <code>$new_text</code> is specified, it will replace characters in the current 1430<p>If <code>$new_text</code> is specified, it will replace characters in the current
598line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1431line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
599to replace only parts of a line. The font index in the rendition will 1432to replace only parts of a line. The font index in the rendition will
600automatically be updated.</p> 1433automatically be updated.</p>
601</dd> 1434</dd>
602<dd> 1435<dd>
603<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1436<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
604than one cell when displayed are padded with urxvt::NOCHAR characters 1437than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
605(<code>chr 65535</code>). Characters with combining characters and other characters 1438characters. Characters with combining characters and other characters that
606that do not fit into the normal tetx encoding will be replaced with 1439do not fit into the normal tetx encoding will be replaced with characters
607characters in the private use area.</p> 1440in the private use area.</p>
608</dd> 1441</dd>
609<dd> 1442<dd>
610<p>You have to obey this encoding when changing text. The advantage is 1443<p>You have to obey this encoding when changing text. The advantage is
611that <code>substr</code> and similar functions work on screen cells and not on 1444that <code>substr</code> and similar functions work on screen cells and not on
612characters.</p> 1445characters.</p>
613</dd> 1446</dd>
614<dd> 1447<dd>
615<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 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>
616can be used to convert normal strings into this encoding and vice versa.</p> 1449can be used to convert normal strings into this encoding and vice versa.</p>
617</dd> 1450</dd>
618<p></p> 1451<p></p>
619<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1452<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
620</dt> 1453</dt>
… …
653Create and return a new <code>urxvt::line</code> object that stores information 1486Create and return a new <code>urxvt::line</code> object that stores information
654about the logical line that row <code>$row_number</code> is part of. It supports the 1487about the logical line that row <code>$row_number</code> is part of. It supports the
655following methods: 1488following methods:
656</dd> 1489</dd>
657<dl> 1490<dl>
658<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 1491<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
659</dt> 1492</dt>
660<dd> 1493<dd>
661Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1494Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
662</dd> 1495</dd>
663<p></p> 1496<p></p>
664<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 1497<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
665</dt> 1498</dt>
666<dd> 1499<dd>
667Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1500Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
668</dd> 1501</dd>
669<p></p> 1502<p></p>
670<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1503<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
671</dt> 1504</dt>
672<dd> 1505<dd>
… …
683<p></p> 1516<p></p>
684<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1517<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
685</dt> 1518</dt>
686<dd> 1519<dd>
687Returns the character offset of the given row|col pair within the logical 1520Returns the character offset of the given row|col pair within the logical
688line. 1521line. Works for rows outside the line, too, and returns corresponding
1522offsets outside the string.
689</dd> 1523</dd>
690<p></p> 1524<p></p>
691<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1525<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
692</dt> 1526</dt>
693<dd> 1527<dd>
694Translates a string offset into terminal coordinates again. 1528Translates a string offset into terminal coordinates again.
695</dd> 1529</dd>
696<p></p></dl> 1530<p></p></dl>
697<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1531<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
698=item $text = $term-&gt;special_encode $string</strong><br />
699</dt> 1532</dt>
700<dd> 1533<dd>
701Converts a perl string into the special encoding used by rxvt-unicode, 1534Converts a perl string into the special encoding used by rxvt-unicode,
702where one character corresponds to one screen cell. See 1535where one character corresponds to one screen cell. See
703<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1536<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
706<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1539<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
707</dt> 1540</dt>
708<dd> 1541<dd>
709Converts rxvt-unicodes text reprsentation into a perl string. See 1542Converts rxvt-unicodes text reprsentation into a perl string. See
710<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1543<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1544</dd>
1545<p></p>
1546<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1547</dt>
1548<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1549</dt>
1550<dd>
1551Register/unregister a synchronous button grab. See the XGrabButton
1552manpage.
1553</dd>
1554<p></p>
1555<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1556</dt>
1557<dd>
1558Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1559synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1560</dd>
1561<p></p>
1562<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1563</dt>
1564<dd>
1565Calls XAllowEvents with AsyncBoth for the most recent grab.
1566</dd>
1567<p></p>
1568<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1569</dt>
1570<dd>
1571Calls XAllowEvents with SyncBoth for the most recent grab.
1572</dd>
1573<p></p>
1574<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1575</dt>
1576<dd>
1577Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1578recent grab.
1579</dd>
1580<p></p>
1581<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1582</dt>
1583<dd>
1584Calls 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
1586the session.
1587</dd>
1588<p></p>
1589<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1590</dt>
1591<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1592</dt>
1593<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1594</dt>
1595<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1596</dt>
1597<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1598</dt>
1599<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1600</dt>
1601<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1602</dt>
1603<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1604</dt>
1605<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1606</dt>
1607<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1608</dt>
1609<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1610</dt>
1611<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1612</dt>
1613<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1614</dt>
1615<dd>
1616Various X or X-related functions. The <code>$term</code> object only serves as
1617the source of the display, otherwise those functions map more-or-less
1618directory onto the X functions of the same name.
1619</dd>
1620<p></p></dl>
1621<p>
1622</p>
1623<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1624<dl>
1625<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1626</dt>
1627<dd>
1628Adds a non-clickable title to the popup.
1629</dd>
1630<p></p>
1631<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1632</dt>
1633<dd>
1634Creates a separator, optionally using the character given as <code>$sepchr</code>.
1635</dd>
1636<p></p>
1637<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1638</dt>
1639<dd>
1640Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1641selected.
1642</dd>
1643<p></p>
1644<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1645</dt>
1646<dd>
1647Adds a toggle/checkbox item to the popup. Teh callback gets called
1648whenever it gets toggled, with a boolean indicating its value as its first
1649argument.
1650</dd>
1651<p></p>
1652<dt><strong>$popup-&gt;show</strong><br />
1653</dt>
1654<dd>
1655Displays the popup (which is initially hidden).
711</dd> 1656</dd>
712<p></p></dl> 1657<p></p></dl>
713<p> 1658<p>
714</p> 1659</p>
715<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1660<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
768</dt> 1713</dt>
769<dd> 1714<dd>
770Set the event trigger time to <code>$tstamp</code> and start the timer. 1715Set the event trigger time to <code>$tstamp</code> and start the timer.
771</dd> 1716</dd>
772<p></p> 1717<p></p>
1718<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1719</dt>
1720<dd>
1721Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1722</dd>
1723<p></p>
773<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1724<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
774</dt> 1725</dt>
775<dd> 1726<dd>
776Stop the timer. 1727Stop the timer.
777</dd> 1728</dd>
… …
783<pre> 1734<pre>
784 $term-&gt;{socket} = ... 1735 $term-&gt;{socket} = ...
785 $term-&gt;{iow} = urxvt::iow 1736 $term-&gt;{iow} = urxvt::iow
786 -&gt;new 1737 -&gt;new
787 -&gt;fd (fileno $term-&gt;{socket}) 1738 -&gt;fd (fileno $term-&gt;{socket})
788 -&gt;events (1) # wait for read data 1739 -&gt;events (urxvt::EVENT_READ)
789 -&gt;start 1740 -&gt;start
790 -&gt;cb (sub { 1741 -&gt;cb (sub {
791 my ($iow, $revents) = @_; 1742 my ($iow, $revents) = @_;
792 # $revents must be 1 here, no need to check 1743 # $revents must be 1 here, no need to check
793 sysread $term-&gt;{socket}, my $buf, 8192 1744 sysread $term-&gt;{socket}, my $buf, 8192
… …
814</dd> 1765</dd>
815<p></p> 1766<p></p>
816<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1767<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
817</dt> 1768</dt>
818<dd> 1769<dd>
819Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1770Set the event mask to watch. The only allowed values are
820data, Bit #1 (value <code>2</code>) enables watching for write data. 1771<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1772together, or <code>urxvt::EVENT_NONE</code>.
821</dd> 1773</dd>
822<p></p> 1774<p></p>
823<dt><strong>$iow = $iow-&gt;start</strong><br /> 1775<dt><strong>$iow = $iow-&gt;start</strong><br />
824</dt> 1776</dt>
825<dd> 1777<dd>
… …
828<p></p> 1780<p></p>
829<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1781<dt><strong>$iow = $iow-&gt;stop</strong><br />
830</dt> 1782</dt>
831<dd> 1783<dd>
832Stop watching for events on the given filehandle. 1784Stop watching for events on the given filehandle.
1785</dd>
1786<p></p></dl>
1787<p>
1788</p>
1789<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1790<p>This class implements idle watchers, that get called automatically when
1791the process is idle. They should return as fast as possible, after doing
1792some useful work.</p>
1793<dl>
1794<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1795</dt>
1796<dd>
1797Create a new idle watcher object in stopped state.
1798</dd>
1799<p></p>
1800<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1801</dt>
1802<dd>
1803Set the callback to be called when the watcher triggers.
1804</dd>
1805<p></p>
1806<dt><strong>$timer = $timer-&gt;start</strong><br />
1807</dt>
1808<dd>
1809Start the watcher.
1810</dd>
1811<p></p>
1812<dt><strong>$timer = $timer-&gt;stop</strong><br />
1813</dt>
1814<dd>
1815Stop the watcher.
1816</dd>
1817<p></p></dl>
1818<p>
1819</p>
1820<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1821<p>This class implements process watchers. They create an event whenever a
1822process exits, after which they stop automatically.</p>
1823<pre>
1824 my $pid = fork;
1825 ...
1826 $term-&gt;{pw} = urxvt::pw
1827 -&gt;new
1828 -&gt;start ($pid)
1829 -&gt;cb (sub {
1830 my ($pw, $exit_status) = @_;
1831 ...
1832 });</pre>
1833<dl>
1834<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1835</dt>
1836<dd>
1837Create a new process watcher in stopped state.
1838</dd>
1839<p></p>
1840<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1841</dt>
1842<dd>
1843Set the callback to be called when the timer triggers.
1844</dd>
1845<p></p>
1846<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1847</dt>
1848<dd>
1849Tells the wqtcher to start watching for process <code>$pid</code>.
1850</dd>
1851<p></p>
1852<dt><strong>$pw = $pw-&gt;stop</strong><br />
1853</dt>
1854<dd>
1855Stop the watcher.
833</dd> 1856</dd>
834<p></p></dl> 1857<p></p></dl>
835<p> 1858<p>
836</p> 1859</p>
837<hr /> 1860<hr />
… …
840</p> 1863</p>
841<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1864<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
842<p>This variable controls the verbosity level of the perl extension. Higher 1865<p>This variable controls the verbosity level of the perl extension. Higher
843numbers indicate more verbose output.</p> 1866numbers indicate more verbose output.</p>
844<dl> 1867<dl>
845<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1868<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
846</dt> 1869</dt>
847<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1870<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
848</dt> 1871</dt>
849<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1872<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1873</dt>
1874<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
850</dt> 1875</dt>
851</dl> 1876</dl>
852<p> 1877<p>
853</p> 1878</p>
854<hr /> 1879<hr />

Diff Legend

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