ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs.
Revision 1.142 by ayin, Wed Oct 31 14:10:33 2007 UTC

… …
114 114
115=item B<-ss>|B<+ss> 115=item B<-ss>|B<+ss>
116 116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 118
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-tr>|B<+tr>
120 120
121Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-tr>; resource B<inheritPixmap>. 122B<-ip> and it should not be used anymore; resource B<transparent>.
123 123
124I<Please note that transparency of any kind if completely unsupported by 124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125the author. Don't bug him with installation questions! Read the FAQ (man 7 125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126@@RXVT_NAME@@)!> 126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127 130
128=item B<-fade> I<number> 131=item B<-fade> I<number>
129 132
130Fade the text by the given percentage when focus is lost. Small values 133Fade the text by the given percentage when focus is lost. Small values
131fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
… …
137is opaque black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
138 141
139=item B<-tint> I<colour> 142=item B<-tint> I<colour>
140 143
141Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
142transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
143non-tiled backgrounds, currently. See also the B<-sh> option that can be 146non-tiled backgrounds, currently. See also the B<-sh> option that can be
144used to brighten or darken the image in addition to tinting it. 147used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colours can be applied on the server-side, 148Please note that certain tint colours can be applied on the server-side,
146thus yielding performance gain of two orders of magnitude. These colours are: 149thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to them; resource 150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
148I<tintColor>. Example: 152I<tintColor>. Example:
149 153
150 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
151 155
152=item B<-sh> I<number> 156=item B<-sh> I<number>
153 157
154Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
155background image in addition to (or instead of) tinting it; 159background image in addition to (or instead of) tinting it;
156resource I<shading>. 160resource I<shading>.
157 161
158=item B<-blt> I<string> 162=item B<-blt> I<string>
159 163
… …
161at the same time as transparency - such pixmap will be blended over 165at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are : 166transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166alpha-blending; resource I<blendType>. 170alpha-blending. Compile I<afterimage>; resource I<blendType>.
167 171
168=item B<-blr> I<HxV> 172=item B<-blr> I<HxV>
169 173
170Apply Gaussian Blur with the specified radii to the transparent 174Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and 175background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the 176horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects 177radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. 178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
175 180
176=item B<-bg> I<colour> 181=item B<-bg> I<colour>
177 182
178Window background colour; resource B<background>. 183Window background colour; resource B<background>.
179 184
… …
347 352
348=item B<-lsp> I<number> 353=item B<-lsp> I<number>
349 354
350Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
351the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
352B<linespace>. 357B<lineSpace>.
353 358
354=item B<-tn> I<termname> 359=item B<-tn> I<termname>
355 360
356This option specifies the name of the terminal type to be set in the 361This option specifies the name of the terminal type to be set in the
357B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
… …
707other blending type, specified with B<-blt "type"> option. 712other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50] 713[default 0x0+50+50]
709 714
710=item B<path:> I<path> 715=item B<path:> I<path>
711 716
712Specify the colon-delimited search path for finding XPM files. 717Specify the colon-delimited search path for finding background image files.
713 718
714=item B<font:> I<fontlist> 719=item B<font:> I<fontlist>
715 720
716Select the fonts to be used. This is a comma separated list of font names 721Select the fonts to be used. This is a comma separated list of font names
717that are checked in order when trying to find glyphs for characters. The 722that are checked in order when trying to find glyphs for characters. The
… …
916=item B<termName:> I<termname> 921=item B<termName:> I<termname>
917 922
918Specifies the terminal type name to be set in the B<TERM> environment 923Specifies the terminal type name to be set in the B<TERM> environment
919variable; option B<-tn>. 924variable; option B<-tn>.
920 925
921=item B<linespace:> I<number> 926=item B<lineSpace:> I<number>
922 927
923Specifies number of lines (pixel height) to insert between each row of 928Specifies number of lines (pixel height) to insert between each row of
924the display [default 0]; option B<-lsp>. 929the display [default 0]; option B<-lsp>.
925 930
926=item B<meta8:> I<boolean> 931=item B<meta8:> I<boolean>
… …
1084searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1089searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1085omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1090omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1086keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1091keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1087performed in an exact manner; however, the closest match is assured. 1092performed in an exact manner; however, the closest match is assured.
1088 1093
1089I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1094I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1090C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1095number), see RESOURCES in C<man 7 X> for futher details.
1091C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1092C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093can start or end with whitespace. B<This feature is deprecated and will
1094be removed>.
1095
1096Please note that you need to double the C<\> in resource files, as
1097Xlib itself does its own de-escaping (you can use C<\033> instead of
1098C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1099processing).
1100 1096
1101You can define a range of keysyms in one shot by providing a I<string> 1097You can define a range of keysyms in one shot by providing a I<string>
1102with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1098with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103should be a character not used by the strings. 1099should be a character not used by the strings.
1104 1100
… …
1475resources or on the command line. 1471resources or on the command line.
1476 1472
1477=item B<COLORTERM> 1473=item B<COLORTERM>
1478 1474
1479Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1475Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480compiled with XPM support, and optionally with the added extension 1476compiled with background image support, and optionally with the added
1481C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1477extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478screen.
1482 1479
1483=item B<COLORFGBG> 1480=item B<COLORFGBG>
1484 1481
1485Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1482Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486the colour code used as default foreground/text colour (or the string 1483the colour code used as default foreground/text colour (or the string
1487C<default> to indicate that the default-colour escape sequence is to be 1484C<default> to indicate that the default-colour escape sequence is to be
1488used), C<bg> is the colour code used as default background colour (or the 1485used), C<bg> is the colour code used as default background colour (or the
1489string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1486string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1487was compiled with background image support. Libraries like C<ncurses>
1491(and do) use this information to optimize screen output. 1488and C<slang> can (and do) use this information to optimize screen output.
1492 1489
1493=item B<WINDOWID> 1490=item B<WINDOWID>
1494 1491
1495Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1492Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1496window, which usually has subwindows for the scrollbar, the terminal 1493window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines