|
|
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 (colourful, 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 |
… | |
… | |
154 | correct place, e.g. on stderr of the connecting urxvtc client. |
193 | correct place, e.g. on stderr of the connecting urxvtc client. |
155 | |
194 | |
156 | =item $time = urxvt::NOW |
195 | =item $time = urxvt::NOW |
157 | |
196 | |
158 | Returns the "current time" (as per the event loop). |
197 | Returns the "current time" (as per the event loop). |
|
|
198 | |
|
|
199 | =head2 RENDITION |
|
|
200 | |
|
|
201 | Rendition bitsets contain information about colour, font, font styles and |
|
|
202 | similar information for each screen cell. |
|
|
203 | |
|
|
204 | The following "macros" deal with changes in rendition sets. You should |
|
|
205 | never just create a bitset, you should always modify an existing one, |
|
|
206 | as they contain important information required for correct operation of |
|
|
207 | rxvt-unicode. |
|
|
208 | |
|
|
209 | =over 4 |
|
|
210 | |
|
|
211 | =item $rend = urxvt::DEFAULT_RSTYLE |
|
|
212 | |
|
|
213 | Returns the default rendition, as used when the terminal is starting up or |
|
|
214 | being reset. Useful as a base to start when creating renditions. |
|
|
215 | |
|
|
216 | =item $rend = urxvt::OVERLAY_RSTYLE |
|
|
217 | |
|
|
218 | Return the rendition mask used for overlays by default. |
|
|
219 | |
|
|
220 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
221 | |
|
|
222 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
223 | underline, respectively. To enable such a style, just logically OR it into |
|
|
224 | the bitset. |
|
|
225 | |
|
|
226 | =item $foreground = urxvt::GET_BASEFG $rend |
|
|
227 | |
|
|
228 | =item $background = urxvt::GET_BASEBG $rend |
|
|
229 | |
|
|
230 | Return 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 | |
|
|
236 | Replace the foreground/background colour in the rendition mask with the |
|
|
237 | specified one. |
|
|
238 | |
|
|
239 | =item $value = urxvt::GET_CUSTOM ($rend) |
|
|
240 | |
|
|
241 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
242 | extensions. They can be set and changed as you like and are initially |
|
|
243 | zero. |
|
|
244 | |
|
|
245 | =item $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
246 | |
|
|
247 | Change the custom value. |
|
|
248 | |
|
|
249 | =back |
159 | |
250 | |
160 | =cut |
251 | =cut |
161 | |
252 | |
162 | package urxvt; |
253 | package urxvt; |
163 | |
254 | |
… | |
… | |
393 | |
484 | |
394 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
485 | 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 |
486 | pass characters instead of octets, you should convert your strings first |
396 | to the locale-specific encoding using C<< $term->locale_encode >>. |
487 | to the locale-specific encoding using C<< $term->locale_encode >>. |
397 | |
488 | |
|
|
489 | =item $nrow = $term->nrow |
|
|
490 | |
|
|
491 | =item $ncol = $term->ncol |
|
|
492 | |
|
|
493 | Return the number of rows/columns of the terminal window (i.e. as |
|
|
494 | specified by C<-geometry>, excluding any scrollback). |
|
|
495 | |
398 | =item $nsaved = $term->nsaved |
496 | =item $nsaved = $term->nsaved |
399 | |
497 | |
400 | Returns the number of lines in the scrollback buffer. |
498 | Returns the number of lines in the scrollback buffer. |
401 | |
499 | |
402 | =item $view_start = $term->view_start ([$newvalue]) |
500 | =item $view_start = $term->view_start ([$newvalue]) |
403 | |
501 | |
404 | Returns the negative row number of the topmost line. Minimum value is |
502 | Returns the negative row number of the topmost line. Minimum value is |
405 | C<0>, which displays the normal terminal contents. Larger values scroll |
503 | C<0>, which displays the normal terminal contents. Larger values scroll |
406 | this many lines into the scrollback buffer. |
504 | this many lines into the scrollback buffer. |
407 | |
505 | |
|
|
506 | =item $term->want_refresh |
|
|
507 | |
|
|
508 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
509 | compare the on-screen display with its stored representation. If they |
|
|
510 | differ, it redraws the differences. |
|
|
511 | |
|
|
512 | Used after changing terminal contents to display them. |
|
|
513 | |
408 | =item $text = $term->ROW_t ($row_number[, $new_text]) |
514 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
409 | |
515 | |
410 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
516 | 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 |
517 | 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 |
518 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
413 | line C<< -$term->nsaved >>. |
519 | line C<< -$term->nsaved >>. |
414 | |
520 | |
415 | If C<$new_text> is specified, it will completely replace the current line. |
521 | If C<$new_text> is specified, it will replace characters in the current |
|
|
522 | line, starting at column C<$start_col> (default C<0>), which is useful |
|
|
523 | to replace only parts of a line. The font index in the rendition will |
|
|
524 | automatically be updated. |
416 | |
525 | |
417 | C<$text> is in a special encoding: tabs and wide characters that use more |
526 | 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 |
527 | than one cell when displayed are padded with urxvt::NOCHAR characters |
419 | (C<chr 65535>). Characters with combining characters and other characters |
528 | (C<chr 65535>). Characters with combining characters and other characters |
420 | that do not fit into the normal tetx encoding will be replaced with |
529 | that do not fit into the normal tetx encoding will be replaced with |
… | |
… | |
425 | characters. |
534 | characters. |
426 | |
535 | |
427 | The methods C<< $term->special_encode >> and C<< $term->special_decode >> |
536 | 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. |
537 | can be used to convert normal strings into this encoding and vice versa. |
429 | |
538 | |
430 | =item $rend = $term->ROW_r ($row_number[, $new_rend]) |
539 | =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
431 | |
540 | |
432 | Like C<< $term->ROW_t >> |
541 | Like C<< $term->ROW_t >>, but returns an arrayref with rendition |
|
|
542 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
543 | styles and similar information. See also C<< $term->ROW_t >>. |
|
|
544 | |
|
|
545 | When setting rendition, the font mask will be ignored. |
|
|
546 | |
|
|
547 | See the section on RENDITION, above. |
|
|
548 | |
|
|
549 | =item $length = $term->ROW_l ($row_number[, $new_length]) |
|
|
550 | |
|
|
551 | Returns the number of screen cells that are in use ("the line length"). If |
|
|
552 | it is C<-1>, then the line is part of a multiple-row logical "line", which |
|
|
553 | means all characters are in use and it is continued on the next row. |
433 | |
554 | |
434 | =item $text = $term->special_encode $string |
555 | =item $text = $term->special_encode $string |
435 | |
556 | |
436 | Converts a perl string into the special encoding used by rxvt-unicode, |
557 | Converts a perl string into the special encoding used by rxvt-unicode, |
437 | where one character corresponds to one screen cell. See |
558 | where one character corresponds to one screen cell. See |