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.14 by root, Tue Jan 3 01:15:00 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.
30
31=head2 Prepackaged Extensions
32
33This section describes the extensiosn delivered with this version. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35
36You can activate them like this:
37
38 @@RXVT_NAME@@ -pe <extensionname>
39
40=over 4
41
42=item selection
43
44Miscellaneous selection modifications.
45
46=over 4
47
48=item rot13
49
50Rot-13 the selection when activated. Used via keyboard trigger:
51
52 URxvt.keysym.C-M-r: perl:selection:rot13
53
54=back
55
56=item digital-clock
57
58Displays a very simple digital clock in the upper right corner of the
59window. Illustrates overwriting the refresh callbacks to create your own
60overlays or changes.
61
62=item simple-overlay-clock
63
64Displays a digital clock using the built-in overlay (colourful, useless).
65
66=back
28 67
29=head2 General API Considerations 68=head2 General API Considerations
30 69
31All objects (such as terminals, time watchers etc.) are typical 70All objects (such as terminals, time watchers etc.) are typical
32reference-to-hash objects. The hash can be used to store anything you 71reference-to-hash objects. The hash can be used to store anything you
… …
154correct place, e.g. on stderr of the connecting urxvtc client. 193correct place, e.g. on stderr of the connecting urxvtc client.
155 194
156=item $time = urxvt::NOW 195=item $time = urxvt::NOW
157 196
158Returns 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
159 250
160=cut 251=cut
161 252
162package urxvt; 253package urxvt;
163 254
… …
427terminal 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
428line C<< -$term->nsaved >>. 519line C<< -$term->nsaved >>.
429 520
430If 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
431line, 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
432to 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
433automatically be updated. 524automatically be updated.
434 525
435C<$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
436than one cell when displayed are padded with urxvt::NOCHAR characters 527than one cell when displayed are padded with urxvt::NOCHAR characters
437(C<chr 65535>). Characters with combining characters and other characters 528(C<chr 65535>). Characters with combining characters and other characters
… …
451bitsets. Rendition bitsets contain information about colour, font, font 542bitsets. Rendition bitsets contain information about colour, font, font
452styles and similar information. See also C<< $term->ROW_t >>. 543styles and similar information. See also C<< $term->ROW_t >>.
453 544
454When setting rendition, the font mask will be ignored. 545When setting rendition, the font mask will be ignored.
455 546
456See the section on RENDITION, below. 547See the section on RENDITION, above.
457 548
458=item $length = $term->ROW_l ($row_number[, $new_length]) 549=item $length = $term->ROW_l ($row_number[, $new_length])
459 550
460Returns 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
461it 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
… …
471 562
472Converts rxvt-unicodes text reprsentation into a perl string. See 563Converts rxvt-unicodes text reprsentation into a perl string. See
473C<< $term->ROW_t >> for details. 564C<< $term->ROW_t >> for details.
474 565
475=back 566=back
476
477=head2 RENDITION
478
479Rendition bitsets contain information about colour, font, font styles and
480similar information for each screen cell.
481
482The following "macros" deal with changes in rendition sets. You should
483never just create a bitset, you should always modify an existing one,
484as they contain important information required for correct operation of
485rxvt-unicode.
486
487=over 4
488
489=item $rend = urxvt::DEFAULT_RSTYLE
490
491Returns the default rendition, as used when the terminal is starting up or
492being reset. Useful as a base
493
494=back
495
496=cut
497 567
498=head2 The C<urxvt::timer> Class 568=head2 The C<urxvt::timer> Class
499 569
500This class implements timer watchers/events. Time is represented as a 570This class implements timer watchers/events. Time is represented as a
501fractional 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