5 @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
9 # create a file grab_test in $HOME:
12 warn "you selected ", $_[0]->selection;
16 # start a @@RXVT_NAME@@ using it:
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
22 Everytime a terminal object gets created, scripts specified via the
23 C<perl> resource are loaded and associated with it.
25 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26 thus must be encoded as UTF-8.
28 Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29 scripts will be shared (but not enabled) for all terminals.
31 =head2 Prepackaged Extensions
33 This section describes the extensiosn delivered with this version. You can
34 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
36 You can activate them like this:
38 @@RXVT_NAME@@ -pe <extensionname>
44 Intelligent selection. This extension tries to be more intelligent when
45 the user extends selections (double-click). Right now, it tries to select
46 urls and complete shell-quoted arguments, which is very convenient, too,
47 if your F<ls> supports C<--quoting-style=shell>.
49 It also offers the following bindable event:
55 Rot-13 the selection when activated. Used via keyboard trigger:
57 URxvt.keysym.C-M-r: perl:selection:rot13
63 Displays a digital clock using the built-in overlay.
67 Uses per-line filtering (C<on_line_update>) to underline urls.
69 =item example-refresh-hooks
71 Displays a very simple digital clock in the upper right corner of the
72 window. Illustrates overwriting the refresh callbacks to create your own
75 =item example-filter-input
77 A not very useful example of filtering all text output to the terminal, by
78 underlining all urls that matches a certain regex (i.e. some urls :). It
79 is not very useful because urls that are output in multiple steps (e.g.
80 when typing them) do not get marked.
84 =head2 General API Considerations
86 All objects (such as terminals, time watchers etc.) are typical
87 reference-to-hash objects. The hash can be used to store anything you
88 like. All members starting with an underscore (such as C<_ptr> or
89 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
92 When objects are destroyed on the C++ side, the perl object hashes are
93 emptied, so its best to store related objects such as time watchers and
94 the like inside the terminal object so they get destroyed as soon as the
95 terminal is destroyed.
97 Argument names also often indicate the type of a parameter. Here are some
98 hints on what they mean:
104 Rxvt-unicodes special way of encoding text, where one "unicode" character
105 always represents one screen cell. See L<row_t> for a discussion of this format.
109 A perl text string, with an emphasis on I<text>. It can store all unicode
110 characters and is to be distinguished with text encoded in a specific
111 encoding (often locale-specific) and binary data.
115 Either binary data or - more common - a text string encoded in a
122 The following subroutines can be declared in loaded scripts, and will be
123 called whenever the relevant event happens.
125 The first argument passed to them is an object private to each terminal
126 and extension package. You can call all C<urxvt::term> methods on it, but
127 its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128 object that is shared between all packages is stored in the C<term>
131 All of them must return a boolean value. If it is true, then the event
132 counts as being I<consumed>, and the invocation of other hooks is skipped,
133 and the relevant action might not be carried out by the C++ code.
135 When in doubt, return a false value (preferably C<()>).
141 Called after a new terminal object has been initialized, but before
142 windows are created or the command gets run. Most methods are unsafe to
143 call or deliver senseless data, as terminal size and other characteristics
144 have not yet been determined. You can safely query and change resources,
149 Called after the screen is "reset" for any reason, such as resizing or
150 control sequences. Here is where you can react on changes to size-related
155 Called at the very end of initialisation of a new terminal, just before
156 returning to the mainloop.
158 =item on_sel_make $term, $eventtime
160 Called whenever a selection has been made by the user, but before the
161 selection text is copied, so changes to the beginning, end or type of the
162 selection will be honored.
164 Returning a true value aborts selection making by urxvt, in which case you
165 have to make a selection yourself by calling C<< $term->selection_grab >>.
167 =item on_sel_grab $term, $eventtime
169 Called whenever a selection has been copied, but before the selection is
170 requested from the server. The selection text can be queried and changed
171 by calling C<< $term->selection >>.
173 Returning a true value aborts selection grabbing. It will still be hilighted.
175 =item on_sel_extend $term
177 Called whenever the user tries to extend the selection (e.g. with a double
178 click) and is either supposed to return false (normal operation), or
179 should extend the selection itelf and return true to suppress the built-in
182 See the F<selection> example extension.
184 =item on_focus_in $term
186 Called whenever the window gets the keyboard focus, before urxvt does
189 =item on_focus_out $term
191 Called wheneever the window loses keyboard focus, before urxvt does focus
194 =item on_view_change $term, $offset
196 Called whenever the view offset changes, i..e the user or program
197 scrolls. Offset C<0> means display the normal terminal, positive values
198 show this many lines of scrollback.
200 =item on_scroll_back $term, $lines, $saved
202 Called whenever lines scroll out of the terminal area into the scrollback
203 buffer. C<$lines> is the number of lines scrolled out and may be larger
204 than the scroll back buffer or the terminal.
206 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208 number of lines that will be in the scrollback buffer.
210 =item on_tty_activity $term *NYI*
212 Called whenever the program(s) running in the urxvt window send output.
214 =item on_osc_seq $term, $string
216 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217 operating system command) is processed. Cursor position and other state
218 information is up-to-date when this happens. For interoperability, the
219 string should start with the extension name and a colon, to distinguish
220 it from commands for other extensions, and this might be enforced in the
223 Be careful not ever to trust (in a security sense) the data you receive,
224 as its source can not easily be controleld (e-mail content, messages from
225 other users on the same system etc.).
227 =item on_add_lines $term, $string
229 Called whenever text is about to be output, with the text as argument. You
230 can filter/change and output the text yourself by returning a true value
231 and calling C<< $term->scr_add_lines >> yourself. Please note that this
232 might be very slow, however, as your hook is called for B<all> text being
235 =item on_line_update $term, $row
237 Called whenever a line was updated or changed. Can be used to filter
238 screen output (e.g. underline urls or other useless stuff). Only lines
239 that are being shown will be filtered, and, due to performance reasons,
240 not always immediately.
242 The row number is always the topmost row of the line if the line spans
245 Please note that, if you change the line, then the hook might get called
246 later with the already-modified line (e.g. if unrelated parts change), so
247 you cannot just toggle rendition bits, but only set them.
249 =item on_refresh_begin $term
251 Called just before the screen gets redrawn. Can be used for overlay
252 or similar effects by modify terminal contents in refresh_begin, and
253 restoring them in refresh_end. The built-in overlay and selection display
254 code is run after this hook, and takes precedence.
256 =item on_refresh_end $term
258 Called just after the screen gets redrawn. See C<on_refresh_begin>.
260 =item on_keyboard_command $term, $string
262 Called whenever the user presses a key combination that has a
263 C<perl:string> action bound to it (see description of the B<keysym>
264 resource in the @@RXVT_NAME@@(1) manpage).
266 =item on_key_press $term, $event, $octets
268 =item on_key_release $term, $event
270 =item on_button_press $term, $event
272 =item on_button_release $term, $event
274 =item on_motion_notify $term, $event
276 Called whenever the corresponding X event is received for the terminal
277 (see the XEvent manpage) If the hook returns true, then the even will be
278 ignored by rxvt-unicode.
280 C<on_key_press> additionally receives the string rxvt-unicode would
281 output, if any, in locale-specific encoding.
287 =head2 Variables in the C<urxvt> Package
293 The current terminal. Whenever a callback/Hook is bein executed, this
294 variable stores the current C<urxvt::term> object.
298 =head2 Functions in the C<urxvt> Package
302 =item $term = new urxvt [arg...]
304 Creates a new terminal, very similar as if you had started it with
305 C<system $binfile, arg...>. Croaks (and probably outputs an error message)
306 if the new instance couldn't be created. Returns C<undef> if the new
307 instance didn't initialise perl, and the terminal object otherwise. The
308 C<init> and C<start> hooks will be called during the call.
310 =item urxvt::fatal $errormessage
312 Fatally aborts execution with the given error message. Avoid at all
313 costs! The only time this is acceptable is when the terminal process
316 =item urxvt::warn $string
318 Calls C<rxvt_warn> with the given string which should not include a
319 newline. The module also overwrites the C<warn> builtin with a function
320 that calls this function.
322 Using this function has the advantage that its output ends up in the
323 correct place, e.g. on stderr of the connecting urxvtc client.
325 =item $time = urxvt::NOW
327 Returns the "current time" (as per the event loop).
333 Rendition bitsets contain information about colour, font, font styles and
334 similar information for each screen cell.
336 The following "macros" deal with changes in rendition sets. You should
337 never just create a bitset, you should always modify an existing one,
338 as they contain important information required for correct operation of
343 =item $rend = urxvt::DEFAULT_RSTYLE
345 Returns the default rendition, as used when the terminal is starting up or
346 being reset. Useful as a base to start when creating renditions.
348 =item $rend = urxvt::OVERLAY_RSTYLE
350 Return the rendition mask used for overlays by default.
352 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
354 Return the bit that enabled bold, italic, blink, reverse-video and
355 underline, respectively. To enable such a style, just logically OR it into
358 =item $foreground = urxvt::GET_BASEFG $rend
360 =item $background = urxvt::GET_BASEBG $rend
362 Return the foreground/background colour index, respectively.
364 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
366 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
368 Replace the foreground/background colour in the rendition mask with the
371 =item $value = urxvt::GET_CUSTOM ($rend)
373 Return the "custom" value: Every rendition has 5 bits for use by
374 extensions. They can be set and changed as you like and are initially
377 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
379 Change the custom value.
397 # overwrite perl's warn
398 *CORE::GLOBAL::warn = sub {
399 my $msg = join "", @_;
401 unless $msg =~ /\n$/;
407 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410 my ($level, $msg) = @_;
411 warn "$msg\n" if $level <= $verbosity;
414 # find on_xxx subs in the package and register them
416 sub register_package($) {
419 for my $htype (0.. $#HOOKNAME) {
420 my $name = $HOOKNAME[$htype];
422 my $ref = $pkg->can ("on_" . lc $name)
425 $TERM->{_hook}[$htype]{$pkg} = $ref;
426 $hook_count[$htype]++
427 or set_should_invoke $htype, 1;
431 my $script_pkg = "script0000";
434 # load a single script into its own package, once only
435 sub script_package($) {
438 $script_pkg{$path} ||= do {
439 my $pkg = "urxvt::" . ($script_pkg++);
441 verbose 3, "loading script '$path' into package '$pkg'";
443 open my $fh, "<:raw", $path
446 my $source = "package $pkg; use strict; use utf8;\n"
447 . "#line 1 \"$path\"\n{\n"
448 . (do { local $/; <$fh> })
451 eval $source or die "$path: $@";
457 our $retval; # return value for urxvt
459 # called by the rxvt core
464 if ($htype == 0) { # INIT
465 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
467 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
468 my @files = grep -f $_, map "$_/$ext", @dirs;
471 register_package script_package $files[0];
473 warn "perl extension '$ext' not found in perl library search path\n";
480 if (my $cb = $TERM->{_hook}[$htype]) {
481 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
486 while (my ($pkg, $cb) = each %$cb) {
488 $TERM->{_pkg}{$pkg} ||= do {
489 my $proxy = bless { }, urxvt::term::proxy::;
490 Scalar::Util::weaken ($proxy->{term} = $TERM);
498 if ($htype == 1) { # DESTROY
499 # remove hooks if unused
500 if (my $hook = $TERM->{_hook}) {
501 for my $htype (0..$#$hook) {
502 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
503 or set_should_invoke $htype, 0;
507 # clear package objects
508 %$_ = () for values %{ $TERM->{_pkg} };
517 sub urxvt::term::proxy::AUTOLOAD {
518 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
519 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
522 sub $urxvt::term::proxy::AUTOLOAD {
524 \$proxy->{term}->$1 (\@_)
527 } or die "FATAL: unable to compile method forwarder: $@";
529 goto &$urxvt::term::proxy::AUTOLOAD;
532 =head2 The C<urxvt::term> Class
538 Destroy the terminal object (close the window, free resources etc.).
540 =item $value = $term->resource ($name[, $newval])
542 Returns the current resource value associated with a given name and
543 optionally sets a new value. Setting values is most useful in the C<init>
544 hook. Unset resources are returned and accepted as C<undef>.
546 The new value must be properly encoded to a suitable character encoding
547 before passing it to this method. Similarly, the returned value may need
548 to be converted from the used encoding to text.
550 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
551 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
554 Please note that resource strings will currently only be freed when the
555 terminal is destroyed, so changing options frequently will eat memory.
557 Here is a a likely non-exhaustive list of resource names, not all of which
558 are supported in every build, please see the source to see the actual
561 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562 borderLess color cursorBlink cursorUnderline cutchars delete_key
563 display_name embed ext_bwidth fade font geometry hold iconName
564 imFont imLocale inputMethod insecure int_bwidth intensityStyles
565 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
566 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
567 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
568 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
569 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
570 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
571 shade term_name title transparent transparent_all tripleclickwords
572 utmpInhibit visualBell
576 sub urxvt::term::resource($$;$) {
577 my ($self, $name) = (shift, shift);
578 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
579 goto &urxvt::term::_resource;
582 =item $rend = $term->rstyle ([$new_rstyle])
584 Return and optionally change the current rendition. Text that is output by
585 the terminal application will use this style.
587 =item ($row, $col) = $term->screen_cur ([$row, $col])
589 Return the current coordinates of the text cursor position and optionally
590 set it (which is usually bad as applications don't expect that).
592 =item ($row, $col) = $term->selection_mark ([$row, $col])
594 =item ($row, $col) = $term->selection_beg ([$row, $col])
596 =item ($row, $col) = $term->selection_end ([$row, $col])
598 Return the current values of the selection mark, begin or end positions,
599 and optionally set them to new values.
601 =item $success = $term->selection_grab ($eventtime)
603 Try to request the primary selection from the server (for example, as set
606 =item $oldtext = $term->selection ([$newtext])
608 Return the current selection text and optionally replace it by C<$newtext>.
610 #=item $term->overlay ($x, $y, $text)
612 #Create a simple multi-line overlay box. See the next method for details.
616 #sub urxvt::term::scr_overlay {
617 # my ($self, $x, $y, $text) = @_;
619 # my @lines = split /\n/, $text;
622 # for (map $self->strwidth ($_), @lines) {
623 # $w = $_ if $w < $_;
626 # $self->scr_overlay_new ($x, $y, $w, scalar @lines);
627 # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
630 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
632 Create a new (empty) overlay at the given position with the given
633 width/height. C<$rstyle> defines the initial rendition style
634 (default: C<OVERLAY_RSTYLE>).
636 If C<$border> is C<2> (default), then a decorative border will be put
639 If either C<$x> or C<$y> is negative, then this is counted from the
640 right/bottom side, respectively.
642 This method returns an urxvt::overlay object. The overlay will be visible
643 as long as the perl object is referenced.
645 The methods currently supported on C<urxvt::overlay> objects are:
649 =item $overlay->set ($x, $y, $text, $rend)
651 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
652 text in rxvt-unicode's special encoding and an array of rendition values
653 at a specific position inside the overlay.
657 If visible, hide the overlay, but do not destroy it.
661 If hidden, display the overlay again.
665 =item $cellwidth = $term->strwidth $string
667 Returns the number of screen-cells this string would need. Correctly
668 accounts for wide and combining characters.
670 =item $octets = $term->locale_encode $string
672 Convert the given text string into the corresponding locale encoding.
674 =item $string = $term->locale_decode $octets
676 Convert the given locale-encoded octets into a perl string.
678 =item $term->scr_add_lines ($string)
680 Write the given text string to the screen, as if output by the application
681 running inside the terminal. It may not contain command sequences (escape
682 codes), but is free to use line feeds, carriage returns and tabs. The
683 string is a normal text string, not in locale-dependent encoding.
685 Normally its not a good idea to use this function, as programs might be
686 confused by changes in cursor position or scrolling. Its useful inside a
687 C<on_add_lines> hook, though.
689 =item $term->cmd_parse ($octets)
691 Similar to C<scr_add_lines>, but the argument must be in the
692 locale-specific encoding of the terminal and can contain command sequences
693 (escape codes) that will be interpreted.
695 =item $term->tt_write ($octets)
697 Write the octets given in C<$data> to the tty (i.e. as program input). To
698 pass characters instead of octets, you should convert your strings first
699 to the locale-specific encoding using C<< $term->locale_encode >>.
701 =item $window_width = $term->width
703 =item $window_height = $term->height
705 =item $font_width = $term->fwidth
707 =item $font_height = $term->fheight
709 =item $font_ascent = $term->fbase
711 =item $terminal_rows = $term->nrow
713 =item $terminal_columns = $term->ncol
715 =item $has_focus = $term->focus
717 =item $is_mapped = $term->mapped
719 =item $max_scrollback = $term->saveLines
721 =item $nrow_plus_saveLines = $term->total_rows
723 =item $lines_in_scrollback = $term->nsaved
725 Return various integers describing terminal characteristics.
727 =item $view_start = $term->view_start ([$newvalue])
729 Returns the negative row number of the topmost line. Minimum value is
730 C<0>, which displays the normal terminal contents. Larger values scroll
731 this many lines into the scrollback buffer.
733 =item $term->want_refresh
735 Requests a screen refresh. At the next opportunity, rxvt-unicode will
736 compare the on-screen display with its stored representation. If they
737 differ, it redraws the differences.
739 Used after changing terminal contents to display them.
741 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
743 Returns the text of the entire row with number C<$row_number>. Row C<0>
744 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
745 terminal line. The scrollback buffer starts at line C<-1> and extends to
746 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
749 If C<$new_text> is specified, it will replace characters in the current
750 line, starting at column C<$start_col> (default C<0>), which is useful
751 to replace only parts of a line. The font index in the rendition will
752 automatically be updated.
754 C<$text> is in a special encoding: tabs and wide characters that use more
755 than one cell when displayed are padded with urxvt::NOCHAR characters
756 (C<chr 65535>). Characters with combining characters and other characters
757 that do not fit into the normal tetx encoding will be replaced with
758 characters in the private use area.
760 You have to obey this encoding when changing text. The advantage is
761 that C<substr> and similar functions work on screen cells and not on
764 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
765 can be used to convert normal strings into this encoding and vice versa.
767 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
769 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
770 bitsets. Rendition bitsets contain information about colour, font, font
771 styles and similar information. See also C<< $term->ROW_t >>.
773 When setting rendition, the font mask will be ignored.
775 See the section on RENDITION, above.
777 =item $length = $term->ROW_l ($row_number[, $new_length])
779 Returns the number of screen cells that are in use ("the line
780 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
781 line is joined with the following one.
783 =item $bool = $term->is_longer ($row_number)
785 Returns true if the row is part of a multiple-row logical "line" (i.e.
786 joined with the following row), which means all characters are in use
787 and it is continued on the next row (and possibly a continuation of the
790 =item $line = $term->line ($row_number)
792 Create and return a new C<urxvt::line> object that stores information
793 about the logical line that row C<$row_number> is part of. It supports the
798 =item $text = $line->t ([$new_text])
800 Returns or replaces the full text of the line, similar to C<ROW_t>
802 =item $rend = $line->r ([$new_rend])
804 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
806 =item $length = $line->l
808 Returns the length of the line in cells, similar to C<ROW_l>.
810 =item $rownum = $line->beg
812 =item $rownum = $line->end
814 Return the row number of the first/last row of the line, respectively.
816 =item $offset = $line->offset_of ($row, $col)
818 Returns the character offset of the given row|col pair within the logical
821 =item ($row, $col) = $line->coord_of ($offset)
823 Translates a string offset into terminal coordinates again.
829 sub urxvt::term::line {
830 my ($self, $row) = @_;
832 my $maxrow = $self->nrow - 1;
834 my ($beg, $end) = ($row, $row);
836 --$beg while $self->ROW_is_longer ($beg - 1);
837 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
844 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
853 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
854 for $self->{beg} .. $self->{end};
858 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
867 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
868 for $self->{beg} .. $self->{end};
871 if (defined wantarray) {
873 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
875 $#$rend = $self->{len} - 1;
882 sub urxvt::line::beg { $_[0]{beg} }
883 sub urxvt::line::end { $_[0]{end} }
884 sub urxvt::line::l { $_[0]{len} }
886 sub urxvt::line::offset_of {
887 my ($self, $row, $col) = @_;
889 ($row - $self->{beg}) * $self->{ncol} + $col
892 sub urxvt::line::coord_of {
893 my ($self, $offset) = @_;
898 $offset / $self->{ncol} + $self->{beg},
899 $offset % $self->{ncol}
903 =item ($row, $col) = $line->coord_of ($offset)
904 =item $text = $term->special_encode $string
906 Converts a perl string into the special encoding used by rxvt-unicode,
907 where one character corresponds to one screen cell. See
908 C<< $term->ROW_t >> for details.
910 =item $string = $term->special_decode $text
912 Converts rxvt-unicodes text reprsentation into a perl string. See
913 C<< $term->ROW_t >> for details.
917 =head2 The C<urxvt::timer> Class
919 This class implements timer watchers/events. Time is represented as a
920 fractional number of seconds since the epoch. Example:
922 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
923 $term->{timer} = urxvt::timer
927 $term->{overlay}->set (0, 0,
928 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
933 =item $timer = new urxvt::timer
935 Create a new timer object in started state. It is scheduled to fire
938 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
940 Set the callback to be called when the timer triggers.
942 =item $tstamp = $timer->at
944 Return the time this watcher will fire next.
946 =item $timer = $timer->set ($tstamp)
948 Set the time the event is generated to $tstamp.
950 =item $timer = $timer->interval ($interval)
952 Normally (and when C<$interval> is C<0>), the timer will automatically
953 stop after it has fired once. If C<$interval> is non-zero, then the timer
954 is automatically rescheduled at the given intervals.
956 =item $timer = $timer->start
960 =item $timer = $timer->start ($tstamp)
962 Set the event trigger time to C<$tstamp> and start the timer.
964 =item $timer = $timer->stop
970 =head2 The C<urxvt::iow> Class
972 This class implements io watchers/events. Example:
974 $term->{socket} = ...
975 $term->{iow} = urxvt::iow
977 ->fd (fileno $term->{socket})
978 ->events (1) # wait for read data
981 my ($iow, $revents) = @_;
982 # $revents must be 1 here, no need to check
983 sysread $term->{socket}, my $buf, 8192
990 =item $iow = new urxvt::iow
992 Create a new io watcher object in stopped state.
994 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
996 Set the callback to be called when io events are triggered. C<$reventmask>
997 is a bitset as described in the C<events> method.
999 =item $iow = $iow->fd ($fd)
1001 Set the filedescriptor (not handle) to watch.
1003 =item $iow = $iow->events ($eventmask)
1005 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
1006 data, Bit #1 (value C<2>) enables watching for write data.
1008 =item $iow = $iow->start
1010 Start watching for requested events on the given handle.
1012 =item $iow = $iow->stop
1014 Stop watching for events on the given filehandle.
1020 =head2 URXVT_PERL_VERBOSITY
1022 This variable controls the verbosity level of the perl extension. Higher
1023 numbers indicate more verbose output.
1027 =item =0 - only fatal messages
1029 =item =3 - script loading and management
1031 =item =10 - all events received
1037 Marc Lehmann <pcg@goof.com>
1038 http://software.schmorp.de/pkg/rxvt-unicode