| 1 | =encoding utf8 |
1 | =encoding utf8 |
| 2 | |
2 | |
| 3 | =head1 NAME |
3 | =head1 NAME |
| 4 | |
4 | |
| 5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
| 6 | |
6 | |
| 7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
| 8 | |
8 | |
| 9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in $HOME: |
| 10 | |
10 | |
| 11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
| 12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
| 13 | () |
13 | () |
| 14 | } |
14 | } |
| 15 | |
15 | |
| 16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt using it: |
| 17 | |
17 | |
| 18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib $HOME -pe grab_test |
| 19 | |
19 | |
| 20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
| 21 | |
21 | |
| 22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
| 23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
| 24 | |
24 | |
| 25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
| 26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
| 27 | |
27 | |
| 28 | 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 urxvtd, where |
| 29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
| 30 | |
30 | |
| 31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
| 32 | and "perl-ext-common" resources to the empty string. |
32 | and "perl-ext-common" resources to the empty string. |
| 33 | |
33 | |
| 34 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
| 35 | |
35 | |
| 36 | A number of extensions are delivered with this release. You can find them |
36 | A number of extensions are delivered with this release. You can find them |
| 37 | in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed |
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
| 38 | using F<< man urxvt-<EXTENSIONNAME> >>. |
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
| 39 | |
39 | |
| 40 | You can activate them like this: |
40 | You can activate them like this: |
| 41 | |
41 | |
| 42 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
| 43 | |
43 | |
| 44 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
| 45 | |
45 | |
| 46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
| 47 | |
47 | |
| … | |
… | |
| 285 | |
285 | |
| 286 | =item on_user_command $term, $string |
286 | =item on_user_command $term, $string |
| 287 | |
287 | |
| 288 | Called whenever a user-configured event is being activated (e.g. via |
288 | Called whenever a user-configured event is being activated (e.g. via |
| 289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| 290 | resource in the @@RXVT_NAME@@(1) manpage). |
290 | resource in the urxvt(1) manpage). |
| 291 | |
291 | |
| 292 | The event is simply the action string. This interface is assumed to change |
292 | The event is simply the action string. This interface is assumed to change |
| 293 | slightly in the future. |
293 | slightly in the future. |
| 294 | |
294 | |
| 295 | =item on_register_command $term, $keysym, $modifiermask, $string |
295 | =item on_register_command $term, $keysym, $modifiermask, $string |
| … | |
… | |
| 1126 | } |
1126 | } |
| 1127 | |
1127 | |
| 1128 | =item $term->destroy |
1128 | =item $term->destroy |
| 1129 | |
1129 | |
| 1130 | Destroy the terminal object (close the window, free resources |
1130 | Destroy the terminal object (close the window, free resources |
| 1131 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1131 | etc.). Please note that urxvt will not exit as long as any event |
| 1132 | watchers (timers, io watchers) are still active. |
1132 | watchers (timers, io watchers) are still active. |
| 1133 | |
1133 | |
| 1134 | =item $term->exec_async ($cmd[, @args]) |
1134 | =item $term->exec_async ($cmd[, @args]) |
| 1135 | |
1135 | |
| 1136 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1136 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
| … | |
… | |
| 1255 | } |
1255 | } |
| 1256 | |
1256 | |
| 1257 | =item $success = $term->parse_keysym ($key, $octets) |
1257 | =item $success = $term->parse_keysym ($key, $octets) |
| 1258 | |
1258 | |
| 1259 | Adds a key binding exactly as specified via a resource. See the |
1259 | Adds a key binding exactly as specified via a resource. See the |
| 1260 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1260 | C<keysym> resource in the urxvt(1) manpage. |
| 1261 | |
1261 | |
| 1262 | =item $term->register_command ($keysym, $modifiermask, $string) |
1262 | =item $term->register_command ($keysym, $modifiermask, $string) |
| 1263 | |
1263 | |
| 1264 | Adds a key binding. This is a lower level api compared to |
1264 | Adds a key binding. This is a lower level api compared to |
| 1265 | C<parse_keysym>, as it expects a parsed key description, and can be |
1265 | C<parse_keysym>, as it expects a parsed key description, and can be |
