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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 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> or I<pixbuf>: 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> or I<pixbuf>: 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
734	=item B<blendType:> I<string>
735
736	Specify background blending type; option B<-blt>.
737		711
738	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
739		713
740	Apply gaussian blur with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
741	background image; option B<-blr>.	715	background; option B<-blr>.
742		716
743	=item B<iconFile:> I<file>	717	=item B<iconFile:> I<file>
744		718
745	Set the application icon pixmap; option B<-icon>.	719	Set the application icon pixmap; option B<-icon>.
746		720
…		…
756	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
757		731
758	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
759	and the text.	733	and the text.
760		734
761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
762		736
763	Use the specified image file for the background and also	737	Use the specified image file for the background and also
764	optionally specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify a colon separated list of operations to modify it.
765	(default C<100x100+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.
768	The maximum permitted scale is 1000.
769	Additional operations can be specified after colon B<:op1:op2...>.
770	Supported operations are:	739	Supported operations are:
771		740
772	tile force background image to be tiled and not scaled. Equivalent to 0x0	741	=over 4
773	propscale will scale image keeping proportions	742
774	auto will scale image to match window size. Equivalent to 100x100	743	=item B<WxH+X+Y>
775	hscale will scale image horizontally to the window size	744
776	vscale will scale image vertically to the window size	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
777	scale will scale image to match window size	746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
778	root will tile image as if it was a root window background, auto-adjusting	747	scale of 0 disables scaling.
779	whenever terminal window moves	748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
780		796
781	If used in conjunction with B<-tr> option, the specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
782	blended over transparency image using either alpha-blending, or any	798	blended over the transparent background using alpha-blending.
783	other blending type, specified with B<-blt "type"> option.
784		799
785	=item B<path:> I<path>	800	=item B<path:> I<path>
786		801
787	Specify the colon-delimited search path for finding background image files.	802	Specify the colon-delimited search path for finding background image files.
788		803
…		…
915	=item B<scrollstyle:> I<mode>	930	=item B<scrollstyle:> I<mode>
916		931
917	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
918	the author's favourite.	933	the author's favourite.
919		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
920	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
921		940
922	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
923	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
924		943
…		…
943	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
944	B<+si>.	963	B<+si>.
945		964
946	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
947		966
948	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
949	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	968	try to show the same lines) and B<scrollTtyOutput> is False; option
950	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
951		971
952	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
953		973
954	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	B<True>: scroll to bottom when a non-special key is pressed. Special keys
955	are those which are intercepted by rxvt-unicode for special handling and	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
1169	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1170		1190
1171	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1172	number), see RESOURCES in C<man 7 X> for further details.	1192	number), see RESOURCES in C<man 7 X> for further details.
1173		1193
1174	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1175	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1176	should be a character not used by the strings.	1197	should be a character not used by the strings.
1177		1198
1178	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1179		1200
1180	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1181		1202
1182	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1183		1204
1184	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1185	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1186	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1187		1208
1188	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1189	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1190	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1191	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
…		…
1198	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1199		1220
1200	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1201		1222
1202	Due the the large number of modifier combinations, a defined key mapping	1223	Due the the large number of modifier combinations, a defined key mapping
1203	will match if at I<at least> the specified identifiers are being set, and	1224	will match if I<at least> the specified identifiers are being set, and
1204	no other key mappings with those and more bits are being defined. That	1225	no other key mappings with those and more bits are being defined. That
1205	means that defining a key map for C<a> will automatically provide	1226	means that defining a key map for C<a> will automatically provide
1206	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1207	mappings themselves.	1228	mappings themselves.
1208		1229
…		…
1264	the @@RXVT_NAME@@perl(3) manpage.	1285	the @@RXVT_NAME@@perl(3) manpage.
1265		1286
1266	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1267		1288
1268	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1269	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1270	@@RXVT_NAME@@ will first look in these directories and then in	1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
1271	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1272		1293
1273	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1274		1295
1275	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1524	White.	1545	White.
1525		1546
1526	=head2 ALPHA CHANNEL SUPPORT	1547	=head2 ALPHA CHANNEL SUPPORT
1527		1548
1528	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1529	their act together, rxvt-unicode will do it's own alpha channel management:	1550	their act together, rxvt-unicode will do its own alpha channel management:
1530		1551
1531	You can prefix any colour with an opaqueness percentage enclosed in	1552	You can prefix any colour with an opaqueness percentage enclosed in
1532	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1533	(0-100) that specifies the opacity of the colour, where C<0> is completely	1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
1534	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
…		…
1621	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1622		1643
1623	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1624	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1625		1646
1626	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1627		1648
1628	=item B<HOME>	1649	=item B<HOME>
1629		1650
1630	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1631	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1632	C<.Xdefaults>)	1653	C<.Xdefaults>)
1633		1654
1634	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1635		1656
1636	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1637		1658
1638	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1639		1660
1640	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1641	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1707		1728
1708	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1709		1730
1710	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1711		1732
1712	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1713		1734
1714	=back	1735	=back
1715		1736

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC vs. Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC