ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/rxvt-unicode/doc/rxvtperl.3.html
Revision: 1.37
Committed: Sun Jan 22 20:39:56 2006 UTC (20 years, 8 months ago) by root
Content type: text/html
Branch: MAIN
CVS Tags: rel-7_2
Changes since 1.36: +13 -4 lines
Log Message:
*** empty log message ***

File Contents

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