[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.213 by sf-exg, Sat Feb 4 21:47:06 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		711
728	=item B<blendType:> I<string>	712	=item B<blendType:> I<string>
729		713
730	Specify background blending type; option B<-blt>.	714	Specify background blending type; option B<-blt>.
731		715
732	=item B<blurRadius:> I<number>	716	=item B<blurRadius:> I<number>
733		717
734	Apply gaussian blur with the specified radius to the transparent	718	Apply gaussian blur with the specified radius to the transparent
735	background image; option B<-blr>.	719	background; option B<-blr>.
736		720
737	=item B<iconFile:> I<file>	721	=item B<iconFile:> I<file>
738		722
739	Set the application icon pixmap; option B<-icon>.	723	Set the application icon pixmap; option B<-icon>.
740		724
…		…
750	=item B<borderColor:> I<colour>	734	=item B<borderColor:> I<colour>
751		735
752	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
753	and the text.	737	and the text.
754		738
755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	739	=item B<backgroundPixmap:> I<file[;oplist]>
756		740
757	Use the specified image file for the background and also	741	Use the specified image file for the background and also
758	optionally specify its scaling with a geometry string B<WxH+X+Y>,	742	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:	743	Supported operations are:
765		744
766	tile force background image to be tiled and not scaled. Equivalent to 0x0	745	=over 4
767	propscale will scale image keeping proportions	746
768	auto will scale image to match window size. Equivalent to 100x100	747	=item B<WxH+X+Y>
769	hscale will scale image horizontally to the window size	748
770	vscale will scale image vertically to the window size	749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
771	scale will scale image to match window size	750	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	751	scale of 0 disables scaling. The maximum permitted scale is 1000.
773	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.
774		800
775	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
776	blended over transparency image using alpha-blending. If I<afterimage>	802	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		803
780	=item B<path:> I<path>	804	=item B<path:> I<path>
781		805
782	Specify the colon-delimited search path for finding background image files.	806	Specify the colon-delimited search path for finding background image files.
783		807
…		…
910	=item B<scrollstyle:> I<mode>	934	=item B<scrollstyle:> I<mode>
911		935
912	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
913	the author's favourite.	937	the author's favourite.
914		938
		939	=item B<thickness:> I<number>
		940
		941	Set the scrollbar width in pixels.
		942
915	=item B<scrollBar:> I<boolean>	943	=item B<scrollBar:> I<boolean>
916		944
917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	945	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918	disable the scrollbar; option B<+sb>.	946	disable the scrollbar; option B<+sb>.
919		947
…		…
938	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
939	B<+si>.	967	B<+si>.
940		968
941	=item B<scrollWithBuffer:> I<boolean>	969	=item B<scrollWithBuffer:> I<boolean>
942		970
943	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.
944	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
945	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>.
946		975
947	=item B<scrollTtyKeypress:> I<boolean>	976	=item B<scrollTtyKeypress:> I<boolean>
948		977
949	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
950	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
…		…
1164	performed in an exact manner; however, the closest match is assured.	1193	performed in an exact manner; however, the closest match is assured.
1165		1194
1166	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
1167	number), see RESOURCES in C<man 7 X> for further details.	1196	number), see RESOURCES in C<man 7 X> for further details.
1168		1197
1169	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>
1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1171	should be a character not used by the strings.	1201	should be a character not used by the strings.
1172		1202
1173	Its usage can be demonstrated by an example:	1203	Its usage can be demonstrated by an example:
1174		1204
1175	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1176		1206
1177	The above line is equivalent to the following three lines:	1207	The above line is equivalent to the following three lines:
1178		1208
1179	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1209	URxvt.keysym.Meta-Control-0x61: \033<a>
1180	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1210	URxvt.keysym.Meta-Control-0x62: \033<b>
1181	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1211	URxvt.keysym.Meta-Control-0x63: \033<c>
1182		1212
1183	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>
1184	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1214	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>	1215	example the following means "change the current locale to C<zh_CN.GBK>
1186	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
…		…
1259	the @@RXVT_NAME@@perl(3) manpage.	1289	the @@RXVT_NAME@@perl(3) manpage.
1260		1290
1261	=item B<perl-lib>: I<path>	1291	=item B<perl-lib>: I<path>
1262		1292
1263	Colon-separated list of additional directories that hold extension	1293	Colon-separated list of additional directories that hold extension
1264	scripts. When looking for extensions specified by the C<perl> resource,	1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1265	@@RXVT_NAME@@ will first look in these directories and then in	1295	look in these directories, then in $HOME/.urxvt/ext and lastly in
1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267		1297
1268	See the @@RXVT_NAME@@perl(3) manpage.	1298	See the @@RXVT_NAME@@perl(3) manpage.
1269		1299
1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1519	White.	1549	White.
1520		1550
1521	=head2 ALPHA CHANNEL SUPPORT	1551	=head2 ALPHA CHANNEL SUPPORT
1522		1552
1523	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
1524	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:
1525		1555
1526	You can prefix any colour with an opaqueness percentage enclosed in	1556	You can prefix any colour with an opaqueness percentage enclosed in
1527	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
1528	(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
1529	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
…		…
1616	=item B<RXVT_SOCKET>	1646	=item B<RXVT_SOCKET>
1617		1647
1618	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
1619	@@RXVT_NAME@@d(1).	1649	@@RXVT_NAME@@d(1).
1620		1650
1621	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1622		1652
1623	=item B<HOME>	1653	=item B<HOME>
1624		1654
1625	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
1626	daemon communications and to locate various resource files (such as	1656	daemon communications and to locate various resource files (such as
1627	C<.Xdefaults>)	1657	C<.Xdefaults>)
1628		1658
1629	=item B<XAPPLRESDIR>	1659	=item B<XAPPLRESDIR>
1630		1660
1631	Directory where various X resource files are being located.	1661	Directory where application-specific X resource files are located.
1632		1662
1633	=item B<XENVIRONMENT>	1663	=item B<XENVIRONMENT>
1634		1664
1635	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
1636	@@RXVT_NAME@@.	1666	@@RXVT_NAME@@.
…		…
1702		1732
1703	Project Coordinator (Changes 1.0 -)	1733	Project Coordinator (Changes 1.0 -)
1704		1734
1705	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1706		1736
1707	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708		1738
1709	=back	1739	=back
1710		1740

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.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.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC