--- rxvt-unicode/src/urxvt.pm 2006/01/02 22:23:26 1.12 +++ rxvt-unicode/src/urxvt.pm 2006/01/03 01:41:06 1.16 @@ -24,7 +24,44 @@ thus must be encoded as UTF-8. Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where -scripts will be shared (But not enabled) for all terminals. +scripts will be shared (but not enabled) for all terminals. + +=head1 PACKAGED EXTENSIONS + +This section describes the extensiosn delivered with this version. You can +find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. + +You can activate them like this: + + @@RXVT_NAME@@ -pe + +=over 4 + +=item selection + +Miscellaneous selection modifications. + +=over 4 + +=item rot13 + +Rot-13 the selection when activated. Used via keyboard trigger: + + URxvt.keysym.C-M-r: perl:selection:rot13 + +=back + +=item digital-clock + +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 simple-overlay-clock + +Displays a digital clock using the built-in overlay (colorful, useless). + +=back =head2 General API Considerations @@ -395,6 +432,13 @@ pass characters instead of octets, you should convert your strings first to the locale-specific encoding using C<< $term->locale_encode >>. +=item $nrow = $term->nrow + +=item $ncol = $term->ncol + +Return the number of rows/columns of the terminal window (i.e. as +specified by C<-geometry>, excluding any scrollback). + =item $nsaved = $term->nsaved Returns the number of lines in the scrollback buffer. @@ -405,14 +449,25 @@ C<0>, which displays the normal terminal contents. Larger values scroll this many lines into the scrollback buffer. -=item $text = $term->ROW_t ($row_number[, $new_text]) +=item $term->want_refresh + +Requests a screen refresh. At the next opportunity, rxvt-unicode will +compare the on-screen display with its stored representation. If they +differ, it redraws the differences. + +Used after changing terminal contents to display them. + +=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) Returns the text of the entire row with number C<$row_number>. Row C<0> is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost terminal line. The scrollback buffer starts at line C<-1> and extends to line C<< -$term->nsaved >>. -If C<$new_text> is specified, it will completely replace the current line. +If C<$new_text> is specified, it will replace characters in the current +line, starting at column C<$start_col> (default C<0>), which is useful +to replace only parts of a line. The font iindex in the rendition will +automatically be updated. C<$text> is in a special encoding: tabs and wide characters that use more than one cell when displayed are padded with urxvt::NOCHAR characters @@ -427,9 +482,21 @@ The methods C<< $term->special_encode >> and C<< $term->special_decode >> can be used to convert normal strings into this encoding and vice versa. -=item $rend = $term->ROW_r ($row_number[, $new_rend]) +=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) -Like C<< $term->ROW_t >> +Like C<< $term->ROW_t >>, but returns an arrayref with rendition +bitsets. Rendition bitsets contain information about colour, font, font +styles and similar information. See also C<< $term->ROW_t >>. + +When setting rendition, the font mask will be ignored. + +See the section on RENDITION, below. + +=item $length = $term->ROW_l ($row_number[, $new_length]) + +Returns the number of screen cells that are in use ("the line length"). If +it is C<-1>, then the line is part of a multiple-row logical "line", which +means all characters are in use and it is continued on the next row. =item $text = $term->special_encode $string @@ -444,6 +511,27 @@ =back +=head2 RENDITION + +Rendition bitsets contain information about colour, font, font styles and +similar information for each screen cell. + +The following "macros" deal with changes in rendition sets. You should +never just create a bitset, you should always modify an existing one, +as they contain important information required for correct operation of +rxvt-unicode. + +=over 4 + +=item $rend = urxvt::DEFAULT_RSTYLE + +Returns the default rendition, as used when the terminal is starting up or +being reset. Useful as a base + +=back + +=cut + =head2 The C Class This class implements timer watchers/events. Time is represented as a