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.12 by root, Mon Jan 2 22:23:26 2006 UTC vs.
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC

… …
23Scripts are compiled in a 'use strict' and 'use utf8' environment, and 23Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24thus must be encoded as UTF-8. 24thus must be encoded as UTF-8.
25 25
26Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 26Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27scripts will be shared (But not enabled) for all terminals. 27scripts will be shared (But not enabled) for all terminals.
28
29=head1 PACKAGED EXTENSIONS
30
31This section describes the extensiosn delivered with this version. You can
32find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33
34You can activate them like this:
35
36 @@RXVT_NAME@@ -pe <extensionname>
37
38=over 4
39
40=item selection
41
42Miscellaneous selection modifications.
43
44=over 4
45
46=item rot13
47
48Rot-13 the selection when activated. Used via keyboard trigger:
49
50 URxvt.keysym.C-M-r: perl:selection:rot13
51
52=back
53
54=item digital-clock
55
56Displays a very simple digital clock in the upper right corner of the
57window. Illustrates overwriting the refresh callbacks to create your own
58overlays or changes.
59
60=item simple-overlay-clock
61
62Displays a digital clock using the built-in overlay (colorful, useless).
63
64=back
28 65
29=head2 General API Considerations 66=head2 General API Considerations
30 67
31All objects (such as terminals, time watchers etc.) are typical 68All objects (such as terminals, time watchers etc.) are typical
32reference-to-hash objects. The hash can be used to store anything you 69reference-to-hash objects. The hash can be used to store anything you
… …
393 430
394Write the octets given in C<$data> to the tty (i.e. as program input). To 431Write the octets given in C<$data> to the tty (i.e. as program input). To
395pass characters instead of octets, you should convert your strings first 432pass characters instead of octets, you should convert your strings first
396to the locale-specific encoding using C<< $term->locale_encode >>. 433to the locale-specific encoding using C<< $term->locale_encode >>.
397 434
435=item $nrow = $term->nrow
436
437=item $ncol = $term->ncol
438
439Return the number of rows/columns of the terminal window (i.e. as
440specified by C<-geometry>, excluding any scrollback).
441
398=item $nsaved = $term->nsaved 442=item $nsaved = $term->nsaved
399 443
400Returns the number of lines in the scrollback buffer. 444Returns the number of lines in the scrollback buffer.
401 445
402=item $view_start = $term->view_start ([$newvalue]) 446=item $view_start = $term->view_start ([$newvalue])
403 447
404Returns the negative row number of the topmost line. Minimum value is 448Returns the negative row number of the topmost line. Minimum value is
405C<0>, which displays the normal terminal contents. Larger values scroll 449C<0>, which displays the normal terminal contents. Larger values scroll
406this many lines into the scrollback buffer. 450this many lines into the scrollback buffer.
407 451
452=item $term->want_refresh
453
454Requests a screen refresh. At the next opportunity, rxvt-unicode will
455compare the on-screen display with its stored representation. If they
456differ, it redraws the differences.
457
458Used after changing terminal contents to display them.
459
408=item $text = $term->ROW_t ($row_number[, $new_text]) 460=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
409 461
410Returns the text of the entire row with number C<$row_number>. Row C<0> 462Returns the text of the entire row with number C<$row_number>. Row C<0>
411is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 463is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
412terminal line. The scrollback buffer starts at line C<-1> and extends to 464terminal line. The scrollback buffer starts at line C<-1> and extends to
413line C<< -$term->nsaved >>. 465line C<< -$term->nsaved >>.
414 466
415If C<$new_text> is specified, it will completely replace the current line. 467If 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
469to replace only parts of a line. The font iindex in the rendition will
470automatically be updated.
416 471
417C<$text> is in a special encoding: tabs and wide characters that use more 472C<$text> is in a special encoding: tabs and wide characters that use more
418than one cell when displayed are padded with urxvt::NOCHAR characters 473than one cell when displayed are padded with urxvt::NOCHAR characters
419(C<chr 65535>). Characters with combining characters and other characters 474(C<chr 65535>). Characters with combining characters and other characters
420that do not fit into the normal tetx encoding will be replaced with 475that do not fit into the normal tetx encoding will be replaced with
… …
425characters. 480characters.
426 481
427The methods C<< $term->special_encode >> and C<< $term->special_decode >> 482The methods C<< $term->special_encode >> and C<< $term->special_decode >>
428can be used to convert normal strings into this encoding and vice versa. 483can be used to convert normal strings into this encoding and vice versa.
429 484
430=item $rend = $term->ROW_r ($row_number[, $new_rend]) 485=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
431 486
432Like C<< $term->ROW_t >> 487Like C<< $term->ROW_t >>, but returns an arrayref with rendition
488bitsets. Rendition bitsets contain information about colour, font, font
489styles and similar information. See also C<< $term->ROW_t >>.
490
491When setting rendition, the font mask will be ignored.
492
493See the section on RENDITION, below.
494
495=item $length = $term->ROW_l ($row_number[, $new_length])
496
497Returns 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
499means all characters are in use and it is continued on the next row.
433 500
434=item $text = $term->special_encode $string 501=item $text = $term->special_encode $string
435 502
436Converts a perl string into the special encoding used by rxvt-unicode, 503Converts a perl string into the special encoding used by rxvt-unicode,
437where one character corresponds to one screen cell. See 504where one character corresponds to one screen cell. See
… …
441 508
442Converts rxvt-unicodes text reprsentation into a perl string. See 509Converts rxvt-unicodes text reprsentation into a perl string. See
443C<< $term->ROW_t >> for details. 510C<< $term->ROW_t >> for details.
444 511
445=back 512=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
446 534
447=head2 The C<urxvt::timer> Class 535=head2 The C<urxvt::timer> Class
448 536
449This class implements timer watchers/events. Time is represented as a 537This class implements timer watchers/events. Time is represented as a
450fractional number of seconds since the epoch. Example: 538fractional number of seconds since the epoch. Example:

Diff Legend

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