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.10 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.38 by root, Wed Jan 25 00:57:57 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<p></p>
299<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
300</dt>
301<dd>
302Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
303make them clickable. When middle-clicked, the program specified in the
304resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
305the URL as first argument.
306</dd>
307<p></p>
308<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
309</dt>
310<dd>
311This (experimental) perl extension implements OnTheSpot editing. It does
312not work perfectly, and some input methods don't seem to work well with
313OnTheSpot editing in general, but it seems to work at leats for SCIM and
314kinput2.
315</dd>
316<dd>
317<p>You enable it by specifying this extension and a preedit style of
318<code>OnTheSpot</code>, i.e.:</p>
319</dd>
320<dd>
321<pre>
322 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
323</dd>
324<p></p>
325<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
326</dt>
327<dd>
328This is basically a one-line extension that dynamically changes the background pixmap offset
329to the window position, in effect creating the same effect as pseudo transparency with
330a custom pixmap. No scaling is supported in this mode. Exmaple:
331</dd>
332<dd>
333<pre>
334 rxvt -pixmap background.xpm -pe automove-background</pre>
335</dd>
336<p></p>
337<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
338</dt>
339<dd>
340A not very useful example of filtering all text output to the terminal,
341by replacing all line-drawing characters (U+2500 .. U+259F) by a
342similar-looking ascii character.
343</dd>
344<p></p>
103<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 345<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
104</dt> 346</dt>
105<dd> 347<dd>
106Displays a digital clock using the built-in overlay. 348Displays a digital clock using the built-in overlay.
107</dd> 349</dd>
… …
111<dd> 353<dd>
112Displays a very simple digital clock in the upper right corner of the 354Displays a very simple digital clock in the upper right corner of the
113window. Illustrates overwriting the refresh callbacks to create your own 355window. Illustrates overwriting the refresh callbacks to create your own
114overlays or changes. 356overlays or changes.
115</dd> 357</dd>
358<p></p>
359<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
360</dt>
361<dd>
362This is a little rarely useful extension that Uploads the selection as
363textfile to a remote site (or does other things). (The implementation is
364not currently secure for use in a multiuser environment as it writes to
365<em>/tmp</em> directly.).
366</dd>
367<dd>
368<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
369i.e.</p>
370</dd>
371<dd>
372<pre>
373 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
374</dd>
375<dd>
376<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
377the textfile. This command can be set via a resource:</p>
378</dd>
379<dd>
380<pre>
381 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
382</dd>
383<dd>
384<p>And the default is likely not useful to anybody but the few people around
385here :)</p>
386</dd>
387<dd>
388<p>The name of the textfile is the hex encoded md5 sum of the selection, so
389the same content should lead to the same filename.</p>
390</dd>
391<dd>
392<p>After a successful upload the selection will be replaced by the text given
393in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
394for the filename):</p>
395</dd>
396<dd>
397<pre>
398 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
399</dd>
116<p></p></dl> 400<p></p></dl>
401<p>
402</p>
403<hr />
404<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
117<p> 405<p>
118</p> 406</p>
119<h2><a name="general_api_considerations">General API Considerations</a></h2> 407<h2><a name="general_api_considerations">General API Considerations</a></h2>
120<p>All objects (such as terminals, time watchers etc.) are typical 408<p>All objects (such as terminals, time watchers etc.) are typical
121reference-to-hash objects. The hash can be used to store anything you 409reference-to-hash objects. The hash can be used to store anything you
… …
124modified).</p> 412modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are 413<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 414emptied, 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 415the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p> 416terminal is destroyed.</p>
417<p>Argument names also often indicate the type of a parameter. Here are some
418hints on what they mean:</p>
419<dl>
420<dt><strong><a name="item__24text">$text</a></strong><br />
421</dt>
422<dd>
423Rxvt-unicodes special way of encoding text, where one ``unicode'' character
424always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
425</dd>
426<p></p>
427<dt><strong><a name="item__24string">$string</a></strong><br />
428</dt>
429<dd>
430A perl text string, with an emphasis on <em>text</em>. It can store all unicode
431characters and is to be distinguished with text encoded in a specific
432encoding (often locale-specific) and binary data.
433</dd>
434<p></p>
435<dt><strong><a name="item__24octets">$octets</a></strong><br />
436</dt>
437<dd>
438Either binary data or - more common - a text string encoded in a
439locale-specific way.
440</dd>
441<p></p></dl>
442<p>
443</p>
444<h2><a name="extension_objects">Extension Objects</a></h2>
445<p>Very perl extension is a perl class. A separate perl object is created
446for each terminal and each extension and passed as the first parameter to
447hooks. So extensions can use their <code>$self</code> object without having to think
448about other extensions, with the exception of methods and members that
449begin with an underscore character <code>_</code>: these are reserved for internal
450use.</p>
451<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
452<code>urxvt::term</code> class on this object.</p>
453<p>It has the following methods and data members:</p>
454<dl>
455<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
456</dt>
457<dd>
458Returns the <code>urxvt::term</code> object associated with this instance of the
459extension. This member <em>must not</em> be changed in any way.
460</dd>
461<p></p>
462<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
463</dt>
464<dd>
465Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
466this extension, replacing any previous hook. This is useful when you want
467to overwrite time-critical hooks only temporarily.
468</dd>
469<p></p>
470<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
471</dt>
472<dd>
473Dynamically disable the given hooks.
474</dd>
475<p></p></dl>
129<p> 476<p>
130</p> 477</p>
131<h2><a name="hooks">Hooks</a></h2> 478<h2><a name="hooks">Hooks</a></h2>
132<p>The following subroutines can be declared in loaded scripts, and will be 479<p>The following subroutines can be declared in extension files, and will be
133called whenever the relevant event happens.</p> 480called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal 481<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 482the in the <code>Extension Objects</code> section.</p>
136its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> 483<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> 484hooks 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> 485relevant action might not be carried out by the C++ code.</p>
142<p>When in doubt, return a false value (preferably <code>()</code>).</p> 486<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
143<dl> 487<dl>
144<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 488<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145</dt> 489</dt>
146<dd> 490<dd>
147Called after a new terminal object has been initialized, but before 491Called after a new terminal object has been initialized, but before
148windows are created or the command gets run. 492windows are created or the command gets run. Most methods are unsafe to
493call or deliver senseless data, as terminal size and other characteristics
494have not yet been determined. You can safely query and change resources
495and options, though. For many purposes the <code>on_start</code> hook is a better
496place.
497</dd>
498<p></p>
499<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
500</dt>
501<dd>
502Called at the very end of initialisation of a new terminal, just before
503trying to map (display) the toplevel and returning to the mainloop.
504</dd>
505<p></p>
506<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
507</dt>
508<dd>
509Called whenever something tries to destroy terminal, when the terminal is
510still fully functional (not for long, though).
149</dd> 511</dd>
150<p></p> 512<p></p>
151<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 513<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152</dt> 514</dt>
153<dd> 515<dd>
154Called after the screen is ``reset'' for any reason, such as resizing or 516Called 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 517control sequences. Here is where you can react on changes to size-related
156variables. 518variables.
157</dd> 519</dd>
158<p></p> 520<p></p>
159<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 521<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
160</dt> 522</dt>
523<dd>
524Called just after the child process has been <code>fork</code>ed.
161<dd> 525</dd>
162Called at the very end of initialisation of a new terminal, just before 526<p></p>
163returning to the mainloop. 527<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
528</dt>
529<dd>
530Called just after the child process has exited. <code>$status</code> is the status
531from <code>waitpid</code>.
164</dd> 532</dd>
165<p></p> 533<p></p>
166<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 534<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
167</dt> 535</dt>
168<dd> 536<dd>
… …
190</dt> 558</dt>
191<dd> 559<dd>
192Called whenever the user tries to extend the selection (e.g. with a double 560Called whenever the user tries to extend the selection (e.g. with a double
193click) and is either supposed to return false (normal operation), or 561click) and is either supposed to return false (normal operation), or
194should extend the selection itelf and return true to suppress the built-in 562should extend the selection itelf and return true to suppress the built-in
195processing. 563processing. This can happen multiple times, as long as the callback
564returns true, it will be called on every further click by the user and is
565supposed to enlarge the selection more and more, if possible.
196</dd> 566</dd>
197<dd> 567<dd>
198<p>See the <em>selection</em> example extension.</p> 568<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> 569</dd>
214<p></p> 570<p></p>
215<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 571<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
216</dt> 572</dt>
217<dd> 573<dd>
… …
231<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 587<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 588$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> 589number of lines that will be in the scrollback buffer.</p>
234</dd> 590</dd>
235<p></p> 591<p></p>
236<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 592<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
237</dt> 593</dt>
594<dd>
595Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
596operating system command) is processed. Cursor position and other state
597information is up-to-date when this happens. For interoperability, the
598string should start with the extension name and a colon, to distinguish
599it from commands for other extensions, and this might be enforced in the
600future.
238<dd> 601</dd>
239Called whenever the <code>program(s)</code> running in the urxvt window send output. 602<dd>
603<p>Be careful not ever to trust (in a security sense) the data you receive,
604as its source can not easily be controleld (e-mail content, messages from
605other users on the same system etc.).</p>
606</dd>
607<p></p>
608<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
609</dt>
610<dd>
611Called whenever text is about to be output, with the text as argument. You
612can filter/change and output the text yourself by returning a true value
613and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
614might be very slow, however, as your hook is called for <strong>all</strong> text being
615output.
616</dd>
617<p></p>
618<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
619</dt>
620<dd>
621Called whenever some data is written to the tty/pty and can be used to
622suppress or filter tty input.
623</dd>
624<p></p>
625<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
626</dt>
627<dd>
628Called whenever a line was updated or changed. Can be used to filter
629screen output (e.g. underline urls or other useless stuff). Only lines
630that are being shown will be filtered, and, due to performance reasons,
631not always immediately.
632</dd>
633<dd>
634<p>The row number is always the topmost row of the line if the line spans
635multiple rows.</p>
636</dd>
637<dd>
638<p>Please note that, if you change the line, then the hook might get called
639later with the already-modified line (e.g. if unrelated parts change), so
640you cannot just toggle rendition bits, but only set them.</p>
240</dd> 641</dd>
241<p></p> 642<p></p>
242<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 643<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
243</dt> 644</dt>
244<dd> 645<dd>
… …
259<dd> 660<dd>
260Called whenever the user presses a key combination that has a 661Called whenever the user presses a key combination that has a
261<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 662<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
262resource in the <code>rxvt(1)</code> manpage). 663resource in the <code>rxvt(1)</code> manpage).
263</dd> 664</dd>
665<p></p>
666<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
667</dt>
668<dd>
669Called on every X event received on the vt window (and possibly other
670windows). Should only be used as a last resort. Most event structure
671members are not passed.
672</dd>
673<p></p>
674<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
675</dt>
676<dd>
677Called whenever the window gets the keyboard focus, before rxvt-unicode
678does focus in processing.
679</dd>
680<p></p>
681<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
682</dt>
683<dd>
684Called wheneever the window loses keyboard focus, before rxvt-unicode does
685focus out processing.
686</dd>
687<p></p>
688<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
689</dt>
690<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
691</dt>
692<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
693</dt>
694<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
695</dt>
696<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
697</dt>
698<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
699</dt>
700<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
701</dt>
702<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
703</dt>
704<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
705</dt>
706<dd>
707Called whenever the corresponding X event is received for the terminal If
708the hook returns true, then the even will be ignored by rxvt-unicode.
709</dd>
710<dd>
711<p>The event is a hash with most values as named by Xlib (see the XEvent
712manpage), with the additional members <code>row</code> and <code>col</code>, which are the
713(real, not screen-based) row and column under the mouse cursor.</p>
714</dd>
715<dd>
716<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
717output, if any, in locale-specific encoding.</p>
718</dd>
719<dd>
720<p>subwindow.</p>
721</dd>
722<p></p>
723<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
724</dt>
725<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
726</dt>
727<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
728</dt>
729<dd>
730Called when various types of ClientMessage events are received (all with
731format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
732</dd>
264<p></p></dl> 733<p></p></dl>
265<p> 734<p>
266</p> 735</p>
267<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 736<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
268<dl> 737<dl>
738<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
739</dt>
740<dd>
741The rxvt-unicode library directory, where, among other things, the perl
742modules and scripts are stored.
743</dd>
744<p></p>
745<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
746</dt>
747<dd>
748The resource class and name rxvt-unicode uses to look up X resources.
749</dd>
750<p></p>
751<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
752</dt>
753<dd>
754The basename of the installed binaries, usually <code>urxvt</code>.
755</dd>
756<p></p>
269<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 757<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
270</dt> 758</dt>
271<dd> 759<dd>
272The current terminal. Whenever a callback/Hook is bein executed, this 760The current terminal. This variable stores the current <code>urxvt::term</code>
273variable stores the current <code>urxvt::term</code> object. 761object, whenever a callback/hook is executing.
762</dd>
763<p></p>
764<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
765</dt>
766<dd>
767All coderefs in this array will be called as methods of the next newly
768created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
769gets cleared before the codereferences that were in it are being executed,
770so coderefs can push themselves onto it again if they so desire.
771</dd>
772<dd>
773<p>This complements to the perl-eval commandline option, but gets executed
774first.</p>
775</dd>
776<p></p>
777<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
778</dt>
779<dd>
780Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
781get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
782but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
274</dd> 783</dd>
275<p></p></dl> 784<p></p></dl>
276<p> 785<p>
277</p> 786</p>
278<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 787<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
… …
294</dd> 803</dd>
295<dd> 804<dd>
296<p>Using this function has the advantage that its output ends up in the 805<p>Using this function has the advantage that its output ends up in the
297correct place, e.g. on stderr of the connecting urxvtc client.</p> 806correct place, e.g. on stderr of the connecting urxvtc client.</p>
298</dd> 807</dd>
808<dd>
809<p>Messages have a size limit of 1023 bytes currently.</p>
810</dd>
299<p></p> 811<p></p>
300<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 812<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
301</dt> 813</dt>
302<dd> 814<dd>
303Returns the ``current time'' (as per the event loop). 815Returns the ``current time'' (as per the event loop).
816</dd>
817<p></p>
818<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
819</dt>
820<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
821Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
822Button4Mask, Button5Mask, AnyModifier</a></strong><br />
823</dt>
824<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
825ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
826PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
827Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
828KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
829ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
830FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
831</dt>
832<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
833EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
834GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
835UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
836ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
837CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
838SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
839</dt>
840<dd>
841Various constants for use in X calls and event processing.
304</dd> 842</dd>
305<p></p></dl> 843<p></p></dl>
306<p> 844<p>
307</p> 845</p>
308<h2><a name="rendition">RENDITION</a></h2> 846<h2><a name="rendition">RENDITION</a></h2>
… …
340</dt> 878</dt>
341<dd> 879<dd>
342Return the foreground/background colour index, respectively. 880Return the foreground/background colour index, respectively.
343</dd> 881</dd>
344<p></p> 882<p></p>
345<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 883<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
346</dt> 884</dt>
347<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 885<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
348</dt> 886</dt>
349<dd> 887<dd>
350Replace the foreground/background colour in the rendition mask with the 888Replace the foreground/background colour in the rendition mask with the
351specified one. 889specified one.
352</dd> 890</dd>
353<p></p> 891<p></p>
354<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 892<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
355</dt> 893</dt>
356<dd> 894<dd>
357Return the ``custom'' value: Every rendition has 5 bits for use by 895Return the ``custom'' value: Every rendition has 5 bits for use by
358extensions. They can be set and changed as you like and are initially 896extensions. They can be set and changed as you like and are initially
359zero. 897zero.
360</dd> 898</dd>
361<p></p> 899<p></p>
362<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 900<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
363</dt> 901</dt>
364<dd> 902<dd>
365Change the custom value. 903Change the custom value.
366</dd> 904</dd>
367<p></p></dl> 905<p></p></dl>
906<p>
907</p>
908<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
909<p>The sole purpose of this class is to deliver an interface to the
910<code>AnyEvent</code> module - any module using it will work inside urxvt without
911further programming. The only exception is that you cannot wait on
912condition variables, but non-blocking condvar use is ok. What this means
913is that you cannot use blocking APIs, but the non-blocking variant should
914work.</p>
368<p> 915<p>
369</p> 916</p>
370<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 917<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
371<dl> 918<dl>
919<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
920</dt>
921<dd>
922Creates a new terminal, very similar as if you had started it with system
923<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
924hash which defines the environment of the new terminal.
925</dd>
926<dd>
927<p>Croaks (and probably outputs an error message) if the new instance
928couldn't be created. Returns <code>undef</code> if the new instance didn't
929initialise perl, and the terminal object otherwise. The <code>init</code> and
930<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
931</dd>
932<p></p>
933<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
934</dt>
935<dd>
936Destroy the terminal object (close the window, free resources
937etc.). Please note that rxvt will not exit as long as any event
938watchers (timers, io watchers) are still active.
939</dd>
940<p></p>
941<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
942</dt>
943<dd>
944Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
945(``starts'') programs in the background. This function takes care of setting
946the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
947be preferred over explicit calls to <code>exec</code> or <code>system</code>.
948</dd>
949<dd>
950<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
951</dd>
952<p></p>
953<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
954</dt>
955<dd>
956Returns true if the option specified by <code>$optval</code> is enabled, and
957optionally change it. All option values are stored by name in the hash
958<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
959</dd>
960<dd>
961<p>Here is a a likely non-exhaustive list of option names, please see the
962source file <em>/src/optinc.h</em> to see the actual list:</p>
963</dd>
964<dd>
965<pre>
966 borderLess console cursorBlink cursorUnderline hold iconic insecure
967 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
968 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
969 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
970 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
971 transparent tripleclickwords utmpInhibit visualBell</pre>
972</dd>
973<p></p>
372<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 974<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
373</dt> 975</dt>
374<dd> 976<dd>
375Returns the current resource value associated with a given name and 977Returns the current resource value associated with a given name and
376optionally sets a new value. Setting values is most useful in the <code>init</code> 978optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
390<p>Please note that resource strings will currently only be freed when the 992<p>Please note that resource strings will currently only be freed when the
391terminal is destroyed, so changing options frequently will eat memory.</p> 993terminal is destroyed, so changing options frequently will eat memory.</p>
392</dd> 994</dd>
393<dd> 995<dd>
394<p>Here is a a likely non-exhaustive list of resource names, not all of which 996<p>Here is a a likely non-exhaustive list of resource names, not all of which
395are supported in every build, please see the source to see the actual 997are supported in every build, please see the source file <em>/src/rsinc.h</em>
396list:</p> 998to see the actual list:</p>
397</dd> 999</dd>
398<dd> 1000<dd>
399<pre> 1001<pre>
400 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1002 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
401 borderLess color cursorBlink cursorUnderline cutchars delete_key 1003 borderLess color cursorBlink cursorUnderline cutchars delete_key
402 display_name embed ext_bwidth fade font geometry hold iconName 1004 display_name embed ext_bwidth fade font geometry hold iconName
403 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1005 imFont imLocale inputMethod insecure int_bwidth intensityStyles
404 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1006 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
405 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 1007 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
406 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1008 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
407 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1009 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
408 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1010 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
409 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1011 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
410 shade term_name title transparent transparent_all tripleclickwords 1012 secondaryScreen secondaryScroll selectstyle shade term_name title
1013 transient_for transparent transparent_all tripleclickwords utmpInhibit
411 utmpInhibit visualBell</pre> 1014 visualBell</pre>
1015</dd>
1016<p></p>
1017<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1018</dt>
1019<dd>
1020Returns the X-Resource for the given pattern, excluding the program or
1021class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
1022same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1023resource with that pattern exists.
1024</dd>
1025<dd>
1026<p>This method should only be called during the <code>on_start</code> hook, as there is
1027only one resource database per display, and later invocations might return
1028the wrong resources.</p>
1029</dd>
1030<p></p>
1031<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1032</dt>
1033<dd>
1034Adds a keymap translation exactly as specified via a resource. See the
1035<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
1036</dd>
1037<p></p>
1038<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1039</dt>
1040<dd>
1041Return and optionally change the current rendition. Text that is output by
1042the terminal application will use this style.
1043</dd>
1044<p></p>
1045<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1046</dt>
1047<dd>
1048Return the current coordinates of the text cursor position and optionally
1049set it (which is usually bad as applications don't expect that).
412</dd> 1050</dd>
413<p></p> 1051<p></p>
414<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1052<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
415</dt> 1053</dt>
416<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 1054<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
… …
420<dd> 1058<dd>
421Return the current values of the selection mark, begin or end positions, 1059Return the current values of the selection mark, begin or end positions,
422and optionally set them to new values. 1060and optionally set them to new values.
423</dd> 1061</dd>
424<p></p> 1062<p></p>
1063<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1064</dt>
1065<dd>
1066Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1067<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1068rectangular selection will be made. This is the prefered function to make
1069a selection.
1070</dd>
1071<p></p>
425<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 1072<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
426</dt> 1073</dt>
427<dd> 1074<dd>
428Try to request the primary selection from the server (for example, as set 1075Try to request the primary selection text from the server (for example, as
429by the next method). 1076set by the next method). No visual feedback will be given. This function
1077is mostly useful from within <code>on_sel_grab</code> hooks.
430</dd> 1078</dd>
431<p></p> 1079<p></p>
432<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 1080<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
433</dt> 1081</dt>
434<dd> 1082<dd>
435Return the current selection text and optionally replace it by <code>$newtext</code>. 1083Return the current selection text and optionally replace it by <code>$newtext</code>.
436</dd> 1084</dd>
1085<p></p>
1086<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1087</dt>
437<dd> 1088<dd>
438<p>#=item $term-&gt;overlay ($x, $y, $text)
439#
440#Create a simple multi-line overlay box. See the next method for details. 1089Create a simple multi-line overlay box. See the next method for details.
441#
442#=cut</p>
443</dd>
444<dd>
445<p>sub urxvt::term::scr_overlay {
446die;
447 my ($self, $x, $y, $text) = @_;</p>
448</dd>
449<dd>
450<pre>
451 my @lines = split /\n/, $text;</pre>
452</dd>
453<dd>
454<pre>
455 my $w = 0;
456 for (map $self-&gt;strwidth ($_), @lines) {
457 $w = $_ if $w &lt; $_;
458 }</pre>
459</dd>
460<dd>
461<pre>
462 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
463 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
464}</pre>
465</dd> 1090</dd>
466<p></p> 1091<p></p>
467<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 1092<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
468</dt> 1093</dt>
469<dd> 1094<dd>
… …
505</dt> 1130</dt>
506<dd> 1131<dd>
507If hidden, display the overlay again. 1132If hidden, display the overlay again.
508</dd> 1133</dd>
509<p></p></dl> 1134<p></p></dl>
1135<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1136</dt>
1137<dd>
1138Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1139<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1140currently).
1141</dd>
1142<p></p>
510<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 1143<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
511</dt> 1144</dt>
512<dd> 1145<dd>
513Returns the number of screen-cells this string would need. Correctly 1146Returns the number of screen-cells this string would need. Correctly
514accounts for wide and combining characters. 1147accounts for wide and combining characters.
515</dd> 1148</dd>
516<p></p> 1149<p></p>
517<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 1150<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
518</dt> 1151</dt>
519<dd> 1152<dd>
520Convert the given text string into the corresponding locale encoding. 1153Convert the given text string into the corresponding locale encoding.
521</dd> 1154</dd>
522<p></p> 1155<p></p>
523<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 1156<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
524</dt> 1157</dt>
525<dd> 1158<dd>
526Convert the given locale-encoded octets into a perl string. 1159Convert the given locale-encoded octets into a perl string.
1160</dd>
1161<p></p>
1162<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 />
1163</dt>
1164<dd>
1165XORs the rendition values in the given span with the provided value
1166(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1167refresh hooks to provide effects similar to the selection.
1168</dd>
1169<p></p>
1170<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 />
1171</dt>
1172<dd>
1173Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1174whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1175to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1176it instead. Both styles <em>MUST NOT</em> contain font styles.
1177</dd>
1178<p></p>
1179<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1180</dt>
1181<dd>
1182Ring the bell!
1183</dd>
1184<p></p>
1185<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1186</dt>
1187<dd>
1188Write the given text string to the screen, as if output by the application
1189running inside the terminal. It may not contain command sequences (escape
1190codes), but is free to use line feeds, carriage returns and tabs. The
1191string is a normal text string, not in locale-dependent encoding.
1192</dd>
1193<dd>
1194<p>Normally its not a good idea to use this function, as programs might be
1195confused by changes in cursor position or scrolling. Its useful inside a
1196<code>on_add_lines</code> hook, though.</p>
1197</dd>
1198<p></p>
1199<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1200</dt>
1201<dd>
1202Switch to given screen - 0 primary, 1 secondary.
1203</dd>
1204<p></p>
1205<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1206</dt>
1207<dd>
1208Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1209locale-specific encoding of the terminal and can contain command sequences
1210(escape codes) that will be interpreted.
527</dd> 1211</dd>
528<p></p> 1212<p></p>
529<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 1213<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
530</dt> 1214</dt>
531<dd> 1215<dd>
532Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1216Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
533pass characters instead of octets, you should convert your strings first 1217pass characters instead of octets, you should convert your strings first
534to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1218to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
535</dd> 1219</dd>
536<p></p> 1220<p></p>
1221<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1222</dt>
1223<dd>
1224Replaces the event mask of the pty watcher by the given event mask. Can
1225be used to suppress input and output handling to the pty/tty. See the
1226description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1227the previous value.
1228</dd>
1229<p></p>
1230<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1231</dt>
1232<dd>
1233Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1234is used.
1235</dd>
1236<p></p>
1237<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1238</dt>
1239<dd>
1240Return the window id of the toplevel window.
1241</dd>
1242<p></p>
1243<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1244</dt>
1245<dd>
1246Return the window id of the terminal window.
1247</dd>
1248<p></p>
1249<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1250</dt>
1251<dd>
1252Adds the specified events to the vt event mask. Useful e.g. when you want
1253to receive pointer events all the times:
1254</dd>
1255<dd>
1256<pre>
1257 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1258</dd>
1259<p></p>
1260<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1261</dt>
1262<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1263</dt>
1264<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1265</dt>
1266<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1267</dt>
1268<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1269</dt>
537<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 1270<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
538</dt> 1271</dt>
539<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1272<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
540</dt> 1273</dt>
541<dd> 1274<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
542Return the number of rows/columns of the terminal window (i.e. as 1275</dt>
543specified by <code>-geometry</code>, excluding any scrollback). 1276<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1277</dt>
1278<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1279</dt>
1280<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1281</dt>
1282<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1283</dt>
544</dd> 1284<dd>
1285Return various integers describing terminal characteristics.
1286</dd>
545<p></p> 1287<p></p>
1288<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1289</dt>
1290<dd>
1291Return the DISPLAY used by rxvt-unicode.
1292</dd>
1293<p></p>
1294<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1295</dt>
1296<dd>
1297Returns the LC_CTYPE category string used by this rxvt-unicode.
1298</dd>
1299<p></p>
546<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1300<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
547</dt> 1301</dt>
1302<dd>
1303Returns a copy of the environment in effect for the terminal as a hashref
1304similar to <code>\%ENV</code>.
548<dd> 1305</dd>
549Returns the number of lines in the scrollback buffer. 1306<p></p>
1307<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1308</dt>
1309<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1310</dt>
1311<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1312</dt>
1313<dd>
1314Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1315AltGr), the meta key (often Alt) and the num lock key, if applicable.
1316</dd>
1317<p></p>
1318<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1319</dt>
1320<dd>
1321Returns the currently displayed screen (0 primary, 1 secondary).
1322</dd>
1323<p></p>
1324<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1325</dt>
1326<dd>
1327Returns wether the cursor is currently hidden or not.
550</dd> 1328</dd>
551<p></p> 1329<p></p>
552<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1330<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
553</dt> 1331</dt>
554<dd> 1332<dd>
555Returns the negative row number of the topmost line. Minimum value is 1333Returns the row number of the topmost displayed line. Maximum value is
556<code>0</code>, which displays the normal terminal contents. Larger values scroll 1334<code>0</code>, which displays the normal terminal contents. Lower values scroll
557this many lines into the scrollback buffer. 1335this many lines into the scrollback buffer.
558</dd> 1336</dd>
559<p></p> 1337<p></p>
560<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1338<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
561</dt> 1339</dt>
… …
572</dt> 1350</dt>
573<dd> 1351<dd>
574Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1352Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
575is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1353is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
576terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1354terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
577line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1355line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
578is requested. 1356is requested.
579</dd> 1357</dd>
580<dd> 1358<dd>
581<p>If <code>$new_text</code> is specified, it will replace characters in the current 1359<p>If <code>$new_text</code> is specified, it will replace characters in the current
582line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1360line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
583to replace only parts of a line. The font index in the rendition will 1361to replace only parts of a line. The font index in the rendition will
584automatically be updated.</p> 1362automatically be updated.</p>
585</dd> 1363</dd>
586<dd> 1364<dd>
587<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1365<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
588than one cell when displayed are padded with urxvt::NOCHAR characters 1366than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
589(<code>chr 65535</code>). Characters with combining characters and other characters 1367characters. Characters with combining characters and other characters that
590that do not fit into the normal tetx encoding will be replaced with 1368do not fit into the normal tetx encoding will be replaced with characters
591characters in the private use area.</p> 1369in the private use area.</p>
592</dd> 1370</dd>
593<dd> 1371<dd>
594<p>You have to obey this encoding when changing text. The advantage is 1372<p>You have to obey this encoding when changing text. The advantage is
595that <code>substr</code> and similar functions work on screen cells and not on 1373that <code>substr</code> and similar functions work on screen cells and not on
596characters.</p> 1374characters.</p>
597</dd> 1375</dd>
598<dd> 1376<dd>
599<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1377<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>
600can be used to convert normal strings into this encoding and vice versa.</p> 1378can be used to convert normal strings into this encoding and vice versa.</p>
601</dd> 1379</dd>
602<p></p> 1380<p></p>
603<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1381<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
604</dt> 1382</dt>
… …
637Create and return a new <code>urxvt::line</code> object that stores information 1415Create and return a new <code>urxvt::line</code> object that stores information
638about the logical line that row <code>$row_number</code> is part of. It supports the 1416about the logical line that row <code>$row_number</code> is part of. It supports the
639following methods: 1417following methods:
640</dd> 1418</dd>
641<dl> 1419<dl>
642<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 1420<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
643</dt> 1421</dt>
644<dd> 1422<dd>
645Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1423Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
646</dd> 1424</dd>
647<p></p> 1425<p></p>
648<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 1426<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
649</dt> 1427</dt>
650<dd> 1428<dd>
651Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1429Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
652</dd> 1430</dd>
653<p></p> 1431<p></p>
654<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1432<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
655</dt> 1433</dt>
656<dd> 1434<dd>
… …
667<p></p> 1445<p></p>
668<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1446<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
669</dt> 1447</dt>
670<dd> 1448<dd>
671Returns the character offset of the given row|col pair within the logical 1449Returns the character offset of the given row|col pair within the logical
672line. 1450line. Works for rows outside the line, too, and returns corresponding
1451offsets outside the string.
673</dd> 1452</dd>
674<p></p> 1453<p></p>
675<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1454<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
676</dt> 1455</dt>
677<dd> 1456<dd>
678Translates a string offset into terminal coordinates again. 1457Translates a string offset into terminal coordinates again.
679</dd> 1458</dd>
680<p></p></dl> 1459<p></p></dl>
681<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1460<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
682=item $text = $term-&gt;special_encode $string</strong><br />
683</dt> 1461</dt>
684<dd> 1462<dd>
685Converts a perl string into the special encoding used by rxvt-unicode, 1463Converts a perl string into the special encoding used by rxvt-unicode,
686where one character corresponds to one screen cell. See 1464where one character corresponds to one screen cell. See
687<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1465<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
690<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1468<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
691</dt> 1469</dt>
692<dd> 1470<dd>
693Converts rxvt-unicodes text reprsentation into a perl string. See 1471Converts rxvt-unicodes text reprsentation into a perl string. See
694<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1472<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1473</dd>
1474<p></p>
1475<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1476</dt>
1477<dd>
1478Registers a synchronous button grab. See the XGrabButton manpage.
1479</dd>
1480<p></p>
1481<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1482</dt>
1483<dd>
1484Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1485synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1486</dd>
1487<p></p>
1488<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1489</dt>
1490<dd>
1491Calls XAllowEvents with AsyncBoth for the most recent grab.
1492</dd>
1493<p></p>
1494<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1495</dt>
1496<dd>
1497Calls XAllowEvents with SyncBoth for the most recent grab.
1498</dd>
1499<p></p>
1500<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1501</dt>
1502<dd>
1503Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1504recent grab.
1505</dd>
1506<p></p>
1507<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1508</dt>
1509<dd>
1510Calls XUngrab for the most recent grab. Is called automatically on
1511evaluation errors, as it is better to lose the grab in the error case as
1512the session.
1513</dd>
1514<p></p>
1515<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1516</dt>
1517<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1518</dt>
1519<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1520</dt>
1521<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1522</dt>
1523<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1524</dt>
1525<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1526</dt>
1527<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1528</dt>
1529<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1530</dt>
1531<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1532</dt>
1533<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1534</dt>
1535<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1536</dt>
1537<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1538</dt>
1539<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1540</dt>
1541<dd>
1542Various X or X-related functions. The <code>$term</code> object only serves as
1543the source of the display, otherwise those functions map more-or-less
1544directory onto the X functions of the same name.
1545</dd>
1546<p></p></dl>
1547<p>
1548</p>
1549<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1550<dl>
1551<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1552</dt>
1553<dd>
1554Adds a non-clickable title to the popup.
1555</dd>
1556<p></p>
1557<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1558</dt>
1559<dd>
1560Creates a separator, optionally using the character given as <code>$sepchr</code>.
1561</dd>
1562<p></p>
1563<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1564</dt>
1565<dd>
1566Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1567selected.
1568</dd>
1569<p></p>
1570<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1571</dt>
1572<dd>
1573Adds a toggle/checkbox item to the popup. Teh callback gets called
1574whenever it gets toggled, with a boolean indicating its value as its first
1575argument.
1576</dd>
1577<p></p>
1578<dt><strong>$popup-&gt;show</strong><br />
1579</dt>
1580<dd>
1581Displays the popup (which is initially hidden).
695</dd> 1582</dd>
696<p></p></dl> 1583<p></p></dl>
697<p> 1584<p>
698</p> 1585</p>
699<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1586<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
752</dt> 1639</dt>
753<dd> 1640<dd>
754Set the event trigger time to <code>$tstamp</code> and start the timer. 1641Set the event trigger time to <code>$tstamp</code> and start the timer.
755</dd> 1642</dd>
756<p></p> 1643<p></p>
1644<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1645</dt>
1646<dd>
1647Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1648</dd>
1649<p></p>
757<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1650<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
758</dt> 1651</dt>
759<dd> 1652<dd>
760Stop the timer. 1653Stop the timer.
761</dd> 1654</dd>
… …
767<pre> 1660<pre>
768 $term-&gt;{socket} = ... 1661 $term-&gt;{socket} = ...
769 $term-&gt;{iow} = urxvt::iow 1662 $term-&gt;{iow} = urxvt::iow
770 -&gt;new 1663 -&gt;new
771 -&gt;fd (fileno $term-&gt;{socket}) 1664 -&gt;fd (fileno $term-&gt;{socket})
772 -&gt;events (1) # wait for read data 1665 -&gt;events (urxvt::EVENT_READ)
773 -&gt;start 1666 -&gt;start
774 -&gt;cb (sub { 1667 -&gt;cb (sub {
775 my ($iow, $revents) = @_; 1668 my ($iow, $revents) = @_;
776 # $revents must be 1 here, no need to check 1669 # $revents must be 1 here, no need to check
777 sysread $term-&gt;{socket}, my $buf, 8192 1670 sysread $term-&gt;{socket}, my $buf, 8192
… …
798</dd> 1691</dd>
799<p></p> 1692<p></p>
800<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1693<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
801</dt> 1694</dt>
802<dd> 1695<dd>
803Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1696Set the event mask to watch. The only allowed values are
804data, Bit #1 (value <code>2</code>) enables watching for write data. 1697<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1698together, or <code>urxvt::EVENT_NONE</code>.
805</dd> 1699</dd>
806<p></p> 1700<p></p>
807<dt><strong>$iow = $iow-&gt;start</strong><br /> 1701<dt><strong>$iow = $iow-&gt;start</strong><br />
808</dt> 1702</dt>
809<dd> 1703<dd>
… …
812<p></p> 1706<p></p>
813<dt><strong>$iow = $iow-&gt;stop</strong><br /> 1707<dt><strong>$iow = $iow-&gt;stop</strong><br />
814</dt> 1708</dt>
815<dd> 1709<dd>
816Stop watching for events on the given filehandle. 1710Stop watching for events on the given filehandle.
1711</dd>
1712<p></p></dl>
1713<p>
1714</p>
1715<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1716<p>This class implements idle watchers, that get called automatically when
1717the process is idle. They should return as fast as possible, after doing
1718some useful work.</p>
1719<dl>
1720<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1721</dt>
1722<dd>
1723Create a new idle watcher object in stopped state.
1724</dd>
1725<p></p>
1726<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1727</dt>
1728<dd>
1729Set the callback to be called when the watcher triggers.
1730</dd>
1731<p></p>
1732<dt><strong>$timer = $timer-&gt;start</strong><br />
1733</dt>
1734<dd>
1735Start the watcher.
1736</dd>
1737<p></p>
1738<dt><strong>$timer = $timer-&gt;stop</strong><br />
1739</dt>
1740<dd>
1741Stop the watcher.
1742</dd>
1743<p></p></dl>
1744<p>
1745</p>
1746<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1747<p>This class implements process watchers. They create an event whenever a
1748process exits, after which they stop automatically.</p>
1749<pre>
1750 my $pid = fork;
1751 ...
1752 $term-&gt;{pw} = urxvt::pw
1753 -&gt;new
1754 -&gt;start ($pid)
1755 -&gt;cb (sub {
1756 my ($pw, $exit_status) = @_;
1757 ...
1758 });</pre>
1759<dl>
1760<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1761</dt>
1762<dd>
1763Create a new process watcher in stopped state.
1764</dd>
1765<p></p>
1766<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1767</dt>
1768<dd>
1769Set the callback to be called when the timer triggers.
1770</dd>
1771<p></p>
1772<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1773</dt>
1774<dd>
1775Tells the wqtcher to start watching for process <code>$pid</code>.
1776</dd>
1777<p></p>
1778<dt><strong>$pw = $pw-&gt;stop</strong><br />
1779</dt>
1780<dd>
1781Stop the watcher.
817</dd> 1782</dd>
818<p></p></dl> 1783<p></p></dl>
819<p> 1784<p>
820</p> 1785</p>
821<hr /> 1786<hr />
… …
824</p> 1789</p>
825<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1790<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
826<p>This variable controls the verbosity level of the perl extension. Higher 1791<p>This variable controls the verbosity level of the perl extension. Higher
827numbers indicate more verbose output.</p> 1792numbers indicate more verbose output.</p>
828<dl> 1793<dl>
829<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1794<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
830</dt> 1795</dt>
831<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1796<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
832</dt> 1797</dt>
833<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1798<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1799</dt>
1800<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
834</dt> 1801</dt>
835</dl> 1802</dl>
836<p> 1803<p>
837</p> 1804</p>
838<hr /> 1805<hr />

Diff Legend

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