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.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.163 by ayin, Mon Dec 17 23:52:45 2007 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
256The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
260 263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
261Example configuration: 267Example configuration:
262 268
263 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
265 URxvt.keysym.C-Delete: perl:matcher 271 URxvt.keysym.C-Delete: perl:matcher
270 276
271=item xim-onthespot 277=item xim-onthespot
272 278
273This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
274not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
275OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
276kinput2. 282kinput2.
277 283
278You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
279C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
280 286
288will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
289or show it again. 295or show it again.
290 296
291Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
292 298
293This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
294space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
295 301
296The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
297extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
298 304
299If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
300(fvwm can do it). 306(fvwm can do it).
301
302=item automove-background
303
304This is basically a very small extension that dynamically changes the
305background pixmap offset to the window position, in effect creating the
306same effect as pseudo transparency with a custom pixmap. No scaling is
307supported in this mode. Example:
308
309 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310 307
311=item block-graphics-to-ascii 308=item block-graphics-to-ascii
312 309
313A not very useful example of filtering all text output to the terminal 310A not very useful example of filtering all text output to the terminal
314by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
319Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
320 317
321=item remote-clipboard 318=item remote-clipboard
322 319
323Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
324selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
325selection somewhere and fetch it again. 322selection somewhere and fetch it again.
326 323
327We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
328means that one command uploads the file to a remote server, and another 325means that one command uploads the file to a remote server, and another
329reads it. 326reads it.
918 local $TERM = shift; 915 local $TERM = shift;
919 my $htype = shift; 916 my $htype = shift;
920 917
921 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
922 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
923 920
924 my %ext_arg; 921 my %ext_arg;
925 922
926 { 923 {
927 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
928 @TERM_INIT = (); 925 @TERM_INIT = ();
1288 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1285 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1289 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1286 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1290 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1287 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1291 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1288 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1292 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1289 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1293 secondaryScreen secondaryScroll selectstyle shade term_name title 1290 secondaryScreen secondaryScroll shade term_name title
1294 transient_for transparent transparent_all tripleclickwords utmpInhibit 1291 transient_for transparent transparent_all tripleclickwords utmpInhibit
1295 visualBell 1292 visualBell
1296 1293
1297=cut 1294=cut
1298 1295
1628automatically be updated. 1625automatically be updated.
1629 1626
1630C<$text> is in a special encoding: tabs and wide characters that use more 1627C<$text> is in a special encoding: tabs and wide characters that use more
1631than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1632characters. Characters with combining characters and other characters that 1629characters. Characters with combining characters and other characters that
1633do not fit into the normal tetx encoding will be replaced with characters 1630do not fit into the normal text encoding will be replaced with characters
1634in the private use area. 1631in the private use area.
1635 1632
1636You have to obey this encoding when changing text. The advantage is 1633You have to obey this encoding when changing text. The advantage is
1637that C<substr> and similar functions work on screen cells and not on 1634that C<substr> and similar functions work on screen cells and not on
1638characters. 1635characters.
1992 ->new 1989 ->new
1993 ->interval (1) 1990 ->interval (1)
1994 ->cb (sub { 1991 ->cb (sub {
1995 $term->{overlay}->set (0, 0, 1992 $term->{overlay}->set (0, 0,
1996 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1993 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1997 }); 1994 });
1998 1995
1999=over 4 1996=over 4
2000 1997
2001=item $timer = new urxvt::timer 1998=item $timer = new urxvt::timer
2002 1999
2045 2042
2046 $term->{socket} = ... 2043 $term->{socket} = ...
2047 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
2048 ->new 2045 ->new
2049 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
2050 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
2051 ->start 2048 ->start
2052 ->cb (sub { 2049 ->cb (sub {
2053 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
2054 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
2055 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
2073Set the file descriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
2074 2071
2075=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
2076 2073
2077Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
2078C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2075C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2079together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
2080 2077
2081=item $iow = $iow->start 2078=item $iow = $iow->start
2082 2079
2083Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
2084 2081
2125 ->new 2122 ->new
2126 ->start ($pid) 2123 ->start ($pid)
2127 ->cb (sub { 2124 ->cb (sub {
2128 my ($pw, $exit_status) = @_; 2125 my ($pw, $exit_status) = @_;
2129 ... 2126 ...
2130 }); 2127 });
2131 2128
2132=over 4 2129=over 4
2133 2130
2134=item $pw = new urxvt::pw 2131=item $pw = new urxvt::pw
2135 2132

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines