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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 UTC vs.
Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 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
…		…
743	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
744		744
745	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
746	and the text.	746	and the text.
747		747
748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
749		749
750	Use the specified image file for the background and also	750	Use the specified image file for the background and also
751	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754	centre (percent). A scale of 0 displays the image with tiling.
755	The maximum permitted scale is 1000.
756	Additional operations can be specified after colon B<:op1:op2...>.
757	Supported operations are:	752	Supported operations are:
758		753
759	tile force background image to be tiled and not scaled. Equivalent to 0x0	754	=over 4
760	propscale will scale image keeping proportions	755
761	auto will scale image to match window size. Equivalent to 100x100	756	=item B<WxH+X+Y>
762	hscale will scale image horizontally to the window size	757
763	vscale will scale image vertically to the window size	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764	scale will scale image to match window size	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
765	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.
766	whenever terminal window moves	761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=pscale>
		767
		768	enables proportional scaling
		769
		770	=item B<op=root>
		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=pscale
		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
		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.
767		809
768	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
769	blended over the transparent background using alpha-blending. If I<afterimage>	811	blended over the transparent background using alpha-blending. If I<afterimage>
770	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
771	types with B<-blt "type"> option.	813	types with B<-blt "type"> option.
…		…
903	=item B<scrollstyle:> I<mode>	945	=item B<scrollstyle:> I<mode>
904		946
905	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
906	the author's favourite.	948	the author's favourite.
907		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
908	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
909		955
910	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
911	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
912		958
…		…
931	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
932	B<+si>.	978	B<+si>.
933		979
934	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
935		981
936	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.
937	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
938	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>.
939		986
940	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
941		988
942	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
943	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
…		…
1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1210	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164	should be a character not used by the strings.	1211	should be a character not used by the strings.
1165		1212
1166	Its usage can be demonstrated by an example:	1213	Its usage can be demonstrated by an example:
1167		1214
1168	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1215	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1169		1216
1170	The above line is equivalent to the following three lines:	1217	The above line is equivalent to the following three lines:
1171		1218
1172	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1219	URxvt.keysym.Meta-Control-0x61: \033<a>
1173	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1220	URxvt.keysym.Meta-Control-0x62: \033<b>
1174	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1221	URxvt.keysym.Meta-Control-0x63: \033<c>
1175		1222
1176	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1223	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1177	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1224	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1178	example the following means "change the current locale to C<zh_CN.GBK>	1225	example the following means "change the current locale to C<zh_CN.GBK>
1179	when Control-Meta-c is being pressed":	1226	when Control-Meta-c is being pressed":
…		…
1252	the @@RXVT_NAME@@perl(3) manpage.	1299	the @@RXVT_NAME@@perl(3) manpage.
1253		1300
1254	=item B<perl-lib>: I<path>	1301	=item B<perl-lib>: I<path>
1255		1302
1256	Colon-separated list of additional directories that hold extension	1303	Colon-separated list of additional directories that hold extension
1257	scripts. When looking for extensions specified by the C<perl> resource,	1304	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1258	@@RXVT_NAME@@ will first look in these directories and then in	1305	look in these directories, then in $HOME/.urxvt/ext and lastly in
1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1306	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260		1307
1261	See the @@RXVT_NAME@@perl(3) manpage.	1308	See the @@RXVT_NAME@@perl(3) manpage.
1262		1309
1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1310	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1609	=item B<RXVT_SOCKET>	1656	=item B<RXVT_SOCKET>
1610		1657
1611	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1658	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1612	@@RXVT_NAME@@d(1).	1659	@@RXVT_NAME@@d(1).
1613		1660
1614	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1661	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1615		1662
1616	=item B<HOME>	1663	=item B<HOME>
1617		1664
1618	Used to locate the default directory for the unix domain socket for	1665	Used to locate the default directory for the unix domain socket for
1619	daemon communications and to locate various resource files (such as	1666	daemon communications and to locate various resource files (such as
1620	C<.Xdefaults>)	1667	C<.Xdefaults>)
1621		1668
1622	=item B<XAPPLRESDIR>	1669	=item B<XAPPLRESDIR>
1623		1670
1624	Directory where various X resource files are being located.	1671	Directory where application-specific X resource files are located.
1625		1672
1626	=item B<XENVIRONMENT>	1673	=item B<XENVIRONMENT>
1627		1674
1628	If set and accessible, gives the name of a X resource file to be loaded by	1675	If set and accessible, gives the name of a X resource file to be loaded by
1629	@@RXVT_NAME@@.	1676	@@RXVT_NAME@@.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 UTC vs. Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 UTC vs.
Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 2011 UTC