[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.216 by root, Tue Jun 5 21:29:51 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		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
165	=item B<-blt> I<string>
166
167	Specify background blending type. If background pixmap is specified
168	at the same time as transparency - such pixmap will be blended over
169	transparency image, using method specified. Supported values are :
170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171	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
173	alpha-blending. Compile I<afterimage>; resource I<blendType>.
174		154
175	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
176		156
177	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
178	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
179	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
180	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
181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
182	resource I<blurRadius>.	163	resource I<blurRadius>.
183		164
184	=item B<-icon> I<file>	165	=item B<-icon> I<file>
185		166
186	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
187	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
188	application window; resource I<iconFile>.	169	application window; resource I<iconFile>.
189		170
190	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
191		172
…		…
193		174
194	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
195		176
196	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
197		178
198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	179	=item B<-pixmap> I<file[;oplist]>
199		180
200	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
201	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
202	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
203	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
204		185
205	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
206		187
…		…
568	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
569	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
570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
571	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
572		553
573	1. system-wide app-defaults file, either locale-dependent OR global
574	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
575	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
576	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578	6. resources specified via -xrm on the commandline	559	6. resources specified via -xrm on the commandline
579		560
580	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
581	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
…		…
699	if the refresh is too fast for the human eye to read anything (or the	680	if the refresh is too fast for the human eye to read anything (or the
700	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
701		682
702	=item B<transparent:> I<boolean>	683	=item B<transparent:> I<boolean>
703		684
704	Turn on/off illusion of a transparent window background.	685	Turn on/off pseudo-transparency by using the root pixmap as background.
705		686
706	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
707	future versions.	688	future versions.
708		689
709	=item B<fading:> I<number>	690	=item B<fading:> I<number>
…		…
715	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
716	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
717		698
718	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
719		700
720	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
721	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>.
722		706
723	=item B<shading:> I<number>	707	=item B<shading:> I<number>
724		708
725	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
726	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
727
728	=item B<blendType:> I<string>
729
730	Specify background blending type; option B<-blt>.
731		711
732	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
733		713
734	Apply gaussian blur with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
735	background image; option B<-blr>.	715	background; option B<-blr>.
736		716
737	=item B<iconFile:> I<file>	717	=item B<iconFile:> I<file>
738		718
739	Set the application icon pixmap; option B<-icon>.	719	Set the application icon pixmap; option B<-icon>.
740		720
…		…
750	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
751		731
752	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
753	and the text.	733	and the text.
754		734
755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
756		736
757	Use the specified image file for the background and also	737	Use the specified image file for the background and also
758	optionally specify its scaling with a geometry string B<WxH+X+Y>,	738	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:	739	Supported operations are:
765		740
766	tile force background image to be tiled and not scaled. Equivalent to 0x0	741	=over 4
767	propscale will scale image keeping proportions	742
768	auto will scale image to match window size. Equivalent to 100x100	743	=item B<WxH+X+Y>
769	hscale will scale image horizontally to the window size	744
770	vscale will scale image vertically to the window size	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
771	scale will scale image to match window size	746	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	747	scale of 0 disables scaling.
773	whenever terminal window moves	748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
774		796
775	If used in conjunction with B<-tr> option, the specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
776	blended over transparency image using alpha-blending. If I<afterimage>	798	blended over the transparent background using alpha-blending.
777	support has been compiled in it is possible to choose other blending
778	types with B<-blt "type"> option.
779		799
780	=item B<path:> I<path>	800	=item B<path:> I<path>
781		801
782	Specify the colon-delimited search path for finding background image files.	802	Specify the colon-delimited search path for finding background image files.
783		803
…		…
910	=item B<scrollstyle:> I<mode>	930	=item B<scrollstyle:> I<mode>
911		931
912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
913	the author's favourite.	933	the author's favourite.
914		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
915	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
916		940
917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
919		943
…		…
938	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
939	B<+si>.	963	B<+si>.
940		964
941	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
942		966
943	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	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	968	try to show the same lines) and B<scrollTtyOutput> is False; option
945	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
946		971
947	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
948		973
949	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	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	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
1164	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1165		1190
1166	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1167	number), see RESOURCES in C<man 7 X> for further details.	1192	number), see RESOURCES in C<man 7 X> for further details.
1168		1193
1169	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1171	should be a character not used by the strings.	1197	should be a character not used by the strings.
1172		1198
1173	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1174		1200
1175	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1176		1202
1177	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1178		1204
1179	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1180	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1181	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1182		1208
1183	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	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	1210	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>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1186	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
…		…
1259	the @@RXVT_NAME@@perl(3) manpage.	1285	the @@RXVT_NAME@@perl(3) manpage.
1260		1286
1261	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1262		1288
1263	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1264	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1265	@@RXVT_NAME@@ will first look in these directories and then in	1291	in these directories, then in C<$RXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1292	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267		1293
1268	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1269		1295
1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1271		1297
…		…
1519	White.	1545	White.
1520		1546
1521	=head2 ALPHA CHANNEL SUPPORT	1547	=head2 ALPHA CHANNEL SUPPORT
1522		1548
1523	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1524	their act together, rxvt-unicode will do it's own alpha channel management:	1550	their act together, rxvt-unicode will do its own alpha channel management:
1525		1551
1526	You can prefix any colour with an opaqueness percentage enclosed in	1552	You can prefix any colour with an opaqueness percentage enclosed in
1527	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1528	(0-100) that specifies the opacity of the colour, where C<0> is completely	1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
1529	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1611		1637
1612	=item B<SHELL>	1638	=item B<SHELL>
1613		1639
1614	The shell to be used for command execution, defaults to C</bin/sh>.	1640	The shell to be used for command execution, defaults to C</bin/sh>.
1615		1641
1616	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET> (sic)
1617		1643
1618	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1620		1646
1621	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1648
		1649	=item B<RXVT_PERL_LIB> (sic)
		1650
		1651	Additional F<:>-separated library search path for perl extensions. Will be
		1652	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1653	directory.
1622		1654
1623	=item B<HOME>	1655	=item B<HOME>
1624		1656
1625	Used to locate the default directory for the unix domain socket for	1657	Used to locate the default directory for the unix domain socket for
1626	daemon communications and to locate various resource files (such as	1658	daemon communications and to locate various resource files (such as
1627	C<.Xdefaults>)	1659	C<.Xdefaults>)
1628		1660
1629	=item B<XAPPLRESDIR>	1661	=item B<XAPPLRESDIR>
1630		1662
1631	Directory where various X resource files are being located.	1663	Directory where application-specific X resource files are located.
1632		1664
1633	=item B<XENVIRONMENT>	1665	=item B<XENVIRONMENT>
1634		1666
1635	If set and accessible, gives the name of a X resource file to be loaded by	1667	If set and accessible, gives the name of a X resource file to be loaded by
1636	@@RXVT_NAME@@.	1668	@@RXVT_NAME@@.
…		…
1702		1734
1703	Project Coordinator (Changes 1.0 -)	1735	Project Coordinator (Changes 1.0 -)
1704		1736
1705	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1737	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1706		1738
1707	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1739	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708		1740
1709	=back	1741	=back
1710		1742

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.216 by root, Tue Jun 5 21:29:51 2012 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.216 by root, Tue Jun 5 21:29:51 2012 UTC