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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.188 by sf-exg, Thu Nov 4 12:13:20 2010 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

…		…
147	Tint the transparent background with the given colour;	147	Tint the transparent background with the given colour;
148	resource I<tintColor>.	148	resource I<tintColor>.
149		149
150	=item B<-sh> I<number>	150	=item B<-sh> I<number>
151		151
152	Darken (0 .. 100) or lighten (100 .. 200) the transparent background;	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153	resource I<shading>.	153	A value of 100 means no shading; resource I<shading>.
154		154
155	=item B<-blt> I<string>	155	=item B<-blt> I<string>
156		156
157	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
158	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
…		…
163	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
164		164
165	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
166		166
167	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
168	background. If a single number is specified - both vertical and	168	background. If a single number is specified, the vertical and
169	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
170	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
171	on some backgrounds. Maximum radius value is 128;	171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
172	resource I<blurRadius>.	173	resource I<blurRadius>.
173		174
174	=item B<-icon> I<file>	175	=item B<-icon> I<file>
175		176
176	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
…		…
183		184
184	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
185		186
186	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
187		188
188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	189	=item B<-pixmap> I<file[;oplist]>
189		190
190	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
191	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
192	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
193	command-line; for more details see resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
194		195
195	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
196		197
…		…
558	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
559	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
560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
562		563
563	1. system-wide app-defaults file, either locale-dependent OR global
564	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
566	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568	6. resources specified via -xrm on the commandline	569	6. resources specified via -xrm on the commandline
569		570
570	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
571	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
…		…
705	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
706	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
707		708
708	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
709		710
710	Tint the transparent background with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
711	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>.
712		716
713	=item B<shading:> I<number>	717	=item B<shading:> I<number>
714		718
715	Darken (0 .. 100) or lighten (100 .. 200) the transparent background;	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
716	option B<-sh>.	720	A value of 100 means no shading; option B<-sh>.
717		721
718	=item B<blendType:> I<string>	722	=item B<blendType:> I<string>
719		723
720	Specify background blending type; option B<-blt>.	724	Specify background blending type; option B<-blt>.
721		725
…		…
740	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
741		745
742	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
743	and the text.	747	and the text.
744		748
745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
746		750
747	Use the specified image file for the background and also	751	Use the specified image file for the background and also
748	optionally specify its scaling with a geometry string B<WxH+X+Y>,	752	optionally specify a colon separated list of operations to modify it.
749	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
750	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751	centre (percent). A scale of 0 displays the image with tiling.
752	The maximum permitted scale is 1000.
753	Additional operations can be specified after colon B<:op1:op2...>.
754	Supported operations are:	753	Supported operations are:
755		754
756	tile force background image to be tiled and not scaled. Equivalent to 0x0	755	=over 4
757	propscale will scale image keeping proportions	756
758	auto will scale image to match window size. Equivalent to 100x100	757	=item B<WxH+X+Y>
759	hscale will scale image horizontally to the window size	758
760	vscale will scale image vertically to the window size	759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
761	scale will scale image to match window size	760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
762	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.
763	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.
764		810
765	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
766	blended over the transparent background using alpha-blending. If I<afterimage>	812	blended over the transparent background using alpha-blending. If I<afterimage>
767	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
768	types with B<-blt "type"> option.	814	types with B<-blt "type"> option.
…		…
900	=item B<scrollstyle:> I<mode>	946	=item B<scrollstyle:> I<mode>
901		947
902	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
903	the author's favourite.	949	the author's favourite.
904		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
		954
905	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
906		956
907	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
908	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
909		959
…		…
928	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
929	B<+si>.	979	B<+si>.
930		980
931	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
932		982
933	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.
934	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
935	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>.
936		987
937	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
938		989
939	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
940	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
…		…
1154	performed in an exact manner; however, the closest match is assured.	1205	performed in an exact manner; however, the closest match is assured.
1155		1206
1156	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
1157	number), see RESOURCES in C<man 7 X> for further details.	1208	number), see RESOURCES in C<man 7 X> for further details.
1158		1209
1159	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>
1160	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1161	should be a character not used by the strings.	1213	should be a character not used by the strings.
1162		1214
1163	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1164		1216
1165	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1166		1218
1167	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1168		1220
1169	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1170	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1171	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1172		1224
1173	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>
1174	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1175	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>
1176	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
…		…
1249	the @@RXVT_NAME@@perl(3) manpage.	1301	the @@RXVT_NAME@@perl(3) manpage.
1250		1302
1251	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1252		1304
1253	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1254	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1255	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1256	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1257		1309
1258	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1259		1311
1260	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1509	White.	1561	White.
1510		1562
1511	=head2 ALPHA CHANNEL SUPPORT	1563	=head2 ALPHA CHANNEL SUPPORT
1512		1564
1513	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
1514	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:
1515		1567
1516	You can prefix any colour with an opaqueness percentage enclosed in	1568	You can prefix any colour with an opaqueness percentage enclosed in
1517	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
1518	(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
1519	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
…		…
1606	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1607		1659
1608	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
1609	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1610		1662
1611	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1612		1664
1613	=item B<HOME>	1665	=item B<HOME>
1614		1666
1615	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
1616	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1617	C<.Xdefaults>)	1669	C<.Xdefaults>)
1618		1670
1619	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1620		1672
1621	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1622		1674
1623	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1624		1676
1625	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
1626	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1692		1744
1693	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1694		1746
1695	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1696		1748
1697	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1698		1750
1699	=back	1751	=back
1700		1752

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.188 by sf-exg, Thu Nov 4 12:13:20 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.188 by sf-exg, Thu Nov 4 12:13:20 2010 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC