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.14 by root, Mon Feb 14 18:47:54 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.1, 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
… …
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 It might be useful to know that rxvt will not close file descriptors
329 passed to it (except for stdin/out/err, of course), so you can use
330 file descriptors to communicate with the programs within the
331 terminal. This works regardless of wether the "-embed" option was
332 used or not.
318 333
319RESOURCES (available also as long-options) 334RESOURCES (available also as long-options)
320 Note: `rxvt --help' gives a list of all resources (long options) 335 Note: `rxvt --help' gives a list of all resources (long options)
321 compiled into your version. 336 compiled into your version.
322 337
323 There are two different methods that rxvt can use to get the Xresource 338 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources 339 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 340 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 341 XGetDefaults), you can set and change the resources using X11 tools like
327 xset. Many distribution do also load settings from the ~/.Xresources 342 xrdb. Many distribution do also load settings from the ~/.Xresources
328 file when X starts. 343 file when X starts. rxvt will consult the following files/resources in
344 order, with later settings overwriting earlier ones:
345
346 1. system-wide app-defaults file, either locale-dependent OR global
347 2. app-defaults file in $XAPPLRESDIR
348 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
349 4. SCREEN_RESOURCES for the current screen
350 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329 351
330 If compiled with internal Xresources support (i.e. rxvt -h lists 352 If compiled with internal Xresources support (i.e. rxvt -h lists
331 .Xdefaults) then rxvt accepts application defaults set in 353 .Xdefaults) then rxvt accepts application defaults set in
332 XAPPLOADDIR/URxvt (compile-time defined: usually 354 XAPPLOADDIR/URxvt (compile-time defined: usually
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 355 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 761 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 762 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 763 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 764 it can start or end with whitespace.
743 765
766 Please note that you need to double the "\" when using
767 "--enable-xgetdefault", as X itself does it's own de-escaping (you
768 can use "\033" instead of "\e" (and so on), which will work with
769 both Xt and rxvt's own processing).
770
744 You can define a range of keysyms in one shot by providing a 771 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 772 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 773 `/' should be a character not used by the strings.
747 774
748 Its usage can be demonstrated by an example: 775 Its usage can be demonstrated by an example:
749 776
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 777 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 778
752 The above line is equivalent to the following three lines: 779 The above line is equivalent to the following three lines:
753 780
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 781 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 782 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 783 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 784
758 If *string* takes the form of "proto:STRING", the specified STRING 785 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 786 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 787 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 788 Control-Meta-c is being pressed":
762 789
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 790 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
764 791
765 The following example will map Control-Meta-1 and Control-Meta-2 to 792 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 793 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 794 font-switching at runtime:
768 795
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 796 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 797 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 798
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 799 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 800 info):
801
802 URxvt.keysym.M-C-3: command:\033[8;25;80t
803 URxvt.keysym.M-C-4: command:\033[8;48;110t
774 804
775THE SCROLLBAR 805THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 806 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 807 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 808 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 818 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 819 key while performing the desired mouse action.
790 820
791 If mouse reporting mode is active, the normal scrollbar actions are 821 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 822 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 823 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 824 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 825 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 826
797TEXT SELECTION AND INSERTION 827TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 828 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 829 *xterm*(1).
800 830
… …
929 rxvt -fg Black -bg White -rv 959 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 960 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 961 on White.
932 962
933ENVIRONMENT 963ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 964 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 965
936 rxvt window and it also uses and sets the environment variable DISPLAY 966 TERM
937 to specify which display terminal to use. rxvt uses the environment 967 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 968 time, via resources or on the commandline.
969
970 COLORTERM
971 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
972 with XPM support, and optionally with the added extension "-mono" to
973 indicate that rxvt-unicode runs on a monochrome screen.
974
975 COLORFGBG
976 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
977 the colour code used as default foreground/text colour (or the
978 string "default" to indicate that the default-colour escape sequence
979 is to be used), "bg" is the colour code used as default background
980 colour (or the string "default"), and "xpm" is the string "default"
981 if rxvt was compiled with XPM support. Libraries like "ncurses" and
982 "slang" can (and do) use this information to optimize screen output.
983
984 WINDOWID
985 Set to the (decimal) X Window ID of the rxvt window (the toplevel
986 window, which usually has subwindows for the scrollbar, the terminal
987 window and so on).
988
989 TERMINFO
990 Set to the terminfo directory iff rxvt was configured with
991 "--with-terminfo=PATH".
992
993 DISPLAY
994 Used by rxvt to connect to the display and set to the correct
995 display in it's child processes.
996
997 SHELL
998 The shell to be used for command execution, defaults to "/bin/sh".
999
1000 RXVTPATH
1001 The path where rxvt looks for support files such as menu and xpm
1002 files.
1003
1004 PATH
1005 Used in the same way as "RXVTPATH".
1006
1007 RXVT_SOCKET
1008 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1009
1010 Default "$HOME/.rxvt-unicode-<nodename".
1011
1012 HOME
1013 Used to locate the default directory for the unix domain socket for
1014 daemon communications and to locate various resource files (such as
1015 ".Xdefaults")
1016
1017 XAPPLRESDIR
1018 Directory where various X resource files are being located.
1019
1020 XENVIRONMENT
1021 If set and accessible, gives the name of a X resource file to be
1022 loaded by rxvt.
939 1023
940FILES 1024FILES
941 /usr/lib/X11/rgb.txt 1025 /usr/lib/X11/rgb.txt
942 Color names. 1026 Color names.
943 1027
… …
951 1035
952 Click-and-drag doesn't work with X11 mouse report overriding. 1036 Click-and-drag doesn't work with X11 mouse report overriding.
953 1037
954CURRENT PROJECT COORDINATOR 1038CURRENT PROJECT COORDINATOR
955 Project Coordinator 1039 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de 1040 Marc A. Lehmann <rxvt-unicode@schmorp.de>
957 1041
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de
960
961 <http://software.schmorp.de/> 1042 <http://software.schmorp.de/#rxvt-unicode>
962 1043
963AUTHORS 1044AUTHORS
964 John Bovey 1045 John Bovey
965 University of Kent, 1992, wrote the original Xvt. 1046 University of Kent, 1992, wrote the original Xvt.
966 1047
… …
980 1061
981 Geoff Wing <gcw@pobox.com> 1062 Geoff Wing <gcw@pobox.com>
982 Rewrote screen display and text selection routines. Project 1063 Rewrote screen display and text selection routines. Project
983 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1064 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984 1065
985 Marc Alexander Lehmann <rxvt@schmorp.de> 1066 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986 Forked rxvt-unicode, rewrote most of the display code and internal 1067 Forked rxvt-unicode, rewrote most of the display code and internal
987 character handling to store text in unicode, improve xterm 1068 character handling to store text in unicode, improve xterm
988 compatibility and apply numerous other bugfixes and extensions. 1069 compatibility and apply numerous other bugfixes and extensions.
989 1070
990 Project Coordinator (Changes 1.0 -) 1071 Project Coordinator (Changes 1.0 -)

Diff Legend

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