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.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs.
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC

… …
40 40
41 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42 42
43Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
44 44
45 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
46 46
47=over 4 47=over 4
48 48
49=item selection (enabled by default) 49=item selection (enabled by default)
50 50
… …
101 101
102Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed. 104popup is being displayed.
105 105
106It'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
107either 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
108reference. 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
109will 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
110first argument. 110first argument.
111 111
… …
124 124
125Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed. 127popup is being displayed.
128 128
129It'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
130is 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.
131It 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
132string 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
133when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
134 134
135The 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
136the 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
137C<a>s: 137C<a>s:
138 138
139 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : () 141 : ()
142 }; 142 };
143 143
144=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
145 145
… …
276 276
277=item xim-onthespot 277=item xim-onthespot
278 278
279This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
280not 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
281OnTheSpot 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
282kinput2. 282kinput2.
283 283
284You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
286 286
… …
294will 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
295or show it again. 295or show it again.
296 296
297Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
298 298
299This 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
300space 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.
301 301
302The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If 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
306(fvwm can do it). 306(fvwm can do it).
307
308=item automove-background
309
310This is basically a very small extension that dynamically changes the
311background pixmap offset to the window position, in effect creating the
312same effect as pseudo transparency with a custom pixmap. No scaling is
313supported in this mode. Example:
314
315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318shows how this extension can be used to implement an automatically blurred
319transparent background.
320 307
321=item block-graphics-to-ascii 308=item block-graphics-to-ascii
322 309
323A 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
324by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
329Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
330 317
331=item remote-clipboard 318=item remote-clipboard
332 319
333Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
334selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
335selection somewhere and fetch it again. 322selection somewhere and fetch it again.
336 323
337We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
338means 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
339reads it. 326reads it.
… …
2055 2042
2056 $term->{socket} = ... 2043 $term->{socket} = ...
2057 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
2058 ->new 2045 ->new
2059 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
2060 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
2061 ->start 2048 ->start
2062 ->cb (sub { 2049 ->cb (sub {
2063 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
2064 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
2065 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
… …
2083Set the file descriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
2084 2071
2085=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
2086 2073
2087Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
2088C<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
2089together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
2090 2077
2091=item $iow = $iow->start 2078=item $iow = $iow->start
2092 2079
2093Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
2094 2081

Diff Legend

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