… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
62 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
63 | ... |
64 | |
64 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
65 | The index number (0, 1...) must not have any holes, and each regex must |
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 following 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 | |
71 | |
72 | Another example: Programs I use often output "absolute path: " at the |
72 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
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 whether 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 |
113 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
114 | |
131 | |
115 | The following will add an entry C<a to b> that transforms all C<a>s in |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
… | |
… | |
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: |
… | |
… | |
197 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
198 | |
221 | |
199 | =item tabbed |
222 | =item tabbed |
200 | |
223 | |
201 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
225 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
204 | button per tab. |
227 | button per tab. |
205 | |
228 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
… | |
… | |
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 modifiers, 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. Example: |
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. |
… | |
… | |
387 | =head2 Hooks |
430 | =head2 Hooks |
388 | |
431 | |
389 | The following subroutines can be declared in extension files, and will be |
432 | The following subroutines can be declared in extension files, and will be |
390 | called whenever the relevant event happens. |
433 | called whenever the relevant event happens. |
391 | |
434 | |
392 | The first argument passed to them is an extension oject as described in |
435 | The first argument passed to them is an extension object as described in |
393 | the in the C<Extension Objects> section. |
436 | the in the C<Extension Objects> section. |
394 | |
437 | |
395 | B<All> of these hooks must return a boolean value. If any of the called |
438 | B<All> of these hooks must return a boolean value. If any of the called |
396 | hooks returns true, then the event counts as being I<consumed>, and the |
439 | hooks returns true, then the event counts as being I<consumed>, and the |
397 | relevant action might not be carried out by the C++ code. |
440 | relevant action might not be carried out by the C++ code. |
… | |
… | |
410 | place. |
453 | place. |
411 | |
454 | |
412 | =item on_start $term |
455 | =item on_start $term |
413 | |
456 | |
414 | Called at the very end of initialisation of a new terminal, just before |
457 | Called at the very end of initialisation of a new terminal, just before |
415 | trying to map (display) the toplevel and returning to the mainloop. |
458 | trying to map (display) the toplevel and returning to the main loop. |
416 | |
459 | |
417 | =item on_destroy $term |
460 | =item on_destroy $term |
418 | |
461 | |
419 | Called whenever something tries to destroy terminal, when the terminal is |
462 | Called whenever something tries to destroy terminal, when the terminal is |
420 | still fully functional (not for long, though). |
463 | still fully functional (not for long, though). |
… | |
… | |
447 | |
490 | |
448 | Called whenever a selection has been copied, but before the selection is |
491 | Called whenever a selection has been copied, but before the selection is |
449 | requested from the server. The selection text can be queried and changed |
492 | requested from the server. The selection text can be queried and changed |
450 | by calling C<< $term->selection >>. |
493 | by calling C<< $term->selection >>. |
451 | |
494 | |
452 | Returning a true value aborts selection grabbing. It will still be hilighted. |
495 | Returning a true value aborts selection grabbing. It will still be highlighted. |
453 | |
496 | |
454 | =item on_sel_extend $term |
497 | =item on_sel_extend $term |
455 | |
498 | |
456 | Called whenever the user tries to extend the selection (e.g. with a double |
499 | Called whenever the user tries to extend the selection (e.g. with a double |
457 | click) and is either supposed to return false (normal operation), or |
500 | click) and is either supposed to return false (normal operation), or |
458 | should extend the selection itelf and return true to suppress the built-in |
501 | should extend the selection itself and return true to suppress the built-in |
459 | processing. This can happen multiple times, as long as the callback |
502 | processing. This can happen multiple times, as long as the callback |
460 | returns true, it will be called on every further click by the user and is |
503 | returns true, it will be called on every further click by the user and is |
461 | supposed to enlarge the selection more and more, if possible. |
504 | supposed to enlarge the selection more and more, if possible. |
462 | |
505 | |
463 | See the F<selection> example extension. |
506 | See the F<selection> example extension. |
464 | |
507 | |
465 | =item on_view_change $term, $offset |
508 | =item on_view_change $term, $offset |
466 | |
509 | |
467 | Called whenever the view offset changes, i..e the user or program |
510 | Called whenever the view offset changes, i.e. the user or program |
468 | scrolls. Offset C<0> means display the normal terminal, positive values |
511 | scrolls. Offset C<0> means display the normal terminal, positive values |
469 | show this many lines of scrollback. |
512 | show this many lines of scrollback. |
470 | |
513 | |
471 | =item on_scroll_back $term, $lines, $saved |
514 | =item on_scroll_back $term, $lines, $saved |
472 | |
515 | |
… | |
… | |
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 |
487 | it from commands for other extensions, and this might be enforced in the |
540 | it from commands for other extensions, and this might be enforced in the |
488 | future. |
541 | future. |
489 | |
542 | |
490 | Be careful not ever to trust (in a security sense) the data you receive, |
543 | Be careful not ever to trust (in a security sense) the data you receive, |
491 | as its source can not easily be controleld (e-mail content, messages from |
544 | as its source can not easily be controlled (e-mail content, messages from |
492 | other users on the same system etc.). |
545 | other users on the same system etc.). |
493 | |
546 | |
494 | =item on_add_lines $term, $string |
547 | =item on_add_lines $term, $string |
495 | |
548 | |
496 | Called whenever text is about to be output, with the text as argument. You |
549 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
529 | |
582 | |
530 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
583 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
531 | |
584 | |
532 | =item on_user_command $term, $string |
585 | =item on_user_command $term, $string |
533 | |
586 | |
534 | Called whenever the a user-configured event is being activated (e.g. via |
587 | Called whenever a user-configured event is being activated (e.g. via |
535 | a C<perl:string> action bound to a key, see description of the B<keysym> |
588 | a C<perl:string> action bound to a key, see description of the B<keysym> |
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. |
|
|
593 | |
|
|
594 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
595 | |
|
|
596 | Called just after the new window size has been calculated, 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. |
540 | |
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. |
546 | |
605 | |
|
|
606 | =item on_root_event $term, $event |
|
|
607 | |
|
|
608 | Like C<on_x_event>, but is called for events on the root window. |
|
|
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. |
551 | |
614 | |
552 | =item on_focus_out $term |
615 | =item on_focus_out $term |
553 | |
616 | |
554 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
617 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
555 | focus out processing. |
618 | focus out processing. |
556 | |
619 | |
557 | =item on_configure_notify $term, $event |
620 | =item on_configure_notify $term, $event |
558 | |
621 | |
559 | =item on_property_notify $term, $event |
622 | =item on_property_notify $term, $event |
… | |
… | |
642 | The current terminal. This variable stores the current C<urxvt::term> |
705 | The current terminal. This variable stores the current C<urxvt::term> |
643 | object, whenever a callback/hook is executing. |
706 | object, whenever a callback/hook is executing. |
644 | |
707 | |
645 | =item @urxvt::TERM_INIT |
708 | =item @urxvt::TERM_INIT |
646 | |
709 | |
647 | All coderefs in this array will be called as methods of the next newly |
710 | All code references in this array will be called as methods of the next newly |
648 | created C<urxvt::term> object (during the C<on_init> phase). The array |
711 | created C<urxvt::term> object (during the C<on_init> phase). The array |
649 | gets cleared before the codereferences that were in it are being executed, |
712 | gets cleared before the code references that were in it are being executed, |
650 | so coderefs can push themselves onto it again if they so desire. |
713 | so references can push themselves onto it again if they so desire. |
651 | |
714 | |
652 | This complements to the perl-eval commandline option, but gets executed |
715 | This complements to the perl-eval command line option, but gets executed |
653 | first. |
716 | first. |
654 | |
717 | |
655 | =item @urxvt::TERM_EXT |
718 | =item @urxvt::TERM_EXT |
656 | |
719 | |
657 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
720 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
682 | Messages have a size limit of 1023 bytes currently. |
745 | Messages have a size limit of 1023 bytes currently. |
683 | |
746 | |
684 | =item @terms = urxvt::termlist |
747 | =item @terms = urxvt::termlist |
685 | |
748 | |
686 | Returns all urxvt::term objects that exist in this process, regardless of |
749 | Returns all urxvt::term objects that exist in this process, regardless of |
687 | wether they are started, being destroyed etc., so be careful. Only term |
750 | whether they are started, being destroyed etc., so be careful. Only term |
688 | objects that have perl extensions attached will be returned (because there |
751 | objects that have perl extensions attached will be returned (because there |
689 | is no urxvt::term objet associated with others). |
752 | is no urxvt::term objet associated with others). |
690 | |
753 | |
691 | =item $time = urxvt::NOW |
754 | =item $time = urxvt::NOW |
692 | |
755 | |
… | |
… | |
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 $@; |
… | |
… | |
1132 | |
1193 | |
1133 | Returns true if the option specified by C<$optval> is enabled, and |
1194 | Returns true if the option specified by C<$optval> is enabled, and |
1134 | optionally change it. All option values are stored by name in the hash |
1195 | optionally change it. All option values are stored by name in the hash |
1135 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1196 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1136 | |
1197 | |
1137 | Here is a a likely non-exhaustive list of option names, please see the |
1198 | Here is a likely non-exhaustive list of option names, please see the |
1138 | source file F</src/optinc.h> to see the actual list: |
1199 | source file F</src/optinc.h> to see the actual list: |
1139 | |
1200 | |
1140 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1201 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1141 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1202 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1142 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1203 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1159 | likely change). |
1220 | likely change). |
1160 | |
1221 | |
1161 | Please note that resource strings will currently only be freed when the |
1222 | Please note that resource strings will currently only be freed when the |
1162 | terminal is destroyed, so changing options frequently will eat memory. |
1223 | terminal is destroyed, so changing options frequently will eat memory. |
1163 | |
1224 | |
1164 | Here is a a likely non-exhaustive list of resource names, not all of which |
1225 | Here is a likely non-exhaustive list of resource names, not all of which |
1165 | are supported in every build, please see the source file F</src/rsinc.h> |
1226 | are supported in every build, please see the source file F</src/rsinc.h> |
1166 | to see the actual list: |
1227 | to see the actual list: |
1167 | |
1228 | |
1168 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1229 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1169 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1230 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
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 |
… | |
… | |
1476 | |
1542 | |
1477 | Returns the currently displayed screen (0 primary, 1 secondary). |
1543 | Returns the currently displayed screen (0 primary, 1 secondary). |
1478 | |
1544 | |
1479 | =item $cursor_is_hidden = $term->hidden_cursor |
1545 | =item $cursor_is_hidden = $term->hidden_cursor |
1480 | |
1546 | |
1481 | Returns wether the cursor is currently hidden or not. |
1547 | Returns whether the cursor is currently hidden or not. |
1482 | |
1548 | |
1483 | =item $view_start = $term->view_start ([$newvalue]) |
1549 | =item $view_start = $term->view_start ([$newvalue]) |
1484 | |
1550 | |
1485 | Returns the row number of the topmost displayed line. Maximum value is |
1551 | Returns the row number of the topmost displayed line. Maximum value is |
1486 | C<0>, which displays the normal terminal contents. Lower values scroll |
1552 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1663 | where one character corresponds to one screen cell. See |
1729 | where one character corresponds to one screen cell. See |
1664 | C<< $term->ROW_t >> for details. |
1730 | C<< $term->ROW_t >> for details. |
1665 | |
1731 | |
1666 | =item $string = $term->special_decode $text |
1732 | =item $string = $term->special_decode $text |
1667 | |
1733 | |
1668 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1734 | Converts rxvt-unicodes text representation into a perl string. See |
1669 | C<< $term->ROW_t >> for details. |
1735 | C<< $term->ROW_t >> for details. |
1670 | |
1736 | |
1671 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1737 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1672 | |
1738 | |
1673 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1739 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1676 | manpage. |
1742 | manpage. |
1677 | |
1743 | |
1678 | =item $success = $term->grab ($eventtime[, $sync]) |
1744 | =item $success = $term->grab ($eventtime[, $sync]) |
1679 | |
1745 | |
1680 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1746 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1681 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1747 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1682 | |
1748 | |
1683 | =item $term->allow_events_async |
1749 | =item $term->allow_events_async |
1684 | |
1750 | |
1685 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1751 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1686 | |
1752 | |
… | |
… | |
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, |
… | |
… | |
1953 | Set the callback to be called when io events are triggered. C<$reventmask> |
2019 | Set the callback to be called when io events are triggered. C<$reventmask> |
1954 | is a bitset as described in the C<events> method. |
2020 | is a bitset as described in the C<events> method. |
1955 | |
2021 | |
1956 | =item $iow = $iow->fd ($fd) |
2022 | =item $iow = $iow->fd ($fd) |
1957 | |
2023 | |
1958 | Set the filedescriptor (not handle) to watch. |
2024 | Set the file descriptor (not handle) to watch. |
1959 | |
2025 | |
1960 | =item $iow = $iow->events ($eventmask) |
2026 | =item $iow = $iow->events ($eventmask) |
1961 | |
2027 | |
1962 | Set the event mask to watch. The only allowed values are |
2028 | Set the event mask to watch. The only allowed values are |
1963 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2029 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1967 | |
2033 | |
1968 | Start watching for requested events on the given handle. |
2034 | Start watching for requested events on the given handle. |
1969 | |
2035 | |
1970 | =item $iow = $iow->stop |
2036 | =item $iow = $iow->stop |
1971 | |
2037 | |
1972 | Stop watching for events on the given filehandle. |
2038 | Stop watching for events on the given file handle. |
1973 | |
2039 | |
1974 | =back |
2040 | =back |
1975 | |
2041 | |
1976 | =head2 The C<urxvt::iw> Class |
2042 | =head2 The C<urxvt::iw> Class |
1977 | |
2043 | |
… | |
… | |
2024 | |
2090 | |
2025 | Set the callback to be called when the timer triggers. |
2091 | Set the callback to be called when the timer triggers. |
2026 | |
2092 | |
2027 | =item $pw = $timer->start ($pid) |
2093 | =item $pw = $timer->start ($pid) |
2028 | |
2094 | |
2029 | Tells the wqtcher to start watching for process C<$pid>. |
2095 | Tells the watcher to start watching for process C<$pid>. |
2030 | |
2096 | |
2031 | =item $pw = $pw->stop |
2097 | =item $pw = $pw->stop |
2032 | |
2098 | |
2033 | Stop the watcher. |
2099 | Stop the watcher. |
2034 | |
2100 | |
… | |
… | |
2047 | |
2113 | |
2048 | =item >= 3 - script loading and management |
2114 | =item >= 3 - script loading and management |
2049 | |
2115 | |
2050 | =item >=10 - all called hooks |
2116 | =item >=10 - all called hooks |
2051 | |
2117 | |
2052 | =item >=11 - hook reutrn values |
2118 | =item >=11 - hook return values |
2053 | |
2119 | |
2054 | =back |
2120 | =back |
2055 | |
2121 | |
2056 | =head1 AUTHOR |
2122 | =head1 AUTHOR |
2057 | |
2123 | |