ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.32 by root, Fri Jan 20 16:02:20 2006 UTC vs.
Revision 1.34 by root, Sat Jan 21 19:50:53 2006 UTC

75 options at runtime. 75 options at runtime.
76 76
77 selection-popup (enabled by default) 77 selection-popup (enabled by default)
78 Binds a popup menu to Ctrl-Button3 that lets you convert the 78 Binds a popup menu to Ctrl-Button3 that lets you convert the
79 selection text into various other formats/action (such as uri 79 selection text into various other formats/action (such as uri
80 unescaping, perl evalution, web-browser starting etc.), depending on 80 unescaping, perl evaluation, web-browser starting etc.), depending
81 content. 81 on content.
82 82
83 Other extensions can extend this popup menu by pushing a code 83 Other extensions can extend this popup menu by pushing a code
84 reference onto "@{ $term-"{selection_popup_hook} }>, that is called 84 reference onto "@{ $term-"{selection_popup_hook} }>, that is called
85 whenever the popup is displayed. 85 whenever the popup is displayed.
86 86
112 "End" jumps to the bottom. "Escape" leaves search mode and returns 112 "End" jumps to the bottom. "Escape" leaves search mode and returns
113 to the point where search was started, while "Enter" or "Return" 113 to the point where search was started, while "Enter" or "Return"
114 stay at the current position and additionally stores the first match 114 stay at the current position and additionally stores the first match
115 in the current line into the primary selection. 115 in the current line into the primary selection.
116 116
117 readline (enabled by default)
118 A support package that tries to make editing with readline easier.
119 At the moment, it reacts to clicking with the left mouse button by
120 trying to move the text cursor to this position. It does so by
121 generating as many cursor-left or cursor-right keypresses as
122 required (the this only works for programs that correctly support
123 wide characters).
124
125 To avoid too many false positives, this is only done when:
126
127 - the mouse is on the same (multi-row-) line as the text cursor.
128 - the primary screen is currently being displayed.
129 - the text cursor is visible.
130
131 The normal selection mechanism isn't disabled, so quick successive
132 clicks might interfere with selection creation in harmless ways.
133
117 selection-autotransform 134 selection-autotransform
118 This selection allows you to do automatic transforms on a selection 135 This selection allows you to do automatic transforms on a selection
119 whenever a selection is made. 136 whenever a selection is made.
120 137
121 It works by specifying perl snippets (most useful is a single "s///" 138 It works by specifying perl snippets (most useful is a single "s///"
155 "tabbed terminal". The topmost line displays a "[NEW]" button, 172 "tabbed terminal". The topmost line displays a "[NEW]" button,
156 which, when clicked, will add a new tab, followed by one button per 173 which, when clicked, will add a new tab, followed by one button per
157 tab. 174 tab.
158 175
159 Clicking a button will activate that tab. Pressing Shift-Left and 176 Clicking a button will activate that tab. Pressing Shift-Left and
160 Shift-Right will switch to the tab left or right of the current one. 177 Shift-Right will switch to the tab left or right of the current one,
178 while Shift-Down creates a new tab.
161 179
162 mark-urls 180 mark-urls
163 Uses per-line display filtering ("on_line_update") to underline urls 181 Uses per-line display filtering ("on_line_update") to underline urls
164 and make them clickable. When middle-clicked, the program specified 182 and make them clickable. When middle-clicked, the program specified
165 in the resource "urlLauncher" (default "x-www-browser") will be 183 in the resource "urlLauncher" (default "x-www-browser") will be
417 on_focus_out $term 435 on_focus_out $term
418 Called wheneever the window loses keyboard focus, before 436 Called wheneever the window loses keyboard focus, before
419 rxvt-unicode does focus out processing. 437 rxvt-unicode does focus out processing.
420 438
421 on_configure_notify $term, $event 439 on_configure_notify $term, $event
440 on_property_notify $term, $event
422 on_key_press $term, $event, $keysym, $octets 441 on_key_press $term, $event, $keysym, $octets
423 on_key_release $term, $event, $keysym 442 on_key_release $term, $event, $keysym
424 on_button_press $term, $event 443 on_button_press $term, $event
425 on_button_release $term, $event 444 on_button_release $term, $event
426 on_motion_notify $term, $event 445 on_motion_notify $term, $event
430 terminal If the hook returns true, then the even will be ignored by 449 terminal If the hook returns true, then the even will be ignored by
431 rxvt-unicode. 450 rxvt-unicode.
432 451
433 The event is a hash with most values as named by Xlib (see the 452 The event is a hash with most values as named by Xlib (see the
434 XEvent manpage), with the additional members "row" and "col", which 453 XEvent manpage), with the additional members "row" and "col", which
435 are the row and column under the mouse cursor. 454 are the (real, not screen-based) row and column under the mouse
455 cursor.
436 456
437 "on_key_press" additionally receives the string rxvt-unicode would 457 "on_key_press" additionally receives the string rxvt-unicode would
438 output, if any, in locale-specific encoding. 458 output, if any, in locale-specific encoding.
439 459
440 subwindow. 460 subwindow.
757 777
758 Normally its not a good idea to use this function, as programs might 778 Normally its not a good idea to use this function, as programs might
759 be confused by changes in cursor position or scrolling. Its useful 779 be confused by changes in cursor position or scrolling. Its useful
760 inside a "on_add_lines" hook, though. 780 inside a "on_add_lines" hook, though.
761 781
782 $term->scr_change_screen ($screen)
783 Switch to given screen - 0 primary, 1 secondary.
784
762 $term->cmd_parse ($octets) 785 $term->cmd_parse ($octets)
763 Similar to "scr_add_lines", but the argument must be in the 786 Similar to "scr_add_lines", but the argument must be in the
764 locale-specific encoding of the terminal and can contain command 787 locale-specific encoding of the terminal and can contain command
765 sequences (escape codes) that will be interpreted. 788 sequences (escape codes) that will be interpreted.
766 789
817 $modifiermask = $term->ModNumLockMask 840 $modifiermask = $term->ModNumLockMask
818 Return the modifier masks corresponding to the "ISO Level 3 Shift" 841 Return the modifier masks corresponding to the "ISO Level 3 Shift"
819 (often AltGr), the meta key (often Alt) and the num lock key, if 842 (often AltGr), the meta key (often Alt) and the num lock key, if
820 applicable. 843 applicable.
821 844
845 $screen = $term->current_screen
846 Returns the currently displayed screen (0 primary, 1 secondary).
847
848 $cursor_is_hidden = $term->hidden_cursor
849 Returns wether the cursor is currently hidden or not.
850
822 $view_start = $term->view_start ([$newvalue]) 851 $view_start = $term->view_start ([$newvalue])
823 Returns the row number of the topmost displayed line. Maximum value 852 Returns the row number of the topmost displayed line. Maximum value
824 is 0, which displays the normal terminal contents. Lower values 853 is 0, which displays the normal terminal contents. Lower values
825 scroll this many lines into the scrollback buffer. 854 scroll this many lines into the scrollback buffer.
826 855
842 line, starting at column $start_col (default 0), which is useful to 871 line, starting at column $start_col (default 0), which is useful to
843 replace only parts of a line. The font index in the rendition will 872 replace only parts of a line. The font index in the rendition will
844 automatically be updated. 873 automatically be updated.
845 874
846 $text is in a special encoding: tabs and wide characters that use 875 $text is in a special encoding: tabs and wide characters that use
847 more than one cell when displayed are padded with urxvt::NOCHAR 876 more than one cell when displayed are padded with $urxvt::NOCHAR
848 characters ("chr 65535"). Characters with combining characters and 877 characters. Characters with combining characters and other
849 other characters that do not fit into the normal tetx encoding will 878 characters that do not fit into the normal tetx encoding will be
850 be replaced with characters in the private use area. 879 replaced with characters in the private use area.
851 880
852 You have to obey this encoding when changing text. The advantage is 881 You have to obey this encoding when changing text. The advantage is
853 that "substr" and similar functions work on screen cells and not on 882 that "substr" and similar functions work on screen cells and not on
854 characters. 883 characters.
855 884
933 962
934 $term->ungrab 963 $term->ungrab
935 Calls XUngrab for the most recent grab. Is called automatically on 964 Calls XUngrab for the most recent grab. Is called automatically on
936 evaluation errors, as it is better to lose the grab in the error 965 evaluation errors, as it is better to lose the grab in the error
937 case as the session. 966 case as the session.
967
968 $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
969 $atom_name = $term->XGetAtomName ($atom)
970 @atoms = $term->XListProperties ($window)
971 ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
972 $term->XChangeWindowProperty ($window, $property, $type, $format,
973 $octets)
974 $term->XDeleteProperty ($window, $property)
975 $window = $term->DefaultRootWindow
976 $term->XReparentWindow ($window, $parent, [$x, $y])
977 $term->XMapWindow ($window)
978 $term->XUnmapWindow ($window)
979 $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
980 ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
981 $y)
982 $term->XChangeInput ($window, $add_events[, $del_events])
983 Various X or X-related functions. The $term object only serves as
984 the source of the display, otherwise those functions map
985 more-or-less directory onto the X functions of the same name.
938 986
939 The "urxvt::popup" Class 987 The "urxvt::popup" Class
940 $popup->add_title ($title) 988 $popup->add_title ($title)
941 Adds a non-clickable title to the popup. 989 Adds a non-clickable title to the popup.
942 990

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines