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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.45 by root, Mon Jul 17 19:20:29 2006 UTC vs.
Revision 1.47 by root, Thu Nov 2 17:37:47 2006 UTC

69 rxvt --perl-lib $HOME -pe grab_test</pre> 69 rxvt --perl-lib $HOME -pe grab_test</pre>
70<p> 70<p>
71</p> 71</p>
72<hr /> 72<hr />
73<h1><a name="description">DESCRIPTION</a></h1> 73<h1><a name="description">DESCRIPTION</a></h1>
74<p>Everytime a terminal object gets created, extension scripts specified via 74<p>Every time a terminal object gets created, extension scripts specified via
75the <code>perl</code> resource are loaded and associated with it.</p> 75the <code>perl</code> resource are loaded and associated with it.</p>
76<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 76<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
77thus must be encoded as UTF-8.</p> 77thus must be encoded as UTF-8.</p>
78<p>Each script will only ever be loaded once, even in rxvtd, where 78<p>Each script will only ever be loaded once, even in rxvtd, where
79scripts will be shared (but not enabled) for all terminals.</p> 79scripts will be shared (but not enabled) for all terminals.</p>
115 ...</pre> 115 ...</pre>
116</dd> 116</dd>
117<dd> 117<dd>
118<p>The index number (0, 1...) must not have any holes, and each regex must 118<p>The index number (0, 1...) must not have any holes, and each regex must
119contain at least one pair of capturing parentheses, which will be used for 119contain at least one pair of capturing parentheses, which will be used for
120the match. For example, the followign adds a regex that matches everything 120the match. For example, the following adds a regex that matches everything
121between two vertical bars:</p> 121between two vertical bars:</p>
122</dd> 122</dd>
123<dd> 123<dd>
124<pre> 124<pre>
125 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> 125 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
194onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the 194onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
195popup is being displayed.</p> 195popup is being displayed.</p>
196</dd> 196</dd>
197<dd> 197<dd>
198<p>It's sole argument is the popup menu, which can be modified. The selection 198<p>It's sole argument is the popup menu, which can be modified. The selection
199is in <code>$_</code>, which can be used to decide wether to add something or not. 199is in <code>$_</code>, which can be used to decide whether to add something or not.
200It should either return nothing or a string and a code reference. The 200It should either return nothing or a string and a code reference. The
201string will be used as button text and the code reference will be called 201string will be used as button text and the code reference will be called
202when the button gets activated and should transform <code>$_</code>.</p> 202when the button gets activated and should transform <code>$_</code>.</p>
203</dd> 203</dd>
204<dd> 204<dd>
317</li> 317</li>
318<dt><strong><a name="item_tabbed">tabbed</a></strong> 318<dt><strong><a name="item_tabbed">tabbed</a></strong>
319 319
320<dd> 320<dd>
321<p>This transforms the terminal into a tabbar with additional terminals, that 321<p>This transforms the terminal into a tabbar with additional terminals, that
322is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line 322is, it implements what is commonly referred to as ``tabbed terminal''. The topmost line
323displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one 323displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
324button per tab.</p> 324button per tab.</p>
325</dd> 325</dd>
326<dd> 326<dd>
327<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and 327<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
343<dd> 343<dd>
344<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid 344<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
345indices.</p> 345indices.</p>
346</dd> 346</dd>
347</li> 347</li>
348<dt><strong><a name="item_mark_2durls">mark-urls</a></strong> 348<dt><strong><a name="item_matcher">matcher</a></strong>
349 349
350<dd> 350<dd>
351<p>Uses per-line display filtering (<code>on_line_update</code>) to underline urls and 351<p>Uses per-line display filtering (<code>on_line_update</code>) to underline text
352make them clickable. When middle-clicked, the program specified in the 352matching a certain pattern and make it clickable. When clicked with the
353mouse button specified in the <code>matcher.button</code> resource (default 2, or
354middle), the program specified in the <code>matcher.launcher</code> resource
353resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 355(default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started
354the URL as first argument.</p> 356with the matched text as first argument. The default configuration is
357suitable for matching URLs and launching a web browser, like the
358former ``mark-urls'' extension.</p>
359</dd>
360<dd>
361<p>The default pattern to match URLs can be overridden with the
362<code>matcher.pattern.0</code> resource, and additional patterns can be specified
363with numbered patterns, in a manner similar to the ``selection'' extension.
364The launcher can also be overridden on a per-pattern basis.</p>
365</dd>
366<dd>
367<p>Example configuration:</p>
368</dd>
369<dd>
370<pre>
371 URxvt.perl-ext: default,matcher
372 URxvt.urlLauncher: sensible-browser
373 URxvt.matcher.button: 1
374 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&amp;@#-]*[\\w/-]
375 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
376 URxvt.matcher.launcher.2: gvim +$2 $1</pre>
355</dd> 377</dd>
356</li> 378</li>
357<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong> 379<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong>
358 380
359<dd> 381<dd>
386<dd> 408<dd>
387<p>This is useful if you need a single terminal thats not using any desktop 409<p>This is useful if you need a single terminal thats not using any desktop
388space most of the time but is quickly available at the press of a key.</p> 410space most of the time but is quickly available at the press of a key.</p>
389</dd> 411</dd>
390<dd> 412<dd>
391<p>The accelerator key is grabbed regardless of any modifers, so this 413<p>The accelerator key is grabbed regardless of any modifiers, so this
392extension will actually grab a physical key just for this function.</p> 414extension will actually grab a physical key just for this function.</p>
393</dd> 415</dd>
394<dd> 416<dd>
395<p>If you want a quake-like animation, tell your window manager to do so 417<p>If you want a quake-like animation, tell your window manager to do so
396(fvwm can do it).</p> 418(fvwm can do it).</p>
400 422
401<dd> 423<dd>
402<p>This is basically a very small extension that dynamically changes the 424<p>This is basically a very small extension that dynamically changes the
403background pixmap offset to the window position, in effect creating the 425background pixmap offset to the window position, in effect creating the
404same effect as pseudo transparency with a custom pixmap. No scaling is 426same effect as pseudo transparency with a custom pixmap. No scaling is
405supported in this mode. Exmaple:</p> 427supported in this mode. Example:</p>
406</dd> 428</dd>
407<dd> 429<dd>
408<pre> 430<pre>
409 rxvt -pixmap background.xpm -pe automove-background</pre> 431 rxvt -pixmap background.xpm -pe automove-background</pre>
410</dd> 432</dd>
488for the filename):</p> 510for the filename):</p>
489</dd> 511</dd>
490<dd> 512<dd>
491<pre> 513<pre>
492 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 514 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
515</dd>
516<dd>
517<p><em>Note to xrdb users:</em> xrdb uses the C preprocessor, which might interpret
518the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead,
519which works regardless of wether xrdb is used to parse the resource file
520or not.</p>
493</dd> 521</dd>
494</li> 522</li>
495<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong> 523<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong>
496 524
497<dd> 525<dd>
545</dl> 573</dl>
546<p> 574<p>
547</p> 575</p>
548<h2><a name="extension_objects">Extension Objects</a></h2> 576<h2><a name="extension_objects">Extension Objects</a></h2>
549<p>Every perl extension is a perl class. A separate perl object is created 577<p>Every perl extension is a perl class. A separate perl object is created
550for each terminal and each extension and passed as the first parameter to 578for each terminal, and each terminal has its own set of extenion objects,
551hooks. So extensions can use their <code>$self</code> object without having to think 579which are passed as the first parameter to hooks. So extensions can use
552about other extensions, with the exception of methods and members that 580their <code>$self</code> object without having to think about clashes with other
581extensions or other terminals, with the exception of methods and members
553begin with an underscore character <code>_</code>: these are reserved for internal 582that begin with an underscore character <code>_</code>: these are reserved for
554use.</p> 583internal use.</p>
555<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the 584<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
556<code>urxvt::term</code> class on this object.</p> 585<code>urxvt::term</code> class on this object.</p>
557<p>It has the following methods and data members:</p> 586<p>It has the following methods and data members:</p>
558<dl> 587<dl>
559<dt><strong><a name="item__urxvt_term">$urxvt_term = $self-&gt;{term}</a></strong> 588<dt><strong><a name="item__urxvt_term">$urxvt_term = $self-&gt;{term}</a></strong>
581<p> 610<p>
582</p> 611</p>
583<h2><a name="hooks">Hooks</a></h2> 612<h2><a name="hooks">Hooks</a></h2>
584<p>The following subroutines can be declared in extension files, and will be 613<p>The following subroutines can be declared in extension files, and will be
585called whenever the relevant event happens.</p> 614called whenever the relevant event happens.</p>
586<p>The first argument passed to them is an extension oject as described in 615<p>The first argument passed to them is an extension object as described in
587the in the <code>Extension Objects</code> section.</p> 616the in the <code>Extension Objects</code> section.</p>
588<p><strong>All</strong> of these hooks must return a boolean value. If any of the called 617<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
589hooks returns true, then the event counts as being <em>consumed</em>, and the 618hooks returns true, then the event counts as being <em>consumed</em>, and the
590relevant action might not be carried out by the C++ code.</p> 619relevant action might not be carried out by the C++ code.</p>
591<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 620<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
603</li> 632</li>
604<dt><strong><a name="item_on_start__24term">on_start $term</a></strong> 633<dt><strong><a name="item_on_start__24term">on_start $term</a></strong>
605 634
606<dd> 635<dd>
607<p>Called at the very end of initialisation of a new terminal, just before 636<p>Called at the very end of initialisation of a new terminal, just before
608trying to map (display) the toplevel and returning to the mainloop.</p> 637trying to map (display) the toplevel and returning to the main loop.</p>
609</dd> 638</dd>
610</li> 639</li>
611<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong> 640<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong>
612 641
613<dd> 642<dd>
654<p>Called whenever a selection has been copied, but before the selection is 683<p>Called whenever a selection has been copied, but before the selection is
655requested from the server. The selection text can be queried and changed 684requested from the server. The selection text can be queried and changed
656by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.</p> 685by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>.</p>
657</dd> 686</dd>
658<dd> 687<dd>
659<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 688<p>Returning a true value aborts selection grabbing. It will still be highlighted.</p>
660</dd> 689</dd>
661</li> 690</li>
662<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong> 691<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong>
663 692
664<dd> 693<dd>
665<p>Called whenever the user tries to extend the selection (e.g. with a double 694<p>Called whenever the user tries to extend the selection (e.g. with a double
666click) and is either supposed to return false (normal operation), or 695click) and is either supposed to return false (normal operation), or
667should extend the selection itelf and return true to suppress the built-in 696should extend the selection itself and return true to suppress the built-in
668processing. This can happen multiple times, as long as the callback 697processing. This can happen multiple times, as long as the callback
669returns true, it will be called on every further click by the user and is 698returns true, it will be called on every further click by the user and is
670supposed to enlarge the selection more and more, if possible.</p> 699supposed to enlarge the selection more and more, if possible.</p>
671</dd> 700</dd>
672<dd> 701<dd>
674</dd> 703</dd>
675</li> 704</li>
676<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong> 705<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong>
677 706
678<dd> 707<dd>
679<p>Called whenever the view offset changes, i..e the user or program 708<p>Called whenever the view offset changes, i.e. the user or program
680scrolls. Offset <code>0</code> means display the normal terminal, positive values 709scrolls. Offset <code>0</code> means display the normal terminal, positive values
681show this many lines of scrollback.</p> 710show this many lines of scrollback.</p>
682</dd> 711</dd>
683</li> 712</li>
684<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong> 713<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong>
717it from commands for other extensions, and this might be enforced in the 746it from commands for other extensions, and this might be enforced in the
718future.</p> 747future.</p>
719</dd> 748</dd>
720<dd> 749<dd>
721<p>Be careful not ever to trust (in a security sense) the data you receive, 750<p>Be careful not ever to trust (in a security sense) the data you receive,
722as its source can not easily be controleld (e-mail content, messages from 751as its source can not easily be controlled (e-mail content, messages from
723other users on the same system etc.).</p> 752other users on the same system etc.).</p>
724</dd> 753</dd>
725</li> 754</li>
726<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong> 755<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong>
727 756
774</dd> 803</dd>
775</li> 804</li>
776<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong> 805<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong>
777 806
778<dd> 807<dd>
779<p>Called whenever the a user-configured event is being activated (e.g. via 808<p>Called whenever a user-configured event is being activated (e.g. via
780a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> 809a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
781resource in the <code>rxvt(1)</code> manpage).</p> 810resource in the <code>rxvt(1)</code> manpage).</p>
782</dd> 811</dd>
783<dd> 812<dd>
784<p>The event is simply the action string. This interface is assumed to change 813<p>The event is simply the action string. This interface is assumed to change
786</dd> 815</dd>
787</li> 816</li>
788<dt><strong><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong> 817<dt><strong><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong>
789 818
790<dd> 819<dd>
791<p>Called just after the new window size has been calculcated, but before 820<p>Called just after the new window size has been calculated, but before
792windows are actually being resized or hints are being set. If this hook 821windows are actually being resized or hints are being set. If this hook
793returns TRUE, setting of the window hints is being skipped.</p> 822returns TRUE, setting of the window hints is being skipped.</p>
794</dd> 823</dd>
795</li> 824</li>
796<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong> 825<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong>
815</dd> 844</dd>
816</li> 845</li>
817<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong> 846<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong>
818 847
819<dd> 848<dd>
820<p>Called wheneever the window loses keyboard focus, before rxvt-unicode does 849<p>Called whenever the window loses keyboard focus, before rxvt-unicode does
821focus out processing.</p> 850focus out processing.</p>
822</dd> 851</dd>
823</li> 852</li>
824<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong> 853<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong>
825 854
899</dd> 928</dd>
900</li> 929</li>
901<dt><strong><a name="item__urxvt__term_init">@urxvt::TERM_INIT</a></strong> 930<dt><strong><a name="item__urxvt__term_init">@urxvt::TERM_INIT</a></strong>
902 931
903<dd> 932<dd>
904<p>All coderefs in this array will be called as methods of the next newly 933<p>All code references in this array will be called as methods of the next newly
905created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array 934created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
906gets cleared before the codereferences that were in it are being executed, 935gets cleared before the code references that were in it are being executed,
907so coderefs can push themselves onto it again if they so desire.</p> 936so references can push themselves onto it again if they so desire.</p>
908</dd>
909<dd> 937</dd>
938<dd>
910<p>This complements to the perl-eval commandline option, but gets executed 939<p>This complements to the perl-eval command line option, but gets executed
911first.</p> 940first.</p>
912</dd> 941</dd>
913</li> 942</li>
914<dt><strong><a name="item__urxvt__term_ext">@urxvt::TERM_EXT</a></strong> 943<dt><strong><a name="item__urxvt__term_ext">@urxvt::TERM_EXT</a></strong>
915 944
949</li> 978</li>
950<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong> 979<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong>
951 980
952<dd> 981<dd>
953<p>Returns all urxvt::term objects that exist in this process, regardless of 982<p>Returns all urxvt::term objects that exist in this process, regardless of
954wether they are started, being destroyed etc., so be careful. Only term 983whether they are started, being destroyed etc., so be careful. Only term
955objects that have perl extensions attached will be returned (because there 984objects that have perl extensions attached will be returned (because there
956is no urxvt::term objet associated with others).</p> 985is no urxvt::term objet associated with others).</p>
957</dd> 986</dd>
958</li> 987</li>
959<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong> 988<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong>
1108<p>Returns true if the option specified by <code>$optval</code> is enabled, and 1137<p>Returns true if the option specified by <code>$optval</code> is enabled, and
1109optionally change it. All option values are stored by name in the hash 1138optionally change it. All option values are stored by name in the hash
1110<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p> 1139<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p>
1111</dd> 1140</dd>
1112<dd> 1141<dd>
1113<p>Here is a a likely non-exhaustive list of option names, please see the 1142<p>Here is a likely non-exhaustive list of option names, please see the
1114source file <em>/src/optinc.h</em> to see the actual list:</p> 1143source file <em>/src/optinc.h</em> to see the actual list:</p>
1115</dd> 1144</dd>
1116<dd> 1145<dd>
1117<pre> 1146<pre>
1118 borderLess console cursorBlink cursorUnderline hold iconic insecure 1147 borderLess console cursorBlink cursorUnderline hold iconic insecure
1143<dd> 1172<dd>
1144<p>Please note that resource strings will currently only be freed when the 1173<p>Please note that resource strings will currently only be freed when the
1145terminal is destroyed, so changing options frequently will eat memory.</p> 1174terminal is destroyed, so changing options frequently will eat memory.</p>
1146</dd> 1175</dd>
1147<dd> 1176<dd>
1148<p>Here is a a likely non-exhaustive list of resource names, not all of which 1177<p>Here is a likely non-exhaustive list of resource names, not all of which
1149are supported in every build, please see the source file <em>/src/rsinc.h</em> 1178are supported in every build, please see the source file <em>/src/rsinc.h</em>
1150to see the actual list:</p> 1179to see the actual list:</p>
1151</dd> 1180</dd>
1152<dd> 1181<dd>
1153<pre> 1182<pre>
1500</dd> 1529</dd>
1501</li> 1530</li>
1502<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong> 1531<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong>
1503 1532
1504<dd> 1533<dd>
1505<p>Returns wether the cursor is currently hidden or not.</p> 1534<p>Returns whether the cursor is currently hidden or not.</p>
1506</dd> 1535</dd>
1507</li> 1536</li>
1508<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong> 1537<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong>
1509 1538
1510<dd> 1539<dd>
1645</dd> 1674</dd>
1646</li> 1675</li>
1647<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong> 1676<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong>
1648 1677
1649<dd> 1678<dd>
1650<p>Converts rxvt-unicodes text reprsentation into a perl string. See 1679<p>Converts rxvt-unicodes text representation into a perl string. See
1651<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.</p> 1680<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.</p>
1652</dd> 1681</dd>
1653</li> 1682</li>
1654<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong> 1683<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong>
1655 1684
1662</li> 1691</li>
1663<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong> 1692<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong>
1664 1693
1665<dd> 1694<dd>
1666<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1695<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1667synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.</p> 1696synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
1668</dd> 1697</dd>
1669</li> 1698</li>
1670<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong> 1699<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong>
1671 1700
1672<dd> 1701<dd>
1870</dd> 1899</dd>
1871</li> 1900</li>
1872<dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong> 1901<dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong>
1873 1902
1874<dd> 1903<dd>
1875<p>Set the filedescriptor (not handle) to watch.</p> 1904<p>Set the file descriptor (not handle) to watch.</p>
1876</dd> 1905</dd>
1877</li> 1906</li>
1878<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong> 1907<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong>
1879 1908
1880<dd> 1909<dd>
1890</dd> 1919</dd>
1891</li> 1920</li>
1892<dt><strong>$iow = $iow-&gt;stop</strong> 1921<dt><strong>$iow = $iow-&gt;stop</strong>
1893 1922
1894<dd> 1923<dd>
1895<p>Stop watching for events on the given filehandle.</p> 1924<p>Stop watching for events on the given file handle.</p>
1896</dd> 1925</dd>
1897</li> 1926</li>
1898</dl> 1927</dl>
1899<p> 1928<p>
1900</p> 1929</p>
1957</dd> 1986</dd>
1958</li> 1987</li>
1959<dt><strong>$pw = $timer-&gt;start ($pid)</strong> 1988<dt><strong>$pw = $timer-&gt;start ($pid)</strong>
1960 1989
1961<dd> 1990<dd>
1962<p>Tells the wqtcher to start watching for process <code>$pid</code>.</p> 1991<p>Tells the watcher to start watching for process <code>$pid</code>.</p>
1963</dd> 1992</dd>
1964</li> 1993</li>
1965<dt><strong>$pw = $pw-&gt;stop</strong> 1994<dt><strong>$pw = $pw-&gt;stop</strong>
1966 1995
1967<dd> 1996<dd>
1983 2012
1984<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong> 2013<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong>
1985 2014
1986<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong> 2015<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong>
1987 2016
1988<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong> 2017<dt><strong><a name="item__3e_3d11__2d_hook_return_values">&gt;=11 - hook return values</a></strong>
1989 2018
1990</dl> 2019</dl>
1991<p> 2020<p>
1992</p> 2021</p>
1993<hr /> 2022<hr />

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines