--- rxvt-unicode/doc/rxvtperl.3.txt 2006/01/09 01:36:56 1.15 +++ rxvt-unicode/doc/rxvtperl.3.txt 2006/01/12 05:37:34 1.23 @@ -23,8 +23,8 @@ 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 extensiosn delivered with this version. You +PREPACKAGED EXTENSIONS + This section describes the extensions delivered with this release. You can find them in /opt/rxvt/lib/urxvt/perl/. You can activate them like this: @@ -32,12 +32,16 @@ rxvt -pe selection (enabled by default) - 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". + (More) intelligent selection. This extension tries to be more + intelligent 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". - It also offers the following bindable event: + A double-click usually selects the word under the cursor, further + clicks will enlarge the selection. + + It also offers the following bindable keyboard command: rot13 Rot-13 the selection when activated. Used via keyboard trigger: @@ -50,14 +54,32 @@ selection-popup (enabled by default) Binds a popup menu to Ctrl-Button3 that lets you convert the - selection text into various other formats/action. + selection text into various other formats/action (such as uri + unescaping, perl evalution, web-browser starting etc.), depending on + content. + + searchable-scrollback (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 + the screen. + + 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 Displays a digital clock using the built-in overlay. 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. block-graphics-to-ascii A not very useful example of filtering all text output to the @@ -69,6 +91,7 @@ the window. Illustrates overwriting the refresh callbacks to create your own overlays or changes. +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 @@ -86,7 +109,7 @@ $text Rxvt-unicodes special way of encoding text, where one "unicode" - character always represents one screen cell. See row_t for a + character always represents one screen cell. See ROW_t for a discussion of this format. $string @@ -98,24 +121,44 @@ Either binary data or - more common - a text string encoded in a locale-specific way. + Extension Objects + Very perl extension is a perl class. A separate perl object is created + for each terminal and each extension and passed as the first parameter + to hooks. So extensions can use their $self object without having to + think about other extensions, with the exception of methods and members + that begin with an underscore character "_": these are reserved for + internal use. + + Although it isn't a "urxvt::term" object, you can call all methods of + the "urxvt::term" class on this object. + + It has the following methods and data members: + + $urxvt_term = $self->{term} + Returns the "urxvt::term" object associated with this instance of + the extension. This member *must not* be changed in any way. + + $self->enable ($hook_name => $cb, [$hook_name => $cb..]) + Dynamically enable the given hooks (named without the "on_" prefix) + for this extension, replacing any previous hook. This is useful when + you want to overwrite time-critical hooks only temporarily. + + $self->disable ($hook_name[, $hook_name..]) + Dynamically disable the given hooks. + Hooks The following subroutines can be declared in extension files, 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. It is, however, blessed intot he package of the extension - script, so for all practical purposes you can treat an extension script - as a class. + The first argument passed to them is an extension oject as described in + the in the "Extension Objects" section. - 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 + 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. - When in doubt, return a false value (preferably "()"). + *When in doubt, return a false value (preferably "()").* on_init $term Called after a new terminal object has been initialized, but before @@ -154,7 +197,10 @@ 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. + suppress the built-in 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. @@ -191,6 +237,10 @@ Please note that this might be very slow, however, as your hook is called for all text being output. + on_tt_write $term, $octets + Called whenever some data is written to the tty/pty and can be used + to suppress or filter tty input. + on_line_update $term, $row Called whenever a line was updated or changed. Can be used to filter screen output (e.g. underline urls or other useless stuff). Only @@ -227,8 +277,8 @@ Called wheneever the window loses keyboard focus, before rxvt-unicode does focus out processing. - on_key_press $term, $event, $octets - on_key_release $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 @@ -248,19 +298,22 @@ subwindow. Variables in the "urxvt" Package + $urxvt::LIBDIR + The rxvt-unicode library directory, where, among other things, the + perl modules and scripts are stored. + + $urxvt::RESCLASS, $urxvt::RESCLASS + The resource class and name rxvt-unicode uses to look up X + resources. + + $urxvt::RXVTNAME + The basename of the installed binaries, usually "urxvt". + $urxvt::TERM The current terminal. This variable stores the current "urxvt::term" object, whenever a callback/hook is executing. Functions in the "urxvt" Package - $term = new urxvt [arg...] - Creates a new terminal, very similar as if you had started it with - "system $binfile, arg...". 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 the - call. - 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 @@ -274,6 +327,13 @@ 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). @@ -309,29 +369,42 @@ $background = urxvt::GET_BASEBG $rend Return the foreground/background colour index, respectively. - $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) - $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) + $rend = urxvt::SET_FGCOLOR $rend, $new_colour + $rend = urxvt::SET_BGCOLOR $rend, $new_colour Replace the foreground/background colour in the rendition mask with the specified one. - $value = urxvt::GET_CUSTOM ($rend) + $value = urxvt::GET_CUSTOM $rend Return the "custom" value: Every rendition has 5 bits for use by extensions. They can be set and changed as you like and are initially zero. - $rend = urxvt::SET_CUSTOM ($rend, $new_value) + $rend = urxvt::SET_CUSTOM $rend, $new_value Change the custom value. The "urxvt::anyevent" Class The sole purpose of this class is to deliver an interface to the "AnyEvent" module - any module using it will work inside urxvt without - further work. The only exception is that you cannot wait on condition - variables, but non-blocking condvar use is ok. What this means is that - you cannot use blocking APIs, but the non-blocking variant should work. + further programming. The only exception is that you cannot wait on + condition variables, but non-blocking condvar use is ok. What this means + is that you cannot use blocking APIs, but the non-blocking variant + should work. The "urxvt::term" Class + $term = new urxvt::term $envhashref, $rxvtname, [arg...] + Creates a new terminal, very similar as if you had started it with + system "$rxvtname, arg...". $envhashref must be a reference to a + %ENV-like hash which defines the environment of the new terminal. + + 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. + $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. $isset = $term->option ($optval[, $set]) Returns true if the option specified by $optval is enabled, and @@ -383,6 +456,20 @@ shade term_name title 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) + Adds a keymap translation exactly as specified via a resource. See + the "keysym" resource in the rxvt(1) manpage. + $rend = $term->rstyle ([$new_rstyle]) Return and optionally change the current rendition. Text that is output by the terminal application will use this style. @@ -398,21 +485,25 @@ Return the current values of the selection mark, begin or end positions, 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]) Return the current selection text and optionally replace it by $newtext. - #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line - overlay box. See the next method for details. # #=cut # #sub - urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my - @lines = split /\n/, $text; # # my $w = 0; # for (map - $self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # # - $self->scr_overlay_new ($x, $y, $w, scalar @lines); # - $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #} + $term->overlay_simple ($x, $y, $text) + Create a simple multi-line overlay box. See the next method for + details. $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) Create a new (empty) overlay at the given position with the given @@ -457,6 +548,22 @@ $string = $term->locale_decode ($octets) Convert the given locale-encoded octets into a perl string. + $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) + XORs the rendition values in the given span with the provided value + (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]]) + 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. Both styles *MUST NOT* contain font + styles. + + $term->scr_bell + Ring the bell! + $term->scr_add_lines ($string) Write the given text string to the screen, as if output by the application running inside the terminal. It may not contain command @@ -479,6 +586,12 @@ strings first to the locale-specific encoding using "$term->locale_encode". + $old_events = $term->pty_ev_events ([$new_events]) + Replaces the event mask of the pty watcher by the given event mask. + Can be used to suppress input and output handling to the pty/tty. + See the description of "urxvt::timer->events". Make sure to always + restore the previous value. + $windowid = $term->parent Return the window id of the toplevel window. @@ -499,6 +612,16 @@ $lines_in_scrollback = $term->nsaved Return various integers describing terminal characteristics. + $x_display = $term->display_id + Return the DISPLAY used by rxvt-unicode. + + $lc_ctype = $term->locale + Returns the LC_CTYPE category string used by this rxvt-unicode. + + $env = $term->env + Returns a copy of the environment in effect for the terminal as a + hashref similar to "\%ENV". + $modifiermask = $term->ModLevel3Mask $modifiermask = $term->ModMetaMask $modifiermask = $term->ModNumLockMask @@ -586,7 +709,8 @@ $offset = $line->offset_of ($row, $col) Returns the character offset of the given row|col pair within - the logical line. + the logical line. Works for rows outside the line, too, and + returns corresponding offsets outside the string. ($row, $col) = $line->coord_of ($offset) Translates a string offset into terminal coordinates again. @@ -601,7 +725,7 @@ "$term->ROW_t" for details. $success = $term->grab_button ($button, $modifiermask) - Registers a synchronous button grab. See XGrabButton. + Registers a synchronous button grab. See the XGrabButton manpage. $success = $term->grab ($eventtime[, $sync]) Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or @@ -623,92 +747,113 @@ case as the session. The "urxvt::popup" Class + $popup->add_title ($title) + Adds a non-clickable title to the popup. + + $popup->add_separator ([$sepchr]) + Creates a separator, optionally using the character given as + $sepchr. + + $popup->add_button ($text, $cb) + Adds a clickable button to the popup. $cb is called whenever it is + selected. + + $popup->add_toggle ($text, $cb, $initial_value) + 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. + + $popup->show + Displays the popup (which is initially hidden). + The "urxvt::timer" Class - This class implements timer watchers/events. Time is represented as - a fractional number of seconds since the epoch. Example: + This class implements timer watchers/events. Time is represented as a + fractional number of seconds since the epoch. Example: - $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); - $term->{timer} = urxvt::timer - ->new - ->interval (1) - ->cb (sub { - $term->{overlay}->set (0, 0, - sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); - }); - - $timer = new urxvt::timer - Create a new timer object in started state. It is scheduled to - fire immediately. - - $timer = $timer->cb (sub { my ($timer) = @_; ... }) - Set the callback to be called when the timer triggers. - - $tstamp = $timer->at - Return the time this watcher will fire next. - - $timer = $timer->set ($tstamp) - Set the time the event is generated to $tstamp. - - $timer = $timer->interval ($interval) - Normally (and when $interval is 0), the timer will automatically - stop after it has fired once. If $interval is non-zero, then the - timer is automatically rescheduled at the given intervals. + $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); + $term->{timer} = urxvt::timer + ->new + ->interval (1) + ->cb (sub { + $term->{overlay}->set (0, 0, + sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); + }); + + $timer = new urxvt::timer + Create a new timer object in started state. It is scheduled to fire + immediately. + + $timer = $timer->cb (sub { my ($timer) = @_; ... }) + Set the callback to be called when the timer triggers. + + $tstamp = $timer->at + Return the time this watcher will fire next. + + $timer = $timer->set ($tstamp) + Set the time the event is generated to $tstamp. + + $timer = $timer->interval ($interval) + Normally (and when $interval is 0), the timer will automatically + stop after it has fired once. If $interval is non-zero, then the + timer is automatically rescheduled at the given intervals. - $timer = $timer->start - Start the timer. + $timer = $timer->start + Start the timer. - $timer = $timer->start ($tstamp) - Set the event trigger time to $tstamp and start the timer. + $timer = $timer->start ($tstamp) + Set the event trigger time to $tstamp and start the timer. - $timer = $timer->stop - Stop the timer. + $timer = $timer->stop + Stop the timer. The "urxvt::iow" Class - This class implements io watchers/events. Example: + This class implements io watchers/events. Example: - $term->{socket} = ... - $term->{iow} = urxvt::iow - ->new - ->fd (fileno $term->{socket}) - ->events (1) # wait for read data - ->start - ->cb (sub { - my ($iow, $revents) = @_; - # $revents must be 1 here, no need to check - sysread $term->{socket}, my $buf, 8192 - or end-of-file; - }); - - $iow = new urxvt::iow - Create a new io watcher object in stopped state. - - $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) - Set the callback to be called when io events are triggered. - $reventmask is a bitset as described in the "events" method. - - $iow = $iow->fd ($fd) - Set the filedescriptor (not handle) to watch. - - $iow = $iow->events ($eventmask) - Set the event mask to watch. Bit #0 (value 1) enables watching - for read data, Bit #1 (value 2) enables watching for write data. + $term->{socket} = ... + $term->{iow} = urxvt::iow + ->new + ->fd (fileno $term->{socket}) + ->events (urxvt::EVENT_READ) + ->start + ->cb (sub { + my ($iow, $revents) = @_; + # $revents must be 1 here, no need to check + sysread $term->{socket}, my $buf, 8192 + or end-of-file; + }); + + $iow = new urxvt::iow + Create a new io watcher object in stopped state. + + $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) + Set the callback to be called when io events are triggered. + $reventmask is a bitset as described in the "events" method. + + $iow = $iow->fd ($fd) + Set the filedescriptor (not handle) to watch. + + $iow = $iow->events ($eventmask) + Set the event mask to watch. The only allowed values are + "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed + together, or "urxvt::EVENT_NONE". - $iow = $iow->start - Start watching for requested events on the given handle. + $iow = $iow->start + Start watching for requested events on the given handle. - $iow = $iow->stop - Stop watching for events on the given filehandle. + $iow = $iow->stop + Stop watching for events on the given filehandle. ENVIRONMENT URXVT_PERL_VERBOSITY - This variable controls the verbosity level of the perl extension. - Higher numbers indicate more verbose output. + This variable controls the verbosity level of the perl extension. Higher + numbers indicate more verbose output. - == 0 - fatal messages - >= 3 - script loading and management - >=10 - all events received + == 0 - fatal messages + >= 3 - script loading and management + >=10 - all called hooks + >=11 - hook reutrn values AUTHOR - Marc Lehmann - http://software.schmorp.de/pkg/rxvt-unicode + Marc Lehmann + http://software.schmorp.de/pkg/rxvt-unicode