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.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.89 by root, Thu Jan 12 12:10:06 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<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
86 131
87=item mark-urls 132=item mark-urls
88 133
89Uses per-line display filtering (C<on_line_update>) to underline urls and 134Uses per-line display filtering (C<on_line_update>) to underline urls and
90make them clickable. When middle-clicked, the program specified in the 135make them clickable. When middle-clicked, the program specified in the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 136resource C<urlLauncher> (default C<x-www-browser>) will be started with
137the URL as first argument.
92 138
93=item block-graphics-to-ascii 139=item block-graphics-to-ascii
94 140
95A not very useful example of filtering all text output to the terminal, 141A not very useful example of filtering all text output to the terminal,
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 142by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 143similar-looking ascii character.
144
145=item digital-clock
146
147Displays a digital clock using the built-in overlay.
98 148
99=item example-refresh-hooks 149=item example-refresh-hooks
100 150
101Displays a very simple digital clock in the upper right corner of the 151Displays a very simple digital clock in the upper right corner of the
102window. Illustrates overwriting the refresh callbacks to create your own 152window. Illustrates overwriting the refresh callbacks to create your own
… …
230=item on_sel_extend $term 280=item on_sel_extend $term
231 281
232Called whenever the user tries to extend the selection (e.g. with a double 282Called whenever the user tries to extend the selection (e.g. with a double
233click) and is either supposed to return false (normal operation), or 283click) and is either supposed to return false (normal operation), or
234should extend the selection itelf and return true to suppress the built-in 284should extend the selection itelf and return true to suppress the built-in
235processing. 285processing. This can happen multiple times, as long as the callback
286returns true, it will be called on every further click by the user and is
287supposed to enlarge the selection more and more, if possible.
236 288
237See the F<selection> example extension. 289See the F<selection> example extension.
238 290
239=item on_view_change $term, $offset 291=item on_view_change $term, $offset
240 292
… …
595 if ($@) { 647 if ($@) {
596 $TERM->ungrab; # better to lose the grab than the session 648 $TERM->ungrab; # better to lose the grab than the session
597 warn $@; 649 warn $@;
598 } 650 }
599 } 651 }
652
653 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654 if $verbosity >= 11;
600 } 655 }
601 656
602 if ($htype == 1) { # DESTROY 657 if ($htype == 1) { # DESTROY
603 if (my $hook = delete $TERM->{_hook}) { 658 if (my $hook = delete $TERM->{_hook}) {
604 for my $htype (0..$#$hook) { 659 for my $htype (0..$#$hook) {
… …
910=item ($row, $col) = $term->selection_end ([$row, $col]) 965=item ($row, $col) = $term->selection_end ([$row, $col])
911 966
912Return the current values of the selection mark, begin or end positions, 967Return the current values of the selection mark, begin or end positions,
913and optionally set them to new values. 968and optionally set them to new values.
914 969
970=item $term->selection_make ($eventtime[, $rectangular])
971
972Tries to make a selection as set by C<selection_beg> and
973C<selection_end>. If C<$rectangular> is true (default: false), a
974rectangular selection will be made. This is the prefered function to make
975a selection.
976
915=item $success = $term->selection_grab ($eventtime) 977=item $success = $term->selection_grab ($eventtime)
916 978
917Try to request the primary selection from the server (for example, as set 979Try to request the primary selection text from the server (for example, as
918by the next method). 980set by the next method). No visual feedback will be given. This function
981is mostly useful from within C<on_sel_grab> hooks.
919 982
920=item $oldtext = $term->selection ([$newtext]) 983=item $oldtext = $term->selection ([$newtext])
921 984
922Return the current selection text and optionally replace it by C<$newtext>. 985Return the current selection text and optionally replace it by C<$newtext>.
923 986
… …
1016Convert the given locale-encoded octets into a perl string. 1079Convert the given locale-encoded octets into a perl string.
1017 1080
1018=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1081=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019 1082
1020XORs the rendition values in the given span with the provided value 1083XORs the rendition values in the given span with the provided value
1021(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1084(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1022to the selection. 1085refresh hooks to provide effects similar to the selection.
1023 1086
1024=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1087=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025 1088
1026Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1089Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027whitespace will additionally be xored with the C<$rstyle2>, which defaults 1090whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1091to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1029it instead. 1092it instead. Both styles I<MUST NOT> contain font styles.
1030 1093
1031=item $term->scr_bell 1094=item $term->scr_bell
1032 1095
1033Ring the bell! 1096Ring the bell!
1034 1097
… …
1218Return the row number of the first/last row of the line, respectively. 1281Return the row number of the first/last row of the line, respectively.
1219 1282
1220=item $offset = $line->offset_of ($row, $col) 1283=item $offset = $line->offset_of ($row, $col)
1221 1284
1222Returns the character offset of the given row|col pair within the logical 1285Returns the character offset of the given row|col pair within the logical
1223line. 1286line. Works for rows outside the line, too, and returns corresponding
1287offsets outside the string.
1224 1288
1225=item ($row, $col) = $line->coord_of ($offset) 1289=item ($row, $col) = $line->coord_of ($offset)
1226 1290
1227Translates a string offset into terminal coordinates again. 1291Translates a string offset into terminal coordinates again.
1228 1292
… …
1583 1647
1584=item == 0 - fatal messages 1648=item == 0 - fatal messages
1585 1649
1586=item >= 3 - script loading and management 1650=item >= 3 - script loading and management
1587 1651
1588=item >=10 - all events received 1652=item >=10 - all called hooks
1653
1654=item >=11 - hook reutrn values
1589 1655
1590=back 1656=back
1591 1657
1592=head1 AUTHOR 1658=head1 AUTHOR
1593 1659

Diff Legend

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