… | |
… | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
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 | |
|
|
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
|
|
32 | and "perl-ext-common" resources to the empty string. |
30 | |
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/>. |
… | |
… | |
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 | |
… | |
… | |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
243 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
241 | |
244 | |
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
245 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
243 | indices. |
246 | indices. |
244 | |
247 | |
245 | =item mark-urls |
248 | =item matcher |
246 | |
249 | |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
250 | Uses per-line display filtering (C<on_line_update>) to underline text |
248 | make them clickable. When middle-clicked, the program specified in the |
251 | matching a certain pattern and make it clickable. When clicked with the |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
252 | mouse button specified in the C<matcher.button> resource (default 2, or |
250 | the URL as first argument. |
253 | middle), the program specified in the C<matcher.launcher> resource |
|
|
254 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
255 | with the matched text as first argument. The default configuration is |
|
|
256 | suitable for matching URLs and launching a web browser, like the |
|
|
257 | former "mark-urls" extension. |
|
|
258 | |
|
|
259 | The default pattern to match URLs can be overridden with the |
|
|
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
261 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
262 | The launcher can also be overridden on a per-pattern basis. |
|
|
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 | |
|
|
267 | Example configuration: |
|
|
268 | |
|
|
269 | URxvt.perl-ext: default,matcher |
|
|
270 | URxvt.urlLauncher: sensible-browser |
|
|
271 | URxvt.keysym.C-Delete: perl:matcher |
|
|
272 | URxvt.matcher.button: 1 |
|
|
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
251 | |
276 | |
252 | =item xim-onthespot |
277 | =item xim-onthespot |
253 | |
278 | |
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
255 | 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 |
256 | 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 |
257 | kinput2. |
282 | kinput2. |
258 | |
283 | |
259 | 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 |
260 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
261 | |
286 | |
… | |
… | |
269 | 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 |
270 | or show it again. |
295 | or show it again. |
271 | |
296 | |
272 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
273 | |
298 | |
274 | 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 |
275 | 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. |
276 | |
301 | |
277 | The accelerator key is grabbed regardless of any modifiers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
278 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
279 | |
304 | |
… | |
… | |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
312 | same effect as pseudo transparency with a custom pixmap. No scaling is |
288 | supported in this mode. Example: |
313 | supported in this mode. Example: |
289 | |
314 | |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
315 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
291 | |
316 | |
|
|
317 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
318 | shows how this extension can be used to implement an automatically blurred |
|
|
319 | transparent background. |
|
|
320 | |
292 | =item block-graphics-to-ascii |
321 | =item block-graphics-to-ascii |
293 | |
322 | |
294 | A not very useful example of filtering all text output to the terminal |
323 | A not very useful example of filtering all text output to the terminal |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
324 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
296 | similar-looking ascii character. |
325 | similar-looking ascii character. |
… | |
… | |
300 | Displays a digital clock using the built-in overlay. |
329 | Displays a digital clock using the built-in overlay. |
301 | |
330 | |
302 | =item remote-clipboard |
331 | =item remote-clipboard |
303 | |
332 | |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
333 | Somewhat of a misnomer, this extension adds two menu entries to the |
305 | selection popup that allows one ti run external commands to store the |
334 | selection popup that allows one to run external commands to store the |
306 | selection somewhere and fetch it again. |
335 | selection somewhere and fetch it again. |
307 | |
336 | |
308 | We use it to implement a "distributed selection mechanism", which just |
337 | We use it to implement a "distributed selection mechanism", which just |
309 | means that one command uploads the file to a remote server, and another |
338 | means that one command uploads the file to a remote server, and another |
310 | reads it. |
339 | reads it. |
… | |
… | |
345 | After a successful upload the selection will be replaced by the text given |
374 | After a successful upload the selection will be replaced by the text given |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
375 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
347 | for the filename): |
376 | for the filename): |
348 | |
377 | |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
378 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
379 | |
|
|
380 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
381 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
382 | which works regardless of wether xrdb is used to parse the resource file |
|
|
383 | or not. |
350 | |
384 | |
351 | =item example-refresh-hooks |
385 | =item example-refresh-hooks |
352 | |
386 | |
353 | Displays a very simple digital clock in the upper right corner of the |
387 | Displays a very simple digital clock in the upper right corner of the |
354 | window. Illustrates overwriting the refresh callbacks to create your own |
388 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
894 | local $TERM = shift; |
928 | local $TERM = shift; |
895 | my $htype = shift; |
929 | my $htype = shift; |
896 | |
930 | |
897 | if ($htype == 0) { # INIT |
931 | if ($htype == 0) { # INIT |
898 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
932 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
899 | |
933 | |
900 | my %ext_arg; |
934 | my %ext_arg; |
901 | |
935 | |
902 | { |
936 | { |
903 | my @init = @TERM_INIT; |
937 | my @init = @TERM_INIT; |
904 | @TERM_INIT = (); |
938 | @TERM_INIT = (); |
… | |
… | |
967 | |
1001 | |
968 | sub SET_COLOR($$$) { |
1002 | sub SET_COLOR($$$) { |
969 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
1003 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
970 | } |
1004 | } |
971 | |
1005 | |
|
|
1006 | sub rend2mask { |
|
|
1007 | no strict 'refs'; |
|
|
1008 | my ($str, $mask) = (@_, 0); |
|
|
1009 | my %color = ( fg => undef, bg => undef ); |
|
|
1010 | my @failed; |
|
|
1011 | for my $spec ( split /\s+/, $str ) { |
|
|
1012 | if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) { |
|
|
1013 | $color{lc($1)} = $2; |
|
|
1014 | } else { |
|
|
1015 | my $neg = $spec =~ s/^[-^]//; |
|
|
1016 | unless ( exists &{"RS_$spec"} ) { |
|
|
1017 | push @failed, $spec; |
|
|
1018 | next; |
|
|
1019 | } |
|
|
1020 | my $cur = &{"RS_$spec"}; |
|
|
1021 | if ( $neg ) { |
|
|
1022 | $mask &= ~$cur; |
|
|
1023 | } else { |
|
|
1024 | $mask |= $cur; |
|
|
1025 | } |
|
|
1026 | } |
|
|
1027 | } |
|
|
1028 | ($mask, @color{qw(fg bg)}, \@failed) |
|
|
1029 | } |
|
|
1030 | |
972 | # urxvt::term::extension |
1031 | # urxvt::term::extension |
973 | |
1032 | |
974 | package urxvt::term::extension; |
1033 | package urxvt::term::extension; |
975 | |
1034 | |
976 | sub enable { |
1035 | sub enable { |
… | |
… | |
1087 | sub DESTROY { |
1146 | sub DESTROY { |
1088 | $_[0][1]->stop; |
1147 | $_[0][1]->stop; |
1089 | } |
1148 | } |
1090 | |
1149 | |
1091 | sub condvar { |
1150 | sub condvar { |
1092 | bless \my $flag, urxvt::anyevent::condvar:: |
1151 | bless \my $flag, urxvt::anyevent:: |
1093 | } |
1152 | } |
1094 | |
1153 | |
1095 | sub urxvt::anyevent::condvar::broadcast { |
1154 | sub broadcast { |
1096 | ${$_[0]}++; |
1155 | ${$_[0]}++; |
1097 | } |
1156 | } |
1098 | |
1157 | |
1099 | sub urxvt::anyevent::condvar::wait { |
1158 | sub wait { |
1100 | unless (${$_[0]}) { |
1159 | unless (${$_[0]}) { |
1101 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1160 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1102 | } |
1161 | } |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | sub one_event { |
|
|
1165 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1103 | } |
1166 | } |
1104 | |
1167 | |
1105 | package urxvt::term; |
1168 | package urxvt::term; |
1106 | |
1169 | |
1107 | =head2 The C<urxvt::term> Class |
1170 | =head2 The C<urxvt::term> Class |
… | |
… | |
1927 | |
1990 | |
1928 | =cut |
1991 | =cut |
1929 | |
1992 | |
1930 | package urxvt::watcher; |
1993 | package urxvt::watcher; |
1931 | |
1994 | |
1932 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1933 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1934 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1935 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1936 | |
|
|
1937 | =head2 The C<urxvt::timer> Class |
1995 | =head2 The C<urxvt::timer> Class |
1938 | |
1996 | |
1939 | This class implements timer watchers/events. Time is represented as a |
1997 | This class implements timer watchers/events. Time is represented as a |
1940 | fractional number of seconds since the epoch. Example: |
1998 | fractional number of seconds since the epoch. Example: |
1941 | |
1999 | |
… | |
… | |
1944 | ->new |
2002 | ->new |
1945 | ->interval (1) |
2003 | ->interval (1) |
1946 | ->cb (sub { |
2004 | ->cb (sub { |
1947 | $term->{overlay}->set (0, 0, |
2005 | $term->{overlay}->set (0, 0, |
1948 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2006 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1949 | }); |
2007 | }); |
1950 | |
2008 | |
1951 | =over 4 |
2009 | =over 4 |
1952 | |
2010 | |
1953 | =item $timer = new urxvt::timer |
2011 | =item $timer = new urxvt::timer |
1954 | |
2012 | |
… | |
… | |
1997 | |
2055 | |
1998 | $term->{socket} = ... |
2056 | $term->{socket} = ... |
1999 | $term->{iow} = urxvt::iow |
2057 | $term->{iow} = urxvt::iow |
2000 | ->new |
2058 | ->new |
2001 | ->fd (fileno $term->{socket}) |
2059 | ->fd (fileno $term->{socket}) |
2002 | ->events (urxvt::EVENT_READ) |
2060 | ->events (urxvt::EV_READ) |
2003 | ->start |
2061 | ->start |
2004 | ->cb (sub { |
2062 | ->cb (sub { |
2005 | my ($iow, $revents) = @_; |
2063 | my ($iow, $revents) = @_; |
2006 | # $revents must be 1 here, no need to check |
2064 | # $revents must be 1 here, no need to check |
2007 | sysread $term->{socket}, my $buf, 8192 |
2065 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2025 | Set the file descriptor (not handle) to watch. |
2083 | Set the file descriptor (not handle) to watch. |
2026 | |
2084 | |
2027 | =item $iow = $iow->events ($eventmask) |
2085 | =item $iow = $iow->events ($eventmask) |
2028 | |
2086 | |
2029 | Set the event mask to watch. The only allowed values are |
2087 | Set the event mask to watch. The only allowed values are |
2030 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2088 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2031 | together, or C<urxvt::EVENT_NONE>. |
2089 | together, or C<urxvt::EV_NONE>. |
2032 | |
2090 | |
2033 | =item $iow = $iow->start |
2091 | =item $iow = $iow->start |
2034 | |
2092 | |
2035 | Start watching for requested events on the given handle. |
2093 | Start watching for requested events on the given handle. |
2036 | |
2094 | |
… | |
… | |
2077 | ->new |
2135 | ->new |
2078 | ->start ($pid) |
2136 | ->start ($pid) |
2079 | ->cb (sub { |
2137 | ->cb (sub { |
2080 | my ($pw, $exit_status) = @_; |
2138 | my ($pw, $exit_status) = @_; |
2081 | ... |
2139 | ... |
2082 | }); |
2140 | }); |
2083 | |
2141 | |
2084 | =over 4 |
2142 | =over 4 |
2085 | |
2143 | |
2086 | =item $pw = new urxvt::pw |
2144 | =item $pw = new urxvt::pw |
2087 | |
2145 | |
… | |
… | |
2126 | http://software.schmorp.de/pkg/rxvt-unicode |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
2127 | |
2185 | |
2128 | =cut |
2186 | =cut |
2129 | |
2187 | |
2130 | 1 |
2188 | 1 |
|
|
2189 | |
|
|
2190 | # vim: sw=3: |