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.1 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.40 by root, Sun Jan 29 21:45:47 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
22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
20 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
21 <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>
27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
22 <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>
23 <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>
24 <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>
35 </ul>
36
37 <li><a href="#environment">ENVIRONMENT</a></li>
38 <ul>
39
40 <li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li>
25 </ul> 41 </ul>
26 42
27 <li><a href="#author">AUTHOR</a></li> 43 <li><a href="#author">AUTHOR</a></li>
28</ul> 44</ul>
29<!-- INDEX END --> 45<!-- INDEX END -->
30 46
31<hr /> 47<hr />
32<p> 48<p>
33</p> 49</p>
50<hr />
34<h1><a name="name">NAME</a></h1> 51<h1><a name="name">NAME</a></h1>
35<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
36<p> 53<p>
37</p> 54</p>
38<hr /> 55<hr />
39<h1><a name="synopsis">SYNOPSIS</a></h1> 56<h1><a name="synopsis">SYNOPSIS</a></h1>
40<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 57<pre>
41<p>* Each script will only be loaded once, even in urxvtd, and will be valid 58 # create a file grab_test in $HOME:</pre>
42globally.</p>
43<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
44thus must be encoded as UTF-8.</p>
45<pre> 59<pre>
46 sub on_sel_grab { 60 sub on_sel_grab {
47 warn &quot;you selected &quot;, $_[0]-&gt;selection; 61 warn &quot;you selected &quot;, $_[0]-&gt;selection;
48 () 62 ()
49 }</pre> 63 }</pre>
50<pre> 64<pre>
51 1</pre> 65 # start a rxvt using it:</pre>
66<pre>
67 rxvt --perl-lib $HOME -pe grab_test</pre>
52<p> 68<p>
53</p> 69</p>
54<hr /> 70<hr />
55<h1><a name="description">DESCRIPTION</a></h1> 71<h1><a name="description">DESCRIPTION</a></h1>
72<p>Everytime a terminal object gets created, extension scripts specified via
73the <code>perl</code> resource are loaded and associated with it.</p>
74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
75thus must be encoded as UTF-8.</p>
76<p>Each script will only ever be loaded once, even in rxvtd, where
77scripts will be shared (but not enabled) for all terminals.</p>
78<p>
79</p>
80<hr />
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
82<p>This section describes the extensions delivered with this release. You can
83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
84<p>You can activate them like this:</p>
85<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>
90<dl>
91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
92</dt>
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>.
99</dd>
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>
141</dd>
142<dl>
143<dt><strong><a name="item_rot13">rot13</a></strong><br />
144</dt>
145<dd>
146Rot-13 the selection when activated. Used via keyboard trigger:
147</dd>
148<dd>
149<pre>
150 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
151</dd>
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>
345<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
346</dt>
347<dd>
348Displays a digital clock using the built-in overlay.
349</dd>
350<p></p>
351<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
352</dt>
353<dd>
354Somewhat of a misnomer, this extension adds two menu entries to the
355selection popup that allows one ti run external commands to store the
356selection somewhere and fetch it again.
357</dd>
358<dd>
359<p>We use it to implement a ``distributed selection mechanism'', which just
360means that one command uploads the file to a remote server, and another
361reads it.</p>
362</dd>
363<dd>
364<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
365<code>URxvt.remote-selection.fetch</code> resources. The first should read the
366selection to store from STDIN (always in UTF-8), the second should provide
367the selection data on STDOUT (also in UTF-8).</p>
368</dd>
369<dd>
370<p>The defaults (which are likely useless to you) use rsh and cat:</p>
371</dd>
372<dd>
373<pre>
374 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
375 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
376</dd>
377<p></p>
378<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
379</dt>
380<dd>
381This is a little rarely useful extension that Uploads the selection as
382textfile to a remote site (or does other things). (The implementation is
383not currently secure for use in a multiuser environment as it writes to
384<em>/tmp</em> directly.).
385</dd>
386<dd>
387<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
388i.e.</p>
389</dd>
390<dd>
391<pre>
392 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
393</dd>
394<dd>
395<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
396the textfile. This command can be set via a resource:</p>
397</dd>
398<dd>
399<pre>
400 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
401</dd>
402<dd>
403<p>And the default is likely not useful to anybody but the few people around
404here :)</p>
405</dd>
406<dd>
407<p>The name of the textfile is the hex encoded md5 sum of the selection, so
408the same content should lead to the same filename.</p>
409</dd>
410<dd>
411<p>After a successful upload the selection will be replaced by the text given
412in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
413for the filename):</p>
414</dd>
415<dd>
416<pre>
417 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
418</dd>
419<p></p>
420<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
421</dt>
422<dd>
423Displays a very simple digital clock in the upper right corner of the
424window. Illustrates overwriting the refresh callbacks to create your own
425overlays or changes.
426</dd>
427<p></p></dl>
428<p>
429</p>
430<hr />
431<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
432<p>
433</p>
434<h2><a name="general_api_considerations">General API Considerations</a></h2>
435<p>All objects (such as terminals, time watchers etc.) are typical
436reference-to-hash objects. The hash can be used to store anything you
437like. All members starting with an underscore (such as <code>_ptr</code> or
438<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
439modified).</p>
440<p>When objects are destroyed on the C++ side, the perl object hashes are
441emptied, so its best to store related objects such as time watchers and
442the like inside the terminal object so they get destroyed as soon as the
443terminal is destroyed.</p>
444<p>Argument names also often indicate the type of a parameter. Here are some
445hints on what they mean:</p>
446<dl>
447<dt><strong><a name="item__24text">$text</a></strong><br />
448</dt>
449<dd>
450Rxvt-unicodes special way of encoding text, where one ``unicode'' character
451always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
452</dd>
453<p></p>
454<dt><strong><a name="item__24string">$string</a></strong><br />
455</dt>
456<dd>
457A perl text string, with an emphasis on <em>text</em>. It can store all unicode
458characters and is to be distinguished with text encoded in a specific
459encoding (often locale-specific) and binary data.
460</dd>
461<p></p>
462<dt><strong><a name="item__24octets">$octets</a></strong><br />
463</dt>
464<dd>
465Either binary data or - more common - a text string encoded in a
466locale-specific way.
467</dd>
468<p></p></dl>
469<p>
470</p>
471<h2><a name="extension_objects">Extension Objects</a></h2>
472<p>Very perl extension is a perl class. A separate perl object is created
473for each terminal and each extension and passed as the first parameter to
474hooks. So extensions can use their <code>$self</code> object without having to think
475about other extensions, with the exception of methods and members that
476begin with an underscore character <code>_</code>: these are reserved for internal
477use.</p>
478<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
479<code>urxvt::term</code> class on this object.</p>
480<p>It has the following methods and data members:</p>
481<dl>
482<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
483</dt>
484<dd>
485Returns the <code>urxvt::term</code> object associated with this instance of the
486extension. This member <em>must not</em> be changed in any way.
487</dd>
488<p></p>
489<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
490</dt>
491<dd>
492Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
493this extension, replacing any previous hook. This is useful when you want
494to overwrite time-critical hooks only temporarily.
495</dd>
496<p></p>
497<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
498</dt>
499<dd>
500Dynamically disable the given hooks.
501</dd>
502<p></p></dl>
56<p> 503<p>
57</p> 504</p>
58<h2><a name="hooks">Hooks</a></h2> 505<h2><a name="hooks">Hooks</a></h2>
59<p>The following subroutines can be declared in loaded scripts, and will be called 506<p>The following subroutines can be declared in extension files, and will be
60whenever the relevant event happens.</p> 507called whenever the relevant event happens.</p>
61<p>All of them must return a boolean value. If it is true, then the event 508<p>The first argument passed to them is an extension oject as described in
62counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 509the in the <code>Extension Objects</code> section.</p>
510<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
511hooks returns true, then the event counts as being <em>consumed</em>, and the
63and the relevant action might not be carried out by the C++ code.</p> 512relevant action might not be carried out by the C++ code.</p>
64<p>When in doubt, return a false value (preferably <code>()</code>).</p> 513<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
65<dl> 514<dl>
66<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 515<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
67</dt> 516</dt>
68<dd> 517<dd>
69Called after a new terminal object has been initialized, but before 518Called after a new terminal object has been initialized, but before
70windows are created or the command gets run. 519windows are created or the command gets run. Most methods are unsafe to
520call or deliver senseless data, as terminal size and other characteristics
521have not yet been determined. You can safely query and change resources
522and options, though. For many purposes the <code>on_start</code> hook is a better
523place.
524</dd>
525<p></p>
526<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
527</dt>
528<dd>
529Called at the very end of initialisation of a new terminal, just before
530trying to map (display) the toplevel and returning to the mainloop.
531</dd>
532<p></p>
533<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
534</dt>
535<dd>
536Called whenever something tries to destroy terminal, when the terminal is
537still fully functional (not for long, though).
71</dd> 538</dd>
72<p></p> 539<p></p>
73<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 540<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
74</dt> 541</dt>
75<dd> 542<dd>
76Called after the screen is ``reset'' for any reason, such as resizing or 543Called after the screen is ``reset'' for any reason, such as resizing or
77control sequences. Here is where you can react on changes to size-related 544control sequences. Here is where you can react on changes to size-related
78variables. 545variables.
79</dd> 546</dd>
80<p></p> 547<p></p>
81<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> 548<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
82</dt> 549</dt>
550<dd>
551Called just after the child process has been <code>fork</code>ed.
83<dd> 552</dd>
84Called at the very end of initialisation of a new terminal, just before 553<p></p>
85returning to the mainloop. 554<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
555</dt>
556<dd>
557Called just after the child process has exited. <code>$status</code> is the status
558from <code>waitpid</code>.
86</dd> 559</dd>
87<p></p> 560<p></p>
88<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 561<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
89</dt> 562</dt>
90<dd> 563<dd>
… …
106</dd> 579</dd>
107<dd> 580<dd>
108<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 581<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
109</dd> 582</dd>
110<p></p> 583<p></p>
111<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 584<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
112</dt> 585</dt>
113<dd>
114Called whenever the window gets the keyboard focus, before urxvt does
115focus in processing.
116</dd> 586<dd>
117<p></p> 587Called whenever the user tries to extend the selection (e.g. with a double
118<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 588click) and is either supposed to return false (normal operation), or
119</dt> 589should extend the selection itelf and return true to suppress the built-in
590processing. This can happen multiple times, as long as the callback
591returns true, it will be called on every further click by the user and is
592supposed to enlarge the selection more and more, if possible.
120<dd> 593</dd>
121Called wheneever the window loses keyboard focus, before urxvt does focus 594<dd>
122out processing. 595<p>See the <em>selection</em> example extension.</p>
123</dd> 596</dd>
124<p></p> 597<p></p>
125<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 598<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
126</dt> 599</dt>
127<dd> 600<dd>
… …
141<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 614<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
142$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 615$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
143number of lines that will be in the scrollback buffer.</p> 616number of lines that will be in the scrollback buffer.</p>
144</dd> 617</dd>
145<p></p> 618<p></p>
146<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 619<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
147</dt> 620</dt>
621<dd>
622Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
623operating system command) is processed. Cursor position and other state
624information is up-to-date when this happens. For interoperability, the
625string should start with the extension name and a colon, to distinguish
626it from commands for other extensions, and this might be enforced in the
627future.
148<dd> 628</dd>
149Called whenever the <code>program(s)</code> running in the urxvt window send output. 629<dd>
630<p>Be careful not ever to trust (in a security sense) the data you receive,
631as its source can not easily be controleld (e-mail content, messages from
632other users on the same system etc.).</p>
633</dd>
634<p></p>
635<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
636</dt>
637<dd>
638Called whenever text is about to be output, with the text as argument. You
639can filter/change and output the text yourself by returning a true value
640and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
641might be very slow, however, as your hook is called for <strong>all</strong> text being
642output.
643</dd>
644<p></p>
645<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
646</dt>
647<dd>
648Called whenever some data is written to the tty/pty and can be used to
649suppress or filter tty input.
650</dd>
651<p></p>
652<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
653</dt>
654<dd>
655Called whenever a line was updated or changed. Can be used to filter
656screen output (e.g. underline urls or other useless stuff). Only lines
657that are being shown will be filtered, and, due to performance reasons,
658not always immediately.
659</dd>
660<dd>
661<p>The row number is always the topmost row of the line if the line spans
662multiple rows.</p>
663</dd>
664<dd>
665<p>Please note that, if you change the line, then the hook might get called
666later with the already-modified line (e.g. if unrelated parts change), so
667you cannot just toggle rendition bits, but only set them.</p>
150</dd> 668</dd>
151<p></p> 669<p></p>
152<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 670<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
153</dt> 671</dt>
154<dd> 672<dd>
… …
161<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 679<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
162</dt> 680</dt>
163<dd> 681<dd>
164Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 682Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
165</dd> 683</dd>
684<p></p>
685<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
686</dt>
687<dd>
688Called whenever the a user-configured event is being activated (e.g. via
689a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
690resource in the <code>rxvt(1)</code> manpage).
691</dd>
692<dd>
693<p>The event is simply the action string. This interface is assumed to change
694slightly in the future.</p>
695</dd>
696<p></p>
697<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
698</dt>
699<dd>
700Called on every X event received on the vt window (and possibly other
701windows). Should only be used as a last resort. Most event structure
702members are not passed.
703</dd>
704<p></p>
705<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
706</dt>
707<dd>
708Called whenever the window gets the keyboard focus, before rxvt-unicode
709does focus in processing.
710</dd>
711<p></p>
712<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
713</dt>
714<dd>
715Called wheneever the window loses keyboard focus, before rxvt-unicode does
716focus out processing.
717</dd>
718<p></p>
719<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
720</dt>
721<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
722</dt>
723<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
724</dt>
725<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
726</dt>
727<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
728</dt>
729<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
730</dt>
731<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
732</dt>
733<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
734</dt>
735<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
736</dt>
737<dd>
738Called whenever the corresponding X event is received for the terminal If
739the hook returns true, then the even will be ignored by rxvt-unicode.
740</dd>
741<dd>
742<p>The event is a hash with most values as named by Xlib (see the XEvent
743manpage), with the additional members <code>row</code> and <code>col</code>, which are the
744(real, not screen-based) row and column under the mouse cursor.</p>
745</dd>
746<dd>
747<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
748output, if any, in locale-specific encoding.</p>
749</dd>
750<dd>
751<p>subwindow.</p>
752</dd>
753<p></p>
754<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br />
755</dt>
756<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
757</dt>
758<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
759</dt>
760<dd>
761Called when various types of ClientMessage events are received (all with
762format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
763</dd>
764<p></p></dl>
765<p>
766</p>
767<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
768<dl>
769<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
770</dt>
771<dd>
772The rxvt-unicode library directory, where, among other things, the perl
773modules and scripts are stored.
774</dd>
775<p></p>
776<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
777</dt>
778<dd>
779The resource class and name rxvt-unicode uses to look up X resources.
780</dd>
781<p></p>
782<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
783</dt>
784<dd>
785The basename of the installed binaries, usually <code>urxvt</code>.
786</dd>
787<p></p>
788<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
789</dt>
790<dd>
791The current terminal. This variable stores the current <code>urxvt::term</code>
792object, whenever a callback/hook is executing.
793</dd>
794<p></p>
795<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
796</dt>
797<dd>
798All coderefs in this array will be called as methods of the next newly
799created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
800gets cleared before the codereferences that were in it are being executed,
801so coderefs can push themselves onto it again if they so desire.
802</dd>
803<dd>
804<p>This complements to the perl-eval commandline option, but gets executed
805first.</p>
806</dd>
807<p></p>
808<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
809</dt>
810<dd>
811Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
812get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
813but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.
814</dd>
166<p></p></dl> 815<p></p></dl>
167<p> 816<p>
168</p> 817</p>
169<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 818<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
170<dl> 819<dl>
… …
177</dd> 826</dd>
178<p></p> 827<p></p>
179<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> 828<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
180</dt> 829</dt>
181<dd> 830<dd>
182Calls <code>rxvt_warn</code> witht eh given string which should not include a 831Calls <code>rxvt_warn</code> with the given string which should not include a
183newline. The module also overwrites the <code>warn</code> builtin with a function 832newline. The module also overwrites the <code>warn</code> builtin with a function
184that calls this function. 833that calls this function.
185</dd> 834</dd>
186<dd> 835<dd>
187<p>Using this function has the advantage that its output ends up in the 836<p>Using this function has the advantage that its output ends up in the
188correct place, e.g. on stderr of the connecting urxvtc client.</p> 837correct place, e.g. on stderr of the connecting urxvtc client.</p>
189</dd> 838</dd>
839<dd>
840<p>Messages have a size limit of 1023 bytes currently.</p>
841</dd>
190<p></p> 842<p></p>
191<dt><strong><a name="item__24cellwidth__3d_urxvt_3a_3awcswidth__24string">$cellwidth = urxvt::wcswidth $string</a></strong><br /> 843<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
844</dt>
845<dd>
846Returns all urxvt::term objects that exist in this process, regardless of
847wether they are started, being destroyed etc., so be careful. Only term
848objects that have perl extensions attached will be returned (because there
849is no urxvt::term objet associated with others).
850</dd>
851<p></p>
852<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
853</dt>
854<dd>
855Returns the ``current time'' (as per the event loop).
856</dd>
857<p></p>
858<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
859</dt>
860<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
861Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
862Button4Mask, Button5Mask, AnyModifier</a></strong><br />
863</dt>
864<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
865ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
866PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
867Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
868KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
869ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
870FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
871</dt>
872<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
873EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
874GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
875UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
876ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
877CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
878SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
879</dt>
880<dd>
881Various constants for use in X calls and event processing.
882</dd>
883<p></p></dl>
884<p>
885</p>
886<h2><a name="rendition">RENDITION</a></h2>
887<p>Rendition bitsets contain information about colour, font, font styles and
888similar information for each screen cell.</p>
889<p>The following ``macros'' deal with changes in rendition sets. You should
890never just create a bitset, you should always modify an existing one,
891as they contain important information required for correct operation of
892rxvt-unicode.</p>
893<dl>
894<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
895</dt>
896<dd>
897Returns the default rendition, as used when the terminal is starting up or
898being reset. Useful as a base to start when creating renditions.
899</dd>
900<p></p>
901<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
902</dt>
903<dd>
904Return the rendition mask used for overlays by default.
905</dd>
906<p></p>
907<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
908</dt>
909<dd>
910Return the bit that enabled bold, italic, blink, reverse-video and
911underline, respectively. To enable such a style, just logically OR it into
912the bitset.
913</dd>
914<p></p>
915<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
916</dt>
917<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
918</dt>
919<dd>
920Return the foreground/background colour index, respectively.
921</dd>
922<p></p>
923<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
924</dt>
925<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
926</dt>
927<dd>
928Replace the foreground/background colour in the rendition mask with the
929specified one.
930</dd>
931<p></p>
932<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
933</dt>
934<dd>
935Return the ``custom'' value: Every rendition has 5 bits for use by
936extensions. They can be set and changed as you like and are initially
937zero.
938</dd>
939<p></p>
940<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
941</dt>
942<dd>
943Change the custom value.
944</dd>
945<p></p></dl>
946<p>
947</p>
948<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
949<p>The sole purpose of this class is to deliver an interface to the
950<code>AnyEvent</code> module - any module using it will work inside urxvt without
951further programming. The only exception is that you cannot wait on
952condition variables, but non-blocking condvar use is ok. What this means
953is that you cannot use blocking APIs, but the non-blocking variant should
954work.</p>
955<p>
956</p>
957<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
958<dl>
959<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
960</dt>
961<dd>
962Creates a new terminal, very similar as if you had started it with system
963<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
964hash which defines the environment of the new terminal.
965</dd>
966<dd>
967<p>Croaks (and probably outputs an error message) if the new instance
968couldn't be created. Returns <code>undef</code> if the new instance didn't
969initialise perl, and the terminal object otherwise. The <code>init</code> and
970<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
971refer to global data (which is race free).</p>
972</dd>
973<p></p>
974<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
975</dt>
976<dd>
977Destroy the terminal object (close the window, free resources
978etc.). Please note that rxvt will not exit as long as any event
979watchers (timers, io watchers) are still active.
980</dd>
981<p></p>
982<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
983</dt>
984<dd>
985Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
986(``starts'') programs in the background. This function takes care of setting
987the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
988be preferred over explicit calls to <code>exec</code> or <code>system</code>.
989</dd>
990<dd>
991<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
992</dd>
993<p></p>
994<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
995</dt>
996<dd>
997Returns true if the option specified by <code>$optval</code> is enabled, and
998optionally change it. All option values are stored by name in the hash
999<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
1000</dd>
1001<dd>
1002<p>Here is a a likely non-exhaustive list of option names, please see the
1003source file <em>/src/optinc.h</em> to see the actual list:</p>
1004</dd>
1005<dd>
1006<pre>
1007 borderLess console cursorBlink cursorUnderline hold iconic insecure
1008 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1009 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1010 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1011 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1012 transparent tripleclickwords utmpInhibit visualBell</pre>
1013</dd>
1014<p></p>
1015<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
1016</dt>
1017<dd>
1018Returns the current resource value associated with a given name and
1019optionally sets a new value. Setting values is most useful in the <code>init</code>
1020hook. Unset resources are returned and accepted as <code>undef</code>.
1021</dd>
1022<dd>
1023<p>The new value must be properly encoded to a suitable character encoding
1024before passing it to this method. Similarly, the returned value may need
1025to be converted from the used encoding to text.</p>
1026</dd>
1027<dd>
1028<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
1029as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
1030likely change).</p>
1031</dd>
1032<dd>
1033<p>Please note that resource strings will currently only be freed when the
1034terminal is destroyed, so changing options frequently will eat memory.</p>
1035</dd>
1036<dd>
1037<p>Here is a a likely non-exhaustive list of resource names, not all of which
1038are supported in every build, please see the source file <em>/src/rsinc.h</em>
1039to see the actual list:</p>
1040</dd>
1041<dd>
1042<pre>
1043 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1044 borderLess color cursorBlink cursorUnderline cutchars delete_key
1045 display_name embed ext_bwidth fade font geometry hold iconName
1046 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1047 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1048 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1049 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1050 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1051 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1052 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1053 secondaryScreen secondaryScroll selectstyle shade term_name title
1054 transient_for transparent transparent_all tripleclickwords utmpInhibit
1055 visualBell</pre>
1056</dd>
1057<p></p>
1058<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1059</dt>
1060<dd>
1061Returns the X-Resource for the given pattern, excluding the program or
1062class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
1063same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1064resource with that pattern exists.
1065</dd>
1066<dd>
1067<p>This method should only be called during the <code>on_start</code> hook, as there is
1068only one resource database per display, and later invocations might return
1069the wrong resources.</p>
1070</dd>
1071<p></p>
1072<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1073</dt>
1074<dd>
1075Adds a keymap translation exactly as specified via a resource. See the
1076<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
1077</dd>
1078<p></p>
1079<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1080</dt>
1081<dd>
1082Return and optionally change the current rendition. Text that is output by
1083the terminal application will use this style.
1084</dd>
1085<p></p>
1086<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1087</dt>
1088<dd>
1089Return the current coordinates of the text cursor position and optionally
1090set it (which is usually bad as applications don't expect that).
1091</dd>
1092<p></p>
1093<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
1094</dt>
1095<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
1096</dt>
1097<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
1098</dt>
1099<dd>
1100Return the current values of the selection mark, begin or end positions,
1101and optionally set them to new values.
1102</dd>
1103<p></p>
1104<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1105</dt>
1106<dd>
1107Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
1108<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
1109rectangular selection will be made. This is the prefered function to make
1110a selection.
1111</dd>
1112<p></p>
1113<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
1114</dt>
1115<dd>
1116Try to request the primary selection text from the server (for example, as
1117set by the next method). No visual feedback will be given. This function
1118is mostly useful from within <code>on_sel_grab</code> hooks.
1119</dd>
1120<p></p>
1121<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
1122</dt>
1123<dd>
1124Return the current selection text and optionally replace it by <code>$newtext</code>.
1125</dd>
1126<p></p>
1127<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1128</dt>
1129<dd>
1130Create a simple multi-line overlay box. See the next method for details.
1131</dd>
1132<p></p>
1133<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
1134</dt>
1135<dd>
1136Create a new (empty) overlay at the given position with the given
1137width/height. <code>$rstyle</code> defines the initial rendition style
1138(default: <code>OVERLAY_RSTYLE</code>).
1139</dd>
1140<dd>
1141<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
1142around the box.</p>
1143</dd>
1144<dd>
1145<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
1146right/bottom side, respectively.</p>
1147</dd>
1148<dd>
1149<p>This method returns an urxvt::overlay object. The overlay will be visible
1150as long as the perl object is referenced.</p>
1151</dd>
1152<dd>
1153<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
1154</dd>
1155<dl>
1156<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
1157</dt>
1158<dd>
1159Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
1160text in rxvt-unicode's special encoding and an array of rendition values
1161at a specific position inside the overlay.
1162</dd>
1163<p></p>
1164<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
1165</dt>
1166<dd>
1167If visible, hide the overlay, but do not destroy it.
1168</dd>
1169<p></p>
1170<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
1171</dt>
1172<dd>
1173If hidden, display the overlay again.
1174</dd>
1175<p></p></dl>
1176<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1177</dt>
1178<dd>
1179Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1180<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
1181currently).
1182</dd>
1183<p></p>
1184<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
192</dt> 1185</dt>
193<dd> 1186<dd>
194Returns the number of screen-cells this string would need. Correctly 1187Returns the number of screen-cells this string would need. Correctly
195accounts for wide and combining characters. 1188accounts for wide and combining characters.
196</dd> 1189</dd>
197<p></p> 1190<p></p>
198<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 1191<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
199</dt> 1192</dt>
1193<dd>
1194Convert the given text string into the corresponding locale encoding.
200<dd> 1195</dd>
201Returns the ``current time'' (as per the event loop). 1196<p></p>
1197<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
1198</dt>
1199<dd>
1200Convert the given locale-encoded octets into a perl string.
1201</dd>
1202<p></p>
1203<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 />
1204</dt>
1205<dd>
1206XORs the rendition values in the given span with the provided value
1207(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1208refresh hooks to provide effects similar to the selection.
1209</dd>
1210<p></p>
1211<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 />
1212</dt>
1213<dd>
1214Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1215whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1216to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1217it instead. Both styles <em>MUST NOT</em> contain font styles.
1218</dd>
1219<p></p>
1220<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1221</dt>
1222<dd>
1223Ring the bell!
1224</dd>
1225<p></p>
1226<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1227</dt>
1228<dd>
1229Write the given text string to the screen, as if output by the application
1230running inside the terminal. It may not contain command sequences (escape
1231codes), but is free to use line feeds, carriage returns and tabs. The
1232string is a normal text string, not in locale-dependent encoding.
1233</dd>
1234<dd>
1235<p>Normally its not a good idea to use this function, as programs might be
1236confused by changes in cursor position or scrolling. Its useful inside a
1237<code>on_add_lines</code> hook, though.</p>
1238</dd>
1239<p></p>
1240<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1241</dt>
1242<dd>
1243Switch to given screen - 0 primary, 1 secondary.
1244</dd>
1245<p></p>
1246<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1247</dt>
1248<dd>
1249Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1250locale-specific encoding of the terminal and can contain command sequences
1251(escape codes) that will be interpreted.
1252</dd>
1253<p></p>
1254<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
1255</dt>
1256<dd>
1257Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
1258pass characters instead of octets, you should convert your strings first
1259to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
1260</dd>
1261<p></p>
1262<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1263</dt>
1264<dd>
1265Replaces the event mask of the pty watcher by the given event mask. Can
1266be used to suppress input and output handling to the pty/tty. See the
1267description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1268the previous value.
1269</dd>
1270<p></p>
1271<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1272</dt>
1273<dd>
1274Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1275is used.
1276</dd>
1277<p></p>
1278<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1279</dt>
1280<dd>
1281Return the window id of the toplevel window.
1282</dd>
1283<p></p>
1284<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1285</dt>
1286<dd>
1287Return the window id of the terminal window.
1288</dd>
1289<p></p>
1290<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1291</dt>
1292<dd>
1293Adds the specified events to the vt event mask. Useful e.g. when you want
1294to receive pointer events all the times:
1295</dd>
1296<dd>
1297<pre>
1298 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1299</dd>
1300<p></p>
1301<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1302</dt>
1303<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1304</dt>
1305<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
1306</dt>
1307<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
1308</dt>
1309<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
1310</dt>
1311<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
1312</dt>
1313<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
1314</dt>
1315<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1316</dt>
1317<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1318</dt>
1319<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1320</dt>
1321<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1322</dt>
1323<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1324</dt>
1325<dd>
1326Return various integers describing terminal characteristics.
1327</dd>
1328<p></p>
1329<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1330</dt>
1331<dd>
1332Return the DISPLAY used by rxvt-unicode.
1333</dd>
1334<p></p>
1335<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1336</dt>
1337<dd>
1338Returns the LC_CTYPE category string used by this rxvt-unicode.
1339</dd>
1340<p></p>
1341<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1342</dt>
1343<dd>
1344Returns a copy of the environment in effect for the terminal as a hashref
1345similar to <code>\%ENV</code>.
1346</dd>
1347<p></p>
1348<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1349</dt>
1350<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1351</dt>
1352<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1353</dt>
1354<dd>
1355Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1356AltGr), the meta key (often Alt) and the num lock key, if applicable.
1357</dd>
1358<p></p>
1359<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1360</dt>
1361<dd>
1362Returns the currently displayed screen (0 primary, 1 secondary).
1363</dd>
1364<p></p>
1365<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1366</dt>
1367<dd>
1368Returns wether the cursor is currently hidden or not.
1369</dd>
1370<p></p>
1371<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1372</dt>
1373<dd>
1374Returns the row number of the topmost displayed line. Maximum value is
1375<code>0</code>, which displays the normal terminal contents. Lower values scroll
1376this many lines into the scrollback buffer.
1377</dd>
1378<p></p>
1379<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1380</dt>
1381<dd>
1382Requests a screen refresh. At the next opportunity, rxvt-unicode will
1383compare the on-screen display with its stored representation. If they
1384differ, it redraws the differences.
1385</dd>
1386<dd>
1387<p>Used after changing terminal contents to display them.</p>
1388</dd>
1389<p></p>
1390<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1391</dt>
1392<dd>
1393Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1394is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1395terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1396line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1397is requested.
1398</dd>
1399<dd>
1400<p>If <code>$new_text</code> is specified, it will replace characters in the current
1401line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1402to replace only parts of a line. The font index in the rendition will
1403automatically be updated.</p>
1404</dd>
1405<dd>
1406<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1407than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1408characters. Characters with combining characters and other characters that
1409do not fit into the normal tetx encoding will be replaced with characters
1410in the private use area.</p>
1411</dd>
1412<dd>
1413<p>You have to obey this encoding when changing text. The advantage is
1414that <code>substr</code> and similar functions work on screen cells and not on
1415characters.</p>
1416</dd>
1417<dd>
1418<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>
1419can be used to convert normal strings into this encoding and vice versa.</p>
1420</dd>
1421<p></p>
1422<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1423</dt>
1424<dd>
1425Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1426bitsets. Rendition bitsets contain information about colour, font, font
1427styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1428</dd>
1429<dd>
1430<p>When setting rendition, the font mask will be ignored.</p>
1431</dd>
1432<dd>
1433<p>See the section on RENDITION, above.</p>
1434</dd>
1435<p></p>
1436<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1437</dt>
1438<dd>
1439Returns the number of screen cells that are in use (``the line
1440length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1441line is joined with the following one.
1442</dd>
1443<p></p>
1444<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1445</dt>
1446<dd>
1447Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1448joined with the following row), which means all characters are in use
1449and it is continued on the next row (and possibly a continuation of the
1450previous row(s)).
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1454</dt>
1455<dd>
1456Create and return a new <code>urxvt::line</code> object that stores information
1457about the logical line that row <code>$row_number</code> is part of. It supports the
1458following methods:
1459</dd>
1460<dl>
1461<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1462</dt>
1463<dd>
1464Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1465</dd>
1466<p></p>
1467<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1468</dt>
1469<dd>
1470Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1471</dd>
1472<p></p>
1473<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1474</dt>
1475<dd>
1476Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1477</dd>
1478<p></p>
1479<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1480</dt>
1481<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1482</dt>
1483<dd>
1484Return the row number of the first/last row of the line, respectively.
1485</dd>
1486<p></p>
1487<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1488</dt>
1489<dd>
1490Returns the character offset of the given row|col pair within the logical
1491line. Works for rows outside the line, too, and returns corresponding
1492offsets outside the string.
1493</dd>
1494<p></p>
1495<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1496</dt>
1497<dd>
1498Translates a string offset into terminal coordinates again.
202</dd> 1499</dd>
203<p></p></dl> 1500<p></p></dl>
204<p> 1501<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1502</dt>
1503<dd>
1504Converts a perl string into the special encoding used by rxvt-unicode,
1505where one character corresponds to one screen cell. See
1506<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1507</dd>
1508<p></p>
1509<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1510</dt>
1511<dd>
1512Converts rxvt-unicodes text reprsentation into a perl string. See
1513<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1514</dd>
1515<p></p>
1516<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1517</dt>
1518<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1519</dt>
1520<dd>
1521Register/unregister a synchronous button grab. See the XGrabButton
1522manpage.
1523</dd>
1524<p></p>
1525<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1526</dt>
1527<dd>
1528Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1529synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1530</dd>
1531<p></p>
1532<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1533</dt>
1534<dd>
1535Calls XAllowEvents with AsyncBoth for the most recent grab.
1536</dd>
1537<p></p>
1538<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1539</dt>
1540<dd>
1541Calls XAllowEvents with SyncBoth for the most recent grab.
1542</dd>
1543<p></p>
1544<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1545</dt>
1546<dd>
1547Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1548recent grab.
1549</dd>
1550<p></p>
1551<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1552</dt>
1553<dd>
1554Calls XUngrab for the most recent grab. Is called automatically on
1555evaluation errors, as it is better to lose the grab in the error case as
1556the session.
1557</dd>
1558<p></p>
1559<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1560</dt>
1561<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1562</dt>
1563<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1564</dt>
1565<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1566</dt>
1567<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1568</dt>
1569<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1570</dt>
1571<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1572</dt>
1573<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1574</dt>
1575<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1576</dt>
1577<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1578</dt>
1579<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1580</dt>
1581<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1582</dt>
1583<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1584</dt>
1585<dd>
1586Various X or X-related functions. The <code>$term</code> object only serves as
1587the source of the display, otherwise those functions map more-or-less
1588directory onto the X functions of the same name.
1589</dd>
1590<p></p></dl>
205</p> 1591<p>
1592</p>
206<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 1593<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
207<dl> 1594<dl>
208<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 1595<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
209</dt> 1596</dt>
210<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
211</dt>
212<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
213</dt>
214<dd>
215Return the current values of the selection mark, begin or end positions,
216and optionally set them to new values.
217</dd> 1597<dd>
218<p></p> 1598Adds a non-clickable title to the popup.
219<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
220</dt>
221<dd> 1599</dd>
222Try to request the primary selection from the server (for example, as set 1600<p></p>
223by the next method). 1601<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1602</dt>
224</dd> 1603<dd>
225<p></p> 1604Creates a separator, optionally using the character given as <code>$sepchr</code>.
226<dt><strong><a name="item_selection">$oldtext = $term-&gt;selection ([$newtext])</a></strong><br />
227</dt>
228<dd> 1605</dd>
229Return the current selection text and optionally replace it by <code>$newtext</code>. 1606<p></p>
1607<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1608</dt>
230</dd> 1609<dd>
231<p></p> 1610Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
232<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br /> 1611selected.
233</dt>
234<dd> 1612</dd>
235Create a simple multi-line overlay box. See the next method for details. 1613<p></p>
1614<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1615</dt>
236</dd> 1616<dd>
237<p></p> 1617Adds a toggle/checkbox item to the popup. Teh callback gets called
238<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> 1618whenever it gets toggled, with a boolean indicating its value as its first
239</dt> 1619argument.
240<dd> 1620</dd>
241Create a new (empty) overlay at the given position with the given 1621<p></p>
242width/height. A border will be put around the box. If either <code>$x</code> or 1622<dt><strong>$popup-&gt;show</strong><br />
243<code>$y</code> is negative, then this is counted from the right/bottom side, 1623</dt>
244respectively.
245</dd> 1624<dd>
246<p></p> 1625Displays the popup (which is initially hidden).
247<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
248</dt>
249<dd>
250Switch the overlay off again.
251</dd>
252<p></p>
253<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br />
254</dt>
255<dd>
256Put a single character (specified numerically) at the given overlay
257position.
258</dd>
259<p></p>
260<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br />
261</dt>
262<dd>
263Write a string at the given position into the overlay.
264</dd> 1626</dd>
265<p></p></dl> 1627<p></p></dl>
266<p> 1628<p>
267</p> 1629</p>
268<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1630<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
269<p>This class implements timer watchers/events. Time is represented as a 1631<p>This class implements timer watchers/events. Time is represented as a
270fractional number of seconds since the epoch. Example:</p> 1632fractional number of seconds since the epoch. Example:</p>
271<pre> 1633<pre>
272 # create a digital clock display in upper right corner 1634 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
273 $term-&gt;{timer} = urxvt::timer 1635 $term-&gt;{timer} = urxvt::timer
274 -&gt;new 1636 -&gt;new
275 -&gt;start (urxvt::NOW) 1637 -&gt;interval (1)
276 -&gt;cb (sub { 1638 -&gt;cb (sub {
277 my ($timer) = @_;
278 my $time = $timer-&gt;at;
279 $timer-&gt;start ($time + 1);
280 $self-&gt;scr_overlay (-1, 0, 1639 $term-&gt;{overlay}-&gt;set (0, 0,
281 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 1640 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
282 });</pre> 1641 });</pre>
283<dl> 1642<dl>
284<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1643<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
285</dt> 1644</dt>
286<dd> 1645<dd>
287Create a new timer object in stopped state. 1646Create a new timer object in started state. It is scheduled to fire
1647immediately.
288</dd> 1648</dd>
289<p></p> 1649<p></p>
290<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 1650<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
291</dt> 1651</dt>
292<dd> 1652<dd>
… …
297</dt> 1657</dt>
298<dd> 1658<dd>
299Return the time this watcher will fire next. 1659Return the time this watcher will fire next.
300</dd> 1660</dd>
301<p></p> 1661<p></p>
302<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 1662<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
303</dt> 1663</dt>
304<dd> 1664<dd>
305Set the time the event is generated to $tstamp. 1665Set the time the event is generated to $tstamp.
306</dd> 1666</dd>
307<p></p> 1667<p></p>
1668<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1669</dt>
1670<dd>
1671Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1672stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1673is automatically rescheduled at the given intervals.
1674</dd>
1675<p></p>
308<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 1676<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
309</dt> 1677</dt>
310<dd> 1678<dd>
311Start the timer. 1679Start the timer.
312</dd> 1680</dd>
313<p></p> 1681<p></p>
314<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1682<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
315</dt> 1683</dt>
316<dd> 1684<dd>
317Set the event trigger time to <code>$tstamp</code> and start the timer. 1685Set the event trigger time to <code>$tstamp</code> and start the timer.
1686</dd>
1687<p></p>
1688<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1689</dt>
1690<dd>
1691Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
318</dd> 1692</dd>
319<p></p> 1693<p></p>
320<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1694<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
321</dt> 1695</dt>
322<dd> 1696<dd>
… …
330<pre> 1704<pre>
331 $term-&gt;{socket} = ... 1705 $term-&gt;{socket} = ...
332 $term-&gt;{iow} = urxvt::iow 1706 $term-&gt;{iow} = urxvt::iow
333 -&gt;new 1707 -&gt;new
334 -&gt;fd (fileno $term-&gt;{socket}) 1708 -&gt;fd (fileno $term-&gt;{socket})
335 -&gt;events (1) # wait for read data 1709 -&gt;events (urxvt::EVENT_READ)
336 -&gt;start 1710 -&gt;start
337 -&gt;cb (sub { 1711 -&gt;cb (sub {
338 my ($iow, $revents) = @_; 1712 my ($iow, $revents) = @_;
339 # $revents must be 1 here, no need to check 1713 # $revents must be 1 here, no need to check
340 sysread $term-&gt;{socket}, my $buf, 8192 1714 sysread $term-&gt;{socket}, my $buf, 8192
… …
361</dd> 1735</dd>
362<p></p> 1736<p></p>
363<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1737<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
364</dt> 1738</dt>
365<dd> 1739<dd>
366Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1740Set the event mask to watch. The only allowed values are
367data, Bit #1 (value <code>2</code>) enables watching for write data. 1741<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1742together, or <code>urxvt::EVENT_NONE</code>.
368</dd> 1743</dd>
369<p></p> 1744<p></p>
370<dt><strong>$iow = $iow-&gt;start</strong><br /> 1745<dt><strong>$iow = $iow-&gt;start</strong><br />
371</dt> 1746</dt>
372<dd> 1747<dd>
… …
377</dt> 1752</dt>
378<dd> 1753<dd>
379Stop watching for events on the given filehandle. 1754Stop watching for events on the given filehandle.
380</dd> 1755</dd>
381<p></p></dl> 1756<p></p></dl>
1757<p>
1758</p>
1759<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2>
1760<p>This class implements idle watchers, that get called automatically when
1761the process is idle. They should return as fast as possible, after doing
1762some useful work.</p>
1763<dl>
1764<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br />
1765</dt>
1766<dd>
1767Create a new idle watcher object in stopped state.
1768</dd>
1769<p></p>
1770<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br />
1771</dt>
1772<dd>
1773Set the callback to be called when the watcher triggers.
1774</dd>
1775<p></p>
1776<dt><strong>$timer = $timer-&gt;start</strong><br />
1777</dt>
1778<dd>
1779Start the watcher.
1780</dd>
1781<p></p>
1782<dt><strong>$timer = $timer-&gt;stop</strong><br />
1783</dt>
1784<dd>
1785Stop the watcher.
1786</dd>
1787<p></p></dl>
1788<p>
1789</p>
1790<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2>
1791<p>This class implements process watchers. They create an event whenever a
1792process exits, after which they stop automatically.</p>
1793<pre>
1794 my $pid = fork;
1795 ...
1796 $term-&gt;{pw} = urxvt::pw
1797 -&gt;new
1798 -&gt;start ($pid)
1799 -&gt;cb (sub {
1800 my ($pw, $exit_status) = @_;
1801 ...
1802 });</pre>
1803<dl>
1804<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br />
1805</dt>
1806<dd>
1807Create a new process watcher in stopped state.
1808</dd>
1809<p></p>
1810<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br />
1811</dt>
1812<dd>
1813Set the callback to be called when the timer triggers.
1814</dd>
1815<p></p>
1816<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br />
1817</dt>
1818<dd>
1819Tells the wqtcher to start watching for process <code>$pid</code>.
1820</dd>
1821<p></p>
1822<dt><strong>$pw = $pw-&gt;stop</strong><br />
1823</dt>
1824<dd>
1825Stop the watcher.
1826</dd>
1827<p></p></dl>
1828<p>
1829</p>
1830<hr />
1831<h1><a name="environment">ENVIRONMENT</a></h1>
1832<p>
1833</p>
1834<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1835<p>This variable controls the verbosity level of the perl extension. Higher
1836numbers indicate more verbose output.</p>
1837<dl>
1838<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1839</dt>
1840<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1841</dt>
1842<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1843</dt>
1844<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1845</dt>
1846</dl>
382<p> 1847<p>
383</p> 1848</p>
384<hr /> 1849<hr />
385<h1><a name="author">AUTHOR</a></h1> 1850<h1><a name="author">AUTHOR</a></h1>
386<pre> 1851<pre>

Diff Legend

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