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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs.
Revision 1.206 by sf-exg, Sun Nov 20 10:58:58 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		133
134	=item B<-fade> I<number>	134	=item B<-fade> I<number>
…		…
142	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
143	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
144		144
145	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
146		146
147	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
148	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
149	non-tiled backgrounds, currently. See also the B<-sh> option that can be
150	used to brighten or darken the image in addition to tinting it.
151	Please note that certain tint colours can be applied on the server-side,
152	thus yielding performance gain of two orders of magnitude. These colours are:
153	blue, red, green, cyan, magenta, yellow, and those close to them. Also
154	pure black and pure white colours essentially mean no tinting; resource
155	I<tintColor>. Example:
156
157	@@RXVT_NAME@@ -tr -tint blue -sh 40
158		149
159	=item B<-sh> I<number>	150	=item B<-sh> I<number>
160		151
161	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
162	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
163	resource I<shading>.
164		154
165	=item B<-blt> I<string>	155	=item B<-blt> I<string>
166		156
167	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
168	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
169	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171	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>,
172	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
173	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
174		164
175	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
176		166
177	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
178	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
179	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
180	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
181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;	171	on some backgrounds. Maximum radius value is 128;
182	resource I<blurRadius>.	172	resource I<blurRadius>.
183		173
184	=item B<-icon> I<file>	174	=item B<-icon> I<file>
185		175
186	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
…		…
193		183
194	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
195		185
196	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
197		187
198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;oplist]>
199		189
200	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
201	optionally specify its scaling with a geometry string. Note you may need to	191	optionally specify a list of operations to modify it. Note you may need to
202	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
203	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
204		194
205	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
206		196
…		…
568	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
569	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
570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
571	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
572		562
573	1. system-wide app-defaults file, either locale-dependent OR global
574	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
575	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
576	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
579		569
580	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
581	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
…		…
699	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
700	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
701		691
702	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
703		693
704	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
705		695
706	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
707	future versions.	697	future versions.
708		698
709	=item B<fading:> I<number>	699	=item B<fading:> I<number>
…		…
715	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
716	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
717		707
718	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
719		709
720	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
721	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>.
722		715
723	=item B<shading:> I<number>	716	=item B<shading:> I<number>
724		717
725	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
726	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
727		720
728	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
729		722
730	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
731		724
732	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
733		726
734	Apply gaussian blur with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
735	background image; option B<-blr>.	728	background; option B<-blr>.
736		729
737	=item B<iconFile:> I<file>	730	=item B<iconFile:> I<file>
738		731
739	Set the application icon pixmap; option B<-icon>.	732	Set the application icon pixmap; option B<-icon>.
740		733
…		…
750	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
751		744
752	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
753	and the text.	746	and the text.
754		747
755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
756		749
757	Use the specified image file for the background and also	750	Use the specified image file for the background and also
758	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
759	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
760	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
761	centre (percent). A scale of 0 displays the image with tiling.
762	The maximum permitted scale is 1000.
763	Additional operations can be specified after colon B<:op1:op2...>.
764	Supported operations are:	752	Supported operations are:
765		753
766	tile force background image to be tiled and not scaled. Equivalent to 0x0	754	=over 4
767	propscale will scale image keeping proportions	755
768	auto will scale image to match window size. Equivalent to 100x100	756	=item B<WxH+X+Y>
769	hscale will scale image horizontally to the window size	757
770	vscale will scale image vertically to the window size	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
771	scale will scale image to match window size	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
772	root will tile image as if it was a root window background, auto-adjusting	760	scale of 0 disables scaling. The maximum permitted scale is 1000.
773	whenever terminal window moves	761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=pscale>
		767
		768	enables proportional scaling
		769
		770	=item B<op=root>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=pscale
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
774		809
775	If used in conjunction with B<-tr> option, the specified pixmap will be	810	If used in conjunction with B<-tr> option, the specified pixmap will be
776	blended over transparency image using alpha-blending. If I<afterimage>	811	blended over the transparent background using alpha-blending. If I<afterimage>
777	support has been compiled in it is possible to choose other blending	812	support has been compiled in it is possible to choose other blending
778	types with B<-blt "type"> option.	813	types with B<-blt "type"> option.
779		814
780	=item B<path:> I<path>	815	=item B<path:> I<path>
781		816
…		…
910	=item B<scrollstyle:> I<mode>	945	=item B<scrollstyle:> I<mode>
911		946
912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
913	the author's favourite.	948	the author's favourite.
914		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
915	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
916		955
917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
919		958
…		…
938	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
939	B<+si>.	978	B<+si>.
940		979
941	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
942		981
943	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
944	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	983	try to show the same lines) and B<scrollTtyOutput> is False; option
945	with scrollback buffer when tty receives new lines; option B<+sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
946		986
947	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
948		988
949	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	B<True>: scroll to bottom when a non-special key is pressed. Special keys
950	are those which are intercepted by rxvt-unicode for special handling and	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1210	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1171	should be a character not used by the strings.	1211	should be a character not used by the strings.
1172		1212
1173	Its usage can be demonstrated by an example:	1213	Its usage can be demonstrated by an example:
1174		1214
1175	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1215	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1176		1216
1177	The above line is equivalent to the following three lines:	1217	The above line is equivalent to the following three lines:
1178		1218
1179	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1219	URxvt.keysym.Meta-Control-0x61: \033<a>
1180	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1220	URxvt.keysym.Meta-Control-0x62: \033<b>
1181	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1221	URxvt.keysym.Meta-Control-0x63: \033<c>
1182		1222
1183	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1223	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1184	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1224	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1185	example the following means "change the current locale to C<zh_CN.GBK>	1225	example the following means "change the current locale to C<zh_CN.GBK>
1186	when Control-Meta-c is being pressed":	1226	when Control-Meta-c is being pressed":
…		…
1259	the @@RXVT_NAME@@perl(3) manpage.	1299	the @@RXVT_NAME@@perl(3) manpage.
1260		1300
1261	=item B<perl-lib>: I<path>	1301	=item B<perl-lib>: I<path>
1262		1302
1263	Colon-separated list of additional directories that hold extension	1303	Colon-separated list of additional directories that hold extension
1264	scripts. When looking for extensions specified by the C<perl> resource,	1304	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1265	@@RXVT_NAME@@ will first look in these directories and then in	1305	look in these directories, then in $HOME/.urxvt/ext and lastly in
1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1306	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267		1307
1268	See the @@RXVT_NAME@@perl(3) manpage.	1308	See the @@RXVT_NAME@@perl(3) manpage.
1269		1309
1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1310	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1616	=item B<RXVT_SOCKET>	1656	=item B<RXVT_SOCKET>
1617		1657
1618	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1658	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619	@@RXVT_NAME@@d(1).	1659	@@RXVT_NAME@@d(1).
1620		1660
1621	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1661	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1622		1662
1623	=item B<HOME>	1663	=item B<HOME>
1624		1664
1625	Used to locate the default directory for the unix domain socket for	1665	Used to locate the default directory for the unix domain socket for
1626	daemon communications and to locate various resource files (such as	1666	daemon communications and to locate various resource files (such as
1627	C<.Xdefaults>)	1667	C<.Xdefaults>)
1628		1668
1629	=item B<XAPPLRESDIR>	1669	=item B<XAPPLRESDIR>
1630		1670
1631	Directory where various X resource files are being located.	1671	Directory where application-specific X resource files are located.
1632		1672
1633	=item B<XENVIRONMENT>	1673	=item B<XENVIRONMENT>
1634		1674
1635	If set and accessible, gives the name of a X resource file to be loaded by	1675	If set and accessible, gives the name of a X resource file to be loaded by
1636	@@RXVT_NAME@@.	1676	@@RXVT_NAME@@.
…		…
1702		1742
1703	Project Coordinator (Changes 1.0 -)	1743	Project Coordinator (Changes 1.0 -)
1704		1744
1705	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1745	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1706		1746
1707	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1747	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708		1748
1709	=back	1749	=back
1710		1750

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs. Revision 1.206 by sf-exg, Sun Nov 20 10:58:58 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs.
Revision 1.206 by sf-exg, Sun Nov 20 10:58:58 2011 UTC