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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.181 by sf-exg, Tue Jun 15 13:05:39 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
134	I<Please address all transparency related issues to Sasha Vasko at
135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136		133
137	=item B<-fade> I<number>	134	=item B<-fade> I<number>
138		135
139	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
140	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
145	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
146	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
147		144
148	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
149		146
150	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colours essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161		149
162	=item B<-sh> I<number>	150	=item B<-sh> I<number>
163		151
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
166	resource I<shading>.
167
168	=item B<-blt> I<string>
169
170	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :
173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177		154
178	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
179		156
180	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
182	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
183	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
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
185	resource I<blurRadius>.	163	resource I<blurRadius>.
186		164
187	=item B<-icon> I<file>	165	=item B<-icon> I<file>
188		166
189	Compile I<afterimage>: Use the specified image as application icon. This	167	Compile I<pixbuf>: Use the specified image as application icon. This
190	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
191	application window; resource I<iconFile>.	169	application window; resource I<iconFile>.
192		170
193	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
194		172
…		…
196		174
197	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
198		176
199	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
200		178
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	179	=item B<-pixmap> I<file[;oplist]>
202		180
203	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
204	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
205	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
206	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
207		185
208	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
209		187
…		…
571	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
572	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
573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
575		553
576	1. system-wide app-defaults file, either locale-dependent OR global
577	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
579	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581	6. resources specified via -xrm on the commandline	559	6. resources specified via -xrm on the commandline
582		560
583	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
584	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
…		…
702	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
703	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
704		682
705	=item B<transparent:> I<boolean>	683	=item B<transparent:> I<boolean>
706		684
707	Turn on/off illusion of a transparent window background.	685	Turn on/off pseudo-transparency by using the root pixmap as background.
708		686
709	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
710	future versions.	688	future versions.
711		689
712	I<Please address all transparency related issues to Sasha Vasko at
713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
714
715	=item B<fading:> I<number>	690	=item B<fading:> I<number>
716		691
717	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
718		693
719	=item B<fadeColor:> I<colour>	694	=item B<fadeColor:> I<colour>
…		…
721	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
722	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
723		698
724	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
725		700
726	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
727	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>.
728		706
729	=item B<shading:> I<number>	707	=item B<shading:> I<number>
730		708
731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
732	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
733		711
734	=item B<blendType:> I<string>	712	=item B<blendType:> I<string>
735		713
736	Specify background blending type; option B<-blt>.	714	Specify background blending type; option B<-blt>.
737		715
738	=item B<blurRadius:> I<number>	716	=item B<blurRadius:> I<number>
739		717
740	Apply gaussian blur with the specified radius to the transparent	718	Apply gaussian blur with the specified radius to the transparent
741	background image; option B<-blr>.	719	background; option B<-blr>.
742		720
743	=item B<iconFile:> I<file>	721	=item B<iconFile:> I<file>
744		722
745	Set the application icon pixmap; option B<-icon>.	723	Set the application icon pixmap; option B<-icon>.
746		724
…		…
756	=item B<borderColor:> I<colour>	734	=item B<borderColor:> I<colour>
757		735
758	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
759	and the text.	737	and the text.
760		738
761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	739	=item B<backgroundPixmap:> I<file[;oplist]>
762		740
763	Use the specified image file for the background and also	741	Use the specified image file for the background and also
764	optionally specify its scaling with a geometry string B<WxH+X+Y>,	742	optionally specify a colon separated list of operations to modify it.
765	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767	centre (percent). A scale of 0 displays the image with tiling. A scale
768	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
769	an integer number of images in that direction. No image will be magnified
770	beyond 10 times its original size. The maximum permitted scale is 1000.
771	Additional operations can be specified after colon B<:op1:op2...>.
772	Supported operations are:	743	Supported operations are:
773		744
774	tile force background image to be tiled and not scaled. Equivalent to 0x0	745	=over 4
775	propscale will scale image keeping proportions	746
776	auto will scale image to match window size. Equivalent to 100x100	747	=item B<WxH+X+Y>
777	hscale will scale image horizontally to the window size	748
778	vscale will scale image vertically to the window size	749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
779	scale will scale image to match window size	750	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
780	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.
781	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.
782		800
783	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
784	blended over transparency image using either alpha-blending, or any	802	blended over the transparent background using alpha-blending.
785	other blending type, specified with B<-blt "type"> option.
786		803
787	=item B<path:> I<path>	804	=item B<path:> I<path>
788		805
789	Specify the colon-delimited search path for finding background image files.	806	Specify the colon-delimited search path for finding background image files.
790		807
…		…
917	=item B<scrollstyle:> I<mode>	934	=item B<scrollstyle:> I<mode>
918		935
919	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
920	the author's favourite.	937	the author's favourite.
921		938
		939	=item B<thickness:> I<number>
		940
		941	Set the scrollbar width in pixels.
		942
922	=item B<scrollBar:> I<boolean>	943	=item B<scrollBar:> I<boolean>
923		944
924	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	945	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
925	disable the scrollbar; option B<+sb>.	946	disable the scrollbar; option B<+sb>.
926		947
…		…
945	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
946	B<+si>.	967	B<+si>.
947		968
948	=item B<scrollWithBuffer:> I<boolean>	969	=item B<scrollWithBuffer:> I<boolean>
949		970
950	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.
951	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
952	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>.
953		975
954	=item B<scrollTtyKeypress:> I<boolean>	976	=item B<scrollTtyKeypress:> I<boolean>
955		977
956	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
957	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
…		…
1169	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1191	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1170	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1192	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1171	performed in an exact manner; however, the closest match is assured.	1193	performed in an exact manner; however, the closest match is assured.
1172		1194
1173	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
1174	number), see RESOURCES in C<man 7 X> for futher details.	1196	number), see RESOURCES in C<man 7 X> for further details.
1175		1197
1176	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>
1177	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1178	should be a character not used by the strings.	1201	should be a character not used by the strings.
1179		1202
1180	Its usage can be demonstrated by an example:	1203	Its usage can be demonstrated by an example:
1181		1204
1182	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1183		1206
1184	The above line is equivalent to the following three lines:	1207	The above line is equivalent to the following three lines:
1185		1208
1186	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1209	URxvt.keysym.Meta-Control-0x61: \033<a>
1187	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1210	URxvt.keysym.Meta-Control-0x62: \033<b>
1188	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1211	URxvt.keysym.Meta-Control-0x63: \033<c>
1189		1212
1190	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>
1191	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1214	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1192	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>
1193	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
…		…
1200	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1223	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1201		1224
1202	URxvt.keysym.M-C-c: perl:selection:rot13	1225	URxvt.keysym.M-C-c: perl:selection:rot13
1203		1226
1204	Due the the large number of modifier combinations, a defined key mapping	1227	Due the the large number of modifier combinations, a defined key mapping
1205	will match if at I<at least> the specified identifiers are being set, and	1228	will match if I<at least> the specified identifiers are being set, and
1206	no other key mappings with those and more bits are being defined. That	1229	no other key mappings with those and more bits are being defined. That
1207	means that defining a key map for C<a> will automatically provide	1230	means that defining a key map for C<a> will automatically provide
1208	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1231	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1209	mappings themselves.	1232	mappings themselves.
1210		1233
…		…
1266	the @@RXVT_NAME@@perl(3) manpage.	1289	the @@RXVT_NAME@@perl(3) manpage.
1267		1290
1268	=item B<perl-lib>: I<path>	1291	=item B<perl-lib>: I<path>
1269		1292
1270	Colon-separated list of additional directories that hold extension	1293	Colon-separated list of additional directories that hold extension
1271	scripts. When looking for extensions specified by the C<perl> resource,	1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1272	@@RXVT_NAME@@ will first look in these directories and then in	1295	look in these directories, then in $HOME/.urxvt/ext and lastly in
1273	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1274		1297
1275	See the @@RXVT_NAME@@perl(3) manpage.	1298	See the @@RXVT_NAME@@perl(3) manpage.
1276		1299
1277	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1526	White.	1549	White.
1527		1550
1528	=head2 ALPHA CHANNEL SUPPORT	1551	=head2 ALPHA CHANNEL SUPPORT
1529		1552
1530	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
1531	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:
1532		1555
1533	You can prefix any colour with an opaqueness percentage enclosed in	1556	You can prefix any colour with an opaqueness percentage enclosed in
1534	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
1535	(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
1536	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
…		…
1623	=item B<RXVT_SOCKET>	1646	=item B<RXVT_SOCKET>
1624		1647
1625	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
1626	@@RXVT_NAME@@d(1).	1649	@@RXVT_NAME@@d(1).
1627		1650
1628	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1629		1652
1630	=item B<HOME>	1653	=item B<HOME>
1631		1654
1632	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
1633	daemon communications and to locate various resource files (such as	1656	daemon communications and to locate various resource files (such as
1634	C<.Xdefaults>)	1657	C<.Xdefaults>)
1635		1658
1636	=item B<XAPPLRESDIR>	1659	=item B<XAPPLRESDIR>
1637		1660
1638	Directory where various X resource files are being located.	1661	Directory where application-specific X resource files are located.
1639		1662
1640	=item B<XENVIRONMENT>	1663	=item B<XENVIRONMENT>
1641		1664
1642	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
1643	@@RXVT_NAME@@.	1666	@@RXVT_NAME@@.
…		…
1709		1732
1710	Project Coordinator (Changes 1.0 -)	1733	Project Coordinator (Changes 1.0 -)
1711		1734
1712	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1713		1736
1714	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1715		1738
1716	=back	1739	=back
1717		1740

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.181 by sf-exg, Tue Jun 15 13:05:39 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.181 by sf-exg, Tue Jun 15 13:05:39 2010 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC