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.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC

… …
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn 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>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133 131
134=item B<-fade> I<number> 132=item B<-fade> I<number>
135 133
136Fade 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
137fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
… …
140=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
141 139
142Fade 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
143is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
144 142
145=item B<-tint> I<colour>
146
147Tint the transparent background with the given colour;
148resource I<tintColor>.
149
150=item B<-sh> I<number>
151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>.
154
155=item B<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file> 143=item B<-icon> I<file>
166 144
167Compile I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>. 147application window; resource I<iconFile>.
… …
173Window background colour; resource B<background>. 151Window background colour; resource B<background>.
174 152
175=item B<-fg> I<colour> 153=item B<-fg> I<colour>
176 154
177Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
178
179=item B<-pixmap> I<file[;oplist]>
180
181Compile I<pixbuf>: Specify image file for the background and also
182optionally specify a list of operations to modify it. Note you may need to
183add quotes to avoid special shell interpretation of the C<;> in the
184command-line; for more details see resource B<backgroundPixmap>.
185 156
186=item B<-cr> I<colour> 157=item B<-cr> I<colour>
187 158
188The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
189 160
… …
678 649
679B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
680if 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
681monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
682 653
683=item B<transparent:> I<boolean>
684
685Turn on/off pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690=item B<fading:> I<number> 654=item B<fading:> I<number>
691 655
692Fade 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>.
693 657
694=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
695 659
696Fade 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
697colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
698 662
699=item B<tintColor:> I<colour>
700
701Tint the transparent background with the given colour. If the RENDER
702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
706
707=item B<shading:> I<number>
708
709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
710A value of 100 means no shading; option B<-sh>.
711
712=item B<blendType:> I<string>
713
714Specify background blending type; option B<-blt>.
715
716=item B<blurRadius:> I<number>
717
718Apply gaussian blur with the specified radius to the transparent
719background; option B<-blr>.
720
721=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
722 664
723Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
724 666
725=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
733 675
734=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
735 677
736The 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
737and the text. 679and the text.
738
739=item B<backgroundPixmap:> I<file[;oplist]>
740
741Use the specified image file for the background and also
742optionally specify a colon separated list of operations to modify it.
743Supported operations are:
744
745=over 4
746
747=item B<WxH+X+Y>
748
749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
750scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
763use the position of the terminal window relative to the root window as
764the image offset, simulating a root window background
765
766=back
767
768The default scale and position setting is C<100x100+50+50>.
769Alternatively, a predefined set of templates can be used to achieve
770the most common setups:
771
772=over 4
773
774=item B<style=tiled>
775
776the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
797
798If multiple templates are specified the last one wins. Note that a
799template overrides all the scale, position and operations settings.
800
801If used in conjunction with B<-tr> option, the specified pixmap will be
802blended over the transparent background using alpha-blending.
803
804=item B<path:> I<path>
805
806Specify the colon-delimited search path for finding background image files.
807 680
808=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
809 682
810Select 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
811that 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
… …
1289the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1290 1163
1291=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1292 1165
1293Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1295look in these directories, then in $HOME/.urxvt/ext and lastly in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1296F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1297 1170
1298See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1299 1172
1300=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1301 1174
… …
1331Turn on/off ISO 14755 (default enabled). 1204Turn on/off ISO 14755 (default enabled).
1332 1205
1333=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1334 1207
1335Turn 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.
1336 1319
1337=back 1320=back
1338 1321
1339=head1 THE SCROLLBAR 1322=head1 THE SCROLLBAR
1340 1323
… …
1641 1624
1642=item B<SHELL> 1625=item B<SHELL>
1643 1626
1644The shell to be used for command execution, defaults to C</bin/sh>. 1627The shell to be used for command execution, defaults to C</bin/sh>.
1645 1628
1646=item B<RXVT_SOCKET> 1629=item B<RXVT_SOCKET> [I<sic>]
1647 1630
1648The unix domain socket path used by @@RXVT_NAME@@c(1) and 1631The unix domain socket path used by @@RXVT_NAME@@c(1) and
1649@@RXVT_NAME@@d(1). 1632@@RXVT_NAME@@d(1).
1650 1633
1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. 1634Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1635
1636=item B<URXVT_PERL_LIB>
1637
1638Additional F<:>-separated library search path for perl extensions. Will be
1639searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1640directory.
1641
1642=item B<URXVT_PERL_VERBOSITY>
1643
1644See L<@@RXVT_NAME@@perl>(3).
1652 1645
1653=item B<HOME> 1646=item B<HOME>
1654 1647
1655Used to locate the default directory for the unix domain socket for 1648Used to locate the default directory for the unix domain socket for
1656daemon communications and to locate various resource files (such as 1649daemon communications and to locate various resource files (such as
… …
1677 1670
1678=back 1671=back
1679 1672
1680=head1 SEE ALSO 1673=head1 SEE ALSO
1681 1674
1675@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1682@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1676@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1683 1677
1684=head1 CURRENT PROJECT COORDINATOR 1678=head1 CURRENT PROJECT COORDINATOR
1685 1679
1686=over 4 1680=over 4
1687 1681

Diff Legend

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