… | |
… | |
66 | contain at least one pair of capturing parentheses, which will be used for |
66 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
71 | |
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
130 | selection. |
137 | selection. |
131 | |
138 | |
132 | =item selection-autotransform |
139 | =item readline (enabled by default) |
133 | |
|
|
134 | This selection allows you to do automatic transforms on a selection |
|
|
135 | whenever a selection is made. |
|
|
136 | |
|
|
137 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
138 | operator) that modify C<$_> as resources: |
|
|
139 | |
|
|
140 | URxvt.selection-autotransform.0: transform |
|
|
141 | URxvt.selection-autotransform.1: transform |
|
|
142 | ... |
|
|
143 | |
|
|
144 | For example, the following will transform selections of the form |
|
|
145 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
146 | $word>: |
|
|
147 | |
|
|
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
149 | |
|
|
150 | And this example matches the same,but replaces it with vi-commands you can |
|
|
151 | paste directly into your (vi :) editor: |
|
|
152 | |
|
|
153 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
154 | |
|
|
155 | Of course, this can be modified to suit your needs and your editor :) |
|
|
156 | |
|
|
157 | To expand the example above to typical perl error messages ("XXX at |
|
|
158 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
159 | |
|
|
160 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
162 | |
|
|
163 | The first line tells the selection code to treat the unchanging part of |
|
|
164 | every error message as a selection pattern, and the second line transforms |
|
|
165 | the message into vi commands to load the file. |
|
|
166 | |
|
|
167 | =item readline |
|
|
168 | |
140 | |
169 | A support package that tries to make editing with readline easier. At the |
141 | A support package that tries to make editing with readline easier. At the |
170 | moment, it reacts to clicking with the left mouse button by trying to |
142 | moment, it reacts to clicking with the left mouse button by trying to |
171 | move the text cursor to this position. It does so by generating as many |
143 | move the text cursor to this position. It does so by generating as many |
172 | cursor-left or cursor-right keypresses as required (the this only works |
144 | cursor-left or cursor-right keypresses as required (the this only works |
… | |
… | |
174 | |
146 | |
175 | To avoid too many false positives, this is only done when: |
147 | To avoid too many false positives, this is only done when: |
176 | |
148 | |
177 | =over 4 |
149 | =over 4 |
178 | |
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
179 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
180 | |
|
|
181 | =item - the primary screen is currently being displayed. |
|
|
182 | |
|
|
183 | =item - the text cursor is visible. |
|
|
184 | |
158 | |
185 | =back |
159 | =back |
186 | |
160 | |
187 | The normal selection mechanism isn't disabled, so quick successive clicks |
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
188 | might interfere with selection creation in harmless ways. |
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
|
|
164 | =item selection-autotransform |
|
|
165 | |
|
|
166 | This selection allows you to do automatic transforms on a selection |
|
|
167 | whenever a selection is made. |
|
|
168 | |
|
|
169 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
170 | operator) that modify C<$_> as resources: |
|
|
171 | |
|
|
172 | URxvt.selection-autotransform.0: transform |
|
|
173 | URxvt.selection-autotransform.1: transform |
|
|
174 | ... |
|
|
175 | |
|
|
176 | For example, the following will transform selections of the form |
|
|
177 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
178 | $word>: |
|
|
179 | |
|
|
180 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
181 | |
|
|
182 | And this example matches the same,but replaces it with vi-commands you can |
|
|
183 | paste directly into your (vi :) editor: |
|
|
184 | |
|
|
185 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
186 | |
|
|
187 | Of course, this can be modified to suit your needs and your editor :) |
|
|
188 | |
|
|
189 | To expand the example above to typical perl error messages ("XXX at |
|
|
190 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
191 | |
|
|
192 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
193 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
194 | |
|
|
195 | The first line tells the selection code to treat the unchanging part of |
|
|
196 | every error message as a selection pattern, and the second line transforms |
|
|
197 | the message into vi commands to load the file. |
189 | |
198 | |
190 | =item tabbed |
199 | =item tabbed |
191 | |
200 | |
192 | This transforms the terminal into a tabbar with additional terminals, that |
201 | This transforms the terminal into a tabbar with additional terminals, that |
193 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
… | |
… | |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
204 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
205 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
206 | the URL as first argument. |
215 | the URL as first argument. |
207 | |
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
228 | |
208 | =item automove-background |
229 | =item automove-background |
209 | |
230 | |
210 | This is basically a one-line extension that dynamically changes the background pixmap offset |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
211 | to the window position, in effect creating the same effect as pseudo transparency with |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
212 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
221 | |
242 | |
222 | =item digital-clock |
243 | =item digital-clock |
223 | |
244 | |
224 | Displays a digital clock using the built-in overlay. |
245 | Displays a digital clock using the built-in overlay. |
225 | |
246 | |
226 | =item example-refresh-hooks |
247 | =item remote-selection |
227 | |
248 | |
228 | Displays a very simple digital clock in the upper right corner of the |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
229 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | selection popup that allows one ti run external commands to store the |
230 | overlays or changes. |
251 | selection somewhere and fetch it again. |
|
|
252 | |
|
|
253 | We use it to implement a "distributed selection mechanism", which just |
|
|
254 | means that one command uploads the file to a remote server, and another |
|
|
255 | reads it. |
|
|
256 | |
|
|
257 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
258 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
259 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
260 | the selection data on STDOUT (also in UTF-8). |
|
|
261 | |
|
|
262 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
263 | |
|
|
264 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
265 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
231 | |
266 | |
232 | =item selection-pastebin |
267 | =item selection-pastebin |
233 | |
268 | |
234 | This is a little rarely useful extension that Uploads the selection as |
269 | This is a little rarely useful extension that Uploads the selection as |
235 | textfile to a remote site (or does other things). (The implementation is |
270 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
255 | After a successful upload the selection will be replaced by the text given |
290 | After a successful upload the selection will be replaced by the text given |
256 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
257 | for the filename): |
292 | for the filename): |
258 | |
293 | |
259 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
295 | |
|
|
296 | =item example-refresh-hooks |
|
|
297 | |
|
|
298 | Displays a very simple digital clock in the upper right corner of the |
|
|
299 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
300 | overlays or changes. |
260 | |
301 | |
261 | =back |
302 | =back |
262 | |
303 | |
263 | =head1 API DOCUMENTATION |
304 | =head1 API DOCUMENTATION |
264 | |
305 | |
… | |
… | |
361 | Called at the very end of initialisation of a new terminal, just before |
402 | Called at the very end of initialisation of a new terminal, just before |
362 | trying to map (display) the toplevel and returning to the mainloop. |
403 | trying to map (display) the toplevel and returning to the mainloop. |
363 | |
404 | |
364 | =item on_destroy $term |
405 | =item on_destroy $term |
365 | |
406 | |
366 | Called whenever something tries to destroy terminal, before doing anything |
407 | Called whenever something tries to destroy terminal, when the terminal is |
367 | yet. If this hook returns true, then destruction is skipped, but this is |
408 | still fully functional (not for long, though). |
368 | rarely a good idea. |
|
|
369 | |
409 | |
370 | =item on_reset $term |
410 | =item on_reset $term |
371 | |
411 | |
372 | Called after the screen is "reset" for any reason, such as resizing or |
412 | Called after the screen is "reset" for any reason, such as resizing or |
373 | control sequences. Here is where you can react on changes to size-related |
413 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
561 | our $LIBDIR; |
601 | our $LIBDIR; |
562 | our $RESNAME; |
602 | our $RESNAME; |
563 | our $RESCLASS; |
603 | our $RESCLASS; |
564 | our $RXVTNAME; |
604 | our $RXVTNAME; |
565 | |
605 | |
566 | our $NOCHAR = chr 0xfffe; |
606 | our $NOCHAR = chr 0xffff; |
567 | |
607 | |
568 | =head2 Variables in the C<urxvt> Package |
608 | =head2 Variables in the C<urxvt> Package |
569 | |
609 | |
570 | =over 4 |
610 | =over 4 |
571 | |
611 | |
… | |
… | |
718 | unless $msg =~ /\n$/; |
758 | unless $msg =~ /\n$/; |
719 | urxvt::warn ($msg); |
759 | urxvt::warn ($msg); |
720 | }; |
760 | }; |
721 | } |
761 | } |
722 | |
762 | |
|
|
763 | no warnings 'utf8'; |
|
|
764 | |
723 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
765 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
724 | |
766 | |
725 | sub verbose { |
767 | sub verbose { |
726 | my ($level, $msg) = @_; |
768 | my ($level, $msg) = @_; |
727 | warn "$msg\n" if $level <= $verbosity; |
769 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
743 | |
785 | |
744 | open my $fh, "<:raw", $path |
786 | open my $fh, "<:raw", $path |
745 | or die "$path: $!"; |
787 | or die "$path: $!"; |
746 | |
788 | |
747 | my $source = |
789 | my $source = |
748 | "package $pkg; use strict; use utf8;\n" |
790 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
749 | . "#line 1 \"$path\"\n{\n" |
791 | . "#line 1 \"$path\"\n{\n" |
750 | . (do { local $/; <$fh> }) |
792 | . (do { local $/; <$fh> }) |
751 | . "\n};\n1"; |
793 | . "\n};\n1"; |
752 | |
794 | |
753 | eval $source |
795 | eval $source |
… | |
… | |
778 | $TERM->register_package ($_) for @pkg; |
820 | $TERM->register_package ($_) for @pkg; |
779 | } |
821 | } |
780 | |
822 | |
781 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
823 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
782 | if ($_ eq "default") { |
824 | if ($_ eq "default") { |
783 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
825 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
784 | } elsif (/^-(.*)$/) { |
826 | } elsif (/^-(.*)$/) { |
785 | delete $ext_arg{$1}; |
827 | delete $ext_arg{$1}; |
786 | } elsif (/^([^<]+)<(.*)>$/) { |
828 | } elsif (/^([^<]+)<(.*)>$/) { |
787 | push @{ $ext_arg{$1} }, $2; |
829 | push @{ $ext_arg{$1} }, $2; |
788 | } else { |
830 | } else { |
… | |
… | |
1308 | Replaces the event mask of the pty watcher by the given event mask. Can |
1350 | Replaces the event mask of the pty watcher by the given event mask. Can |
1309 | be used to suppress input and output handling to the pty/tty. See the |
1351 | be used to suppress input and output handling to the pty/tty. See the |
1310 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1352 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1311 | the previous value. |
1353 | the previous value. |
1312 | |
1354 | |
|
|
1355 | =item $fd = $term->pty_fd |
|
|
1356 | |
|
|
1357 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1358 | is used. |
|
|
1359 | |
1313 | =item $windowid = $term->parent |
1360 | =item $windowid = $term->parent |
1314 | |
1361 | |
1315 | Return the window id of the toplevel window. |
1362 | Return the window id of the toplevel window. |
1316 | |
1363 | |
1317 | =item $windowid = $term->vt |
1364 | =item $windowid = $term->vt |
… | |
… | |
1416 | If C<$new_text> is specified, it will replace characters in the current |
1463 | If C<$new_text> is specified, it will replace characters in the current |
1417 | line, starting at column C<$start_col> (default C<0>), which is useful |
1464 | line, starting at column C<$start_col> (default C<0>), which is useful |
1418 | to replace only parts of a line. The font index in the rendition will |
1465 | to replace only parts of a line. The font index in the rendition will |
1419 | automatically be updated. |
1466 | automatically be updated. |
1420 | |
1467 | |
1421 | C<$text> is in a special encoding: tabs and wide characters that use |
1468 | C<$text> is in a special encoding: tabs and wide characters that use more |
1422 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1469 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1423 | characters. Characters with combining characters and other characters that |
1470 | characters. Characters with combining characters and other characters that |
1424 | do not fit into the normal tetx encoding will be replaced with characters |
1471 | do not fit into the normal tetx encoding will be replaced with characters |
1425 | in the private use area. |
1472 | in the private use area. |
1426 | |
1473 | |
1427 | You have to obey this encoding when changing text. The advantage is |
1474 | You have to obey this encoding when changing text. The advantage is |