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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.17 by root, Tue Jan 10 04:26:54 2006 UTC

         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.
+    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
     $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
         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
         newline. The module also overwrites the "warn" builtin with a
         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.
+    $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
           scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
           scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
           shade term_name title transparent transparent_all tripleclickwords
           utmpInhibit visualBell
+    $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.
+    $lc_ctype = $term->locale
+        Returns the LC_CTYPE category string used by this rxvt-unicode.
+    $x_display = $term->display_id
+        Return the DISPLAY used by rxvt-unicode.
     $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
     $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 XGrabButton.
+        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->{socket} = ...
           $term->{iow} = urxvt::iow
                          ->new
                          ->fd (fileno $term->{socket})
-                         ->events (1) # wait for read data
+                         ->events (urxvt::EVENT_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 filedescriptor (not handle) to watch.
         $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
             Start watching for requested events on the given handle.
         $iow = $iow->stop

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.17 by root, Tue Jan 10 04:26:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.15 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.17 by root, Tue Jan 10 04:26:54 2006 UTC