… | |
… | |
4 | |
4 | |
5 | SYNOPSIS |
5 | SYNOPSIS |
6 | rxvt [options] [-e command [ args ]] |
6 | rxvt [options] [-e command [ args ]] |
7 | |
7 | |
8 | DESCRIPTION |
8 | DESCRIPTION |
9 | rxvt-unicode, version 7.3, 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 | |
… | |
… | |
85 | Attempt to open a window on the named X display (-d still |
85 | Attempt to open a window on the named X display (-d still |
86 | respected). In the absence of this option, the display specified by |
86 | respected). In the absence of this option, the display specified by |
87 | the DISPLAY environment variable is used. |
87 | the DISPLAY environment variable is used. |
88 | |
88 | |
89 | -depth *bitdepth* |
89 | -depth *bitdepth* |
90 | Compile *frills*: Attempt to find a visual with the given bit depth; |
90 | Compile *xft*: Attempt to find a visual with the given bit depth; |
91 | resource depth. |
91 | resource depth. |
92 | |
92 | |
93 | -geometry *geom* |
93 | -geometry *geom* |
94 | Window geometry (-g still respected); resource geometry. |
94 | Window geometry (-g still respected); resource geometry. |
95 | |
95 | |
… | |
… | |
100 | Turn on/off jump scrolling; resource jumpScroll. |
100 | Turn on/off jump scrolling; resource jumpScroll. |
101 | |
101 | |
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 | |
|
|
106 | *Please note that transparency of any kind if completely unsupported |
|
|
107 | by the author. Don't bug him with installation questions!* |
105 | |
108 | |
106 | -fade *number* |
109 | -fade *number* |
107 | Fade the text by the given percentage when focus is lost. Small |
110 | Fade the text by the given percentage when focus is lost. Small |
108 | values fade a little only, 100 completely replaces all colours by |
111 | values fade a little only, 100 completely replaces all colours by |
109 | the fade colour; resource fading. |
112 | the fade colour; resource fading. |
110 | |
113 | |
111 | -fadecolor *colour* |
114 | -fadecolor *colour* |
112 | Fade to this colour when fading is used (see -fade). The default |
115 | Fade to this colour when fading is used (see -fade). The default |
113 | colour is black. resource fadeColor. |
116 | colour is opaque black. resource fadeColor. |
114 | |
117 | |
115 | -tint *colour* |
118 | -tint *colour* |
116 | Tint the transparent background pixmap with the given colour when |
119 | Tint the transparent background pixmap with the given colour when |
117 | transparency is enabled with -tr or -ip. This only works for |
120 | transparency is enabled with -tr or -ip. This only works for |
118 | non-tiled backgrounds, currently. See also the -sh option that can |
121 | non-tiled backgrounds, currently. See also the -sh option that can |
… | |
… | |
156 | characters. The first font defines the cell size for characters; |
159 | characters. The first font defines the cell size for characters; |
157 | other fonts might be smaller, but not (in general) larger. A |
160 | other fonts might be smaller, but not (in general) larger. A |
158 | (hopefully) reasonable default font list is always appended to it. |
161 | (hopefully) reasonable default font list is always appended to it. |
159 | See resource font for more details. |
162 | See resource font for more details. |
160 | |
163 | |
161 | 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 |
162 | 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 |
163 | with "xft:", e.g.: |
166 | with "xft:", e.g.: |
164 | |
167 | |
165 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
168 | rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
166 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
169 | rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
354 | |
357 | |
355 | -keysym.*sym* *string* |
358 | -keysym.*sym* *string* |
356 | Remap a key symbol. See resource keysym. |
359 | Remap a key symbol. See resource keysym. |
357 | |
360 | |
358 | -embed *windowid* |
361 | -embed *windowid* |
359 | Tells rxvt to embed it's windows into an already-existing window, |
362 | Tells rxvt to embed its windows into an already-existing window, |
360 | which enables applications to easily embed a terminal. |
363 | which enables applications to easily embed a terminal. |
361 | |
364 | |
362 | 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 |
363 | 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 |
364 | 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 |
… | |
… | |
437 | settings. The following resources are supported (you might want to check |
440 | settings. The following resources are supported (you might want to check |
438 | the rxvtperl(3) manpage for additional settings by perl extensions not |
441 | the rxvtperl(3) manpage for additional settings by perl extensions not |
439 | documented here): |
442 | documented here): |
440 | |
443 | |
441 | depth: *bitdepth* |
444 | depth: *bitdepth* |
442 | Compile *frills*: Attempt to find a visual with the given bit depth; |
445 | Compile *xft*: Attempt to find a visual with the given bit depth; |
443 | option -depth. |
446 | option -depth. |
444 | |
447 | |
445 | geometry: *geom* |
448 | geometry: *geom* |
446 | Create the window with the specified X window geometry [default |
449 | Create the window with the specified X window geometry [default |
447 | 80x24]; option -geometry. |
450 | 80x24]; option -geometry. |
… | |
… | |
509 | |
512 | |
510 | inheritPixmap: *boolean* |
513 | inheritPixmap: *boolean* |
511 | True: make the background inherit the parent windows' pixmap, giving |
514 | True: make the background inherit the parent windows' pixmap, giving |
512 | artificial transparency. False: do not inherit the parent windows' |
515 | artificial transparency. False: do not inherit the parent windows' |
513 | pixmap. |
516 | pixmap. |
|
|
517 | |
|
|
518 | *Please note that transparency of any kind if completely unsupported |
|
|
519 | by the author. Don't bug him with installation questions!* |
514 | |
520 | |
515 | fading: *number* |
521 | fading: *number* |
516 | Fade the text by the given percentage when focus is lost; option |
522 | Fade the text by the given percentage when focus is lost; option |
517 | -fade. |
523 | -fade. |
518 | |
524 | |
… | |
… | |
882 | "\000": octal number) or verbatim control characters ("^?": delete, |
888 | "\000": octal number) or verbatim control characters ("^?": delete, |
883 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
889 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
884 | it can start or end with whitespace. |
890 | it can start or end with whitespace. |
885 | |
891 | |
886 | 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 |
887 | 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 |
888 | "\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 |
889 | processing). |
895 | processing). |
890 | |
896 | |
891 | 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 |
892 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
898 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
… | |
… | |
1082 | 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 |
1083 | part is available rxvt-unicode has been compiled with "--enable-frills", |
1089 | part is available rxvt-unicode has been compiled with "--enable-frills", |
1084 | the rest is available when rxvt-unicode was compiled with |
1090 | the rest is available when rxvt-unicode was compiled with |
1085 | "--enable-iso14755". |
1091 | "--enable-iso14755". |
1086 | |
1092 | |
1087 | * 5.1: Basic method |
1093 | * 5.1: Basic method |
|
|
1094 | |
1088 | This allows you to enter unicode characters using their hexcode. |
1095 | This allows you to enter unicode characters using their hexcode. |
1089 | |
1096 | |
1090 | Start by pressing and holding both "Control" and "Shift", then enter |
1097 | Start by pressing and holding both "Control" and "Shift", then enter |
1091 | hex-digits (between one and six). Releasing "Control" and "Shift" |
1098 | hex-digits (between one and six). Releasing "Control" and "Shift" |
1092 | will commit the character as if it were typed directly. While |
1099 | will commit the character as if it were typed directly. While |
… | |
… | |
1098 | 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 |
1099 | 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 |
1100 | easily by pressing "Control" and "Shift", followed by |
1107 | easily by pressing "Control" and "Shift", followed by |
1101 | "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. |
1102 | |
1109 | |
1103 | * 5.2: Keyboard symbols entry method |
1110 | * 5.2: Keyboard symbols entry method |
|
|
1111 | |
1104 | This mode lets you input characters representing the keycap symbols |
1112 | This mode lets you input characters representing the keycap symbols |
1105 | of your keyboard, if representable in the current locale encoding. |
1113 | of your keyboard, if representable in the current locale encoding. |
1106 | |
1114 | |
1107 | Start by pressing "Control" and "Shift" together, then releasing |
1115 | Start by pressing "Control" and "Shift" together, then releasing |
1108 | 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 |
1109 | not invoke it's usual function but instead will insert the |
1117 | not invoke its usual function but instead will insert the |
1110 | corresponding keycap symbol. The symbol will only be entered when |
1118 | corresponding keycap symbol. The symbol will only be entered when |
1111 | the key has been released, otherwise pressing e.g. "Shift" would |
1119 | the key has been released, otherwise pressing e.g. "Shift" would |
1112 | enter the symbol for "ISO Level 2 Switch", although your intention |
1120 | enter the symbol for "ISO Level 2 Switch", although your intention |
1113 | might have been to enter a reverse tab (Shift-Tab). |
1121 | might have been to enter a reverse tab (Shift-Tab). |
1114 | |
1122 | |
1115 | * 5.3: Screen-selection entry method |
1123 | * 5.3: Screen-selection entry method |
|
|
1124 | |
1116 | While this is implemented already (it's basically the selection |
1125 | While this is implemented already (it's basically the selection |
1117 | mechanism), it could be extended by displaying a unicode character |
1126 | mechanism), it could be extended by displaying a unicode character |
1118 | map. |
1127 | map. |
1119 | |
1128 | |
1120 | * 5.4: Feedback method for identifying displayed characters for later |
1129 | * 5.4: Feedback method for identifying displayed characters for later |
1121 | input |
1130 | input |
|
|
1131 | |
1122 | This method lets you display the unicode character code associated |
1132 | This method lets you display the unicode character code associated |
1123 | with characters already displayed. |
1133 | with characters already displayed. |
1124 | |
1134 | |
1125 | You enter this mode by holding down "Control" and "Shift" together, |
1135 | You enter this mode by holding down "Control" and "Shift" together, |
1126 | then pressing and holding the left mouse button and moving around. |
1136 | then pressing and holding the left mouse button and moving around. |
… | |
… | |
1143 | setgid to root or to some other group on others. |
1153 | setgid to root or to some other group on others. |
1144 | |
1154 | |
1145 | COLORS AND GRAPHICS |
1155 | COLORS AND GRAPHICS |
1146 | In addition to the default foreground and background colours, rxvt can |
1156 | In addition to the default foreground and background colours, rxvt can |
1147 | 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 |
1148 | versions of the same). Here is a list of the colours with their rgb.txt |
1158 | versions of the same). Here is a list of the colours with their names. |
1149 | names. |
|
|
1150 | |
1159 | |
1151 | color0 (black) = Black |
1160 | color0 (black) = Black |
1152 | color1 (red) = Red3 |
1161 | color1 (red) = Red3 |
1153 | color2 (green) = Green3 |
1162 | color2 (green) = Green3 |
1154 | color3 (yellow) = Yellow3 |
1163 | color3 (yellow) = Yellow3 |
1155 | color4 (blue) = Blue3 |
1164 | color4 (blue) = Blue3 |
1156 | color5 (magenta) = Magenta3 |
1165 | color5 (magenta) = Magenta3 |
1157 | color6 (cyan) = Cyan3 |
1166 | color6 (cyan) = Cyan3 |
1158 | color7 (white) = AntiqueWhite |
1167 | color7 (white) = AntiqueWhite |
1159 | color8 (bright black) = Grey25 |
1168 | color8 (bright black) = Grey25 |
1160 | color9 (bright red) = Red |
1169 | color9 (bright red) = Red |
1161 | color10 (bright green) = Green |
1170 | color10 (bright green) = Green |
1162 | color11 (bright yellow) = Yellow |
1171 | color11 (bright yellow) = Yellow |
1163 | color12 (bright blue) = Blue |
1172 | color12 (bright blue) = Blue |
1164 | color13 (bright magenta) = Magenta |
1173 | color13 (bright magenta) = Magenta |
1165 | color14 (bright cyan) = Cyan |
1174 | color14 (bright cyan) = Cyan |
1166 | color15 (bright white) = White |
1175 | color15 (bright white) = White |
1167 | foreground = Black |
1176 | foreground = Black |
1168 | background = White |
1177 | background = White |
1169 | |
|
|
1170 | It is also possible to specify the colour values of foreground, |
1178 | It is also possible to specify the colour values of foreground, |
1171 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1179 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1172 | 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 |
1173 | color0-color15. |
1181 | color0-color15. |
1174 | |
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"). |
|
|
1191 | |
1175 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1192 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1176 | swapping the foreground/background colours. This is in contrast to |
1193 | swapping the foreground/background colours. This is in contrast to |
1177 | *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 |
1178 | been specified. For example, |
1195 | been specified. For example, |
1179 | |
1196 | |
1180 | rxvt -fg Black -bg White -rv |
1197 | rxvt -fg Black -bg White -rv |
1181 | would yield White on Black, while on *xterm*(1) it would yield Black |
1198 | would yield White on Black, while on *xterm*(1) it would yield Black |
1182 | on White. |
1199 | on White. |
|
|
1200 | |
|
|
1201 | ALPHA CHANNEL SUPPORT |
|
|
1202 | If Xft support has been compiled in and as long as Xft/Xrender/X don't |
|
|
1203 | get their act together, rxvt-unicode will support |
|
|
1204 | "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 |
|
|
1205 | digits/component) colour specifications, in addition to the ones |
|
|
1206 | provided by X, where the additional A component specifies opacity |
|
|
1207 | (alpha) values. The minimum value of 0 is completely transparent). You |
|
|
1208 | can also prefix any color with "[a]", where "a" is on to four hex digits |
|
|
1209 | specifiying the opacity value. |
|
|
1210 | |
|
|
1211 | You probably need to specify "-depth 32", too, and have the luck that |
|
|
1212 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1213 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1214 | |
|
|
1215 | For example, the following selects an almost completely transparent red |
|
|
1216 | background, and an almost opaque pink foreground: |
|
|
1217 | |
|
|
1218 | rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
|
|
1219 | |
|
|
1220 | *Please note that transparency of any kind if completely unsupported by |
|
|
1221 | the author. Don't bug him with installation questions!* |
1183 | |
1222 | |
1184 | ENVIRONMENT |
1223 | ENVIRONMENT |
1185 | rxvt sets and/or uses the following environment variables: |
1224 | rxvt sets and/or uses the following environment variables: |
1186 | |
1225 | |
1187 | TERM |
1226 | TERM |
… | |
… | |
1211 | Set to the terminfo directory iff rxvt was configured with |
1250 | Set to the terminfo directory iff rxvt was configured with |
1212 | "--with-terminfo=PATH". |
1251 | "--with-terminfo=PATH". |
1213 | |
1252 | |
1214 | DISPLAY |
1253 | DISPLAY |
1215 | 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 |
1216 | display in it's child processes. |
1255 | display in its child processes. |
1217 | |
1256 | |
1218 | SHELL |
1257 | SHELL |
1219 | 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". |
1220 | |
1259 | |
1221 | RXVT_SOCKET |
1260 | RXVT_SOCKET |
… | |
… | |
1245 | |
1284 | |
1246 | CURRENT PROJECT COORDINATOR |
1285 | CURRENT PROJECT COORDINATOR |
1247 | Project Coordinator |
1286 | Project Coordinator |
1248 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1287 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1249 | |
1288 | |
1250 | <http://software.schmorp.de/#rxvt-unicode> |
1289 | <http://software.schmorp.de/pkg/rxvt-unicode.html> |
1251 | |
1290 | |
1252 | AUTHORS |
1291 | AUTHORS |
1253 | John Bovey |
1292 | John Bovey |
1254 | University of Kent, 1992, wrote the original Xvt. |
1293 | University of Kent, 1992, wrote the original Xvt. |
1255 | |
1294 | |