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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

…		…
150	=item B<-sh> I<number>	150	=item B<-sh> I<number>
151		151
152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153	A value of 100 means no shading; resource I<shading>.	153	A value of 100 means no shading; resource I<shading>.
154		154
155	=item B<-blt> I<string>
156
157	Specify background blending type. If background pixmap is specified
158	at the same time as transparency - such pixmap will be blended over
159	the transparent background, using the method specified. Supported values are:
160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
166		156
167	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
168	background. If a single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
169	horizontal radii are considered to be the same. Setting one of the	159	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	160	radii to 1 and the other to a large number creates interesting effects
171	on some backgrounds. Maximum radius value is 128;	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
172	resource I<blurRadius>.	163	resource I<blurRadius>.
173		164
174	=item B<-icon> I<file>	165	=item B<-icon> I<file>
175		166
176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This	167	Compile I<pixbuf>: Use the specified image as application icon. This
177	is used by many window managers, taskbars and pagers to represent the	168	is used by many window managers, taskbars and pagers to represent the
178	application window; resource I<iconFile>.	169	application window; resource I<iconFile>.
179		170
180	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
181		172
…		…
183		174
184	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
185		176
186	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
187		178
188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	179	=item B<-pixmap> I<file[;oplist]>
189		180
190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
191	optionally specify its scaling with a geometry string. Note you may need to	182	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	183	add quotes to avoid special shell interpretation of the C<;> in the
193	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
194		185
195	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
196		187
…		…
558	You can set and change the resources using X11 tools like B<xrdb>. Many	549	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	550	distribution do also load settings from the B<~/.Xresources> file when X
560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
562		553
563	1. system-wide app-defaults file, either locale-dependent OR global
564	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
566	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568	6. resources specified via -xrm on the commandline	559	6. resources specified via -xrm on the commandline
569		560
570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	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	562	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	696	Fade to this colour, when fading is used (see B<fading:>). The default
706	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
707		698
708	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
709		700
710	Tint the transparent background with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
711	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
712		706
713	=item B<shading:> I<number>	707	=item B<shading:> I<number>
714		708
715	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
716	A value of 100 means no shading; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
…		…
740	=item B<borderColor:> I<colour>	734	=item B<borderColor:> I<colour>
741		735
742	The colour of the border around the text area and between the scrollbar	736	The colour of the border around the text area and between the scrollbar
743	and the text.	737	and the text.
744		738
745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	739	=item B<backgroundPixmap:> I<file[;oplist]>
746		740
747	Use the specified image file for the background and also	741	Use the specified image file for the background and also
748	optionally specify its scaling with a geometry string B<WxH+X+Y>,	742	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:	743	Supported operations are:
755		744
756	tile force background image to be tiled and not scaled. Equivalent to 0x0	745	=over 4
757	propscale will scale image keeping proportions	746
758	auto will scale image to match window size. Equivalent to 100x100	747	=item B<WxH+X+Y>
759	hscale will scale image horizontally to the window size	748
760	vscale will scale image vertically to the window size	749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
761	scale will scale image to match window size	750	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	751	scale of 0 disables scaling. The maximum permitted scale is 1000.
763	whenever terminal window moves	752
		753	=item B<op=tile>
		754
		755	enables tiling
		756
		757	=item B<op=keep-aspect>
		758
		759	maintain the image aspect ratio when scaling
		760
		761	=item B<op=root-align>
		762
		763	use the position of the terminal window relative to the root window as
		764	the image offset, simulating a root window background
		765
		766	=back
		767
		768	The default scale and position setting is C<100x100+50+50>.
		769	Alternatively, a predefined set of templates can be used to achieve
		770	the most common setups:
		771
		772	=over 4
		773
		774	=item B<style=tiled>
		775
		776	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		777
		778	=item B<style=aspect-stretched>
		779
		780	the image is scaled to fill the whole window maintaining the aspect
		781	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		782
		783	=item B<style=stretched>
		784
		785	the image is scaled to fill the whole window. Equivalent to 100x100
		786
		787	=item B<style=centered>
		788
		789	the image is centered with no scaling. Equivalent to 0x0+50+50
		790
		791	=item B<style=root-tiled>
		792
		793	the image is tiled with no scaling and using 'root' positioning.
		794	Equivalent to 0x0:op=tile:op=root-align
		795
		796	=back
		797
		798	If multiple templates are specified the last one wins. Note that a
		799	template overrides all the scale, position and operations settings.
764		800
765	If used in conjunction with B<-tr> option, the specified pixmap will be	801	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>	802	blended over the transparent background using alpha-blending.
767	support has been compiled in it is possible to choose other blending
768	types with B<-blt "type"> option.
769		803
770	=item B<path:> I<path>	804	=item B<path:> I<path>
771		805
772	Specify the colon-delimited search path for finding background image files.	806	Specify the colon-delimited search path for finding background image files.
773		807
…		…
900	=item B<scrollstyle:> I<mode>	934	=item B<scrollstyle:> I<mode>
901		935
902	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	936	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
903	the author's favourite.	937	the author's favourite.
904		938
		939	=item B<thickness:> I<number>
		940
		941	Set the scrollbar width in pixels.
		942
