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.33 by root, Fri Jan 20 22:49:34 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
147 147
148 The first line tells the selection code to treat the unchanging part 148 The first line tells the selection code to treat the unchanging part
149 of every error message as a selection pattern, and the second line 149 of every error message as a selection pattern, and the second line
150 transforms the message into vi commands to load the file. 150 transforms the message into vi commands to load the file.
151 151
152 readline
153 A support package that tries to make editing with readline easier.
154 At the moment, it reacts to clicking with the left mouse button by
155 trying to move the text cursor to this position. It does so by
156 generating as many cursor-left or cursor-right keypresses as
157 required (the this only works for programs that correctly support
158 wide characters).
159
160 It only works when clicking into the same line (possibly extended
161 over multiple rows) as the text cursor and on the primary screen, to
162 reduce the risk of misinterpreting. The normal selection isn't
163 disabled, so quick successive clicks might interfere with selection
164 creation in harmless ways.
165
152 tabbed 166 tabbed
153 This transforms the terminal into a tabbar with additional 167 This transforms the terminal into a tabbar with additional
154 terminals, that is, it implements what is commonly refered to as 168 terminals, that is, it implements what is commonly refered to as
155 "tabbed terminal". The topmost line displays a "[NEW]" button, 169 "tabbed terminal". The topmost line displays a "[NEW]" button,
156 which, when clicked, will add a new tab, followed by one button per 170 which, when clicked, will add a new tab, followed by one button per
157 tab. 171 tab.
158 172
159 Clicking a button will activate that tab. Pressing Shift-Left and 173 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. 174 Shift-Right will switch to the tab left or right of the current one,
175 while Shift-Down creates a new tab.
161 176
162 mark-urls 177 mark-urls
163 Uses per-line display filtering ("on_line_update") to underline urls 178 Uses per-line display filtering ("on_line_update") to underline urls
164 and make them clickable. When middle-clicked, the program specified 179 and make them clickable. When middle-clicked, the program specified
165 in the resource "urlLauncher" (default "x-www-browser") will be 180 in the resource "urlLauncher" (default "x-www-browser") will be
417 on_focus_out $term 432 on_focus_out $term
418 Called wheneever the window loses keyboard focus, before 433 Called wheneever the window loses keyboard focus, before
419 rxvt-unicode does focus out processing. 434 rxvt-unicode does focus out processing.
420 435
421 on_configure_notify $term, $event 436 on_configure_notify $term, $event
437 on_property_notify $term, $event
422 on_key_press $term, $event, $keysym, $octets 438 on_key_press $term, $event, $keysym, $octets
423 on_key_release $term, $event, $keysym 439 on_key_release $term, $event, $keysym
424 on_button_press $term, $event 440 on_button_press $term, $event
425 on_button_release $term, $event 441 on_button_release $term, $event
426 on_motion_notify $term, $event 442 on_motion_notify $term, $event
430 terminal If the hook returns true, then the even will be ignored by 446 terminal If the hook returns true, then the even will be ignored by
431 rxvt-unicode. 447 rxvt-unicode.
432 448
433 The event is a hash with most values as named by Xlib (see the 449 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 450 XEvent manpage), with the additional members "row" and "col", which
435 are the row and column under the mouse cursor. 451 are the (real, not screen-based) row and column under the mouse
452 cursor.
436 453
437 "on_key_press" additionally receives the string rxvt-unicode would 454 "on_key_press" additionally receives the string rxvt-unicode would
438 output, if any, in locale-specific encoding. 455 output, if any, in locale-specific encoding.
439 456
440 subwindow. 457 subwindow.
757 774
758 Normally its not a good idea to use this function, as programs might 775 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 776 be confused by changes in cursor position or scrolling. Its useful
760 inside a "on_add_lines" hook, though. 777 inside a "on_add_lines" hook, though.
761 778
779 $term->scr_change_screen ($screen)
780 Switch to given screen - 0 primary, 1 secondary.
781
762 $term->cmd_parse ($octets) 782 $term->cmd_parse ($octets)
763 Similar to "scr_add_lines", but the argument must be in the 783 Similar to "scr_add_lines", but the argument must be in the
764 locale-specific encoding of the terminal and can contain command 784 locale-specific encoding of the terminal and can contain command
765 sequences (escape codes) that will be interpreted. 785 sequences (escape codes) that will be interpreted.
766 786
817 $modifiermask = $term->ModNumLockMask 837 $modifiermask = $term->ModNumLockMask
818 Return the modifier masks corresponding to the "ISO Level 3 Shift" 838 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 839 (often AltGr), the meta key (often Alt) and the num lock key, if
820 applicable. 840 applicable.
821 841
842 $screen = $term->current_screen
843 Returns the currently displayed screen (0 primary, 1 secondary).
844
822 $view_start = $term->view_start ([$newvalue]) 845 $view_start = $term->view_start ([$newvalue])
823 Returns the row number of the topmost displayed line. Maximum value 846 Returns the row number of the topmost displayed line. Maximum value
824 is 0, which displays the normal terminal contents. Lower values 847 is 0, which displays the normal terminal contents. Lower values
825 scroll this many lines into the scrollback buffer. 848 scroll this many lines into the scrollback buffer.
826 849
842 line, starting at column $start_col (default 0), which is useful to 865 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 866 replace only parts of a line. The font index in the rendition will
844 automatically be updated. 867 automatically be updated.
845 868
846 $text is in a special encoding: tabs and wide characters that use 869 $text is in a special encoding: tabs and wide characters that use
847 more than one cell when displayed are padded with urxvt::NOCHAR 870 more than one cell when displayed are padded with $urxvt::NOCHAR
848 characters ("chr 65535"). Characters with combining characters and 871 characters. Characters with combining characters and other
849 other characters that do not fit into the normal tetx encoding will 872 characters that do not fit into the normal tetx encoding will be
850 be replaced with characters in the private use area. 873 replaced with characters in the private use area.
851 874
852 You have to obey this encoding when changing text. The advantage is 875 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 876 that "substr" and similar functions work on screen cells and not on
854 characters. 877 characters.
855 878
933 956
934 $term->ungrab 957 $term->ungrab
935 Calls XUngrab for the most recent grab. Is called automatically on 958 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 959 evaluation errors, as it is better to lose the grab in the error
937 case as the session. 960 case as the session.
961
962 $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
963 $atom_name = $term->XGetAtomName ($atom)
964 @atoms = $term->XListProperties ($window)
965 ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
966 $term->XChangeWindowProperty ($window, $property, $type, $format,
967 $octets)
968 $term->XDeleteProperty ($window, $property)
969 $window = $term->DefaultRootWindow
970 $term->XReparentWindow ($window, $parent, [$x, $y])
971 $term->XMapWindow ($window)
972 $term->XUnmapWindow ($window)
973 $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
974 ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
975 $y)
976 $term->XChangeInput ($window, $add_events[, $del_events])
977 Various X or X-related functions. The $term object only serves as
978 the source of the display, otherwise those functions map
979 more-or-less directory onto the X functions of the same name.
938 980
939 The "urxvt::popup" Class 981 The "urxvt::popup" Class
940 $popup->add_title ($title) 982 $popup->add_title ($title)
941 Adds a non-clickable title to the popup. 983 Adds a non-clickable title to the popup.
942 984

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines