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.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC

… …
40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44(More) intelligent selection. This extension tries to be more intelligent 44(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 45when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 46now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
49It also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
55Rot-13 the selection when activated. Used via keyboard trigger: 77Rot-13 the selection when activated. Used via keyboard trigger:
56 78
57 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
80
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
58 97
59=back 98=back
60 99
61=item option-popup (enabled by default) 100=item option-popup (enabled by default)
62 101
… …
70evalution, web-browser starting etc.), depending on content. 109evalution, web-browser starting etc.), depending on content.
71 110
72=item searchable-scrollback<hotkey> (enabled by default) 111=item searchable-scrollback<hotkey> (enabled by default)
73 112
74Adds regex search functionality to the scrollback buffer, triggered 113Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 114by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 115input/output is suspended and a regex is displayed at the bottom of the
116screen.
77 117
78C</> starts an incremental regex search, C<n> searches further, C<p> or 118Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 119search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 120search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 121bottom. C<Escape> leaves search mode and returns to the point where search
122was started, while C<Enter> or C<Return> stay at the current position and
123additionally stores the first match in the current line into the primary
124selection.
82 125
83=item digital-clock 126=item selection-autotransform
84 127
85Displays a digital clock using the built-in overlay. 128This selection allows you to do automatic transforms on a selection
129whenever a selection is made.
130
131It works by specifying perl snippets (most useful is a single C<s///>
132operator) that modify C<$_> as resources:
133
134 URxvt.selection-autotransform.0: transform
135 URxvt.selection-autotransform.1: transform
136 ...
137
138For example, the following will transform selections of the form
139C<filename:number>, often seen in compiler messages, into C<vi +$filename
140$word>:
141
142 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144And this example matches the same,but replaces it with vi-commands you can
145paste directly into your (vi :) editor:
146
147 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149Of course, this can be modified to suit your needs and your editor :)
150
151To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution:
153
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157The first line tells the selection code to treat the unchanging part of
158every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file.
86 160
87=item mark-urls 161=item mark-urls
88 162
89Uses per-line display filtering (C<on_line_update>) to underline urls and 163Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When middle-clicked, the program specified in the 164make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 165resource C<urlLauncher> (default C<x-www-browser>) will be started with
166the URL as first argument.
92 167
93=item block-graphics-to-ascii 168=item block-graphics-to-ascii
94 169
95A not very useful example of filtering all text output to the terminal, 170A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 171by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 172similar-looking ascii character.
173
174=item digital-clock
175
176Displays a digital clock using the built-in overlay.
98 177
99=item example-refresh-hooks 178=item example-refresh-hooks
100 179
101Displays a very simple digital clock in the upper right corner of the 180Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 181window. Illustrates overwriting the refresh callbacks to create your own
… …
309 388
310Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
311C<perl:string> action bound to it (see description of the B<keysym> 390C<perl:string> action bound to it (see description of the B<keysym>
312resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
313 392
393=item on_x_event $term, $event
394
395Called on every X event received on the vt window (and possibly other
396windows). Should only be used as a last resort. Most event structure
397members are not passed.
398
314=item on_focus_in $term 399=item on_focus_in $term
315 400
316Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
317does focus in processing. 402does focus in processing.
318 403
… …
428=item urxvt::CurrentTime 513=item urxvt::CurrentTime
429 514
430=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 515=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 516Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432Button4Mask, Button5Mask, AnyModifier 517Button4Mask, Button5Mask, AnyModifier
518
519=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
520ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
521PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
522Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
523KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
524ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
525FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
526
527=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
528EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
529GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
530UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
531ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
532CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
533SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433 534
434Various constants for use in X calls and event processing. 535Various constants for use in X calls and event processing.
435 536
436=back 537=back
437 538
… …
505 delete $ENV{CDPATH}; 606 delete $ENV{CDPATH};
506 delete $ENV{BASH_ENV}; 607 delete $ENV{BASH_ENV};
507 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 608 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508} 609}
509 610
510my @hook_count;
511my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 611my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512 612
513sub verbose { 613sub verbose {
514 my ($level, $msg) = @_; 614 my ($level, $msg) = @_;
515 warn "$msg\n" if $level <= $verbosity; 615 warn "$msg\n" if $level <= $verbosity;
… …
603 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 703 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604 if $verbosity >= 11; 704 if $verbosity >= 11;
605 } 705 }
606 706
607 if ($htype == 1) { # DESTROY 707 if ($htype == 1) { # DESTROY
608 if (my $hook = delete $TERM->{_hook}) {
609 for my $htype (0..$#$hook) {
610 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
611 or set_should_invoke $htype, 0;
612 }
613 }
614
615 # clear package objects 708 # clear package objects
616 %$_ = () for values %{ $TERM->{_pkg} }; 709 %$_ = () for values %{ $TERM->{_pkg} };
617 710
618 # clear package 711 # clear package
619 %$TERM = (); 712 %$TERM = ();
… …
645 while (my ($name, $cb) = each %hook) { 738 while (my ($name, $cb) = each %hook) {
646 my $htype = $HOOKTYPE{uc $name}; 739 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 740 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 741 or Carp::croak "unsupported hook type '$name'";
649 742
743 $self->set_should_invoke ($htype, +1)
650 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 744 unless exists $self->{term}{_hook}[$htype]{$pkg};
651 $hook_count[$htype]++
652 or urxvt::set_should_invoke $htype, 1;
653 }
654 745
655 $self->{term}{_hook}[$htype]{$pkg} = $cb; 746 $self->{term}{_hook}[$htype]{$pkg} = $cb;
656 } 747 }
657} 748}
658 749
… …
663 for my $name (@hook) { 754 for my $name (@hook) {
664 my $htype = $HOOKTYPE{uc $name}; 755 my $htype = $HOOKTYPE{uc $name};
665 defined $htype 756 defined $htype
666 or Carp::croak "unsupported hook type '$name'"; 757 or Carp::croak "unsupported hook type '$name'";
667 758
759 $self->set_should_invoke ($htype, -1)
668 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 760 if delete $self->{term}{_hook}[$htype]{$pkg};
669 --$hook_count[$htype]
670 or urxvt::set_should_invoke $htype, 0;
671 }
672 } 761 }
673} 762}
674 763
675our $AUTOLOAD; 764our $AUTOLOAD;
676 765
… …
1081 1170
1082=item $windowid = $term->vt 1171=item $windowid = $term->vt
1083 1172
1084Return the window id of the terminal window. 1173Return the window id of the terminal window.
1085 1174
1175=item $term->vt_emask_add ($x_event_mask)
1176
1177Adds the specified events to the vt event mask. Useful e.g. when you want
1178to receive pointer events all the times:
1179
1180 $term->vt_emask_add (urxvt::PointerMotionMask);
1181
1086=item $window_width = $term->width 1182=item $window_width = $term->width
1087 1183
1088=item $window_height = $term->height 1184=item $window_height = $term->height
1089 1185
1090=item $font_width = $term->fwidth 1186=item $font_width = $term->fwidth
… …
1103 1199
1104=item $max_scrollback = $term->saveLines 1200=item $max_scrollback = $term->saveLines
1105 1201
1106=item $nrow_plus_saveLines = $term->total_rows 1202=item $nrow_plus_saveLines = $term->total_rows
1107 1203
1108=item $lines_in_scrollback = $term->nsaved 1204=item $topmost_scrollback_row = $term->top_row
1109 1205
1110Return various integers describing terminal characteristics. 1206Return various integers describing terminal characteristics.
1111 1207
1112=item $x_display = $term->display_id 1208=item $x_display = $term->display_id
1113 1209
… …
1141Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1237Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1142AltGr), the meta key (often Alt) and the num lock key, if applicable. 1238AltGr), the meta key (often Alt) and the num lock key, if applicable.
1143 1239
1144=item $view_start = $term->view_start ([$newvalue]) 1240=item $view_start = $term->view_start ([$newvalue])
1145 1241
1146Returns the negative row number of the topmost line. Minimum value is 1242Returns the row number of the topmost displayed line. Maximum value is
1147C<0>, which displays the normal terminal contents. Larger values scroll 1243C<0>, which displays the normal terminal contents. Lower values scroll
1148this many lines into the scrollback buffer. 1244this many lines into the scrollback buffer.
1149 1245
1150=item $term->want_refresh 1246=item $term->want_refresh
1151 1247
1152Requests a screen refresh. At the next opportunity, rxvt-unicode will 1248Requests a screen refresh. At the next opportunity, rxvt-unicode will

Diff Legend

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