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.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 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 the following bindable keyboard command:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
… …
70evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
71 93
72=item searchable-scrollback<hotkey> (enabled by default) 94=item searchable-scrollback<hotkey> (enabled by default)
73 95
74Adds regex search functionality to the scrollback buffer, triggered 96Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 97by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 98input/output is suspended and a regex is displayed at the bottom of the
99screen.
77 100
78C</> starts an incremental regex search, C<n> searches further, C<p> or 101Inputting 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 102search. 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> 103search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
82 108
83=item digital-clock 109=item selection-autotransform
84 110
85Displays a digital clock using the built-in overlay. 111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<word:number> into C<vi +$number $word>:
123
124 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/
125
126And this example matches the same,but replaces it with vi-commands you can
127paste directory into your (vi :) editor:
128
129 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/
86 130
87=item mark-urls 131=item mark-urls
88 132
89Uses per-line display filtering (C<on_line_update>) to underline urls and 133Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When clicked, the program specified in the resource 134make them clickable. When middle-clicked, the program specified in the
91C<urlLauncher> (default C<x-www-browser>) will be started. 135resource C<urlLauncher> (default C<x-www-browser>) will be started with
136the URL as first argument.
92 137
93=item block-graphics-to-ascii 138=item block-graphics-to-ascii
94 139
95A not very useful example of filtering all text output to the terminal, 140A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 141by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 142similar-looking ascii character.
143
144=item digital-clock
145
146Displays a digital clock using the built-in overlay.
98 147
99=item example-refresh-hooks 148=item example-refresh-hooks
100 149
101Displays a very simple digital clock in the upper right corner of the 150Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 151window. Illustrates overwriting the refresh callbacks to create your own
… …
230=item on_sel_extend $term 279=item on_sel_extend $term
231 280
232Called whenever the user tries to extend the selection (e.g. with a double 281Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 282click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 283should extend the selection itelf and return true to suppress the built-in
235processing. 284processing. This can happen multiple times, as long as the callback
285returns true, it will be called on every further click by the user and is
286supposed to enlarge the selection more and more, if possible.
236 287
237See the F<selection> example extension. 288See the F<selection> example extension.
238 289
239=item on_view_change $term, $offset 290=item on_view_change $term, $offset
240 291
… …
595 if ($@) { 646 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 647 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 648 warn $@;
598 } 649 }
599 } 650 }
651
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11;
600 } 654 }
601 655
602 if ($htype == 1) { # DESTROY 656 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) { 657 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) { 658 for my $htype (0..$#$hook) {
… …
613 # clear package 667 # clear package
614 %$TERM = (); 668 %$TERM = ();
615 } 669 }
616 670
617 $retval 671 $retval
672}
673
674sub exec_async(@) {
675 my $pid = fork;
676
677 return
678 if !defined $pid or $pid;
679
680 %ENV = %{ $TERM->env };
681
682 exec @_;
683 _exit 255;
618} 684}
619 685
620# urxvt::term::extension 686# urxvt::term::extension
621 687
622package urxvt::term::extension; 688package urxvt::term::extension;
… …
898=item ($row, $col) = $term->selection_end ([$row, $col]) 964=item ($row, $col) = $term->selection_end ([$row, $col])
899 965
900Return the current values of the selection mark, begin or end positions, 966Return the current values of the selection mark, begin or end positions,
901and optionally set them to new values. 967and optionally set them to new values.
902 968
969=item $term->selection_make ($eventtime[, $rectangular])
970
971Tries to make a selection as set by C<selection_beg> and
972C<selection_end>. If C<$rectangular> is true (default: false), a
973rectangular selection will be made. This is the prefered function to make
974a selection.
975
903=item $success = $term->selection_grab ($eventtime) 976=item $success = $term->selection_grab ($eventtime)
904 977
905Try to request the primary selection from the server (for example, as set 978Try to request the primary selection text from the server (for example, as
906by the next method). 979set by the next method). No visual feedback will be given. This function
980is mostly useful from within C<on_sel_grab> hooks.
907 981
908=item $oldtext = $term->selection ([$newtext]) 982=item $oldtext = $term->selection ([$newtext])
909 983
910Return the current selection text and optionally replace it by C<$newtext>. 984Return the current selection text and optionally replace it by C<$newtext>.
911 985
… …
1004Convert the given locale-encoded octets into a perl string. 1078Convert the given locale-encoded octets into a perl string.
1005 1079
1006=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1080=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007 1081
1008XORs the rendition values in the given span with the provided value 1082XORs the rendition values in the given span with the provided value
1009(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1083(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010to the selection. 1084refresh hooks to provide effects similar to the selection.
1011 1085
1012=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1086=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013 1087
1014Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1088Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015whitespace will additionally be xored with the C<$rstyle2>, which defaults 1089whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1090to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1017it instead. 1091it instead. Both styles I<MUST NOT> contain font styles.
1018 1092
1019=item $term->scr_bell 1093=item $term->scr_bell
1020 1094
1021Ring the bell! 1095Ring the bell!
1022 1096
… …
1206Return the row number of the first/last row of the line, respectively. 1280Return the row number of the first/last row of the line, respectively.
1207 1281
1208=item $offset = $line->offset_of ($row, $col) 1282=item $offset = $line->offset_of ($row, $col)
1209 1283
1210Returns the character offset of the given row|col pair within the logical 1284Returns the character offset of the given row|col pair within the logical
1211line. 1285line. Works for rows outside the line, too, and returns corresponding
1286offsets outside the string.
1212 1287
1213=item ($row, $col) = $line->coord_of ($offset) 1288=item ($row, $col) = $line->coord_of ($offset)
1214 1289
1215Translates a string offset into terminal coordinates again. 1290Translates a string offset into terminal coordinates again.
1216 1291
… …
1571 1646
1572=item == 0 - fatal messages 1647=item == 0 - fatal messages
1573 1648
1574=item >= 3 - script loading and management 1649=item >= 3 - script loading and management
1575 1650
1576=item >=10 - all events received 1651=item >=10 - all called hooks
1652
1653=item >=11 - hook reutrn values
1577 1654
1578=back 1655=back
1579 1656
1580=head1 AUTHOR 1657=head1 AUTHOR
1581 1658

Diff Legend

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