ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/rxvt-unicode/doc/rxvtperl.3.html
Revision: 1.27
Committed: Thu Jan 12 12:15:10 2006 UTC (20 years, 8 months ago) by root
Content type: text/html
Branch: MAIN
Changes since 1.26: +3 -0 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     <title>rxvtperl - rxvt-unicode's embedded perl interpreter</title>
5     <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     </ul>
34    
35 root 1.2 <li><a href="#environment">ENVIRONMENT</a></li>
36     <ul>
37    
38     <li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li>
39     </ul>
40    
41 root 1.1 <li><a href="#author">AUTHOR</a></li>
42     </ul>
43     <!-- INDEX END -->
44    
45     <hr />
46     <p>
47     </p>
48 root 1.7 <hr />
49 root 1.1 <h1><a name="name">NAME</a></h1>
50     <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
51     <p>
52     </p>
53     <hr />
54     <h1><a name="synopsis">SYNOPSIS</a></h1>
55 root 1.5 <pre>
56     # create a file grab_test in $HOME:</pre>
57 root 1.1 <pre>
58     sub on_sel_grab {
59     warn &quot;you selected &quot;, $_[0]-&gt;selection;
60     ()
61     }</pre>
62     <pre>
63 root 1.5 # start a rxvt using it:</pre>
64     <pre>
65     rxvt --perl-lib $HOME -pe grab_test</pre>
66 root 1.1 <p>
67     </p>
68     <hr />
69     <h1><a name="description">DESCRIPTION</a></h1>
70 root 1.15 <p>Everytime a terminal object gets created, extension scripts specified via
71     the <code>perl</code> resource are loaded and associated with it.</p>
72 root 1.5 <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
73     thus must be encoded as UTF-8.</p>
74 root 1.3 <p>Each script will only ever be loaded once, even in rxvtd, where
75 root 1.7 scripts will be shared (but not enabled) for all terminals.</p>
76 root 1.3 <p>
77     </p>
78 root 1.20 <hr />
79     <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
80     <p>This section describes the extensions delivered with this release. You can
81 root 1.6 find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
82     <p>You can activate them like this:</p>
83     <pre>
84     rxvt -pe &lt;extensionname&gt;</pre>
85     <dl>
86 root 1.16 <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
87 root 1.6 </dt>
88     <dd>
89 root 1.20 (More) intelligent selection. This extension tries to be more intelligent
90 root 1.25 when the user extends selections (double-click and further clicks). Right
91     now, it tries to select words, urls and complete shell-quoted
92     arguments, which is very convenient, too, if your <em>ls</em> supports
93     <code>--quoting-style=shell</code>.
94     </dd>
95     <dd>
96     <p>A double-click usually selects the word under the cursor, further clicks
97     will enlarge the selection.</p>
98 root 1.9 </dd>
99     <dd>
100 root 1.26 <p>The selection works by trying to match a number of regexes and displaying
101     them in increasing order of length. You can add your own regexes by
102     specifying resources of the form:</p>
103     </dd>
104     <dd>
105     <pre>
106     URxvt.selection.pattern-0: perl-regex
107     URxvt.selection.pattern-1: perl-regex
108     ...</pre>
109     </dd>
110     <dd>
111     <p>The index number (0, 1...) must not have any holes, and each regex must
112     contain at least one pair of capturing parentheses, which will be used for
113     the match. For example, the followign adds a regex that matches everything
114     between two vertical bars:</p>
115     </dd>
116     <dd>
117     <pre>
118     URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
119     </dd>
120     <dd>
121     <p>You can look at the source of the selection extension to see more
122     interesting uses, such as parsing a line from beginning to end.</p>
123     </dd>
124     <dd>
125     <p>This extension also offers the following bindable keyboard command:</p>
126 root 1.6 </dd>
127     <dl>
128     <dt><strong><a name="item_rot13">rot13</a></strong><br />
129     </dt>
130     <dd>
131     Rot-13 the selection when activated. Used via keyboard trigger:
132     </dd>
133     <dd>
134     <pre>
135     URxvt.keysym.C-M-r: perl:selection:rot13</pre>
136     </dd>
137     <p></p></dl>
138 root 1.16 <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
139     </dt>
140     <dd>
141 root 1.17 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
142 root 1.16 runtime.
143     </dd>
144     <p></p>
145 root 1.17 <dt><strong>selection-popup (enabled by default)</strong><br />
146     </dt>
147     <dd>
148     Binds a popup menu to Ctrl-Button3 that lets you convert the selection
149 root 1.20 text into various other formats/action (such as uri unescaping, perl
150     evalution, web-browser starting etc.), depending on content.
151 root 1.17 </dd>
152     <p></p>
153 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 />
154     </dt>
155     <dd>
156     Adds regex search functionality to the scrollback buffer, triggered
157 root 1.25 by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
158     input/output is suspended and a regex is displayed at the bottom of the
159     screen.
160 root 1.19 </dd>
161     <dd>
162 root 1.25 <p>Inputting characters appends them to the regex and continues incremental
163     search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
164     search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
165     bottom. <code>Escape</code> leaves search mode and returns to the point where search
166     was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167     additionally stores the first match in the current line into the primary
168     selection.</p>
169 root 1.19 </dd>
170     <p></p>
171 root 1.26 <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172 root 1.6 </dt>
173     <dd>
174 root 1.26 This selection allows you to do automatic transforms on a selection
175     whenever a selection is made.
176     </dd>
177     <dd>
178     <p>It works by specifying perl snippets (most useful is a single <code>s///</code>
179     operator) that modify <code>$_</code> as resources:</p>
180     </dd>
181     <dd>
182     <pre>
183     URxvt.selection-autotransform.0: transform
184     URxvt.selection-autotransform.1: transform
185     ...</pre>
186     </dd>
187     <dd>
188     <p>For example, the following will transform selections of the form
189     <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
190     $word</code>:</p>
191     </dd>
192     <dd>
193     <pre>
194     URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
195     </dd>
196     <dd>
197     <p>And this example matches the same,but replaces it with vi-commands you can
198     paste directly into your (vi :) editor:</p>
199     </dd>
200     <dd>
201     <pre>
202     URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203 root 1.6 </dd>
204 root 1.27 <dd>
205     <p>Of course, this can be modified to suit your needs and your editor :)</p>
206     </dd>
207 root 1.6 <p></p>
208 root 1.14 <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
209     </dt>
210     <dd>
211 root 1.24 Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
212 root 1.25 make them clickable. When middle-clicked, the program specified in the
213     resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
214     the URL as first argument.
215 root 1.14 </dd>
216     <p></p>
217     <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
218     </dt>
219     <dd>
220     A not very useful example of filtering all text output to the terminal,
221     by replacing all line-drawing characters (U+2500 .. U+259F) by a
222     similar-looking ascii character.
223     </dd>
224     <p></p>
225 root 1.26 <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
226     </dt>
227     <dd>
228     Displays a digital clock using the built-in overlay.
229     </dd>
230     <p></p>
231 root 1.8 <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
232 root 1.6 </dt>
233     <dd>
234 root 1.8 Displays a very simple digital clock in the upper right corner of the
235     window. Illustrates overwriting the refresh callbacks to create your own
236     overlays or changes.
237 root 1.6 </dd>
238     <p></p></dl>
239     <p>
240     </p>
241 root 1.20 <hr />
242     <h1><a name="api_documentation">API DOCUMENTATION</a></h1>
243     <p>
244     </p>
245 root 1.3 <h2><a name="general_api_considerations">General API Considerations</a></h2>
246     <p>All objects (such as terminals, time watchers etc.) are typical
247     reference-to-hash objects. The hash can be used to store anything you
248     like. All members starting with an underscore (such as <code>_ptr</code> or
249 root 1.9 <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
250 root 1.3 modified).</p>
251     <p>When objects are destroyed on the C++ side, the perl object hashes are
252     emptied, so its best to store related objects such as time watchers and
253     the like inside the terminal object so they get destroyed as soon as the
254     terminal is destroyed.</p>
255 root 1.14 <p>Argument names also often indicate the type of a parameter. Here are some
256     hints on what they mean:</p>
257     <dl>
258     <dt><strong><a name="item__24text">$text</a></strong><br />
259     </dt>
260     <dd>
261     Rxvt-unicodes special way of encoding text, where one ``unicode'' character
262 root 1.23 always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
263 root 1.14 </dd>
264     <p></p>
265     <dt><strong><a name="item__24string">$string</a></strong><br />
266     </dt>
267     <dd>
268     A perl text string, with an emphasis on <em>text</em>. It can store all unicode
269     characters and is to be distinguished with text encoded in a specific
270     encoding (often locale-specific) and binary data.
271     </dd>
272     <p></p>
273     <dt><strong><a name="item__24octets">$octets</a></strong><br />
274     </dt>
275     <dd>
276     Either binary data or - more common - a text string encoded in a
277     locale-specific way.
278     </dd>
279     <p></p></dl>
280 root 1.1 <p>
281     </p>
282 root 1.19 <h2><a name="extension_objects">Extension Objects</a></h2>
283     <p>Very perl extension is a perl class. A separate perl object is created
284     for each terminal and each extension and passed as the first parameter to
285     hooks. So extensions can use their <code>$self</code> object without having to think
286     about other extensions, with the exception of methods and members that
287     begin with an underscore character <code>_</code>: these are reserved for internal
288     use.</p>
289     <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
290     <code>urxvt::term</code> class on this object.</p>
291     <p>It has the following methods and data members:</p>
292     <dl>
293     <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
294     </dt>
295     <dd>
296     Returns the <code>urxvt::term</code> object associated with this instance of the
297     extension. This member <em>must not</em> be changed in any way.
298     </dd>
299     <p></p>
300     <dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
301     </dt>
302     <dd>
303     Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
304     this extension, replacing any previous hook. This is useful when you want
305     to overwrite time-critical hooks only temporarily.
306     </dd>
307     <p></p>
308     <dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
309     </dt>
310     <dd>
311     Dynamically disable the given hooks.
312     </dd>
313     <p></p></dl>
314     <p>
315     </p>
316 root 1.1 <h2><a name="hooks">Hooks</a></h2>
317 root 1.14 <p>The following subroutines can be declared in extension files, and will be
318 root 1.9 called whenever the relevant event happens.</p>
319 root 1.19 <p>The first argument passed to them is an extension oject as described in
320     the in the <code>Extension Objects</code> section.</p>
321     <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
322     event counts as being <em>consumed</em>, and the invocation of other hooks is
323     skipped, and the relevant action might not be carried out by the C++ code.</p>
324     <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
325 root 1.1 <dl>
326     <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
327     </dt>
328     <dd>
329     Called after a new terminal object has been initialized, but before
330 root 1.14 windows are created or the command gets run. Most methods are unsafe to
331     call or deliver senseless data, as terminal size and other characteristics
332     have not yet been determined. You can safely query and change resources,
333     though.
334 root 1.1 </dd>
335     <p></p>
336     <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
337     </dt>
338     <dd>
339     Called after the screen is ``reset'' for any reason, such as resizing or
340     control sequences. Here is where you can react on changes to size-related
341     variables.
342     </dd>
343     <p></p>
344     <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
345     </dt>
346     <dd>
347     Called at the very end of initialisation of a new terminal, just before
348     returning to the mainloop.
349     </dd>
350     <p></p>
351     <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
352     </dt>
353     <dd>
354     Called whenever a selection has been made by the user, but before the
355     selection text is copied, so changes to the beginning, end or type of the
356     selection will be honored.
357     </dd>
358     <dd>
359     <p>Returning a true value aborts selection making by urxvt, in which case you
360     have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term-&gt;selection_grab</code></a>.</p>
361     </dd>
362     <p></p>
363     <dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br />
364     </dt>
365     <dd>
366     Called whenever a selection has been copied, but before the selection is
367     requested from the server. The selection text can be queried and changed
368     by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.
369     </dd>
370     <dd>
371     <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
372     </dd>
373     <p></p>
374 root 1.9 <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
375     </dt>
376     <dd>
377     Called whenever the user tries to extend the selection (e.g. with a double
378     click) and is either supposed to return false (normal operation), or
379     should extend the selection itelf and return true to suppress the built-in
380 root 1.25 processing. This can happen multiple times, as long as the callback
381     returns true, it will be called on every further click by the user and is
382     supposed to enlarge the selection more and more, if possible.
383 root 1.9 </dd>
384     <dd>
385     <p>See the <em>selection</em> example extension.</p>
386     </dd>
387     <p></p>
388 root 1.1 <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
389     </dt>
390     <dd>
391     Called whenever the view offset changes, i..e the user or program
392     scrolls. Offset <code>0</code> means display the normal terminal, positive values
393     show this many lines of scrollback.
394     </dd>
395     <p></p>
396     <dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br />
397     </dt>
398     <dd>
399     Called whenever lines scroll out of the terminal area into the scrollback
400     buffer. <code>$lines</code> is the number of lines scrolled out and may be larger
401     than the scroll back buffer or the terminal.
402     </dd>
403     <dd>
404     <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
405     $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
406     number of lines that will be in the scrollback buffer.</p>
407     </dd>
408     <p></p>
409 root 1.11 <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
410     </dt>
411     <dd>
412     Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
413     operating system command) is processed. Cursor position and other state
414     information is up-to-date when this happens. For interoperability, the
415     string should start with the extension name and a colon, to distinguish
416     it from commands for other extensions, and this might be enforced in the
417     future.
418     </dd>
419     <dd>
420     <p>Be careful not ever to trust (in a security sense) the data you receive,
421     as its source can not easily be controleld (e-mail content, messages from
422     other users on the same system etc.).</p>
423     </dd>
424     <p></p>
425 root 1.14 <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
426     </dt>
427     <dd>
428     Called whenever text is about to be output, with the text as argument. You
429     can filter/change and output the text yourself by returning a true value
430     and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
431     might be very slow, however, as your hook is called for <strong>all</strong> text being
432     output.
433     </dd>
434     <p></p>
435 root 1.19 <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
436     </dt>
437     <dd>
438     Called whenever some data is written to the tty/pty and can be used to
439     suppress or filter tty input.
440     </dd>
441     <p></p>
442 root 1.14 <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
443     </dt>
444     <dd>
445     Called whenever a line was updated or changed. Can be used to filter
446     screen output (e.g. underline urls or other useless stuff). Only lines
447     that are being shown will be filtered, and, due to performance reasons,
448     not always immediately.
449     </dd>
450     <dd>
451     <p>The row number is always the topmost row of the line if the line spans
452     multiple rows.</p>
453     </dd>
454     <dd>
455     <p>Please note that, if you change the line, then the hook might get called
456     later with the already-modified line (e.g. if unrelated parts change), so
457     you cannot just toggle rendition bits, but only set them.</p>
458     </dd>
459     <p></p>
460 root 1.1 <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
461     </dt>
462     <dd>
463     Called just before the screen gets redrawn. Can be used for overlay
464     or similar effects by modify terminal contents in refresh_begin, and
465     restoring them in refresh_end. The built-in overlay and selection display
466     code is run after this hook, and takes precedence.
467     </dd>
468     <p></p>
469     <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
470     </dt>
471     <dd>
472     Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
473     </dd>
474 root 1.5 <p></p>
475     <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
476     </dt>
477     <dd>
478     Called whenever the user presses a key combination that has a
479     <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
480     resource in the <code>rxvt(1)</code> manpage).
481     </dd>
482 root 1.14 <p></p>
483 root 1.15 <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
484     </dt>
485     <dd>
486     Called whenever the window gets the keyboard focus, before rxvt-unicode
487     does focus in processing.
488     </dd>
489     <p></p>
490     <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
491     </dt>
492     <dd>
493     Called wheneever the window loses keyboard focus, before rxvt-unicode does
494     focus out processing.
495     </dd>
496     <p></p>
497 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 />
498 root 1.14 </dt>
499 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 />
500 root 1.14 </dt>
501     <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
502     </dt>
503     <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
504     </dt>
505     <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
506     </dt>
507 root 1.15 <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
508     </dt>
509     <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
510     </dt>
511 root 1.14 <dd>
512     Called whenever the corresponding X event is received for the terminal If
513     the hook returns true, then the even will be ignored by rxvt-unicode.
514     </dd>
515     <dd>
516     <p>The event is a hash with most values as named by Xlib (see the XEvent
517     manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
518     and column under the mouse cursor.</p>
519     </dd>
520     <dd>
521     <p><code>on_key_press</code> additionally receives the string rxvt-unicode would
522     output, if any, in locale-specific encoding.</p>
523     </dd>
524     <dd>
525     <p>subwindow.</p>
526     </dd>
527 root 1.1 <p></p></dl>
528     <p>
529     </p>
530 root 1.9 <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
531     <dl>
532 root 1.21 <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
533     </dt>
534     <dd>
535     The rxvt-unicode library directory, where, among other things, the perl
536     modules and scripts are stored.
537     </dd>
538     <p></p>
539     <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
540     </dt>
541     <dd>
542     The resource class and name rxvt-unicode uses to look up X resources.
543     </dd>
544     <p></p>
545     <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
546     </dt>
547     <dd>
548     The basename of the installed binaries, usually <code>urxvt</code>.
549     </dd>
550     <p></p>
551 root 1.9 <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
552     </dt>
553     <dd>
554 root 1.14 The current terminal. This variable stores the current <code>urxvt::term</code>
555     object, whenever a callback/hook is executing.
556 root 1.9 </dd>
557 root 1.23 <p></p></dl>
558 root 1.9 <p>
559     </p>
560 root 1.1 <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
561     <dl>
562     <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
563     </dt>
564     <dd>
565     Fatally aborts execution with the given error message. Avoid at all
566     costs! The only time this is acceptable is when the terminal process
567     starts up.
568     </dd>
569     <p></p>
570     <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
571     </dt>
572     <dd>
573 root 1.3 Calls <code>rxvt_warn</code> with the given string which should not include a
574 root 1.1 newline. The module also overwrites the <code>warn</code> builtin with a function
575     that calls this function.
576     </dd>
577     <dd>
578     <p>Using this function has the advantage that its output ends up in the
579     correct place, e.g. on stderr of the connecting urxvtc client.</p>
580     </dd>
581 root 1.22 <dd>
582     <p>Messages have a size limit of 1023 bytes currently.</p>
583     </dd>
584 root 1.1 <p></p>
585 root 1.18 <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
586     </dt>
587     <dd>
588     Returns true when it is safe to do potentially unsafe things, such as
589     evaluating perl code specified by the user. This is true when urxvt was
590     started setuid or setgid.
591     </dd>
592     <p></p>
593 root 1.1 <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
594     </dt>
595     <dd>
596     Returns the ``current time'' (as per the event loop).
597     </dd>
598 root 1.15 <p></p>
599     <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
600     </dt>
601     <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
602     Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
603     Button4Mask, Button5Mask, AnyModifier</a></strong><br />
604     </dt>
605     <dd>
606 root 1.16 Various constants for use in X calls and event processing.
607 root 1.15 </dd>
608 root 1.1 <p></p></dl>
609     <p>
610     </p>
611 root 1.8 <h2><a name="rendition">RENDITION</a></h2>
612     <p>Rendition bitsets contain information about colour, font, font styles and
613     similar information for each screen cell.</p>
614     <p>The following ``macros'' deal with changes in rendition sets. You should
615     never just create a bitset, you should always modify an existing one,
616     as they contain important information required for correct operation of
617     rxvt-unicode.</p>
618     <dl>
619     <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
620     </dt>
621     <dd>
622     Returns the default rendition, as used when the terminal is starting up or
623     being reset. Useful as a base to start when creating renditions.
624     </dd>
625     <p></p>
626     <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
627     </dt>
628     <dd>
629     Return the rendition mask used for overlays by default.
630     </dd>
631     <p></p>
632     <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 />
633     </dt>
634     <dd>
635     Return the bit that enabled bold, italic, blink, reverse-video and
636     underline, respectively. To enable such a style, just logically OR it into
637     the bitset.
638     </dd>
639     <p></p>
640     <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
641     </dt>
642     <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
643     </dt>
644     <dd>
645     Return the foreground/background colour index, respectively.
646     </dd>
647     <p></p>
648 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 />
649 root 1.8 </dt>
650 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 />
651 root 1.8 </dt>
652     <dd>
653     Replace the foreground/background colour in the rendition mask with the
654     specified one.
655     </dd>
656     <p></p>
657 root 1.21 <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
658 root 1.8 </dt>
659     <dd>
660     Return the ``custom'' value: Every rendition has 5 bits for use by
661     extensions. They can be set and changed as you like and are initially
662     zero.
663     </dd>
664     <p></p>
665 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 />
666 root 1.8 </dt>
667     <dd>
668     Change the custom value.
669     </dd>
670     <p></p></dl>
671     <p>
672     </p>
673 root 1.16 <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
674     <p>The sole purpose of this class is to deliver an interface to the
675     <code>AnyEvent</code> module - any module using it will work inside urxvt without
676 root 1.21 further programming. The only exception is that you cannot wait on
677     condition variables, but non-blocking condvar use is ok. What this means
678     is that you cannot use blocking APIs, but the non-blocking variant should
679     work.</p>
680 root 1.16 <p>
681     </p>
682 root 1.1 <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
683     <dl>
684 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 />
685     </dt>
686     <dd>
687     Creates a new terminal, very similar as if you had started it with system
688 root 1.23 <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
689     hash which defines the environment of the new terminal.
690 root 1.22 </dd>
691     <dd>
692 root 1.23 <p>Croaks (and probably outputs an error message) if the new instance
693 root 1.22 couldn't be created. Returns <code>undef</code> if the new instance didn't
694     initialise perl, and the terminal object otherwise. The <code>init</code> and
695     <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
696     </dd>
697     <p></p>
698 root 1.14 <dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
699     </dt>
700     <dd>
701 root 1.21 Destroy the terminal object (close the window, free resources
702     etc.). Please note that rxvt will not exit as long as any event
703     watchers (timers, io watchers) are still active.
704 root 1.14 </dd>
705     <p></p>
706 root 1.15 <dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
707     </dt>
708     <dd>
709     Returns true if the option specified by <code>$optval</code> is enabled, and
710     optionally change it. All option values are stored by name in the hash
711     <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
712     </dd>
713     <dd>
714     <p>Here is a a likely non-exhaustive list of option names, please see the
715     source file <em>/src/optinc.h</em> to see the actual list:</p>
716     </dd>
717     <dd>
718     <pre>
719     borderLess console cursorBlink cursorUnderline hold iconic insecure
720     intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
721     pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
722     scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
723     secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
724     tripleclickwords utmpInhibit visualBell</pre>
725     </dd>
726     <p></p>
727 root 1.2 <dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
728     </dt>
729     <dd>
730     Returns the current resource value associated with a given name and
731     optionally sets a new value. Setting values is most useful in the <code>init</code>
732     hook. Unset resources are returned and accepted as <code>undef</code>.
733     </dd>
734     <dd>
735     <p>The new value must be properly encoded to a suitable character encoding
736     before passing it to this method. Similarly, the returned value may need
737     to be converted from the used encoding to text.</p>
738     </dd>
739     <dd>
740     <p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
741     as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
742     likely change).</p>
743     </dd>
744     <dd>
745     <p>Please note that resource strings will currently only be freed when the
746     terminal is destroyed, so changing options frequently will eat memory.</p>
747     </dd>
748     <dd>
749     <p>Here is a a likely non-exhaustive list of resource names, not all of which
750 root 1.15 are supported in every build, please see the source file <em>/src/rsinc.h</em>
751     to see the actual list:</p>
752 root 1.2 </dd>
753     <dd>
754     <pre>
755     answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
756     borderLess color cursorBlink cursorUnderline cutchars delete_key
757     display_name embed ext_bwidth fade font geometry hold iconName
758     imFont imLocale inputMethod insecure int_bwidth intensityStyles
759 root 1.4 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
760 root 1.12 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
761 root 1.3 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
762     reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
763     scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
764     scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
765     shade term_name title transparent transparent_all tripleclickwords
766     utmpInhibit visualBell</pre>
767 root 1.2 </dd>
768     <p></p>
769 root 1.24 <dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
770     </dt>
771     <dd>
772     Returns the X-Resource for the given pattern, excluding the program or
773     class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
774     same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
775     resource with that pattern exists.
776     </dd>
777     <dd>
778     <p>This method should only be called during the <code>on_start</code> hook, as there is
779     only one resource database per display, and later invocations might return
780     the wrong resources.</p>
781     </dd>
782     <p></p>
783 root 1.19 <dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
784     </dt>
785     <dd>
786     Adds a keymap translation exactly as specified via a resource. See the
787     <code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
788     </dd>
789     <p></p>
790 root 1.14 <dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
791 root 1.13 </dt>
792     <dd>
793 root 1.14 Return and optionally change the current rendition. Text that is output by
794     the terminal application will use this style.
795 root 1.13 </dd>
796     <p></p>
797     <dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
798     </dt>
799     <dd>
800     Return the current coordinates of the text cursor position and optionally
801     set it (which is usually bad as applications don't expect that).
802     </dd>
803     <p></p>
804 root 1.1 <dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
805     </dt>
806     <dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
807     </dt>
808     <dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
809     </dt>
810     <dd>
811     Return the current values of the selection mark, begin or end positions,
812     and optionally set them to new values.
813     </dd>
814     <p></p>
815 root 1.25 <dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
816     </dt>
817     <dd>
818     Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
819     <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
820     rectangular selection will be made. This is the prefered function to make
821     a selection.
822     </dd>
823     <p></p>
824 root 1.1 <dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
825     </dt>
826     <dd>
827 root 1.25 Try to request the primary selection text from the server (for example, as
828     set by the next method). No visual feedback will be given. This function
829     is mostly useful from within <code>on_sel_grab</code> hooks.
830 root 1.1 </dd>
831     <p></p>
832 root 1.6 <dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
833 root 1.1 </dt>
834     <dd>
835     Return the current selection text and optionally replace it by <code>$newtext</code>.
836     </dd>
837 root 1.19 <p></p>
838     <dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
839     </dt>
840 root 1.1 <dd>
841 root 1.19 Create a simple multi-line overlay box. See the next method for details.
842 root 1.1 </dd>
843     <p></p>
844 root 1.8 <dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
845 root 1.1 </dt>
846     <dd>
847     Create a new (empty) overlay at the given position with the given
848 root 1.8 width/height. <code>$rstyle</code> defines the initial rendition style
849     (default: <code>OVERLAY_RSTYLE</code>).
850     </dd>
851     <dd>
852     <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
853     around the box.</p>
854     </dd>
855     <dd>
856     <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
857     right/bottom side, respectively.</p>
858 root 1.1 </dd>
859     <dd>
860 root 1.8 <p>This method returns an urxvt::overlay object. The overlay will be visible
861     as long as the perl object is referenced.</p>
862 root 1.1 </dd>
863     <dd>
864 root 1.9 <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
865 root 1.1 </dd>
866 root 1.9 <dl>
867 root 1.8 <dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
868 root 1.1 </dt>
869     <dd>
870 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
871     text in rxvt-unicode's special encoding and an array of rendition values
872     at a specific position inside the overlay.
873 root 1.1 </dd>
874 root 1.3 <p></p>
875 root 1.9 <dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
876     </dt>
877     <dd>
878     If visible, hide the overlay, but do not destroy it.
879     </dd>
880     <p></p>
881     <dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
882     </dt>
883     <dd>
884     If hidden, display the overlay again.
885     </dd>
886     <p></p></dl>
887 root 1.16 <dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
888 root 1.15 </dt>
889     <dd>
890     Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
891     <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
892     currently).
893     </dd>
894     <p></p>
895 root 1.14 <dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
896 root 1.3 </dt>
897     <dd>
898     Returns the number of screen-cells this string would need. Correctly
899     accounts for wide and combining characters.
900     </dd>
901     <p></p>
902 root 1.14 <dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
903 root 1.3 </dt>
904     <dd>
905     Convert the given text string into the corresponding locale encoding.
906     </dd>
907     <p></p>
908 root 1.14 <dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
909 root 1.3 </dt>
910     <dd>
911     Convert the given locale-encoded octets into a perl string.
912     </dd>
913     <p></p>
914 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 />
915     </dt>
916     <dd>
917     XORs the rendition values in the given span with the provided value
918 root 1.25 (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
919     refresh hooks to provide effects similar to the selection.
920 root 1.19 </dd>
921     <p></p>
922     <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 />
923     </dt>
924     <dd>
925     Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
926     whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
927     to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
928 root 1.25 it instead. Both styles <em>MUST NOT</em> contain font styles.
929 root 1.19 </dd>
930     <p></p>
931     <dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
932     </dt>
933     <dd>
934     Ring the bell!
935     </dd>
936     <p></p>
937 root 1.14 <dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
938     </dt>
939     <dd>
940     Write the given text string to the screen, as if output by the application
941     running inside the terminal. It may not contain command sequences (escape
942     codes), but is free to use line feeds, carriage returns and tabs. The
943     string is a normal text string, not in locale-dependent encoding.
944     </dd>
945     <dd>
946     <p>Normally its not a good idea to use this function, as programs might be
947     confused by changes in cursor position or scrolling. Its useful inside a
948     <code>on_add_lines</code> hook, though.</p>
949     </dd>
950     <p></p>
951     <dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
952     </dt>
953     <dd>
954     Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
955     locale-specific encoding of the terminal and can contain command sequences
956     (escape codes) that will be interpreted.
957     </dd>
958     <p></p>
959 root 1.3 <dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
960     </dt>
961     <dd>
962     Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
963 root 1.6 pass characters instead of octets, you should convert your strings first
964     to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
965     </dd>
966     <p></p>
967 root 1.19 <dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
968     </dt>
969     <dd>
970     Replaces the event mask of the pty watcher by the given event mask. Can
971     be used to suppress input and output handling to the pty/tty. See the
972     description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
973     the previous value.
974     </dd>
975     <p></p>
976 root 1.14 <dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
977     </dt>
978     <dd>
979     Return the window id of the toplevel window.
980     </dd>
981     <p></p>
982     <dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
983     </dt>
984     <dd>
985     Return the window id of the terminal window.
986     </dd>
987     <p></p>
988 root 1.13 <dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
989     </dt>
990     <dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
991     </dt>
992     <dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
993 root 1.6 </dt>
994 root 1.13 <dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
995 root 1.6 </dt>
996 root 1.13 <dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
997     </dt>
998     <dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
999     </dt>
1000     <dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
1001     </dt>
1002     <dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1003     </dt>
1004     <dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1005     </dt>
1006     <dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1007     </dt>
1008     <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1009     </dt>
1010     <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
1011 root 1.6 </dt>
1012     <dd>
1013 root 1.13 Return various integers describing terminal characteristics.
1014 root 1.6 </dd>
1015     <p></p>
1016 root 1.22 <dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1017     </dt>
1018     <dd>
1019     Return the DISPLAY used by rxvt-unicode.
1020     </dd>
1021     <p></p>
1022 root 1.19 <dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1023     </dt>
1024     <dd>
1025     Returns the LC_CTYPE category string used by this rxvt-unicode.
1026     </dd>
1027     <p></p>
1028 root 1.22 <dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1029 root 1.19 </dt>
1030     <dd>
1031 root 1.22 Returns a copy of the environment in effect for the terminal as a hashref
1032     similar to <code>\%ENV</code>.
1033 root 1.19 </dd>
1034     <p></p>
1035 root 1.15 <dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1036     </dt>
1037     <dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1038     </dt>
1039     <dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1040     </dt>
1041     <dd>
1042     Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1043     AltGr), the meta key (often Alt) and the num lock key, if applicable.
1044     </dd>
1045     <p></p>
1046 root 1.6 <dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1047     </dt>
1048     <dd>
1049     Returns the negative row number of the topmost line. Minimum value is
1050     <code>0</code>, which displays the normal terminal contents. Larger values scroll
1051     this many lines into the scrollback buffer.
1052     </dd>
1053     <p></p>
1054     <dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1055     </dt>
1056     <dd>
1057     Requests a screen refresh. At the next opportunity, rxvt-unicode will
1058     compare the on-screen display with its stored representation. If they
1059     differ, it redraws the differences.
1060     </dd>
1061     <dd>
1062     <p>Used after changing terminal contents to display them.</p>
1063     </dd>
1064     <p></p>
1065     <dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1066     </dt>
1067     <dd>
1068     Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1069     is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1070     terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1071 root 1.9 line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
1072     is requested.
1073 root 1.6 </dd>
1074     <dd>
1075     <p>If <code>$new_text</code> is specified, it will replace characters in the current
1076     line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1077 root 1.8 to replace only parts of a line. The font index in the rendition will
1078 root 1.6 automatically be updated.</p>
1079     </dd>
1080     <dd>
1081 root 1.14 <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1082 root 1.6 than one cell when displayed are padded with urxvt::NOCHAR characters
1083     (<code>chr 65535</code>). Characters with combining characters and other characters
1084     that do not fit into the normal tetx encoding will be replaced with
1085     characters in the private use area.</p>
1086     </dd>
1087     <dd>
1088     <p>You have to obey this encoding when changing text. The advantage is
1089     that <code>substr</code> and similar functions work on screen cells and not on
1090     characters.</p>
1091     </dd>
1092     <dd>
1093 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>
1094 root 1.6 can be used to convert normal strings into this encoding and vice versa.</p>
1095     </dd>
1096     <p></p>
1097     <dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1098     </dt>
1099     <dd>
1100     Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
1101     bitsets. Rendition bitsets contain information about colour, font, font
1102     styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
1103     </dd>
1104     <dd>
1105     <p>When setting rendition, the font mask will be ignored.</p>
1106     </dd>
1107     <dd>
1108 root 1.8 <p>See the section on RENDITION, above.</p>
1109 root 1.6 </dd>
1110     <p></p>
1111     <dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1112     </dt>
1113     <dd>
1114 root 1.9 Returns the number of screen cells that are in use (``the line
1115     length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1116     line is joined with the following one.
1117     </dd>
1118     <p></p>
1119     <dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1120     </dt>
1121     <dd>
1122     Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1123     joined with the following row), which means all characters are in use
1124     and it is continued on the next row (and possibly a continuation of the
1125     previous row(s)).
1126 root 1.6 </dd>
1127     <p></p>
1128 root 1.9 <dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1129     </dt>
1130     <dd>
1131     Create and return a new <code>urxvt::line</code> object that stores information
1132     about the logical line that row <code>$row_number</code> is part of. It supports the
1133     following methods:
1134     </dd>
1135     <dl>
1136 root 1.14 <dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1137 root 1.9 </dt>
1138     <dd>
1139 root 1.14 Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1140 root 1.9 </dd>
1141     <p></p>
1142 root 1.14 <dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1143 root 1.9 </dt>
1144     <dd>
1145 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>
1146 root 1.9 </dd>
1147     <p></p>
1148     <dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1149     </dt>
1150     <dd>
1151     Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1152     </dd>
1153     <p></p>
1154     <dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1155     </dt>
1156     <dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1157     </dt>
1158     <dd>
1159     Return the row number of the first/last row of the line, respectively.
1160     </dd>
1161     <p></p>
1162     <dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1163     </dt>
1164     <dd>
1165     Returns the character offset of the given row|col pair within the logical
1166 root 1.25 line. Works for rows outside the line, too, and returns corresponding
1167     offsets outside the string.
1168 root 1.9 </dd>
1169     <p></p>
1170     <dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1171     </dt>
1172     <dd>
1173     Translates a string offset into terminal coordinates again.
1174     </dd>
1175     <p></p></dl>
1176 root 1.17 <dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1177 root 1.6 </dt>
1178     <dd>
1179     Converts a perl string into the special encoding used by rxvt-unicode,
1180     where one character corresponds to one screen cell. See
1181     <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1182     </dd>
1183     <p></p>
1184     <dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1185     </dt>
1186     <dd>
1187     Converts rxvt-unicodes text reprsentation into a perl string. See
1188     <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1189     </dd>
1190 root 1.17 <p></p>
1191     <dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1192     </dt>
1193     <dd>
1194 root 1.18 Registers a synchronous button grab. See the XGrabButton manpage.
1195 root 1.17 </dd>
1196     <p></p>
1197     <dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1198     </dt>
1199     <dd>
1200     Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1201     synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1202     </dd>
1203     <p></p>
1204     <dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1205     </dt>
1206     <dd>
1207     Calls XAllowEvents with AsyncBoth for the most recent grab.
1208     </dd>
1209     <p></p>
1210     <dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1211     </dt>
1212     <dd>
1213     Calls XAllowEvents with SyncBoth for the most recent grab.
1214     </dd>
1215     <p></p>
1216     <dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1217     </dt>
1218     <dd>
1219     Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1220     recent grab.
1221     </dd>
1222     <p></p>
1223     <dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1224     </dt>
1225     <dd>
1226     Calls XUngrab for the most recent grab. Is called automatically on
1227     evaluation errors, as it is better to lose the grab in the error case as
1228     the session.
1229     </dd>
1230 root 1.6 <p></p></dl>
1231     <p>
1232     </p>
1233 root 1.15 <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1234 root 1.21 <dl>
1235     <dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1236     </dt>
1237     <dd>
1238     Adds a non-clickable title to the popup.
1239     </dd>
1240     <p></p>
1241     <dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1242     </dt>
1243     <dd>
1244     Creates a separator, optionally using the character given as <code>$sepchr</code>.
1245     </dd>
1246     <p></p>
1247     <dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1248     </dt>
1249     <dd>
1250     Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1251     selected.
1252     </dd>
1253     <p></p>
1254     <dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1255     </dt>
1256     <dd>
1257     Adds a toggle/checkbox item to the popup. Teh callback gets called
1258     whenever it gets toggled, with a boolean indicating its value as its first
1259     argument.
1260     </dd>
1261     <p></p>
1262     <dt><strong>$popup-&gt;show</strong><br />
1263     </dt>
1264     <dd>
1265     Displays the popup (which is initially hidden).
1266     </dd>
1267     <p></p></dl>
1268 root 1.15 <p>
1269     </p>
1270 root 1.1 <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1271     <p>This class implements timer watchers/events. Time is represented as a
1272     fractional number of seconds since the epoch. Example:</p>
1273     <pre>
1274 root 1.8 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1275 root 1.1 $term-&gt;{timer} = urxvt::timer
1276     -&gt;new
1277 root 1.8 -&gt;interval (1)
1278 root 1.1 -&gt;cb (sub {
1279 root 1.8 $term-&gt;{overlay}-&gt;set (0, 0,
1280     sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
1281 root 1.1 });</pre>
1282     <dl>
1283     <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
1284     </dt>
1285     <dd>
1286 root 1.8 Create a new timer object in started state. It is scheduled to fire
1287     immediately.
1288 root 1.1 </dd>
1289     <p></p>
1290     <dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
1291     </dt>
1292     <dd>
1293     Set the callback to be called when the timer triggers.
1294     </dd>
1295     <p></p>
1296     <dt><strong><a name="item_at">$tstamp = $timer-&gt;at</a></strong><br />
1297     </dt>
1298     <dd>
1299     Return the time this watcher will fire next.
1300     </dd>
1301     <p></p>
1302 root 1.8 <dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
1303 root 1.1 </dt>
1304     <dd>
1305     Set the time the event is generated to $tstamp.
1306     </dd>
1307     <p></p>
1308 root 1.8 <dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1309     </dt>
1310     <dd>
1311     Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1312     stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1313     is automatically rescheduled at the given intervals.
1314     </dd>
1315     <p></p>
1316 root 1.1 <dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
1317     </dt>
1318     <dd>
1319     Start the timer.
1320     </dd>
1321     <p></p>
1322     <dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1323     </dt>
1324     <dd>
1325     Set the event trigger time to <code>$tstamp</code> and start the timer.
1326     </dd>
1327     <p></p>
1328     <dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1329     </dt>
1330     <dd>
1331     Stop the timer.
1332     </dd>
1333     <p></p></dl>
1334     <p>
1335     </p>
1336     <h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2>
1337     <p>This class implements io watchers/events. Example:</p>
1338     <pre>
1339     $term-&gt;{socket} = ...
1340     $term-&gt;{iow} = urxvt::iow
1341     -&gt;new
1342     -&gt;fd (fileno $term-&gt;{socket})
1343 root 1.19 -&gt;events (urxvt::EVENT_READ)
1344 root 1.1 -&gt;start
1345     -&gt;cb (sub {
1346     my ($iow, $revents) = @_;
1347     # $revents must be 1 here, no need to check
1348     sysread $term-&gt;{socket}, my $buf, 8192
1349     or end-of-file;
1350     });</pre>
1351     <dl>
1352     <dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br />
1353     </dt>
1354     <dd>
1355     Create a new io watcher object in stopped state.
1356     </dd>
1357     <p></p>
1358     <dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br />
1359     </dt>
1360     <dd>
1361     Set the callback to be called when io events are triggered. <code>$reventmask</code>
1362     is a bitset as described in the <a href="#item_events"><code>events</code></a> method.
1363     </dd>
1364     <p></p>
1365     <dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong><br />
1366     </dt>
1367     <dd>
1368     Set the filedescriptor (not handle) to watch.
1369     </dd>
1370     <p></p>
1371     <dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1372     </dt>
1373     <dd>
1374 root 1.19 Set the event mask to watch. The only allowed values are
1375     <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1376     together, or <code>urxvt::EVENT_NONE</code>.
1377 root 1.1 </dd>
1378     <p></p>
1379     <dt><strong>$iow = $iow-&gt;start</strong><br />
1380     </dt>
1381     <dd>
1382     Start watching for requested events on the given handle.
1383     </dd>
1384     <p></p>
1385     <dt><strong>$iow = $iow-&gt;stop</strong><br />
1386     </dt>
1387     <dd>
1388     Stop watching for events on the given filehandle.
1389     </dd>
1390     <p></p></dl>
1391     <p>
1392     </p>
1393     <hr />
1394 root 1.2 <h1><a name="environment">ENVIRONMENT</a></h1>
1395     <p>
1396     </p>
1397     <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1398     <p>This variable controls the verbosity level of the perl extension. Higher
1399     numbers indicate more verbose output.</p>
1400 root 1.10 <dl>
1401 root 1.17 <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1402 root 1.10 </dt>
1403 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 />
1404 root 1.10 </dt>
1405 root 1.25 <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1406     </dt>
1407     <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1408 root 1.10 </dt>
1409     </dl>
1410 root 1.2 <p>
1411     </p>
1412     <hr />
1413 root 1.1 <h1><a name="author">AUTHOR</a></h1>
1414     <pre>
1415     Marc Lehmann &lt;pcg@goof.com&gt;
1416     <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre>
1417    
1418     </body>
1419    
1420     </html>