--- rxvt-unicode/doc/rxvtperl.3.html 2006/07/17 19:20:29 1.45 +++ rxvt-unicode/doc/rxvtperl.3.html 2006/08/07 16:17:30 1.46 @@ -71,7 +71,7 @@


DESCRIPTION

-

Everytime a terminal object gets created, extension scripts specified via +

Every time a terminal object gets created, extension scripts specified via the perl resource are loaded and associated with it.

Scripts are compiled in a 'use strict' and 'use utf8' environment, and thus must be encoded as UTF-8.

@@ -117,7 +117,7 @@

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 +the match. For example, the following adds a regex that matches everything between two vertical bars:

@@ -196,7 +196,7 @@

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. +is in $_, which can be used to decide whether 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 $_.

@@ -319,7 +319,7 @@

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 +is, it implements what is commonly referred 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.

@@ -388,7 +388,7 @@ space most of the time but is quickly available at the press of a key.

-

The accelerator key is grabbed regardless of any modifers, so this +

The accelerator key is grabbed regardless of any modifiers, so this extension will actually grab a physical key just for this function.

@@ -402,7 +402,7 @@

This is basically a very small 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:

+supported in this mode. Example:

@@ -583,7 +583,7 @@
 

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 extension oject as described in +

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

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 @@ -605,7 +605,7 @@

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

+trying to map (display) the toplevel and returning to the main loop.

on_destroy $term @@ -656,7 +656,7 @@ by calling $term->selection.

-

Returning a true value aborts selection grabbing. It will still be hilighted.

+

Returning a true value aborts selection grabbing. It will still be highlighted.

on_sel_extend $term @@ -664,7 +664,7 @@

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 +should extend the selection itself and return true to 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.

@@ -676,7 +676,7 @@
on_view_change $term, $offset
-

Called whenever the view offset changes, i..e the user or program +

Called whenever the view offset changes, i.e. the user or program scrolls. Offset 0 means display the normal terminal, positive values show this many lines of scrollback.

@@ -719,7 +719,7 @@

Be careful not ever to trust (in a security sense) the data you receive, -as its source can not easily be controleld (e-mail content, messages from +as its source can not easily be controlled (e-mail content, messages from other users on the same system etc.).

@@ -776,7 +776,7 @@
on_user_command $term, $string
-

Called whenever the a user-configured event is being activated (e.g. via +

Called whenever 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).

@@ -788,7 +788,7 @@
on_resize_all_windows $tern, $new_width, $new_height
-

Called just after the new window size has been calculcated, but before +

Called just after the new window size has been calculated, 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.

@@ -817,7 +817,7 @@
on_focus_out $term
-

Called wheneever the window loses keyboard focus, before rxvt-unicode does +

Called whenever the window loses keyboard focus, before rxvt-unicode does focus out processing.

@@ -901,13 +901,13 @@
@urxvt::TERM_INIT
-

All coderefs in this array will be called as methods of the next newly +

All code references 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.

+gets cleared before the code references that were in it are being executed, +so references can push themselves onto it again if they so desire.

-

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

This complements to the perl-eval command line option, but gets executed first.

@@ -951,7 +951,7 @@

Returns all urxvt::term objects that exist in this process, regardless of -wether they are started, being destroyed etc., so be careful. Only term +whether 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).

@@ -1110,7 +1110,7 @@ %urxvt::OPTION. Options not enabled in this binary are not in the hash.

-

Here is a a likely non-exhaustive list of option names, please see the +

Here is a likely non-exhaustive list of option names, please see the source file /src/optinc.h to see the actual list:

@@ -1145,7 +1145,7 @@ terminal is destroyed, so changing options frequently will eat memory.

-

Here is a a likely non-exhaustive list of resource names, not all of which +

Here is a likely non-exhaustive list of resource names, not all of which are supported in every build, please see the source file /src/rsinc.h to see the actual list:

@@ -1502,7 +1502,7 @@
$cursor_is_hidden = $term->hidden_cursor
-

Returns wether the cursor is currently hidden or not.

+

Returns whether the cursor is currently hidden or not.

$view_start = $term->view_start ([$newvalue]) @@ -1647,7 +1647,7 @@
$string = $term->special_decode $text
-

Converts rxvt-unicodes text reprsentation into a perl string. See +

Converts rxvt-unicodes text representation into a perl string. See $term->ROW_t for details.

@@ -1664,7 +1664,7 @@

Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or -synchronous ($sync is true). Also remembers the grab timestampe.

+synchronous ($sync is true). Also remembers the grab timestamp.

$term->allow_events_async @@ -1872,7 +1872,7 @@
$iow = $iow->fd ($fd)
-

Set the filedescriptor (not handle) to watch.

+

Set the file descriptor (not handle) to watch.

$iow = $iow->events ($eventmask) @@ -1892,7 +1892,7 @@
$iow = $iow->stop
-

Stop watching for events on the given filehandle.

+

Stop watching for events on the given file handle.

@@ -1959,7 +1959,7 @@
$pw = $timer->start ($pid)
-

Tells the wqtcher to start watching for process $pid.

+

Tells the watcher to start watching for process $pid.

$pw = $pw->stop @@ -1985,7 +1985,7 @@
>=10 - all called hooks -
>=11 - hook reutrn values +
>=11 - hook return values