| 1 | =head1 NAME |
1 | =head1 NAME |
| 2 | |
2 | |
| 3 | rxvtperl - rxvt-unicode's embedded perl interpreter |
3 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
| 4 | |
4 | |
| 5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
| 6 | |
6 | |
| 7 | * Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl/>, they will be loaded automatically. |
7 | # create a file grab_test in $HOME: |
| 8 | |
|
|
| 9 | * Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
|
|
| 10 | thus must be encoded as UTF-8. |
|
|
| 11 | |
8 | |
| 12 | sub on_sel_grab { |
9 | sub on_sel_grab { |
| 13 | warn "you selected ", $_[0]->selection; |
10 | warn "you selected ", $_[0]->selection; |
| 14 | () |
11 | () |
| 15 | } |
12 | } |
| 16 | |
13 | |
| 17 | 1 |
14 | # start a @@RXVT_NAME@@ using it: |
|
|
15 | |
|
|
16 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
| 18 | |
17 | |
| 19 | =head1 DESCRIPTION |
18 | =head1 DESCRIPTION |
| 20 | |
19 | |
| 21 | Everytime a terminal object gets created, scripts specified via the |
20 | Everytime a terminal object gets created, scripts specified via the |
| 22 | C<perl> resource are associated with it. |
21 | C<perl> resource are loaded and associated with it. |
|
|
22 | |
|
|
23 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
24 | thus must be encoded as UTF-8. |
| 23 | |
25 | |
| 24 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
26 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
| 25 | scripts will be shared (But not enabled) for all terminals. |
27 | scripts will be shared (But not enabled) for all terminals. |
| 26 | |
28 | |
| 27 | =head2 General API Considerations |
29 | =head2 General API Considerations |
| … | |
… | |
| 121 | code is run after this hook, and takes precedence. |
123 | code is run after this hook, and takes precedence. |
| 122 | |
124 | |
| 123 | =item on_refresh_end $term |
125 | =item on_refresh_end $term |
| 124 | |
126 | |
| 125 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
127 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
|
|
128 | |
|
|
129 | =item on_keyboard_command $term, $string |
|
|
130 | |
|
|
131 | Called whenever the user presses a key combination that has a |
|
|
132 | C<perl:string> action bound to it (see description of the B<keysym> |
|
|
133 | resource in the @@RXVT_NAME@@(1) manpage). |
| 126 | |
134 | |
| 127 | =back |
135 | =back |
| 128 | |
136 | |
| 129 | =head2 Functions in the C<urxvt> Package |
137 | =head2 Functions in the C<urxvt> Package |
| 130 | |
138 | |
| … | |
… | |
| 382 | Convert the given locale-encoded octets into a perl string. |
390 | Convert the given locale-encoded octets into a perl string. |
| 383 | |
391 | |
| 384 | =item $term->tt_write ($octets) |
392 | =item $term->tt_write ($octets) |
| 385 | |
393 | |
| 386 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
394 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
| 387 | pass characters instead of octets, you should convetr you strings first to |
395 | pass characters instead of octets, you should convert your strings first |
| 388 | the locale-specific encoding using C<< $term->locale_encode >>. |
396 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
397 | |
|
|
398 | =item $nsaved = $term->nsaved |
|
|
399 | |
|
|
400 | Returns the number of lines in the scrollback buffer. |
|
|
401 | |
|
|
402 | =item $view_start = $term->view_start ([$newvalue]) |
|
|
403 | |
|
|
404 | Returns the negative row number of the topmost line. Minimum value is |
|
|
405 | C<0>, which displays the normal terminal contents. Larger values scroll |
|
|
406 | this many lines into the scrollback buffer. |
|
|
407 | |
|
|
408 | =item $text = $term->ROW_t ($row_number[, $new_text]) |
|
|
409 | |
|
|
410 | 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 |
|
|
412 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
413 | line C<< -$term->nsaved >>. |
|
|
414 | |
|
|
415 | If C<$new_text> is specified, it will completely replace the current line. |
|
|
416 | |
|
|
417 | 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 |
|
|
419 | (C<chr 65535>). Characters with combining characters and other characters |
|
|
420 | that do not fit into the normal tetx encoding will be replaced with |
|
|
421 | characters in the private use area. |
|
|
422 | |
|
|
423 | You have to obey this encoding when changing text. The advantage is |
|
|
424 | that C<substr> and similar functions work on screen cells and not on |
|
|
425 | characters. |
|
|
426 | |
|
|
427 | 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. |
|
|
429 | |
|
|
430 | =item $rend = $term->ROW_r ($row_number[, $new_rend]) |
|
|
431 | |
|
|
432 | Like C<< $term->ROW_t >> |
|
|
433 | |
|
|
434 | =item $text = $term->special_encode $string |
|
|
435 | |
|
|
436 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
437 | where one character corresponds to one screen cell. See |
|
|
438 | C<< $term->ROW_t >> for details. |
|
|
439 | |
|
|
440 | =item $string = $term->special_decode $text |
|
|
441 | |
|
|
442 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
443 | C<< $term->ROW_t >> for details. |
| 389 | |
444 | |
| 390 | =back |
445 | =back |
| 391 | |
446 | |
| 392 | =head2 The C<urxvt::timer> Class |
447 | =head2 The C<urxvt::timer> Class |
| 393 | |
448 | |
