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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.25 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC

            URxvt.selection.pattern-0: \\|([^|]+)\\|
         You can look at the source of the selection extension to see more
         interesting uses, such as parsing a line from beginning to end.
-        This extension also offers the following bindable keyboard command:
+        This extension also offers following bindable keyboard commands:
         rot13
             Rot-13 the selection when activated. Used via keyboard trigger:
                URxvt.keysym.C-M-r: perl:selection:rot13
     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.
+        Other extensions can extend this popup menu by pushing a code
+        reference onto "@{ $term-"{selection_popup_hook} }>, that is called
+        whenever the popup is displayed.
+        It's sole argument is the popup menu, which can be modified. The
+        selection is in $_, which can be used to decide wether 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 }
+                  : ()
+           };
     searchable-scrollback<hotkey> (enabled by default)
         Adds regex search functionality to the scrollback buffer, triggered
         by a hotkey (default: "M-s"). While in search mode, normal terminal
         input/output is suspended and a regex is displayed at the bottom of
         For example, the following will transform selections of the form
         "filename:number", often seen in compiler messages, into "vi
         +$filename $word":
-           URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
+           URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
         And this example matches the same,but replaces it with vi-commands
         you can paste directly into your (vi :) editor:
-           URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
+           URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
         Of course, this can be modified to suit your needs and your editor
         :)
+        To expand the example above to typical perl error messages ("XXX at
+        FILENAME line YYY."), you need a slightly more elaborate solution:
+           URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
+           URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
+        The first line tells the selection code to treat the unchanging part
+        of every error message as a selection pattern, and the second line
+        transforms the message into vi commands to load the file.
     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.
+    automove-background
+        This is basically a one-line 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. Exmaple:
+           rxvt -pixmap background.xpm -pe automove-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.
     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.
+    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
+        environment as it writes to /tmp directly.).
+        It listens to the "selection-pastebin:remote-pastebin" keyboard
+        command, i.e.
+           URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
+        Pressing this combination runs a command with "%" replaced by the
+        name of the textfile. This command can be set via a resource:
+           URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
+        And the default is likely not useful to anybody but the few people
+        around here :)
+        The name of the textfile is the hex encoded md5 sum of the
+        selection, so the same content should lead to the same filename.
+        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/%
 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
         size-related variables.
     on_start $term
         Called at the very end of initialisation of a new terminal, just
         before returning to the mainloop.
+    on_child_start $term, $pid
+        Called just after the child process has been "fork"ed.
+    on_child_exit $term, $status
+        Called just after the child process has exited. $status is the
+        status from "waitpid".
     on_sel_make $term, $eventtime
         Called whenever a selection has been made by the user, but before
         the selection text is copied, so changes to the beginning, end or
         type of the selection will be honored.
     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).
+    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.
     on_focus_in $term
         Called whenever the window gets the keyboard focus, before
         rxvt-unicode does focus in processing.
     on_focus_out $term
         Called wheneever the window loses keyboard focus, before
         rxvt-unicode does focus out processing.
+    on_configure_notify $term, $event
     on_key_press $term, $event, $keysym, $octets
     on_key_release $term, $event, $keysym
     on_button_press $term, $event
     on_button_release $term, $event
     on_motion_notify $term, $event
         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
+    urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
+    ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
+    PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
+    Button3MotionMask, Button4MotionMask, Button5MotionMask,
+    ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
+    StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
+    SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
+    ColormapChangeMask, OwnerGrabButtonMask
+    urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
+    EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
+    GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
+    UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
+    ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
+    CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
+    SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
         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.
     $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.
+    $term->exec_async ($cmd[, @args])
+        Works like the combination of the "fork"/"exec" builtins, which
+        executes ("starts") programs in the background. This function takes
+        care of setting the user environment before exec'ing the command
+        (e.g. "PATH") and should be preferred over explicit calls to "exec"
+        or "system".
+        Returns the pid of the subprocess or "undef" on error.
     $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
         the hash.
         Here is a a likely non-exhaustive list of option names, please see
         the source file /src/optinc.h to see the actual list:
          borderLess console cursorBlink cursorUnderline hold iconic insecure
          intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
-         pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
+         override-redirect pastableTabs pointerBlank reverseVideo scrollBar
-         scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
+         scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
-         secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
+         scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
-         tripleclickwords utmpInhibit visualBell
+         transparent tripleclickwords utmpInhibit visualBell
     $value = $term->resource ($name[, $newval])
         Returns the current resource value associated with a given name and
         optionally sets a new value. Setting values is most useful in the
         "init" hook. Unset resources are returned and accepted as "undef".
           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
+          italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
-          mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
+          mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
-          perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
+          perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
-          reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
+          preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
-          scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
+          scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
-          scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
+          scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
+          secondaryScreen secondaryScroll selectstyle shade term_name title
-          shade term_name title transparent transparent_all tripleclickwords
+          transient_for transparent transparent_all tripleclickwords utmpInhibit
-          utmpInhibit visualBell
+          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
     $windowid = $term->parent
         Return the window id of the toplevel window.
     $windowid = $term->vt
         Return the window id of the terminal window.
+    $term->vt_emask_add ($x_event_mask)
+        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);
     $window_width = $term->width
     $window_height = $term->height
     $font_width = $term->fwidth
     $font_height = $term->fheight
     $terminal_columns = $term->ncol
     $has_focus = $term->focus
     $is_mapped = $term->mapped
     $max_scrollback = $term->saveLines
     $nrow_plus_saveLines = $term->total_rows
-    $lines_in_scrollback = $term->nsaved
+    $topmost_scrollback_row = $term->top_row
         Return various integers describing terminal characteristics.
     $x_display = $term->display_id
         Return the DISPLAY used by rxvt-unicode.
         Return the modifier masks corresponding to the "ISO Level 3 Shift"
         (often AltGr), the meta key (often Alt) and the num lock key, if
         applicable.
     $view_start = $term->view_start ([$newvalue])
-        Returns the negative row number of the topmost line. Minimum value
+        Returns the row number of the topmost displayed line. Maximum value
-        is 0, which displays the normal terminal contents. Larger values
+        is 0, which displays the normal terminal contents. Lower values
         scroll this many lines into the scrollback buffer.
     $term->want_refresh
         Requests a screen refresh. At the next opportunity, rxvt-unicode
         will compare the on-screen display with its stored representation.
     $timer = $timer->start
         Start the timer.
     $timer = $timer->start ($tstamp)
         Set the event trigger time to $tstamp and start the timer.
+    $timer = $timer->after ($delay)
+        Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
     $timer = $timer->stop
         Stop the timer.
   The "urxvt::iow" Class

Diff Legend

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

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents): Revision 1.25 by root, Thu Jan 12 12:15:10 2006 UTC vs. Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.25 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC