ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.48 by root, Mon Jul 17 19:20:29 2006 UTC vs.
Revision 1.49 by root, Mon Aug 7 16:17:30 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "@@RXVT_NAME@@ 3" 131.IX Title "@@RXVT_NAME@@ 3"
132.TH @@RXVT_NAME@@ 3 "2006-07-17" "7.8" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 3 "2006-08-07" "7.9" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter 134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
… …
146\& 146\&
147\& @@RXVT_NAME@@ \-\-perl\-lib $HOME \-pe grab_test 147\& @@RXVT_NAME@@ \-\-perl\-lib $HOME \-pe grab_test
148.Ve 148.Ve
149.SH "DESCRIPTION" 149.SH "DESCRIPTION"
150.IX Header "DESCRIPTION" 150.IX Header "DESCRIPTION"
151Everytime a terminal object gets created, extension scripts specified via 151Every time a terminal object gets created, extension scripts specified via
152the \f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it. 152the \f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it.
153.PP 153.PP
154Scripts are compiled in a 'use strict' and 'use utf8' environment, and 154Scripts are compiled in a 'use strict' and 'use utf8' environment, and
155thus must be encoded as \s-1UTF\-8\s0. 155thus must be encoded as \s-1UTF\-8\s0.
156.PP 156.PP
… …
193\& ... 193\& ...
194.Ve 194.Ve
195.Sp 195.Sp
196The index number (0, 1...) must not have any holes, and each regex must 196The index number (0, 1...) must not have any holes, and each regex must
197contain at least one pair of capturing parentheses, which will be used for 197contain at least one pair of capturing parentheses, which will be used for
198the match. For example, the followign adds a regex that matches everything 198the match. For example, the following adds a regex that matches everything
199between two vertical bars: 199between two vertical bars:
200.Sp 200.Sp
201.Vb 1 201.Vb 1
202\& URxvt.selection.pattern\-0: \e\e|([^|]+)\e\e| 202\& URxvt.selection.pattern\-0: \e\e|([^|]+)\e\e|
203.Ve 203.Ve
… …
258Other extensions can extend this popup menu by pushing a code reference 258Other extensions can extend this popup menu by pushing a code reference
259onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, which gets called whenever the 259onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, which gets called whenever the
260popup is being displayed. 260popup is being displayed.
261.Sp 261.Sp
262It's sole argument is the popup menu, which can be modified. The selection 262It's sole argument is the popup menu, which can be modified. The selection
263is in \f(CW$_\fR, which can be used to decide wether to add something or not. 263is in \f(CW$_\fR, which can be used to decide whether to add something or not.
264It should either return nothing or a string and a code reference. The 264It should either return nothing or a string and a code reference. The
265string will be used as button text and the code reference will be called 265string will be used as button text and the code reference will be called
266when the button gets activated and should transform \f(CW$_\fR. 266when the button gets activated and should transform \f(CW$_\fR.
267.Sp 267.Sp
268The following will add an entry \f(CW\*(C`a to b\*(C'\fR that transforms all \f(CW\*(C`a\*(C'\fRs in 268The following will add an entry \f(CW\*(C`a to b\*(C'\fR that transforms all \f(CW\*(C`a\*(C'\fRs in
… …
364every error message as a selection pattern, and the second line transforms 364every error message as a selection pattern, and the second line transforms
365the message into vi commands to load the file. 365the message into vi commands to load the file.
366.IP "tabbed" 4 366.IP "tabbed" 4
367.IX Item "tabbed" 367.IX Item "tabbed"
368This transforms the terminal into a tabbar with additional terminals, that 368This transforms the terminal into a tabbar with additional terminals, that
369is, it implements what is commonly refered to as \*(L"tabbed terminal\*(R". The topmost line 369is, it implements what is commonly referred to as \*(L"tabbed terminal\*(R". The topmost line
370displays a \*(L"[\s-1NEW\s0]\*(R" button, which, when clicked, will add a new tab, followed by one 370displays a \*(L"[\s-1NEW\s0]\*(R" button, which, when clicked, will add a new tab, followed by one
371button per tab. 371button per tab.
372.Sp 372.Sp
373Clicking a button will activate that tab. Pressing \fBShift-Left\fR and 373Clicking a button will activate that tab. Pressing \fBShift-Left\fR and
374\&\fBShift-Right\fR will switch to the tab left or right of the current one, 374\&\fBShift-Right\fR will switch to the tab left or right of the current one,
… …
417Initially, the window will not be shown when using this extension. 417Initially, the window will not be shown when using this extension.
418.Sp 418.Sp
419This is useful if you need a single terminal thats not using any desktop 419This is useful if you need a single terminal thats not using any desktop
420space most of the time but is quickly available at the press of a key. 420space most of the time but is quickly available at the press of a key.
421.Sp 421.Sp
422The accelerator key is grabbed regardless of any modifers, so this 422The accelerator key is grabbed regardless of any modifiers, so this
423extension will actually grab a physical key just for this function. 423extension will actually grab a physical key just for this function.
424.Sp 424.Sp
425If you want a quake-like animation, tell your window manager to do so 425If you want a quake-like animation, tell your window manager to do so
426(fvwm can do it). 426(fvwm can do it).
427.IP "automove-background" 4 427.IP "automove-background" 4
428.IX Item "automove-background" 428.IX Item "automove-background"
429This is basically a very small extension that dynamically changes the 429This is basically a very small extension that dynamically changes the
430background pixmap offset to the window position, in effect creating the 430background pixmap offset to the window position, in effect creating the
431same effect as pseudo transparency with a custom pixmap. No scaling is 431same effect as pseudo transparency with a custom pixmap. No scaling is
432supported in this mode. Exmaple: 432supported in this mode. Example:
433.Sp 433.Sp
434.Vb 1 434.Vb 1
435\& @@RXVT_NAME@@ \-pixmap background.xpm \-pe automove\-background 435\& @@RXVT_NAME@@ \-pixmap background.xpm \-pe automove\-background
436.Ve 436.Ve
437.IP "block-graphics-to-ascii" 4 437.IP "block-graphics-to-ascii" 4
… …
566.Sh "Hooks" 566.Sh "Hooks"
567.IX Subsection "Hooks" 567.IX Subsection "Hooks"
568The following subroutines can be declared in extension files, and will be 568The following subroutines can be declared in extension files, and will be
569called whenever the relevant event happens. 569called whenever the relevant event happens.
570.PP 570.PP
571The first argument passed to them is an extension oject as described in 571The first argument passed to them is an extension object as described in
572the in the \f(CW\*(C`Extension Objects\*(C'\fR section. 572the in the \f(CW\*(C`Extension Objects\*(C'\fR section.
573.PP 573.PP
574\&\fBAll\fR of these hooks must return a boolean value. If any of the called 574\&\fBAll\fR of these hooks must return a boolean value. If any of the called
575hooks returns true, then the event counts as being \fIconsumed\fR, and the 575hooks returns true, then the event counts as being \fIconsumed\fR, and the
576relevant action might not be carried out by the \*(C+ code. 576relevant action might not be carried out by the \*(C+ code.
… …
587place. 587place.
588.ie n .IP "on_start $term" 4 588.ie n .IP "on_start $term" 4
589.el .IP "on_start \f(CW$term\fR" 4 589.el .IP "on_start \f(CW$term\fR" 4
590.IX Item "on_start $term" 590.IX Item "on_start $term"
591Called at the very end of initialisation of a new terminal, just before 591Called at the very end of initialisation of a new terminal, just before
592trying to map (display) the toplevel and returning to the mainloop. 592trying to map (display) the toplevel and returning to the main loop.
593.ie n .IP "on_destroy $term" 4 593.ie n .IP "on_destroy $term" 4
594.el .IP "on_destroy \f(CW$term\fR" 4 594.el .IP "on_destroy \f(CW$term\fR" 4
595.IX Item "on_destroy $term" 595.IX Item "on_destroy $term"
596Called whenever something tries to destroy terminal, when the terminal is 596Called whenever something tries to destroy terminal, when the terminal is
597still fully functional (not for long, though). 597still fully functional (not for long, though).
… …
624.IX Item "on_sel_grab $term, $eventtime" 624.IX Item "on_sel_grab $term, $eventtime"
625Called whenever a selection has been copied, but before the selection is 625Called whenever a selection has been copied, but before the selection is
626requested from the server. The selection text can be queried and changed 626requested from the server. The selection text can be queried and changed
627by calling \f(CW\*(C`$term\->selection\*(C'\fR. 627by calling \f(CW\*(C`$term\->selection\*(C'\fR.
628.Sp 628.Sp
629Returning a true value aborts selection grabbing. It will still be hilighted. 629Returning a true value aborts selection grabbing. It will still be highlighted.
630.ie n .IP "on_sel_extend $term" 4 630.ie n .IP "on_sel_extend $term" 4
631.el .IP "on_sel_extend \f(CW$term\fR" 4 631.el .IP "on_sel_extend \f(CW$term\fR" 4
632.IX Item "on_sel_extend $term" 632.IX Item "on_sel_extend $term"
633Called whenever the user tries to extend the selection (e.g. with a double 633Called whenever the user tries to extend the selection (e.g. with a double
634click) and is either supposed to return false (normal operation), or 634click) and is either supposed to return false (normal operation), or
635should extend the selection itelf and return true to suppress the built-in 635should extend the selection itself and return true to suppress the built-in
636processing. This can happen multiple times, as long as the callback 636processing. This can happen multiple times, as long as the callback
637returns true, it will be called on every further click by the user and is 637returns true, it will be called on every further click by the user and is
638supposed to enlarge the selection more and more, if possible. 638supposed to enlarge the selection more and more, if possible.
639.Sp 639.Sp
640See the \fIselection\fR example extension. 640See the \fIselection\fR example extension.
641.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4 641.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4
642.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4 642.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4
643.IX Item "on_view_change $term, $offset" 643.IX Item "on_view_change $term, $offset"
644Called whenever the view offset changes, i..e the user or program 644Called whenever the view offset changes, i.e. the user or program
645scrolls. Offset \f(CW0\fR means display the normal terminal, positive values 645scrolls. Offset \f(CW0\fR means display the normal terminal, positive values
646show this many lines of scrollback. 646show this many lines of scrollback.
647.ie n .IP "on_scroll_back $term\fR, \f(CW$lines\fR, \f(CW$saved" 4 647.ie n .IP "on_scroll_back $term\fR, \f(CW$lines\fR, \f(CW$saved" 4
648.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4 648.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4
649.IX Item "on_scroll_back $term, $lines, $saved" 649.IX Item "on_scroll_back $term, $lines, $saved"
… …
673string should start with the extension name and a colon, to distinguish 673string should start with the extension name and a colon, to distinguish
674it from commands for other extensions, and this might be enforced in the 674it from commands for other extensions, and this might be enforced in the
675future. 675future.
676.Sp 676.Sp
677Be careful not ever to trust (in a security sense) the data you receive, 677Be careful not ever to trust (in a security sense) the data you receive,
678as its source can not easily be controleld (e\-mail content, messages from 678as its source can not easily be controlled (e\-mail content, messages from
679other users on the same system etc.). 679other users on the same system etc.).
680.ie n .IP "on_add_lines $term\fR, \f(CW$string" 4 680.ie n .IP "on_add_lines $term\fR, \f(CW$string" 4
681.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4 681.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4
682.IX Item "on_add_lines $term, $string" 682.IX Item "on_add_lines $term, $string"
683Called whenever text is about to be output, with the text as argument. You 683Called whenever text is about to be output, with the text as argument. You
… …
716.IX Item "on_refresh_end $term" 716.IX Item "on_refresh_end $term"
717Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR. 717Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR.
718.ie n .IP "on_user_command $term\fR, \f(CW$string" 4 718.ie n .IP "on_user_command $term\fR, \f(CW$string" 4
719.el .IP "on_user_command \f(CW$term\fR, \f(CW$string\fR" 4 719.el .IP "on_user_command \f(CW$term\fR, \f(CW$string\fR" 4
720.IX Item "on_user_command $term, $string" 720.IX Item "on_user_command $term, $string"
721Called whenever the a user-configured event is being activated (e.g. via 721Called whenever a user-configured event is being activated (e.g. via
722a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR 722a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR
723resource in the @@RXVT_NAME@@(1) manpage). 723resource in the @@RXVT_NAME@@(1) manpage).
724.Sp 724.Sp
725The event is simply the action string. This interface is assumed to change 725The event is simply the action string. This interface is assumed to change
726slightly in the future. 726slightly in the future.
727.ie n .IP "on_resize_all_windows $tern\fR, \f(CW$new_width\fR, \f(CW$new_height" 4 727.ie n .IP "on_resize_all_windows $tern\fR, \f(CW$new_width\fR, \f(CW$new_height" 4
728.el .IP "on_resize_all_windows \f(CW$tern\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4 728.el .IP "on_resize_all_windows \f(CW$tern\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4
729.IX Item "on_resize_all_windows $tern, $new_width, $new_height" 729.IX Item "on_resize_all_windows $tern, $new_width, $new_height"
730Called just after the new window size has been calculcated, but before 730Called just after the new window size has been calculated, but before
731windows are actually being resized or hints are being set. If this hook 731windows are actually being resized or hints are being set. If this hook
732returns \s-1TRUE\s0, setting of the window hints is being skipped. 732returns \s-1TRUE\s0, setting of the window hints is being skipped.
733.ie n .IP "on_x_event $term\fR, \f(CW$event" 4 733.ie n .IP "on_x_event $term\fR, \f(CW$event" 4
734.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4 734.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4
735.IX Item "on_x_event $term, $event" 735.IX Item "on_x_event $term, $event"
… …
746Called whenever the window gets the keyboard focus, before rxvt-unicode 746Called whenever the window gets the keyboard focus, before rxvt-unicode
747does focus in processing. 747does focus in processing.
748.ie n .IP "on_focus_out $term" 4 748.ie n .IP "on_focus_out $term" 4
749.el .IP "on_focus_out \f(CW$term\fR" 4 749.el .IP "on_focus_out \f(CW$term\fR" 4
750.IX Item "on_focus_out $term" 750.IX Item "on_focus_out $term"
751Called wheneever the window loses keyboard focus, before rxvt-unicode does 751Called whenever the window loses keyboard focus, before rxvt-unicode does
752focus out processing. 752focus out processing.
753.ie n .IP "on_configure_notify $term\fR, \f(CW$event" 4 753.ie n .IP "on_configure_notify $term\fR, \f(CW$event" 4
754.el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4 754.el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4
755.IX Item "on_configure_notify $term, $event" 755.IX Item "on_configure_notify $term, $event"
756.PD 0 756.PD 0
… …
825The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR 825The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR
826object, whenever a callback/hook is executing. 826object, whenever a callback/hook is executing.
827.ie n .IP "@urxvt::TERM_INIT" 4 827.ie n .IP "@urxvt::TERM_INIT" 4
828.el .IP "\f(CW@urxvt::TERM_INIT\fR" 4 828.el .IP "\f(CW@urxvt::TERM_INIT\fR" 4
829.IX Item "@urxvt::TERM_INIT" 829.IX Item "@urxvt::TERM_INIT"
830All coderefs in this array will be called as methods of the next newly 830All code references in this array will be called as methods of the next newly
831created \f(CW\*(C`urxvt::term\*(C'\fR object (during the \f(CW\*(C`on_init\*(C'\fR phase). The array 831created \f(CW\*(C`urxvt::term\*(C'\fR object (during the \f(CW\*(C`on_init\*(C'\fR phase). The array
832gets cleared before the codereferences that were in it are being executed, 832gets cleared before the code references that were in it are being executed,
833so coderefs can push themselves onto it again if they so desire. 833so references can push themselves onto it again if they so desire.
834.Sp 834.Sp
835This complements to the perl-eval commandline option, but gets executed 835This complements to the perl-eval command line option, but gets executed
836first. 836first.
837.ie n .IP "@urxvt::TERM_EXT" 4 837.ie n .IP "@urxvt::TERM_EXT" 4
838.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4 838.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4
839.IX Item "@urxvt::TERM_EXT" 839.IX Item "@urxvt::TERM_EXT"
840Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which 840Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which
… …
862Messages have a size limit of 1023 bytes currently. 862Messages have a size limit of 1023 bytes currently.
863.ie n .IP "@terms = urxvt::termlist" 4 863.ie n .IP "@terms = urxvt::termlist" 4
864.el .IP "\f(CW@terms\fR = urxvt::termlist" 4 864.el .IP "\f(CW@terms\fR = urxvt::termlist" 4
865.IX Item "@terms = urxvt::termlist" 865.IX Item "@terms = urxvt::termlist"
866Returns all urxvt::term objects that exist in this process, regardless of 866Returns all urxvt::term objects that exist in this process, regardless of
867wether they are started, being destroyed etc., so be careful. Only term 867whether they are started, being destroyed etc., so be careful. Only term
868objects that have perl extensions attached will be returned (because there 868objects that have perl extensions attached will be returned (because there
869is no urxvt::term objet associated with others). 869is no urxvt::term objet associated with others).
870.ie n .IP "$time = urxvt::NOW" 4 870.ie n .IP "$time = urxvt::NOW" 4
871.el .IP "\f(CW$time\fR = urxvt::NOW" 4 871.el .IP "\f(CW$time\fR = urxvt::NOW" 4
872.IX Item "$time = urxvt::NOW" 872.IX Item "$time = urxvt::NOW"
… …
982.IX Item "$isset = $term->option ($optval[, $set])" 982.IX Item "$isset = $term->option ($optval[, $set])"
983Returns true if the option specified by \f(CW$optval\fR is enabled, and 983Returns true if the option specified by \f(CW$optval\fR is enabled, and
984optionally change it. All option values are stored by name in the hash 984optionally change it. All option values are stored by name in the hash
985\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash. 985\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash.
986.Sp 986.Sp
987Here is a a likely non-exhaustive list of option names, please see the 987Here is a likely non-exhaustive list of option names, please see the
988source file \fI/src/optinc.h\fR to see the actual list: 988source file \fI/src/optinc.h\fR to see the actual list:
989.Sp 989.Sp
990.Vb 6 990.Vb 6
991\& borderLess console cursorBlink cursorUnderline hold iconic insecure 991\& borderLess console cursorBlink cursorUnderline hold iconic insecure
992\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 992\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
… …
1011likely change). 1011likely change).
1012.Sp 1012.Sp
1013Please note that resource strings will currently only be freed when the 1013Please note that resource strings will currently only be freed when the
1014terminal is destroyed, so changing options frequently will eat memory. 1014terminal is destroyed, so changing options frequently will eat memory.
1015.Sp 1015.Sp
1016Here is a a likely non-exhaustive list of resource names, not all of which 1016Here is a likely non-exhaustive list of resource names, not all of which
1017are supported in every build, please see the source file \fI/src/rsinc.h\fR 1017are supported in every build, please see the source file \fI/src/rsinc.h\fR
1018to see the actual list: 1018to see the actual list:
1019.Sp 1019.Sp
1020.Vb 10 1020.Vb 10
1021\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1021\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
… …
1313.IX Item "$screen = $term->current_screen" 1313.IX Item "$screen = $term->current_screen"
1314Returns the currently displayed screen (0 primary, 1 secondary). 1314Returns the currently displayed screen (0 primary, 1 secondary).
1315.ie n .IP "$cursor_is_hidden\fR = \f(CW$term\->hidden_cursor" 4 1315.ie n .IP "$cursor_is_hidden\fR = \f(CW$term\->hidden_cursor" 4
1316.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4 1316.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4
1317.IX Item "$cursor_is_hidden = $term->hidden_cursor" 1317.IX Item "$cursor_is_hidden = $term->hidden_cursor"
1318Returns wether the cursor is currently hidden or not. 1318Returns whether the cursor is currently hidden or not.
1319.ie n .IP "$view_start\fR = \f(CW$term\->view_start ([$newvalue])" 4 1319.ie n .IP "$view_start\fR = \f(CW$term\->view_start ([$newvalue])" 4
1320.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4 1320.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4
1321.IX Item "$view_start = $term->view_start ([$newvalue])" 1321.IX Item "$view_start = $term->view_start ([$newvalue])"
1322Returns the row number of the topmost displayed line. Maximum value is 1322Returns the row number of the topmost displayed line. Maximum value is
1323\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll 1323\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll
… …
1427where one character corresponds to one screen cell. See 1427where one character corresponds to one screen cell. See
1428\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 1428\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
1429.ie n .IP "$string\fR = \f(CW$term\fR\->special_decode \f(CW$text" 4 1429.ie n .IP "$string\fR = \f(CW$term\fR\->special_decode \f(CW$text" 4
1430.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 1430.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4
1431.IX Item "$string = $term->special_decode $text" 1431.IX Item "$string = $term->special_decode $text"
1432Converts rxvt-unicodes text reprsentation into a perl string. See 1432Converts rxvt-unicodes text representation into a perl string. See
1433\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 1433\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
1434.ie n .IP "$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 1434.ie n .IP "$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4
1435.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 1435.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4
1436.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])" 1436.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])"
1437.PD 0 1437.PD 0
… …
1443manpage. 1443manpage.
1444.ie n .IP "$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync])" 4 1444.ie n .IP "$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync])" 4
1445.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 1445.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4
1446.IX Item "$success = $term->grab ($eventtime[, $sync])" 1446.IX Item "$success = $term->grab ($eventtime[, $sync])"
1447Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1447Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1448synchronous (\f(CW$sync\fR is true). Also remembers the grab timestampe. 1448synchronous (\f(CW$sync\fR is true). Also remembers the grab timestamp.
1449.ie n .IP "$term\->allow_events_async" 4 1449.ie n .IP "$term\->allow_events_async" 4
1450.el .IP "\f(CW$term\fR\->allow_events_async" 4 1450.el .IP "\f(CW$term\fR\->allow_events_async" 4
1451.IX Item "$term->allow_events_async" 1451.IX Item "$term->allow_events_async"
1452Calls XAllowEvents with AsyncBoth for the most recent grab. 1452Calls XAllowEvents with AsyncBoth for the most recent grab.
1453.ie n .IP "$term\->allow_events_sync" 4 1453.ie n .IP "$term\->allow_events_sync" 4
… …
1619Set the callback to be called when io events are triggered. \f(CW$reventmask\fR 1619Set the callback to be called when io events are triggered. \f(CW$reventmask\fR
1620is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. 1620is a bitset as described in the \f(CW\*(C`events\*(C'\fR method.
1621.ie n .IP "$iow\fR = \f(CW$iow\->fd ($fd)" 4 1621.ie n .IP "$iow\fR = \f(CW$iow\->fd ($fd)" 4
1622.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4 1622.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4
1623.IX Item "$iow = $iow->fd ($fd)" 1623.IX Item "$iow = $iow->fd ($fd)"
1624Set the filedescriptor (not handle) to watch. 1624Set the file descriptor (not handle) to watch.
1625.ie n .IP "$iow\fR = \f(CW$iow\->events ($eventmask)" 4 1625.ie n .IP "$iow\fR = \f(CW$iow\->events ($eventmask)" 4
1626.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4 1626.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4
1627.IX Item "$iow = $iow->events ($eventmask)" 1627.IX Item "$iow = $iow->events ($eventmask)"
1628Set the event mask to watch. The only allowed values are 1628Set the event mask to watch. The only allowed values are
1629\&\f(CW\*(C`urxvt::EVENT_READ\*(C'\fR and \f(CW\*(C`urxvt::EVENT_WRITE\*(C'\fR, which might be ORed 1629\&\f(CW\*(C`urxvt::EVENT_READ\*(C'\fR and \f(CW\*(C`urxvt::EVENT_WRITE\*(C'\fR, which might be ORed
… …
1633.IX Item "$iow = $iow->start" 1633.IX Item "$iow = $iow->start"
1634Start watching for requested events on the given handle. 1634Start watching for requested events on the given handle.
1635.ie n .IP "$iow\fR = \f(CW$iow\->stop" 4 1635.ie n .IP "$iow\fR = \f(CW$iow\->stop" 4
1636.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4 1636.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4
1637.IX Item "$iow = $iow->stop" 1637.IX Item "$iow = $iow->stop"
1638Stop watching for events on the given filehandle. 1638Stop watching for events on the given file handle.
1639.ie n .Sh "The ""urxvt::iw"" Class" 1639.ie n .Sh "The ""urxvt::iw"" Class"
1640.el .Sh "The \f(CWurxvt::iw\fP Class" 1640.el .Sh "The \f(CWurxvt::iw\fP Class"
1641.IX Subsection "The urxvt::iw Class" 1641.IX Subsection "The urxvt::iw Class"
1642This class implements idle watchers, that get called automatically when 1642This class implements idle watchers, that get called automatically when
1643the process is idle. They should return as fast as possible, after doing 1643the process is idle. They should return as fast as possible, after doing
… …
1684.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })" 1684.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })"
1685Set the callback to be called when the timer triggers. 1685Set the callback to be called when the timer triggers.
1686.ie n .IP "$pw\fR = \f(CW$timer\->start ($pid)" 4 1686.ie n .IP "$pw\fR = \f(CW$timer\->start ($pid)" 4
1687.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4 1687.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4
1688.IX Item "$pw = $timer->start ($pid)" 1688.IX Item "$pw = $timer->start ($pid)"
1689Tells the wqtcher to start watching for process \f(CW$pid\fR. 1689Tells the watcher to start watching for process \f(CW$pid\fR.
1690.ie n .IP "$pw\fR = \f(CW$pw\->stop" 4 1690.ie n .IP "$pw\fR = \f(CW$pw\->stop" 4
1691.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4 1691.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4
1692.IX Item "$pw = $pw->stop" 1692.IX Item "$pw = $pw->stop"
1693Stop the watcher. 1693Stop the watcher.
1694.SH "ENVIRONMENT" 1694.SH "ENVIRONMENT"
… …
1702.PD 0 1702.PD 0
1703.IP ">= 3 \- script loading and management" 4 1703.IP ">= 3 \- script loading and management" 4
1704.IX Item ">= 3 - script loading and management" 1704.IX Item ">= 3 - script loading and management"
1705.IP ">=10 \- all called hooks" 4 1705.IP ">=10 \- all called hooks" 4
1706.IX Item ">=10 - all called hooks" 1706.IX Item ">=10 - all called hooks"
1707.IP ">=11 \- hook reutrn values" 4 1707.IP ">=11 \- hook return values" 4
1708.IX Item ">=11 - hook reutrn values" 1708.IX Item ">=11 - hook return values"
1709.PD 1709.PD
1710.SH "AUTHOR" 1710.SH "AUTHOR"
1711.IX Header "AUTHOR" 1711.IX Header "AUTHOR"
1712.Vb 2 1712.Vb 2
1713\& Marc Lehmann <pcg@goof.com> 1713\& Marc Lehmann <pcg@goof.com>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines