--- rxvt-unicode/doc/rxvtperl.3.html 2006/01/11 01:01:52 1.23 +++ rxvt-unicode/doc/rxvtperl.3.html 2006/02/21 01:00:40 1.43 @@ -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,17 +84,60 @@

    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)
    (More) 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. +when the user extends selections (double-click and further clicks). Right +now, it tries to select words, urls and complete shell-quoted +arguments, which is very convenient, too, if your ls supports +--quoting-style=shell. +
    +
    +

    A double-click usually selects the word under the cursor, further clicks +will enlarge the selection.

    +
    +
    +

    The selection works by trying to match a number of regexes and displaying +them in increasing order of length. You can add your own regexes by +specifying resources of the form:

    +
    +
    +
    +   URxvt.selection.pattern-0: perl-regex
+   URxvt.selection.pattern-1: perl-regex
+   ...
    +
    +
    +

    The index number (0, 1...) must not have any holes, and each regex must +contain at least one pair of capturing parentheses, which will be used for +the match. For example, the followign adds a regex that matches everything +between two vertical bars:

    +
    +
    +
    +   URxvt.selection.pattern-0: \\|([^|]+)\\|
    +
    +
    +

    Another example: Programs I use often output ``absolute path: '' at the +beginning of a line when they process multiple files. The following +pattern matches the filename (note, there is a single space at the very +end):

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

    -

    It also offers the following bindable keyboard command:

    +

    This extension also offers following bindable keyboard commands:

    rot13
    @@ -111,39 +156,220 @@ Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at runtime. +
    +

    Other extensions can extend this popup menu by pushing a code reference +onto @{ $term-{option_popup_hook} }>, which gets called whenever the +popup is being displayed.

    +
    +
    +

    It's sole argument is the popup menu, which can be modified. It should +either return nothing or a string, the initial boolean value and a code +reference. The string will be used as button text and the code reference +will be called when the toggle changes, with the new boolean value as +first argument.

    +
    +
    +

    The following will add an entry myoption that changes +$self-{myoption}>:

    +
    +
    +
    +   push @{ $self->{term}{option_popup_hook} }, sub {
+      ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
+   };
    +

    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. +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} }>, which gets called whenever the +popup is being 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)
    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. +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 the +screen.
    -

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

    +

    Inputting characters appends them to the regex and continues incremental +search. BackSpace removes a character from the regex, Up and Down +search upwards/downwards in the scrollback buffer, End jumps to the +bottom. Escape leaves search mode and returns to the point where search +was started, while Enter or Return stay at the current position and +additionally stores the first match in the current line into the primary +selection.

    -
    digital-clock
    +
    readline (enabled by default)
    -Displays a digital clock using the built-in overlay. +A support package that tries to make editing with readline easier. At +the moment, it reacts to clicking shift-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). +
    +
    +

    To avoid too many false positives, this is only done when:

    +
    +
    +
    - the tty is in ICANON state.
    +
    +
    - the text cursor is visible.
    +
    +
    - the primary screen is currently being displayed.
    +
    +
    - the mouse is on the same (multi-row-) line as the text cursor.
    +
    +
    +

    The normal selection mechanism isn't disabled, so quick successive clicks +might interfere with selection creation in harmless ways.

    +
    selection-autotransform
    +
    +
    +This selection allows you to do automatic transforms on a selection +whenever a selection is made. +
    +
    +

    It works by specifying perl snippets (most useful is a single s/// +operator) that modify $_ as resources:

    +
    +
    +
    +   URxvt.selection-autotransform.0: transform
+   URxvt.selection-autotransform.1: transform
+   ...
    +
    +
    +

    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/^([^:[: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/^([^:[: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.

    +
    +

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

    +
    +
    +

    The tabbar itself can be configured similarly to a normal terminal, but +with a resource class of URxvt.tabbed. In addition, it supports the +following four resources (shown with defaults):

    +
    +
    +
    +   URxvt.tabbed.tabbar-fg: <colour-index, default 3>
+   URxvt.tabbed.tabbar-bg: <colour-index, default 0>
+   URxvt.tabbed.tab-fg:    <colour-index, default 0>
+   URxvt.tabbed.tab-bg:    <colour-index, default 1>
    +
    +
    +

    See COLOR AND GRAPHICS in the rxvt(1) manpage for valid +indices.

    mark-urls
    -Uses per-line display filtering (on_line_update) to underline 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. +
    +

    +
    xim-onthespot
    +
    +
    +This (experimental) perl extension implements OnTheSpot editing. It does +not work perfectly, and some input methods don't seem to work well with +OnTheSpot editing in general, but it seems to work at leats for SCIM and +kinput2. +
    +
    +

    You enable it by specifying this extension and a preedit style of +OnTheSpot, i.e.:

    +
    +
    +
    +   rxvt -pt OnTheSpot -pe xim-onthespot
    +
    +

    +
    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
    @@ -154,6 +380,81 @@ similar-looking ascii character.

    +
    digital-clock
    +
    +
    +Displays a digital clock using the built-in overlay. +
    +

    +
    remote-clipboard
    +
    +
    +Somewhat of a misnomer, this extension adds two menu entries to the +selection popup that allows one ti run external commands to store the +selection somewhere and fetch it again. +
    +
    +

    We use it to implement a ``distributed selection mechanism'', which just +means that one command uploads the file to a remote server, and another +reads it.

    +
    +
    +

    The commands can be set using the URxvt.remote-selection.store and +URxvt.remote-selection.fetch resources. The first should read the +selection to store from STDIN (always in UTF-8), the second should provide +the selection data on STDOUT (also in UTF-8).

    +
    +
    +

    The defaults (which are likely useless to you) use rsh and cat:

    +
    +
    +
    +   URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
+   URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
    +
    +

    +
    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/%
    +
    +

    example-refresh-hooks
    @@ -244,9 +545,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
    @@ -255,8 +556,23 @@ 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, when the terminal is +still fully functional (not for long, though).

    on_reset $term
    @@ -267,11 +583,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
    @@ -303,7 +625,9 @@ 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. +processing. This can happen multiple times, as long as the callback +returns true, it will be called on every further click by the user and is +supposed to enlarge the selection more and more, if possible.

    See the selection example extension.

    @@ -396,13 +720,33 @@ Called just after the screen gets redrawn. See on_refresh_begin.

    -
    on_keyboard_command $term, $string
    +
    on_user_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 +Called whenever the a user-configured event is being activated (e.g. via +a perl:string action bound to a key, see description of the keysym resource in the rxvt(1) manpage).
    +
    +

    The event is simply the action string. This interface is assumed to change +slightly in the future.

    +
    +

    +
    on_resize_all_windows $tern, $new_width, $new_height
    +
    +
    +Called just after the new window size has been calculcated, but before +windows are actually being resized or hints are being set. If this hook +returns TRUE, setting of the window hints is being skipped. +
    +

    +
    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
    @@ -418,6 +762,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
    @@ -438,8 +786,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 @@ -448,6 +796,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). +

    @@ -478,6 +837,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. +

    @@ -506,12 +886,13 @@

    Messages have a size limit of 1023 bytes currently.

    -
    $is_safe = urxvt::safe
    +
    @terms = urxvt::termlist
    -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. +Returns all urxvt::term objects that exist in this process, regardless of +wether they are started, being destroyed etc., so be careful. Only term +objects that have perl extensions attached will be returned (because there +is no urxvt::term objet associated with others).

    $time = urxvt::NOW
    @@ -526,6 +907,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.
    @@ -573,6 +970,8 @@
    $rend = urxvt::SET_BGCOLOR $rend, $new_colour
    +
    $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
    +
    Replace the foreground/background colour in the rendition mask with the specified one. @@ -616,7 +1015,8 @@

    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.

    +start hooks will be called before this call returns, and are free to +refer to global data (which is race free).

    $term->destroy
    @@ -627,6 +1027,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])
    @@ -642,10 +1054,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])
    @@ -680,14 +1092,29 @@ 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)
    +
    +
    +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)
    @@ -722,11 +1149,21 @@ and optionally set them to new values.

    +
    $term->selection_make ($eventtime[, $rectangular])
    +
    +
    +Tries to make a selection as set by selection_beg and +selection_end. If $rectangular is true (default: false), a +rectangular selection will be made. This is the prefered function to make +a selection. +
    +

    $success = $term->selection_grab ($eventtime)
    -Try to request the primary selection from the server (for example, as set -by the next method). +Try to request the primary selection text from the server (for example, as +set by the next method). No visual feedback will be given. This function +is mostly useful from within on_sel_grab hooks.

    $oldtext = $term->selection ([$newtext])
    @@ -815,8 +1252,8 @@
    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. +(default: RS_RVid), which MUST NOT contain font styles. 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]])
    @@ -825,7 +1262,7 @@ 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. +it instead. Both styles MUST NOT contain font styles.

    $term->scr_bell
    @@ -848,6 +1285,12 @@ on_add_lines hook, though.

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

    $term->cmd_parse ($octets)
    @@ -873,6 +1316,13 @@ the previous value.

    +
    $fd = $term->pty_fd
    +
    +
    +Returns the master file descriptor for the pty in use, or -1 if no pty +is used. +
    +

    $windowid = $term->parent
    @@ -885,6 +1335,29 @@ 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);
    +
    +

    +
    $term->focus_in
    +
    +
    $term->focus_out
    +
    +
    $term->key_press ($state, $keycode[, $time])
    +
    +
    $term->key_release ($state, $keycode[, $time])
    +
    +
    +Deliver various fake events to to terminal. +
    +

    $window_width = $term->width
    $window_height = $term->height
    @@ -907,7 +1380,7 @@
    $nrow_plus_saveLines = $term->total_rows
    -
    $lines_in_scrollback = $term->nsaved
    +
    $topmost_scrollback_row = $term->top_row
    Return various integers describing terminal characteristics. @@ -932,6 +1405,19 @@ similar to \%ENV.

    +
    @envv = $term->envv
    +
    +
    +Returns the environment as array of strings of the form VAR=VALUE. +
    +

    +
    @argv = $term->argv
    +
    +
    +Return the argument vector as this terminal, similar to @ARGV, but +includes the program name as first element. +
    +

    $modifiermask = $term->ModLevel3Mask
    $modifiermask = $term->ModMetaMask
    @@ -943,11 +1429,23 @@ 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). +
    +

    +
    $cursor_is_hidden = $term->hidden_cursor
    +
    +
    +Returns wether the cursor is currently hidden or not. +
    +

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

    @@ -968,7 +1466,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.
    @@ -979,10 +1477,10 @@

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

    +than one cell when displayed are padded with $urxvt::NOCHAR (chr 65535) +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 @@ -1063,7 +1561,8 @@

    Returns the character offset of the given row|col pair within the logical -line. +line. Works for rows outside the line, too, and returns corresponding +offsets outside the string.

    ($row, $col) = $line->coord_of ($offset)
    @@ -1087,10 +1586,13 @@ $term->ROW_t for details.

    -
    $success = $term->grab_button ($button, $modifiermask)
    +
    $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
    +
    +
    $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
    -Registers a synchronous button grab. See the XGrabButton manpage. +Register/unregister a synchronous button grab. See the XGrabButton +manpage.

    $success = $term->grab ($eventtime[, $sync])
    @@ -1126,6 +1628,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. +

    @@ -1150,12 +1684,12 @@ selected.

    -
    $popup->add_toggle ($text, $cb, $initial_value)
    +
    $popup->add_toggle ($text, $initial_value, $cb)
    -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. +Adds a toggle/checkbox item to the popup. The callback gets called +whenever it gets toggled, with a boolean indicating its new value as its +first argument.

    $popup->show
    @@ -1224,6 +1758,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
    @@ -1289,6 +1829,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

    @@ -1301,7 +1912,9 @@

    >= 3 - script loading and management
    -
    >=10 - all events received
    +
    >=10 - all called hooks
    +
    +
    >=11 - hook reutrn values