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.129 by root, Mon May 28 20:34:56 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> 151=item B<-sh> I<number>
146 152
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 153Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 154background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 155resource I<shading>.
156
157=item B<-blt> I<string>
158
159Specify background blending type. If background pixmap is specified
160at the same time as transparency - such pixmap will be blended over
161transparency image, using method specified. Supported values are :
162B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165alpha-blending; resource I<blendType>.
166
167=item B<-blr> I<HxV>
168
169Apply Gaussian Blur with the specified radii to the transparent
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>.
150 174
151=item B<-bg> I<colour> 175=item B<-bg> I<colour>
152 176
153Window background colour; resource B<background>. 177Window background colour; resource B<background>.
154 178
… …
156 180
157Window foreground colour; resource B<foreground>. 181Window foreground colour; resource B<foreground>.
158 182
159=item B<-pixmap> I<file[;geom]> 183=item B<-pixmap> I<file[;geom]>
160 184
161Compile I<XPM>: Specify XPM file for the background and also optionally 185Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 186optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 187add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 188command-line; for more details see resource B<backgroundPixmap>.
165 189
166=item B<-cr> I<colour> 190=item B<-cr> I<colour>
167 191
168The cursor colour; resource B<cursorColor>. 192The cursor colour; resource B<cursorColor>.
169 193
… …
322 346
323=item B<-lsp> I<number> 347=item B<-lsp> I<number>
324 348
325Compile I<frills>: Lines (pixel height) to insert between each row of 349Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 350the display. Useful to work around font rendering problems; resource
327B<linespace>. 351B<lineSpace>.
328 352
329=item B<-tn> I<termname> 353=item B<-tn> I<termname>
330 354
331This 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
332B<TERM> environment variable. This terminal type must exist in the 356B<TERM> environment variable. This terminal type must exist in the
… …
592option B<-rv>. B<False>: regular screen colours [default]; option 616option B<-rv>. B<False>: regular screen colours [default]; option
593B<+rv>. See note in B<COLORS AND GRAPHICS> section. 617B<+rv>. See note in B<COLORS AND GRAPHICS> section.
594 618
595=item B<jumpScroll:> I<boolean> 619=item B<jumpScroll:> I<boolean>
596 620
597B<True>: specify that jump scrolling should be used. When scrolling 621B<True>: specify that jump scrolling should be used. When receiving lots
598quickly, 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
599B<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>.
600 640
601=item B<inheritPixmap:> I<boolean> 641=item B<inheritPixmap:> I<boolean>
602 642
603B<True>: make the background inherit the parent windows' pixmap, giving 643B<True>: make the background inherit the parent windows' pixmap, giving
604artificial transparency. B<False>: do not inherit the parent windows' 644artificial transparency. B<False>: do not inherit the parent windows'
… …
624=item B<shading:> I<number> 664=item B<shading:> I<number>
625 665
626Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 666Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
627in addition to tinting it; option B<-sh>. 667in addition to tinting it; option B<-sh>.
628 668
669=item B<blendType:> I<string>
670
671Specify background blending type; option B<-blt>.
672
673=item B<blurRadius:> I<number>
674
675Apply Gaussian Blurr with the specified radius to the transparent
676background image; option B<-blr>.
677
629=item B<scrollColor:> I<colour> 678=item B<scrollColor:> I<colour>
630 679
631Use the specified colour for the scrollbar [default #B2B2B2]. 680Use the specified colour for the scrollbar [default #B2B2B2].
632 681
633=item B<troughColor:> I<colour> 682=item B<troughColor:> I<colour>
… …
640The colour of the border around the text area and between the scrollbar 689The colour of the border around the text area and between the scrollbar
641and the text. 690and the text.
642 691
643=item B<backgroundPixmap:> I<file[;geom]> 692=item B<backgroundPixmap:> I<file[;geom]>
644 693
645Use the specified XPM file (note the `.xpm' extension is optional) for 694Use the specified image file for the background and also optionally
646the background and also optionally specify its scaling with a geometry 695specify its scaling with a geometry string B<WxH+X+Y>,
647string B<WxH+X+Y>, in which B<"W" / "H"> specify the 696in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
648horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 697and B<"X" / "Y"> locate the image centre (percent).
649centre (percent). A scale of 0 displays the image with tiling. A scale 698A scale of 0 displays the image with tiling. A scale of 1 displays the
650of 1 displays the image without any scaling. A scale of 2 to 9 699image without any scaling. A scale of 2 to 9 specifies an integer
651specifies an integer number of images in that direction. No image will 700number of images in that direction. No image will be magnified beyond
652be magnified beyond 10 times its original size. The maximum permitted 70110 times its original size. The maximum permitted scale is 1000.
653scale is 1000. [default 0x0+50+50] 702Special string of B<"auto"> used as a geometry will cause image to be
703automatically scaled to match window size.
704If used in conjunction with B<-tr> option - specified pixmap will be
705blended over transparency image using either alpha-blending, or any
706other blending type, specified with B<-blt "type"> option.
707[default 0x0+50+50]
654 708
655=item B<path:> I<path> 709=item B<path:> I<path>
656 710
657Specify the colon-delimited search path for finding XPM files. 711Specify the colon-delimited search path for finding background image files.
658 712
659=item B<font:> I<fontlist> 713=item B<font:> I<fontlist>
660 714
661Select 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
662that 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
… …
861=item B<termName:> I<termname> 915=item B<termName:> I<termname>
862 916
863Specifies 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
864variable; option B<-tn>. 918variable; option B<-tn>.
865 919
866=item B<linespace:> I<number> 920=item B<lineSpace:> I<number>
867 921
868Specifies number of lines (pixel height) to insert between each row of 922Specifies number of lines (pixel height) to insert between each row of
869the display [default 0]; option B<-lsp>. 923the display [default 0]; option B<-lsp>.
870 924
871=item B<meta8:> I<boolean> 925=item B<meta8:> I<boolean>
… …
1029searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1083searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1030omitting 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
1031keysym 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
1032performed in an exact manner; however, the closest match is assured. 1086performed in an exact manner; however, the closest match is assured.
1033 1087
1034I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1088I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1035C<\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.
1036C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1037C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1038can start or end with whitespace. B<This feature is deprecated and will
1039be removed>.
1040
1041Please note that you need to double the C<\> in resource files, as
1042Xlib itself does its own de-escaping (you can use C<\033> instead of
1043C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1044processing).
1045 1090
1046You 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>
1047with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1092with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1048should be a character not used by the strings. 1093should be a character not used by the strings.
1049 1094
… …
1173=item B<override-redirect>: I<boolean> 1218=item B<override-redirect>: I<boolean>
1174 1219
1175Compile I<frills>: Sets override-redirect for the terminal window, making 1220Compile I<frills>: Sets override-redirect for the terminal window, making
1176it almost invisible to window managers; option B<-override-redirect>. 1221it almost invisible to window managers; option B<-override-redirect>.
1177 1222
1223=item B<iso14755_52:> I<boolean>
1224
1225Turn on/off ISO 14755 5.2 mode (default enabled).
1226
1178=back 1227=back
1179 1228
1180=head1 THE SCROLLBAR 1229=head1 THE SCROLLBAR
1181 1230
1182Lines 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
… …
1252 1301
1253=head1 ISO 14755 SUPPORT 1302=head1 ISO 14755 SUPPORT
1254 1303
1255ISO 14755 is a standard for entering and viewing unicode characters 1304ISO 14755 is a standard for entering and viewing unicode characters
1256and character codes using the keyboard. It consists of 4 parts. The 1305and character codes using the keyboard. It consists of 4 parts. The
1257first part is available rxvt-unicode has been compiled with 1306first part is available if rxvt-unicode has been compiled with
1258C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1307C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1259with C<--enable-iso14755>. 1308with C<--enable-iso14755>.
1260 1309
1261=over 4 1310=over 4
1262 1311
… …
1416resources or on the command line. 1465resources or on the command line.
1417 1466
1418=item B<COLORTERM> 1467=item B<COLORTERM>
1419 1468
1420Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1469Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1421compiled with XPM support, and optionally with the added extension 1470compiled with background image support, and optionally with the added
1422C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1471extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472screen.
1423 1473
1424=item B<COLORFGBG> 1474=item B<COLORFGBG>
1425 1475
1426Set 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
1427the colour code used as default foreground/text colour (or the string 1477the colour code used as default foreground/text colour (or the string
1428C<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
1429used), 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
1430string 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@@
1431was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1481was compiled with background image support. Libraries like C<ncurses>
1432(and do) use this information to optimize screen output. 1482and C<slang> can (and do) use this information to optimize screen output.
1433 1483
1434=item B<WINDOWID> 1484=item B<WINDOWID>
1435 1485
1436Set 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
1437window, 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