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.44 by root, Thu Jul 6 18:56:10 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>
… …
369<dd> 391<dd>
370<pre> 392<pre>
371 rxvt -pt OnTheSpot -pe xim-onthespot</pre> 393 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
372</dd> 394</dd>
373</li> 395</li>
396<dt><strong><a name="item_kuake_3chotkey_3e">kuake&lt;hotkey&gt;</a></strong>
397
398<dd>
399<p>A very primitive quake-console-like extension. It was inspired by a
400description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the
401user presses a global accelerator key (by default <code>F10</code>), the terminal
402will show or hide itself. Another press of the accelerator key will hide
403or show it again.</p>
404</dd>
405<dd>
406<p>Initially, the window will not be shown when using this extension.</p>
407</dd>
408<dd>
409<p>This is useful if you need a single terminal thats not using any desktop
410space most of the time but is quickly available at the press of a key.</p>
411</dd>
412<dd>
413<p>The accelerator key is grabbed regardless of any modifiers, so this
414extension will actually grab a physical key just for this function.</p>
415</dd>
416<dd>
417<p>If you want a quake-like animation, tell your window manager to do so
418(fvwm can do it).</p>
419</dd>
420</li>
374<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong> 421<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong>
375 422
376<dd> 423<dd>
377<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
378background pixmap offset to the window position, in effect creating the 425background pixmap offset to the window position, in effect creating the
379same effect as pseudo transparency with a custom pixmap. No scaling is 426same effect as pseudo transparency with a custom pixmap. No scaling is
380supported in this mode. Exmaple:</p> 427supported in this mode. Example:</p>
381</dd> 428</dd>
382<dd> 429<dd>
383<pre> 430<pre>
384 rxvt -pixmap background.xpm -pe automove-background</pre> 431 rxvt -pixmap background.xpm -pe automove-background</pre>
385</dd> 432</dd>
… …
463for the filename):</p> 510for the filename):</p>
464</dd> 511</dd>
465<dd> 512<dd>
466<pre> 513<pre>
467 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>
468</dd> 521</dd>
469</li> 522</li>
470<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>
471 524
472<dd> 525<dd>
… …
520</dl> 573</dl>
521<p> 574<p>
522</p> 575</p>
523<h2><a name="extension_objects">Extension Objects</a></h2> 576<h2><a name="extension_objects">Extension Objects</a></h2>
524<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
525for 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,
526hooks. 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
527about 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
528begin with an underscore character <code>_</code>: these are reserved for internal 582that begin with an underscore character <code>_</code>: these are reserved for
529use.</p> 583internal use.</p>
530<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
531<code>urxvt::term</code> class on this object.</p> 585<code>urxvt::term</code> class on this object.</p>
532<p>It has the following methods and data members:</p> 586<p>It has the following methods and data members:</p>
533<dl> 587<dl>
534<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>
… …
556<p> 610<p>
557</p> 611</p>
558<h2><a name="hooks">Hooks</a></h2> 612<h2><a name="hooks">Hooks</a></h2>
559<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
560called whenever the relevant event happens.</p> 614called whenever the relevant event happens.</p>
561<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
562the in the <code>Extension Objects</code> section.</p> 616the in the <code>Extension Objects</code> section.</p>
563<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
564hooks 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
565relevant action might not be carried out by the C++ code.</p> 619relevant action might not be carried out by the C++ code.</p>
566<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>
… …
578</li> 632</li>
579<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>
580 634
581<dd> 635<dd>
582<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
583trying to map (display) the toplevel and returning to the mainloop.</p> 637trying to map (display) the toplevel and returning to the main loop.</p>
584</dd> 638</dd>
585</li> 639</li>
586<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>
587 641
588<dd> 642<dd>
… …
629<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
630requested from the server. The selection text can be queried and changed 684requested from the server. The selection text can be queried and changed
631by 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>
632</dd> 686</dd>
633<dd> 687<dd>
634<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>
635</dd> 689</dd>
636</li> 690</li>
637<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>
638 692
639<dd> 693<dd>
640<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
641click) and is either supposed to return false (normal operation), or 695click) and is either supposed to return false (normal operation), or
642should 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
643processing. This can happen multiple times, as long as the callback 697processing. This can happen multiple times, as long as the callback
644returns 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
645supposed to enlarge the selection more and more, if possible.</p> 699supposed to enlarge the selection more and more, if possible.</p>
646</dd> 700</dd>
647<dd> 701<dd>
… …
649</dd> 703</dd>
650</li> 704</li>
651<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>
652 706
653<dd> 707<dd>
654<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
655scrolls. Offset <code>0</code> means display the normal terminal, positive values 709scrolls. Offset <code>0</code> means display the normal terminal, positive values
656show this many lines of scrollback.</p> 710show this many lines of scrollback.</p>
657</dd> 711</dd>
658</li> 712</li>
659<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>
… …
692it 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
693future.</p> 747future.</p>
694</dd> 748</dd>
695<dd> 749<dd>
696<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,
697as 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
698other users on the same system etc.).</p> 752other users on the same system etc.).</p>
699</dd> 753</dd>
700</li> 754</li>
701<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>
702 756
… …
749</dd> 803</dd>
750</li> 804</li>
751<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>
752 806
753<dd> 807<dd>
754<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
755a <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>
756resource in the <code>rxvt(1)</code> manpage).</p> 810resource in the <code>rxvt(1)</code> manpage).</p>
757</dd> 811</dd>
758<dd> 812<dd>
759<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
… …
761</dd> 815</dd>
762</li> 816</li>
763<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>
764 818
765<dd> 819<dd>
766<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
767windows 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
768returns TRUE, setting of the window hints is being skipped.</p> 822returns TRUE, setting of the window hints is being skipped.</p>
769</dd> 823</dd>
770</li> 824</li>
771<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>
… …
774<p>Called on every X event received on the vt window (and possibly other 828<p>Called on every X event received on the vt window (and possibly other
775windows). Should only be used as a last resort. Most event structure 829windows). Should only be used as a last resort. Most event structure
776members are not passed.</p> 830members are not passed.</p>
777</dd> 831</dd>
778</li> 832</li>
833<dt><strong><a name="item_on_root_event__24term_2c__24event">on_root_event $term, $event</a></strong>
834
835<dd>
836<p>Like <code>on_x_event</code>, but is called for events on the root window.</p>
837</dd>
838</li>
779<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong> 839<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong>
780 840
781<dd> 841<dd>
782<p>Called whenever the window gets the keyboard focus, before rxvt-unicode 842<p>Called whenever the window gets the keyboard focus, before rxvt-unicode
783does focus in processing.</p> 843does focus in processing.</p>
784</dd> 844</dd>
785</li> 845</li>
786<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>
787 847
788<dd> 848<dd>
789<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
790focus out processing.</p> 850focus out processing.</p>
791</dd> 851</dd>
792</li> 852</li>
793<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>
794 854
… …
868</dd> 928</dd>
869</li> 929</li>
870<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>
871 931
872<dd> 932<dd>
873<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
874created <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
875gets cleared before the codereferences that were in it are being executed, 935gets cleared before the code references that were in it are being executed,
876so 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>
877</dd>
878<dd> 937</dd>
938<dd>
879<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
880first.</p> 940first.</p>
881</dd> 941</dd>
882</li> 942</li>
883<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>
884 944
… …
918</li> 978</li>
919<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong> 979<dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong>
920 980
921<dd> 981<dd>
922<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
923wether they are started, being destroyed etc., so be careful. Only term 983whether they are started, being destroyed etc., so be careful. Only term
924objects that have perl extensions attached will be returned (because there 984objects that have perl extensions attached will be returned (because there
925is no urxvt::term objet associated with others).</p> 985is no urxvt::term objet associated with others).</p>
926</dd> 986</dd>
927</li> 987</li>
928<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong> 988<dt><strong><a name="item__time">$time = urxvt::NOW</a></strong>
… …
1077<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
1078optionally 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
1079<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>
1080</dd> 1140</dd>
1081<dd> 1141<dd>
1082<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
1083source 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>
1084</dd> 1144</dd>
1085<dd> 1145<dd>
1086<pre> 1146<pre>
1087 borderLess console cursorBlink cursorUnderline hold iconic insecure 1147 borderLess console cursorBlink cursorUnderline hold iconic insecure
… …
1112<dd> 1172<dd>
1113<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
1114terminal is destroyed, so changing options frequently will eat memory.</p> 1174terminal is destroyed, so changing options frequently will eat memory.</p>
1115</dd> 1175</dd>
1116<dd> 1176<dd>
1117<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
1118are 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>
1119to see the actual list:</p> 1179to see the actual list:</p>
1120</dd> 1180</dd>
1121<dd> 1181<dd>
1122<pre> 1182<pre>
… …
1469</dd> 1529</dd>
1470</li> 1530</li>
1471<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>
1472 1532
1473<dd> 1533<dd>
1474<p>Returns wether the cursor is currently hidden or not.</p> 1534<p>Returns whether the cursor is currently hidden or not.</p>
1475</dd> 1535</dd>
1476</li> 1536</li>
1477<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>
1478 1538
1479<dd> 1539<dd>
… …
1614</dd> 1674</dd>
1615</li> 1675</li>
1616<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>
1617 1677
1618<dd> 1678<dd>
1619<p>Converts rxvt-unicodes text reprsentation into a perl string. See 1679<p>Converts rxvt-unicodes text representation into a perl string. See
1620<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>
1621</dd> 1681</dd>
1622</li> 1682</li>
1623<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>
1624 1684
… …
1631</li> 1691</li>
1632<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>
1633 1693
1634<dd> 1694<dd>
1635<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1695<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.</p> 1696synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
1637</dd> 1697</dd>
1638</li> 1698</li>
1639<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>
1640 1700
1641<dd> 1701<dd>
… …
1839</dd> 1899</dd>
1840</li> 1900</li>
1841<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>
1842 1902
1843<dd> 1903<dd>
1844<p>Set the filedescriptor (not handle) to watch.</p> 1904<p>Set the file descriptor (not handle) to watch.</p>
1845</dd> 1905</dd>
1846</li> 1906</li>
1847<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>
1848 1908
1849<dd> 1909<dd>
… …
1859</dd> 1919</dd>
1860</li> 1920</li>
1861<dt><strong>$iow = $iow-&gt;stop</strong> 1921<dt><strong>$iow = $iow-&gt;stop</strong>
1862 1922
1863<dd> 1923<dd>
1864<p>Stop watching for events on the given filehandle.</p> 1924<p>Stop watching for events on the given file handle.</p>
1865</dd> 1925</dd>
1866</li> 1926</li>
1867</dl> 1927</dl>
1868<p> 1928<p>
1869</p> 1929</p>
… …
1926</dd> 1986</dd>
1927</li> 1987</li>
1928<dt><strong>$pw = $timer-&gt;start ($pid)</strong> 1988<dt><strong>$pw = $timer-&gt;start ($pid)</strong>
1929 1989
1930<dd> 1990<dd>
1931<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>
1932</dd> 1992</dd>
1933</li> 1993</li>
1934<dt><strong>$pw = $pw-&gt;stop</strong> 1994<dt><strong>$pw = $pw-&gt;stop</strong>
1935 1995
1936<dd> 1996<dd>
… …
1952 2012
1953<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>
1954 2014
1955<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>
1956 2016
1957<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>
1958 2018
1959</dl> 2019</dl>
1960<p> 2020<p>
1961</p> 2021</p>
1962<hr /> 2022<hr />

Diff Legend

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