--- rxvt-unicode/doc/rxvtperl.3.txt 2006/01/20 16:02:20 1.32 +++ rxvt-unicode/doc/rxvtperl.3.txt 2006/01/22 20:39:56 1.35 @@ -77,8 +77,8 @@ 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 @@ -114,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. @@ -157,7 +175,8 @@ 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. + 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 @@ -419,6 +438,7 @@ 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 @@ -432,7 +452,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. + 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. @@ -759,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 @@ -776,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. @@ -819,6 +847,12 @@ (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 row number of the topmost displayed line. Maximum value is 0, which displays the normal terminal contents. Lower values @@ -844,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. @@ -936,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.