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.62 by root, Mon Aug 7 16:17:30 2006 UTC vs.
Revision 1.65 by root, Sat Feb 17 20:36:36 2007 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.9, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.2, 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
125 125
126 rxvt -tr -tint blue -sh 40 126 rxvt -tr -tint blue -sh 40
127 127
128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129 background image in addition to tinting it (i.e. -tint must be 129 background image in addition to tinting it (i.e. -tint must be
130 specified, too, e.g. "-tint white"). 130 specified, too, e.g. "-tint white"); resource *shading*.
131 131
132 -bg *colour* 132 -bg *colour*
133 Window background colour; resource background. 133 Window background colour; resource background.
134 134
135 -fg *colour* 135 -fg *colour*
484 Use the specified colour to display underlined characters when the 484 Use the specified colour to display underlined characters when the
485 foreground colour is the default. 485 foreground colour is the default.
486 486
487 colorRV: *colour* 487 colorRV: *colour*
488 Use the specified colour as the background for reverse video 488 Use the specified colour as the background for reverse video
489 characters. 489 characters when OPTION_HC is disabled (--disable-frills).
490 490
491 underlineColor: *colour* 491 underlineColor: *colour*
492 If set, use the specified colour as the colour for the underline 492 If set, use the specified colour as the colour for the underline
493 itself. If unset, use the foreground colour. 493 itself. If unset, use the foreground colour.
494 494
531 Tint the transparent background pixmap with the given colour; option 531 Tint the transparent background pixmap with the given colour; option
532 -tint. 532 -tint.
533 533
534 shading: *number* 534 shading: *number*
535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 535 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
536 image in addition to tinting it. 536 image in addition to tinting it; option -sh.
537 537
538 scrollColor: *colour* 538 scrollColor: *colour*
539 Use the specified colour for the scrollbar [default #B2B2B2]. 539 Use the specified colour for the scrollbar [default #B2B2B2].
540 540
541 troughColor: *colour* 541 troughColor: *colour*
886 886
887 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
889 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
890 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
891 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
892 893
893 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
894 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
895 "\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
896 processing). 897 processing).
1007 Sets the hotkey that starts the incremental scrollback buffer search 1008 Sets the hotkey that starts the incremental scrollback buffer search
1008 (default: "M-s"). 1009 (default: "M-s").
1009 1010
1010 urlLauncher: *string* 1011 urlLauncher: *string*
1011 Specifies the program to be started with a URL argument. Used by the 1012 Specifies the program to be started with a URL argument. Used by the
1012 "selection-popup" and "mark-urls" perl extensions. 1013 "selection-popup" and "matcher" perl extensions.
1013 1014
1014 transient-for: *windowid* 1015 transient-for: *windowid*
1015 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given 1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1016 window id. 1017 window id.
1017 1018
1089 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
1090 part is available rxvt-unicode has been compiled with "--enable-frills", 1091 part is available rxvt-unicode has been compiled with "--enable-frills",
1091 the rest is available when rxvt-unicode was compiled with 1092 the rest is available when rxvt-unicode was compiled with
1092 "--enable-iso14755". 1093 "--enable-iso14755".
1093 1094
1094 * 5.1: Basic method 1095 * 5.1: Basic method
1095
1096 This allows you to enter unicode characters using their hexcode. 1096 This allows you to enter unicode characters using their hexcode.
1097 1097
1098 Start by pressing and holding both "Control" and "Shift", then enter 1098 Start by pressing and holding both "Control" and "Shift", then enter
1099 hex-digits (between one and six). Releasing "Control" and "Shift" 1099 hex-digits (between one and six). Releasing "Control" and "Shift"
1100 will commit the character as if it were typed directly. While 1100 will commit the character as if it were typed directly. While
1106 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
1107 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
1108 easily by pressing "Control" and "Shift", followed by 1108 easily by pressing "Control" and "Shift", followed by
1109 "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.
1110 1110
1111 * 5.2: Keyboard symbols entry method 1111 * 5.2: Keyboard symbols entry method
1112
1113 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1114 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1115 1114
1116 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1117 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
1119 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1120 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1121 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1122 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1123 1122
1124 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1125
1126 While this is implemented already (it's basically the selection 1124 While this is implemented already (it's basically the selection
1127 mechanism), it could be extended by displaying a unicode character 1125 mechanism), it could be extended by displaying a unicode character
1128 map. 1126 map.
1129 1127
1130 * 5.4: Feedback method for identifying displayed characters for later 1128 * 5.4: Feedback method for identifying displayed characters for later
1131 input 1129 input
1132
1133 This method lets you display the unicode character code associated 1130 This method lets you display the unicode character code associated
1134 with characters already displayed. 1131 with characters already displayed.
1135 1132
1136 You enter this mode by holding down "Control" and "Shift" together, 1133 You enter this mode by holding down "Control" and "Shift" together,
1137 then pressing and holding the left mouse button and moving around. 1134 then pressing and holding the left mouse button and moving around.
1156COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
1157 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
1158 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
1159 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.
1160 1157
1161 color0 (black) = Black 1158 color0 (black) = Black
1162 color1 (red) = Red3 1159 color1 (red) = Red3
1163 color2 (green) = Green3 1160 color2 (green) = Green3
1164 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
1165 color4 (blue) = Blue3 1162 color4 (blue) = Blue3
1166 color5 (magenta) = Magenta3 1163 color5 (magenta) = Magenta3
1167 color6 (cyan) = Cyan3 1164 color6 (cyan) = Cyan3
1168 color7 (white) = AntiqueWhite 1165 color7 (white) = AntiqueWhite
1169 color8 (bright black) = Grey25 1166 color8 (bright black) = Grey25
1170 color9 (bright red) = Red 1167 color9 (bright red) = Red
1171 color10 (bright green) = Green 1168 color10 (bright green) = Green
1172 color11 (bright yellow) = Yellow 1169 color11 (bright yellow) = Yellow
1173 color12 (bright blue) = Blue 1170 color12 (bright blue) = Blue
1174 color13 (bright magenta) = Magenta 1171 color13 (bright magenta) = Magenta
1175 color14 (bright cyan) = Cyan 1172 color14 (bright cyan) = Cyan
1176 color15 (bright white) = White 1173 color15 (bright white) = White
1177 foreground = Black 1174 foreground = Black
1178 background = White 1175 background = White
1176
1179 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1181 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
1182 color0-color15. 1180 color0-color15.
1183 1181
1204 get their act together, rxvt-unicode will support 1202 get their act together, rxvt-unicode will support
1205 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1206 digits/component) colour specifications, in addition to the ones 1204 digits/component) colour specifications, in addition to the ones
1207 provided by X, where the additional A component specifies opacity 1205 provided by X, where the additional A component specifies opacity
1208 (alpha) values. The minimum value of 0 is completely transparent). You 1206 (alpha) values. The minimum value of 0 is completely transparent). You
1209 can also prefix any color with "[a]", where "a" is on to four hex digits 1207 can also prefix any color with "[percent]", where "percent" is a decimal
1210 specifiying the opacity value. 1208 percentage (0-100) that specifies the opacity of the color, where 0 is
1209 completely transparent and 100 is completelxy opaque.
1211 1210
1212 You probably need to specify "-depth 32", too, and have the luck that 1211 You probably need to specify "-depth 32", too, and have the luck that
1213 your X-server uses ARGB pixel layout, as X is far from just supporting 1212 your X-server uses ARGB pixel layout, as X is far from just supporting
1214 ARGB visuals out of the box, and rxvt-unicode just fudges around. 1213 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1215 1214
1216 For example, the following selects an almost completely transparent red 1215 For example, the following selects an almost completely transparent red
1217 background, and an almost opaque pink foreground: 1216 background, and an almost opaque pink foreground:
1218 1217
1219 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1218 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1220 1219
1221 *Please note that transparency of any kind if completely unsupported by 1220 *Please note that transparency of any kind if completely unsupported by
1222 the author. Don't bug him with installation questions!* 1221 the author. Don't bug him with installation questions!*
1223 1222
1224ENVIRONMENT 1223ENVIRONMENT

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines