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.56 by root, Tue Jan 31 00:25:16 2006 UTC vs.
Revision 1.60 by root, Thu Jul 6 19:43:21 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.5, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.7, 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
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
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able 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 it's 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 less bugs 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
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
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
159 characters. The first font defines the cell size for characters; 159 characters. The first font defines the cell size for characters;
160 other fonts might be smaller, but not (in general) larger. A 160 other fonts might be smaller, but not (in general) larger. A
161 (hopefully) reasonable default font list is always appended to it. 161 (hopefully) reasonable default font list is always appended to it.
162 See resource font for more details. 162 See resource font for more details.
163 163
164 In short, to specify an X11 core font, just specify it's name or 164 In short, to specify an X11 core font, just specify its name or
165 prefix it with "x:". To specify an XFT-font, you need to prefix it 165 prefix it with "x:". To specify an XFT-font, you need to prefix it
166 with "xft:", e.g.: 166 with "xft:", e.g.:
167 167
168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
357 357
358 -keysym.*sym* *string* 358 -keysym.*sym* *string*
359 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
360 360
361 -embed *windowid* 361 -embed *windowid*
362 Tells rxvt to embed it's windows into an already-existing window, 362 Tells rxvt to embed its windows into an already-existing window,
363 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
364 364
365 Right now, rxvt will first unmap/map the specified window, so it 365 Right now, rxvt will first unmap/map the specified window, so it
366 shouldn't be a top-level window. rxvt will also reconfigure it quite 366 shouldn't be a top-level window. rxvt will also reconfigure it quite
367 a bit, so don't expect it to keep some specific state. It's best to 367 a bit, so don't expect it to keep some specific state. It's best to
888 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
889 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
890 it can start or end with whitespace. 890 it can start or end with whitespace.
891 891
892 Please note that you need to double the "\" in resource files, as 892 Please note that you need to double the "\" in resource files, as
893 Xlib itself does it's own de-escaping (you can use "\033" instead of 893 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 894 "\e" (and so on), which will work with both Xt and rxvt's own
895 processing). 895 processing).
896 896
897 You can define a range of keysyms in one shot by providing a 897 You can define a range of keysyms in one shot by providing a
898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
1088 character codes using the keyboard. It consists of 4 parts. The first 1088 character codes using the keyboard. It consists of 4 parts. The first
1089 part is available rxvt-unicode has been compiled with "--enable-frills", 1089 part is available rxvt-unicode has been compiled with "--enable-frills",
1090 the rest is available when rxvt-unicode was compiled with 1090 the rest is available when rxvt-unicode was compiled with
1091 "--enable-iso14755". 1091 "--enable-iso14755".
1092 1092
1093 * 5.1: Basic method 1093 * 5.1: Basic method
1094
1094 This allows you to enter unicode characters using their hexcode. 1095 This allows you to enter unicode characters using their hexcode.
1095 1096
1096 Start by pressing and holding both "Control" and "Shift", then enter 1097 Start by pressing and holding both "Control" and "Shift", then enter
1097 hex-digits (between one and six). Releasing "Control" and "Shift" 1098 hex-digits (between one and six). Releasing "Control" and "Shift"
1098 will commit the character as if it were typed directly. While 1099 will commit the character as if it were typed directly. While
1104 address, which you cannot type. Fortunately, the card has the e-mail 1105 address, which you cannot type. Fortunately, the card has the e-mail
1105 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1106 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1106 easily by pressing "Control" and "Shift", followed by 1107 easily by pressing "Control" and "Shift", followed by
1107 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1108 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1108 1109
1109 * 5.2: Keyboard symbols entry method 1110 * 5.2: Keyboard symbols entry method
1111
1110 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1111 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1112 1114
1113 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1114 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
1115 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1116 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1117 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1118 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1119 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1120 1122
1121 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1124
1122 While this is implemented already (it's basically the selection 1125 While this is implemented already (it's basically the selection
1123 mechanism), it could be extended by displaying a unicode character 1126 mechanism), it could be extended by displaying a unicode character
1124 map. 1127 map.
1125 1128
1126 * 5.4: Feedback method for identifying displayed characters for later 1129 * 5.4: Feedback method for identifying displayed characters for later
1127 input 1130 input
1131
1128 This method lets you display the unicode character code associated 1132 This method lets you display the unicode character code associated
1129 with characters already displayed. 1133 with characters already displayed.
1130 1134
1131 You enter this mode by holding down "Control" and "Shift" together, 1135 You enter this mode by holding down "Control" and "Shift" together,
1132 then pressing and holding the left mouse button and moving around. 1136 then pressing and holding the left mouse button and moving around.
1151COLORS AND GRAPHICS 1155COLORS AND GRAPHICS
1152 In addition to the default foreground and background colours, rxvt can 1156 In addition to the default foreground and background colours, rxvt can
1153 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1157 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1154 versions of the same). Here is a list of the colours with their names. 1158 versions of the same). Here is a list of the colours with their names.
1155 1159
1156 color0 (black) = Black 1160 color0 (black) = Black
1157 color1 (red) = Red3 1161 color1 (red) = Red3
1158 color2 (green) = Green3 1162 color2 (green) = Green3
1159 color3 (yellow) = Yellow3 1163 color3 (yellow) = Yellow3
1160 color4 (blue) = Blue3 1164 color4 (blue) = Blue3
1161 color5 (magenta) = Magenta3 1165 color5 (magenta) = Magenta3
1162 color6 (cyan) = Cyan3 1166 color6 (cyan) = Cyan3
1163 color7 (white) = AntiqueWhite 1167 color7 (white) = AntiqueWhite
1164 color8 (bright black) = Grey25 1168 color8 (bright black) = Grey25
1165 color9 (bright red) = Red 1169 color9 (bright red) = Red
1166 color10 (bright green) = Green 1170 color10 (bright green) = Green
1167 color11 (bright yellow) = Yellow 1171 color11 (bright yellow) = Yellow
1168 color12 (bright blue) = Blue 1172 color12 (bright blue) = Blue
1169 color13 (bright magenta) = Magenta 1173 color13 (bright magenta) = Magenta
1170 color14 (bright cyan) = Cyan 1174 color14 (bright cyan) = Cyan
1171 color15 (bright white) = White 1175 color15 (bright white) = White
1172 foreground = Black 1176 foreground = Black
1173 background = White 1177 background = White
1174
1175 It is also possible to specify the colour values of foreground, 1178 It is also possible to specify the colour values of foreground,
1176 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1179 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1177 0-15, as a convenient shorthand to reference the colour name of 1180 0-15, as a convenient shorthand to reference the colour name of
1178 color0-color15. 1181 color0-color15.
1182
1183 In addition to the colours defined above, rxvt offers an additional 72
1184 colours. The first 64 of those (with indices 16 to 79) consist of a
1185 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1186 by 8 additional shades of gray (with indices 80 to 87).
1187
1188 Together, all those colours implement the 88 colour xterm colours. Only
1189 the first 16 can be changed using resources currently, the rest can only
1190 be changed via command sequences ("escape codes").
1179 1191
1180 Note that -rv ("reverseVideo: True") simulates reverse video by always 1192 Note that -rv ("reverseVideo: True") simulates reverse video by always
1181 swapping the foreground/background colours. This is in contrast to 1193 swapping the foreground/background colours. This is in contrast to
1182 *xterm*(1) where the colours are only swapped if they have not otherwise 1194 *xterm*(1) where the colours are only swapped if they have not otherwise
1183 been specified. For example, 1195 been specified. For example,
1238 Set to the terminfo directory iff rxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
1239 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
1240 1252
1241 DISPLAY 1253 DISPLAY
1242 Used by rxvt to connect to the display and set to the correct 1254 Used by rxvt to connect to the display and set to the correct
1243 display in it's child processes. 1255 display in its child processes.
1244 1256
1245 SHELL 1257 SHELL
1246 The shell to be used for command execution, defaults to "/bin/sh". 1258 The shell to be used for command execution, defaults to "/bin/sh".
1247 1259
1248 RXVT_SOCKET 1260 RXVT_SOCKET
1272 1284
1273CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1274 Project Coordinator 1286 Project Coordinator
1275 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1276 1288
1277 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1278 1290
1279AUTHORS 1291AUTHORS
1280 John Bovey 1292 John Bovey
1281 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1282 1294

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines