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.97 by elmex, Tue Jan 17 16:53:47 2006 UTC vs.
Revision 1.105 by root, Wed Jan 18 19:43:51 2006 UTC

88=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
89 89
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
93
94Other extensions can extend this popup menu by pushing a code reference onto
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called
101when the button gets activated and should transform C<$_>.
102
103The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any
105C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
93 111
94=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
95 113
96Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
146Uses per-line display filtering (C<on_line_update>) to underline urls and 164Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 167the URL as first argument.
150 168
169=item automove-background
170
171This is basically a one-line extension that dynamically changes the background pixmap offset
172to the window position, in effect creating the same effect as pseudo transparency with
173a custom pixmap. No scaling is supported in this mode. Exmaple:
174
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
176
151=item block-graphics-to-ascii 177=item block-graphics-to-ascii
152 178
153A not very useful example of filtering all text output to the terminal, 179A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 181similar-looking ascii character.
164window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 191overlays or changes.
166 192
167=item selection-pastebin 193=item selection-pastebin
168 194
169Uploads the selection as textfile to a remote site. 195This is a little rarely useful extension that Uploads the selection as
196textfile to a remote site (or does other things). (The implementation is
197not currently secure for use in a multiuser environment as it writes to
198F</tmp> directly.).
199
200It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
201i.e.
170 202
171 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172 204
173To set the command to upload the file set this resource: 205Pressing this combination runs a command with C<%> replaced by the name of
206the textfile. This command can be set via a resource:
174 207
175 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. 208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176 209
177The % is the placeholder for the textfile. The name of the textfile is the hex encoded 210And the default is likely not useful to anybody but the few people around
178md5 sum of the selection. 211here :)
212
213The name of the textfile is the hex encoded md5 sum of the selection, so
214the same content should lead to the same filename.
215
179After an successful upload the selection will be replaced by the following url 216After a successful upload the selection will be replaced by the text given
180(the % is the placeholder for the filename): 217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
181 219
182 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% 220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
183 221
184=back 222=back
185 223
186=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
187 225
403 441
404=item on_focus_out $term 442=item on_focus_out $term
405 443
406Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
407focus out processing. 445focus out processing.
446
447=item on_configure_notify $term, $event
408 448
409=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
410 450
411=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
412 452
583=back 623=back
584 624
585=cut 625=cut
586 626
587BEGIN { 627BEGIN {
588 urxvt->bootstrap;
589
590 # overwrite perl's warn 628 # overwrite perl's warn
591 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
592 my $msg = join "", @_; 630 my $msg = join "", @_;
593 $msg .= "\n" 631 $msg .= "\n"
594 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
607sub verbose { 645sub verbose {
608 my ($level, $msg) = @_; 646 my ($level, $msg) = @_;
609 warn "$msg\n" if $level <= $verbosity; 647 warn "$msg\n" if $level <= $verbosity;
610} 648}
611 649
612my $extension_pkg = "extension0000";
613my %extension_pkg; 650my %extension_pkg;
614 651
615# load a single script into its own package, once only 652# load a single script into its own package, once only
616sub extension_package($) { 653sub extension_package($) {
617 my ($path) = @_; 654 my ($path) = @_;
618 655
656 no strict 'refs';
657
619 $extension_pkg{$path} ||= do { 658 $extension_pkg{$path} ||= do {
620 my $pkg = "urxvt::" . ($extension_pkg++); 659 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg";
621 663
622 verbose 3, "loading extension '$path' into package '$pkg'"; 664 verbose 3, "loading extension '$path' into package '$pkg'";
623 665
624 open my $fh, "<:raw", $path 666 open my $fh, "<:raw", $path
625 or die "$path: $!"; 667 or die "$path: $!";
626 668
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
627 my $source = 671 my $source =
628 "package $pkg; use strict; use utf8;\n" 672 "package $pkg; use strict; use utf8;\n"
629 . "use base urxvt::term::extension::;\n"
630 . "#line 1 \"$path\"\n{\n" 673 . "#line 1 \"$path\"\n{\n"
631 . (do { local $/; <$fh> }) 674 . (do { local $/; <$fh> })
632 . "\n};\n1"; 675 . "\n};\n1";
633 676
634 eval $source 677 eval $source
916Here is a a likely non-exhaustive list of option names, please see the 959Here is a a likely non-exhaustive list of option names, please see the
917source file F</src/optinc.h> to see the actual list: 960source file F</src/optinc.h> to see the actual list:
918 961
919 borderLess console cursorBlink cursorUnderline hold iconic insecure 962 borderLess console cursorBlink cursorUnderline hold iconic insecure
920 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 963 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 964 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 965 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 966 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924 tripleclickwords utmpInhibit visualBell 967 transparent tripleclickwords utmpInhibit visualBell
925 968
926=item $value = $term->resource ($name[, $newval]) 969=item $value = $term->resource ($name[, $newval])
927 970
928Returns the current resource value associated with a given name and 971Returns the current resource value associated with a given name and
929optionally sets a new value. Setting values is most useful in the C<init> 972optionally sets a new value. Setting values is most useful in the C<init>
946 989
947 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 990 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948 borderLess color cursorBlink cursorUnderline cutchars delete_key 991 borderLess color cursorBlink cursorUnderline cutchars delete_key
949 display_name embed ext_bwidth fade font geometry hold iconName 992 display_name embed ext_bwidth fade font geometry hold iconName
950 imFont imLocale inputMethod insecure int_bwidth intensityStyles 993 imFont imLocale inputMethod insecure int_bwidth intensityStyles
951 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 994 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 995 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 996 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 997 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 998 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 999 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957 shade term_name title transparent transparent_all tripleclickwords 1000 secondaryScreen secondaryScroll selectstyle shade term_name title
958 utmpInhibit visualBell 1001 transient_for transparent transparent_all tripleclickwords utmpInhibit
1002 visualBell
959 1003
960=cut 1004=cut
961 1005
962sub resource($$;$) { 1006sub resource($$;$) {
963 my ($self, $name) = (shift, shift); 1007 my ($self, $name) = (shift, shift);
1555 my $env = $self->{term}->env; 1599 my $env = $self->{term}->env;
1556 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1600 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557 delete $env->{LC_ALL}; 1601 delete $env->{LC_ALL};
1558 $env->{LC_CTYPE} = $self->{term}->locale; 1602 $env->{LC_CTYPE} = $self->{term}->locale;
1559 1603
1560 urxvt::term->new ($env, $self->{term}->resource ("name"), 1604 urxvt::term->new ($env, "popup",
1561 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1605 "--perl-lib" => "", "--perl-ext-common" => "",
1606 "-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562 "--transient-for" => $self->{term}->parent, 1607 "--transient-for" => $self->{term}->parent,
1563 "-display" => $self->{term}->display_id, 1608 "-display" => $self->{term}->display_id,
1564 "-pe" => "urxvt-popup") 1609 "-pe" => "urxvt-popup")
1565 or die "unable to create popup window\n"; 1610 or die "unable to create popup window\n";
1566} 1611}
1618Start the timer. 1663Start the timer.
1619 1664
1620=item $timer = $timer->start ($tstamp) 1665=item $timer = $timer->start ($tstamp)
1621 1666
1622Set the event trigger time to C<$tstamp> and start the timer. 1667Set the event trigger time to C<$tstamp> and start the timer.
1668
1669=item $timer = $timer->after ($delay)
1670
1671Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623 1672
1624=item $timer = $timer->stop 1673=item $timer = $timer->stop
1625 1674
1626Stop the timer. 1675Stop the timer.
1627 1676

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines