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.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.140 by sasha, Fri Oct 26 18:27:29 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
… …
108 108
109Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
110 110
111=item B<-j>|B<+j> 111=item B<-j>|B<+j>
112 112
113Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 114
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 118
120I<Please note that transparency of any kind if completely unsupported by 119=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 120
122@@RXVT_NAME@@)!> 121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
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@@)!>
123 130
124=item B<-fade> I<number> 131=item B<-fade> I<number>
125 132
126Fade 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
127fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
… …
133is opaque black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
134 141
135=item B<-tint> I<colour> 142=item B<-tint> I<colour>
136 143
137Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
139non-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
140used 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; resource
141I<tintColor>. Example: 151I<tintColor>. Example:
142 152
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 153 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 154
145=item B<-sh> I<number> 155=item B<-sh> I<number>
146 156
147Darken (0 .. 100) or lighten (-1 .. -100) the transparent 157Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to (or instead of) tinting it; 158background image in addition to (or instead of) tinting it;
149resource I<shading>. 159resource I<shading>.
150 160
151=item B<-blt> I<string> 161=item B<-blt> I<string>
152 162
153Specify background blending type. If background pixmap is specified 163Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over 164at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are : 165transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 166B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 167B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 168B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>. 169alpha-blending. Compile I<afterimage>; resource I<blendType>.
160 170
161=item B<-blr> I<number> 171=item B<-blr> I<HxV>
162 172
163Apply Gaussian Blur with the specified radius to the transparent 173Apply Gaussian Blur with the specified radii to the transparent
164background image; resource I<blurRadius>. 174background image. If single number is specified - both vertical and
175horizontal radii are considered to be the same. Setting one of the
176radii to 1 and another to a large number creates interesting effects
177on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
178resource I<blurRadius>.
165 179
166=item B<-bg> I<colour> 180=item B<-bg> I<colour>
167 181
168Window background colour; resource B<background>. 182Window background colour; resource B<background>.
169 183
… …
337 351
338=item B<-lsp> I<number> 352=item B<-lsp> I<number>
339 353
340Compile I<frills>: Lines (pixel height) to insert between each row of 354Compile I<frills>: Lines (pixel height) to insert between each row of
341the display. Useful to work around font rendering problems; resource 355the display. Useful to work around font rendering problems; resource
342B<linespace>. 356B<lineSpace>.
343 357
344=item B<-tn> I<termname> 358=item B<-tn> I<termname>
345 359
346This option specifies the name of the terminal type to be set in the 360This option specifies the name of the terminal type to be set in the
347B<TERM> environment variable. This terminal type must exist in the 361B<TERM> environment variable. This terminal type must exist in the
… …
607option B<-rv>. B<False>: regular screen colours [default]; option 621option B<-rv>. B<False>: regular screen colours [default]; option
608B<+rv>. See note in B<COLORS AND GRAPHICS> section. 622B<+rv>. See note in B<COLORS AND GRAPHICS> section.
609 623
610=item B<jumpScroll:> I<boolean> 624=item B<jumpScroll:> I<boolean>
611 625
612B<True>: specify that jump scrolling should be used. When scrolling 626B<True>: specify that jump scrolling should be used. When receiving lots
613quickly, fewer screen updates are performed [default]; option B<-j>. 627of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
628has been read, resulting in fewer updates while still displaying every
629received line; option B<-j>.
630
614B<False>: specify that smooth scrolling should be used; option B<+j>. 631B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
632force a screen refresh on each new line it received; option B<+j>.
633
634=item B<skipScroll:> I<boolean>
635
636B<True>: (the default) specify that skip scrolling should be used. When
637receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
638(around 60 times per second), resulting in far fewer updates. This can
639result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
640option B<-ss>.
641
642B<False>: specify that everything is to be displayed, even
643if the refresh is too fast for the human eye to read anything (or the
644monitor to display anything); option B<+ss>.
615 645
616=item B<inheritPixmap:> I<boolean> 646=item B<inheritPixmap:> I<boolean>
617 647
618B<True>: make the background inherit the parent windows' pixmap, giving 648B<True>: make the background inherit the parent windows' pixmap, giving
619artificial transparency. B<False>: do not inherit the parent windows' 649artificial transparency. B<False>: do not inherit the parent windows'
… …
681other blending type, specified with B<-blt "type"> option. 711other blending type, specified with B<-blt "type"> option.
682[default 0x0+50+50] 712[default 0x0+50+50]
683 713
684=item B<path:> I<path> 714=item B<path:> I<path>
685 715
686Specify the colon-delimited search path for finding XPM files. 716Specify the colon-delimited search path for finding background image files.
687 717
688=item B<font:> I<fontlist> 718=item B<font:> I<fontlist>
689 719
690Select the fonts to be used. This is a comma separated list of font names 720Select the fonts to be used. This is a comma separated list of font names
691that are checked in order when trying to find glyphs for characters. The 721that are checked in order when trying to find glyphs for characters. The
… …
890=item B<termName:> I<termname> 920=item B<termName:> I<termname>
891 921
892Specifies the terminal type name to be set in the B<TERM> environment 922Specifies the terminal type name to be set in the B<TERM> environment
893variable; option B<-tn>. 923variable; option B<-tn>.
894 924
895=item B<linespace:> I<number> 925=item B<lineSpace:> I<number>
896 926
897Specifies number of lines (pixel height) to insert between each row of 927Specifies number of lines (pixel height) to insert between each row of
898the display [default 0]; option B<-lsp>. 928the display [default 0]; option B<-lsp>.
899 929
900=item B<meta8:> I<boolean> 930=item B<meta8:> I<boolean>
… …
1058searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1088searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1059omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1089omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1060keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1090keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1061performed in an exact manner; however, the closest match is assured. 1091performed in an exact manner; however, the closest match is assured.
1062 1092
1063I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1093I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1064C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1094number), see RESOURCES in C<man 7 X> for futher details.
1065C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1066C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1067can start or end with whitespace. B<This feature is deprecated and will
1068be removed>.
1069
1070Please note that you need to double the C<\> in resource files, as
1071Xlib itself does its own de-escaping (you can use C<\033> instead of
1072C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1073processing).
1074 1095
1075You can define a range of keysyms in one shot by providing a I<string> 1096You can define a range of keysyms in one shot by providing a I<string>
1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1097with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077should be a character not used by the strings. 1098should be a character not used by the strings.
1078 1099
… …
1202=item B<override-redirect>: I<boolean> 1223=item B<override-redirect>: I<boolean>
1203 1224
1204Compile I<frills>: Sets override-redirect for the terminal window, making 1225Compile I<frills>: Sets override-redirect for the terminal window, making
1205it almost invisible to window managers; option B<-override-redirect>. 1226it almost invisible to window managers; option B<-override-redirect>.
1206 1227
1228=item B<iso14755_52:> I<boolean>
1229
1230Turn on/off ISO 14755 5.2 mode (default enabled).
1231
1207=back 1232=back
1208 1233
1209=head1 THE SCROLLBAR 1234=head1 THE SCROLLBAR
1210 1235
1211Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1236Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1281 1306
1282=head1 ISO 14755 SUPPORT 1307=head1 ISO 14755 SUPPORT
1283 1308
1284ISO 14755 is a standard for entering and viewing unicode characters 1309ISO 14755 is a standard for entering and viewing unicode characters
1285and character codes using the keyboard. It consists of 4 parts. The 1310and character codes using the keyboard. It consists of 4 parts. The
1286first part is available rxvt-unicode has been compiled with 1311first part is available if rxvt-unicode has been compiled with
1287C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1312C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1288with C<--enable-iso14755>. 1313with C<--enable-iso14755>.
1289 1314
1290=over 4 1315=over 4
1291 1316
… …
1445resources or on the command line. 1470resources or on the command line.
1446 1471
1447=item B<COLORTERM> 1472=item B<COLORTERM>
1448 1473
1449Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450compiled with XPM support, and optionally with the added extension 1475compiled with background image support, and optionally with the added
1451C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen.
1452 1478
1453=item B<COLORFGBG> 1479=item B<COLORFGBG>
1454 1480
1455Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1481Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1456the colour code used as default foreground/text colour (or the string 1482the colour code used as default foreground/text colour (or the string
1457C<default> to indicate that the default-colour escape sequence is to be 1483C<default> to indicate that the default-colour escape sequence is to be
1458used), C<bg> is the colour code used as default background colour (or the 1484used), C<bg> is the colour code used as default background colour (or the
1459string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1485string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1460was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1486was compiled with background image support. Libraries like C<ncurses>
1461(and do) use this information to optimize screen output. 1487and C<slang> can (and do) use this information to optimize screen output.
1462 1488
1463=item B<WINDOWID> 1489=item B<WINDOWID>
1464 1490
1465Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1491Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466window, which usually has subwindows for the scrollbar, the terminal 1492window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

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