… | |
… | |
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 |
… | |
… | |
122 | 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 |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
124 | popup is being displayed. |
125 | |
125 | |
126 | 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 |
127 | 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. |
128 | 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 |
129 | 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 |
130 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
131 | |
131 | |
132 | 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 |
… | |
… | |
151 | 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 |
152 | 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 |
153 | 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 |
154 | selection. |
154 | selection. |
155 | |
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 | |
156 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
157 | |
163 | |
158 | 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 |
159 | 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 |
160 | 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 |
161 | 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 |
162 | for programs that correctly support wide characters). |
168 | for programs that correctly support wide characters). |
163 | |
169 | |
164 | To avoid too many false positives, this is only done when: |
170 | To avoid too many false positives, this is only done when: |
… | |
… | |
214 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
215 | |
221 | |
216 | =item tabbed |
222 | =item tabbed |
217 | |
223 | |
218 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
219 | 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 |
220 | 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 |
221 | button per tab. |
227 | button per tab. |
222 | |
228 | |
223 | 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 |
224 | 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, |
… | |
… | |
253 | 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 |
254 | C<OnTheSpot>, i.e.: |
260 | C<OnTheSpot>, i.e.: |
255 | |
261 | |
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
257 | |
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 | |
258 | =item automove-background |
283 | =item automove-background |
259 | |
284 | |
260 | 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 |
261 | 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 |
262 | 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: |
263 | |
289 | |
264 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
265 | |
291 | |
266 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
267 | |
293 | |
268 | 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 |
269 | 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 |
270 | similar-looking ascii character. |
296 | similar-looking ascii character. |
271 | |
297 | |
272 | =item digital-clock |
298 | =item digital-clock |
273 | |
299 | |
… | |
… | |
368 | |
394 | |
369 | =back |
395 | =back |
370 | |
396 | |
371 | =head2 Extension Objects |
397 | =head2 Extension Objects |
372 | |
398 | |
373 | 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 |
374 | for each terminal and each extension and passed as the first parameter to |
400 | for each terminal, and each terminal has its own set of extenion objects, |
375 | hooks. So extensions can use their C<$self> object without having to think |
401 | which are passed as the first parameter to hooks. So extensions can use |
376 | about other extensions, with the exception of methods and members that |
402 | their C<$self> object without having to think about clashes with other |
|
|
403 | extensions or other terminals, with the exception of methods and members |
377 | begin with an underscore character C<_>: these are reserved for internal |
404 | that begin with an underscore character C<_>: these are reserved for |
378 | use. |
405 | internal use. |
379 | |
406 | |
380 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
407 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
381 | C<urxvt::term> class on this object. |
408 | C<urxvt::term> class on this object. |
382 | |
409 | |
383 | It has the following methods and data members: |
410 | It has the following methods and data members: |
… | |
… | |
404 | =head2 Hooks |
431 | =head2 Hooks |
405 | |
432 | |
406 | The following subroutines can be declared in extension files, and will be |
433 | The following subroutines can be declared in extension files, and will be |
407 | called whenever the relevant event happens. |
434 | called whenever the relevant event happens. |
408 | |
435 | |
409 | The first argument passed to them is an extension oject as described in |
436 | The first argument passed to them is an extension object as described in |
410 | the in the C<Extension Objects> section. |
437 | the in the C<Extension Objects> section. |
411 | |
438 | |
412 | B<All> of these hooks must return a boolean value. If any of the called |
439 | B<All> of these hooks must return a boolean value. If any of the called |
413 | hooks returns true, then the event counts as being I<consumed>, and the |
440 | hooks returns true, then the event counts as being I<consumed>, and the |
414 | relevant action might not be carried out by the C++ code. |
441 | relevant action might not be carried out by the C++ code. |
… | |
… | |
427 | place. |
454 | place. |
428 | |
455 | |
429 | =item on_start $term |
456 | =item on_start $term |
430 | |
457 | |
431 | Called at the very end of initialisation of a new terminal, just before |
458 | Called at the very end of initialisation of a new terminal, just before |
432 | trying to map (display) the toplevel and returning to the mainloop. |
459 | trying to map (display) the toplevel and returning to the main loop. |
433 | |
460 | |
434 | =item on_destroy $term |
461 | =item on_destroy $term |
435 | |
462 | |
436 | Called whenever something tries to destroy terminal, when the terminal is |
463 | Called whenever something tries to destroy terminal, when the terminal is |
437 | still fully functional (not for long, though). |
464 | still fully functional (not for long, though). |
… | |
… | |
464 | |
491 | |
465 | Called whenever a selection has been copied, but before the selection is |
492 | Called whenever a selection has been copied, but before the selection is |
466 | requested from the server. The selection text can be queried and changed |
493 | requested from the server. The selection text can be queried and changed |
467 | by calling C<< $term->selection >>. |
494 | by calling C<< $term->selection >>. |
468 | |
495 | |
469 | Returning a true value aborts selection grabbing. It will still be hilighted. |
496 | Returning a true value aborts selection grabbing. It will still be highlighted. |
470 | |
497 | |
471 | =item on_sel_extend $term |
498 | =item on_sel_extend $term |
472 | |
499 | |
473 | Called whenever the user tries to extend the selection (e.g. with a double |
500 | Called whenever the user tries to extend the selection (e.g. with a double |
474 | click) and is either supposed to return false (normal operation), or |
501 | click) and is either supposed to return false (normal operation), or |
475 | should extend the selection itelf and return true to suppress the built-in |
502 | should extend the selection itself and return true to suppress the built-in |
476 | processing. This can happen multiple times, as long as the callback |
503 | processing. This can happen multiple times, as long as the callback |
477 | returns true, it will be called on every further click by the user and is |
504 | returns true, it will be called on every further click by the user and is |
478 | supposed to enlarge the selection more and more, if possible. |
505 | supposed to enlarge the selection more and more, if possible. |
479 | |
506 | |
480 | See the F<selection> example extension. |
507 | See the F<selection> example extension. |
481 | |
508 | |
482 | =item on_view_change $term, $offset |
509 | =item on_view_change $term, $offset |
483 | |
510 | |
484 | Called whenever the view offset changes, i..e the user or program |
511 | Called whenever the view offset changes, i.e. the user or program |
485 | scrolls. Offset C<0> means display the normal terminal, positive values |
512 | scrolls. Offset C<0> means display the normal terminal, positive values |
486 | show this many lines of scrollback. |
513 | show this many lines of scrollback. |
487 | |
514 | |
488 | =item on_scroll_back $term, $lines, $saved |
515 | =item on_scroll_back $term, $lines, $saved |
489 | |
516 | |
… | |
… | |
493 | |
520 | |
494 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
521 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
495 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
522 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
496 | number of lines that will be in the scrollback buffer. |
523 | number of lines that will be in the scrollback buffer. |
497 | |
524 | |
|
|
525 | =item on_osc_seq $term, $op, $args |
|
|
526 | |
|
|
527 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
528 | behaviour. The default should be to return an empty list. A true value |
|
|
529 | suppresses execution of the request completely. Make sure you don't get |
|
|
530 | confused by recursive invocations when you output an osc sequence within |
|
|
531 | this callback. |
|
|
532 | |
|
|
533 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
534 | |
498 | =item on_osc_seq $term, $string |
535 | =item on_osc_seq_perl $term, $string |
499 | |
536 | |
500 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
537 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
501 | operating system command) is processed. Cursor position and other state |
538 | operating system command) is processed. Cursor position and other state |
502 | information is up-to-date when this happens. For interoperability, the |
539 | information is up-to-date when this happens. For interoperability, the |
503 | string should start with the extension name and a colon, to distinguish |
540 | string should start with the extension name and a colon, to distinguish |
504 | it from commands for other extensions, and this might be enforced in the |
541 | it from commands for other extensions, and this might be enforced in the |
505 | future. |
542 | future. |
506 | |
543 | |
507 | Be careful not ever to trust (in a security sense) the data you receive, |
544 | Be careful not ever to trust (in a security sense) the data you receive, |
508 | as its source can not easily be controleld (e-mail content, messages from |
545 | as its source can not easily be controlled (e-mail content, messages from |
509 | other users on the same system etc.). |
546 | other users on the same system etc.). |
510 | |
547 | |
511 | =item on_add_lines $term, $string |
548 | =item on_add_lines $term, $string |
512 | |
549 | |
513 | Called whenever text is about to be output, with the text as argument. You |
550 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
546 | |
583 | |
547 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
584 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
548 | |
585 | |
549 | =item on_user_command $term, $string |
586 | =item on_user_command $term, $string |
550 | |
587 | |
551 | Called whenever the a user-configured event is being activated (e.g. via |
588 | Called whenever a user-configured event is being activated (e.g. via |
552 | a C<perl:string> action bound to a key, see description of the B<keysym> |
589 | a C<perl:string> action bound to a key, see description of the B<keysym> |
553 | resource in the @@RXVT_NAME@@(1) manpage). |
590 | resource in the @@RXVT_NAME@@(1) manpage). |
554 | |
591 | |
555 | The event is simply the action string. This interface is assumed to change |
592 | The event is simply the action string. This interface is assumed to change |
556 | slightly in the future. |
593 | slightly in the future. |
|
|
594 | |
|
|
595 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
596 | |
|
|
597 | Called just after the new window size has been calculated, but before |
|
|
598 | windows are actually being resized or hints are being set. If this hook |
|
|
599 | returns TRUE, setting of the window hints is being skipped. |
557 | |
600 | |
558 | =item on_x_event $term, $event |
601 | =item on_x_event $term, $event |
559 | |
602 | |
560 | Called on every X event received on the vt window (and possibly other |
603 | Called on every X event received on the vt window (and possibly other |
561 | windows). Should only be used as a last resort. Most event structure |
604 | windows). Should only be used as a last resort. Most event structure |
562 | members are not passed. |
605 | members are not passed. |
563 | |
606 | |
|
|
607 | =item on_root_event $term, $event |
|
|
608 | |
|
|
609 | Like C<on_x_event>, but is called for events on the root window. |
|
|
610 | |
564 | =item on_focus_in $term |
611 | =item on_focus_in $term |
565 | |
612 | |
566 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
613 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
567 | does focus in processing. |
614 | does focus in processing. |
568 | |
615 | |
569 | =item on_focus_out $term |
616 | =item on_focus_out $term |
570 | |
617 | |
571 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
618 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
572 | focus out processing. |
619 | focus out processing. |
573 | |
620 | |
574 | =item on_configure_notify $term, $event |
621 | =item on_configure_notify $term, $event |
575 | |
622 | |
576 | =item on_property_notify $term, $event |
623 | =item on_property_notify $term, $event |
… | |
… | |
659 | The current terminal. This variable stores the current C<urxvt::term> |
706 | The current terminal. This variable stores the current C<urxvt::term> |
660 | object, whenever a callback/hook is executing. |
707 | object, whenever a callback/hook is executing. |
661 | |
708 | |
662 | =item @urxvt::TERM_INIT |
709 | =item @urxvt::TERM_INIT |
663 | |
710 | |
664 | All coderefs in this array will be called as methods of the next newly |
711 | All code references in this array will be called as methods of the next newly |
665 | created C<urxvt::term> object (during the C<on_init> phase). The array |
712 | created C<urxvt::term> object (during the C<on_init> phase). The array |
666 | gets cleared before the codereferences that were in it are being executed, |
713 | gets cleared before the code references that were in it are being executed, |
667 | so coderefs can push themselves onto it again if they so desire. |
714 | so references can push themselves onto it again if they so desire. |
668 | |
715 | |
669 | This complements to the perl-eval commandline option, but gets executed |
716 | This complements to the perl-eval command line option, but gets executed |
670 | first. |
717 | first. |
671 | |
718 | |
672 | =item @urxvt::TERM_EXT |
719 | =item @urxvt::TERM_EXT |
673 | |
720 | |
674 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
721 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
699 | Messages have a size limit of 1023 bytes currently. |
746 | Messages have a size limit of 1023 bytes currently. |
700 | |
747 | |
701 | =item @terms = urxvt::termlist |
748 | =item @terms = urxvt::termlist |
702 | |
749 | |
703 | Returns all urxvt::term objects that exist in this process, regardless of |
750 | Returns all urxvt::term objects that exist in this process, regardless of |
704 | wether they are started, being destroyed etc., so be careful. Only term |
751 | whether they are started, being destroyed etc., so be careful. Only term |
705 | objects that have perl extensions attached will be returned (because there |
752 | objects that have perl extensions attached will be returned (because there |
706 | is no urxvt::term objet associated with others). |
753 | is no urxvt::term objet associated with others). |
707 | |
754 | |
708 | =item $time = urxvt::NOW |
755 | =item $time = urxvt::NOW |
709 | |
756 | |
… | |
… | |
891 | |
938 | |
892 | if (my $cb = $TERM->{_hook}[$htype]) { |
939 | if (my $cb = $TERM->{_hook}[$htype]) { |
893 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
940 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
894 | if $verbosity >= 10; |
941 | if $verbosity >= 10; |
895 | |
942 | |
896 | keys %$cb; |
943 | for my $pkg (keys %$cb) { |
897 | |
|
|
898 | while (my ($pkg, $cb) = each %$cb) { |
|
|
899 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
944 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
900 | $retval ||= $retval_; |
945 | $retval ||= $retval_; |
901 | |
946 | |
902 | if ($@) { |
947 | if ($@) { |
903 | $TERM->ungrab; # better to lose the grab than the session |
948 | $TERM->ungrab; # better to lose the grab than the session |
904 | warn $@; |
949 | warn $@; |
… | |
… | |
1149 | |
1194 | |
1150 | Returns true if the option specified by C<$optval> is enabled, and |
1195 | Returns true if the option specified by C<$optval> is enabled, and |
1151 | optionally change it. All option values are stored by name in the hash |
1196 | optionally change it. All option values are stored by name in the hash |
1152 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1197 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1153 | |
1198 | |
1154 | Here is a a likely non-exhaustive list of option names, please see the |
1199 | Here is a likely non-exhaustive list of option names, please see the |
1155 | source file F</src/optinc.h> to see the actual list: |
1200 | source file F</src/optinc.h> to see the actual list: |
1156 | |
1201 | |
1157 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1202 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1158 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1203 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1159 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1204 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1176 | likely change). |
1221 | likely change). |
1177 | |
1222 | |
1178 | Please note that resource strings will currently only be freed when the |
1223 | Please note that resource strings will currently only be freed when the |
1179 | terminal is destroyed, so changing options frequently will eat memory. |
1224 | terminal is destroyed, so changing options frequently will eat memory. |
1180 | |
1225 | |
1181 | Here is a a likely non-exhaustive list of resource names, not all of which |
1226 | Here is a likely non-exhaustive list of resource names, not all of which |
1182 | are supported in every build, please see the source file F</src/rsinc.h> |
1227 | are supported in every build, please see the source file F</src/rsinc.h> |
1183 | to see the actual list: |
1228 | to see the actual list: |
1184 | |
1229 | |
1185 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1230 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1186 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1231 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1468 | =item $env = $term->env |
1513 | =item $env = $term->env |
1469 | |
1514 | |
1470 | Returns a copy of the environment in effect for the terminal as a hashref |
1515 | Returns a copy of the environment in effect for the terminal as a hashref |
1471 | similar to C<\%ENV>. |
1516 | similar to C<\%ENV>. |
1472 | |
1517 | |
|
|
1518 | =item @envv = $term->envv |
|
|
1519 | |
|
|
1520 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1521 | |
|
|
1522 | =item @argv = $term->argv |
|
|
1523 | |
|
|
1524 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1525 | includes the program name as first element. |
|
|
1526 | |
1473 | =cut |
1527 | =cut |
1474 | |
1528 | |
1475 | sub env { |
1529 | sub env { |
1476 | if (my $env = $_[0]->_env) { |
|
|
1477 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1530 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1478 | } else { |
|
|
1479 | +{ %ENV } |
|
|
1480 | } |
|
|
1481 | } |
1531 | } |
1482 | |
1532 | |
1483 | =item $modifiermask = $term->ModLevel3Mask |
1533 | =item $modifiermask = $term->ModLevel3Mask |
1484 | |
1534 | |
1485 | =item $modifiermask = $term->ModMetaMask |
1535 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1493 | |
1543 | |
1494 | Returns the currently displayed screen (0 primary, 1 secondary). |
1544 | Returns the currently displayed screen (0 primary, 1 secondary). |
1495 | |
1545 | |
1496 | =item $cursor_is_hidden = $term->hidden_cursor |
1546 | =item $cursor_is_hidden = $term->hidden_cursor |
1497 | |
1547 | |
1498 | Returns wether the cursor is currently hidden or not. |
1548 | Returns whether the cursor is currently hidden or not. |
1499 | |
1549 | |
1500 | =item $view_start = $term->view_start ([$newvalue]) |
1550 | =item $view_start = $term->view_start ([$newvalue]) |
1501 | |
1551 | |
1502 | Returns the row number of the topmost displayed line. Maximum value is |
1552 | Returns the row number of the topmost displayed line. Maximum value is |
1503 | C<0>, which displays the normal terminal contents. Lower values scroll |
1553 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1680 | where one character corresponds to one screen cell. See |
1730 | where one character corresponds to one screen cell. See |
1681 | C<< $term->ROW_t >> for details. |
1731 | C<< $term->ROW_t >> for details. |
1682 | |
1732 | |
1683 | =item $string = $term->special_decode $text |
1733 | =item $string = $term->special_decode $text |
1684 | |
1734 | |
1685 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1735 | Converts rxvt-unicodes text representation into a perl string. See |
1686 | C<< $term->ROW_t >> for details. |
1736 | C<< $term->ROW_t >> for details. |
1687 | |
1737 | |
1688 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1738 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1689 | |
1739 | |
1690 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1740 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1693 | manpage. |
1743 | manpage. |
1694 | |
1744 | |
1695 | =item $success = $term->grab ($eventtime[, $sync]) |
1745 | =item $success = $term->grab ($eventtime[, $sync]) |
1696 | |
1746 | |
1697 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1747 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1698 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1748 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1699 | |
1749 | |
1700 | =item $term->allow_events_async |
1750 | =item $term->allow_events_async |
1701 | |
1751 | |
1702 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1752 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1703 | |
1753 | |
… | |
… | |
1970 | Set the callback to be called when io events are triggered. C<$reventmask> |
2020 | Set the callback to be called when io events are triggered. C<$reventmask> |
1971 | is a bitset as described in the C<events> method. |
2021 | is a bitset as described in the C<events> method. |
1972 | |
2022 | |
1973 | =item $iow = $iow->fd ($fd) |
2023 | =item $iow = $iow->fd ($fd) |
1974 | |
2024 | |
1975 | Set the filedescriptor (not handle) to watch. |
2025 | Set the file descriptor (not handle) to watch. |
1976 | |
2026 | |
1977 | =item $iow = $iow->events ($eventmask) |
2027 | =item $iow = $iow->events ($eventmask) |
1978 | |
2028 | |
1979 | Set the event mask to watch. The only allowed values are |
2029 | Set the event mask to watch. The only allowed values are |
1980 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2030 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1984 | |
2034 | |
1985 | Start watching for requested events on the given handle. |
2035 | Start watching for requested events on the given handle. |
1986 | |
2036 | |
1987 | =item $iow = $iow->stop |
2037 | =item $iow = $iow->stop |
1988 | |
2038 | |
1989 | Stop watching for events on the given filehandle. |
2039 | Stop watching for events on the given file handle. |
1990 | |
2040 | |
1991 | =back |
2041 | =back |
1992 | |
2042 | |
1993 | =head2 The C<urxvt::iw> Class |
2043 | =head2 The C<urxvt::iw> Class |
1994 | |
2044 | |
… | |
… | |
2041 | |
2091 | |
2042 | Set the callback to be called when the timer triggers. |
2092 | Set the callback to be called when the timer triggers. |
2043 | |
2093 | |
2044 | =item $pw = $timer->start ($pid) |
2094 | =item $pw = $timer->start ($pid) |
2045 | |
2095 | |
2046 | Tells the wqtcher to start watching for process C<$pid>. |
2096 | Tells the watcher to start watching for process C<$pid>. |
2047 | |
2097 | |
2048 | =item $pw = $pw->stop |
2098 | =item $pw = $pw->stop |
2049 | |
2099 | |
2050 | Stop the watcher. |
2100 | Stop the watcher. |
2051 | |
2101 | |
… | |
… | |
2064 | |
2114 | |
2065 | =item >= 3 - script loading and management |
2115 | =item >= 3 - script loading and management |
2066 | |
2116 | |
2067 | =item >=10 - all called hooks |
2117 | =item >=10 - all called hooks |
2068 | |
2118 | |
2069 | =item >=11 - hook reutrn values |
2119 | =item >=11 - hook return values |
2070 | |
2120 | |
2071 | =back |
2121 | =back |
2072 | |
2122 | |
2073 | =head1 AUTHOR |
2123 | =head1 AUTHOR |
2074 | |
2124 | |