--- rxvt-unicode/doc/rxvtperl.3.txt 2006/01/13 12:40:46 1.27 +++ rxvt-unicode/doc/rxvtperl.3.txt 2006/01/22 20:39:56 1.35 @@ -1,5 +1,5 @@ NAME - urxvtperl - rxvt-unicode's embedded perl interpreter + rxvtperl - rxvt-unicode's embedded perl interpreter SYNOPSIS # create a file grab_test in $HOME: @@ -9,9 +9,9 @@ () } - # start a urxvt using it: + # start a rxvt using it: - urxvt --perl-lib $HOME -pe grab_test + rxvt --perl-lib $HOME -pe grab_test DESCRIPTION Everytime a terminal object gets created, extension scripts specified @@ -20,16 +20,20 @@ Scripts are compiled in a 'use strict' and 'use utf8' environment, and thus must be encoded as UTF-8. - Each script will only ever be loaded once, even in urxvtd, where scripts + Each script will only ever be loaded once, even in rxvtd, where scripts will be shared (but not enabled) for all terminals. PREPACKAGED EXTENSIONS This section describes the extensions delivered with this release. You - can find them in /usr/local/lib/urxvt/perl/. + can find them in /opt/rxvt/lib/urxvt/perl/. You can activate them like this: - urxvt -pe + rxvt -pe + + 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 @@ -59,7 +63,7 @@ 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: @@ -73,8 +77,28 @@ 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. + unescaping, perl 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 "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 (enabled by default) Adds regex search functionality to the scrollback buffer, triggered @@ -90,6 +114,24 @@ stay at the current position and additionally stores the first match in the current line into the primary selection. + readline (enabled by default) + 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). + + 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. @@ -110,7 +152,7 @@ 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+):?$/\\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 :) @@ -118,19 +160,38 @@ 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+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ + 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. + 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 .. @@ -144,6 +205,34 @@ 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 @@ -206,10 +295,9 @@ 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 "()").* @@ -218,16 +306,30 @@ 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. + 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 Called after the screen is "reset" for any reason, such as resizing or control sequences. Here is where you can react on changes to 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 @@ -320,7 +422,7 @@ 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 urxvt(1) manpage). + resource in the rxvt(1) manpage). on_x_event $term, $event Called on every X event received on the vt window (and possibly @@ -335,6 +437,8 @@ Called wheneever the window loses keyboard focus, before rxvt-unicode does 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 on_button_press $term, $event @@ -348,13 +452,20 @@ 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. + are the (real, not screen-based) row and column under the mouse + cursor. "on_key_press" additionally receives the string rxvt-unicode would output, if any, in locale-specific encoding. 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). + Variables in the "urxvt" Package $urxvt::LIBDIR The rxvt-unicode library directory, where, among other things, the @@ -371,6 +482,22 @@ 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. + Functions in the "urxvt" Package urxvt::fatal $errormessage Fatally aborts execution with the given error message. Avoid at all @@ -387,11 +514,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 Returns the "current time" (as per the event loop). @@ -476,9 +598,18 @@ $term->destroy Destroy the terminal object (close the window, free resources etc.). - Please note that urxvt will not exit as long as any event watchers + 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 @@ -490,10 +621,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]) Returns the current resource value associated with a given name and @@ -520,14 +651,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) Returns the X-Resource for the given pattern, excluding the program @@ -541,7 +673,7 @@ $success = $term->parse_keysym ($keysym_spec, $command_string) Adds a keymap translation exactly as specified via a resource. See - the "keysym" resource in the urxvt(1) manpage. + the "keysym" resource in the rxvt(1) manpage. $rend = $term->rstyle ([$new_rstyle]) Return and optionally change the current rendition. Text that is @@ -648,6 +780,9 @@ be confused by changes in cursor position or scrolling. Its useful inside a "on_add_lines" hook, though. + $term->scr_change_screen ($screen) + Switch to given screen - 0 primary, 1 secondary. + $term->cmd_parse ($octets) Similar to "scr_add_lines", but the argument must be in the locale-specific encoding of the terminal and can contain command @@ -665,6 +800,10 @@ See the description of "urxvt::timer->events". Make sure to always restore 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 Return the window id of the toplevel window. @@ -688,7 +827,7 @@ $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 @@ -708,9 +847,15 @@ (often 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 + 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. $term->want_refresh @@ -733,8 +878,8 @@ 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 + more 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. @@ -825,6 +970,25 @@ 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. + The "urxvt::popup" Class $popup->add_title ($title) Adds a non-clickable title to the popup. @@ -882,6 +1046,9 @@ $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. + $timer = $timer->stop Stop the timer. @@ -922,6 +1089,49 @@ $iow = $iow->stop Stop watching for events on the given filehandle. + 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 URXVT_PERL_VERBOSITY This variable controls the verbosity level of the perl extension. Higher