--- rxvt-unicode/doc/rxvtperl.3.txt 2006/01/10 18:09:22 1.18 +++ rxvt-unicode/doc/rxvtperl.3.txt 2006/01/10 19:46:28 1.19 @@ -286,10 +286,23 @@ subwindow. 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 $term = new urxvt [arg...] Creates a new terminal, very similar as if you had started it with @@ -352,29 +365,32 @@ $background = urxvt::GET_BASEBG $rend Return the foreground/background colour index, respectively. - $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) - $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) + $rend = urxvt::SET_FGCOLOR $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 extensions. They can be set and changed as you like and are initially zero. - $rend = urxvt::SET_CUSTOM ($rend, $new_value) + $rend = urxvt::SET_CUSTOM $rend, $new_value Change the custom value. 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 $term->destroy 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]) Returns true if the option specified by $optval is enabled, and @@ -693,6 +709,25 @@ case as the session. 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 This class implements timer watchers/events. Time is represented as a fractional number of seconds since the epoch. Example: