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.35 by root, Sun Jan 22 20:39:56 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 tty is in ICANON state.
128 - the text cursor is visible.
129 - the primary screen is currently being displayed.
130 - the mouse is on the same (multi-row-) line as the text cursor.
131
132 The normal selection mechanism isn't disabled, so quick successive
133 clicks might interfere with selection creation in harmless ways.
134
117 selection-autotransform 135 selection-autotransform
118 This selection allows you to do automatic transforms on a selection 136 This selection allows you to do automatic transforms on a selection
119 whenever a selection is made. 137 whenever a selection is made.
120 138
121 It works by specifying perl snippets (most useful is a single "s///" 139 It works by specifying perl snippets (most useful is a single "s///"
155 "tabbed terminal". The topmost line displays a "[NEW]" button, 173 "tabbed terminal". The topmost line displays a "[NEW]" button,
156 which, when clicked, will add a new tab, followed by one button per 174 which, when clicked, will add a new tab, followed by one button per
157 tab. 175 tab.
158 176
159 Clicking a button will activate that tab. Pressing Shift-Left and 177 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. 178 Shift-Right will switch to the tab left or right of the current one,
179 while Shift-Down creates a new tab.
161 180
162 mark-urls 181 mark-urls
163 Uses per-line display filtering ("on_line_update") to underline urls 182 Uses per-line display filtering ("on_line_update") to underline urls
164 and make them clickable. When middle-clicked, the program specified 183 and make them clickable. When middle-clicked, the program specified
165 in the resource "urlLauncher" (default "x-www-browser") will be 184 in the resource "urlLauncher" (default "x-www-browser") will be
417 on_focus_out $term 436 on_focus_out $term
418 Called wheneever the window loses keyboard focus, before 437 Called wheneever the window loses keyboard focus, before
419 rxvt-unicode does focus out processing. 438 rxvt-unicode does focus out processing.
420 439
421 on_configure_notify $term, $event 440 on_configure_notify $term, $event
441 on_property_notify $term, $event
422 on_key_press $term, $event, $keysym, $octets 442 on_key_press $term, $event, $keysym, $octets
423 on_key_release $term, $event, $keysym 443 on_key_release $term, $event, $keysym
424 on_button_press $term, $event 444 on_button_press $term, $event
425 on_button_release $term, $event 445 on_button_release $term, $event
426 on_motion_notify $term, $event 446 on_motion_notify $term, $event
430 terminal If the hook returns true, then the even will be ignored by 450 terminal If the hook returns true, then the even will be ignored by
431 rxvt-unicode. 451 rxvt-unicode.
432 452
433 The event is a hash with most values as named by Xlib (see the 453 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 454 XEvent manpage), with the additional members "row" and "col", which
435 are the row and column under the mouse cursor. 455 are the (real, not screen-based) row and column under the mouse
456 cursor.
436 457
437 "on_key_press" additionally receives the string rxvt-unicode would 458 "on_key_press" additionally receives the string rxvt-unicode would
438 output, if any, in locale-specific encoding. 459 output, if any, in locale-specific encoding.
439 460
440 subwindow. 461 subwindow.
757 778
758 Normally its not a good idea to use this function, as programs might 779 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 780 be confused by changes in cursor position or scrolling. Its useful
760 inside a "on_add_lines" hook, though. 781 inside a "on_add_lines" hook, though.
761 782
783 $term->scr_change_screen ($screen)
784 Switch to given screen - 0 primary, 1 secondary.
785
762 $term->cmd_parse ($octets) 786 $term->cmd_parse ($octets)
763 Similar to "scr_add_lines", but the argument must be in the 787 Similar to "scr_add_lines", but the argument must be in the
764 locale-specific encoding of the terminal and can contain command 788 locale-specific encoding of the terminal and can contain command
765 sequences (escape codes) that will be interpreted. 789 sequences (escape codes) that will be interpreted.
766 790
773 $old_events = $term->pty_ev_events ([$new_events]) 797 $old_events = $term->pty_ev_events ([$new_events])
774 Replaces the event mask of the pty watcher by the given event mask. 798 Replaces the event mask of the pty watcher by the given event mask.
775 Can be used to suppress input and output handling to the pty/tty. 799 Can be used to suppress input and output handling to the pty/tty.
776 See the description of "urxvt::timer->events". Make sure to always 800 See the description of "urxvt::timer->events". Make sure to always
777 restore the previous value. 801 restore the previous value.
802
803 $fd = $term->pty_fd
804 Returns the master file descriptor for the pty in use, or -1 if no
805 pty is used.
778 806
779 $windowid = $term->parent 807 $windowid = $term->parent
780 Return the window id of the toplevel window. 808 Return the window id of the toplevel window.
781 809
782 $windowid = $term->vt 810 $windowid = $term->vt
817 $modifiermask = $term->ModNumLockMask 845 $modifiermask = $term->ModNumLockMask
818 Return the modifier masks corresponding to the "ISO Level 3 Shift" 846 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 847 (often AltGr), the meta key (often Alt) and the num lock key, if
820 applicable. 848 applicable.
821 849
850 $screen = $term->current_screen
851 Returns the currently displayed screen (0 primary, 1 secondary).
852
853 $cursor_is_hidden = $term->hidden_cursor
854 Returns wether the cursor is currently hidden or not.
855
822 $view_start = $term->view_start ([$newvalue]) 856 $view_start = $term->view_start ([$newvalue])
823 Returns the row number of the topmost displayed line. Maximum value 857 Returns the row number of the topmost displayed line. Maximum value
824 is 0, which displays the normal terminal contents. Lower values 858 is 0, which displays the normal terminal contents. Lower values
825 scroll this many lines into the scrollback buffer. 859 scroll this many lines into the scrollback buffer.
826 860
842 line, starting at column $start_col (default 0), which is useful to 876 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 877 replace only parts of a line. The font index in the rendition will
844 automatically be updated. 878 automatically be updated.
845 879
846 $text is in a special encoding: tabs and wide characters that use 880 $text is in a special encoding: tabs and wide characters that use
847 more than one cell when displayed are padded with urxvt::NOCHAR 881 more than one cell when displayed are padded with $urxvt::NOCHAR
848 characters ("chr 65535"). Characters with combining characters and 882 (chr 65535) characters. Characters with combining characters and
849 other characters that do not fit into the normal tetx encoding will 883 other characters that do not fit into the normal tetx encoding will
850 be replaced with characters in the private use area. 884 be replaced with characters in the private use area.
851 885
852 You have to obey this encoding when changing text. The advantage is 886 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 887 that "substr" and similar functions work on screen cells and not on
933 967
934 $term->ungrab 968 $term->ungrab
935 Calls XUngrab for the most recent grab. Is called automatically on 969 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 970 evaluation errors, as it is better to lose the grab in the error
937 case as the session. 971 case as the session.
972
973 $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
974 $atom_name = $term->XGetAtomName ($atom)
975 @atoms = $term->XListProperties ($window)
976 ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
977 $term->XChangeWindowProperty ($window, $property, $type, $format,
978 $octets)
979 $term->XDeleteProperty ($window, $property)
980 $window = $term->DefaultRootWindow
981 $term->XReparentWindow ($window, $parent, [$x, $y])
982 $term->XMapWindow ($window)
983 $term->XUnmapWindow ($window)
984 $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
985 ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
986 $y)
987 $term->XChangeInput ($window, $add_events[, $del_events])
988 Various X or X-related functions. The $term object only serves as
989 the source of the display, otherwise those functions map
990 more-or-less directory onto the X functions of the same name.
938 991
939 The "urxvt::popup" Class 992 The "urxvt::popup" Class
940 $popup->add_title ($title) 993 $popup->add_title ($title)
941 Adds a non-clickable title to the popup. 994 Adds a non-clickable title to the popup.
942 995

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines