… | |
… | |
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 |
173 | for programs that correctly support wide characters). |
145 | for programs that correctly support wide characters). |
174 | |
146 | |
175 | It only works when clicking into the same line (possibly extended over |
147 | To avoid too many false positives, this is only done when: |
176 | multiple rows) as the text cursor and on the primary screen, to reduce the |
148 | |
177 | risk of misinterpreting. The normal selection isn't disabled, so quick |
149 | =over 4 |
|
|
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 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
178 | successive clicks might interfere with selection creation in harmless |
162 | might interfere with selection creation in harmless ways. |
179 | 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. |
180 | |
198 | |
181 | =item tabbed |
199 | =item tabbed |
182 | |
200 | |
183 | This transforms the terminal into a tabbar with additional terminals, that |
201 | This transforms the terminal into a tabbar with additional terminals, that |
184 | 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 |
… | |
… | |
193 | |
211 | |
194 | 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 |
195 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
196 | 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 |
197 | the URL as first argument. |
215 | the URL as first argument. |
|
|
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 |
198 | |
228 | |
199 | =item automove-background |
229 | =item automove-background |
200 | |
230 | |
201 | 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 |
202 | 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 |
… | |
… | |
352 | Called at the very end of initialisation of a new terminal, just before |
382 | Called at the very end of initialisation of a new terminal, just before |
353 | trying to map (display) the toplevel and returning to the mainloop. |
383 | trying to map (display) the toplevel and returning to the mainloop. |
354 | |
384 | |
355 | =item on_destroy $term |
385 | =item on_destroy $term |
356 | |
386 | |
357 | Called whenever something tries to destroy terminal, before doing anything |
387 | Called whenever something tries to destroy terminal, when the terminal is |
358 | yet. If this hook returns true, then destruction is skipped, but this is |
388 | still fully functional (not for long, though). |
359 | rarely a good idea. |
|
|
360 | |
389 | |
361 | =item on_reset $term |
390 | =item on_reset $term |
362 | |
391 | |
363 | Called after the screen is "reset" for any reason, such as resizing or |
392 | Called after the screen is "reset" for any reason, such as resizing or |
364 | control sequences. Here is where you can react on changes to size-related |
393 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
552 | our $LIBDIR; |
581 | our $LIBDIR; |
553 | our $RESNAME; |
582 | our $RESNAME; |
554 | our $RESCLASS; |
583 | our $RESCLASS; |
555 | our $RXVTNAME; |
584 | our $RXVTNAME; |
556 | |
585 | |
557 | our $NOCHAR = chr 0xfffe; |
586 | our $NOCHAR = chr 0xffff; |
558 | |
587 | |
559 | =head2 Variables in the C<urxvt> Package |
588 | =head2 Variables in the C<urxvt> Package |
560 | |
589 | |
561 | =over 4 |
590 | =over 4 |
562 | |
591 | |
… | |
… | |
709 | unless $msg =~ /\n$/; |
738 | unless $msg =~ /\n$/; |
710 | urxvt::warn ($msg); |
739 | urxvt::warn ($msg); |
711 | }; |
740 | }; |
712 | } |
741 | } |
713 | |
742 | |
|
|
743 | no warnings 'utf8'; |
|
|
744 | |
714 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
745 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
715 | |
746 | |
716 | sub verbose { |
747 | sub verbose { |
717 | my ($level, $msg) = @_; |
748 | my ($level, $msg) = @_; |
718 | warn "$msg\n" if $level <= $verbosity; |
749 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
734 | |
765 | |
735 | open my $fh, "<:raw", $path |
766 | open my $fh, "<:raw", $path |
736 | or die "$path: $!"; |
767 | or die "$path: $!"; |
737 | |
768 | |
738 | my $source = |
769 | my $source = |
739 | "package $pkg; use strict; use utf8;\n" |
770 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
740 | . "#line 1 \"$path\"\n{\n" |
771 | . "#line 1 \"$path\"\n{\n" |
741 | . (do { local $/; <$fh> }) |
772 | . (do { local $/; <$fh> }) |
742 | . "\n};\n1"; |
773 | . "\n};\n1"; |
743 | |
774 | |
744 | eval $source |
775 | eval $source |
… | |
… | |
769 | $TERM->register_package ($_) for @pkg; |
800 | $TERM->register_package ($_) for @pkg; |
770 | } |
801 | } |
771 | |
802 | |
772 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
803 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
773 | if ($_ eq "default") { |
804 | if ($_ eq "default") { |
774 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
805 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
775 | } elsif (/^-(.*)$/) { |
806 | } elsif (/^-(.*)$/) { |
776 | delete $ext_arg{$1}; |
807 | delete $ext_arg{$1}; |
777 | } elsif (/^([^<]+)<(.*)>$/) { |
808 | } elsif (/^([^<]+)<(.*)>$/) { |
778 | push @{ $ext_arg{$1} }, $2; |
809 | push @{ $ext_arg{$1} }, $2; |
779 | } else { |
810 | } else { |
… | |
… | |
1299 | Replaces the event mask of the pty watcher by the given event mask. Can |
1330 | Replaces the event mask of the pty watcher by the given event mask. Can |
1300 | be used to suppress input and output handling to the pty/tty. See the |
1331 | be used to suppress input and output handling to the pty/tty. See the |
1301 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1332 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1302 | the previous value. |
1333 | the previous value. |
1303 | |
1334 | |
|
|
1335 | =item $fd = $term->pty_fd |
|
|
1336 | |
|
|
1337 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1338 | is used. |
|
|
1339 | |
1304 | =item $windowid = $term->parent |
1340 | =item $windowid = $term->parent |
1305 | |
1341 | |
1306 | Return the window id of the toplevel window. |
1342 | Return the window id of the toplevel window. |
1307 | |
1343 | |
1308 | =item $windowid = $term->vt |
1344 | =item $windowid = $term->vt |
… | |
… | |
1376 | |
1412 | |
1377 | =item $screen = $term->current_screen |
1413 | =item $screen = $term->current_screen |
1378 | |
1414 | |
1379 | Returns the currently displayed screen (0 primary, 1 secondary). |
1415 | Returns the currently displayed screen (0 primary, 1 secondary). |
1380 | |
1416 | |
|
|
1417 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1418 | |
|
|
1419 | Returns wether the cursor is currently hidden or not. |
|
|
1420 | |
1381 | =item $view_start = $term->view_start ([$newvalue]) |
1421 | =item $view_start = $term->view_start ([$newvalue]) |
1382 | |
1422 | |
1383 | Returns the row number of the topmost displayed line. Maximum value is |
1423 | Returns the row number of the topmost displayed line. Maximum value is |
1384 | C<0>, which displays the normal terminal contents. Lower values scroll |
1424 | C<0>, which displays the normal terminal contents. Lower values scroll |
1385 | this many lines into the scrollback buffer. |
1425 | this many lines into the scrollback buffer. |
… | |
… | |
1403 | If C<$new_text> is specified, it will replace characters in the current |
1443 | If C<$new_text> is specified, it will replace characters in the current |
1404 | line, starting at column C<$start_col> (default C<0>), which is useful |
1444 | line, starting at column C<$start_col> (default C<0>), which is useful |
1405 | to replace only parts of a line. The font index in the rendition will |
1445 | to replace only parts of a line. The font index in the rendition will |
1406 | automatically be updated. |
1446 | automatically be updated. |
1407 | |
1447 | |
1408 | C<$text> is in a special encoding: tabs and wide characters that use |
1448 | C<$text> is in a special encoding: tabs and wide characters that use more |
1409 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1449 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1410 | characters. Characters with combining characters and other characters that |
1450 | characters. Characters with combining characters and other characters that |
1411 | do not fit into the normal tetx encoding will be replaced with characters |
1451 | do not fit into the normal tetx encoding will be replaced with characters |
1412 | in the private use area. |
1452 | in the private use area. |
1413 | |
1453 | |
1414 | You have to obey this encoding when changing text. The advantage is |
1454 | You have to obey this encoding when changing text. The advantage is |