[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.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC

…		…
183		183
184	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
185		185
186	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
187		187
188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;oplist]>
189		189
190	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
191	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
192	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
193	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
194		194
195	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
196		196
…		…
558	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
559	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
560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
562		562
563	1. system-wide app-defaults file, either locale-dependent OR global
564	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
565	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
566	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
569		569
570	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
571	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
…		…
705	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
706	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
707		707
708	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
709		709
710	Tint the transparent background with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
711	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>.
712		715
713	=item B<shading:> I<number>	716	=item B<shading:> I<number>
714		717
715	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
716	A value of 100 means no shading; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
…		…
740	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
741		744
742	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
743	and the text.	746	and the text.
744		747
745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
746		749
747	Use the specified image file for the background and also	750	Use the specified image file for the background and also
748	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	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:	752	Supported operations are:
755		753
756	tile force background image to be tiled and not scaled. Equivalent to 0x0	754	=over 4
757	propscale will scale image keeping proportions	755
758	auto will scale image to match window size. Equivalent to 100x100	756	=item B<WxH+X+Y>
759	hscale will scale image horizontally to the window size	757
760	vscale will scale image vertically to the window size	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
761	scale will scale image to match window size	759	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	760	scale of 0 disables scaling. The maximum permitted scale is 1000.
763	whenever terminal window moves	761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=keep-aspect>
		767
		768	maintain the image aspect ratio when scaling
		769
		770	=item B<op=root-align>
		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=keep-aspect
		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-align
		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.
764		809
765	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
766	blended over the transparent background using alpha-blending. If I<afterimage>	811	blended over the transparent background using alpha-blending. If I<afterimage>
767	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
768	types with B<-blt "type"> option.	813	types with B<-blt "type"> option.
…		…
900	=item B<scrollstyle:> I<mode>	945	=item B<scrollstyle:> I<mode>
901		946
902	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
903	the author's favourite.	948	the author's favourite.
904		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
905	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
906		955
907	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
908	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
909		958
…		…
928	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
929	B<+si>.	978	B<+si>.
930		979
931	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
932		981
933	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.
934	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
935	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>.
936		986
937	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
938		988
939	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
940	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
…		…
1154	performed in an exact manner; however, the closest match is assured.	1204	performed in an exact manner; however, the closest match is assured.
1155		1205
1156	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1206	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1157	number), see RESOURCES in C<man 7 X> for further details.	1207	number), see RESOURCES in C<man 7 X> for further details.
1158		1208
1159	You can define a range of keysyms in one shot by providing a I<string>	1209	You can define a range of keysyms in one shot by
		1210	loading the C<keysym-list> perl extension and providing a I<string>
1160	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1161	should be a character not used by the strings.	1212	should be a character not used by the strings.
1162		1213
1163	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1164		1215
1165	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1166		1217
1167	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1168		1219
1169	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: \033<a>
1170	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: \033<b>
1171	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: \033<c>
1172		1223
1173	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1224	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	1225	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>	1226	example the following means "change the current locale to C<zh_CN.GBK>
1176	when Control-Meta-c is being pressed":	1227	when Control-Meta-c is being pressed":
…		…
1249	the @@RXVT_NAME@@perl(3) manpage.	1300	the @@RXVT_NAME@@perl(3) manpage.
1250		1301
1251	=item B<perl-lib>: I<path>	1302	=item B<perl-lib>: I<path>
1252		1303
1253	Colon-separated list of additional directories that hold extension	1304	Colon-separated list of additional directories that hold extension
1254	scripts. When looking for extensions specified by the C<perl> resource,	1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1255	@@RXVT_NAME@@ will first look in these directories and then in	1306	look in these directories, then in $HOME/.urxvt/ext and lastly in
1256	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1257		1308
1258	See the @@RXVT_NAME@@perl(3) manpage.	1309	See the @@RXVT_NAME@@perl(3) manpage.
1259		1310
1260	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1509	White.	1560	White.
1510		1561
1511	=head2 ALPHA CHANNEL SUPPORT	1562	=head2 ALPHA CHANNEL SUPPORT
1512		1563
1513	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1564	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:	1565	their act together, rxvt-unicode will do its own alpha channel management:
1515		1566
1516	You can prefix any colour with an opaqueness percentage enclosed in	1567	You can prefix any colour with an opaqueness percentage enclosed in
1517	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1568	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	1569	(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	1570	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1606	=item B<RXVT_SOCKET>	1657	=item B<RXVT_SOCKET>
1607		1658
1608	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1659	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1609	@@RXVT_NAME@@d(1).	1660	@@RXVT_NAME@@d(1).
1610		1661
1611	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
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@@.
…		…
1692		1743
1693	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1694		1745
1695	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1696		1747
1697	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1698		1749
1699	=back	1750	=back
1700		1751

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.210 by sf-exg, Mon Dec 26 15:20:58 2011 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.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC