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.220 by root, Fri Sep 21 23:31:43 2012 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC

… …
127 127
128=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
129 129
130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
131 131
132=item B<-tr>|B<+tr>
133
134Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
135
136B<-ip> is still accepted as an obsolete alias but will be removed in
137future versions.
138
139=item B<-fade> I<number> 132=item B<-fade> I<number>
140 133
141Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
142fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
143colour; resource B<fading>. 136colour; resource B<fading>.
… …
145=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
146 139
147Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
148is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
149 142
150=item B<-tint> I<colour>
151
152Tint the transparent background with the given colour;
153resource I<tintColor>.
154
155=item B<-sh> I<number>
156
157Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158A value of 100 means no shading; resource I<shading>.
159
160=item B<-blr> I<HxV>
161
162Apply Gaussian Blur with the specified radii to the transparent
163background. If a single number is specified, the vertical and
164horizontal radii are considered to be the same. Setting one of the
165radii to 1 and the other to a large number creates interesting effects
166on some backgrounds. The maximum radius value is 128. An horizontal or
167vertical radius of 0 disables blurring;
168resource I<blurRadius>.
169
170=item B<-icon> I<file> 143=item B<-icon> I<file>
171 144
172Compile I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
173is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
174application window; resource I<iconFile>. 147application window; resource I<iconFile>.
… …
178Window background colour; resource B<background>. 151Window background colour; resource B<background>.
179 152
180=item B<-fg> I<colour> 153=item B<-fg> I<colour>
181 154
182Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
183
184=item B<-pixmap> I<file[;oplist]>
185
186Compile I<pixbuf>: Specify image file for the background and also
187optionally specify a list of operations to modify it. Note you may need to
188add quotes to avoid special shell interpretation of the C<;> in the
189command-line; for more details see resource B<backgroundPixmap>.
190 156
191=item B<-cr> I<colour> 157=item B<-cr> I<colour>
192 158
193The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
194 160
… …
683 649
684B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
685if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
686monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
687 653
688=item B<transparent:> I<boolean>
689
690Turn on/off pseudo-transparency by using the root pixmap as background.
691
692B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
693future versions.
694
695=item B<fading:> I<number> 654=item B<fading:> I<number>
696 655
697Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
698 657
699=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
700 659
701Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
702colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
703 662
704=item B<tintColor:> I<colour>
705
706Tint the transparent background with the given colour. If the RENDER
707extension is not available only black, red, green, yellow, blue,
708magenta, cyan and white tints can be performed server-side. Note that
709a black tint yields a completely black image while a white tint yields
710the image unchanged; option B<-tint>.
711
712=item B<shading:> I<number>
713
714Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
715A value of 100 means no shading; option B<-sh>.
716
717=item B<blurRadius:> I<number>
718
719Apply gaussian blur with the specified radius to the transparent
720background; option B<-blr>.
721
722=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
723 664
724Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
725 666
726=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
734 675
735=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
736 677
737The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
738and the text. 679and the text.
739
740=item B<backgroundPixmap:> I<file[;oplist]>
741
742Use the specified image file for the background and also
743optionally specify a colon separated list of operations to modify it.
744Supported operations are:
745
746=over 4
747
748=item B<WxH+X+Y>
749
750sets scale and position. B<"W" / "H"> specify the horizontal/vertical
751scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
752scale of 0 disables scaling.
753
754=item B<op=tile>
755
756enables tiling
757
758=item B<op=keep-aspect>
759
760maintain the image aspect ratio when scaling
761
762=item B<op=root-align>
763
764use the position of the terminal window relative to the root window as
765the image offset, simulating a root window background
766
767=back
768
769The default scale and position setting is C<100x100+50+50>.
770Alternatively, a predefined set of templates can be used to achieve
771the most common setups:
772
773=over 4
774
775=item B<style=tiled>
776
777the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
778
779=item B<style=aspect-stretched>
780
781the image is scaled to fill the whole window maintaining the aspect
782ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784=item B<style=stretched>
785
786the image is scaled to fill the whole window. Equivalent to 100x100
787
788=item B<style=centered>
789
790the image is centered with no scaling. Equivalent to 0x0+50+50
791
792=item B<style=root-tiled>
793
794the image is tiled with no scaling and using 'root' positioning.
795Equivalent to 0x0:op=tile:op=root-align
796
797=back
798
799If multiple templates are specified the last one wins. Note that a
800template overrides all the scale, position and operations settings.
801
802If used in conjunction with B<-tr> option, the specified pixmap will be
803blended over the transparent background using alpha-blending.
804
805=item B<path:> I<path>
806
807Specify the colon-delimited search path for finding background image files.
808 680
809=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
810 682
811Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
812that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
… …
1332Turn on/off ISO 14755 (default enabled). 1204Turn on/off ISO 14755 (default enabled).
1333 1205
1334=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1335 1207
1336Turn on/off ISO 14755 5.2 mode (default enabled). 1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1211
1212=item B<-pixmap> I<file[;oplist]>
1213
1214=item B<backgroundPixmap:> I<file[;oplist]>
1215
1216Compile I<pixbuf>: Use the specified image file as the window's
1217background and also optionally specify a colon separated list of
1218operations to modify it. Note that you may need to quote the C<;>
1219character when using the command line option, as C<;> is usually a
1220metacharacter in shells. Supported operations are:
1221
1222=over 4
1223
1224=item B<WxH+X+Y>
1225
1226sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1227scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1228scale of 0 disables scaling.
1229
1230=item B<op=tile>
1231
1232enables tiling
1233
1234=item B<op=keep-aspect>
1235
1236maintain the image aspect ratio when scaling
1237
1238=item B<op=root-align>
1239
1240use the position of the terminal window relative to the root window as
1241the image offset, simulating a root window background
1242
1243=back
1244
1245The default scale and position setting is C<100x100+50+50>.
1246Alternatively, a predefined set of templates can be used to achieve
1247the most common setups:
1248
1249=over 4
1250
1251=item B<style=tiled>
1252
1253the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1254
1255=item B<style=aspect-stretched>
1256
1257the image is scaled to fill the whole window maintaining the aspect
1258ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1259
1260=item B<style=stretched>
1261
1262the image is scaled to fill the whole window. Equivalent to 100x100
1263
1264=item B<style=centered>
1265
1266the image is centered with no scaling. Equivalent to 0x0+50+50
1267
1268=item B<style=root-tiled>
1269
1270the image is tiled with no scaling and using 'root' positioning.
1271Equivalent to 0x0:op=tile:op=root-align
1272
1273=back
1274
1275If multiple templates are specified the last one wins. Note that a
1276template overrides all the scale, position and operations settings.
1277
1278If used in conjunction with pseudo-transparency, the specified pixmap
1279will be blended over the transparent background using alpha-blending.
1280
1281=item B<-tr>|B<+tr>
1282
1283=item B<transparent:> I<boolean>
1284
1285Turn on/off pseudo-transparency by using the root pixmap as background.
1286
1287B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1288will be removed in future versions.
1289
1290=item B<-tint> I<colour>
1291
1292=item B<tintColor:> I<colour>
1293
1294Tint the transparent background with the given colour. Note that a
1295black tint yields a completely black image while a white tint yields
1296the image unchanged.
1297
1298=item B<-sh> I<number>
1299
1300=item B<shading:> I<number>
1301
1302Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1303A value of 100 means no shading.
1304
1305=item B<-blr> I<HxV>
1306
1307=item B<blurRadius:> I<HxV>
1308
1309Apply gaussian blur with the specified radius to the transparent
1310background. If a single number is specified, the vertical and
1311horizontal radii are considered to be the same. Setting one of the
1312radii to 1 and the other to a large number creates interesting effects
1313on some backgrounds. The maximum radius value is 128. An horizontal or
1314vertical radius of 0 disables blurring.
1315
1316=item B<path:> I<path>
1317
1318Specify the colon-delimited search path for finding background image files.
1337 1319
1338=back 1320=back
1339 1321
1340=head1 THE SCROLLBAR 1322=head1 THE SCROLLBAR
1341 1323

Diff Legend

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