--- rxvt-unicode/src/urxvt.pm 2006/01/06 01:16:58 1.34 +++ rxvt-unicode/src/urxvt.pm 2006/01/06 02:58:02 1.36 @@ -62,13 +62,17 @@ Displays a digital clock using the built-in overlay. +=item mark-urls + +Uses per-line filtering (C) to underline urls. + =item example-refresh-hooks Displays a very simple digital clock in the upper right corner of the window. Illustrates overwriting the refresh callbacks to create your own overlays or changes. -=item mark-urls +=item example-filter-input A not very useful example of filtering all text output to the terminal, by underlining all urls that matches a certain regex (i.e. some urls :). It @@ -135,7 +139,10 @@ =item on_init $term Called after a new terminal object has been initialized, but before -windows are created or the command gets run. +windows are created or the command gets run. Most methods are unsafe to +call or deliver senseless data, as terminal size and other characteristics +have not yet been determined. You can safely query and change resources, +though. =item on_reset $term @@ -225,6 +232,20 @@ might be very slow, however, as your hook is called for B text being output. +=item on_line_update $term, $row + +Called whenever a line was updated or changed. Can be used to filter +screen output (e.g. underline urls or other useless stuff). Only lines +that are being shown will be filtered, and, due to performance reasons, +not always immediately. + +The row number is always the topmost row of the line if the line spans +multiple rows. + +Please note that, if you change the line, then the hook might get called +later with the already-modified line (e.g. if unrelated parts change), so +you cannot just toggle rendition bits, but only set them. + =item on_refresh_begin $term Called just before the screen gets redrawn. Can be used for overlay @@ -259,6 +280,14 @@ =over 4 +=item $term = new urxvt [arg...] + +Creates a new terminal, very similar as if you had started it with +C. Croaks (and probably outputs an error message) +if the new instance couldn't be created. Returns C if the new +instance didn't initialise perl, and the terminal object otherwise. The +C and C hooks will be called during the call. + =item urxvt::fatal $errormessage Fatally aborts execution with the given error message. Avoid at all @@ -485,6 +514,10 @@ =over 4 +=item $term->destroy + +Destroy the terminal object (close the window, free resources etc.). + =item $value = $term->resource ($name[, $newval]) Returns the current resource value associated with a given name and @@ -634,6 +667,12 @@ confused by changes in cursor position or scrolling. Its useful inside a C hook, though. +=item $term->cmd_parse ($octets) + +Similar to C, but the argument must be in the +locale-specific encoding of the terminal and can contain command sequences +(escape codes) that will be interpreted. + =item $term->tt_write ($octets) Write the octets given in C<$data> to the tty (i.e. as program input). To @@ -737,13 +776,13 @@ =over 4 -=item $text = $line->t +=item $text = $line->t ([$new_text]) -Returns the full text of the line, similar to C +Returns or replaces the full text of the line, similar to C -=item $rend = $line->r +=item $rend = $line->r ([$new_rend]) -Returns the full rendition array of the line, similar to C +Returns or replaces the full rendition array of the line, similar to C =item $length = $line->l