[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.220 by root, Fri Sep 21 23:31:43 2012 UTC

…		…
98	is still respected. but deprecated). In the absence of this option, the	98	is still respected. but deprecated). In the absence of this option, the
99	display specified by the B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
105		105
106	[Please note that many X servers (and libXft) are buggy with	106	[Please note that many X servers (and libXft) are buggy with
107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts	107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108	of graphical corruption. This is harmless, but we can't do anything about	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
111	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
112		117
113	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
114		119
115	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
…		…
150	=item B<-sh> I<number>	155	=item B<-sh> I<number>
151		156
152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.	157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153	A value of 100 means no shading; resource I<shading>.	158	A value of 100 means no shading; resource I<shading>.
154		159
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>	160	=item B<-blr> I<HxV>
166		161
167	Apply Gaussian Blur with the specified radii to the transparent	162	Apply Gaussian Blur with the specified radii to the transparent
168	background. If a single number is specified - both vertical and	163	background. If a single number is specified, the vertical and
169	horizontal radii are considered to be the same. Setting one of the	164	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	165	radii to 1 and the other to a large number creates interesting effects
171	on some backgrounds. Maximum radius value is 128;	166	on some backgrounds. The maximum radius value is 128. An horizontal or
		167	vertical radius of 0 disables blurring;
172	resource I<blurRadius>.	168	resource I<blurRadius>.
173		169
174	=item B<-icon> I<file>	170	=item B<-icon> I<file>
175		171
176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This	172	Compile I<pixbuf>: Use the specified image as application icon. This
177	is used by many window managers, taskbars and pagers to represent the	173	is used by many window managers, taskbars and pagers to represent the
178	application window; resource I<iconFile>.	174	application window; resource I<iconFile>.
179		175
180	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
181		177
…		…
183		179
184	=item B<-fg> I<colour>	180	=item B<-fg> I<colour>
185		181
186	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
187		183
188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	184	=item B<-pixmap> I<file[;oplist]>
189		185
190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also	186	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	187	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	188	add quotes to avoid special shell interpretation of the C<;> in the
193	command-line; for more details see resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
194		190
195	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
196		192
…		…
558	You can set and change the resources using X11 tools like B<xrdb>. Many	554	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	555	distribution do also load settings from the B<~/.Xresources> file when X
560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
562		558
563	1. system-wide app-defaults file, either locale-dependent OR global
564	2. app-defaults file in $XAPPLRESDIR	559	1. app-defaults file in $XAPPLRESDIR
		560	2. $HOME/.Xdefaults
565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window of screen 0
566	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES property on root-window of the current screen
567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568	6. resources specified via -xrm on the commandline	564	6. resources specified via -xrm on the commandline
569		565
570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	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	567	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	701	Fade to this colour, when fading is used (see B<fading:>). The default
706	colour is black; option B<-fadecolor>.	702	colour is black; option B<-fadecolor>.
707		703
708	=item B<tintColor:> I<colour>	704	=item B<tintColor:> I<colour>
709		705
710	Tint the transparent background with the given colour; option	706	Tint the transparent background with the given colour. If the RENDER
711	B<-tint>.	707	extension is not available only black, red, green, yellow, blue,
		708	magenta, cyan and white tints can be performed server-side. Note that
		709	a black tint yields a completely black image while a white tint yields
		710	the image unchanged; option B<-tint>.
712		711
713	=item B<shading:> I<number>	712	=item B<shading:> I<number>
714		713
715	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.	714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
716	A value of 100 means no shading; option B<-sh>.	715	A value of 100 means no shading; option B<-sh>.
717		716
718	=item B<blendType:> I<string>
719
720	Specify background blending type; option B<-blt>.
721
722	=item B<blurRadius:> I<number>	717	=item B<blurRadius:> I<number>
723		718
724	Apply gaussian blur with the specified radius to the transparent	719	Apply gaussian blur with the specified radius to the transparent
725	background; option B<-blr>.	720	background; option B<-blr>.
726		721
…		…
740	=item B<borderColor:> I<colour>	735	=item B<borderColor:> I<colour>
741		736
742	The colour of the border around the text area and between the scrollbar	737	The colour of the border around the text area and between the scrollbar
743	and the text.	738	and the text.
744		739
745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	740	=item B<backgroundPixmap:> I<file[;oplist]>
746		741
747	Use the specified image file for the background and also	742	Use the specified image file for the background and also
748	optionally specify its scaling with a geometry string B<WxH+X+Y>,	743	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:	744	Supported operations are:
755		745
756	tile force background image to be tiled and not scaled. Equivalent to 0x0	746	=over 4
757	propscale will scale image keeping proportions	747
758	auto will scale image to match window size. Equivalent to 100x100	748	=item B<WxH+X+Y>
759	hscale will scale image horizontally to the window size	749
760	vscale will scale image vertically to the window size	750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
761	scale will scale image to match window size	751	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	752	scale of 0 disables scaling.
763	whenever terminal window moves	753
		754	=item B<op=tile>
		755
		756	enables tiling
		757
		758	=item B<op=keep-aspect>
		759
		760	maintain the image aspect ratio when scaling
		761
		762	=item B<op=root-align>
		763
		764	use the position of the terminal window relative to the root window as
		765	the image offset, simulating a root window background
		766
		767	=back
		768
		769	The default scale and position setting is C<100x100+50+50>.
		770	Alternatively, a predefined set of templates can be used to achieve
		771	the most common setups:
		772
		773	=over 4
		774
		775	=item B<style=tiled>
		776
		777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		778
		779	=item B<style=aspect-stretched>
		780
		781	the image is scaled to fill the whole window maintaining the aspect
		782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		783
		784	=item B<style=stretched>
		785
		786	the image is scaled to fill the whole window. Equivalent to 100x100
		787
		788	=item B<style=centered>
		789
		790	the image is centered with no scaling. Equivalent to 0x0+50+50
		791
		792	=item B<style=root-tiled>
		793
		794	the image is tiled with no scaling and using 'root' positioning.
		795	Equivalent to 0x0:op=tile:op=root-align
		796
		797	=back
		798
		799	If multiple templates are specified the last one wins. Note that a
		800	template overrides all the scale, position and operations settings.
764		801
765	If used in conjunction with B<-tr> option, the specified pixmap will be	802	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>	803	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		804
770	=item B<path:> I<path>	805	=item B<path:> I<path>
771		806
772	Specify the colon-delimited search path for finding background image files.	807	Specify the colon-delimited search path for finding background image files.
773		808
…		…
900	=item B<scrollstyle:> I<mode>	935	=item B<scrollstyle:> I<mode>
901		936
902	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	937	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
903	the author's favourite.	938	the author's favourite.
904		939
		940	=item B<thickness:> I<number>
		941
		942	Set the scrollbar width in pixels.
		943
905	=item B<scrollBar:> I<boolean>	944	=item B<scrollBar:> I<boolean>
906		945
907	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	946	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
908	disable the scrollbar; option B<+sb>.	947	disable the scrollbar; option B<+sb>.
909		948
…		…
928	B<False>: do not scroll to bottom when tty receives output; option	967	B<False>: do not scroll to bottom when tty receives output; option
929	B<+si>.	968	B<+si>.
930		969
931	=item B<scrollWithBuffer:> I<boolean>	970	=item B<scrollWithBuffer:> I<boolean>
932		971
933	B<True>: scroll with scrollback buffer when tty receives new lines (and	972	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	973	try to show the same lines) and B<scrollTtyOutput> is False; option
935	with scrollback buffer when tty receives new lines; option B<+sw>.	974	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		975	new lines; option B<+sw>.
936		976
937	=item B<scrollTtyKeypress:> I<boolean>	977	=item B<scrollTtyKeypress:> I<boolean>
938		978
939	B<True>: scroll to bottom when a non-special key is pressed. Special keys	979	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	980	are those which are intercepted by rxvt-unicode for special handling and
…		…
1154	performed in an exact manner; however, the closest match is assured.	1194	performed in an exact manner; however, the closest match is assured.
1155		1195
1156	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1196	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1157	number), see RESOURCES in C<man 7 X> for further details.	1197	number), see RESOURCES in C<man 7 X> for further details.
1158		1198
1159	You can define a range of keysyms in one shot by providing a I<string>	1199	You can define a range of keysyms in one shot by
		1200	loading the C<keysym-list> perl extension and providing a I<string>
1160	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1161	should be a character not used by the strings.	1202	should be a character not used by the strings.
1162		1203
1163	Its usage can be demonstrated by an example:	1204	Its usage can be demonstrated by an example:
1164		1205
1165	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1166		1207
1167	The above line is equivalent to the following three lines:	1208	The above line is equivalent to the following three lines:
1168		1209
1169	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1210	URxvt.keysym.Meta-Control-0x61: \033<a>
1170	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1211	URxvt.keysym.Meta-Control-0x62: \033<b>
1171	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1212	URxvt.keysym.Meta-Control-0x63: \033<c>
1172		1213
1173	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1214	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	1215	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>	1216	example the following means "change the current locale to C<zh_CN.GBK>
1176	when Control-Meta-c is being pressed":	1217	when Control-Meta-c is being pressed":
…		…
1249	the @@RXVT_NAME@@perl(3) manpage.	1290	the @@RXVT_NAME@@perl(3) manpage.
1250		1291
1251	=item B<perl-lib>: I<path>	1292	=item B<perl-lib>: I<path>
1252		1293
1253	Colon-separated list of additional directories that hold extension	1294	Colon-separated list of additional directories that hold extension
1254	scripts. When looking for extensions specified by the C<perl> resource,	1295	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1255	@@RXVT_NAME@@ will first look in these directories and then in	1296	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1256	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1297	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1257		1298
1258	See the @@RXVT_NAME@@perl(3) manpage.	1299	See the @@RXVT_NAME@@perl(3) manpage.
1259		1300
1260	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1301	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1261		1302
…		…
1509	White.	1550	White.
1510		1551
1511	=head2 ALPHA CHANNEL SUPPORT	1552	=head2 ALPHA CHANNEL SUPPORT
1512		1553
1513	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1554	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:	1555	their act together, rxvt-unicode will do its own alpha channel management:
1515		1556
1516	You can prefix any colour with an opaqueness percentage enclosed in	1557	You can prefix any colour with an opaqueness percentage enclosed in
1517	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1558	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	1559	(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	1560	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1601		1642
1602	=item B<SHELL>	1643	=item B<SHELL>
1603		1644
1604	The shell to be used for command execution, defaults to C</bin/sh>.	1645	The shell to be used for command execution, defaults to C</bin/sh>.
1605		1646
1606	=item B<RXVT_SOCKET>	1647	=item B<RXVT_SOCKET> [I<sic>]
1607		1648
1608	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1649	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1609	@@RXVT_NAME@@d(1).	1650	@@RXVT_NAME@@d(1).
1610		1651
1611	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1652	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1653
		1654	=item B<URXVT_PERL_LIB>
		1655
		1656	Additional F<:>-separated library search path for perl extensions. Will be
		1657	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1658	directory.
		1659
		1660	=item B<URXVT_PERL_VERBOSITY>
		1661
		1662	See L<@@RXVT_NAME@@perl>(3).
1612		1663
1613	=item B<HOME>	1664	=item B<HOME>
1614		1665
1615	Used to locate the default directory for the unix domain socket for	1666	Used to locate the default directory for the unix domain socket for
1616	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1617	C<.Xdefaults>)	1668	C<.Xdefaults>)
1618		1669
1619	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1620		1671
1621	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1622		1673
1623	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1624		1675
1625	If set and accessible, gives the name of a X resource file to be loaded by	1676	If set and accessible, gives the name of a X resource file to be loaded by
1626	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1637		1688
1638	=back	1689	=back
1639		1690
1640	=head1 SEE ALSO	1691	=head1 SEE ALSO
1641		1692
		1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1642	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1694	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1643		1695
1644	=head1 CURRENT PROJECT COORDINATOR	1696	=head1 CURRENT PROJECT COORDINATOR
1645		1697
1646	=over 4	1698	=over 4
1647		1699
…		…
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.189 by sf-exg, Tue Nov 23 18:52:13 2010 UTC vs. Revision 1.220 by root, Fri Sep 21 23:31:43 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.220 by root, Fri Sep 21 23:31:43 2012 UTC