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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
48C<--quoting-style=shell>. 52C<--quoting-style=shell>.
49 53
50A double-click usually selects the word under the cursor, further clicks 54A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection. 55will enlarge the selection.
52 56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
53It also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
54 76
55=over 4 77=over 4
56 78
57=item rot13 79=item rot13
58 80
70=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
71 93
72Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
73text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
74evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
75 116
76=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
77 118
78Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
79by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
86bottom. C<Escape> leaves search mode and returns to the point where search 127bottom. C<Escape> leaves search mode and returns to the point where search
87was started, while C<Enter> or C<Return> stay at the current position and 128was started, while C<Enter> or C<Return> stay at the current position and
88additionally stores the first match in the current line into the primary 129additionally stores the first match in the current line into the primary
89selection. 130selection.
90 131
91=item digital-clock 132=item selection-autotransform
92 133
93Displays a digital clock using the built-in overlay. 134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
94 166
95=item mark-urls 167=item mark-urls
96 168
97Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
98make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
99resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
100the URL as first argument. 172the URL as first argument.
101 173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
102=item block-graphics-to-ascii 182=item block-graphics-to-ascii
103 183
104A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
105by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
106similar-looking ascii character. 186similar-looking ascii character.
107 187
188=item digital-clock
189
190Displays a digital clock using the built-in overlay.
191
108=item example-refresh-hooks 192=item example-refresh-hooks
109 193
110Displays a very simple digital clock in the upper right corner of the 194Displays a very simple digital clock in the upper right corner of the
111window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
112overlays or changes. 196overlays or changes.
197
198=item selection-pastebin
199
200This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
207
208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
212
213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215And the default is likely not useful to anybody but the few people around
216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
221After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
224
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
113 226
114=back 227=back
115 228
116=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
117 230
190called whenever the relevant event happens. 303called whenever the relevant event happens.
191 304
192The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
193the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
194 307
195B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
196event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
197skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
198 311
199I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
200 313
201=over 4 314=over 4
202 315
203=item on_init $term 316=item on_init $term
204 317
205Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
206windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
207call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
208have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
209though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop.
210 329
211=item on_reset $term 330=item on_reset $term
212 331
213Called after the screen is "reset" for any reason, such as resizing or 332Called after the screen is "reset" for any reason, such as resizing or
214control sequences. Here is where you can react on changes to size-related 333control sequences. Here is where you can react on changes to size-related
215variables. 334variables.
216 335
217=item on_start $term 336=item on_child_start $term, $pid
218 337
219Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
220returning to the mainloop. 339
340=item on_child_exit $term, $status
341
342Called just after the child process has exited. C<$status> is the status
343from C<waitpid>.
221 344
222=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
223 346
224Called whenever a selection has been made by the user, but before the 347Called whenever a selection has been made by the user, but before the
225selection text is copied, so changes to the beginning, end or type of the 348selection text is copied, so changes to the beginning, end or type of the
318 441
319Called whenever the user presses a key combination that has a 442Called whenever the user presses a key combination that has a
320C<perl:string> action bound to it (see description of the B<keysym> 443C<perl:string> action bound to it (see description of the B<keysym>
321resource in the @@RXVT_NAME@@(1) manpage). 444resource in the @@RXVT_NAME@@(1) manpage).
322 445
446=item on_x_event $term, $event
447
448Called on every X event received on the vt window (and possibly other
449windows). Should only be used as a last resort. Most event structure
450members are not passed.
451
323=item on_focus_in $term 452=item on_focus_in $term
324 453
325Called whenever the window gets the keyboard focus, before rxvt-unicode 454Called whenever the window gets the keyboard focus, before rxvt-unicode
326does focus in processing. 455does focus in processing.
327 456
328=item on_focus_out $term 457=item on_focus_out $term
329 458
330Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
331focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
332 463
333=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
334 465
335=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
336 467
422Using this function has the advantage that its output ends up in the 553Using this function has the advantage that its output ends up in the
423correct place, e.g. on stderr of the connecting urxvtc client. 554correct place, e.g. on stderr of the connecting urxvtc client.
424 555
425Messages have a size limit of 1023 bytes currently. 556Messages have a size limit of 1023 bytes currently.
426 557
427=item $is_safe = urxvt::safe
428
429Returns true when it is safe to do potentially unsafe things, such as
430evaluating perl code specified by the user. This is true when urxvt was
431started setuid or setgid.
432
433=item $time = urxvt::NOW 558=item $time = urxvt::NOW
434 559
435Returns the "current time" (as per the event loop). 560Returns the "current time" (as per the event loop).
436 561
437=item urxvt::CurrentTime 562=item urxvt::CurrentTime
438 563
439=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 564=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 565Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441Button4Mask, Button5Mask, AnyModifier 566Button4Mask, Button5Mask, AnyModifier
567
568=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
569ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
570PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
571Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
572KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
573ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
574FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
575
576=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
577EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
578GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
579UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
580ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
581CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
582SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442 583
443Various constants for use in X calls and event processing. 584Various constants for use in X calls and event processing.
444 585
445=back 586=back
446 587
497=back 638=back
498 639
499=cut 640=cut
500 641
501BEGIN { 642BEGIN {
502 urxvt->bootstrap;
503
504 # overwrite perl's warn 643 # overwrite perl's warn
505 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
506 my $msg = join "", @_; 645 my $msg = join "", @_;
507 $msg .= "\n" 646 $msg .= "\n"
508 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
509 urxvt::warn ($msg); 648 urxvt::warn ($msg);
510 }; 649 };
511
512 # %ENV is the original startup environment
513 delete $ENV{IFS};
514 delete $ENV{CDPATH};
515 delete $ENV{BASH_ENV};
516 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517} 650}
518 651
519my @hook_count;
520my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521 653
522sub verbose { 654sub verbose {
523 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
524 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
525} 657}
526 658
527my $extension_pkg = "extension0000";
528my %extension_pkg; 659my %extension_pkg;
529 660
530# load a single script into its own package, once only 661# load a single script into its own package, once only
531sub extension_package($) { 662sub extension_package($) {
532 my ($path) = @_; 663 my ($path) = @_;
533 664
665 no strict 'refs';
666
534 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
535 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
536 672
537 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
538 674
539 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
540 or die "$path: $!"; 676 or die "$path: $!";
541 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
542 my $source = untaint 680 my $source =
543 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
544 . "use base urxvt::term::extension::;\n"
545 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
546 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
547 . "\n};\n1"; 684 . "\n};\n1";
548 685
549 eval $source 686 eval $source
598 if $verbosity >= 10; 735 if $verbosity >= 10;
599 736
600 keys %$cb; 737 keys %$cb;
601 738
602 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
603 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
604 and last;
605 741
606 if ($@) { 742 if ($@) {
607 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
608 warn $@; 744 warn $@;
609 } 745 }
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 748 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11; 749 if $verbosity >= 11;
614 } 750 }
615 751
616 if ($htype == 1) { # DESTROY 752 if ($htype == 1) { # DESTROY
617 if (my $hook = delete $TERM->{_hook}) {
618 for my $htype (0..$#$hook) {
619 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
620 or set_should_invoke $htype, 0;
621 }
622 }
623
624 # clear package objects 753 # clear package objects
625 %$_ = () for values %{ $TERM->{_pkg} }; 754 %$_ = () for values %{ $TERM->{_pkg} };
626 755
627 # clear package 756 # clear package
628 %$TERM = (); 757 %$TERM = ();
629 } 758 }
630 759
631 $retval 760 $retval
632}
633
634sub exec_async(@) {
635 my $pid = fork;
636
637 return
638 if !defined $pid or $pid;
639
640 %ENV = %{ $TERM->env };
641
642 exec @_;
643 _exit 255;
644} 761}
645 762
646# urxvt::term::extension 763# urxvt::term::extension
647 764
648package urxvt::term::extension; 765package urxvt::term::extension;
654 while (my ($name, $cb) = each %hook) { 771 while (my ($name, $cb) = each %hook) {
655 my $htype = $HOOKTYPE{uc $name}; 772 my $htype = $HOOKTYPE{uc $name};
656 defined $htype 773 defined $htype
657 or Carp::croak "unsupported hook type '$name'"; 774 or Carp::croak "unsupported hook type '$name'";
658 775
776 $self->set_should_invoke ($htype, +1)
659 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 777 unless exists $self->{term}{_hook}[$htype]{$pkg};
660 $hook_count[$htype]++
661 or urxvt::set_should_invoke $htype, 1;
662 }
663 778
664 $self->{term}{_hook}[$htype]{$pkg} = $cb; 779 $self->{term}{_hook}[$htype]{$pkg} = $cb;
665 } 780 }
666} 781}
667 782
672 for my $name (@hook) { 787 for my $name (@hook) {
673 my $htype = $HOOKTYPE{uc $name}; 788 my $htype = $HOOKTYPE{uc $name};
674 defined $htype 789 defined $htype
675 or Carp::croak "unsupported hook type '$name'"; 790 or Carp::croak "unsupported hook type '$name'";
676 791
792 $self->set_should_invoke ($htype, -1)
677 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 793 if delete $self->{term}{_hook}[$htype]{$pkg};
678 --$hook_count[$htype]
679 or urxvt::set_should_invoke $htype, 0;
680 }
681 } 794 }
682} 795}
683 796
684our $AUTOLOAD; 797our $AUTOLOAD;
685 798
831 944
832Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
833etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
835 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
836=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
837 975
838Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
839optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
840C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
842Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
843source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
844 982
845 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
846 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
851 989
852=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
853 991
854Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
855optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
872 1010
873 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
875 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
876 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
877 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
884 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
885 1024
886=cut 1025=cut
887 1026
888sub resource($$;$) { 1027sub resource($$;$) {
889 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
1090 1229
1091=item $windowid = $term->vt 1230=item $windowid = $term->vt
1092 1231
1093Return the window id of the terminal window. 1232Return the window id of the terminal window.
1094 1233
1234=item $term->vt_emask_add ($x_event_mask)
1235
1236Adds the specified events to the vt event mask. Useful e.g. when you want
1237to receive pointer events all the times:
1238
1239 $term->vt_emask_add (urxvt::PointerMotionMask);
1240
1095=item $window_width = $term->width 1241=item $window_width = $term->width
1096 1242
1097=item $window_height = $term->height 1243=item $window_height = $term->height
1098 1244
1099=item $font_width = $term->fwidth 1245=item $font_width = $term->fwidth
1112 1258
1113=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1114 1260
1115=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1116 1262
1117=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1118 1264
1119Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1120 1266
1121=item $x_display = $term->display_id 1267=item $x_display = $term->display_id
1122 1268
1150Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151AltGr), the meta key (often Alt) and the num lock key, if applicable. 1297AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152 1298
1153=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1154 1300
1155Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1156C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1157this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1158 1304
1159=item $term->want_refresh 1305=item $term->want_refresh
1160 1306
1161Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
1474 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1475 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1477 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1478 1624
1479 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1480 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1482 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1483 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1484 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1485} 1633}
1537Start the timer. 1685Start the timer.
1538 1686
1539=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1540 1688
1541Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542 1694
1543=item $timer = $timer->stop 1695=item $timer = $timer->stop
1544 1696
1545Stop the timer. 1697Stop the timer.
1546 1698

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines