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.19 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.21 by root, Tue Jan 10 19:46:28 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
22 <li><a href="#extension_objects">Extension Objects</a></li> 23 <li><a href="#extension_objects">Extension Objects</a></li>
23 <li><a href="#hooks">Hooks</a></li> 24 <li><a href="#hooks">Hooks</a></li>
24 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
25 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 26 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
… …
72thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
73<p>Each script will only ever be loaded once, even in rxvtd, where 74<p>Each script will only ever be loaded once, even in rxvtd, where
74scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
75<p> 76<p>
76</p> 77</p>
77<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
78<p>This section describes the extensiosn delivered with this version. You can 80<p>This section describes the extensions delivered with this release. You can
79find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
80<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
81<pre> 83<pre>
82 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
83<dl> 85<dl>
84<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
85</dt> 87</dt>
86<dd> 88<dd>
87Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
88the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click). Right now, it tries to
89urls and complete shell-quoted arguments, which is very convenient, too, 91select urls and complete shell-quoted arguments, which is very convenient,
90if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>.
91</dd>
92<dd> 93</dd>
94<dd>
93<p>It also offers the following bindable event:</p> 95<p>It also offers the following bindable keyboard command:</p>
94</dd> 96</dd>
95<dl> 97<dl>
96<dt><strong><a name="item_rot13">rot13</a></strong><br /> 98<dt><strong><a name="item_rot13">rot13</a></strong><br />
97</dt> 99</dt>
98<dd> 100<dd>
… …
112<p></p> 114<p></p>
113<dt><strong>selection-popup (enabled by default)</strong><br /> 115<dt><strong>selection-popup (enabled by default)</strong><br />
114</dt> 116</dt>
115<dd> 117<dd>
116Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
117text into various other formats/action. 119text into various other formats/action (such as uri unescaping, perl
120evalution, web-browser starting etc.), depending on content.
118</dd> 121</dd>
119<p></p> 122<p></p>
120<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 123<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
121</dt> 124</dt>
122<dd> 125<dd>
… …
157Displays a very simple digital clock in the upper right corner of the 160Displays a very simple digital clock in the upper right corner of the
158window. Illustrates overwriting the refresh callbacks to create your own 161window. Illustrates overwriting the refresh callbacks to create your own
159overlays or changes. 162overlays or changes.
160</dd> 163</dd>
161<p></p></dl> 164<p></p></dl>
165<p>
166</p>
167<hr />
168<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
162<p> 169<p>
163</p> 170</p>
164<h2><a name="general_api_considerations">General API Considerations</a></h2> 171<h2><a name="general_api_considerations">General API Considerations</a></h2>
165<p>All objects (such as terminals, time watchers etc.) are typical 172<p>All objects (such as terminals, time watchers etc.) are typical
166reference-to-hash objects. The hash can be used to store anything you 173reference-to-hash objects. The hash can be used to store anything you
… …
444<p></p></dl> 451<p></p></dl>
445<p> 452<p>
446</p> 453</p>
447<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 454<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
448<dl> 455<dl>
456<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
457</dt>
458<dd>
459The rxvt-unicode library directory, where, among other things, the perl
460modules and scripts are stored.
461</dd>
462<p></p>
463<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
464</dt>
465<dd>
466The resource class and name rxvt-unicode uses to look up X resources.
467</dd>
468<p></p>
469<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
470</dt>
471<dd>
472The basename of the installed binaries, usually <code>urxvt</code>.
473</dd>
474<p></p>
449<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 475<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
450</dt> 476</dt>
451<dd> 477<dd>
452The current terminal. This variable stores the current <code>urxvt::term</code> 478The current terminal. This variable stores the current <code>urxvt::term</code>
453object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
454</dd> 480</dd>
455<p></p></dl> 481<p></p>
482<dt></dt>
483</dl>
456<p> 484<p>
457</p> 485</p>
458<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
459<dl> 487<dl>
460<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> 488<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
… …
548</dt> 576</dt>
549<dd> 577<dd>
550Return the foreground/background colour index, respectively. 578Return the foreground/background colour index, respectively.
551</dd> 579</dd>
552<p></p> 580<p></p>
553<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 581<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
554</dt> 582</dt>
555<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 583<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
556</dt> 584</dt>
557<dd> 585<dd>
558Replace the foreground/background colour in the rendition mask with the 586Replace the foreground/background colour in the rendition mask with the
559specified one. 587specified one.
560</dd> 588</dd>
561<p></p> 589<p></p>
562<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 590<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
563</dt> 591</dt>
564<dd> 592<dd>
565Return the ``custom'' value: Every rendition has 5 bits for use by 593Return the ``custom'' value: Every rendition has 5 bits for use by
566extensions. They can be set and changed as you like and are initially 594extensions. They can be set and changed as you like and are initially
567zero. 595zero.
568</dd> 596</dd>
569<p></p> 597<p></p>
570<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 598<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
571</dt> 599</dt>
572<dd> 600<dd>
573Change the custom value. 601Change the custom value.
574</dd> 602</dd>
575<p></p></dl> 603<p></p></dl>
576<p> 604<p>
577</p> 605</p>
578<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 606<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
579<p>The sole purpose of this class is to deliver an interface to the 607<p>The sole purpose of this class is to deliver an interface to the
580<code>AnyEvent</code> module - any module using it will work inside urxvt without 608<code>AnyEvent</code> module - any module using it will work inside urxvt without
581further work. The only exception is that you cannot wait on condition 609further programming. The only exception is that you cannot wait on
582variables, but non-blocking condvar use is ok. What this means is that you 610condition variables, but non-blocking condvar use is ok. What this means
583cannot use blocking APIs, but the non-blocking variant should work.</p> 611is that you cannot use blocking APIs, but the non-blocking variant should
612work.</p>
584<p> 613<p>
585</p> 614</p>
586<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 615<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
587<dl> 616<dl>
588<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
589</dt> 618</dt>
590<dd> 619<dd>
591Destroy the terminal object (close the window, free resources etc.). 620Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event
622watchers (timers, io watchers) are still active.
592</dd> 623</dd>
593<p></p> 624<p></p>
594<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 625<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
595</dt> 626</dt>
596<dd> 627<dd>
… …
1085</dd> 1116</dd>
1086<p></p></dl> 1117<p></p></dl>
1087<p> 1118<p>
1088</p> 1119</p>
1089<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1120<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1121<dl>
1122<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1123</dt>
1124<dd>
1125Adds a non-clickable title to the popup.
1126</dd>
1127<p></p>
1128<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1129</dt>
1130<dd>
1131Creates a separator, optionally using the character given as <code>$sepchr</code>.
1132</dd>
1133<p></p>
1134<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1135</dt>
1136<dd>
1137Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1138selected.
1139</dd>
1140<p></p>
1141<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1142</dt>
1143<dd>
1144Adds a toggle/checkbox item to the popup. Teh callback gets called
1145whenever it gets toggled, with a boolean indicating its value as its first
1146argument.
1147</dd>
1148<p></p>
1149<dt><strong>$popup-&gt;show</strong><br />
1150</dt>
1151<dd>
1152Displays the popup (which is initially hidden).
1153</dd>
1154<p></p></dl>
1090<p> 1155<p>
1091</p> 1156</p>
1092<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1157<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
1093<p>This class implements timer watchers/events. Time is represented as a 1158<p>This class implements timer watchers/events. Time is represented as a
1094fractional number of seconds since the epoch. Example:</p> 1159fractional number of seconds since the epoch. Example:</p>

Diff Legend

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