[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvtperl.3.txt

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC

         Clicking a button will activate that tab. Pressing Shift-Left and
         Shift-Right will switch to the tab left or right of the current one,
         while Shift-Down creates a new tab.
+        The tabbar itself can be configured similarly to a normal terminal,
+        but with a resource class of "URxvt.tabbed". In addition, it
+        supports the following four resources (shown with defaults):
+           URxvt.tabbed.tabbar-fg: <colour-index, default 3>
+           URxvt.tabbed.tabbar-bg: <colour-index, default 0>
+           URxvt.tabbed.tab-fg:    <colour-index, default 0>
+           URxvt.tabbed.tab-bg:    <colour-index, default 1>
+        See *COLOR AND GRAPHICS* in the rxvt(1) manpage for valid indices.
     mark-urls
         Uses per-line display filtering ("on_line_update") to underline urls
         and make them clickable. When middle-clicked, the program specified
         in the resource "urlLauncher" (default "x-www-browser") will be
         started with the URL as first argument.
         U+259F) by a similar-looking ascii character.
     digital-clock
         Displays a digital clock using the built-in overlay.
-    example-refresh-hooks
+    remote-clipboard
-        Displays a very simple digital clock in the upper right corner of
+        Somewhat of a misnomer, this extension adds two menu entries to the
-        the window. Illustrates overwriting the refresh callbacks to create
+        selection popup that allows one ti run external commands to store
-        your own overlays or changes.
+        the selection somewhere and fetch it again.
+        We use it to implement a "distributed selection mechanism", which
+        just means that one command uploads the file to a remote server, and
+        another reads it.
+        The commands can be set using the "URxvt.remote-selection.store" and
+        "URxvt.remote-selection.fetch" resources. The first should read the
+        selection to store from STDIN (always in UTF-8), the second should
+        provide the selection data on STDOUT (also in UTF-8).
+        The defaults (which are likely useless to you) use rsh and cat:
+           URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
+           URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
     selection-pastebin
         This is a little rarely useful extension that Uploads the selection
         as textfile to a remote site (or does other things). (The
         implementation is not currently secure for use in a multiuser
         After a successful upload the selection will be replaced by the text
         given in the "selection-pastebin-url" resource (again, the % is the
         placeholder for the filename):
            URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
+    example-refresh-hooks
+        Displays a very simple digital clock in the upper right corner of
+        the window. Illustrates overwriting the refresh callbacks to create
+        your own overlays or changes.
 API DOCUMENTATION
   General API Considerations
     All objects (such as terminals, time watchers etc.) are typical
     reference-to-hash objects. The hash can be used to store anything you
         display code is run after this hook, and takes precedence.
     on_refresh_end $term
         Called just after the screen gets redrawn. See "on_refresh_begin".
-    on_keyboard_command $term, $string
+    on_user_command $term, $string
-        Called whenever the user presses a key combination that has a
+        Called whenever the a user-configured event is being activated (e.g.
-        "perl:string" action bound to it (see description of the keysym
+        via a "perl:string" action bound to a key, see description of the
-        resource in the rxvt(1) manpage).
+        keysym resource in the rxvt(1) manpage).
+        The event is simply the action string. This interface is assumed to
+        change slightly in the future.
     on_x_event $term, $event
         Called on every X event received on the vt window (and possibly
         other windows). Should only be used as a last resort. Most event
         structure members are not passed.
         Using this function has the advantage that its output ends up in the
         correct place, e.g. on stderr of the connecting urxvtc client.
         Messages have a size limit of 1023 bytes currently.
+    @terms = urxvt::termlist
+        Returns all urxvt::term objects that exist in this process,
+        regardless of wether they are started, being destroyed etc., so be
+        careful. Only term objects that have perl extensions attached will
+        be returned (because there is no urxvt::term objet associated with
+        others).
     $time = urxvt::NOW
         Returns the "current time" (as per the event loop).
     urxvt::CurrentTime
     $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_COLOR $rend, $new_fg, $new_bg
         Replace the foreground/background colour in the rendition mask with
         the specified one.
     $value = urxvt::GET_CUSTOM $rend
         Return the "custom" value: Every rendition has 5 bits for use by
         %ENV-like hash which defines the environment of the new terminal.
         Croaks (and probably outputs an error message) if the new instance
         couldn't be created. Returns "undef" if the new instance didn't
         initialise perl, and the terminal object otherwise. The "init" and
-        "start" hooks will be called during this call.
+        "start" hooks will be called before this call returns, and are free
+        to refer to global data (which is race free).
     $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.
         Adds the specified events to the vt event mask. Useful e.g. when you
         want to receive pointer events all the times:
            $term->vt_emask_add (urxvt::PointerMotionMask);
+    $term->focus_in
+    $term->focus_out
+    $term->key_press ($state, $keycode[, $time])
+    $term->key_release ($state, $keycode[, $time])
+        Deliver various fake events to to terminal.
     $window_width = $term->width
     $window_height = $term->height
     $font_width = $term->fwidth
     $font_height = $term->fheight
     $font_ascent = $term->fbase
     $string = $term->special_decode $text
         Converts rxvt-unicodes text reprsentation into a perl string. See
         "$term->ROW_t" for details.
-    $success = $term->grab_button ($button, $modifiermask)
+    $success = $term->grab_button ($button, $modifiermask[, $window =
+    $term->vt])
+    $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
-        Registers a synchronous button grab. See the XGrabButton manpage.
+        Register/unregister a synchronous button grab. See the XGrabButton
+        manpage.
     $success = $term->grab ($eventtime[, $sync])
         Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
         synchronous ($sync is true). Also remembers the grab timestampe.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC vs. Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.36 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.39 by root, Mon Feb 6 05:55:33 2006 UTC