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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC

     You can activate them like this:
       rxvt -pe <extensionname>
     selection
-        Miscellaneous selection modifications.
+        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:
         rot13
             Rot-13 the selection when activated. Used via keyboard trigger:
                URxvt.keysym.C-M-r: perl:selection:rot13
   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
+    "_hook") are reserved for internal uses and MUST NOT be accessed or
     modified).
     When objects are destroyed on the C++ side, the perl object hashes are
     emptied, so its best to store related objects such as time watchers and
     the like inside the terminal object so they get destroyed as soon as the
   Hooks
     The following subroutines can be declared in loaded scripts, and will be
     called whenever the relevant event happens.
+    The first argument passed to them is an object private to each terminal
+    and extension package. You can call all "urxvt::term" methods on it, but
+    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.
     All of them must return a boolean value. If it is true, then the 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.
         queried and changed by calling "$term->selection".
         Returning a true value aborts selection grabbing. It will still be
         hilighted.
+    on_sel_extend $term
+        Called whenever the user tries to extend the selection (e.g. with a
+        double click) and is either supposed to return false (normal
+        operation), or should extend the selection itelf and return true to
+        suppress the built-in processing.
+        See the selection example extension.
     on_focus_in $term
         Called whenever the window gets the keyboard focus, before urxvt
         does focus in processing.
     on_focus_out $term
         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
+        interoperability, the string should start with the extension name
+        and a colon, to distinguish it from commands for other extensions,
+        and this might be enforced in the future.
+        Be careful not ever to trust (in a security sense) the data you
+        receive, as its source can not easily be controleld (e-mail content,
+        messages from other users on the same system etc.).
     on_refresh_begin $term
         Called just before the screen gets redrawn. Can be used for overlay
         or similar effects by modify terminal contents in refresh_begin, and
         restoring them in refresh_end. The built-in overlay and selection
     on_keyboard_command $term, $string
         Called whenever the user presses a key combination that has a
         "perl:string" action bound to it (see description of the keysym
         resource in the rxvt(1) manpage).
+  Variables in the "urxvt" Package
+    $urxvt::TERM
+        The current terminal. Whenever a callback/Hook is bein executed,
+        this variable stores the current "urxvt::term" object.
   Functions in the "urxvt" Package
     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.
           answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
           borderLess color cursorBlink cursorUnderline cutchars delete_key
           display_name embed ext_bwidth fade font geometry hold iconName
           imFont imLocale inputMethod insecure int_bwidth intensityStyles
           italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
-          mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
+          mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
           perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
           reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
           scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
           scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
           shade term_name title transparent transparent_all tripleclickwords
           utmpInhibit visualBell
+    $rend = $term->screen_rstyle ([$new_rstyle])
+        Return and optionally change the current rendition. Text thta is
+        output by the temrianl application will use this style.
+    ($row, $col) = $term->screen_cur ([$row, $col])
+        Return the current coordinates of the text cursor position and
+        optionally set it (which is usually bad as applications don't expect
+        that).
     ($row, $col) = $term->selection_mark ([$row, $col])
     ($row, $col) = $term->selection_beg ([$row, $col])
     ($row, $col) = $term->selection_end ([$row, $col])
         Return the current values of the selection mark, begin or end
         positions, and optionally set them to new values.
         right/bottom side, respectively.
         This method returns an urxvt::overlay object. The overlay will be
         visible as long as the perl object is referenced.
-        Currently, the only method on the "urxvt::overlay" object is "set":
+        The methods currently supported on "urxvt::overlay" objects are:
-    $overlay->set ($x, $y, $text, $rend)
+        $overlay->set ($x, $y, $text, $rend)
-        Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts text in
+            Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
-        rxvt-unicode's special encoding and an array of rendition values at
+            text in rxvt-unicode's special encoding and an array of
-        a specific position inside the overlay.
+            rendition values at a specific position inside the overlay.
+        $overlay->hide
+            If visible, hide the overlay, but do not destroy it.
+        $overlay->show
+            If hidden, display the overlay again.
     $cellwidth = $term->strwidth $string
         Returns the number of screen-cells this string would need. Correctly
         accounts for wide and combining characters.
         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".
+    $window_width = $term->width
+    $window_height = $term->height
+    $font_width = $term->fwidth
+    $font_height = $term->fheight
+    $font_ascent = $term->fbase
-    $nrow = $term->nrow
+    $terminal_rows = $term->nrow
-    $ncol = $term->ncol
+    $terminal_columns = $term->ncol
-        Return the number of rows/columns of the terminal window (i.e. as
+    $has_focus = $term->focus
-        specified by "-geometry", excluding any scrollback).
-    $nsaved = $term->nsaved
+    $is_mapped = $term->mapped
-        Returns the number of lines in the scrollback buffer.
+    $max_scrollback = $term->saveLines
+    $nrow_plus_saveLines = $term->total_rows
+    $lines_in_scrollback = $term->nsaved
+        Return various integers describing terminal characteristics.
     $view_start = $term->view_start ([$newvalue])
         Returns the negative row number of the topmost line. Minimum value
         is 0, which displays the normal terminal contents. Larger values
         scroll this many lines into the scrollback buffer.
     $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
         Returns the text of the entire row with number $row_number. Row 0 is
         the topmost terminal line, row "$term->$ncol-1" is the bottommost
         terminal line. The scrollback buffer starts at line -1 and extends
-        to line "-$term->nsaved".
+        to line "-$term->nsaved". Nothing will be returned if a nonexistent
+        line is requested.
         If $new_text is specified, it will replace characters in the current
         line, starting at column $start_col (default 0), which is useful to
         replace only parts of a line. The font index in the rendition will
         automatically be updated.
         See the section on RENDITION, above.
     $length = $term->ROW_l ($row_number[, $new_length])
         Returns the number of screen cells that are in use ("the line
-        length"). If it is -1, then the line is part of a multiple-row
+        length"). Unlike the urxvt core, this returns "$term->ncol" if the
-        logical "line", which means all characters are in use and it is
+        line is joined with the following one.
-        continued on the next row.
+    $bool = $term->is_longer ($row_number)
+        Returns true if the row is part of a multiple-row logical "line"
+        (i.e. joined with the following row), which means all characters are
+        in use and it is continued on the next row (and possibly a
+        continuation of the previous row(s)).
+    $line = $term->line ($row_number)
+        Create and return a new "urxvt::line" object that stores information
+        about the logical line that row $row_number is part of. It supports
+        the following methods:
+        $text = $line->t
+            Returns the full text of the line, similar to "ROW_t"
+        $rend = $line->r
+            Returns the full rendition array of the line, similar to "ROW_r"
+        $length = $line->l
+            Returns the length of the line in cells, similar to "ROW_l".
+        $rownum = $line->beg
+        $rownum = $line->end
+            Return the row number of the first/last row of the line,
+            respectively.
+        $offset = $line->offset_of ($row, $col)
+            Returns the character offset of the given row|col pair within
+            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 =
-    $text = $term->special_encode $string
+    $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
 ENVIRONMENT
   URXVT_PERL_VERBOSITY
     This variable controls the verbosity level of the perl extension. Higher
     numbers indicate more verbose output.
-    0 - only fatal messages
+    =0 - only 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>
      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.6 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.6 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.11 by root, Wed Jan 4 21:37:55 2006 UTC