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.20 by root, Tue Jan 10 18:09:22 2006 UTC vs.
Revision 1.21 by root, Tue Jan 10 19:46:28 2006 UTC

… …
451<p></p></dl> 451<p></p></dl>
452<p> 452<p>
453</p> 453</p>
454<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>
455<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>
456<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 />
457</dt> 476</dt>
458<dd> 477<dd>
459The current terminal. This variable stores the current <code>urxvt::term</code> 478The current terminal. This variable stores the current <code>urxvt::term</code>
460object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
461</dd> 480</dd>
462<p></p></dl> 481<p></p>
482<dt></dt>
483</dl>
463<p> 484<p>
464</p> 485</p>
465<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>
466<dl> 487<dl>
467<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 />
… …
555</dt> 576</dt>
556<dd> 577<dd>
557Return the foreground/background colour index, respectively. 578Return the foreground/background colour index, respectively.
558</dd> 579</dd>
559<p></p> 580<p></p>
560<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 />
561</dt> 582</dt>
562<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 />
563</dt> 584</dt>
564<dd> 585<dd>
565Replace the foreground/background colour in the rendition mask with the 586Replace the foreground/background colour in the rendition mask with the
566specified one. 587specified one.
567</dd> 588</dd>
568<p></p> 589<p></p>
569<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 />
570</dt> 591</dt>
571<dd> 592<dd>
572Return the ``custom'' value: Every rendition has 5 bits for use by 593Return the ``custom'' value: Every rendition has 5 bits for use by
573extensions. 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
574zero. 595zero.
575</dd> 596</dd>
576<p></p> 597<p></p>
577<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 />
578</dt> 599</dt>
579<dd> 600<dd>
580Change the custom value. 601Change the custom value.
581</dd> 602</dd>
582<p></p></dl> 603<p></p></dl>
583<p> 604<p>
584</p> 605</p>
585<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>
586<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
587<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
588further work. The only exception is that you cannot wait on condition 609further programming. The only exception is that you cannot wait on
589variables, 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
590cannot 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>
591<p> 613<p>
592</p> 614</p>
593<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>
594<dl> 616<dl>
595<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 />
596</dt> 618</dt>
597<dd> 619<dd>
598Destroy 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.
599</dd> 623</dd>
600<p></p> 624<p></p>
601<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 />
602</dt> 626</dt>
603<dd> 627<dd>
… …
1092</dd> 1116</dd>
1093<p></p></dl> 1117<p></p></dl>
1094<p> 1118<p>
1095</p> 1119</p>
1096<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>
1097<p> 1155<p>
1098</p> 1156</p>
1099<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>
1100<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
1101fractional 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