ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
Revision: 1.21
Committed: Tue Jan 10 19:46:28 2006 UTC (18 years, 5 months ago) by root
Content type: text/html
Branch: MAIN
Changes since 1.20: +67 -9 lines
Log Message:
*** empty log message ***

File Contents

# Content
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 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
20 <ul>
21
22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
24 <li><a href="#hooks">Hooks</a></li>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
27 <li><a href="#rendition">RENDITION</a></li>
28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
31 <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 <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 <li><a href="#author">AUTHOR</a></li>
42 </ul>
43 <!-- INDEX END -->
44
45 <hr />
46 <p>
47 </p>
48 <hr />
49 <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 <pre>
56 # create a file grab_test in $HOME:</pre>
57 <pre>
58 sub on_sel_grab {
59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
60 ()
61 }</pre>
62 <pre>
63 # start a rxvt using it:</pre>
64 <pre>
65 rxvt --perl-lib $HOME -pe grab_test</pre>
66 <p>
67 </p>
68 <hr />
69 <h1><a name="description">DESCRIPTION</a></h1>
70 <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 <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
73 thus must be encoded as UTF-8.</p>
74 <p>Each script will only ever be loaded once, even in rxvtd, where
75 scripts will be shared (but not enabled) for all terminals.</p>
76 <p>
77 </p>
78 <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 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 <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
87 </dt>
88 <dd>
89 (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 </dd>
94 <dd>
95 <p>It also offers the following bindable keyboard command:</p>
96 </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 <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
109 </dt>
110 <dd>
111 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
112 runtime.
113 </dd>
114 <p></p>
115 <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 text into various other formats/action (such as uri unescaping, perl
120 evalution, web-browser starting etc.), depending on content.
121 </dd>
122 <p></p>
123 <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 <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
138 </dt>
139 <dd>
140 Displays a digital clock using the built-in overlay.
141 </dd>
142 <p></p>
143 <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 <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
158 </dt>
159 <dd>
160 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 </dd>
164 <p></p></dl>
165 <p>
166 </p>
167 <hr />
168 <h1><a name="api_documentation">API DOCUMENTATION</a></h1>
169 <p>
170 </p>
171 <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 <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
176 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 <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 always represents one screen cell. See <em>row_t</em> for a discussion of this format.
189 </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 <p>
207 </p>
208 <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 <h2><a name="hooks">Hooks</a></h2>
243 <p>The following subroutines can be declared in extension files, and will be
244 called whenever the relevant event happens.</p>
245 <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 <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 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 </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 <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 <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 <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 <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 <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 <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 <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 <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 <p></p>
407 <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 <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 </dt>
423 <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
424 </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 <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 <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 <p></p></dl>
452 <p>
453 </p>
454 <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
455 <dl>
456 <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 <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
476 </dt>
477 <dd>
478 The current terminal. This variable stores the current <code>urxvt::term</code>
479 object, whenever a callback/hook is executing.
480 </dd>
481 <p></p>
482 <dt></dt>
483 </dl>
484 <p>
485 </p>
486 <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
487 <dl>
488 <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
489 </dt>
490 <dd>
491 Creates a new terminal, very similar as if you had started it with
492 <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
493 if the new instance couldn't be created. Returns <code>undef</code> if the new
494 instance didn't initialise perl, and the terminal object otherwise. The
495 <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
496 </dd>
497 <p></p>
498 <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
499 </dt>
500 <dd>
501 Fatally aborts execution with the given error message. Avoid at all
502 costs! The only time this is acceptable is when the terminal process
503 starts up.
504 </dd>
505 <p></p>
506 <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
507 </dt>
508 <dd>
509 Calls <code>rxvt_warn</code> with the given string which should not include a
510 newline. The module also overwrites the <code>warn</code> builtin with a function
511 that calls this function.
512 </dd>
513 <dd>
514 <p>Using this function has the advantage that its output ends up in the
515 correct place, e.g. on stderr of the connecting urxvtc client.</p>
516 </dd>
517 <p></p>
518 <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519 </dt>
520 <dd>
521 Returns true when it is safe to do potentially unsafe things, such as
522 evaluating perl code specified by the user. This is true when urxvt was
523 started setuid or setgid.
524 </dd>
525 <p></p>
526 <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
527 </dt>
528 <dd>
529 Returns the ``current time'' (as per the event loop).
530 </dd>
531 <p></p>
532 <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
533 </dt>
534 <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
535 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
536 Button4Mask, Button5Mask, AnyModifier</a></strong><br />
537 </dt>
538 <dd>
539 Various constants for use in X calls and event processing.
540 </dd>
541 <p></p></dl>
542 <p>
543 </p>
544 <h2><a name="rendition">RENDITION</a></h2>
545 <p>Rendition bitsets contain information about colour, font, font styles and
546 similar information for each screen cell.</p>
547 <p>The following ``macros'' deal with changes in rendition sets. You should
548 never just create a bitset, you should always modify an existing one,
549 as they contain important information required for correct operation of
550 rxvt-unicode.</p>
551 <dl>
552 <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
553 </dt>
554 <dd>
555 Returns the default rendition, as used when the terminal is starting up or
556 being reset. Useful as a base to start when creating renditions.
557 </dd>
558 <p></p>
559 <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
560 </dt>
561 <dd>
562 Return the rendition mask used for overlays by default.
563 </dd>
564 <p></p>
565 <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 />
566 </dt>
567 <dd>
568 Return the bit that enabled bold, italic, blink, reverse-video and
569 underline, respectively. To enable such a style, just logically OR it into
570 the bitset.
571 </dd>
572 <p></p>
573 <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
574 </dt>
575 <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
576 </dt>
577 <dd>
578 Return the foreground/background colour index, respectively.
579 </dd>
580 <p></p>
581 <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
582 </dt>
583 <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
584 </dt>
585 <dd>
586 Replace the foreground/background colour in the rendition mask with the
587 specified one.
588 </dd>
589 <p></p>
590 <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
591 </dt>
592 <dd>
593 Return the ``custom'' value: Every rendition has 5 bits for use by
594 extensions. They can be set and changed as you like and are initially
595 zero.
596 </dd>
597 <p></p>
598 <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
599 </dt>
600 <dd>
601 Change the custom value.
602 </dd>
603 <p></p></dl>
604 <p>
605 </p>
606 <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
607 <p>The sole purpose of this class is to deliver an interface to the
608 <code>AnyEvent</code> module - any module using it will work inside urxvt without
609 further programming. The only exception is that you cannot wait on
610 condition variables, but non-blocking condvar use is ok. What this means
611 is that you cannot use blocking APIs, but the non-blocking variant should
612 work.</p>
613 <p>
614 </p>
615 <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
616 <dl>
617 <dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
618 </dt>
619 <dd>
620 Destroy the terminal object (close the window, free resources
621 etc.). Please note that rxvt will not exit as long as any event
622 watchers (timers, io watchers) are still active.
623 </dd>
624 <p></p>
625 <dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
626 </dt>
627 <dd>
628 Returns true if the option specified by <code>$optval</code> is enabled, and
629 optionally change it. All option values are stored by name in the hash
630 <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
631 </dd>
632 <dd>
633 <p>Here is a a likely non-exhaustive list of option names, please see the
634 source file <em>/src/optinc.h</em> to see the actual list:</p>
635 </dd>
636 <dd>
637 <pre>
638 borderLess console cursorBlink cursorUnderline hold iconic insecure
639 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
640 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
641 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
642 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
643 tripleclickwords utmpInhibit visualBell</pre>
644 </dd>
645 <p></p>
646 <dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
647 </dt>
648 <dd>
649 Returns the current resource value associated with a given name and
650 optionally sets a new value. Setting values is most useful in the <code>init</code>
651 hook. Unset resources are returned and accepted as <code>undef</code>.
652 </dd>
653 <dd>
654 <p>The new value must be properly encoded to a suitable character encoding
655 before passing it to this method. Similarly, the returned value may need
656 to be converted from the used encoding to text.</p>
657 </dd>
658 <dd>
659 <p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
660 as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
661 likely change).</p>
662 </dd>
663 <dd>
664 <p>Please note that resource strings will currently only be freed when the
665 terminal is destroyed, so changing options frequently will eat memory.</p>
666 </dd>
667 <dd>
668 <p>Here is a a likely non-exhaustive list of resource names, not all of which
669 are supported in every build, please see the source file <em>/src/rsinc.h</em>
670 to see the actual list:</p>
671 </dd>
672 <dd>
673 <pre>
674 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
675 borderLess color cursorBlink cursorUnderline cutchars delete_key
676 display_name embed ext_bwidth fade font geometry hold iconName
677 imFont imLocale inputMethod insecure int_bwidth intensityStyles
678 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
679 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
680 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
681 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
682 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
683 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
684 shade term_name title transparent transparent_all tripleclickwords
685 utmpInhibit visualBell</pre>
686 </dd>
687 <p></p>
688 <dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
689 </dt>
690 <dd>
691 Adds a keymap translation exactly as specified via a resource. See the
692 <code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
693 </dd>
694 <p></p>
695 <dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
696 </dt>
697 <dd>
698 Return and optionally change the current rendition. Text that is output by
699 the terminal application will use this style.
700 </dd>
701 <p></p>
702 <dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
703 </dt>
704 <dd>
705 Return the current coordinates of the text cursor position and optionally
706 set it (which is usually bad as applications don't expect that).
707 </dd>
708 <p></p>
709 <dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
710 </dt>
711 <dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
712 </dt>
713 <dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
714 </dt>
715 <dd>
716 Return the current values of the selection mark, begin or end positions,
717 and optionally set them to new values.
718 </dd>
719 <p></p>
720 <dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
721 </dt>
722 <dd>
723 Try to request the primary selection from the server (for example, as set
724 by the next method).
725 </dd>
726 <p></p>
727 <dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
728 </dt>
729 <dd>
730 Return the current selection text and optionally replace it by <code>$newtext</code>.
731 </dd>
732 <p></p>
733 <dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
734 </dt>
735 <dd>
736 Create a simple multi-line overlay box. See the next method for details.
737 </dd>
738 <p></p>
739 <dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
740 </dt>
741 <dd>
742 Create a new (empty) overlay at the given position with the given
743 width/height. <code>$rstyle</code> defines the initial rendition style
744 (default: <code>OVERLAY_RSTYLE</code>).
745 </dd>
746 <dd>
747 <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
748 around the box.</p>
749 </dd>
750 <dd>
751 <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
752 right/bottom side, respectively.</p>
753 </dd>
754 <dd>
755 <p>This method returns an urxvt::overlay object. The overlay will be visible
756 as long as the perl object is referenced.</p>
757 </dd>
758 <dd>
759 <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
760 </dd>
761 <dl>
762 <dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
763 </dt>
764 <dd>
765 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
766 text in rxvt-unicode's special encoding and an array of rendition values
767 at a specific position inside the overlay.
768 </dd>
769 <p></p>
770 <dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
771 </dt>
772 <dd>
773 If visible, hide the overlay, but do not destroy it.
774 </dd>
775 <p></p>
776 <dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
777 </dt>
778 <dd>
779 If hidden, display the overlay again.
780 </dd>
781 <p></p></dl>
782 <dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
783 </dt>
784 <dd>
785 Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
786 <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
787 currently).
788 </dd>
789 <p></p>
790 <dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
791 </dt>
792 <dd>
793 Returns the number of screen-cells this string would need. Correctly
794 accounts for wide and combining characters.
795 </dd>
796 <p></p>
797 <dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
798 </dt>
799 <dd>
800 Convert the given text string into the corresponding locale encoding.
801 </dd>
802 <p></p>
803 <dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
804 </dt>
805 <dd>
806 Convert the given locale-encoded octets into a perl string.
807 </dd>
808 <p></p>
809 <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 />
810 </dt>
811 <dd>
812 XORs the rendition values in the given span with the provided value
813 (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar
814 to the selection.
815 </dd>
816 <p></p>
817 <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 />
818 </dt>
819 <dd>
820 Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
821 whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
822 to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
823 it instead.
824 </dd>
825 <p></p>
826 <dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
827 </dt>
828 <dd>
829 Ring the bell!
830 </dd>
831 <p></p>
832 <dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
833 </dt>
834 <dd>
835 Write the given text string to the screen, as if output by the application
836 running inside the terminal. It may not contain command sequences (escape
837 codes), but is free to use line feeds, carriage returns and tabs. The
838 string is a normal text string, not in locale-dependent encoding.
839 </dd>
840 <dd>
841 <p>Normally its not a good idea to use this function, as programs might be
842 confused by changes in cursor position or scrolling. Its useful inside a
843 <code>on_add_lines</code> hook, though.</p>
844 </dd>
845 <p></p>
846 <dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
847 </dt>
848 <dd>
849 Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
850 locale-specific encoding of the terminal and can contain command sequences
851 (escape codes) that will be interpreted.
852 </dd>
853 <p></p>
854 <dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
855 </dt>
856 <dd>
857 Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
858 pass characters instead of octets, you should convert your strings first
859 to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
860 </dd>
861 <p></p>
862 <dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
863 </dt>
864 <dd>
865 Replaces the event mask of the pty watcher by the given event mask. Can
866 be used to suppress input and output handling to the pty/tty. See the
867 description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
868 the previous value.
869 </dd>
870 <p></p>
871 <dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
872 </dt>
873 <dd>
874 Return the window id of the toplevel window.
875 </dd>
876 <p></p>
877 <dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
878 </dt>
879 <dd>
880 Return the window id of the terminal window.
881 </dd>
882 <p></p>
883 <dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
884 </dt>
885 <dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
886 </dt>
887 <dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
888 </dt>
889 <dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
890 </dt>
891 <dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
892 </dt>
893 <dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
894 </dt>
895 <dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
896 </dt>
897 <dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
898 </dt>
899 <dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
900 </dt>
901 <dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
902 </dt>
903 <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
904 </dt>
905 <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
906 </dt>
907 <dd>
908 Return various integers describing terminal characteristics.
909 </dd>
910 <p></p>
911 <dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912 </dt>
913 <dd>
914 Returns the LC_CTYPE category string used by this rxvt-unicode.
915 </dd>
916 <p></p>
917 <dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
918 </dt>
919 <dd>
920 Return the DISPLAY used by rxvt-unicode.
921 </dd>
922 <p></p>
923 <dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
924 </dt>
925 <dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
926 </dt>
927 <dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
928 </dt>
929 <dd>
930 Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
931 AltGr), the meta key (often Alt) and the num lock key, if applicable.
932 </dd>
933 <p></p>
934 <dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
935 </dt>
936 <dd>
937 Returns the negative row number of the topmost line. Minimum value is
938 <code>0</code>, which displays the normal terminal contents. Larger values scroll
939 this many lines into the scrollback buffer.
940 </dd>
941 <p></p>
942 <dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
943 </dt>
944 <dd>
945 Requests a screen refresh. At the next opportunity, rxvt-unicode will
946 compare the on-screen display with its stored representation. If they
947 differ, it redraws the differences.
948 </dd>
949 <dd>
950 <p>Used after changing terminal contents to display them.</p>
951 </dd>
952 <p></p>
953 <dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
954 </dt>
955 <dd>
956 Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
957 is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
958 terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
959 line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
960 is requested.
961 </dd>
962 <dd>
963 <p>If <code>$new_text</code> is specified, it will replace characters in the current
964 line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
965 to replace only parts of a line. The font index in the rendition will
966 automatically be updated.</p>
967 </dd>
968 <dd>
969 <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
970 than one cell when displayed are padded with urxvt::NOCHAR characters
971 (<code>chr 65535</code>). Characters with combining characters and other characters
972 that do not fit into the normal tetx encoding will be replaced with
973 characters in the private use area.</p>
974 </dd>
975 <dd>
976 <p>You have to obey this encoding when changing text. The advantage is
977 that <code>substr</code> and similar functions work on screen cells and not on
978 characters.</p>
979 </dd>
980 <dd>
981 <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>
982 can be used to convert normal strings into this encoding and vice versa.</p>
983 </dd>
984 <p></p>
985 <dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
986 </dt>
987 <dd>
988 Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
989 bitsets. Rendition bitsets contain information about colour, font, font
990 styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
991 </dd>
992 <dd>
993 <p>When setting rendition, the font mask will be ignored.</p>
994 </dd>
995 <dd>
996 <p>See the section on RENDITION, above.</p>
997 </dd>
998 <p></p>
999 <dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1000 </dt>
1001 <dd>
1002 Returns the number of screen cells that are in use (``the line
1003 length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
1004 line is joined with the following one.
1005 </dd>
1006 <p></p>
1007 <dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1008 </dt>
1009 <dd>
1010 Returns true if the row is part of a multiple-row logical ``line'' (i.e.
1011 joined with the following row), which means all characters are in use
1012 and it is continued on the next row (and possibly a continuation of the
1013 previous row(s)).
1014 </dd>
1015 <p></p>
1016 <dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1017 </dt>
1018 <dd>
1019 Create and return a new <code>urxvt::line</code> object that stores information
1020 about the logical line that row <code>$row_number</code> is part of. It supports the
1021 following methods:
1022 </dd>
1023 <dl>
1024 <dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
1025 </dt>
1026 <dd>
1027 Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
1028 </dd>
1029 <p></p>
1030 <dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1031 </dt>
1032 <dd>
1033 Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1034 </dd>
1035 <p></p>
1036 <dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1037 </dt>
1038 <dd>
1039 Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1040 </dd>
1041 <p></p>
1042 <dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1043 </dt>
1044 <dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1045 </dt>
1046 <dd>
1047 Return the row number of the first/last row of the line, respectively.
1048 </dd>
1049 <p></p>
1050 <dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1051 </dt>
1052 <dd>
1053 Returns the character offset of the given row|col pair within the logical
1054 line.
1055 </dd>
1056 <p></p>
1057 <dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1058 </dt>
1059 <dd>
1060 Translates a string offset into terminal coordinates again.
1061 </dd>
1062 <p></p></dl>
1063 <dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1064 </dt>
1065 <dd>
1066 Converts a perl string into the special encoding used by rxvt-unicode,
1067 where one character corresponds to one screen cell. See
1068 <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1069 </dd>
1070 <p></p>
1071 <dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1072 </dt>
1073 <dd>
1074 Converts rxvt-unicodes text reprsentation into a perl string. See
1075 <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1076 </dd>
1077 <p></p>
1078 <dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1079 </dt>
1080 <dd>
1081 Registers a synchronous button grab. See the XGrabButton manpage.
1082 </dd>
1083 <p></p>
1084 <dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1085 </dt>
1086 <dd>
1087 Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1088 synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1089 </dd>
1090 <p></p>
1091 <dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1092 </dt>
1093 <dd>
1094 Calls XAllowEvents with AsyncBoth for the most recent grab.
1095 </dd>
1096 <p></p>
1097 <dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1098 </dt>
1099 <dd>
1100 Calls XAllowEvents with SyncBoth for the most recent grab.
1101 </dd>
1102 <p></p>
1103 <dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1104 </dt>
1105 <dd>
1106 Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1107 recent grab.
1108 </dd>
1109 <p></p>
1110 <dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1111 </dt>
1112 <dd>
1113 Calls XUngrab for the most recent grab. Is called automatically on
1114 evaluation errors, as it is better to lose the grab in the error case as
1115 the session.
1116 </dd>
1117 <p></p></dl>
1118 <p>
1119 </p>
1120 <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1121 <dl>
1122 <dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1123 </dt>
1124 <dd>
1125 Adds a non-clickable title to the popup.
1126 </dd>
1127 <p></p>
1128 <dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1129 </dt>
1130 <dd>
1131 Creates a separator, optionally using the character given as <code>$sepchr</code>.
1132 </dd>
1133 <p></p>
1134 <dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1135 </dt>
1136 <dd>
1137 Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1138 selected.
1139 </dd>
1140 <p></p>
1141 <dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1142 </dt>
1143 <dd>
1144 Adds a toggle/checkbox item to the popup. Teh callback gets called
1145 whenever it gets toggled, with a boolean indicating its value as its first
1146 argument.
1147 </dd>
1148 <p></p>
1149 <dt><strong>$popup-&gt;show</strong><br />
1150 </dt>
1151 <dd>
1152 Displays the popup (which is initially hidden).
1153 </dd>
1154 <p></p></dl>
1155 <p>
1156 </p>
1157 <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1158 <p>This class implements timer watchers/events. Time is represented as a
1159 fractional number of seconds since the epoch. Example:</p>
1160 <pre>
1161 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1162 $term-&gt;{timer} = urxvt::timer
1163 -&gt;new
1164 -&gt;interval (1)
1165 -&gt;cb (sub {
1166 $term-&gt;{overlay}-&gt;set (0, 0,
1167 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
1168 });</pre>
1169 <dl>
1170 <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
1171 </dt>
1172 <dd>
1173 Create a new timer object in started state. It is scheduled to fire
1174 immediately.
1175 </dd>
1176 <p></p>
1177 <dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
1178 </dt>
1179 <dd>
1180 Set the callback to be called when the timer triggers.
1181 </dd>
1182 <p></p>
1183 <dt><strong><a name="item_at">$tstamp = $timer-&gt;at</a></strong><br />
1184 </dt>
1185 <dd>
1186 Return the time this watcher will fire next.
1187 </dd>
1188 <p></p>
1189 <dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
1190 </dt>
1191 <dd>
1192 Set the time the event is generated to $tstamp.
1193 </dd>
1194 <p></p>
1195 <dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1196 </dt>
1197 <dd>
1198 Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1199 stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1200 is automatically rescheduled at the given intervals.
1201 </dd>
1202 <p></p>
1203 <dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
1204 </dt>
1205 <dd>
1206 Start the timer.
1207 </dd>
1208 <p></p>
1209 <dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1210 </dt>
1211 <dd>
1212 Set the event trigger time to <code>$tstamp</code> and start the timer.
1213 </dd>
1214 <p></p>
1215 <dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1216 </dt>
1217 <dd>
1218 Stop the timer.
1219 </dd>
1220 <p></p></dl>
1221 <p>
1222 </p>
1223 <h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2>
1224 <p>This class implements io watchers/events. Example:</p>
1225 <pre>
1226 $term-&gt;{socket} = ...
1227 $term-&gt;{iow} = urxvt::iow
1228 -&gt;new
1229 -&gt;fd (fileno $term-&gt;{socket})
1230 -&gt;events (urxvt::EVENT_READ)
1231 -&gt;start
1232 -&gt;cb (sub {
1233 my ($iow, $revents) = @_;
1234 # $revents must be 1 here, no need to check
1235 sysread $term-&gt;{socket}, my $buf, 8192
1236 or end-of-file;
1237 });</pre>
1238 <dl>
1239 <dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br />
1240 </dt>
1241 <dd>
1242 Create a new io watcher object in stopped state.
1243 </dd>
1244 <p></p>
1245 <dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br />
1246 </dt>
1247 <dd>
1248 Set the callback to be called when io events are triggered. <code>$reventmask</code>
1249 is a bitset as described in the <a href="#item_events"><code>events</code></a> method.
1250 </dd>
1251 <p></p>
1252 <dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong><br />
1253 </dt>
1254 <dd>
1255 Set the filedescriptor (not handle) to watch.
1256 </dd>
1257 <p></p>
1258 <dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1259 </dt>
1260 <dd>
1261 Set the event mask to watch. The only allowed values are
1262 <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1263 together, or <code>urxvt::EVENT_NONE</code>.
1264 </dd>
1265 <p></p>
1266 <dt><strong>$iow = $iow-&gt;start</strong><br />
1267 </dt>
1268 <dd>
1269 Start watching for requested events on the given handle.
1270 </dd>
1271 <p></p>
1272 <dt><strong>$iow = $iow-&gt;stop</strong><br />
1273 </dt>
1274 <dd>
1275 Stop watching for events on the given filehandle.
1276 </dd>
1277 <p></p></dl>
1278 <p>
1279 </p>
1280 <hr />
1281 <h1><a name="environment">ENVIRONMENT</a></h1>
1282 <p>
1283 </p>
1284 <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1285 <p>This variable controls the verbosity level of the perl extension. Higher
1286 numbers indicate more verbose output.</p>
1287 <dl>
1288 <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1289 </dt>
1290 <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1291 </dt>
1292 <dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1293 </dt>
1294 </dl>
1295 <p>
1296 </p>
1297 <hr />
1298 <h1><a name="author">AUTHOR</a></h1>
1299 <pre>
1300 Marc Lehmann &lt;pcg@goof.com&gt;
1301 <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre>
1302
1303 </body>
1304
1305 </html>