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.60 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 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 7.7, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.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. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 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
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
43 programs force onto its users never made sense to me: You should be able 43 programs force onto its users never made sense to me: You should be able
44 to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 its predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
102 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
103 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
104 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105 105
106 *Please note that transparency of any kind if completely unsupported 106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions!* 107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
108 109
109 -fade *number* 110 -fade *number*
110 Fade the text by the given percentage when focus is lost. Small 111 Fade the text by the given percentage when focus is lost. Small
111 values fade a little only, 100 completely replaces all colours by 112 values fade a little only, 100 completely replaces all colours by
112 the fade colour; resource fading. 113 the fade colour; resource fading.
370 The window will not be destroyed when rxvt exits. 371 The window will not be destroyed when rxvt exits.
371 372
372 It might be useful to know that rxvt will not close file descriptors 373 It might be useful to know that rxvt will not close file descriptors
373 passed to it (except for stdin/out/err, of course), so you can use 374 passed to it (except for stdin/out/err, of course), so you can use
374 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
375 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
376 used or not. 377 used or not.
377 378
378 Here is a short Gtk2-perl snippet that illustrates how this option 379 Here is a short Gtk2-perl snippet that illustrates how this option
379 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
380 381
384 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
385 }); 386 });
386 387
387 -pty-fd *file descriptor* 388 -pty-fd *file descriptor*
388 Tells rxvt NOT to execute any commands or create a new pty/tty pair 389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
389 but instead use the given filehandle as the tty master. This is 390 but instead use the given file descriptor as the tty master. This is
390 useful if you want to drive rxvt as a generic terminal emulator 391 useful if you want to drive rxvt as a generic terminal emulator
391 without having to run a program within it. 392 without having to run a program within it.
392 393
393 If this switch is given, rxvt will not create any utmp/wtmp entries 394 If this switch is given, rxvt will not create any utmp/wtmp entries
394 and will not tinker with pty/tty permissions - you have to do that 395 and will not tinker with pty/tty permissions - you have to do that
622 normal text font will being used for the given style. 623 normal text font will being used for the given style.
623 624
624 intensityStyles: *boolean* 625 intensityStyles: *boolean*
625 When font styles are not enabled, or this option is enabled (True, 626 When font styles are not enabled, or this option is enabled (True,
626 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
627 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
628 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
629 colours are not reachable. 630 colours are not reachable.
630 631
631 selectstyle: *mode* 632 selectstyle: *mode*
632 Set mouse selection style to old which is 2.20, oldword which is 633 Set mouse selection style to old which is 2.20, oldword which is
675 Example: 676 Example:
676 677
677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
678 679
679 This creates a new file in your home directory with the screen 680 This creates a new file in your home directory with the screen
680 contents everytime you hit "Print". 681 contents every time you hit "Print".
681 682
682 scrollBar: *boolean* 683 scrollBar: *boolean*
683 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
684 scrollbar; option +sb. 685 scrollbar; option +sb.
685 686
700 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
701 702
702 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
703 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
704 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
705 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
706 707
707 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
708 True: scroll to bottom when a non-special key is pressed. Special 709 True: scroll to bottom when a non-special key is pressed. Special
709 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
710 handling and are not passed onto the shell; option -sk. False: do 711 handling and are not passed onto the shell; option -sk. False: do
885 886
886 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
888 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
889 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
890 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
891 893
892 Please note that you need to double the "\" in resource files, as 894 Please note that you need to double the "\" in resource files, as
893 Xlib itself does its own de-escaping (you can use "\033" instead of 895 Xlib itself does its own de-escaping (you can use "\033" instead of
894 "\e" (and so on), which will work with both Xt and rxvt's own 896 "\e" (and so on), which will work with both Xt and rxvt's own
895 processing). 897 processing).
896 898
897 You can define a range of keysyms in one shot by providing a 899 You can define a range of keysyms in one shot by providing a
898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
899 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
900 902
901 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
902 904
903 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
965 For example, "default,-selection" will use all the default extension 967 For example, "default,-selection" will use all the default extension
966 except "selection". 968 except "selection".
967 969
968 Extension names can also be followed by an argument in angle 970 Extension names can also be followed by an argument in angle
969 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey 971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
970 for searchable scorllback to Alt/Meta-s). Mentioning the same 972 for searchable scrollback to Alt/Meta-s). Mentioning the same
971 extension multiple times with different arguments will pass multiple 973 extension multiple times with different arguments will pass multiple
972 arguments to the extension. 974 arguments to the extension.
973 975
974 Each extension is looked up in the library directories, loaded if 976 Each extension is looked up in the library directories, loaded if
975 necessary, and bound to the current terminal instance. 977 necessary, and bound to the current terminal instance.
1088 character codes using the keyboard. It consists of 4 parts. The first 1090 character codes using the keyboard. It consists of 4 parts. The first
1089 part is available rxvt-unicode has been compiled with "--enable-frills", 1091 part is available rxvt-unicode has been compiled with "--enable-frills",
1090 the rest is available when rxvt-unicode was compiled with 1092 the rest is available when rxvt-unicode was compiled with
1091 "--enable-iso14755". 1093 "--enable-iso14755".
1092 1094
1093 * 5.1: Basic method 1095 * 5.1: Basic method
1094
1095 This allows you to enter unicode characters using their hexcode. 1096 This allows you to enter unicode characters using their hexcode.
1096 1097
1097 Start by pressing and holding both "Control" and "Shift", then enter 1098 Start by pressing and holding both "Control" and "Shift", then enter
1098 hex-digits (between one and six). Releasing "Control" and "Shift" 1099 hex-digits (between one and six). Releasing "Control" and "Shift"
1099 will commit the character as if it were typed directly. While 1100 will commit the character as if it were typed directly. While
1105 address, which you cannot type. Fortunately, the card has the e-mail 1106 address, which you cannot type. Fortunately, the card has the e-mail
1106 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1107 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1107 easily by pressing "Control" and "Shift", followed by 1108 easily by pressing "Control" and "Shift", followed by
1108 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1109 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1109 1110
1110 * 5.2: Keyboard symbols entry method 1111 * 5.2: Keyboard symbols entry method
1111
1112 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1113 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1114 1114
1115 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1116 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
1118 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1119 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1120 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1121 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1122 1122
1123 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1124
1125 While this is implemented already (it's basically the selection 1124 While this is implemented already (it's basically the selection
1126 mechanism), it could be extended by displaying a unicode character 1125 mechanism), it could be extended by displaying a unicode character
1127 map. 1126 map.
1128 1127
1129 * 5.4: Feedback method for identifying displayed characters for later 1128 * 5.4: Feedback method for identifying displayed characters for later
1130 input 1129 input
1131
1132 This method lets you display the unicode character code associated 1130 This method lets you display the unicode character code associated
1133 with characters already displayed. 1131 with characters already displayed.
1134 1132
1135 You enter this mode by holding down "Control" and "Shift" together, 1133 You enter this mode by holding down "Control" and "Shift" together,
1136 then pressing and holding the left mouse button and moving around. 1134 then pressing and holding the left mouse button and moving around.
1155COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
1156 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
1157 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1155 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1158 versions of the same). Here is a list of the colours with their names. 1156 versions of the same). Here is a list of the colours with their names.
1159 1157
1160 color0 (black) = Black 1158 color0 (black) = Black
1161 color1 (red) = Red3 1159 color1 (red) = Red3
1162 color2 (green) = Green3 1160 color2 (green) = Green3
1163 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
1164 color4 (blue) = Blue3 1162 color4 (blue) = Blue3
1165 color5 (magenta) = Magenta3 1163 color5 (magenta) = Magenta3
1166 color6 (cyan) = Cyan3 1164 color6 (cyan) = Cyan3
1167 color7 (white) = AntiqueWhite 1165 color7 (white) = AntiqueWhite
1168 color8 (bright black) = Grey25 1166 color8 (bright black) = Grey25
1169 color9 (bright red) = Red 1167 color9 (bright red) = Red
1170 color10 (bright green) = Green 1168 color10 (bright green) = Green
1171 color11 (bright yellow) = Yellow 1169 color11 (bright yellow) = Yellow
1172 color12 (bright blue) = Blue 1170 color12 (bright blue) = Blue
1173 color13 (bright magenta) = Magenta 1171 color13 (bright magenta) = Magenta
1174 color14 (bright cyan) = Cyan 1172 color14 (bright cyan) = Cyan
1175 color15 (bright white) = White 1173 color15 (bright white) = White
1176 foreground = Black 1174 foreground = Black
1177 background = White 1175 background = White
1176
1178 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
1179 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1180 0-15, as a convenient shorthand to reference the colour name of 1179 0-15, as a convenient shorthand to reference the colour name of
1181 color0-color15. 1180 color0-color15.
1182 1181
1223ENVIRONMENT 1222ENVIRONMENT
1224 rxvt sets and/or uses the following environment variables: 1223 rxvt sets and/or uses the following environment variables:
1225 1224
1226 TERM 1225 TERM
1227 Normally set to "rxvt-unicode", unless overwritten at configure 1226 Normally set to "rxvt-unicode", unless overwritten at configure
1228 time, via resources or on the commandline. 1227 time, via resources or on the command line.
1229 1228
1230 COLORTERM 1229 COLORTERM
1231 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1232 with XPM support, and optionally with the added extension "-mono" to 1231 with XPM support, and optionally with the added extension "-mono" to
1233 indicate that rxvt-unicode runs on a monochrome screen. 1232 indicate that rxvt-unicode runs on a monochrome screen.
1234 1233
1235 COLORFGBG 1234 COLORFGBG
1236 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines