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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.11 by root, Fri Feb 11 18:14:07 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.0, 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
316 -keysym.*sym*: *string*
317 Remap a key symbol. See resource keysym.
318
314 -xrm *resourcestring* 319 -xrm *resourcestring*
315 No effect on rxvt-unicode. Simply passes through an argument to be 320 No effect on rxvt-unicode. Simply passes through an argument to be
316 made available in the instance's argument list. Appears in 321 made available in the instance's argument list. Appears in
317 *WM_COMMAND* in some window managers. 322 *WM_COMMAND* in some window managers.
318 323
… …
322 327
323 There are two different methods that rxvt can use to get the Xresource 328 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources 329 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 330 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 331 XGetDefaults), you can set and change the resources using X11 tools like
327 xset. Many distribution do also load settings from the ~/.Xresources 332 xrdb. Many distribution do also load settings from the ~/.Xresources
328 file when X starts. 333 file when X starts. rxvt will consult the following files/resources in
334 order, with later settings overwriting earlier ones:
335
336 1. system-wide app-defaults file, either locale-dependent OR global
337 2. app-defaults file in $XAPPLRESDIR
338 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
339 4. SCREEN_RESOURCES for the current screen
340 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329 341
330 If compiled with internal Xresources support (i.e. rxvt -h lists 342 If compiled with internal Xresources support (i.e. rxvt -h lists
331 .Xdefaults) then rxvt accepts application defaults set in 343 .Xdefaults) then rxvt accepts application defaults set in
332 XAPPLOADDIR/URxvt (compile-time defined: usually 344 XAPPLOADDIR/URxvt (compile-time defined: usually
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 345 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 751 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 752 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 753 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 754 it can start or end with whitespace.
743 755
756 Please note that you need to double the "\" when using
757 "--enable-xgetdefault", as X itself does it's own de-escaping (you
758 can use "\033" instead of "\e" (and so on), which will work with
759 both Xt and rxvt's own processing).
760
744 You can define a range of keysyms in one shot by providing a 761 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 762 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 763 `/' should be a character not used by the strings.
747 764
748 Its usage can be demonstrated by an example: 765 Its usage can be demonstrated by an example:
749 766
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 767 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 768
752 The above line is equivalent to the following three lines: 769 The above line is equivalent to the following three lines:
753 770
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 771 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 772 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 773 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 774
758 If *string* takes the form of "proto:STRING", the specified STRING 775 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 776 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 777 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 778 Control-Meta-c is being pressed":
762 779
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 780 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
764 781
765 The following example will map Control-Meta-1 and Control-Meta-2 to 782 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 783 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 784 font-switching at runtime:
768 785
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 786 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 787 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 788
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 789 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 790 info):
791
792 URxvt.keysym.M-C-3: command:\033[8;25;80t
793 URxvt.keysym.M-C-4: command:\033[8;48;110t
774 794
775THE SCROLLBAR 795THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 796 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 797 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 798 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 808 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 809 key while performing the desired mouse action.
790 810
791 If mouse reporting mode is active, the normal scrollbar actions are 811 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 812 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 813 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 814 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 815 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 816
797TEXT SELECTION AND INSERTION 817TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 818 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 819 *xterm*(1).
800 820
… …
929 rxvt -fg Black -bg White -rv 949 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 950 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 951 on White.
932 952
933ENVIRONMENT 953ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 954 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 955
936 rxvt window and it also uses and sets the environment variable DISPLAY 956 TERM
937 to specify which display terminal to use. rxvt uses the environment 957 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 958 time, via resources or on the commandline.
959
960 COLORTERM
961 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
962 with XPM support, and optionally with the added extension "-mono" to
963 indicate that rxvt-unicode runs on a monochrome screen.
964
965 COLORFGBG
966 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
967 the colour code used as default foreground/text colour (or the
968 string "default" to indicate that the default-colour escape sequence
969 is to be used), "bg" is the colour code used as default background
970 colour (or the string "default"), and "xpm" is the string "default"
971 if rxvt was compiled with XPM support. Libraries like "slang" can
972 (and do) use this information to optimize screen output.
973
974 WINDOWID
975 Set to the (decimal) X Window ID of the rxvt window (the toplevel
976 window, which usually has subwindows for the scrollbar, the terminal
977 window and so on).
978
979 TERMINFO
980 Set to the terminfo directory iff rxvt was configured with
981 "--with-terminfo=PATH".
982
983 DISPLAY
984 Used by rxvt to connect to the display and set to the correct
985 display in it's child processes.
986
987 SHELL
988 The shell to be used for command execution, defaults to "/bin/sh".
989
990 RXVTPATH
991 The path where rxvt looks for support files such as menu and xpm
992 files.
993
994 PATH
995 Used in the same way as "RXVTPATH".
996
997 RXVT_SOCKET
998 The unix domain socket path used by rxvtc(1) and rxvtd(1).
999
1000 Default "$HOME/.rxvt-unicode-<nodename".
1001
1002 HOME
1003 Used to locate the default directory for the unix domain socket for
1004 daemon communications and to locate various resource files (such as
1005 ".Xdefaults")
1006
1007 XAPPLRESDIR
1008 Directory where various X resource files are being located.
1009
1010 XENVIRONMENT
1011 If set and accessible, gives the name of a X resource file to be
1012 loaded by rxvt.
939 1013
940FILES 1014FILES
941 /usr/lib/X11/rgb.txt 1015 /usr/lib/X11/rgb.txt
942 Color names. 1016 Color names.
943 1017
… …
951 1025
952 Click-and-drag doesn't work with X11 mouse report overriding. 1026 Click-and-drag doesn't work with X11 mouse report overriding.
953 1027
954CURRENT PROJECT COORDINATOR 1028CURRENT PROJECT COORDINATOR
955 Project Coordinator 1029 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de
957
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de 1030 Marc A. Lehmann rxvt@schmorp.de
960 1031
961 <http://software.schmorp.de/> 1032 <http://software.schmorp.de/>
962 1033
963AUTHORS 1034AUTHORS

Diff Legend

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