… | |
… | |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
|
|
33 | |
31 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
32 | |
35 | |
33 | This section describes the extensions delivered with this release. You can |
36 | This section describes the extensions delivered with this release. You can |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
37 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
38 | |
… | |
… | |
37 | |
40 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
39 | |
42 | |
40 | Or by adding them to the resource for extensions loaded by default: |
43 | Or 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 | |
99 | Other extensions can extend this popup menu by pushing a code reference |
102 | Other extensions can extend this popup menu by pushing a code reference |
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
101 | popup is being displayed. |
104 | popup is being displayed. |
102 | |
105 | |
103 | It's sole argument is the popup menu, which can be modified. It should |
106 | Its sole argument is the popup menu, which can be modified. It should |
104 | either return nothing or a string, the initial boolean value and a code |
107 | either return nothing or a string, the initial boolean value and a code |
105 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
106 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
107 | first argument. |
110 | first argument. |
108 | |
111 | |
… | |
… | |
121 | |
124 | |
122 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
127 | popup is being displayed. |
125 | |
128 | |
126 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
127 | is in C<$_>, which can be used to decide whether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
128 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
129 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
130 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
131 | |
134 | |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
133 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
134 | C<a>s: |
137 | C<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 | |
… | |
… | |
149 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
150 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
153 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
154 | selection. |
157 | selection if the C<Shift> modifier is active. |
155 | |
158 | |
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
161 | or 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 | |
164 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
166 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
167 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
168 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
169 | |
172 | |
170 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
171 | |
174 | |
172 | =over 4 |
175 | =over 4 |
… | |
… | |
256 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
257 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
258 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
259 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
260 | |
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
261 | Example configuration: |
267 | Example 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 | |
273 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
274 | not work perfectly, and some input methods don't seem to work well with |
280 | not work perfectly, and some input methods don't seem to work well with |
275 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
276 | kinput2. |
282 | kinput2. |
277 | |
283 | |
278 | You enable it by specifying this extension and a preedit style of |
284 | You enable it by specifying this extension and a preedit style of |
279 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
280 | |
286 | |
… | |
… | |
288 | will show or hide itself. Another press of the accelerator key will hide |
294 | will show or hide itself. Another press of the accelerator key will hide |
289 | or show it again. |
295 | or show it again. |
290 | |
296 | |
291 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
292 | |
298 | |
293 | This is useful if you need a single terminal thats not using any desktop |
299 | This is useful if you need a single terminal that is not using any desktop |
294 | space most of the time but is quickly available at the press of a key. |
300 | space most of the time but is quickly available at the press of a key. |
295 | |
301 | |
296 | The accelerator key is grabbed regardless of any modifiers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
297 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
298 | |
304 | |
299 | If you want a quake-like animation, tell your window manager to do so |
305 | If 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 | |
|
|
304 | This is basically a very small extension that dynamically changes the |
|
|
305 | background pixmap offset to the window position, in effect creating the |
|
|
306 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
307 | supported in this mode. Example: |
|
|
308 | |
|
|
309 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
310 | |
|
|
311 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
312 | shows how this extension can be used to implement an automatically blurred |
|
|
313 | transparent background. |
|
|
314 | |
307 | |
315 | =item block-graphics-to-ascii |
308 | =item block-graphics-to-ascii |
316 | |
309 | |
317 | A not very useful example of filtering all text output to the terminal |
310 | A not very useful example of filtering all text output to the terminal |
318 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
323 | Displays a digital clock using the built-in overlay. |
316 | Displays a digital clock using the built-in overlay. |
324 | |
317 | |
325 | =item remote-clipboard |
318 | =item remote-clipboard |
326 | |
319 | |
327 | Somewhat of a misnomer, this extension adds two menu entries to the |
320 | Somewhat of a misnomer, this extension adds two menu entries to the |
328 | selection popup that allows one ti run external commands to store the |
321 | selection popup that allows one to run external commands to store the |
329 | selection somewhere and fetch it again. |
322 | selection somewhere and fetch it again. |
330 | |
323 | |
331 | We use it to implement a "distributed selection mechanism", which just |
324 | We use it to implement a "distributed selection mechanism", which just |
332 | means that one command uploads the file to a remote server, and another |
325 | means that one command uploads the file to a remote server, and another |
333 | reads it. |
326 | reads it. |
… | |
… | |
922 | local $TERM = shift; |
915 | local $TERM = shift; |
923 | my $htype = shift; |
916 | my $htype = shift; |
924 | |
917 | |
925 | if ($htype == 0) { # INIT |
918 | if ($htype == 0) { # INIT |
926 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
919 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
927 | |
920 | |
928 | my %ext_arg; |
921 | my %ext_arg; |
929 | |
922 | |
930 | { |
923 | { |
931 | my @init = @TERM_INIT; |
924 | my @init = @TERM_INIT; |
932 | @TERM_INIT = (); |
925 | @TERM_INIT = (); |
… | |
… | |
1996 | ->new |
1989 | ->new |
1997 | ->interval (1) |
1990 | ->interval (1) |
1998 | ->cb (sub { |
1991 | ->cb (sub { |
1999 | $term->{overlay}->set (0, 0, |
1992 | $term->{overlay}->set (0, 0, |
2000 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1993 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2001 | }); |
1994 | }); |
2002 | |
1995 | |
2003 | =over 4 |
1996 | =over 4 |
2004 | |
1997 | |
2005 | =item $timer = new urxvt::timer |
1998 | =item $timer = new urxvt::timer |
2006 | |
1999 | |
… | |
… | |
2049 | |
2042 | |
2050 | $term->{socket} = ... |
2043 | $term->{socket} = ... |
2051 | $term->{iow} = urxvt::iow |
2044 | $term->{iow} = urxvt::iow |
2052 | ->new |
2045 | ->new |
2053 | ->fd (fileno $term->{socket}) |
2046 | ->fd (fileno $term->{socket}) |
2054 | ->events (urxvt::EVENT_READ) |
2047 | ->events (urxvt::EV_READ) |
2055 | ->start |
2048 | ->start |
2056 | ->cb (sub { |
2049 | ->cb (sub { |
2057 | my ($iow, $revents) = @_; |
2050 | my ($iow, $revents) = @_; |
2058 | # $revents must be 1 here, no need to check |
2051 | # $revents must be 1 here, no need to check |
2059 | sysread $term->{socket}, my $buf, 8192 |
2052 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2077 | Set the file descriptor (not handle) to watch. |
2070 | Set the file descriptor (not handle) to watch. |
2078 | |
2071 | |
2079 | =item $iow = $iow->events ($eventmask) |
2072 | =item $iow = $iow->events ($eventmask) |
2080 | |
2073 | |
2081 | Set the event mask to watch. The only allowed values are |
2074 | Set the event mask to watch. The only allowed values are |
2082 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2075 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2083 | together, or C<urxvt::EVENT_NONE>. |
2076 | together, or C<urxvt::EV_NONE>. |
2084 | |
2077 | |
2085 | =item $iow = $iow->start |
2078 | =item $iow = $iow->start |
2086 | |
2079 | |
2087 | Start watching for requested events on the given handle. |
2080 | Start watching for requested events on the given handle. |
2088 | |
2081 | |
… | |
… | |
2129 | ->new |
2122 | ->new |
2130 | ->start ($pid) |
2123 | ->start ($pid) |
2131 | ->cb (sub { |
2124 | ->cb (sub { |
2132 | my ($pw, $exit_status) = @_; |
2125 | my ($pw, $exit_status) = @_; |
2133 | ... |
2126 | ... |
2134 | }); |
2127 | }); |
2135 | |
2128 | |
2136 | =over 4 |
2129 | =over 4 |
2137 | |
2130 | |
2138 | =item $pw = new urxvt::pw |
2131 | =item $pw = new urxvt::pw |
2139 | |
2132 | |