905	=item B<scrollBar:> I<boolean>	943	=item B<scrollBar:> I<boolean>
906		944
907	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	945	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
908	disable the scrollbar; option B<+sb>.	946	disable the scrollbar; option B<+sb>.
909		947
…		…
928	B<False>: do not scroll to bottom when tty receives output; option	966	B<False>: do not scroll to bottom when tty receives output; option
929	B<+si>.	967	B<+si>.
930		968
931	=item B<scrollWithBuffer:> I<boolean>	969	=item B<scrollWithBuffer:> I<boolean>
932		970
933	B<True>: scroll with scrollback buffer when tty receives new lines (and	971	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	972	try to show the same lines) and B<scrollTtyOutput> is False; option
935	with scrollback buffer when tty receives new lines; option B<+sw>.	973	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		974	new lines; option B<+sw>.
936		975
937	=item B<scrollTtyKeypress:> I<boolean>	976	=item B<scrollTtyKeypress:> I<boolean>
938		977
939	B<True>: scroll to bottom when a non-special key is pressed. Special keys	978	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	979	are those which are intercepted by rxvt-unicode for special handling and
…		…
1154	performed in an exact manner; however, the closest match is assured.	1193	performed in an exact manner; however, the closest match is assured.
1155		1194
1156	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1195	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1157	number), see RESOURCES in C<man 7 X> for further details.	1196	number), see RESOURCES in C<man 7 X> for further details.
1158		1197
1159	You can define a range of keysyms in one shot by providing a I<string>	1198	You can define a range of keysyms in one shot by
		1199	loading the C<keysym-list> perl extension and providing a I<string>
1160	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1161	should be a character not used by the strings.	1201	should be a character not used by the strings.
1162		1202
1163	Its usage can be demonstrated by an example:	1203	Its usage can be demonstrated by an example:
1164		1204
1165	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1166		1206
1167	The above line is equivalent to the following three lines:	1207	The above line is equivalent to the following three lines:
1168		1208
1169	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1209	URxvt.keysym.Meta-Control-0x61: \033<a>
1170	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1210	URxvt.keysym.Meta-Control-0x62: \033<b>
1171	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1211	URxvt.keysym.Meta-Control-0x63: \033<c>
1172		1212
1173	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1213	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	1214	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>	1215	example the following means "change the current locale to C<zh_CN.GBK>
1176	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
…		…
1249	the @@RXVT_NAME@@perl(3) manpage.	1289	the @@RXVT_NAME@@perl(3) manpage.
1250		1290
1251	=item B<perl-lib>: I<path>	1291	=item B<perl-lib>: I<path>
1252		1292
1253	Colon-separated list of additional directories that hold extension	1293	Colon-separated list of additional directories that hold extension
1254	scripts. When looking for extensions specified by the C<perl> resource,	1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1255	@@RXVT_NAME@@ will first look in these directories and then in	1295	look in these directories, then in $HOME/.urxvt/ext and lastly in
1256	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1257		1297
1258	See the @@RXVT_NAME@@perl(3) manpage.	1298	See the @@RXVT_NAME@@perl(3) manpage.
1259		1299
1260	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1509	White.	1549	White.
1510		1550
1511	=head2 ALPHA CHANNEL SUPPORT	1551	=head2 ALPHA CHANNEL SUPPORT
1512		1552
1513	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1553	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:	1554	their act together, rxvt-unicode will do its own alpha channel management:
1515		1555
1516	You can prefix any colour with an opaqueness percentage enclosed in	1556	You can prefix any colour with an opaqueness percentage enclosed in
1517	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1557	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	1558	(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	1559	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1606	=item B<RXVT_SOCKET>	1646	=item B<RXVT_SOCKET>
1607		1647
1608	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1648	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1609	@@RXVT_NAME@@d(1).	1649	@@RXVT_NAME@@d(1).
1610		1650
1611	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1612		1652
1613	=item B<HOME>	1653	=item B<HOME>
1614		1654
1615	Used to locate the default directory for the unix domain socket for	1655	Used to locate the default directory for the unix domain socket for
1616	daemon communications and to locate various resource files (such as	1656	daemon communications and to locate various resource files (such as
1617	C<.Xdefaults>)	1657	C<.Xdefaults>)
1618		1658
1619	=item B<XAPPLRESDIR>	1659	=item B<XAPPLRESDIR>
1620		1660
1621	Directory where various X resource files are being located.	1661	Directory where application-specific X resource files are located.
1622		1662
1623	=item B<XENVIRONMENT>	1663	=item B<XENVIRONMENT>
1624		1664
1625	If set and accessible, gives the name of a X resource file to be loaded by	1665	If set and accessible, gives the name of a X resource file to be loaded by
1626	@@RXVT_NAME@@.	1666	@@RXVT_NAME@@.
…		…
1692		1732
1693	Project Coordinator (Changes 1.0 -)	1733	Project Coordinator (Changes 1.0 -)
1694		1734
1695	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1696		1736
1697	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1698		1738
1699	=back	1739	=back
1700		1740

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC vs. Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC