--- rxvt-unicode/doc/rxvtperl.3.html 2006/01/10 04:26:54 1.19
+++ rxvt-unicode/doc/rxvtperl.3.html 2006/01/10 19:46:28 1.21
@@ -15,9 +15,10 @@
NAME
SYNOPSIS
DESCRIPTION
+ PREPACKAGED EXTENSIONS
+ API DOCUMENTATION
- - Prepackaged Extensions
- General API Considerations
- Extension Objects
- Hooks
@@ -74,8 +75,9 @@
scripts will be shared (but not enabled) for all terminals.
-
-This section describes the extensiosn delivered with this version. You can
+
+
+This section describes the extensions delivered with this release. You can
find them in /opt/rxvt/lib/urxvt/perl/.
You can activate them like this:
@@ -84,13 +86,13 @@
selection (enabled by default)
-Intelligent selection. This extension tries to be more intelligent when
-the user extends selections (double-click). Right now, it tries to select
-urls and complete shell-quoted arguments, which is very convenient, too,
-if your ls supports --quoting-style=shell
.
+(More) intelligent selection. This extension tries to be more intelligent
+when the user extends selections (double-click). Right now, it tries to
+select urls and complete shell-quoted arguments, which is very convenient,
+too, if your ls supports --quoting-style=shell
.
-It also offers the following bindable event:
+It also offers the following bindable keyboard command:
- rot13
@@ -114,7 +116,8 @@
-
Binds a popup menu to Ctrl-Button3 that lets you convert the selection
-text into various other formats/action.
+text into various other formats/action (such as uri unescaping, perl
+evalution, web-browser starting etc.), depending on content.
- searchable-scrollback<hotkey> (enabled by default)
@@ -161,6 +164,10 @@
+
+
+
+
All objects (such as terminals, time watchers etc.) are typical
reference-to-hash objects. The hash can be used to store anything you
@@ -446,13 +453,34 @@
+- $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.
-
+
+
+
@@ -550,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
@@ -567,7 +595,7 @@
zero.
-$rend = urxvt::SET_CUSTOM ($rend, $new_value)
+$rend = urxvt::SET_CUSTOM $rend, $new_value
Change the custom value.
@@ -578,9 +606,10 @@
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.
@@ -588,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])
@@ -1087,6 +1118,40 @@
+
+- $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).
+
+