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.133 by ayin, Sat Jul 28 20:15:18 2007 UTC vs.
Revision 1.142 by ayin, Wed Oct 31 14:10:33 2007 UTC

… …
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
… …
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; resource 147used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
145I<tintColor>. Example: 152I<tintColor>. Example:
146 153
147 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
148 155
149=item B<-sh> I<number> 156=item B<-sh> I<number>
150 157
151Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
152background image in addition to (or instead of) tinting it; 159background image in addition to (or instead of) tinting it;
153resource I<shading>. 160resource I<shading>.
154 161
155=item B<-blt> I<string> 162=item B<-blt> I<string>
156 163
157Specify background blending type. If background pixmap is specified 164Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over 165at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are : 166transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<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
163alpha-blending; resource I<blendType>. 170alpha-blending. Compile I<afterimage>; resource I<blendType>.
164 171
165=item B<-blr> I<number> 172=item B<-blr> I<HxV>
166 173
167Apply Gaussian Blur with the specified radius to the transparent 174Apply Gaussian Blur with the specified radii to the transparent
168background image; resource I<blurRadius>. 175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
169 180
170=item B<-bg> I<colour> 181=item B<-bg> I<colour>
171 182
172Window background colour; resource B<background>. 183Window background colour; resource B<background>.
173 184
… …
341 352
342=item B<-lsp> I<number> 353=item B<-lsp> I<number>
343 354
344Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
345the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
346B<linespace>. 357B<lineSpace>.
347 358
348=item B<-tn> I<termname> 359=item B<-tn> I<termname>
349 360
350This 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
351B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
… …
701other blending type, specified with B<-blt "type"> option. 712other blending type, specified with B<-blt "type"> option.
702[default 0x0+50+50] 713[default 0x0+50+50]
703 714
704=item B<path:> I<path> 715=item B<path:> I<path>
705 716
706Specify the colon-delimited search path for finding XPM files. 717Specify the colon-delimited search path for finding background image files.
707 718
708=item B<font:> I<fontlist> 719=item B<font:> I<fontlist>
709 720
710Select 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
711that 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
… …
910=item B<termName:> I<termname> 921=item B<termName:> I<termname>
911 922
912Specifies 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
913variable; option B<-tn>. 924variable; option B<-tn>.
914 925
915=item B<linespace:> I<number> 926=item B<lineSpace:> I<number>
916 927
917Specifies number of lines (pixel height) to insert between each row of 928Specifies number of lines (pixel height) to insert between each row of
918the display [default 0]; option B<-lsp>. 929the display [default 0]; option B<-lsp>.
919 930
920=item B<meta8:> I<boolean> 931=item B<meta8:> I<boolean>
… …
1078searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1089searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1079omitting 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
1080keysym 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
1081performed in an exact manner; however, the closest match is assured. 1092performed in an exact manner; however, the closest match is assured.
1082 1093
1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1094I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1084C<\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.
1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
1089
1090Please note that you need to double the C<\> in resource files, as
1091Xlib itself does its own de-escaping (you can use C<\033> instead of
1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1093processing).
1094 1096
1095You 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>
1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1098with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1097should be a character not used by the strings. 1099should be a character not used by the strings.
1098 1100
… …
1469resources or on the command line. 1471resources or on the command line.
1470 1472
1471=item B<COLORTERM> 1473=item B<COLORTERM>
1472 1474
1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1475Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1474compiled with XPM support, and optionally with the added extension 1476compiled with background image support, and optionally with the added
1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1477extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478screen.
1476 1479
1477=item B<COLORFGBG> 1480=item B<COLORFGBG>
1478 1481
1479Set 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
1480the colour code used as default foreground/text colour (or the string 1483the colour code used as default foreground/text colour (or the string
1481C<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
1482used), 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
1483string 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@@
1484was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1487was compiled with background image support. Libraries like C<ncurses>
1485(and do) use this information to optimize screen output. 1488and C<slang> can (and do) use this information to optimize screen output.
1486 1489
1487=item B<WINDOWID> 1490=item B<WINDOWID>
1488 1491
1489Set 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
1490window, 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