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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.52 by root, Sat Oct 27 12:09:03 2007 UTC vs.
Revision 1.53 by root, Mon Nov 19 12:02:36 2007 UTC

 NAME
-    urxvtperl - rxvt-unicode's embedded perl interpreter
+    rxvtperl - rxvt-unicode's embedded perl interpreter
 SYNOPSIS
        # create a file grab_test in $HOME:
        sub on_sel_grab {
           warn "you selected ", $_[0]->selection;
           ()
        }
-       # start a urxvt using it:
+       # start a rxvt using it:
-       urxvt --perl-lib $HOME -pe grab_test
+       rxvt --perl-lib $HOME -pe grab_test
 DESCRIPTION
     Every time a terminal object gets created, extension scripts specified
     via the "perl" resource are loaded and associated with it.
     Scripts are compiled in a 'use strict' and 'use utf8' environment, and
     thus must be encoded as UTF-8.
-    Each script will only ever be loaded once, even in urxvtd, where scripts
+    Each script will only ever be loaded once, even in rxvtd, where scripts
     will be shared (but not enabled) for all terminals.
     You can disable the embedded perl interpreter by setting both "perl-ext"
     and "perl-ext-common" resources to the empty string.
 PREPACKAGED EXTENSIONS
     This section describes the extensions delivered with this release. You
-    can find them in /usr/local/lib/urxvt/perl/.
+    can find them in /opt/rxvt/lib/urxvt/perl/.
     You can activate them like this:
-      urxvt -pe <extensionname>
+      rxvt -pe <extensionname>
     Or by adding them to the resource for extensions loaded by default:
-      URxvt.perl-ext-common: default,automove-background,selection-autotransform
+      URxvt.perl-ext-common: default,selection-autotransform
     selection (enabled by default)
         (More) intelligent selection. This extension tries to be more
         intelligent when the user extends selections (double-click and
         further clicks). Right now, it tries to select words, urls and
         Other extensions can extend this popup menu by pushing a code
         reference onto "@{ $term-"{option_popup_hook} }>, which gets called
         whenever the popup is being displayed.
-        It's sole argument is the popup menu, which can be modified. It
+        Its sole argument is the popup menu, which can be modified. It
         should either return nothing or a string, the initial boolean value
         and a code reference. The string will be used as button text and the
         code reference will be called when the toggle changes, with the new
         boolean value as first argument.
         Other extensions can extend this popup menu by pushing a code
         reference onto "@{ $term-"{selection_popup_hook} }>, which gets
         called whenever the popup is being displayed.
