[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.202 by sf-exg, Thu Aug 11 08:37:17 2011 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 - both 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 another 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. Maximum radius value is 128;
185	resource I<blurRadius>.	172	resource I<blurRadius>.
186		173
187	=item B<-icon> I<file>	174	=item B<-icon> I<file>
188		175
189	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This	176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
…		…
571	You can set and change the resources using X11 tools like B<xrdb>. Many	558	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	559	distribution do also load settings from the B<~/.Xresources> file when X
573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
575		562
576	1. system-wide app-defaults file, either locale-dependent OR global
577	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
579	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
582		569
583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	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	571	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	689	if the refresh is too fast for the human eye to read anything (or the
703	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
704		691
705	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
706		693
707	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
708		695
709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710	future versions.	697	future versions.
711		698
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>	699	=item B<fading:> I<number>
716		700
717	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
718		702
719	=item B<fadeColor:> I<colour>	703	=item B<fadeColor:> I<colour>
…		…
721	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
722	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
723		707
724	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
725		709
726	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
727	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
728		715
729	=item B<shading:> I<number>	716	=item B<shading:> I<number>
730		717
731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
732	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
733		720
734	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
735		722
736	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
737		724
738	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
739		726
740	Apply gaussian blur with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
741	background image; option B<-blr>.	728	background; option B<-blr>.
742		729
743	=item B<iconFile:> I<file>	730	=item B<iconFile:> I<file>
744		731
745	Set the application icon pixmap; option B<-icon>.	732	Set the application icon pixmap; option B<-icon>.
746		733
…		…
762		749
763	Use the specified image file for the background and also	750	Use the specified image file for the background and also
764	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767	centre (percent). A scale of 0 displays the image with tiling.	754	centre (percent). A scale of 0 disables scaling.
768	The maximum permitted scale is 1000.	755	The maximum permitted scale is 1000.
769	Additional operations can be specified after colon B<:op1:op2...>.	756	Additional operations can be specified after colon B<:op1:op2...>.
770	Supported operations are:	757	Supported operations are:
771		758
772	tile force background image to be tiled and not scaled. Equivalent to 0x0	759	op=tile enables tiling
773	propscale will scale image keeping proportions	760	op=pscale enables proportional scaling
774	auto will scale image to match window size. Equivalent to 100x100	761	op=root use the position of the terminal window relative to the root
775	hscale will scale image horizontally to the window size	762	window as the image offset, simulating a root window background
776	vscale will scale image vertically to the window size	763
777	scale will scale image to match window size	764	Alternatively, a predefined set of templates can be used to achieve
778	root will tile image as if it was a root window background, auto-adjusting	765	the most common setups:
779	whenever terminal window moves	766
		767	style=tiled the image is tiled with no scaling
		768	style=aspect-stretched the image is scaled to fill the whole window maintaining
		769	the aspect ratio and centered
		770	style=stretched the image is scaled to fill the whole window
		771	style=centered the image is centered with no scaling
		772	style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
		773
		774	If multiple templates are specified the last one wins. Note that a
		775	template overrides all the scale, position and operations settings.
		776	Indeed, the templates can be specified in terms of low level settings
		777	as follows:
		778
		779	style=tiled 0x0+0+0:op=tile
		780	style=aspect-stretched +50+50:op=pscale
		781	style=stretched 100x100
		782	style=centered 0x0+50+50
		783	style=root-tiled 0x0:op=tile:op=root
780		784
781	If used in conjunction with B<-tr> option, the specified pixmap will be	785	If used in conjunction with B<-tr> option, the specified pixmap will be
782	blended over transparency image using alpha-blending. If I<afterimage>	786	blended over the transparent background using alpha-blending. If I<afterimage>
783	support has been compiled in it is possible to choose other blending	787	support has been compiled in it is possible to choose other blending
784	types with B<-blt "type"> option.	788	types with B<-blt "type"> option.
785		789
786	=item B<path:> I<path>	790	=item B<path:> I<path>
787		791
…		…
916	=item B<scrollstyle:> I<mode>	920	=item B<scrollstyle:> I<mode>
917		921
918	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	922	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
919	the author's favourite.	923	the author's favourite.
920		924
		925	=item B<thickness:> I<number>
		926
		927	Set the scrollbar width in pixels.
		928
921	=item B<scrollBar:> I<boolean>	929	=item B<scrollBar:> I<boolean>
922		930
923	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	931	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
924	disable the scrollbar; option B<+sb>.	932	disable the scrollbar; option B<+sb>.
925		933
…		…
944	B<False>: do not scroll to bottom when tty receives output; option	952	B<False>: do not scroll to bottom when tty receives output; option
945	B<+si>.	953	B<+si>.
946		954
947	=item B<scrollWithBuffer:> I<boolean>	955	=item B<scrollWithBuffer:> I<boolean>
948		956
949	B<True>: scroll with scrollback buffer when tty receives new lines (and	957	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	958	try to show the same lines) and B<scrollTtyOutput> is False; option
951	with scrollback buffer when tty receives new lines; option B<+sw>.	959	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		960	new lines; option B<+sw>.
952		961
953	=item B<scrollTtyKeypress:> I<boolean>	962	=item B<scrollTtyKeypress:> I<boolean>
954		963
955	B<True>: scroll to bottom when a non-special key is pressed. Special keys	964	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	965	are those which are intercepted by rxvt-unicode for special handling and
…		…
1176	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1185	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1177	should be a character not used by the strings.	1186	should be a character not used by the strings.
1178		1187
1179	Its usage can be demonstrated by an example:	1188	Its usage can be demonstrated by an example:
1180		1189
1181	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1190	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1182		1191
1183	The above line is equivalent to the following three lines:	1192	The above line is equivalent to the following three lines:
1184		1193
1185	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1194	URxvt.keysym.Meta-Control-0x61: \033<a>
1186	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1195	URxvt.keysym.Meta-Control-0x62: \033<b>
1187	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1196	URxvt.keysym.Meta-Control-0x63: \033<c>
1188		1197
1189	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1198	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	1199	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>	1200	example the following means "change the current locale to C<zh_CN.GBK>
1192	when Control-Meta-c is being pressed":	1201	when Control-Meta-c is being pressed":
…		…
1622	=item B<RXVT_SOCKET>	1631	=item B<RXVT_SOCKET>
1623		1632
1624	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1633	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1625	@@RXVT_NAME@@d(1).	1634	@@RXVT_NAME@@d(1).
1626		1635
1627	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1636	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1628		1637
1629	=item B<HOME>	1638	=item B<HOME>
1630		1639
1631	Used to locate the default directory for the unix domain socket for	1640	Used to locate the default directory for the unix domain socket for
1632	daemon communications and to locate various resource files (such as	1641	daemon communications and to locate various resource files (such as
1633	C<.Xdefaults>)	1642	C<.Xdefaults>)
1634		1643
1635	=item B<XAPPLRESDIR>	1644	=item B<XAPPLRESDIR>
1636		1645
1637	Directory where various X resource files are being located.	1646	Directory where application-specific X resource files are located.
1638		1647
1639	=item B<XENVIRONMENT>	1648	=item B<XENVIRONMENT>
1640		1649
1641	If set and accessible, gives the name of a X resource file to be loaded by	1650	If set and accessible, gives the name of a X resource file to be loaded by
1642	@@RXVT_NAME@@.	1651	@@RXVT_NAME@@.
…		…
1708		1717
1709	Project Coordinator (Changes 1.0 -)	1718	Project Coordinator (Changes 1.0 -)
1710		1719
1711	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1720	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1712		1721
1713	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1722	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1714		1723
1715	=back	1724	=back
1716		1725

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.202 by sf-exg, Thu Aug 11 08:37:17 2011 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.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC