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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC

     thus must be encoded as UTF-8.
     Each script will only ever be loaded once, even in rxvtd, where scripts
     will be shared (but not enabled) for all terminals.
-  Prepackaged Extensions
+PREPACKAGED EXTENSIONS
-    This section describes the extensiosn delivered with this version. You
+    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:
       rxvt -pe <extensionname>
-    selection
+    selection (enabled by default)
-        Intelligent selection. This extension tries to be more intelligent
+        (More) intelligent selection. This extension tries to be more
-        when the user extends selections (double-click). Right now, it tries
+        intelligent when the user extends selections (double-click). Right
-        to select urls and complete shell-quoted arguments, which is very
+        now, it tries to select urls and complete shell-quoted arguments,
-        convenient, too, if your ls supports "--quoting-style=shell".
+        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
             Rot-13 the selection when activated. Used via keyboard trigger:
                URxvt.keysym.C-M-r: perl:selection:rot13
+    option-popup (enabled by default)
+        Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
+        options at runtime.
+    selection-popup (enabled by default)
+        Binds a popup menu to Ctrl-Button3 that lets you convert the
+        selection 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)
+        Adds regex search functionality to the scrollback buffer, triggered
+        by a hotkey (default: "M-s"). When in search mode, normal terminal
+        input/output is suspended.
+        "/" starts an incremental regex search, "n" searches further, "p" or
+        "N" jump to the previous match, "G" jumps to the bottom and clears
+        the history, "enter" leaves search mode at the current position and
+        "escape" returns to the original position.
     digital-clock
         Displays a digital clock using the built-in overlay.
     mark-urls
-        Uses per-line display filtering ("on_line_update") to underline
+        Uses per-line display filtering ("on_line_update") to underline urls
-        urls.
+        and make them clickable. When clicked, the program specified in the
+        resource "urlLauncher" (default "x-www-browser") will be started.
     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.
     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
     like. All members starting with an underscore (such as "_ptr" or
     "_hook") are reserved for internal uses and MUST NOT be accessed or
     Argument names also often indicate the type of a parameter. Here are
     some hints on what they mean:
     $text
         Rxvt-unicodes special way of encoding text, where one "unicode"
-        character always represents one screen cell. See row_t for a
+        character always represents one screen cell. See ROW_t for a
         discussion of this format.
     $string
         A perl text string, with an emphasis on *text*. It can store all
         unicode characters and is to be distinguished with text encoded in a
     $octets
         Either binary data or - more common - a text string encoded in a
         locale-specific way.
+  Extension Objects
+    Very perl extension is a perl class. A separate perl object is created
+    for each terminal and each extension and passed as the first parameter
+    to hooks. So extensions can use their $self object without having to
+    think about other extensions, with the exception of methods and members
+    that begin with an underscore character "_": these are reserved for
+    internal use.
+    Although it isn't a "urxvt::term" object, you can call all methods of
+    the "urxvt::term" class on this object.
+    It has the following methods and data members:
+    $urxvt_term = $self->{term}
+        Returns the "urxvt::term" object associated with this instance of
+        the extension. This member *must not* be changed in any way.
+    $self->enable ($hook_name => $cb, [$hook_name => $cb..])
+        Dynamically enable the given hooks (named without the "on_" prefix)
+        for this extension, replacing any previous hook. This is useful when
+        you want to overwrite time-critical hooks only temporarily.
+    $self->disable ($hook_name[, $hook_name..])
+        Dynamically disable the given hooks.
   Hooks
     The following subroutines can be declared in extension files, and will
     be called whenever the relevant event happens.
-    The first argument passed to them is an object private to each terminal
+    The first argument passed to them is an extension oject as described in
-    and extension package. You can call all "urxvt::term" methods on it, but
+    the in the "Extension Objects" section.
-    its not a real "urxvt::term" object. Instead, the real "urxvt::term"
-    object that is shared between all packages is stored in the "term"
-    member. It is, however, blessed intot he package of the extension
-    script, so for all practical purposes you can treat an extension script
-    as a class.
-    All of them must return a boolean value. If it is true, then the event
+    All of these hooks must return a boolean value. If it is true, then the
-    counts as being *consumed*, and the invocation of other hooks is
+    event counts as being *consumed*, and the invocation of other hooks is
     skipped, and the relevant action might not be carried out by the C++
     code.
-    When in doubt, return a false value (preferably "()").
+    *When in doubt, return a false value (preferably "()").*
     on_init $term
         Called after a new terminal object has been initialized, but before
         windows are created or the command gets run. Most methods are unsafe
         to call or deliver senseless data, as terminal size and other
         may be larger than the scroll back buffer or the terminal.
         It is called before lines are scrolled out (so rows 0 .. min ($lines
         - 1, $nrow - 1) represent the lines to be scrolled out). $saved is
         the total number of lines that will be in the scrollback buffer.
-    on_tty_activity $term *NYI*
-        Called whenever the program(s) running in the urxvt window send
-        output.
     on_osc_seq $term, $string
         Called whenever the ESC ] 777 ; string ST command sequence (OSC =
         operating system command) is processed. Cursor position and other
         state information is up-to-date when this happens. For
         argument. You can filter/change and output the text yourself by
         returning a true value and calling "$term->scr_add_lines" yourself.
         Please note that this might be very slow, however, as your hook is
         called for all text being output.
+    on_tt_write $term, $octets
+        Called whenever some data is written to the tty/pty and can be used
+        to suppress or filter tty input.
     on_line_update $term, $row
         Called whenever a line was updated or changed. Can be used to filter
         screen output (e.g. underline urls or other useless stuff). Only
         lines that are being shown will be filtered, and, due to performance
         reasons, not always immediately.
     on_focus_out $term
         Called wheneever the window loses keyboard focus, before
         rxvt-unicode does focus out processing.
-    on_key_press $term, $event, $octets
+    on_key_press $term, $event, $keysym, $octets
-    on_key_release $term, $event
+    on_key_release $term, $event, $keysym
     on_button_press $term, $event
     on_button_release $term, $event
     on_motion_notify $term, $event
     on_map_notify $term, $event
     on_unmap_notify $term, $event
         output, if any, in locale-specific encoding.
         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
-        "system $binfile, arg...". 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 the
-        call.
     urxvt::fatal $errormessage
         Fatally aborts execution with the given error message. Avoid at all
         costs! The only time this is acceptable is when the terminal process
         starts up.
         function that calls this function.
         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.
+    $is_safe = urxvt::safe
+        Returns true when it is safe to do potentially unsafe things, such
+        as evaluating perl code specified by the user. This is true when
+        urxvt was started setuid or setgid.
     $time = urxvt::NOW
         Returns the "current time" (as per the event loop).
     urxvt::CurrentTime
     urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
     Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
     Button5Mask, AnyModifier
-        Various constants for use in X events.
+        Various constants for use in X calls and event processing.
   RENDITION
     Rendition bitsets contain information about colour, font, font styles
     and similar information for each screen cell.
     $foreground = urxvt::GET_BASEFG $rend
     $background = urxvt::GET_BASEBG $rend
         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
         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 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 = new urxvt::term $envhashref, $rxvtname, [arg...]
+        Creates a new terminal, very similar as if you had started it with
+        system "$rxvtname, arg...". $envhashref must be a reference to a
+        %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.
     $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
         optionally change it. All option values are stored by name in the
         hash %urxvt::OPTION. Options not enabled in this binary are not in
           scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
           scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
           shade term_name title transparent transparent_all tripleclickwords
           utmpInhibit visualBell
+    $value = $term->x_resource ($pattern)
+        Returns the X-Resource for the given pattern, excluding the program
+        or class name, i.e. "$term->x_resource ("boldFont")" should return
+        the same value as used by this instance of rxvt-unicode. Returns
+        "undef" if no resource with that pattern exists.
+        This method should only be called during the "on_start" hook, as
+        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 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.
     ($row, $col) = $term->screen_cur ([$row, $col])
     $oldtext = $term->selection ([$newtext])
         Return the current selection text and optionally replace it by
         $newtext.
-        #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line
+    $term->overlay_simple ($x, $y, $text)
-        overlay box. See the next method for details. # #=cut # #sub
+        Create a simple multi-line overlay box. See the next method for
-        urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my
+        details.
-        @lines = split /\n/, $text; # # my $w = 0; # for (map
-        $self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # #
-        $self->scr_overlay_new ($x, $y, $w, scalar @lines); #
-        $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #}
     $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
         Create a new (empty) overlay at the given position with the given
         width/height. $rstyle defines the initial rendition style (default:
         "OVERLAY_RSTYLE").
         Convert the given text string into the corresponding locale
         encoding.
     $string = $term->locale_decode ($octets)
         Convert the given locale-encoded octets into a perl string.
+    $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
+        XORs the rendition values in the given span with the provided value
+        (default: "RS_RVid"). Useful in refresh hooks to provide effects
+        similar to the selection.
+    $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
+    $rstyle2]])
+        Similar to "scr_xor_span", but xors a rectangle instead. Trailing
+        whitespace will additionally be xored with the $rstyle2, which
+        defaults to "RS_RVid | RS_Uline", which removes reverse video again
+        and underlines it instead.
+    $term->scr_bell
+        Ring the bell!
     $term->scr_add_lines ($string)
         Write the given text string to the screen, as if output by the
         application running inside the terminal. It may not contain command
         sequences (escape codes), but is free to use line feeds, carriage
     $term->tt_write ($octets)
         Write the octets given in $data to the tty (i.e. as program input).
         To pass characters instead of octets, you should convert your
         strings first to the locale-specific encoding using
         "$term->locale_encode".
+    $old_events = $term->pty_ev_events ([$new_events])
+        Replaces the event mask of the pty watcher by the given event mask.
+        Can be used to suppress input and output handling to the pty/tty.
+        See the description of "urxvt::timer->events". Make sure to always
+        restore the previous value.
     $windowid = $term->parent
         Return the window id of the toplevel window.
     $windowid = $term->vt
     $max_scrollback = $term->saveLines
     $nrow_plus_saveLines = $term->total_rows
     $lines_in_scrollback = $term->nsaved
         Return various integers describing terminal characteristics.
+    $x_display = $term->display_id
+        Return the DISPLAY used by rxvt-unicode.
+    $lc_ctype = $term->locale
+        Returns the LC_CTYPE category string used by this rxvt-unicode.
+    $env = $term->env
+        Returns a copy of the environment in effect for the terminal as a
+        hashref similar to "\%ENV".
     $modifiermask = $term->ModLevel3Mask
     $modifiermask = $term->ModMetaMask
     $modifiermask = $term->ModNumLockMask
         Return the modifier masks corresponding to the "ISO Level 3 Shift"
         (often AltGr), the meta key (often Alt) and the num lock key, if
             the logical line.
         ($row, $col) = $line->coord_of ($offset)
             Translates a string offset into terminal coordinates again.
-    ($row, $col) = $line->coord_of ($offset) =item $text =
-    $term->special_encode $string
+    $text = $term->special_encode $string
         Converts a perl string into the special encoding used by
         rxvt-unicode, where one character corresponds to one screen cell.
         See "$term->ROW_t" for details.
     $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)
+        Registers 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.
+    $term->allow_events_async
+        Calls XAllowEvents with AsyncBoth for the most recent grab.
+    $term->allow_events_sync
+        Calls XAllowEvents with SyncBoth for the most recent grab.
+    $term->allow_events_replay
+        Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
+        the most recent grab.
+    $term->ungrab
+        Calls XUngrab for the most recent grab. Is called automatically on
+        evaluation errors, as it is better to lose the grab in the error
+        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
+    This class implements timer watchers/events. Time is represented as a
-        a fractional number of seconds since the epoch. Example:
+    fractional number of seconds since the epoch. Example:
-           $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
+       $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
-           $term->{timer} = urxvt::timer
+       $term->{timer} = urxvt::timer
-                            ->new
+                        ->new
-                            ->interval (1)
+                        ->interval (1)
-                            ->cb (sub {
+                        ->cb (sub {
-                               $term->{overlay}->set (0, 0,
+                           $term->{overlay}->set (0, 0,
-                                  sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
+                              sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
-                            });
+                        });
-        $timer = new urxvt::timer
+    $timer = new urxvt::timer
-            Create a new timer object in started state. It is scheduled to
+        Create a new timer object in started state. It is scheduled to fire
-            fire immediately.
+        immediately.
-        $timer = $timer->cb (sub { my ($timer) = @_; ... })
+    $timer = $timer->cb (sub { my ($timer) = @_; ... })
-            Set the callback to be called when the timer triggers.
+        Set the callback to be called when the timer triggers.
-        $tstamp = $timer->at
+    $tstamp = $timer->at
-            Return the time this watcher will fire next.
+        Return the time this watcher will fire next.
-        $timer = $timer->set ($tstamp)
+    $timer = $timer->set ($tstamp)
-            Set the time the event is generated to $tstamp.
+        Set the time the event is generated to $tstamp.
-        $timer = $timer->interval ($interval)
+    $timer = $timer->interval ($interval)
-            Normally (and when $interval is 0), the timer will automatically
+        Normally (and when $interval is 0), the timer will automatically
-            stop after it has fired once. If $interval is non-zero, then the
+        stop after it has fired once. If $interval is non-zero, then the
-            timer is automatically rescheduled at the given intervals.
+        timer is automatically rescheduled at the given intervals.
-        $timer = $timer->start
+    $timer = $timer->start
-            Start the timer.
+        Start the timer.
-        $timer = $timer->start ($tstamp)
+    $timer = $timer->start ($tstamp)
-            Set the event trigger time to $tstamp and start the timer.
+        Set the event trigger time to $tstamp and start the timer.
-        $timer = $timer->stop
+    $timer = $timer->stop
-            Stop the timer.
+        Stop the timer.
   The "urxvt::iow" Class
-        This class implements io watchers/events. Example:
+    This class implements io watchers/events. Example:
-          $term->{socket} = ...
+      $term->{socket} = ...
-          $term->{iow} = urxvt::iow
+      $term->{iow} = urxvt::iow
-                         ->new
+                     ->new
-                         ->fd (fileno $term->{socket})
+                     ->fd (fileno $term->{socket})
-                         ->events (1) # wait for read data
+                     ->events (urxvt::EVENT_READ)
-                         ->start
+                     ->start
-                         ->cb (sub {
+                     ->cb (sub {
-                           my ($iow, $revents) = @_;
+                       my ($iow, $revents) = @_;
-                           # $revents must be 1 here, no need to check
+                       # $revents must be 1 here, no need to check
-                           sysread $term->{socket}, my $buf, 8192
+                       sysread $term->{socket}, my $buf, 8192
-                              or end-of-file;
+                          or end-of-file;
-                         });
+                     });
-        $iow = new urxvt::iow
+    $iow = new urxvt::iow
-            Create a new io watcher object in stopped state.
+        Create a new io watcher object in stopped state.
-        $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
+    $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
-            Set the callback to be called when io events are triggered.
+        Set the callback to be called when io events are triggered.
-            $reventmask is a bitset as described in the "events" method.
+        $reventmask is a bitset as described in the "events" method.
-        $iow = $iow->fd ($fd)
+    $iow = $iow->fd ($fd)
-            Set the filedescriptor (not handle) to watch.
+        Set the filedescriptor (not handle) to watch.
-        $iow = $iow->events ($eventmask)
+    $iow = $iow->events ($eventmask)
-            Set the event mask to watch. Bit #0 (value 1) enables watching
+        Set the event mask to watch. The only allowed values are
-            for read data, Bit #1 (value 2) enables watching for write data.
+        "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed
+        together, or "urxvt::EVENT_NONE".
-        $iow = $iow->start
+    $iow = $iow->start
-            Start watching for requested events on the given handle.
+        Start watching for requested events on the given handle.
-        $iow = $iow->stop
+    $iow = $iow->stop
-            Stop watching for events on the given filehandle.
+        Stop watching for events on the given filehandle.
 ENVIRONMENT
   URXVT_PERL_VERBOSITY
-        This variable controls the verbosity level of the perl extension.
+    This variable controls the verbosity level of the perl extension. Higher
-        Higher numbers indicate more verbose output.
+    numbers indicate more verbose output.
-        =0 - only fatal messages
+    == 0 - fatal messages
-        =3 - script loading and management
+    >= 3 - script loading and management
-        =10 - all events received
+    >=10 - all events received
 AUTHOR
-         Marc Lehmann <pcg@goof.com>
+     Marc Lehmann <pcg@goof.com>
-         http://software.schmorp.de/pkg/rxvt-unicode
+     http://software.schmorp.de/pkg/rxvt-unicode

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC vs. Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.22 by root, Wed Jan 11 02:13:56 2006 UTC