-        It's sole argument is the popup menu, which can be modified. The
+        Its sole argument is the popup menu, which can be modified. The
         selection is in $_, which can be used to decide whether to add
         something or not. It should either return nothing or a string and a
         code reference. The string will be used as button text and the code
         reference will be called when the button gets activated and should
         transform $_.
         The following will add an entry "a to b" that transforms all "a"s in
         the selection to "b"s, but only if the selection currently contains
         any "a"s:
            push @{ $self->{term}{selection_popup_hook} }, sub {
-              /a/ ? ("a to be" => sub { s/a/b/g }
+              /a/ ? ("a to b" => sub { s/a/b/g }
                   : ()
            };
     searchable-scrollback<hotkey> (enabled by default)
         Adds regex search functionality to the scrollback buffer, triggered
            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 urxvt(1) manpage for valid indices.
+        See *COLOR AND GRAPHICS* in the rxvt(1) manpage for valid indices.
     matcher
         Uses per-line display filtering ("on_line_update") to underline text
         matching a certain pattern and make it clickable. When clicked with
         the mouse button specified in the "matcher.button" resource (default
     xim-onthespot
         This (experimental) perl extension implements OnTheSpot editing. It
         does not work perfectly, and some input methods don't seem to work
         well with OnTheSpot editing in general, but it seems to work at
-        leats for SCIM and kinput2.
+        least for SCIM and kinput2.
         You enable it by specifying this extension and a preedit style of
         "OnTheSpot", i.e.:
-           urxvt -pt OnTheSpot -pe xim-onthespot
+           rxvt -pt OnTheSpot -pe xim-onthespot
     kuake<hotkey>
         A very primitive quake-console-like extension. It was inspired by a
         description of how the programs "kuake" and "yakuake" work: Whenever
         the user presses a global accelerator key (by default "F10"), the
         terminal will show or hide itself. Another press of the accelerator
         key will hide or show it again.
         Initially, the window will not be shown when using this extension.
-        This is useful if you need a single terminal thats not using any
+        This is useful if you need a single terminal that is not using any
         desktop space most of the time but is quickly available at the press
         of a key.
         The accelerator key is grabbed regardless of any modifiers, so this
         extension will actually grab a physical key just for this function.
         If you want a quake-like animation, tell your window manager to do
         so (fvwm can do it).
-    automove-background
-        This is basically a very small extension that dynamically changes
-        the background pixmap offset to the window position, in effect
-        creating the same effect as pseudo transparency with a custom
-        pixmap. No scaling is supported in this mode. Example:
-           urxvt -pixmap background.xpm -pe automove-background
-        <http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extens
-        ions> shows how this extension can be used to implement an
-        automatically blurred transparent background.
     block-graphics-to-ascii
         A not very useful example of filtering all text output to the
         terminal by replacing all line-drawing characters (U+2500 .. U+259F)
         by a similar-looking ascii character.
     digital-clock
         Displays a digital clock using the built-in overlay.
     remote-clipboard
         Somewhat of a misnomer, this extension adds two menu entries to the
-        selection popup that allows one ti run external commands to store
+        selection popup that allows one to run external commands to store
         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.
         Called just after the screen gets redrawn. See "on_refresh_begin".
     on_user_command $term, $string
         Called whenever a user-configured event is being activated (e.g. via
         a "perl:string" action bound to a key, see description of the keysym
-        resource in the urxvt(1) manpage).
+        resource in the rxvt(1) manpage).
         The event is simply the action string. This interface is assumed to
         change slightly in the future.
     on_resize_all_windows $tern, $new_width, $new_height
         "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 urxvt will not exit as long as any event watchers
+        Please note that rxvt will not exit as long as any event watchers
         (timers, io watchers) are still active.
     $term->exec_async ($cmd[, @args])
         Works like the combination of the "fork"/"exec" builtins, which
         executes ("starts") programs in the background. This function takes
         there is only one resource database per display, and later
         invocations might return the wrong resources.
     $success = $term->parse_keysym ($keysym_spec, $command_string)
         Adds a keymap translation exactly as specified via a resource. See
-        the "keysym" resource in the urxvt(1) manpage.
+        the "keysym" resource in the rxvt(1) manpage.
     $rend = $term->rstyle ([$new_rstyle])
         Return and optionally change the current rendition. Text that is
         output by the terminal application will use this style.
                         ->new
                         ->interval (1)
                         ->cb (sub {
                            $term->{overlay}->set (0, 0,
                               sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
                         });
     $timer = new urxvt::timer
         Create a new timer object in started state. It is scheduled to fire
         immediately.
       $term->{socket} = ...
       $term->{iow} = urxvt::iow
                      ->new
                      ->fd (fileno $term->{socket})
-                     ->events (urxvt::EVENT_READ)
+                     ->events (urxvt::EV_READ)
                      ->start
                      ->cb (sub {
                        my ($iow, $revents) = @_;
                        # $revents must be 1 here, no need to check
                        sysread $term->{socket}, my $buf, 8192
     $iow = $iow->fd ($fd)
         Set the file descriptor (not handle) to watch.
     $iow = $iow->events ($eventmask)
         Set the event mask to watch. The only allowed values are
-        "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
+        "urxvt::EV_READ" and "urxvt::EV_WRITE", which might be ORed
-        together, or "urxvt::EVENT_NONE".
+        together, or "urxvt::EV_NONE".
     $iow = $iow->start
         Start watching for requested events on the given handle.
     $iow = $iow->stop
                         ->new
                         ->start ($pid)
                         ->cb (sub {
                            my ($pw, $exit_status) = @_;
                            ...
                         });
     $pw = new urxvt::pw
         Create a new process watcher in stopped state.
     $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.52 by root, Sat Oct 27 12:09:03 2007 UTC vs. Revision 1.53 by root, Mon Nov 19 12:02:36 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.52 by root, Sat Oct 27 12:09:03 2007 UTC vs.
Revision 1.53 by root, Mon Nov 19 12:02:36 2007 UTC