--- rxvt-unicode/src/urxvt.pm 2006/01/03 01:15:00 1.14 +++ rxvt-unicode/src/urxvt.pm 2006/01/03 02:01:27 1.18 @@ -1,3 +1,5 @@ +=encoding utf8 + =head1 NAME @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter @@ -24,7 +26,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. + +=head2 Prepackaged 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 (colourful, useless). + +=back =head2 General API Considerations @@ -157,6 +196,48 @@ Returns the "current time" (as per the event loop). +=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 to start when creating renditions. + +=item $rend = urxvt::OVERLAY_RSTYLE + +Return the rendition mask used for overlays by default. + +=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline + +Return the bit that enabled bold, italic, blink, reverse-video and +underline, respectively. To enable such a style, just or it onto the +bitset. + +=item $foreground = urxvt::GET_BASEFG $rend + +=item $background = urxvt::GET_BASEBG $rend + +Return the foreground/background colour index, respectively. + +=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) + +=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) + +Replace the foreground/background colour in the rendition mask with the +specified one. + +=back + =cut package urxvt; @@ -429,7 +510,7 @@ 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 +to replace only parts of a line. The font index in the rendition will automatically be updated. C<$text> is in a special encoding: tabs and wide characters that use more @@ -453,7 +534,7 @@ When setting rendition, the font mask will be ignored. -See the section on RENDITION, below. +See the section on RENDITION, above. =item $length = $term->ROW_l ($row_number[, $new_length]) @@ -474,27 +555,6 @@ =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