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.139 by ayin, Wed Oct 17 13:53:42 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
115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
114 118
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
116 120
117Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
119 123
120I<Please note that transparency of any kind if completely unsupported by 124I<Please address all transparency related issues to Sasha Vasko at
121the author. Don't bug him with installation questions! Read the FAQ (man 7 125sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
122@@RXVT_NAME@@)!>
123 126
124=item B<-fade> I<number> 127=item B<-fade> I<number>
125 128
126Fade the text by the given percentage when focus is lost. Small values 129Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 130fade a little only, 100 completely replaces all colours by the fade
… …
135=item B<-tint> I<colour> 138=item B<-tint> I<colour>
136 139
137Tint the transparent background pixmap with the given colour when 140Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 141transparency is enabled with B<-tr> or B<-ip>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 142non-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 143used to brighten or darken the image in addition to tinting it.
144Please note that certain tint colours can be applied on the server-side,
145thus yielding performance gain of two orders of magnitude. These colours are:
146blue, red, green, cyan, magenta, yellow, and those close to them; resource
141I<tintColor>. Example: 147I<tintColor>. Example:
142 148
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 149 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 150
145=item B<-sh> I<number> 151=item B<-sh> I<number>
146 152
147Darken (0 .. 100) or lighten (-1 .. -100) the transparent 153Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to (or instead of) tinting it; 154background image in addition to (or instead of) tinting it;
149resource I<shading>. 155resource I<shading>.
150 156
151=item B<-blt> I<string> 157=item B<-blt> I<string>
152 158
153Specify background blending type. If background pixmap is specified 159Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over 160at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are : 161transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 162B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 163B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 164B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>. 165alpha-blending; resource I<blendType>.
160 166
161=item B<-blr> I<number> 167=item B<-blr> I<HxV>
162 168
163Apply Gaussian Blur with the specified radius to the transparent 169Apply Gaussian Blur with the specified radii to the transparent
164background image; resource I<blurRadius>. 170background image. If single number is specified - both vertical and
171horizontal radii are considered to be the same. Setting one of the
172radii to 1 and another to a large number creates interesting effects
173on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
165 174
166=item B<-bg> I<colour> 175=item B<-bg> I<colour>
167 176
168Window background colour; resource B<background>. 177Window background colour; resource B<background>.
169 178
… …
337 346
338=item B<-lsp> I<number> 347=item B<-lsp> I<number>
339 348
340Compile I<frills>: Lines (pixel height) to insert between each row of 349Compile I<frills>: Lines (pixel height) to insert between each row of
341the display. Useful to work around font rendering problems; resource 350the display. Useful to work around font rendering problems; resource
342B<linespace>. 351B<lineSpace>.
343 352
344=item B<-tn> I<termname> 353=item B<-tn> I<termname>
345 354
346This option specifies the name of the terminal type to be set in the 355This option specifies the name of the terminal type to be set in the
347B<TERM> environment variable. This terminal type must exist in the 356B<TERM> environment variable. This terminal type must exist in the
… …
607option B<-rv>. B<False>: regular screen colours [default]; option 616option B<-rv>. B<False>: regular screen colours [default]; option
608B<+rv>. See note in B<COLORS AND GRAPHICS> section. 617B<+rv>. See note in B<COLORS AND GRAPHICS> section.
609 618
610=item B<jumpScroll:> I<boolean> 619=item B<jumpScroll:> I<boolean>
611 620
612B<True>: specify that jump scrolling should be used. When scrolling 621B<True>: specify that jump scrolling should be used. When receiving lots
613quickly, fewer screen updates are performed [default]; option B<-j>. 622of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
623has been read, resulting in fewer updates while still displaying every
624received line; option B<-j>.
625
614B<False>: specify that smooth scrolling should be used; option B<+j>. 626B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
627force a screen refresh on each new line it received; option B<+j>.
628
629=item B<skipScroll:> I<boolean>
630
631B<True>: (the default) specify that skip scrolling should be used. When
632receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
633(around 60 times per second), resulting in far fewer updates. This can
634result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
635option B<-ss>.
636
637B<False>: specify that everything is to be displayed, even
638if the refresh is too fast for the human eye to read anything (or the
639monitor to display anything); option B<+ss>.
615 640
616=item B<inheritPixmap:> I<boolean> 641=item B<inheritPixmap:> I<boolean>
617 642
618B<True>: make the background inherit the parent windows' pixmap, giving 643B<True>: make the background inherit the parent windows' pixmap, giving
619artificial transparency. B<False>: do not inherit the parent windows' 644artificial transparency. B<False>: do not inherit the parent windows'
… …
681other blending type, specified with B<-blt "type"> option. 706other blending type, specified with B<-blt "type"> option.
682[default 0x0+50+50] 707[default 0x0+50+50]
683 708
684=item B<path:> I<path> 709=item B<path:> I<path>
685 710
686Specify the colon-delimited search path for finding XPM files. 711Specify the colon-delimited search path for finding background image files.
687 712
688=item B<font:> I<fontlist> 713=item B<font:> I<fontlist>
689 714
690Select the fonts to be used. This is a comma separated list of font names 715Select 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 716that are checked in order when trying to find glyphs for characters. The
… …
890=item B<termName:> I<termname> 915=item B<termName:> I<termname>
891 916
892Specifies the terminal type name to be set in the B<TERM> environment 917Specifies the terminal type name to be set in the B<TERM> environment
893variable; option B<-tn>. 918variable; option B<-tn>.
894 919
895=item B<linespace:> I<number> 920=item B<lineSpace:> I<number>
896 921
897Specifies number of lines (pixel height) to insert between each row of 922Specifies number of lines (pixel height) to insert between each row of
898the display [default 0]; option B<-lsp>. 923the display [default 0]; option B<-lsp>.
899 924
900=item B<meta8:> I<boolean> 925=item B<meta8:> I<boolean>
… …
1058searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1083searching 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 1084omitting 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 1085keysym 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. 1086performed in an exact manner; however, the closest match is assured.
1062 1087
1063I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1088I<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, 1089number), 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 1090
1075You can define a range of keysyms in one shot by providing a I<string> 1091You can define a range of keysyms in one shot by providing a I<string>
1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1092with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077should be a character not used by the strings. 1093should be a character not used by the strings.
1078 1094
… …
1202=item B<override-redirect>: I<boolean> 1218=item B<override-redirect>: I<boolean>
1203 1219
1204Compile I<frills>: Sets override-redirect for the terminal window, making 1220Compile I<frills>: Sets override-redirect for the terminal window, making
1205it almost invisible to window managers; option B<-override-redirect>. 1221it almost invisible to window managers; option B<-override-redirect>.
1206 1222
1223=item B<iso14755_52:> I<boolean>
1224
1225Turn on/off ISO 14755 5.2 mode (default enabled).
1226
1207=back 1227=back
1208 1228
1209=head1 THE SCROLLBAR 1229=head1 THE SCROLLBAR
1210 1230
1211Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1231Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1281 1301
1282=head1 ISO 14755 SUPPORT 1302=head1 ISO 14755 SUPPORT
1283 1303
1284ISO 14755 is a standard for entering and viewing unicode characters 1304ISO 14755 is a standard for entering and viewing unicode characters
1285and character codes using the keyboard. It consists of 4 parts. The 1305and character codes using the keyboard. It consists of 4 parts. The
1286first part is available rxvt-unicode has been compiled with 1306first part is available if rxvt-unicode has been compiled with
1287C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1307C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1288with C<--enable-iso14755>. 1308with C<--enable-iso14755>.
1289 1309
1290=over 4 1310=over 4
1291 1311
… …
1445resources or on the command line. 1465resources or on the command line.
1446 1466
1447=item B<COLORTERM> 1467=item B<COLORTERM>
1448 1468
1449Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1469Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450compiled with XPM support, and optionally with the added extension 1470compiled with background image support, and optionally with the added
1451C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1471extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472screen.
1452 1473
1453=item B<COLORFGBG> 1474=item B<COLORFGBG>
1454 1475
1455Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1476Set 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 1477the colour code used as default foreground/text colour (or the string
1457C<default> to indicate that the default-colour escape sequence is to be 1478C<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 1479used), 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@@ 1480string 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 1481was compiled with background image support. Libraries like C<ncurses>
1461(and do) use this information to optimize screen output. 1482and C<slang> can (and do) use this information to optimize screen output.
1462 1483
1463=item B<WINDOWID> 1484=item B<WINDOWID>
1464 1485
1465Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1486Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466window, which usually has subwindows for the scrollbar, the terminal 1487window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

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