--- rxvt-unicode/doc/rxvtperl.3.html 2006/01/10 18:09:22 1.20 +++ rxvt-unicode/doc/rxvtperl.3.html 2006/01/10 19:46:28 1.21 @@ -453,13 +453,34 @@

Variables in the urxvt Package

+
$urxvt::LIBDIR
+
+
+The rxvt-unicode library directory, where, among other things, the perl +modules and scripts are stored. +
+

+
$urxvt::RESCLASS, $urxvt::RESCLASS
+
+
+The resource class and name rxvt-unicode uses to look up X resources. +
+

+
$urxvt::RXVTNAME
+
+
+The basename of the installed binaries, usually urxvt. +
+

$urxvt::TERM
The current terminal. This variable stores the current urxvt::term object, whenever a callback/hook is executing.
-

+

+
+

Functions in the urxvt Package

@@ -557,16 +578,16 @@ Return the foreground/background colour index, respectively.

-
$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
+
$rend = urxvt::SET_FGCOLOR $rend, $new_colour
-
$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
+
$rend = urxvt::SET_BGCOLOR $rend, $new_colour
Replace the foreground/background colour in the rendition mask with the specified one.

-
$value = urxvt::GET_CUSTOM ($rend)
+
$value = urxvt::GET_CUSTOM $rend
Return the ``custom'' value: Every rendition has 5 bits for use by @@ -574,7 +595,7 @@ zero.

-
$rend = urxvt::SET_CUSTOM ($rend, $new_value)
+
$rend = urxvt::SET_CUSTOM $rend, $new_value
Change the custom value. @@ -585,9 +606,10 @@

The urxvt::anyevent Class

The sole purpose of this class is to deliver an interface to the AnyEvent module - any module using it will work inside urxvt without -further work. The only exception is that you cannot wait on condition -variables, but non-blocking condvar use is ok. What this means is that you -cannot use blocking APIs, but the non-blocking variant should work.

+further programming. The only exception is that you cannot wait on +condition variables, but non-blocking condvar use is ok. What this means +is that you cannot use blocking APIs, but the non-blocking variant should +work.

The urxvt::term Class

@@ -595,7 +617,9 @@
$term->destroy
-Destroy the terminal object (close the window, free resources etc.). +Destroy the terminal object (close the window, free resources +etc.). Please note that rxvt will not exit as long as any event +watchers (timers, io watchers) are still active.

$isset = $term->option ($optval[, $set])
@@ -1094,6 +1118,40 @@

The urxvt::popup Class

+
+
$popup->add_title ($title)
+
+
+Adds a non-clickable title to the popup. +
+

+
$popup->add_separator ([$sepchr])
+
+
+Creates a separator, optionally using the character given as $sepchr. +
+

+
$popup->add_button ($text, $cb)
+
+
+Adds a clickable button to the popup. $cb is called whenever it is +selected. +
+

+
$popup->add_toggle ($text, $cb, $initial_value)
+
+
+Adds a toggle/checkbox item to the popup. Teh callback gets called +whenever it gets toggled, with a boolean indicating its value as its first +argument. +
+

+
$popup->show
+
+
+Displays the popup (which is initially hidden). +
+

The urxvt::timer Class