ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC

1=encoding utf8
2
1=head1 NAME 3=head1 NAME
2 4
3@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
… …
22 24
23Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
25 27
26Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27scripts will be shared (But not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
28 30
29=head1 PACKAGED EXTENSIONS 31=head2 Prepackaged Extensions
30 32
31This section describes the extensiosn delivered with this version. You can 33This section describes the extensiosn delivered with this version. You can
32find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33 35
34You can activate them like this: 36You can activate them like this:
… …
57window. Illustrates overwriting the refresh callbacks to create your own 59window. Illustrates overwriting the refresh callbacks to create your own
58overlays or changes. 60overlays or changes.
59 61
60=item simple-overlay-clock 62=item simple-overlay-clock
61 63
62Displays a digital clock using the built-in overlay (colorful, useless). 64Displays a digital clock using the built-in overlay (colourful, useless).
63 65
64=back 66=back
65 67
66=head2 General API Considerations 68=head2 General API Considerations
67 69
… …
191correct place, e.g. on stderr of the connecting urxvtc client. 193correct place, e.g. on stderr of the connecting urxvtc client.
192 194
193=item $time = urxvt::NOW 195=item $time = urxvt::NOW
194 196
195Returns the "current time" (as per the event loop). 197Returns the "current time" (as per the event loop).
198
199=head2 RENDITION
200
201Rendition bitsets contain information about colour, font, font styles and
202similar information for each screen cell.
203
204The following "macros" deal with changes in rendition sets. You should
205never just create a bitset, you should always modify an existing one,
206as they contain important information required for correct operation of
207rxvt-unicode.
208
209=over 4
210
211=item $rend = urxvt::DEFAULT_RSTYLE
212
213Returns the default rendition, as used when the terminal is starting up or
214being reset. Useful as a base to start when creating renditions.
215
216=item $rend = urxvt::OVERLAY_RSTYLE
217
218Return the rendition mask used for overlays by default.
219
220=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221
222Return the bit that enabled bold, italic, blink, reverse-video and
223underline, respectively. To enable such a style, just logically OR it into
224the bitset.
225
226=item $foreground = urxvt::GET_BASEFG $rend
227
228=item $background = urxvt::GET_BASEBG $rend
229
230Return the foreground/background colour index, respectively.
231
232=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
233
234=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235
236Replace the foreground/background colour in the rendition mask with the
237specified one.
238
239=item $value = urxvt::GET_CUSTOM ($rend)
240
241Return the "custom" value: Every rendition has 5 bits for use by
242extensions. They can be set and changed as you like and are initially
243zero.
244
245=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
246
247Change the custom value.
248
249=back
196 250
197=cut 251=cut
198 252
199package urxvt; 253package urxvt;
200 254
… …
464terminal line. The scrollback buffer starts at line C<-1> and extends to 518terminal line. The scrollback buffer starts at line C<-1> and extends to
465line C<< -$term->nsaved >>. 519line C<< -$term->nsaved >>.
466 520
467If C<$new_text> is specified, it will replace characters in the current 521If C<$new_text> is specified, it will replace characters in the current
468line, starting at column C<$start_col> (default C<0>), which is useful 522line, starting at column C<$start_col> (default C<0>), which is useful
469to replace only parts of a line. The font iindex in the rendition will 523to replace only parts of a line. The font index in the rendition will
470automatically be updated. 524automatically be updated.
471 525
472C<$text> is in a special encoding: tabs and wide characters that use more 526C<$text> is in a special encoding: tabs and wide characters that use more
473than one cell when displayed are padded with urxvt::NOCHAR characters 527than one cell when displayed are padded with urxvt::NOCHAR characters
474(C<chr 65535>). Characters with combining characters and other characters 528(C<chr 65535>). Characters with combining characters and other characters
… …
488bitsets. Rendition bitsets contain information about colour, font, font 542bitsets. Rendition bitsets contain information about colour, font, font
489styles and similar information. See also C<< $term->ROW_t >>. 543styles and similar information. See also C<< $term->ROW_t >>.
490 544
491When setting rendition, the font mask will be ignored. 545When setting rendition, the font mask will be ignored.
492 546
493See the section on RENDITION, below. 547See the section on RENDITION, above.
494 548
495=item $length = $term->ROW_l ($row_number[, $new_length]) 549=item $length = $term->ROW_l ($row_number[, $new_length])
496 550
497Returns the number of screen cells that are in use ("the line length"). If 551Returns the number of screen cells that are in use ("the line length"). If
498it is C<-1>, then the line is part of a multiple-row logical "line", which 552it is C<-1>, then the line is part of a multiple-row logical "line", which
… …
508 562
509Converts rxvt-unicodes text reprsentation into a perl string. See 563Converts rxvt-unicodes text reprsentation into a perl string. See
510C<< $term->ROW_t >> for details. 564C<< $term->ROW_t >> for details.
511 565
512=back 566=back
513
514=head2 RENDITION
515
516Rendition bitsets contain information about colour, font, font styles and
517similar information for each screen cell.
518
519The following "macros" deal with changes in rendition sets. You should
520never just create a bitset, you should always modify an existing one,
521as they contain important information required for correct operation of
522rxvt-unicode.
523
524=over 4
525
526=item $rend = urxvt::DEFAULT_RSTYLE
527
528Returns the default rendition, as used when the terminal is starting up or
529being reset. Useful as a base
530
531=back
532
533=cut
534 567
535=head2 The C<urxvt::timer> Class 568=head2 The C<urxvt::timer> Class
536 569
537This class implements timer watchers/events. Time is represented as a 570This class implements timer watchers/events. Time is represented as a
538fractional number of seconds since the epoch. Example: 571fractional number of seconds since the epoch. Example:

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines