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