… | |
… | |
76 | |
76 | |
77 | Rot-13 the selection when activated. Used via keyboard trigger: |
77 | Rot-13 the selection when activated. Used via keyboard trigger: |
78 | |
78 | |
79 | URxvt.keysym.C-M-r: perl:selection:rot13 |
79 | URxvt.keysym.C-M-r: perl:selection:rot13 |
80 | |
80 | |
81 | =item remote-pastebin |
|
|
82 | |
|
|
83 | Upload the selection as textfile to a remote site. |
|
|
84 | |
|
|
85 | URxvt.keysym.C-M-e: perl:selection:remote-pastebin |
|
|
86 | |
|
|
87 | To set the command to upload the file set this resource: |
|
|
88 | |
|
|
89 | URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
90 | |
|
|
91 | The % is the placeholder for the textfile. The name of the textfile is the hex encoded |
|
|
92 | md5 sum of the selection. |
|
|
93 | After an successful upload the selection will be replaced by the following url |
|
|
94 | (the % is the placeholder for the filename): |
|
|
95 | |
|
|
96 | URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% |
|
|
97 | |
|
|
98 | =back |
81 | =back |
99 | |
82 | |
100 | =item option-popup (enabled by default) |
83 | =item option-popup (enabled by default) |
101 | |
84 | |
102 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
85 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
… | |
… | |
105 | =item selection-popup (enabled by default) |
88 | =item selection-popup (enabled by default) |
106 | |
89 | |
107 | 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 |
108 | text into various other formats/action (such as uri unescaping, perl |
91 | text into various other formats/action (such as uri unescaping, perl |
109 | 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 | }; |
110 | |
111 | |
111 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | |
113 | |
113 | Adds regex search functionality to the scrollback buffer, triggered |
114 | Adds regex search functionality to the scrollback buffer, triggered |
114 | 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 |
… | |
… | |
163 | 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 |
164 | make them clickable. When middle-clicked, the program specified in the |
165 | make them clickable. When middle-clicked, the program specified in the |
165 | 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 |
166 | the URL as first argument. |
167 | the URL as first argument. |
167 | |
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 | |
168 | =item block-graphics-to-ascii |
177 | =item block-graphics-to-ascii |
169 | |
178 | |
170 | 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, |
171 | 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 |
172 | similar-looking ascii character. |
181 | similar-looking ascii character. |
… | |
… | |
178 | =item example-refresh-hooks |
187 | =item example-refresh-hooks |
179 | |
188 | |
180 | 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 |
181 | window. Illustrates overwriting the refresh callbacks to create your own |
190 | window. Illustrates overwriting the refresh callbacks to create your own |
182 | 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/% |
183 | |
221 | |
184 | =back |
222 | =back |
185 | |
223 | |
186 | =head1 API DOCUMENTATION |
224 | =head1 API DOCUMENTATION |
187 | |
225 | |
… | |
… | |
404 | =item on_focus_out $term |
442 | =item on_focus_out $term |
405 | |
443 | |
406 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
444 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
407 | focus out processing. |
445 | focus out processing. |
408 | |
446 | |
|
|
447 | =item on_configure_notify $term, $event |
|
|
448 | |
409 | =item on_key_press $term, $event, $keysym, $octets |
449 | =item on_key_press $term, $event, $keysym, $octets |
410 | |
450 | |
411 | =item on_key_release $term, $event, $keysym |
451 | =item on_key_release $term, $event, $keysym |
412 | |
452 | |
413 | =item on_button_press $term, $event |
453 | =item on_button_press $term, $event |
… | |
… | |
497 | |
537 | |
498 | 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 |
499 | correct place, e.g. on stderr of the connecting urxvtc client. |
539 | correct place, e.g. on stderr of the connecting urxvtc client. |
500 | |
540 | |
501 | Messages have a size limit of 1023 bytes currently. |
541 | Messages have a size limit of 1023 bytes currently. |
502 | |
|
|
503 | =item $is_safe = urxvt::safe |
|
|
504 | |
|
|
505 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
506 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
507 | started setuid or setgid. |
|
|
508 | |
542 | |
509 | =item $time = urxvt::NOW |
543 | =item $time = urxvt::NOW |
510 | |
544 | |
511 | Returns the "current time" (as per the event loop). |
545 | Returns the "current time" (as per the event loop). |
512 | |
546 | |
… | |
… | |
589 | =back |
623 | =back |
590 | |
624 | |
591 | =cut |
625 | =cut |
592 | |
626 | |
593 | BEGIN { |
627 | BEGIN { |
594 | urxvt->bootstrap; |
|
|
595 | |
|
|
596 | # overwrite perl's warn |
628 | # overwrite perl's warn |
597 | *CORE::GLOBAL::warn = sub { |
629 | *CORE::GLOBAL::warn = sub { |
598 | my $msg = join "", @_; |
630 | my $msg = join "", @_; |
599 | $msg .= "\n" |
631 | $msg .= "\n" |
600 | unless $msg =~ /\n$/; |
632 | unless $msg =~ /\n$/; |
… | |
… | |
613 | sub verbose { |
645 | sub verbose { |
614 | my ($level, $msg) = @_; |
646 | my ($level, $msg) = @_; |
615 | warn "$msg\n" if $level <= $verbosity; |
647 | warn "$msg\n" if $level <= $verbosity; |
616 | } |
648 | } |
617 | |
649 | |
618 | my $extension_pkg = "extension0000"; |
|
|
619 | my %extension_pkg; |
650 | my %extension_pkg; |
620 | |
651 | |
621 | # load a single script into its own package, once only |
652 | # load a single script into its own package, once only |
622 | sub extension_package($) { |
653 | sub extension_package($) { |
623 | my ($path) = @_; |
654 | my ($path) = @_; |
624 | |
655 | |
|
|
656 | no strict 'refs'; |
|
|
657 | |
625 | $extension_pkg{$path} ||= do { |
658 | $extension_pkg{$path} ||= do { |
626 | my $pkg = "urxvt::" . ($extension_pkg++); |
659 | $path =~ /([^\/\\]+)$/; |
|
|
660 | my $pkg = $1; |
|
|
661 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
662 | $pkg = "urxvt::ext::$pkg"; |
627 | |
663 | |
628 | verbose 3, "loading extension '$path' into package '$pkg'"; |
664 | verbose 3, "loading extension '$path' into package '$pkg'"; |
629 | |
665 | |
630 | open my $fh, "<:raw", $path |
666 | open my $fh, "<:raw", $path |
631 | or die "$path: $!"; |
667 | or die "$path: $!"; |
632 | |
668 | |
|
|
669 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
670 | |
633 | my $source = untaint |
671 | my $source = |
634 | "package $pkg; use strict; use utf8;\n" |
672 | "package $pkg; use strict; use utf8;\n" |
635 | . "use base urxvt::term::extension::;\n" |
|
|
636 | . "#line 1 \"$path\"\n{\n" |
673 | . "#line 1 \"$path\"\n{\n" |
637 | . (do { local $/; <$fh> }) |
674 | . (do { local $/; <$fh> }) |
638 | . "\n};\n1"; |
675 | . "\n};\n1"; |
639 | |
676 | |
640 | eval $source |
677 | eval $source |
… | |
… | |
1561 | my $env = $self->{term}->env; |
1598 | my $env = $self->{term}->env; |
1562 | # 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. |
1563 | delete $env->{LC_ALL}; |
1600 | delete $env->{LC_ALL}; |
1564 | $env->{LC_CTYPE} = $self->{term}->locale; |
1601 | $env->{LC_CTYPE} = $self->{term}->locale; |
1565 | |
1602 | |
1566 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1603 | urxvt::term->new ($env, "popup", |
1567 | "--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, |
1568 | "--transient-for" => $self->{term}->parent, |
1605 | "--transient-for" => $self->{term}->parent, |
1569 | "-display" => $self->{term}->display_id, |
1606 | "-display" => $self->{term}->display_id, |
1570 | "-pe" => "urxvt-popup") |
1607 | "-pe" => "urxvt-popup") |
1571 | or die "unable to create popup window\n"; |
1608 | or die "unable to create popup window\n"; |
… | |
… | |
1624 | Start the timer. |
1661 | Start the timer. |
1625 | |
1662 | |
1626 | =item $timer = $timer->start ($tstamp) |
1663 | =item $timer = $timer->start ($tstamp) |
1627 | |
1664 | |
1628 | 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>. |
1629 | |
1670 | |
1630 | =item $timer = $timer->stop |
1671 | =item $timer = $timer->stop |
1631 | |
1672 | |
1632 | Stop the timer. |
1673 | Stop the timer. |
1633 | |
1674 | |