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