… | |
… | |
94 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
95 | |
95 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
97 | runtime. |
98 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's 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 |
|
|
105 | 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 |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
99 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
100 | |
117 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
104 | |
121 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
124 | popup is being displayed. |
108 | |
125 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide wether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
… | |
… | |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
136 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
137 | selection. |
154 | selection. |
138 | |
155 | |
|
|
156 | 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> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
139 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
140 | |
163 | |
141 | A support package that tries to make editing with readline easier. At the |
164 | A support package that tries to make editing with readline easier. At |
142 | moment, it reacts to clicking with the left mouse button by trying to |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
143 | move the text cursor to this position. It does so by generating as many |
166 | move the text cursor to this position. It does so by generating as many |
144 | cursor-left or cursor-right keypresses as required (the this only works |
167 | cursor-left or cursor-right keypresses as required (the this only works |
145 | for programs that correctly support wide characters). |
168 | for programs that correctly support wide characters). |
146 | |
169 | |
147 | To avoid too many false positives, this is only done when: |
170 | To avoid too many false positives, this is only done when: |
… | |
… | |
236 | You enable it by specifying this extension and a preedit style of |
259 | You enable it by specifying this extension and a preedit style of |
237 | C<OnTheSpot>, i.e.: |
260 | C<OnTheSpot>, i.e.: |
238 | |
261 | |
239 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
240 | |
263 | |
|
|
264 | =item kuake<hotkey> |
|
|
265 | |
|
|
266 | A very primitive quake-console-like extension. It was inspired by a |
|
|
267 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
268 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
269 | will show or hide itself. Another press of the accelerator key will hide |
|
|
270 | or show it again. |
|
|
271 | |
|
|
272 | Initially, the window will not be shown when using this extension. |
|
|
273 | |
|
|
274 | This is useful if you need a single terminal thats not using any desktop |
|
|
275 | space most of the time but is quickly available at the press of a key. |
|
|
276 | |
|
|
277 | The accelerator key is grabbed regardless of any modifers, so this |
|
|
278 | extension will actually grab a physical key just for this function. |
|
|
279 | |
|
|
280 | If you want a quake-like animation, tell your window manager to do so |
|
|
281 | (fvwm can do it). |
|
|
282 | |
241 | =item automove-background |
283 | =item automove-background |
242 | |
284 | |
243 | This is basically a one-line extension that dynamically changes the background pixmap offset |
285 | This is basically a very small extension that dynamically changes the |
244 | to the window position, in effect creating the same effect as pseudo transparency with |
286 | background pixmap offset to the window position, in effect creating the |
245 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
288 | supported in this mode. Exmaple: |
246 | |
289 | |
247 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
248 | |
291 | |
249 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
250 | |
293 | |
251 | A not very useful example of filtering all text output to the terminal, |
294 | A not very useful example of filtering all text output to the terminal |
252 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
253 | similar-looking ascii character. |
296 | similar-looking ascii character. |
254 | |
297 | |
255 | =item digital-clock |
298 | =item digital-clock |
256 | |
299 | |
… | |
… | |
351 | |
394 | |
352 | =back |
395 | =back |
353 | |
396 | |
354 | =head2 Extension Objects |
397 | =head2 Extension Objects |
355 | |
398 | |
356 | Very perl extension is a perl class. A separate perl object is created |
399 | Every perl extension is a perl class. A separate perl object is created |
357 | for each terminal and each extension and passed as the first parameter to |
400 | for each terminal and each extension and passed as the first parameter to |
358 | hooks. So extensions can use their C<$self> object without having to think |
401 | hooks. So extensions can use their C<$self> object without having to think |
359 | about other extensions, with the exception of methods and members that |
402 | about other extensions, with the exception of methods and members that |
360 | begin with an underscore character C<_>: these are reserved for internal |
403 | begin with an underscore character C<_>: these are reserved for internal |
361 | use. |
404 | use. |
… | |
… | |
476 | |
519 | |
477 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
520 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
478 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
521 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
479 | number of lines that will be in the scrollback buffer. |
522 | number of lines that will be in the scrollback buffer. |
480 | |
523 | |
|
|
524 | =item on_osc_seq $term, $op, $args |
|
|
525 | |
|
|
526 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
527 | behaviour. The default should be to return an empty list. A true value |
|
|
528 | suppresses execution of the request completely. Make sure you don't get |
|
|
529 | confused by recursive invocations when you output an osc sequence within |
|
|
530 | this callback. |
|
|
531 | |
|
|
532 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
533 | |
481 | =item on_osc_seq $term, $string |
534 | =item on_osc_seq_perl $term, $string |
482 | |
535 | |
483 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
536 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
484 | operating system command) is processed. Cursor position and other state |
537 | operating system command) is processed. Cursor position and other state |
485 | information is up-to-date when this happens. For interoperability, the |
538 | information is up-to-date when this happens. For interoperability, the |
486 | string should start with the extension name and a colon, to distinguish |
539 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
536 | resource in the @@RXVT_NAME@@(1) manpage). |
589 | resource in the @@RXVT_NAME@@(1) manpage). |
537 | |
590 | |
538 | The event is simply the action string. This interface is assumed to change |
591 | The event is simply the action string. This interface is assumed to change |
539 | slightly in the future. |
592 | slightly in the future. |
540 | |
593 | |
|
|
594 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
595 | |
|
|
596 | Called just after the new window size has been calculcated, but before |
|
|
597 | windows are actually being resized or hints are being set. If this hook |
|
|
598 | returns TRUE, setting of the window hints is being skipped. |
|
|
599 | |
541 | =item on_x_event $term, $event |
600 | =item on_x_event $term, $event |
542 | |
601 | |
543 | Called on every X event received on the vt window (and possibly other |
602 | Called on every X event received on the vt window (and possibly other |
544 | windows). Should only be used as a last resort. Most event structure |
603 | windows). Should only be used as a last resort. Most event structure |
545 | members are not passed. |
604 | members are not passed. |
|
|
605 | |
|
|
606 | =item on_root_event $term, $event |
|
|
607 | |
|
|
608 | Like C<on_x_event>, but is called for events on the root window. |
546 | |
609 | |
547 | =item on_focus_in $term |
610 | =item on_focus_in $term |
548 | |
611 | |
549 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
612 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
550 | does focus in processing. |
613 | does focus in processing. |
… | |
… | |
854 | } else { |
917 | } else { |
855 | $ext_arg{$_} ||= []; |
918 | $ext_arg{$_} ||= []; |
856 | } |
919 | } |
857 | } |
920 | } |
858 | |
921 | |
859 | while (my ($ext, $argv) = each %ext_arg) { |
922 | for my $ext (sort keys %ext_arg) { |
860 | my @files = grep -f $_, map "$_/$ext", @dirs; |
923 | my @files = grep -f $_, map "$_/$ext", @dirs; |
861 | |
924 | |
862 | if (@files) { |
925 | if (@files) { |
863 | $TERM->register_package (extension_package $files[0], $argv); |
926 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
864 | } else { |
927 | } else { |
865 | warn "perl extension '$ext' not found in perl library search path\n"; |
928 | warn "perl extension '$ext' not found in perl library search path\n"; |
866 | } |
929 | } |
867 | } |
930 | } |
868 | |
931 | |
… | |
… | |
874 | |
937 | |
875 | if (my $cb = $TERM->{_hook}[$htype]) { |
938 | if (my $cb = $TERM->{_hook}[$htype]) { |
876 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
939 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
877 | if $verbosity >= 10; |
940 | if $verbosity >= 10; |
878 | |
941 | |
879 | keys %$cb; |
942 | for my $pkg (keys %$cb) { |
880 | |
|
|
881 | while (my ($pkg, $cb) = each %$cb) { |
|
|
882 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
943 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
883 | $retval ||= $retval_; |
944 | $retval ||= $retval_; |
884 | |
945 | |
885 | if ($@) { |
946 | if ($@) { |
886 | $TERM->ungrab; # better to lose the grab than the session |
947 | $TERM->ungrab; # better to lose the grab than the session |
887 | warn $@; |
948 | warn $@; |
… | |
… | |
1451 | =item $env = $term->env |
1512 | =item $env = $term->env |
1452 | |
1513 | |
1453 | Returns a copy of the environment in effect for the terminal as a hashref |
1514 | Returns a copy of the environment in effect for the terminal as a hashref |
1454 | similar to C<\%ENV>. |
1515 | similar to C<\%ENV>. |
1455 | |
1516 | |
|
|
1517 | =item @envv = $term->envv |
|
|
1518 | |
|
|
1519 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1520 | |
|
|
1521 | =item @argv = $term->argv |
|
|
1522 | |
|
|
1523 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1524 | includes the program name as first element. |
|
|
1525 | |
1456 | =cut |
1526 | =cut |
1457 | |
1527 | |
1458 | sub env { |
1528 | sub env { |
1459 | if (my $env = $_[0]->_env) { |
|
|
1460 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1529 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1461 | } else { |
|
|
1462 | +{ %ENV } |
|
|
1463 | } |
|
|
1464 | } |
1530 | } |
1465 | |
1531 | |
1466 | =item $modifiermask = $term->ModLevel3Mask |
1532 | =item $modifiermask = $term->ModLevel3Mask |
1467 | |
1533 | |
1468 | =item $modifiermask = $term->ModMetaMask |
1534 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1799 | my ($self, $text, $cb) = @_; |
1865 | my ($self, $text, $cb) = @_; |
1800 | |
1866 | |
1801 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1867 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1802 | } |
1868 | } |
1803 | |
1869 | |
1804 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1870 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1805 | |
1871 | |
1806 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1872 | Adds a toggle/checkbox item to the popup. The callback gets called |
1807 | whenever it gets toggled, with a boolean indicating its value as its first |
1873 | whenever it gets toggled, with a boolean indicating its new value as its |
1808 | argument. |
1874 | first argument. |
1809 | |
1875 | |
1810 | =cut |
1876 | =cut |
1811 | |
1877 | |
1812 | sub add_toggle { |
1878 | sub add_toggle { |
1813 | my ($self, $text, $cb, $value) = @_; |
1879 | my ($self, $text, $value, $cb) = @_; |
1814 | |
1880 | |
1815 | my $item; $item = { |
1881 | my $item; $item = { |
1816 | type => "button", |
1882 | type => "button", |
1817 | text => " $text", |
1883 | text => " $text", |
1818 | value => $value, |
1884 | value => $value, |