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.223 by root, Sat Jul 14 08:00:18 2012 UTC vs.
Revision 1.226 by root, Sat Sep 22 14:35:55 2012 UTC

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 5urxvtperl - 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
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string. 32and "perl-ext-common" resources to the empty string.
33 33
34=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
35 35
36A number of extensions are delivered with this release. You can find them 36A number of extensions are delivered with this release. You can find them
37in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed 37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38using F<< man urxvt-<EXTENSIONNAME> >>. 38F<< man urxvt-<EXTENSIONNAME> >>.
39 39
40You can activate them like this: 40You can activate them like this:
41 41
42 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
43 43
44Or by adding them to the resource for extensions loaded by default: 44Or 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
288Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
289a C<perl:string> action bound to a key, see description of the B<keysym> 289a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
291 291
292The event is simply the action string. This interface is assumed to change 292The event is simply the action string. This interface is assumed to change
293slightly in the future. 293slightly in the future.
294 294
295=item on_register_command $term, $keysym, $modifiermask, $string 295=item on_register_command $term, $keysym, $modifiermask, $string
… …
884 my $disable = shift; 884 my $disable = shift;
885 885
886 my $term = delete $disable->{""}; 886 my $term = delete $disable->{""};
887 887
888 while (my ($htype, $id) = each %$disable) { 888 while (my ($htype, $id) = each %$disable) {
889 warn "disable hook $htype,$id\n";#d#
890 delete $term->{_hook}[$htype]{$id}; 889 delete $term->{_hook}[$htype]{$id};
891 $term->set_should_invoke ($htype, -1); 890 $term->set_should_invoke ($htype, -1);
892 } 891 }
893} 892}
894 893
… …
1078 1077
1079 for my $dir (reverse @libdirs) { 1078 for my $dir (reverse @libdirs) {
1080 opendir my $fh, $dir 1079 opendir my $fh, $dir
1081 or next; 1080 or next;
1082 for my $ext (readdir $fh) { 1081 for my $ext (readdir $fh) {
1083 $ext ne "." 1082 $ext !~ /^\./
1084 and $ext ne ".."
1085 and open my $fh, "<", "$dir/$ext" 1083 and open my $fh, "<", "$dir/$ext"
1086 or next; 1084 or next;
1087 1085
1088 while (<$fh>) { 1086 while (<$fh>) {
1089 if (/^#:META:X_RESOURCE:(.*)/) { 1087 if (/^#:META:X_RESOURCE:(.*)/) {
… …
1128} 1126}
1129 1127
1130=item $term->destroy 1128=item $term->destroy
1131 1129
1132Destroy the terminal object (close the window, free resources 1130Destroy the terminal object (close the window, free resources
1133etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1131etc.). Please note that urxvt will not exit as long as any event
1134watchers (timers, io watchers) are still active. 1132watchers (timers, io watchers) are still active.
1135 1133
1136=item $term->exec_async ($cmd[, @args]) 1134=item $term->exec_async ($cmd[, @args])
1137 1135
1138Works like the combination of the C<fork>/C<exec> builtins, which executes 1136Works like the combination of the C<fork>/C<exec> builtins, which executes
… …
1257} 1255}
1258 1256
1259=item $success = $term->parse_keysym ($key, $octets) 1257=item $success = $term->parse_keysym ($key, $octets)
1260 1258
1261Adds a key binding exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
1262C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1260C<keysym> resource in the urxvt(1) manpage.
1263 1261
1264=item $term->register_command ($keysym, $modifiermask, $string) 1262=item $term->register_command ($keysym, $modifiermask, $string)
1265 1263
1266Adds a key binding. This is a lower level api compared to 1264Adds a key binding. This is a lower level api compared to
1267C<parse_keysym>, as it expects a parsed key description, and can be 1265C<parse_keysym>, as it expects a parsed key description, and can be

Diff Legend

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