1 |
NAME |
2 |
rxvtperl - rxvt-unicode's embedded perl interpreter |
3 |
|
4 |
SYNOPSIS |
5 |
# create a file grab_test in $HOME: |
6 |
|
7 |
sub on_sel_grab { |
8 |
warn "you selected ", $_[0]->selection; |
9 |
() |
10 |
} |
11 |
|
12 |
# start a rxvt using it: |
13 |
|
14 |
rxvt --perl-lib $HOME -pe grab_test |
15 |
|
16 |
DESCRIPTION |
17 |
Everytime a terminal object gets created, extension scripts specified |
18 |
via the "perl" resource are loaded and associated with it. |
19 |
|
20 |
Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
21 |
thus must be encoded as UTF-8. |
22 |
|
23 |
Each script will only ever be loaded once, even in rxvtd, where scripts |
24 |
will be shared (but not enabled) for all terminals. |
25 |
|
26 |
PREPACKAGED EXTENSIONS |
27 |
This section describes the extensions delivered with this release. You |
28 |
can find them in /opt/rxvt/lib/urxvt/perl/. |
29 |
|
30 |
You can activate them like this: |
31 |
|
32 |
rxvt -pe <extensionname> |
33 |
|
34 |
selection (enabled by default) |
35 |
(More) intelligent selection. This extension tries to be more |
36 |
intelligent when the user extends selections (double-click). Right |
37 |
now, it tries to select urls and complete shell-quoted arguments, |
38 |
which is very convenient, too, if your ls supports |
39 |
"--quoting-style=shell". |
40 |
|
41 |
It also offers the following bindable keyboard command: |
42 |
|
43 |
rot13 |
44 |
Rot-13 the selection when activated. Used via keyboard trigger: |
45 |
|
46 |
URxvt.keysym.C-M-r: perl:selection:rot13 |
47 |
|
48 |
option-popup (enabled by default) |
49 |
Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
50 |
options at runtime. |
51 |
|
52 |
selection-popup (enabled by default) |
53 |
Binds a popup menu to Ctrl-Button3 that lets you convert the |
54 |
selection text into various other formats/action (such as uri |
55 |
unescaping, perl evalution, web-browser starting etc.), depending on |
56 |
content. |
57 |
|
58 |
searchable-scrollback<hotkey> (enabled by default) |
59 |
Adds regex search functionality to the scrollback buffer, triggered |
60 |
by a hotkey (default: "M-s"). When in search mode, normal terminal |
61 |
input/output is suspended. |
62 |
|
63 |
"/" starts an incremental regex search, "n" searches further, "p" or |
64 |
"N" jump to the previous match, "G" jumps to the bottom and clears |
65 |
the history, "enter" leaves search mode at the current position and |
66 |
"escape" returns to the original position. |
67 |
|
68 |
digital-clock |
69 |
Displays a digital clock using the built-in overlay. |
70 |
|
71 |
mark-urls |
72 |
Uses per-line display filtering ("on_line_update") to underline |
73 |
urls. |
74 |
|
75 |
block-graphics-to-ascii |
76 |
A not very useful example of filtering all text output to the |
77 |
terminal, by replacing all line-drawing characters (U+2500 .. |
78 |
U+259F) by a similar-looking ascii character. |
79 |
|
80 |
example-refresh-hooks |
81 |
Displays a very simple digital clock in the upper right corner of |
82 |
the window. Illustrates overwriting the refresh callbacks to create |
83 |
your own overlays or changes. |
84 |
|
85 |
API DOCUMENTATION |
86 |
General API Considerations |
87 |
All objects (such as terminals, time watchers etc.) are typical |
88 |
reference-to-hash objects. The hash can be used to store anything you |
89 |
like. All members starting with an underscore (such as "_ptr" or |
90 |
"_hook") are reserved for internal uses and MUST NOT be accessed or |
91 |
modified). |
92 |
|
93 |
When objects are destroyed on the C++ side, the perl object hashes are |
94 |
emptied, so its best to store related objects such as time watchers and |
95 |
the like inside the terminal object so they get destroyed as soon as the |
96 |
terminal is destroyed. |
97 |
|
98 |
Argument names also often indicate the type of a parameter. Here are |
99 |
some hints on what they mean: |
100 |
|
101 |
$text |
102 |
Rxvt-unicodes special way of encoding text, where one "unicode" |
103 |
character always represents one screen cell. See ROW_t for a |
104 |
discussion of this format. |
105 |
|
106 |
$string |
107 |
A perl text string, with an emphasis on *text*. It can store all |
108 |
unicode characters and is to be distinguished with text encoded in a |
109 |
specific encoding (often locale-specific) and binary data. |
110 |
|
111 |
$octets |
112 |
Either binary data or - more common - a text string encoded in a |
113 |
locale-specific way. |
114 |
|
115 |
Extension Objects |
116 |
Very perl extension is a perl class. A separate perl object is created |
117 |
for each terminal and each extension and passed as the first parameter |
118 |
to hooks. So extensions can use their $self object without having to |
119 |
think about other extensions, with the exception of methods and members |
120 |
that begin with an underscore character "_": these are reserved for |
121 |
internal use. |
122 |
|
123 |
Although it isn't a "urxvt::term" object, you can call all methods of |
124 |
the "urxvt::term" class on this object. |
125 |
|
126 |
It has the following methods and data members: |
127 |
|
128 |
$urxvt_term = $self->{term} |
129 |
Returns the "urxvt::term" object associated with this instance of |
130 |
the extension. This member *must not* be changed in any way. |
131 |
|
132 |
$self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
133 |
Dynamically enable the given hooks (named without the "on_" prefix) |
134 |
for this extension, replacing any previous hook. This is useful when |
135 |
you want to overwrite time-critical hooks only temporarily. |
136 |
|
137 |
$self->disable ($hook_name[, $hook_name..]) |
138 |
Dynamically disable the given hooks. |
139 |
|
140 |
Hooks |
141 |
The following subroutines can be declared in extension files, and will |
142 |
be called whenever the relevant event happens. |
143 |
|
144 |
The first argument passed to them is an extension oject as described in |
145 |
the in the "Extension Objects" section. |
146 |
|
147 |
All of these hooks must return a boolean value. If it is true, then the |
148 |
event counts as being *consumed*, and the invocation of other hooks is |
149 |
skipped, and the relevant action might not be carried out by the C++ |
150 |
code. |
151 |
|
152 |
*When in doubt, return a false value (preferably "()").* |
153 |
|
154 |
on_init $term |
155 |
Called after a new terminal object has been initialized, but before |
156 |
windows are created or the command gets run. Most methods are unsafe |
157 |
to call or deliver senseless data, as terminal size and other |
158 |
characteristics have not yet been determined. You can safely query |
159 |
and change resources, though. |
160 |
|
161 |
on_reset $term |
162 |
Called after the screen is "reset" for any reason, such as resizing |
163 |
or control sequences. Here is where you can react on changes to |
164 |
size-related variables. |
165 |
|
166 |
on_start $term |
167 |
Called at the very end of initialisation of a new terminal, just |
168 |
before returning to the mainloop. |
169 |
|
170 |
on_sel_make $term, $eventtime |
171 |
Called whenever a selection has been made by the user, but before |
172 |
the selection text is copied, so changes to the beginning, end or |
173 |
type of the selection will be honored. |
174 |
|
175 |
Returning a true value aborts selection making by urxvt, in which |
176 |
case you have to make a selection yourself by calling |
177 |
"$term->selection_grab". |
178 |
|
179 |
on_sel_grab $term, $eventtime |
180 |
Called whenever a selection has been copied, but before the |
181 |
selection is requested from the server. The selection text can be |
182 |
queried and changed by calling "$term->selection". |
183 |
|
184 |
Returning a true value aborts selection grabbing. It will still be |
185 |
hilighted. |
186 |
|
187 |
on_sel_extend $term |
188 |
Called whenever the user tries to extend the selection (e.g. with a |
189 |
double click) and is either supposed to return false (normal |
190 |
operation), or should extend the selection itelf and return true to |
191 |
suppress the built-in processing. |
192 |
|
193 |
See the selection example extension. |
194 |
|
195 |
on_view_change $term, $offset |
196 |
Called whenever the view offset changes, i..e the user or program |
197 |
scrolls. Offset 0 means display the normal terminal, positive values |
198 |
show this many lines of scrollback. |
199 |
|
200 |
on_scroll_back $term, $lines, $saved |
201 |
Called whenever lines scroll out of the terminal area into the |
202 |
scrollback buffer. $lines is the number of lines scrolled out and |
203 |
may be larger than the scroll back buffer or the terminal. |
204 |
|
205 |
It is called before lines are scrolled out (so rows 0 .. min ($lines |
206 |
- 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
207 |
the total number of lines that will be in the scrollback buffer. |
208 |
|
209 |
on_osc_seq $term, $string |
210 |
Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
211 |
operating system command) is processed. Cursor position and other |
212 |
state information is up-to-date when this happens. For |
213 |
interoperability, the string should start with the extension name |
214 |
and a colon, to distinguish it from commands for other extensions, |
215 |
and this might be enforced in the future. |
216 |
|
217 |
Be careful not ever to trust (in a security sense) the data you |
218 |
receive, as its source can not easily be controleld (e-mail content, |
219 |
messages from other users on the same system etc.). |
220 |
|
221 |
on_add_lines $term, $string |
222 |
Called whenever text is about to be output, with the text as |
223 |
argument. You can filter/change and output the text yourself by |
224 |
returning a true value and calling "$term->scr_add_lines" yourself. |
225 |
Please note that this might be very slow, however, as your hook is |
226 |
called for all text being output. |
227 |
|
228 |
on_tt_write $term, $octets |
229 |
Called whenever some data is written to the tty/pty and can be used |
230 |
to suppress or filter tty input. |
231 |
|
232 |
on_line_update $term, $row |
233 |
Called whenever a line was updated or changed. Can be used to filter |
234 |
screen output (e.g. underline urls or other useless stuff). Only |
235 |
lines that are being shown will be filtered, and, due to performance |
236 |
reasons, not always immediately. |
237 |
|
238 |
The row number is always the topmost row of the line if the line |
239 |
spans multiple rows. |
240 |
|
241 |
Please note that, if you change the line, then the hook might get |
242 |
called later with the already-modified line (e.g. if unrelated parts |
243 |
change), so you cannot just toggle rendition bits, but only set |
244 |
them. |
245 |
|
246 |
on_refresh_begin $term |
247 |
Called just before the screen gets redrawn. Can be used for overlay |
248 |
or similar effects by modify terminal contents in refresh_begin, and |
249 |
restoring them in refresh_end. The built-in overlay and selection |
250 |
display code is run after this hook, and takes precedence. |
251 |
|
252 |
on_refresh_end $term |
253 |
Called just after the screen gets redrawn. See "on_refresh_begin". |
254 |
|
255 |
on_keyboard_command $term, $string |
256 |
Called whenever the user presses a key combination that has a |
257 |
"perl:string" action bound to it (see description of the keysym |
258 |
resource in the rxvt(1) manpage). |
259 |
|
260 |
on_focus_in $term |
261 |
Called whenever the window gets the keyboard focus, before |
262 |
rxvt-unicode does focus in processing. |
263 |
|
264 |
on_focus_out $term |
265 |
Called wheneever the window loses keyboard focus, before |
266 |
rxvt-unicode does focus out processing. |
267 |
|
268 |
on_key_press $term, $event, $keysym, $octets |
269 |
on_key_release $term, $event, $keysym |
270 |
on_button_press $term, $event |
271 |
on_button_release $term, $event |
272 |
on_motion_notify $term, $event |
273 |
on_map_notify $term, $event |
274 |
on_unmap_notify $term, $event |
275 |
Called whenever the corresponding X event is received for the |
276 |
terminal If the hook returns true, then the even will be ignored by |
277 |
rxvt-unicode. |
278 |
|
279 |
The event is a hash with most values as named by Xlib (see the |
280 |
XEvent manpage), with the additional members "row" and "col", which |
281 |
are the row and column under the mouse cursor. |
282 |
|
283 |
"on_key_press" additionally receives the string rxvt-unicode would |
284 |
output, if any, in locale-specific encoding. |
285 |
|
286 |
subwindow. |
287 |
|
288 |
Variables in the "urxvt" Package |
289 |
$urxvt::LIBDIR |
290 |
The rxvt-unicode library directory, where, among other things, the |
291 |
perl modules and scripts are stored. |
292 |
|
293 |
$urxvt::RESCLASS, $urxvt::RESCLASS |
294 |
The resource class and name rxvt-unicode uses to look up X |
295 |
resources. |
296 |
|
297 |
$urxvt::RXVTNAME |
298 |
The basename of the installed binaries, usually "urxvt". |
299 |
|
300 |
$urxvt::TERM |
301 |
The current terminal. This variable stores the current "urxvt::term" |
302 |
object, whenever a callback/hook is executing. |
303 |
|
304 |
Functions in the "urxvt" Package |
305 |
urxvt::fatal $errormessage |
306 |
Fatally aborts execution with the given error message. Avoid at all |
307 |
costs! The only time this is acceptable is when the terminal process |
308 |
starts up. |
309 |
|
310 |
urxvt::warn $string |
311 |
Calls "rxvt_warn" with the given string which should not include a |
312 |
newline. The module also overwrites the "warn" builtin with a |
313 |
function that calls this function. |
314 |
|
315 |
Using this function has the advantage that its output ends up in the |
316 |
correct place, e.g. on stderr of the connecting urxvtc client. |
317 |
|
318 |
Messages have a size limit of 1023 bytes currently. |
319 |
|
320 |
$is_safe = urxvt::safe |
321 |
Returns true when it is safe to do potentially unsafe things, such |
322 |
as evaluating perl code specified by the user. This is true when |
323 |
urxvt was started setuid or setgid. |
324 |
|
325 |
$time = urxvt::NOW |
326 |
Returns the "current time" (as per the event loop). |
327 |
|
328 |
urxvt::CurrentTime |
329 |
urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
330 |
Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
331 |
Button5Mask, AnyModifier |
332 |
Various constants for use in X calls and event processing. |
333 |
|
334 |
RENDITION |
335 |
Rendition bitsets contain information about colour, font, font styles |
336 |
and similar information for each screen cell. |
337 |
|
338 |
The following "macros" deal with changes in rendition sets. You should |
339 |
never just create a bitset, you should always modify an existing one, as |
340 |
they contain important information required for correct operation of |
341 |
rxvt-unicode. |
342 |
|
343 |
$rend = urxvt::DEFAULT_RSTYLE |
344 |
Returns the default rendition, as used when the terminal is starting |
345 |
up or being reset. Useful as a base to start when creating |
346 |
renditions. |
347 |
|
348 |
$rend = urxvt::OVERLAY_RSTYLE |
349 |
Return the rendition mask used for overlays by default. |
350 |
|
351 |
$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
352 |
Return the bit that enabled bold, italic, blink, reverse-video and |
353 |
underline, respectively. To enable such a style, just logically OR |
354 |
it into the bitset. |
355 |
|
356 |
$foreground = urxvt::GET_BASEFG $rend |
357 |
$background = urxvt::GET_BASEBG $rend |
358 |
Return the foreground/background colour index, respectively. |
359 |
|
360 |
$rend = urxvt::SET_FGCOLOR $rend, $new_colour |
361 |
$rend = urxvt::SET_BGCOLOR $rend, $new_colour |
362 |
Replace the foreground/background colour in the rendition mask with |
363 |
the specified one. |
364 |
|
365 |
$value = urxvt::GET_CUSTOM $rend |
366 |
Return the "custom" value: Every rendition has 5 bits for use by |
367 |
extensions. They can be set and changed as you like and are |
368 |
initially zero. |
369 |
|
370 |
$rend = urxvt::SET_CUSTOM $rend, $new_value |
371 |
Change the custom value. |
372 |
|
373 |
The "urxvt::anyevent" Class |
374 |
The sole purpose of this class is to deliver an interface to the |
375 |
"AnyEvent" module - any module using it will work inside urxvt without |
376 |
further programming. The only exception is that you cannot wait on |
377 |
condition variables, but non-blocking condvar use is ok. What this means |
378 |
is that you cannot use blocking APIs, but the non-blocking variant |
379 |
should work. |
380 |
|
381 |
The "urxvt::term" Class |
382 |
$term = new urxvt::term $envhashref, $rxvtname, [arg...] |
383 |
Creates a new terminal, very similar as if you had started it with |
384 |
system "$rxvtname, arg...". $envhashref must be a reference to a |
385 |
%ENV-like hash which defines the environment of the new terminal. |
386 |
|
387 |
Croaks (and probably outputs an error message) if the new instance |
388 |
couldn't be created. Returns "undef" if the new instance didn't |
389 |
initialise perl, and the terminal object otherwise. The "init" and |
390 |
"start" hooks will be called during this call. |
391 |
|
392 |
$term->destroy |
393 |
Destroy the terminal object (close the window, free resources etc.). |
394 |
Please note that rxvt will not exit as long as any event watchers |
395 |
(timers, io watchers) are still active. |
396 |
|
397 |
$isset = $term->option ($optval[, $set]) |
398 |
Returns true if the option specified by $optval is enabled, and |
399 |
optionally change it. All option values are stored by name in the |
400 |
hash %urxvt::OPTION. Options not enabled in this binary are not in |
401 |
the hash. |
402 |
|
403 |
Here is a a likely non-exhaustive list of option names, please see |
404 |
the source file /src/optinc.h to see the actual list: |
405 |
|
406 |
borderLess console cursorBlink cursorUnderline hold iconic insecure |
407 |
intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
408 |
pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
409 |
scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
410 |
secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
411 |
tripleclickwords utmpInhibit visualBell |
412 |
|
413 |
$value = $term->resource ($name[, $newval]) |
414 |
Returns the current resource value associated with a given name and |
415 |
optionally sets a new value. Setting values is most useful in the |
416 |
"init" hook. Unset resources are returned and accepted as "undef". |
417 |
|
418 |
The new value must be properly encoded to a suitable character |
419 |
encoding before passing it to this method. Similarly, the returned |
420 |
value may need to be converted from the used encoding to text. |
421 |
|
422 |
Resource names are as defined in src/rsinc.h. Colours can be |
423 |
specified as resource names of the form "color+<index>", e.g. |
424 |
"color+5". (will likely change). |
425 |
|
426 |
Please note that resource strings will currently only be freed when |
427 |
the terminal is destroyed, so changing options frequently will eat |
428 |
memory. |
429 |
|
430 |
Here is a a likely non-exhaustive list of resource names, not all of |
431 |
which are supported in every build, please see the source file |
432 |
/src/rsinc.h to see the actual list: |
433 |
|
434 |
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
435 |
borderLess color cursorBlink cursorUnderline cutchars delete_key |
436 |
display_name embed ext_bwidth fade font geometry hold iconName |
437 |
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
438 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
439 |
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
440 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
441 |
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
442 |
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
443 |
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
444 |
shade term_name title transparent transparent_all tripleclickwords |
445 |
utmpInhibit visualBell |
446 |
|
447 |
$success = $term->parse_keysym ($keysym_spec, $command_string) |
448 |
Adds a keymap translation exactly as specified via a resource. See |
449 |
the "keysym" resource in the rxvt(1) manpage. |
450 |
|
451 |
$rend = $term->rstyle ([$new_rstyle]) |
452 |
Return and optionally change the current rendition. Text that is |
453 |
output by the terminal application will use this style. |
454 |
|
455 |
($row, $col) = $term->screen_cur ([$row, $col]) |
456 |
Return the current coordinates of the text cursor position and |
457 |
optionally set it (which is usually bad as applications don't expect |
458 |
that). |
459 |
|
460 |
($row, $col) = $term->selection_mark ([$row, $col]) |
461 |
($row, $col) = $term->selection_beg ([$row, $col]) |
462 |
($row, $col) = $term->selection_end ([$row, $col]) |
463 |
Return the current values of the selection mark, begin or end |
464 |
positions, and optionally set them to new values. |
465 |
|
466 |
$success = $term->selection_grab ($eventtime) |
467 |
Try to request the primary selection from the server (for example, |
468 |
as set by the next method). |
469 |
|
470 |
$oldtext = $term->selection ([$newtext]) |
471 |
Return the current selection text and optionally replace it by |
472 |
$newtext. |
473 |
|
474 |
$term->overlay_simple ($x, $y, $text) |
475 |
Create a simple multi-line overlay box. See the next method for |
476 |
details. |
477 |
|
478 |
$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
479 |
Create a new (empty) overlay at the given position with the given |
480 |
width/height. $rstyle defines the initial rendition style (default: |
481 |
"OVERLAY_RSTYLE"). |
482 |
|
483 |
If $border is 2 (default), then a decorative border will be put |
484 |
around the box. |
485 |
|
486 |
If either $x or $y is negative, then this is counted from the |
487 |
right/bottom side, respectively. |
488 |
|
489 |
This method returns an urxvt::overlay object. The overlay will be |
490 |
visible as long as the perl object is referenced. |
491 |
|
492 |
The methods currently supported on "urxvt::overlay" objects are: |
493 |
|
494 |
$overlay->set ($x, $y, $text, $rend) |
495 |
Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts |
496 |
text in rxvt-unicode's special encoding and an array of |
497 |
rendition values at a specific position inside the overlay. |
498 |
|
499 |
$overlay->hide |
500 |
If visible, hide the overlay, but do not destroy it. |
501 |
|
502 |
$overlay->show |
503 |
If hidden, display the overlay again. |
504 |
|
505 |
$popup = $term->popup ($event) |
506 |
Creates a new "urxvt::popup" object that implements a popup menu. |
507 |
The $event *must* be the event causing the menu to pop up (a button |
508 |
event, currently). |
509 |
|
510 |
$cellwidth = $term->strwidth ($string) |
511 |
Returns the number of screen-cells this string would need. Correctly |
512 |
accounts for wide and combining characters. |
513 |
|
514 |
$octets = $term->locale_encode ($string) |
515 |
Convert the given text string into the corresponding locale |
516 |
encoding. |
517 |
|
518 |
$string = $term->locale_decode ($octets) |
519 |
Convert the given locale-encoded octets into a perl string. |
520 |
|
521 |
$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
522 |
XORs the rendition values in the given span with the provided value |
523 |
(default: "RS_RVid"). Useful in refresh hooks to provide effects |
524 |
similar to the selection. |
525 |
|
526 |
$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
527 |
$rstyle2]]) |
528 |
Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
529 |
whitespace will additionally be xored with the $rstyle2, which |
530 |
defaults to "RS_RVid | RS_Uline", which removes reverse video again |
531 |
and underlines it instead. |
532 |
|
533 |
$term->scr_bell |
534 |
Ring the bell! |
535 |
|
536 |
$term->scr_add_lines ($string) |
537 |
Write the given text string to the screen, as if output by the |
538 |
application running inside the terminal. It may not contain command |
539 |
sequences (escape codes), but is free to use line feeds, carriage |
540 |
returns and tabs. The string is a normal text string, not in |
541 |
locale-dependent encoding. |
542 |
|
543 |
Normally its not a good idea to use this function, as programs might |
544 |
be confused by changes in cursor position or scrolling. Its useful |
545 |
inside a "on_add_lines" hook, though. |
546 |
|
547 |
$term->cmd_parse ($octets) |
548 |
Similar to "scr_add_lines", but the argument must be in the |
549 |
locale-specific encoding of the terminal and can contain command |
550 |
sequences (escape codes) that will be interpreted. |
551 |
|
552 |
$term->tt_write ($octets) |
553 |
Write the octets given in $data to the tty (i.e. as program input). |
554 |
To pass characters instead of octets, you should convert your |
555 |
strings first to the locale-specific encoding using |
556 |
"$term->locale_encode". |
557 |
|
558 |
$old_events = $term->pty_ev_events ([$new_events]) |
559 |
Replaces the event mask of the pty watcher by the given event mask. |
560 |
Can be used to suppress input and output handling to the pty/tty. |
561 |
See the description of "urxvt::timer->events". Make sure to always |
562 |
restore the previous value. |
563 |
|
564 |
$windowid = $term->parent |
565 |
Return the window id of the toplevel window. |
566 |
|
567 |
$windowid = $term->vt |
568 |
Return the window id of the terminal window. |
569 |
|
570 |
$window_width = $term->width |
571 |
$window_height = $term->height |
572 |
$font_width = $term->fwidth |
573 |
$font_height = $term->fheight |
574 |
$font_ascent = $term->fbase |
575 |
$terminal_rows = $term->nrow |
576 |
$terminal_columns = $term->ncol |
577 |
$has_focus = $term->focus |
578 |
$is_mapped = $term->mapped |
579 |
$max_scrollback = $term->saveLines |
580 |
$nrow_plus_saveLines = $term->total_rows |
581 |
$lines_in_scrollback = $term->nsaved |
582 |
Return various integers describing terminal characteristics. |
583 |
|
584 |
$x_display = $term->display_id |
585 |
Return the DISPLAY used by rxvt-unicode. |
586 |
|
587 |
$lc_ctype = $term->locale |
588 |
Returns the LC_CTYPE category string used by this rxvt-unicode. |
589 |
|
590 |
$env = $term->env |
591 |
Returns a copy of the environment in effect for the terminal as a |
592 |
hashref similar to "\%ENV". |
593 |
|
594 |
$modifiermask = $term->ModLevel3Mask |
595 |
$modifiermask = $term->ModMetaMask |
596 |
$modifiermask = $term->ModNumLockMask |
597 |
Return the modifier masks corresponding to the "ISO Level 3 Shift" |
598 |
(often AltGr), the meta key (often Alt) and the num lock key, if |
599 |
applicable. |
600 |
|
601 |
$view_start = $term->view_start ([$newvalue]) |
602 |
Returns the negative row number of the topmost line. Minimum value |
603 |
is 0, which displays the normal terminal contents. Larger values |
604 |
scroll this many lines into the scrollback buffer. |
605 |
|
606 |
$term->want_refresh |
607 |
Requests a screen refresh. At the next opportunity, rxvt-unicode |
608 |
will compare the on-screen display with its stored representation. |
609 |
If they differ, it redraws the differences. |
610 |
|
611 |
Used after changing terminal contents to display them. |
612 |
|
613 |
$text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
614 |
Returns the text of the entire row with number $row_number. Row 0 is |
615 |
the topmost terminal line, row "$term->$ncol-1" is the bottommost |
616 |
terminal line. The scrollback buffer starts at line -1 and extends |
617 |
to line "-$term->nsaved". Nothing will be returned if a nonexistent |
618 |
line is requested. |
619 |
|
620 |
If $new_text is specified, it will replace characters in the current |
621 |
line, starting at column $start_col (default 0), which is useful to |
622 |
replace only parts of a line. The font index in the rendition will |
623 |
automatically be updated. |
624 |
|
625 |
$text is in a special encoding: tabs and wide characters that use |
626 |
more than one cell when displayed are padded with urxvt::NOCHAR |
627 |
characters ("chr 65535"). Characters with combining characters and |
628 |
other characters that do not fit into the normal tetx encoding will |
629 |
be replaced with characters in the private use area. |
630 |
|
631 |
You have to obey this encoding when changing text. The advantage is |
632 |
that "substr" and similar functions work on screen cells and not on |
633 |
characters. |
634 |
|
635 |
The methods "$term->special_encode" and "$term->special_decode" can |
636 |
be used to convert normal strings into this encoding and vice versa. |
637 |
|
638 |
$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
639 |
Like "$term->ROW_t", but returns an arrayref with rendition bitsets. |
640 |
Rendition bitsets contain information about colour, font, font |
641 |
styles and similar information. See also "$term->ROW_t". |
642 |
|
643 |
When setting rendition, the font mask will be ignored. |
644 |
|
645 |
See the section on RENDITION, above. |
646 |
|
647 |
$length = $term->ROW_l ($row_number[, $new_length]) |
648 |
Returns the number of screen cells that are in use ("the line |
649 |
length"). Unlike the urxvt core, this returns "$term->ncol" if the |
650 |
line is joined with the following one. |
651 |
|
652 |
$bool = $term->is_longer ($row_number) |
653 |
Returns true if the row is part of a multiple-row logical "line" |
654 |
(i.e. joined with the following row), which means all characters are |
655 |
in use and it is continued on the next row (and possibly a |
656 |
continuation of the previous row(s)). |
657 |
|
658 |
$line = $term->line ($row_number) |
659 |
Create and return a new "urxvt::line" object that stores information |
660 |
about the logical line that row $row_number is part of. It supports |
661 |
the following methods: |
662 |
|
663 |
$text = $line->t ([$new_text]) |
664 |
Returns or replaces the full text of the line, similar to |
665 |
"ROW_t" |
666 |
|
667 |
$rend = $line->r ([$new_rend]) |
668 |
Returns or replaces the full rendition array of the line, |
669 |
similar to "ROW_r" |
670 |
|
671 |
$length = $line->l |
672 |
Returns the length of the line in cells, similar to "ROW_l". |
673 |
|
674 |
$rownum = $line->beg |
675 |
$rownum = $line->end |
676 |
Return the row number of the first/last row of the line, |
677 |
respectively. |
678 |
|
679 |
$offset = $line->offset_of ($row, $col) |
680 |
Returns the character offset of the given row|col pair within |
681 |
the logical line. |
682 |
|
683 |
($row, $col) = $line->coord_of ($offset) |
684 |
Translates a string offset into terminal coordinates again. |
685 |
|
686 |
$text = $term->special_encode $string |
687 |
Converts a perl string into the special encoding used by |
688 |
rxvt-unicode, where one character corresponds to one screen cell. |
689 |
See "$term->ROW_t" for details. |
690 |
|
691 |
$string = $term->special_decode $text |
692 |
Converts rxvt-unicodes text reprsentation into a perl string. See |
693 |
"$term->ROW_t" for details. |
694 |
|
695 |
$success = $term->grab_button ($button, $modifiermask) |
696 |
Registers a synchronous button grab. See the XGrabButton manpage. |
697 |
|
698 |
$success = $term->grab ($eventtime[, $sync]) |
699 |
Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
700 |
synchronous ($sync is true). Also remembers the grab timestampe. |
701 |
|
702 |
$term->allow_events_async |
703 |
Calls XAllowEvents with AsyncBoth for the most recent grab. |
704 |
|
705 |
$term->allow_events_sync |
706 |
Calls XAllowEvents with SyncBoth for the most recent grab. |
707 |
|
708 |
$term->allow_events_replay |
709 |
Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for |
710 |
the most recent grab. |
711 |
|
712 |
$term->ungrab |
713 |
Calls XUngrab for the most recent grab. Is called automatically on |
714 |
evaluation errors, as it is better to lose the grab in the error |
715 |
case as the session. |
716 |
|
717 |
The "urxvt::popup" Class |
718 |
$popup->add_title ($title) |
719 |
Adds a non-clickable title to the popup. |
720 |
|
721 |
$popup->add_separator ([$sepchr]) |
722 |
Creates a separator, optionally using the character given as |
723 |
$sepchr. |
724 |
|
725 |
$popup->add_button ($text, $cb) |
726 |
Adds a clickable button to the popup. $cb is called whenever it is |
727 |
selected. |
728 |
|
729 |
$popup->add_toggle ($text, $cb, $initial_value) |
730 |
Adds a toggle/checkbox item to the popup. Teh callback gets called |
731 |
whenever it gets toggled, with a boolean indicating its value as its |
732 |
first argument. |
733 |
|
734 |
$popup->show |
735 |
Displays the popup (which is initially hidden). |
736 |
|
737 |
The "urxvt::timer" Class |
738 |
This class implements timer watchers/events. Time is represented as a |
739 |
fractional number of seconds since the epoch. Example: |
740 |
|
741 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
742 |
$term->{timer} = urxvt::timer |
743 |
->new |
744 |
->interval (1) |
745 |
->cb (sub { |
746 |
$term->{overlay}->set (0, 0, |
747 |
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
748 |
}); |
749 |
|
750 |
$timer = new urxvt::timer |
751 |
Create a new timer object in started state. It is scheduled to fire |
752 |
immediately. |
753 |
|
754 |
$timer = $timer->cb (sub { my ($timer) = @_; ... }) |
755 |
Set the callback to be called when the timer triggers. |
756 |
|
757 |
$tstamp = $timer->at |
758 |
Return the time this watcher will fire next. |
759 |
|
760 |
$timer = $timer->set ($tstamp) |
761 |
Set the time the event is generated to $tstamp. |
762 |
|
763 |
$timer = $timer->interval ($interval) |
764 |
Normally (and when $interval is 0), the timer will automatically |
765 |
stop after it has fired once. If $interval is non-zero, then the |
766 |
timer is automatically rescheduled at the given intervals. |
767 |
|
768 |
$timer = $timer->start |
769 |
Start the timer. |
770 |
|
771 |
$timer = $timer->start ($tstamp) |
772 |
Set the event trigger time to $tstamp and start the timer. |
773 |
|
774 |
$timer = $timer->stop |
775 |
Stop the timer. |
776 |
|
777 |
The "urxvt::iow" Class |
778 |
This class implements io watchers/events. Example: |
779 |
|
780 |
$term->{socket} = ... |
781 |
$term->{iow} = urxvt::iow |
782 |
->new |
783 |
->fd (fileno $term->{socket}) |
784 |
->events (urxvt::EVENT_READ) |
785 |
->start |
786 |
->cb (sub { |
787 |
my ($iow, $revents) = @_; |
788 |
# $revents must be 1 here, no need to check |
789 |
sysread $term->{socket}, my $buf, 8192 |
790 |
or end-of-file; |
791 |
}); |
792 |
|
793 |
$iow = new urxvt::iow |
794 |
Create a new io watcher object in stopped state. |
795 |
|
796 |
$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
797 |
Set the callback to be called when io events are triggered. |
798 |
$reventmask is a bitset as described in the "events" method. |
799 |
|
800 |
$iow = $iow->fd ($fd) |
801 |
Set the filedescriptor (not handle) to watch. |
802 |
|
803 |
$iow = $iow->events ($eventmask) |
804 |
Set the event mask to watch. The only allowed values are |
805 |
"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
806 |
together, or "urxvt::EVENT_NONE". |
807 |
|
808 |
$iow = $iow->start |
809 |
Start watching for requested events on the given handle. |
810 |
|
811 |
$iow = $iow->stop |
812 |
Stop watching for events on the given filehandle. |
813 |
|
814 |
ENVIRONMENT |
815 |
URXVT_PERL_VERBOSITY |
816 |
This variable controls the verbosity level of the perl extension. Higher |
817 |
numbers indicate more verbose output. |
818 |
|
819 |
== 0 - fatal messages |
820 |
>= 3 - script loading and management |
821 |
>=10 - all events received |
822 |
|
823 |
AUTHOR |
824 |
Marc Lehmann <pcg@goof.com> |
825 |
http://software.schmorp.de/pkg/rxvt-unicode |
826 |
|