[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

…		…
124		124
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		126
127	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
128		128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		130
131	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	132	future versions.
133
134	I<Please address all transparency related issues to Sasha Vasko at
135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136		133
137	=item B<-fade> I<number>	134	=item B<-fade> I<number>
138		135
139	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
140	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
145	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
147		144
148	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
149		146
150	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colours essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161		149
162	=item B<-sh> I<number>	150	=item B<-sh> I<number>
163		151
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
166	resource I<shading>.
167		154
168	=item B<-blt> I<string>	155	=item B<-blt> I<string>
169		156
170	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177		164
178	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
179		166
180	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	168	background. If a single number is specified, the vertical and
182	horizontal radii are considered to be the same. Setting one of the	169	horizontal radii are considered to be the same. Setting one of the
183	radii to 1 and another to a large number creates interesting effects	170	radii to 1 and the other to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;	171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
185	resource I<blurRadius>.	173	resource I<blurRadius>.
186		174
187	=item B<-icon> I<file>	175	=item B<-icon> I<file>
188		176
189	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This	177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
…		…
196		184
197	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
198		186
199	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
200		188
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	189	=item B<-pixmap> I<file[;oplist]>
202		190
203	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also	191	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
204	optionally specify its scaling with a geometry string. Note you may need to	192	optionally specify a list of operations to modify it. Note you may need to
205	add quotes to avoid special shell interpretation of the C<;> in the	193	add quotes to avoid special shell interpretation of the C<;> in the
206	command-line; for more details see resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
207		195
208	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
209		197
…		…
571	You can set and change the resources using X11 tools like B<xrdb>. Many	559	You can set and change the resources using X11 tools like B<xrdb>. Many
572	distribution do also load settings from the B<~/.Xresources> file when X	560	distribution do also load settings from the B<~/.Xresources> file when X
573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
575		563
576	1. system-wide app-defaults file, either locale-dependent OR global
577	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
579	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581	6. resources specified via -xrm on the commandline	569	6. resources specified via -xrm on the commandline
582		570
583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	571	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	572	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
702	if the refresh is too fast for the human eye to read anything (or the	690	if the refresh is too fast for the human eye to read anything (or the
703	monitor to display anything); option B<+ss>.	691	monitor to display anything); option B<+ss>.
704		692
705	=item B<transparent:> I<boolean>	693	=item B<transparent:> I<boolean>
706		694
707	Turn on/off illusion of a transparent window background.	695	Turn on/off pseudo-transparency by using the root pixmap as background.
708		696
709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710	future versions.	698	future versions.
711		699
712	I<Please address all transparency related issues to Sasha Vasko at
713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
714
715	=item B<fading:> I<number>	700	=item B<fading:> I<number>
716		701
717	Fade the text by the given percentage when focus is lost; option B<-fade>.	702	Fade the text by the given percentage when focus is lost; option B<-fade>.
718		703
719	=item B<fadeColor:> I<colour>	704	=item B<fadeColor:> I<colour>
…		…
721	Fade to this colour, when fading is used (see B<fading:>). The default	706	Fade to this colour, when fading is used (see B<fading:>). The default
722	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
723		708
724	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
725		710
726	Tint the transparent background pixmap with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
727	B<-tint>.	712	extension is not available only black, red, green, yellow, blue,
		713	magenta, cyan and white tints can be performed server-side. Note that
		714	a black tint yields a completely black image while a white tint yields
		715	the image unchanged; option B<-tint>.
728		716
729	=item B<shading:> I<number>	717	=item B<shading:> I<number>
730		718
731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
732	in addition to tinting it; option B<-sh>.	720	A value of 100 means no shading; option B<-sh>.
733		721
734	=item B<blendType:> I<string>	722	=item B<blendType:> I<string>
735		723
736	Specify background blending type; option B<-blt>.	724	Specify background blending type; option B<-blt>.
737		725
738	=item B<blurRadius:> I<number>	726	=item B<blurRadius:> I<number>
739		727
740	Apply gaussian blur with the specified radius to the transparent	728	Apply gaussian blur with the specified radius to the transparent
741	background image; option B<-blr>.	729	background; option B<-blr>.
742		730
743	=item B<iconFile:> I<file>	731	=item B<iconFile:> I<file>
744		732
745	Set the application icon pixmap; option B<-icon>.	733	Set the application icon pixmap; option B<-icon>.
746		734
…		…
756	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
757		745
758	The colour of the border around the text area and between the scrollbar	746	The colour of the border around the text area and between the scrollbar
759	and the text.	747	and the text.
760		748
761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
762		750
763	Use the specified image file for the background and also	751	Use the specified image file for the background and also
764	optionally specify its scaling with a geometry string B<WxH+X+Y>,	752	optionally specify a colon separated list of operations to modify it.
765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767	centre (percent). A scale of 0 displays the image with tiling.
768	The maximum permitted scale is 1000.
769	Additional operations can be specified after colon B<:op1:op2...>.
770	Supported operations are:	753	Supported operations are:
771		754
772	tile force background image to be tiled and not scaled. Equivalent to 0x0	755	=over 4
773	propscale will scale image keeping proportions	756
774	auto will scale image to match window size. Equivalent to 100x100	757	=item B<WxH+X+Y>
775	hscale will scale image horizontally to the window size	758
776	vscale will scale image vertically to the window size	759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
777	scale will scale image to match window size	760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
778	root will tile image as if it was a root window background, auto-adjusting	761	scale of 0 disables scaling. The maximum permitted scale is 1000.
779	whenever terminal window moves	762
		763	=item B<op=tile>
		764
		765	enables tiling
		766
		767	=item B<op=keep-aspect>
		768
		769	maintain the image aspect ratio when scaling
		770
		771	=item B<op=root-align>
		772
		773	use the position of the terminal window relative to the root window as
		774	the image offset, simulating a root window background
		775
		776	=back
		777
		778	The default scale and position setting is C<100x100+50+50>.
		779	Alternatively, a predefined set of templates can be used to achieve
		780	the most common setups:
		781
		782	=over 4
		783
		784	=item B<style=tiled>
		785
		786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		787
		788	=item B<style=aspect-stretched>
		789
		790	the image is scaled to fill the whole window maintaining the aspect
		791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		792
		793	=item B<style=stretched>
		794
		795	the image is scaled to fill the whole window. Equivalent to 100x100
		796
		797	=item B<style=centered>
		798
		799	the image is centered with no scaling. Equivalent to 0x0+50+50
		800
		801	=item B<style=root-tiled>
		802
		803	the image is tiled with no scaling and using 'root' positioning.
		804	Equivalent to 0x0:op=tile:op=root-align
		805
		806	=back
		807
		808	If multiple templates are specified the last one wins. Note that a
		809	template overrides all the scale, position and operations settings.
780		810
781	If used in conjunction with B<-tr> option, the specified pixmap will be	811	If used in conjunction with B<-tr> option, the specified pixmap will be
782	blended over transparency image using alpha-blending. If I<afterimage>	812	blended over the transparent background using alpha-blending. If I<afterimage>
783	support has been compiled in it is possible to choose other blending	813	support has been compiled in it is possible to choose other blending
784	types with B<-blt "type"> option.	814	types with B<-blt "type"> option.
785		815
786	=item B<path:> I<path>	816	=item B<path:> I<path>
787		817
…		…
916	=item B<scrollstyle:> I<mode>	946	=item B<scrollstyle:> I<mode>
917		947
918	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	948	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
919	the author's favourite.	949	the author's favourite.
920		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
		954
921	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
922		956
923	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
924	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
925		959
…		…
944	B<False>: do not scroll to bottom when tty receives output; option	978	B<False>: do not scroll to bottom when tty receives output; option
945	B<+si>.	979	B<+si>.
946		980
947	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
948		982
949	B<True>: scroll with scrollback buffer when tty receives new lines (and	983	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
950	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	984	try to show the same lines) and B<scrollTtyOutput> is False; option
951	with scrollback buffer when tty receives new lines; option B<+sw>.	985	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		986	new lines; option B<+sw>.
952		987
953	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
954		989
955	B<True>: scroll to bottom when a non-special key is pressed. Special keys	990	B<True>: scroll to bottom when a non-special key is pressed. Special keys
956	are those which are intercepted by rxvt-unicode for special handling and	991	are those which are intercepted by rxvt-unicode for special handling and
…		…
1170	performed in an exact manner; however, the closest match is assured.	1205	performed in an exact manner; however, the closest match is assured.
1171		1206
1172	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1207	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1173	number), see RESOURCES in C<man 7 X> for further details.	1208	number), see RESOURCES in C<man 7 X> for further details.
1174		1209
1175	You can define a range of keysyms in one shot by providing a I<string>	1210	You can define a range of keysyms in one shot by
		1211	loading the C<keysym-list> perl extension and providing a I<string>
1176	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1177	should be a character not used by the strings.	1213	should be a character not used by the strings.
1178		1214
1179	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1180		1216
1181	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1182		1218
1183	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1184		1220
1185	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1186	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1187	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1188		1224
1189	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1190	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1191	example the following means "change the current locale to C<zh_CN.GBK>	1227	example the following means "change the current locale to C<zh_CN.GBK>
1192	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
…		…
1265	the @@RXVT_NAME@@perl(3) manpage.	1301	the @@RXVT_NAME@@perl(3) manpage.
1266		1302
1267	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1268		1304
1269	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1270	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1271	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1272	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1273		1309
1274	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1275		1311
1276	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1525	White.	1561	White.
1526		1562
1527	=head2 ALPHA CHANNEL SUPPORT	1563	=head2 ALPHA CHANNEL SUPPORT
1528		1564
1529	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1565	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1530	their act together, rxvt-unicode will do it's own alpha channel management:	1566	their act together, rxvt-unicode will do its own alpha channel management:
1531		1567
1532	You can prefix any colour with an opaqueness percentage enclosed in	1568	You can prefix any colour with an opaqueness percentage enclosed in
1533	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1569	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1534	(0-100) that specifies the opacity of the colour, where C<0> is completely	1570	(0-100) that specifies the opacity of the colour, where C<0> is completely
1535	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1571	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1622	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1623		1659
1624	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1625	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1626		1662
1627	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1628		1664
1629	=item B<HOME>	1665	=item B<HOME>
1630		1666
1631	Used to locate the default directory for the unix domain socket for	1667	Used to locate the default directory for the unix domain socket for
1632	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1633	C<.Xdefaults>)	1669	C<.Xdefaults>)
1634		1670
1635	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1636		1672
1637	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1638		1674
1639	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1640		1676
1641	If set and accessible, gives the name of a X resource file to be loaded by	1677	If set and accessible, gives the name of a X resource file to be loaded by
1642	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1708		1744
1709	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1710		1746
1711	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1712		1748
1713	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1714		1750
1715	=back	1751	=back
1716		1752

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC vs. Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC