--- rxvt-unicode/doc/rxvtperl.3.html 2006/01/12 12:10:06 1.26 +++ rxvt-unicode/doc/rxvtperl.3.html 2006/01/20 22:49:34 1.35 @@ -30,6 +30,8 @@
  • The urxvt::popup Class
  • The urxvt::timer Class
  • The urxvt::iow Class
    • +
  • The urxvt::iw Class
    • +
  • The urxvt::pw Class
  • ENVIRONMENT
    • @@ -82,6 +84,9 @@

    You can activate them like this:

       rxvt -pe <extensionname>
    +

    Or by adding them to the resource for extensions loaded by default:

    +
    +  URxvt.perl-ext-common: default,automove-background,selection-autotransform
    selection (enabled by default)
    @@ -122,7 +127,7 @@ 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
    @@ -147,7 +152,31 @@
    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. +evaluation, 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 as in +the selection to bs, but only if the selection currently contains any +as:

    +
    +
    +
    +   push @{ $self->{term}{selection_popup_hook} }, sub {
+      /a/ ? ("a to be" => sub { s/a/b/g }
+          : ()
+   };

    searchable-scrollback<hotkey> (enabled by default)
    @@ -191,7 +220,7 @@ 
    -   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 @@ -199,7 +228,55 @@ 

    -   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.

    +
    +

    +
    readline
    +
    +
    +A support package that tries to make editing with readline easier. At the +moment, it reacts to clicking with the left mouse button by trying to +move the text cursor to this position. It does so by generating as many +cursor-left or cursor-right keypresses as required (the this only works +for programs that correctly support wide characters). +
    +
    +

    It only works when clicking into the same line (possibly extended over +multiple rows) as the text cursor and on the primary screen, to reduce the +risk of misinterpreting. The normal selection isn't disabled, so quick +successive clicks might interfere with selection creation in harmless +ways.

    +
    +

    +
    tabbed
    +
    +
    +This transforms the terminal into a tabbar with additional terminals, that +is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line +displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one +button per tab. +
    +
    +

    Clicking a button will activate that tab. Pressing Shift-Left and +Shift-Right will switch to the tab left or right of the current one, +while Shift-Down creates a new tab.

    mark-urls
    @@ -211,6 +288,18 @@ 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
    @@ -232,6 +321,48 @@ 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/%
    +

    @@ -315,9 +446,9 @@ called whenever the relevant event happens.

    The first argument passed to them is an extension oject as described in the in the Extension Objects section.

    -

    All of these hooks 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.

    +

    All of these hooks must return a boolean value. If any of the called +hooks returns true, then the event counts as being consumed, and the +relevant action might not be carried out by the C++ code.

    When in doubt, return a false value (preferably ()). >

    on_init $term
    @@ -326,8 +457,24 @@ 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 characteristics -have not yet been determined. You can safely query and change resources, -though. +have not yet been determined. You can safely query and change resources +and options, though. For many purposes the on_start hook is a better +place. + +

    +
    on_start $term
    +
    +
    +Called at the very end of initialisation of a new terminal, just before +trying to map (display) the toplevel and returning to the mainloop. +
    +

    +
    on_destroy $term
    +
    +
    +Called whenever something tries to destroy terminal, before doing anything +yet. If this hook returns true, then destruction is skipped, but this is +rarely a good idea.

    on_reset $term
    @@ -338,11 +485,17 @@ variables.

    -
    on_start $term
    +
    on_child_start $term, $pid
    -Called at the very end of initialisation of a new terminal, just before -returning to the mainloop. +Called just after the child process has been forked. +
    +

    +
    on_child_exit $term, $status
    +
    +
    +Called just after the child process has exited. $status is the status +from waitpid.

    on_sel_make $term, $eventtime
    @@ -477,6 +630,14 @@ 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
    @@ -491,6 +652,10 @@ focus out processing.

    +
    on_configure_notify $term, $event
    +
    +
    on_property_notify $term, $event
    +
    on_key_press $term, $event, $keysym, $octets
    on_key_release $term, $event, $keysym
    @@ -511,8 +676,8 @@

    The event is a hash with most values as named by Xlib (see the XEvent -manpage), with the additional members row and col, which are the row -and column under the mouse cursor.

    +manpage), with the additional members row and col, which are the +(real, not screen-based) row and column under the mouse cursor.

    on_key_press additionally receives the string rxvt-unicode would @@ -521,6 +686,17 @@

    subwindow.

    +

    +
    on_client_message $term, $event
    +
    +
    on_wm_protocols $term, $event
    +
    +
    on_wm_delete_window $term, $event
    +
    +
    +Called when various types of ClientMessage events are received (all with +format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). +

    @@ -551,6 +727,27 @@ The current terminal. This variable stores the current urxvt::term object, whenever a callback/hook is executing. +

    +
    @urxvt::TERM_INIT
    +
    +
    +All coderefs in this array will be called as methods of the next newly +created urxvt::term object (during the on_init phase). The array +gets cleared before the codereferences that were in it are being executed, +so coderefs can push themselves onto it again if they so desire. +
    +
    +

    This complements to the perl-eval commandline option, but gets executed +first.

    +
    +

    +
    @urxvt::TERM_EXT
    +
    +
    +Works similar to @TERM_INIT, but contains perl package/class names, which +get registered as normal extensions after calling the hooks in @TERM_INIT +but before other extensions. Gets cleared just like @TERM_INIT. +

    @@ -579,14 +776,6 @@

    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
    @@ -599,6 +788,22 @@ 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.
    @@ -700,6 +905,18 @@ 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])
    @@ -715,10 +932,10 @@ 
      borderLess console cursorBlink cursorUnderline hold iconic insecure
  intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
- pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
- scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
- secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
- tripleclickwords utmpInhibit visualBell
    + override-redirect pastableTabs pointerBlank reverseVideo scrollBar + scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput + scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs + transparent tripleclickwords utmpInhibit visualBell

    $value = $term->resource ($name[, $newval])
    @@ -753,14 +970,15 @@ 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_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 + italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier + mouseWheelScrollPage name override_redirect 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 + transient_for transparent transparent_all tripleclickwords utmpInhibit + visualBell

    $value = $term->x_resource ($pattern)
    @@ -945,6 +1163,12 @@ on_add_lines hook, though.

    +
    $term->scr_change_screen ($screen)
    +
    +
    +Switch to given screen - 0 primary, 1 secondary. +
    +

    $term->cmd_parse ($octets)
    @@ -982,6 +1206,17 @@ 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
    @@ -1004,7 +1239,7 @@
    $nrow_plus_saveLines = $term->total_rows
    -
    $lines_in_scrollback = $term->nsaved
    +
    $topmost_scrollback_row = $term->top_row
    Return various integers describing terminal characteristics. @@ -1040,11 +1275,17 @@ AltGr), the meta key (often Alt) and the num lock key, if applicable.

    +
    $screen = $term->current_screen
    +
    +
    +Returns the currently displayed screen (0 primary, 1 secondary). +
    +

    $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 +Returns the row number of the topmost displayed line. Maximum value is +0, which displays the normal terminal contents. Lower values scroll this many lines into the scrollback buffer.

    @@ -1065,7 +1306,7 @@ 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. Nothing will be returned if a nonexistent line +line -$term->nsaved. Nothing will be returned if a nonexistent line is requested.
    @@ -1075,11 +1316,11 @@ automatically be updated.

    -

    $text is in a special encoding: tabs and wide characters that use more -than one cell when displayed are padded with urxvt::NOCHAR characters -(chr 65535). Characters with combining characters and other characters -that do not fit into the normal tetx encoding will be replaced with -characters in the private use area.

    +

    $text is in a special encoding: tabs and wide characters that use +more than one cell when displayed are padded with $urxvt::NOCHAR +characters. Characters with combining characters and other characters that +do not fit into the normal tetx encoding will be replaced with characters +in the private use area.

    You have to obey this encoding when changing text. The advantage is @@ -1224,6 +1465,38 @@ evaluation errors, as it is better to lose the grab in the error case as the session.

    +

    +
    $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
    +
    +
    $atom_name = $term->XGetAtomName ($atom)
    +
    +
    @atoms = $term->XListProperties ($window)
    +
    +
    ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
    +
    +
    $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
    +
    +
    $term->XDeleteProperty ($window, $property)
    +
    +
    $window = $term->DefaultRootWindow
    +
    +
    $term->XReparentWindow ($window, $parent, [$x, $y])
    +
    +
    $term->XMapWindow ($window)
    +
    +
    $term->XUnmapWindow ($window)
    +
    +
    $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
    +
    +
    ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
    +
    +
    $term->XChangeInput ($window, $add_events[, $del_events])
    +
    +
    +Various X or X-related functions. The $term object only serves as +the source of the display, otherwise those functions map more-or-less +directory onto the X functions of the same name. +

    @@ -1322,6 +1595,12 @@ 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
    @@ -1386,6 +1665,77 @@

    +

    +

    The urxvt::iw Class

    +

    This class implements idle watchers, that get called automatically when +the process is idle. They should return as fast as possible, after doing +some useful work.

    +
    +
    $iw = new urxvt::iw
    +
    +
    +Create a new idle watcher object in stopped state. +
    +

    +
    $iw = $iw->cb (sub { my ($iw) = @_; ... })
    +
    +
    +Set the callback to be called when the watcher triggers. +
    +

    +
    $timer = $timer->start
    +
    +
    +Start the watcher. +
    +

    +
    $timer = $timer->stop
    +
    +
    +Stop the watcher. +
    +

    +

    +

    +

    The urxvt::pw Class

    +

    This class implements process watchers. They create an event whenever a +process exits, after which they stop automatically.

    +
    +   my $pid = fork;
+   ...
+   $term->{pw} = urxvt::pw
+                    ->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) = @_; ... })
    +
    +
    +Set the callback to be called when the timer triggers. +
    +

    +
    $pw = $timer->start ($pid)
    +
    +
    +Tells the wqtcher to start watching for process $pid. +
    +

    +
    $pw = $pw->stop
    +
    +
    +Stop the watcher. +
    +

    +

    ENVIRONMENT