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 If
277 the hook returns true, then the even will be ignored by rxvt-unicode.
279 The event is a hash with most values as named by Xlib (see the XEvent
280 manpage), with the additional members C<row> and C<col>, which are the row
281 and column under the mouse cursor.
283 C<on_key_press> additionally receives the string rxvt-unicode would
284 output, if any, in locale-specific encoding.
290 =head2 Variables in the C<urxvt> Package
296 The current terminal. Whenever a callback/Hook is bein executed, this
297 variable stores the current C<urxvt::term> object.
301 =head2 Functions in the C<urxvt> Package
305 =item $term = new urxvt [arg...]
307 Creates a new terminal, very similar as if you had started it with
308 C<system $binfile, arg...>. Croaks (and probably outputs an error message)
309 if the new instance couldn't be created. Returns C<undef> if the new
310 instance didn't initialise perl, and the terminal object otherwise. The
311 C<init> and C<start> hooks will be called during the call.
313 =item urxvt::fatal $errormessage
315 Fatally aborts execution with the given error message. Avoid at all
316 costs! The only time this is acceptable is when the terminal process
319 =item urxvt::warn $string
321 Calls C<rxvt_warn> with the given string which should not include a
322 newline. The module also overwrites the C<warn> builtin with a function
323 that calls this function.
325 Using this function has the advantage that its output ends up in the
326 correct place, e.g. on stderr of the connecting urxvtc client.
328 =item $time = urxvt::NOW
330 Returns the "current time" (as per the event loop).
336 Rendition bitsets contain information about colour, font, font styles and
337 similar information for each screen cell.
339 The following "macros" deal with changes in rendition sets. You should
340 never just create a bitset, you should always modify an existing one,
341 as they contain important information required for correct operation of
346 =item $rend = urxvt::DEFAULT_RSTYLE
348 Returns the default rendition, as used when the terminal is starting up or
349 being reset. Useful as a base to start when creating renditions.
351 =item $rend = urxvt::OVERLAY_RSTYLE
353 Return the rendition mask used for overlays by default.
355 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
357 Return the bit that enabled bold, italic, blink, reverse-video and
358 underline, respectively. To enable such a style, just logically OR it into
361 =item $foreground = urxvt::GET_BASEFG $rend
363 =item $background = urxvt::GET_BASEBG $rend
365 Return the foreground/background colour index, respectively.
367 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
369 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
371 Replace the foreground/background colour in the rendition mask with the
374 =item $value = urxvt::GET_CUSTOM ($rend)
376 Return the "custom" value: Every rendition has 5 bits for use by
377 extensions. They can be set and changed as you like and are initially
380 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
382 Change the custom value.
400 # overwrite perl's warn
401 *CORE::GLOBAL::warn = sub {
402 my $msg = join "", @_;
404 unless $msg =~ /\n$/;
410 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
413 my ($level, $msg) = @_;
414 warn "$msg\n" if $level <= $verbosity;
417 # find on_xxx subs in the package and register them
419 sub register_package($) {
422 for my $htype (0.. $#HOOKNAME) {
423 my $name = $HOOKNAME[$htype];
425 my $ref = $pkg->can ("on_" . lc $name)
428 $TERM->{_hook}[$htype]{$pkg} = $ref;
429 $hook_count[$htype]++
430 or set_should_invoke $htype, 1;
434 my $script_pkg = "script0000";
437 # load a single script into its own package, once only
438 sub script_package($) {
441 $script_pkg{$path} ||= do {
442 my $pkg = "urxvt::" . ($script_pkg++);
444 verbose 3, "loading script '$path' into package '$pkg'";
446 open my $fh, "<:raw", $path
449 my $source = "package $pkg; use strict; use utf8;\n"
450 . "#line 1 \"$path\"\n{\n"
451 . (do { local $/; <$fh> })
454 eval $source or die "$path: $@";
460 our $retval; # return value for urxvt
462 # called by the rxvt core
467 if ($htype == 0) { # INIT
468 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
470 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
471 my @files = grep -f $_, map "$_/$ext", @dirs;
474 register_package script_package $files[0];
476 warn "perl extension '$ext' not found in perl library search path\n";
483 if (my $cb = $TERM->{_hook}[$htype]) {
484 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
489 while (my ($pkg, $cb) = each %$cb) {
491 $TERM->{_pkg}{$pkg} ||= do {
492 my $proxy = bless { }, urxvt::term::proxy::;
493 Scalar::Util::weaken ($proxy->{term} = $TERM);
501 if ($htype == 1) { # DESTROY
502 # remove hooks if unused
503 if (my $hook = $TERM->{_hook}) {
504 for my $htype (0..$#$hook) {
505 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
506 or set_should_invoke $htype, 0;
510 # clear package objects
511 %$_ = () for values %{ $TERM->{_pkg} };
520 sub urxvt::term::proxy::AUTOLOAD {
521 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
522 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
525 sub $urxvt::term::proxy::AUTOLOAD {
527 \$proxy->{term}->$1 (\@_)
530 } or die "FATAL: unable to compile method forwarder: $@";
532 goto &$urxvt::term::proxy::AUTOLOAD;
535 =head2 The C<urxvt::term> Class
541 Destroy the terminal object (close the window, free resources etc.).
543 =item $value = $term->resource ($name[, $newval])
545 Returns the current resource value associated with a given name and
546 optionally sets a new value. Setting values is most useful in the C<init>
547 hook. Unset resources are returned and accepted as C<undef>.
549 The new value must be properly encoded to a suitable character encoding
550 before passing it to this method. Similarly, the returned value may need
551 to be converted from the used encoding to text.
553 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
554 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
557 Please note that resource strings will currently only be freed when the
558 terminal is destroyed, so changing options frequently will eat memory.
560 Here is a a likely non-exhaustive list of resource names, not all of which
561 are supported in every build, please see the source to see the actual
564 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
565 borderLess color cursorBlink cursorUnderline cutchars delete_key
566 display_name embed ext_bwidth fade font geometry hold iconName
567 imFont imLocale inputMethod insecure int_bwidth intensityStyles
568 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
569 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
570 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
571 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
572 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
573 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
574 shade term_name title transparent transparent_all tripleclickwords
575 utmpInhibit visualBell
579 sub urxvt::term::resource($$;$) {
580 my ($self, $name) = (shift, shift);
581 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
582 goto &urxvt::term::_resource;
585 =item $rend = $term->rstyle ([$new_rstyle])
587 Return and optionally change the current rendition. Text that is output by
588 the terminal application will use this style.
590 =item ($row, $col) = $term->screen_cur ([$row, $col])
592 Return the current coordinates of the text cursor position and optionally
593 set it (which is usually bad as applications don't expect that).
595 =item ($row, $col) = $term->selection_mark ([$row, $col])
597 =item ($row, $col) = $term->selection_beg ([$row, $col])
599 =item ($row, $col) = $term->selection_end ([$row, $col])
601 Return the current values of the selection mark, begin or end positions,
602 and optionally set them to new values.
604 =item $success = $term->selection_grab ($eventtime)
606 Try to request the primary selection from the server (for example, as set
609 =item $oldtext = $term->selection ([$newtext])
611 Return the current selection text and optionally replace it by C<$newtext>.
613 #=item $term->overlay ($x, $y, $text)
615 #Create a simple multi-line overlay box. See the next method for details.
619 #sub urxvt::term::scr_overlay {
620 # my ($self, $x, $y, $text) = @_;
622 # my @lines = split /\n/, $text;
625 # for (map $self->strwidth ($_), @lines) {
626 # $w = $_ if $w < $_;
629 # $self->scr_overlay_new ($x, $y, $w, scalar @lines);
630 # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
633 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
635 Create a new (empty) overlay at the given position with the given
636 width/height. C<$rstyle> defines the initial rendition style
637 (default: C<OVERLAY_RSTYLE>).
639 If C<$border> is C<2> (default), then a decorative border will be put
642 If either C<$x> or C<$y> is negative, then this is counted from the
643 right/bottom side, respectively.
645 This method returns an urxvt::overlay object. The overlay will be visible
646 as long as the perl object is referenced.
648 The methods currently supported on C<urxvt::overlay> objects are:
652 =item $overlay->set ($x, $y, $text, $rend)
654 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
655 text in rxvt-unicode's special encoding and an array of rendition values
656 at a specific position inside the overlay.
660 If visible, hide the overlay, but do not destroy it.
664 If hidden, display the overlay again.
668 =item $cellwidth = $term->strwidth ($string)
670 Returns the number of screen-cells this string would need. Correctly
671 accounts for wide and combining characters.
673 =item $octets = $term->locale_encode ($string)
675 Convert the given text string into the corresponding locale encoding.
677 =item $string = $term->locale_decode ($octets)
679 Convert the given locale-encoded octets into a perl string.
681 =item $term->scr_add_lines ($string)
683 Write the given text string to the screen, as if output by the application
684 running inside the terminal. It may not contain command sequences (escape
685 codes), but is free to use line feeds, carriage returns and tabs. The
686 string is a normal text string, not in locale-dependent encoding.
688 Normally its not a good idea to use this function, as programs might be
689 confused by changes in cursor position or scrolling. Its useful inside a
690 C<on_add_lines> hook, though.
692 =item $term->cmd_parse ($octets)
694 Similar to C<scr_add_lines>, but the argument must be in the
695 locale-specific encoding of the terminal and can contain command sequences
696 (escape codes) that will be interpreted.
698 =item $term->tt_write ($octets)
700 Write the octets given in C<$data> to the tty (i.e. as program input). To
701 pass characters instead of octets, you should convert your strings first
702 to the locale-specific encoding using C<< $term->locale_encode >>.
704 =item $windowid = $term->parent
706 Return the window id of the toplevel window.
708 =item $windowid = $term->vt
710 Return the window id of the terminal window.
712 =item $window_width = $term->width
714 =item $window_height = $term->height
716 =item $font_width = $term->fwidth
718 =item $font_height = $term->fheight
720 =item $font_ascent = $term->fbase
722 =item $terminal_rows = $term->nrow
724 =item $terminal_columns = $term->ncol
726 =item $has_focus = $term->focus
728 =item $is_mapped = $term->mapped
730 =item $max_scrollback = $term->saveLines
732 =item $nrow_plus_saveLines = $term->total_rows
734 =item $lines_in_scrollback = $term->nsaved
736 Return various integers describing terminal characteristics.
738 =item $view_start = $term->view_start ([$newvalue])
740 Returns the negative row number of the topmost line. Minimum value is
741 C<0>, which displays the normal terminal contents. Larger values scroll
742 this many lines into the scrollback buffer.
744 =item $term->want_refresh
746 Requests a screen refresh. At the next opportunity, rxvt-unicode will
747 compare the on-screen display with its stored representation. If they
748 differ, it redraws the differences.
750 Used after changing terminal contents to display them.
752 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
754 Returns the text of the entire row with number C<$row_number>. Row C<0>
755 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
756 terminal line. The scrollback buffer starts at line C<-1> and extends to
757 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
760 If C<$new_text> is specified, it will replace characters in the current
761 line, starting at column C<$start_col> (default C<0>), which is useful
762 to replace only parts of a line. The font index in the rendition will
763 automatically be updated.
765 C<$text> is in a special encoding: tabs and wide characters that use more
766 than one cell when displayed are padded with urxvt::NOCHAR characters
767 (C<chr 65535>). Characters with combining characters and other characters
768 that do not fit into the normal tetx encoding will be replaced with
769 characters in the private use area.
771 You have to obey this encoding when changing text. The advantage is
772 that C<substr> and similar functions work on screen cells and not on
775 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
776 can be used to convert normal strings into this encoding and vice versa.
778 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
780 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
781 bitsets. Rendition bitsets contain information about colour, font, font
782 styles and similar information. See also C<< $term->ROW_t >>.
784 When setting rendition, the font mask will be ignored.
786 See the section on RENDITION, above.
788 =item $length = $term->ROW_l ($row_number[, $new_length])
790 Returns the number of screen cells that are in use ("the line
791 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
792 line is joined with the following one.
794 =item $bool = $term->is_longer ($row_number)
796 Returns true if the row is part of a multiple-row logical "line" (i.e.
797 joined with the following row), which means all characters are in use
798 and it is continued on the next row (and possibly a continuation of the
801 =item $line = $term->line ($row_number)
803 Create and return a new C<urxvt::line> object that stores information
804 about the logical line that row C<$row_number> is part of. It supports the
809 =item $text = $line->t ([$new_text])
811 Returns or replaces the full text of the line, similar to C<ROW_t>
813 =item $rend = $line->r ([$new_rend])
815 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
817 =item $length = $line->l
819 Returns the length of the line in cells, similar to C<ROW_l>.
821 =item $rownum = $line->beg
823 =item $rownum = $line->end
825 Return the row number of the first/last row of the line, respectively.
827 =item $offset = $line->offset_of ($row, $col)
829 Returns the character offset of the given row|col pair within the logical
832 =item ($row, $col) = $line->coord_of ($offset)
834 Translates a string offset into terminal coordinates again.
840 sub urxvt::term::line {
841 my ($self, $row) = @_;
843 my $maxrow = $self->nrow - 1;
845 my ($beg, $end) = ($row, $row);
847 --$beg while $self->ROW_is_longer ($beg - 1);
848 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
855 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
864 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
865 for $self->{beg} .. $self->{end};
869 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
878 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
879 for $self->{beg} .. $self->{end};
882 if (defined wantarray) {
884 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
886 $#$rend = $self->{len} - 1;
893 sub urxvt::line::beg { $_[0]{beg} }
894 sub urxvt::line::end { $_[0]{end} }
895 sub urxvt::line::l { $_[0]{len} }
897 sub urxvt::line::offset_of {
898 my ($self, $row, $col) = @_;
900 ($row - $self->{beg}) * $self->{ncol} + $col
903 sub urxvt::line::coord_of {
904 my ($self, $offset) = @_;
909 $offset / $self->{ncol} + $self->{beg},
910 $offset % $self->{ncol}
914 =item ($row, $col) = $line->coord_of ($offset)
915 =item $text = $term->special_encode $string
917 Converts a perl string into the special encoding used by rxvt-unicode,
918 where one character corresponds to one screen cell. See
919 C<< $term->ROW_t >> for details.
921 =item $string = $term->special_decode $text
923 Converts rxvt-unicodes text reprsentation into a perl string. See
924 C<< $term->ROW_t >> for details.
928 =head2 The C<urxvt::timer> Class
930 This class implements timer watchers/events. Time is represented as a
931 fractional number of seconds since the epoch. Example:
933 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
934 $term->{timer} = urxvt::timer
938 $term->{overlay}->set (0, 0,
939 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
944 =item $timer = new urxvt::timer
946 Create a new timer object in started state. It is scheduled to fire
949 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
951 Set the callback to be called when the timer triggers.
953 =item $tstamp = $timer->at
955 Return the time this watcher will fire next.
957 =item $timer = $timer->set ($tstamp)
959 Set the time the event is generated to $tstamp.
961 =item $timer = $timer->interval ($interval)
963 Normally (and when C<$interval> is C<0>), the timer will automatically
964 stop after it has fired once. If C<$interval> is non-zero, then the timer
965 is automatically rescheduled at the given intervals.
967 =item $timer = $timer->start
971 =item $timer = $timer->start ($tstamp)
973 Set the event trigger time to C<$tstamp> and start the timer.
975 =item $timer = $timer->stop
981 =head2 The C<urxvt::iow> Class
983 This class implements io watchers/events. Example:
985 $term->{socket} = ...
986 $term->{iow} = urxvt::iow
988 ->fd (fileno $term->{socket})
989 ->events (1) # wait for read data
992 my ($iow, $revents) = @_;
993 # $revents must be 1 here, no need to check
994 sysread $term->{socket}, my $buf, 8192
1001 =item $iow = new urxvt::iow
1003 Create a new io watcher object in stopped state.
1005 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1007 Set the callback to be called when io events are triggered. C<$reventmask>
1008 is a bitset as described in the C<events> method.
1010 =item $iow = $iow->fd ($fd)
1012 Set the filedescriptor (not handle) to watch.
1014 =item $iow = $iow->events ($eventmask)
1016 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
1017 data, Bit #1 (value C<2>) enables watching for write data.
1019 =item $iow = $iow->start
1021 Start watching for requested events on the given handle.
1023 =item $iow = $iow->stop
1025 Stop watching for events on the given filehandle.
1031 =head2 URXVT_PERL_VERBOSITY
1033 This variable controls the verbosity level of the perl extension. Higher
1034 numbers indicate more verbose output.
1038 =item =0 - only fatal messages
1040 =item =3 - script loading and management
1042 =item =10 - all events received
1048 Marc Lehmann <pcg@goof.com>
1049 http://software.schmorp.de/pkg/rxvt-unicode