… | |
… | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
67 | |
67 | |
68 | You can look at the source of the selection extension to see more |
68 | You can look at the source of the selection extension to see more |
69 | interesting uses, such as parsing a line from beginning to end. |
69 | interesting uses, such as parsing a line from beginning to end. |
70 | |
70 | |
71 | This extension also offers the following bindable keyboard command: |
71 | This extension also offers following bindable keyboard commands: |
72 | |
72 | |
73 | =over 4 |
73 | =over 4 |
74 | |
74 | |
75 | =item rot13 |
75 | =item rot13 |
76 | |
76 | |
… | |
… | |
88 | =item selection-popup (enabled by default) |
88 | =item selection-popup (enabled by default) |
89 | |
89 | |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
91 | text into various other formats/action (such as uri unescaping, perl |
91 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
92 | evalution, web-browser starting etc.), depending on content. |
|
|
93 | |
|
|
94 | Other extensions can extend this popup menu by pushing a code reference onto |
|
|
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
|
|
96 | |
|
|
97 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
98 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
99 | It should either return nothing or a string and a code reference. The |
|
|
100 | string will be used as button text and the code reference will be called |
|
|
101 | when the button gets activated and should transform C<$_>. |
|
|
102 | |
|
|
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
104 | the selection to C<b>s, but only if the selection currently contains any |
|
|
105 | C<a>s: |
|
|
106 | |
|
|
107 | push urxvt::ext::selection_popup::hook, sub { |
|
|
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
109 | : () |
|
|
110 | }; |
93 | |
111 | |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
95 | |
113 | |
96 | Adds regex search functionality to the scrollback buffer, triggered |
114 | Adds regex search functionality to the scrollback buffer, triggered |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
115 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
… | |
… | |
120 | |
138 | |
121 | For example, the following will transform selections of the form |
139 | For example, the following will transform selections of the form |
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
140 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
141 | $word>: |
124 | |
142 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
144 | |
127 | And this example matches the same,but replaces it with vi-commands you can |
145 | And this example matches the same,but replaces it with vi-commands you can |
128 | paste directly into your (vi :) editor: |
146 | paste directly into your (vi :) editor: |
129 | |
147 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
131 | |
149 | |
132 | Of course, this can be modified to suit your needs and your editor :) |
150 | Of course, this can be modified to suit your needs and your editor :) |
133 | |
151 | |
134 | To expand the example above to typical perl error messages ("XXX at |
152 | To expand the example above to typical perl error messages ("XXX at |
135 | FILENAME line YYY."), you need a slightly more elaborate solution: |
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
… | |
… | |
146 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
147 | make them clickable. When middle-clicked, the program specified in the |
165 | make them clickable. When middle-clicked, the program specified in the |
148 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
149 | the URL as first argument. |
167 | the URL as first argument. |
150 | |
168 | |
|
|
169 | =item automove-background |
|
|
170 | |
|
|
171 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
172 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
173 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
174 | |
|
|
175 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
176 | |
151 | =item block-graphics-to-ascii |
177 | =item block-graphics-to-ascii |
152 | |
178 | |
153 | A not very useful example of filtering all text output to the terminal, |
179 | A not very useful example of filtering all text output to the terminal, |
154 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
180 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
155 | similar-looking ascii character. |
181 | similar-looking ascii character. |
… | |
… | |
161 | =item example-refresh-hooks |
187 | =item example-refresh-hooks |
162 | |
188 | |
163 | Displays a very simple digital clock in the upper right corner of the |
189 | Displays a very simple digital clock in the upper right corner of the |
164 | window. Illustrates overwriting the refresh callbacks to create your own |
190 | window. Illustrates overwriting the refresh callbacks to create your own |
165 | overlays or changes. |
191 | overlays or changes. |
|
|
192 | |
|
|
193 | =item selection-pastebin |
|
|
194 | |
|
|
195 | This is a little rarely useful extension that Uploads the selection as |
|
|
196 | textfile to a remote site (or does other things). (The implementation is |
|
|
197 | not currently secure for use in a multiuser environment as it writes to |
|
|
198 | F</tmp> directly.). |
|
|
199 | |
|
|
200 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
201 | i.e. |
|
|
202 | |
|
|
203 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
204 | |
|
|
205 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
206 | the textfile. This command can be set via a resource: |
|
|
207 | |
|
|
208 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
209 | |
|
|
210 | And the default is likely not useful to anybody but the few people around |
|
|
211 | here :) |
|
|
212 | |
|
|
213 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
214 | the same content should lead to the same filename. |
|
|
215 | |
|
|
216 | After a successful upload the selection will be replaced by the text given |
|
|
217 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
218 | for the filename): |
|
|
219 | |
|
|
220 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
166 | |
221 | |
167 | =back |
222 | =back |
168 | |
223 | |
169 | =head1 API DOCUMENTATION |
224 | =head1 API DOCUMENTATION |
170 | |
225 | |
… | |
… | |
387 | =item on_focus_out $term |
442 | =item on_focus_out $term |
388 | |
443 | |
389 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
444 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
390 | focus out processing. |
445 | focus out processing. |
391 | |
446 | |
|
|
447 | =item on_configure_notify $term, $event |
|
|
448 | |
392 | =item on_key_press $term, $event, $keysym, $octets |
449 | =item on_key_press $term, $event, $keysym, $octets |
393 | |
450 | |
394 | =item on_key_release $term, $event, $keysym |
451 | =item on_key_release $term, $event, $keysym |
395 | |
452 | |
396 | =item on_button_press $term, $event |
453 | =item on_button_press $term, $event |
… | |
… | |
480 | |
537 | |
481 | Using this function has the advantage that its output ends up in the |
538 | Using this function has the advantage that its output ends up in the |
482 | correct place, e.g. on stderr of the connecting urxvtc client. |
539 | correct place, e.g. on stderr of the connecting urxvtc client. |
483 | |
540 | |
484 | Messages have a size limit of 1023 bytes currently. |
541 | Messages have a size limit of 1023 bytes currently. |
485 | |
|
|
486 | =item $is_safe = urxvt::safe |
|
|
487 | |
|
|
488 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
489 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
490 | started setuid or setgid. |
|
|
491 | |
542 | |
492 | =item $time = urxvt::NOW |
543 | =item $time = urxvt::NOW |
493 | |
544 | |
494 | Returns the "current time" (as per the event loop). |
545 | Returns the "current time" (as per the event loop). |
495 | |
546 | |
… | |
… | |
572 | =back |
623 | =back |
573 | |
624 | |
574 | =cut |
625 | =cut |
575 | |
626 | |
576 | BEGIN { |
627 | BEGIN { |
577 | urxvt->bootstrap; |
|
|
578 | |
|
|
579 | # overwrite perl's warn |
628 | # overwrite perl's warn |
580 | *CORE::GLOBAL::warn = sub { |
629 | *CORE::GLOBAL::warn = sub { |
581 | my $msg = join "", @_; |
630 | my $msg = join "", @_; |
582 | $msg .= "\n" |
631 | $msg .= "\n" |
583 | unless $msg =~ /\n$/; |
632 | unless $msg =~ /\n$/; |
… | |
… | |
596 | sub verbose { |
645 | sub verbose { |
597 | my ($level, $msg) = @_; |
646 | my ($level, $msg) = @_; |
598 | warn "$msg\n" if $level <= $verbosity; |
647 | warn "$msg\n" if $level <= $verbosity; |
599 | } |
648 | } |
600 | |
649 | |
601 | my $extension_pkg = "extension0000"; |
|
|
602 | my %extension_pkg; |
650 | my %extension_pkg; |
603 | |
651 | |
604 | # load a single script into its own package, once only |
652 | # load a single script into its own package, once only |
605 | sub extension_package($) { |
653 | sub extension_package($) { |
606 | my ($path) = @_; |
654 | my ($path) = @_; |
607 | |
655 | |
|
|
656 | no strict 'refs'; |
|
|
657 | |
608 | $extension_pkg{$path} ||= do { |
658 | $extension_pkg{$path} ||= do { |
609 | my $pkg = "urxvt::" . ($extension_pkg++); |
659 | $path =~ /([^\/\\]+)$/; |
|
|
660 | my $pkg = $1; |
|
|
661 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
662 | $pkg = "urxvt::ext::$pkg"; |
610 | |
663 | |
611 | verbose 3, "loading extension '$path' into package '$pkg'"; |
664 | verbose 3, "loading extension '$path' into package '$pkg'"; |
612 | |
665 | |
613 | open my $fh, "<:raw", $path |
666 | open my $fh, "<:raw", $path |
614 | or die "$path: $!"; |
667 | or die "$path: $!"; |
615 | |
668 | |
|
|
669 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
670 | |
616 | my $source = untaint |
671 | my $source = |
617 | "package $pkg; use strict; use utf8;\n" |
672 | "package $pkg; use strict; use utf8;\n" |
618 | . "use base urxvt::term::extension::;\n" |
|
|
619 | . "#line 1 \"$path\"\n{\n" |
673 | . "#line 1 \"$path\"\n{\n" |
620 | . (do { local $/; <$fh> }) |
674 | . (do { local $/; <$fh> }) |
621 | . "\n};\n1"; |
675 | . "\n};\n1"; |
622 | |
676 | |
623 | eval $source |
677 | eval $source |
… | |
… | |
1182 | |
1236 | |
1183 | =item $max_scrollback = $term->saveLines |
1237 | =item $max_scrollback = $term->saveLines |
1184 | |
1238 | |
1185 | =item $nrow_plus_saveLines = $term->total_rows |
1239 | =item $nrow_plus_saveLines = $term->total_rows |
1186 | |
1240 | |
1187 | =item $lines_in_scrollback = $term->nsaved |
1241 | =item $topmost_scrollback_row = $term->top_row |
1188 | |
1242 | |
1189 | Return various integers describing terminal characteristics. |
1243 | Return various integers describing terminal characteristics. |
1190 | |
1244 | |
1191 | =item $x_display = $term->display_id |
1245 | =item $x_display = $term->display_id |
1192 | |
1246 | |
… | |
… | |
1220 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1274 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1221 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1275 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1222 | |
1276 | |
1223 | =item $view_start = $term->view_start ([$newvalue]) |
1277 | =item $view_start = $term->view_start ([$newvalue]) |
1224 | |
1278 | |
1225 | Returns the negative row number of the topmost line. Minimum value is |
1279 | Returns the row number of the topmost displayed line. Maximum value is |
1226 | C<0>, which displays the normal terminal contents. Larger values scroll |
1280 | C<0>, which displays the normal terminal contents. Lower values scroll |
1227 | this many lines into the scrollback buffer. |
1281 | this many lines into the scrollback buffer. |
1228 | |
1282 | |
1229 | =item $term->want_refresh |
1283 | =item $term->want_refresh |
1230 | |
1284 | |
1231 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1285 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1544 | my $env = $self->{term}->env; |
1598 | my $env = $self->{term}->env; |
1545 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1599 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1546 | delete $env->{LC_ALL}; |
1600 | delete $env->{LC_ALL}; |
1547 | $env->{LC_CTYPE} = $self->{term}->locale; |
1601 | $env->{LC_CTYPE} = $self->{term}->locale; |
1548 | |
1602 | |
1549 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1603 | urxvt::term->new ($env, "popup", |
1550 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1604 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1551 | "--transient-for" => $self->{term}->parent, |
1605 | "--transient-for" => $self->{term}->parent, |
1552 | "-display" => $self->{term}->display_id, |
1606 | "-display" => $self->{term}->display_id, |
1553 | "-pe" => "urxvt-popup") |
1607 | "-pe" => "urxvt-popup") |
1554 | or die "unable to create popup window\n"; |
1608 | or die "unable to create popup window\n"; |
… | |
… | |
1607 | Start the timer. |
1661 | Start the timer. |
1608 | |
1662 | |
1609 | =item $timer = $timer->start ($tstamp) |
1663 | =item $timer = $timer->start ($tstamp) |
1610 | |
1664 | |
1611 | Set the event trigger time to C<$tstamp> and start the timer. |
1665 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1666 | |
|
|
1667 | =item $timer = $timer->after ($delay) |
|
|
1668 | |
|
|
1669 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1612 | |
1670 | |
1613 | =item $timer = $timer->stop |
1671 | =item $timer = $timer->stop |
1614 | |
1672 | |
1615 | Stop the timer. |
1673 | Stop the timer. |
1616 | |
1674 | |