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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:47 2005 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 4.9, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 5.6, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
18 20
19RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
20 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
21 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
22 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
… …
202 204
203 -sr|+sr 205 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 206 Put scrollbar on right/left; resource scrollBar_right.
205 207
206 -st|+st 208 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 209 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 210 resource scrollBar_floating.
209 211
210 -ptab|+ptab 212 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 213 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 214 as actual wide characters in the screen buffer, which makes it
… …
309 311
310 -ssr|+ssr 312 -ssr|+ssr
311 Turn on/off secondary screen scroll (default enabled); resource 313 Turn on/off secondary screen scroll (default enabled); resource
312 secondaryScroll. 314 secondaryScroll.
313 315
314 -xrm *resourcestring* 316 -keysym.*sym* *string*
315 No effect on rxvt-unicode. Simply passes through an argument to be 317 Remap a key symbol. See resource keysym.
316 made available in the instance's argument list. Appears in 318
317 *WM_COMMAND* in some window managers. 319 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window,
321 which enables applications to easily embed a terminal.
322
323 Right now, rxvt will first unmap/map the specified window, so it
324 shouldn't be a top-level window. rxvt will also reconfigure it quite
325 a bit, so don't expect it to keep some specific state. It's best to
326 create an extra subwindow for rxvt and leave it alone.
327
328 The window will not be destroyed when rxvt exits.
329
330 It might be useful to know that rxvt will not close file descriptors
331 passed to it (except for stdin/out/err, of course), so you can use
332 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was
334 used or not.
335
336 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed):
338
339 my $rxvt = new Gtk2::Socket;
340 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &";
343 });
344
345 -pty-fd *fileno*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair
347 but instead use the given filehandle as the tty master. This is
348 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it.
350
351 If this switch is given, rxvt will not create any utmp/wtmp entries
352 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that.
354
355 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd):
357
358 use IO::Pty;
359 use Fcntl;
360
361 my $pty = new IO::Pty;
362 fcntl $pty, F_SETFD, 0; # clear close-on-exec
363 system "rxvt -pty-fd " . (fileno $pty) . "&";
364 close $pty;
365
366 # now communicate with rxvt
367 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" }
318 369
319RESOURCES (available also as long-options) 370RESOURCES (available also as long-options)
320 Note: `rxvt --help' gives a list of all resources (long options) 371 Note: `rxvt --help' gives a list of all resources (long options)
321 compiled into your version. 372 compiled into your version.
322 373
323 There are two different methods that rxvt can use to get the Xresource 374 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources 375 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 376 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 377 XGetDefaults), you can set and change the resources using X11 tools like
327 xset. Many distribution do also load settings from the ~/.Xresources 378 xrdb. Many distribution do also load settings from the ~/.Xresources
328 file when X starts. 379 file when X starts. rxvt will consult the following files/resources in
380 order, with later settings overwriting earlier ones:
381
382 1. system-wide app-defaults file, either locale-dependent OR global
383 2. app-defaults file in $XAPPLRESDIR
384 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
385 4. SCREEN_RESOURCES for the current screen
386 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329 387
330 If compiled with internal Xresources support (i.e. rxvt -h lists 388 If compiled with internal Xresources support (i.e. rxvt -h lists
331 .Xdefaults) then rxvt accepts application defaults set in 389 .Xdefaults) then rxvt accepts application defaults set in
332 XAPPLOADDIR/URxvt (compile-time defined: usually 390 XAPPLOADDIR/URxvt (compile-time defined: usually
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 391 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
423 scrollColor: *colour* 481 scrollColor: *colour*
424 Use the specified colour for the scrollbar [default #B2B2B2]. 482 Use the specified colour for the scrollbar [default #B2B2B2].
425 483
426 troughColor: *colour* 484 troughColor: *colour*
427 Use the specified colour for the scrollbar's trough area [default 485 Use the specified colour for the scrollbar's trough area [default
428 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 486 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
429 487
430 borderColor: *colour* 488 borderColor: *colour*
431 The colour of the border around the text area and between the 489 The colour of the border around the text area and between the
432 scrollbar and the text. 490 scrollbar and the text.
433 491
… …
519 xterm style with 2.20 old word selection, or anything else which 577 xterm style with 2.20 old word selection, or anything else which
520 gives xterm style selection. 578 gives xterm style selection.
521 579
522 scrollstyle: *mode* 580 scrollstyle: *mode*
523 Set scrollbar style to rxvt, plain, next or xterm. plain is the 581 Set scrollbar style to rxvt, plain, next or xterm. plain is the
524 author's favourite.. 582 author's favourite.
525 583
526 title: *string* 584 title: *string*
527 Set window title string, the default title is the command-line 585 Set window title string, the default title is the command-line
528 specified after the -e option, if any, otherwise the application 586 specified after the -e option, if any, otherwise the application
529 name; option -title. 587 name; option -title.
… …
554 print-pipe: *string* 612 print-pipe: *string*
555 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
556 Print to initiate a screen dump to the printer and Ctrl-Print or 614 Print to initiate a screen dump to the printer and Ctrl-Print or
557 Shift-Print to include the scrollback as well. 615 Shift-Print to include the scrollback as well.
558 616
617 The string will be interpreted as if typed into the shell as-is.
618
619 Example:
620
621 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
622
623 This creates a new file in your home directory with the screen
624 contents everytime you hit "Print".
625
559 scrollBar: *boolean* 626 scrollBar: *boolean*
560 True: enable the scrollbar [default]; option -sb. False: disable the 627 True: enable the scrollbar [default]; option -sb. False: disable the
561 scrollbar; option +sb. 628 scrollbar; option +sb.
562 629
563 scrollBar_right: *boolean* 630 scrollBar_right: *boolean*
… …
576 True: scroll to bottom when tty receives output; option -si. False: 643 True: scroll to bottom when tty receives output; option -si. False:
577 do not scroll to bottom when tty receives output; option +si. 644 do not scroll to bottom when tty receives output; option +si.
578 645
579 scrollWithBuffer: *boolean* 646 scrollWithBuffer: *boolean*
580 True: scroll with scrollback buffer when tty receives new lines (and 647 True: scroll with scrollback buffer when tty receives new lines (and
581 scrollTtyOutput is False); option +sw. False: do not scroll with 648 scrollTtyOutput is False); option -sw. False: do not scroll with
582 scrollback buffer when tty recieves new lines; option -sw. 649 scrollback buffer when tty recieves new lines; option +sw.
583 650
584 scrollTtyKeypress: *boolean* 651 scrollTtyKeypress: *boolean*
585 True: scroll to bottom when a non-special key is pressed. Special 652 True: scroll to bottom when a non-special key is pressed. Special
586 keys are those which are intercepted by rxvt-unicode for special 653 keys are those which are intercepted by rxvt-unicode for special
587 handling and are not passed onto the shell; option -sk. False: do 654 handling and are not passed onto the shell; option -sk. False: do
… …
639 pointerColor2: *colour* 706 pointerColor2: *colour*
640 Mouse pointer background colour. 707 Mouse pointer background colour.
641 708
642 pointerBlankDelay: *number* 709 pointerBlankDelay: *number*
643 Specifies number of seconds before blanking the pointer [default 2]. 710 Specifies number of seconds before blanking the pointer [default 2].
711 Use a large number (e.g. 987654321) to effectively disable the
712 timeout.
644 713
645 backspacekey: *string* 714 backspacekey: *string*
646 The string to send when the backspace key is pressed. If set to DEC 715 The string to send when the backspace key is pressed. If set to DEC
647 or unset it will send Delete (code 127) or, if shifted, Backspace 716 or unset it will send Delete (code 127) or, if shifted, Backspace
648 (code 8) - which can be reversed with the appropriate DEC private 717 (code 8) - which can be reversed with the appropriate DEC private
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 808 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 809 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 810 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 811 it can start or end with whitespace.
743 812
813 Please note that you need to double the "\" when using
814 "--enable-xgetdefault", as X itself does it's own de-escaping (you
815 can use "\033" instead of "\e" (and so on), which will work with
816 both Xt and rxvt's own processing).
817
744 You can define a range of keysyms in one shot by providing a 818 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 819 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 820 `/' should be a character not used by the strings.
747 821
748 Its usage can be demonstrated by an example: 822 Its usage can be demonstrated by an example:
749 823
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 824 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 825
752 The above line is equivalent to the following three lines: 826 The above line is equivalent to the following three lines:
753 827
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 828 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 829 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 830 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 831
758 If *string* takes the form of "proto:STRING", the specified STRING 832 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 833 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 834 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 835 Control-Meta-c is being pressed":
762 836
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 837 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
838
839 Due the the large number of modifier combinations, a defined key
840 mapping will match if at *at least* the specified identifiers are
841 being set, and no other key mappings with those and more bits are
842 being defined. That means that defining a key map for "a" will
843 automatically provide definitions for "Meta-a", "Shift-a" and so on,
844 unless some of those are defined mappings themselves.
845
846 Unfortunately, this will override built-in key mappings. For example
847 if you overwrite the "Insert" key you will disable rxvt's
848 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
849 the user-defined keymap using the "builtin:" replacement:
850
851 URxvt.keysym.Insert: <my insert key sequence>
852 URxvt.keysym.S-Insert: builtin:
853
854 The first line defines a mapping for "Insert" and *any* combination
855 of modifiers. The second line re-establishes the default mapping for
856 "Shift-Insert".
764 857
765 The following example will map Control-Meta-1 and Control-Meta-2 to 858 The following example will map Control-Meta-1 and Control-Meta-2 to
766 the fonts "suxuseuro" and "9x15bold", so you cna have some limited 859 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 860 font-switching at runtime:
768 861
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 862 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 863 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 864
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 865 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 866 info):
867
868 URxvt.keysym.M-C-3: command:\033[8;25;80t
869 URxvt.keysym.M-C-4: command:\033[8;48;110t
774 870
775THE SCROLLBAR 871THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 872 Lines of text that scroll off the top of the rxvt window (resource:
777 saveLines) and can be scrolled back using the scrollbar or by 873 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 874 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 884 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 885 key while performing the desired mouse action.
790 886
791 If mouse reporting mode is active, the normal scrollbar actions are 887 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 888 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 889 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 890 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 891 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 892
797TEXT SELECTION AND INSERTION 893TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 894 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 895 *xterm*(1).
800 896
… …
929 rxvt -fg Black -bg White -rv 1025 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 1026 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 1027 on White.
932 1028
933ENVIRONMENT 1029ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1030 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 1031
936 rxvt window and it also uses and sets the environment variable DISPLAY 1032 TERM
937 to specify which display terminal to use. rxvt uses the environment 1033 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 1034 time, via resources or on the commandline.
1035
1036 COLORTERM
1037 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1038 with XPM support, and optionally with the added extension "-mono" to
1039 indicate that rxvt-unicode runs on a monochrome screen.
1040
1041 COLORFGBG
1042 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1043 the colour code used as default foreground/text colour (or the
1044 string "default" to indicate that the default-colour escape sequence
1045 is to be used), "bg" is the colour code used as default background
1046 colour (or the string "default"), and "xpm" is the string "default"
1047 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1048 "slang" can (and do) use this information to optimize screen output.
1049
1050 WINDOWID
1051 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1052 window, which usually has subwindows for the scrollbar, the terminal
1053 window and so on).
1054
1055 TERMINFO
1056 Set to the terminfo directory iff rxvt was configured with
1057 "--with-terminfo=PATH".
1058
1059 DISPLAY
1060 Used by rxvt to connect to the display and set to the correct
1061 display in it's child processes.
1062
1063 SHELL
1064 The shell to be used for command execution, defaults to "/bin/sh".
1065
1066 RXVTPATH
1067 The path where rxvt looks for support files such as menu and xpm
1068 files.
1069
1070 PATH
1071 Used in the same way as "RXVTPATH".
1072
1073 RXVT_SOCKET
1074 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1075
1076 Default $HOME/.rxvt-unicode-*<nodename*.
1077
1078 HOME
1079 Used to locate the default directory for the unix domain socket for
1080 daemon communications and to locate various resource files (such as
1081 ".Xdefaults")
1082
1083 XAPPLRESDIR
1084 Directory where various X resource files are being located.
1085
1086 XENVIRONMENT
1087 If set and accessible, gives the name of a X resource file to be
1088 loaded by rxvt.
939 1089
940FILES 1090FILES
941 /usr/lib/X11/rgb.txt 1091 /usr/lib/X11/rgb.txt
942 Color names. 1092 Color names.
943 1093
944SEE ALSO 1094SEE ALSO
945 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5)
946 1097
947BUGS 1098BUGS
948 Check the BUGS file for an up-to-date list. 1099 Check the BUGS file for an up-to-date list.
949 1100
950 Cursor change support is not yet implemented. 1101 Cursor change support is not yet implemented.
951 1102
952 Click-and-drag doesn't work with X11 mouse report overriding. 1103 Click-and-drag doesn't work with X11 mouse report overriding.
953 1104
954CURRENT PROJECT COORDINATOR 1105CURRENT PROJECT COORDINATOR
955 Project Coordinator 1106 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de 1107 Marc A. Lehmann <rxvt-unicode@schmorp.de>
957 1108
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de
960
961 <http://software.schmorp.de/> 1109 <http://software.schmorp.de/#rxvt-unicode>
962 1110
963AUTHORS 1111AUTHORS
964 John Bovey 1112 John Bovey
965 University of Kent, 1992, wrote the original Xvt. 1113 University of Kent, 1992, wrote the original Xvt.
966 1114
… …
980 1128
981 Geoff Wing <gcw@pobox.com> 1129 Geoff Wing <gcw@pobox.com>
982 Rewrote screen display and text selection routines. Project 1130 Rewrote screen display and text selection routines. Project
983 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1131 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984 1132
985 Marc Alexander Lehmann <rxvt@schmorp.de> 1133 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986 Forked rxvt-unicode, rewrote most of the display code and internal 1134 Forked rxvt-unicode, rewrote most of the display code and internal
987 character handling to store text in unicode, improve xterm 1135 character handling to store text in unicode, improve xterm
988 compatibility and apply numerous other bugfixes and extensions. 1136 compatibility and apply numerous other bugfixes and extensions.
989 1137
990 Project Coordinator (Changes 1.0 -) 1138 Project Coordinator (Changes 1.0 -)

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines