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.136 by root, Mon Aug 13 10:01:18 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>.
… …
135=item B<-tint> I<colour> 139=item B<-tint> I<colour>
136 140
137Tint the transparent background pixmap with the given colour when 141Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 142transparency 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 143non-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 144used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colours can be applied on the server-side,
146thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to them; resource
141I<tintColor>. Example: 148I<tintColor>. Example:
142 149
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 150 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 151
145=item B<-sh> 152=item B<-sh> I<number>
146 153
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 154Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 155background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 156resource I<shading>.
157
158=item B<-blt> I<string>
159
160Specify background blending type. If background pixmap is specified
161at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166alpha-blending; resource I<blendType>.
167
168=item B<-blr> I<HxV>
169
170Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
150 175
151=item B<-bg> I<colour> 176=item B<-bg> I<colour>
152 177
153Window background colour; resource B<background>. 178Window background colour; resource B<background>.
154 179
… …
156 181
157Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
158 183
159=item B<-pixmap> I<file[;geom]> 184=item B<-pixmap> I<file[;geom]>
160 185
161Compile I<XPM>: Specify XPM file for the background and also optionally 186Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 187optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 188add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 189command-line; for more details see resource B<backgroundPixmap>.
165 190
166=item B<-cr> I<colour> 191=item B<-cr> I<colour>
167 192
168The cursor colour; resource B<cursorColor>. 193The cursor colour; resource B<cursorColor>.
169 194
… …
592option B<-rv>. B<False>: regular screen colours [default]; option 617option B<-rv>. B<False>: regular screen colours [default]; option
593B<+rv>. See note in B<COLORS AND GRAPHICS> section. 618B<+rv>. See note in B<COLORS AND GRAPHICS> section.
594 619
595=item B<jumpScroll:> I<boolean> 620=item B<jumpScroll:> I<boolean>
596 621
597B<True>: specify that jump scrolling should be used. When scrolling 622B<True>: specify that jump scrolling should be used. When receiving lots
598quickly, fewer screen updates are performed [default]; option B<-j>. 623of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
624has been read, resulting in fewer updates while still displaying every
625received line; option B<-j>.
626
599B<False>: specify that smooth scrolling should be used; option B<+j>. 627B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
628force a screen refresh on each new line it received; option B<+j>.
629
630=item B<skipScroll:> I<boolean>
631
632B<True>: (the default) specify that skip scrolling should be used. When
633receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
634(around 60 times per second), resulting in far fewer updates. This can
635result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
636option B<-ss>.
637
638B<False>: specify that everything is to be displayed, even
639if the refresh is too fast for the human eye to read anything (or the
640monitor to display anything); option B<+ss>.
600 641
601=item B<inheritPixmap:> I<boolean> 642=item B<inheritPixmap:> I<boolean>
602 643
603B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: make the background inherit the parent windows' pixmap, giving
604artificial transparency. B<False>: do not inherit the parent windows' 645artificial transparency. B<False>: do not inherit the parent windows'
… …
624=item B<shading:> I<number> 665=item B<shading:> I<number>
625 666
626Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 667Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
627in addition to tinting it; option B<-sh>. 668in addition to tinting it; option B<-sh>.
628 669
670=item B<blendType:> I<string>
671
672Specify background blending type; option B<-blt>.
673
674=item B<blurRadius:> I<number>
675
676Apply Gaussian Blurr with the specified radius to the transparent
677background image; option B<-blr>.
678
629=item B<scrollColor:> I<colour> 679=item B<scrollColor:> I<colour>
630 680
631Use the specified colour for the scrollbar [default #B2B2B2]. 681Use the specified colour for the scrollbar [default #B2B2B2].
632 682
633=item B<troughColor:> I<colour> 683=item B<troughColor:> I<colour>
… …
640The colour of the border around the text area and between the scrollbar 690The colour of the border around the text area and between the scrollbar
641and the text. 691and the text.
642 692
643=item B<backgroundPixmap:> I<file[;geom]> 693=item B<backgroundPixmap:> I<file[;geom]>
644 694
645Use the specified XPM file (note the `.xpm' extension is optional) for 695Use the specified image file for the background and also optionally
646the background and also optionally specify its scaling with a geometry 696specify its scaling with a geometry string B<WxH+X+Y>,
647string B<WxH+X+Y>, in which B<"W" / "H"> specify the 697in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
648horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 698and B<"X" / "Y"> locate the image centre (percent).
649centre (percent). A scale of 0 displays the image with tiling. A scale 699A 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 700image without any scaling. A scale of 2 to 9 specifies an integer
651specifies an integer number of images in that direction. No image will 701number of images in that direction. No image will be magnified beyond
652be magnified beyond 10 times its original size. The maximum permitted 70210 times its original size. The maximum permitted scale is 1000.
653scale is 1000. [default 0x0+50+50] 703Special string of B<"auto"> used as a geometry will cause image to be
704automatically scaled to match window size.
705If used in conjunction with B<-tr> option - specified pixmap will be
706blended over transparency image using either alpha-blending, or any
707other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50]
654 709
655=item B<path:> I<path> 710=item B<path:> I<path>
656 711
657Specify the colon-delimited search path for finding XPM files. 712Specify the colon-delimited search path for finding XPM files.
658 713
… …
1173=item B<override-redirect>: I<boolean> 1228=item B<override-redirect>: I<boolean>
1174 1229
1175Compile I<frills>: Sets override-redirect for the terminal window, making 1230Compile I<frills>: Sets override-redirect for the terminal window, making
1176it almost invisible to window managers; option B<-override-redirect>. 1231it almost invisible to window managers; option B<-override-redirect>.
1177 1232
1233=item B<iso14755_52:> I<boolean>
1234
1235Turn on/off ISO 14755 5.2 mode (default enabled).
1236
1178=back 1237=back
1179 1238
1180=head1 THE SCROLLBAR 1239=head1 THE SCROLLBAR
1181 1240
1182Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1241Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1252 1311
1253=head1 ISO 14755 SUPPORT 1312=head1 ISO 14755 SUPPORT
1254 1313
1255ISO 14755 is a standard for entering and viewing unicode characters 1314ISO 14755 is a standard for entering and viewing unicode characters
1256and character codes using the keyboard. It consists of 4 parts. The 1315and character codes using the keyboard. It consists of 4 parts. The
1257first part is available rxvt-unicode has been compiled with 1316first part is available if rxvt-unicode has been compiled with
1258C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1317C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1259with C<--enable-iso14755>. 1318with C<--enable-iso14755>.
1260 1319
1261=over 4 1320=over 4
1262 1321

Diff Legend

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