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.53 by root, Thu Jan 26 00:09:47 2006 UTC vs.
Revision 1.56 by root, Tue Jan 31 00:25:16 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.3a, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.5, 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
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
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
1143 setgid to root or to some other group on others. 1149 setgid to root or to some other group on others.
1144 1150
1145COLORS AND GRAPHICS 1151COLORS AND GRAPHICS
1146 In addition to the default foreground and background colours, rxvt can 1152 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 1153 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 1154 versions of the same). Here is a list of the colours with their names.
1149 names.
1150 1155
1151 color0 (black) = Black 1156 color0 (black) = Black
1152 color1 (red) = Red3 1157 color1 (red) = Red3
1153 color2 (green) = Green3 1158 color2 (green) = Green3
1154 color3 (yellow) = Yellow3 1159 color3 (yellow) = Yellow3
1179 1184
1180 rxvt -fg Black -bg White -rv 1185 rxvt -fg Black -bg White -rv
1181 would yield White on Black, while on *xterm*(1) it would yield Black 1186 would yield White on Black, while on *xterm*(1) it would yield Black
1182 on White. 1187 on White.
1183 1188
1189 ALPHA CHANNEL SUPPORT
1190 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1191 get their act together, rxvt-unicode will support
1192 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1193 digits/component) colour specifications, in addition to the ones
1194 provided by X, where the additional A component specifies opacity
1195 (alpha) values. The minimum value of 0 is completely transparent). You
1196 can also prefix any color with "[a]", where "a" is on to four hex digits
1197 specifiying the opacity value.
1198
1199 You probably need to specify "-depth 32", too, and have the luck that
1200 your X-server uses ARGB pixel layout, as X is far from just supporting
1201 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1202
1203 For example, the following selects an almost completely transparent red
1204 background, and an almost opaque pink foreground:
1205
1206 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1207
1208 *Please note that transparency of any kind if completely unsupported by
1209 the author. Don't bug him with installation questions!*
1210
1184ENVIRONMENT 1211ENVIRONMENT
1185 rxvt sets and/or uses the following environment variables: 1212 rxvt sets and/or uses the following environment variables:
1186 1213
1187 TERM 1214 TERM
1188 Normally set to "rxvt-unicode", unless overwritten at configure 1215 Normally set to "rxvt-unicode", unless overwritten at configure

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines