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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

…		…
98	is still respected. but deprecated). In the absence of this option, the	98	is still respected. but deprecated). In the absence of this option, the
99	display specified by the B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
105		105
106	[Please note that many X servers (and libXft) are buggy with	106	[Please note that many X servers (and libXft) are buggy with
107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts	107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108	of graphical corruption. This is harmless, but we can't do anything about	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
111	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
112		117
113	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
114		119
115	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
…		…
124		129
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		131
127	=item B<-tr>\|B<+tr>	132	=item B<-tr>\|B<+tr>
128		133
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		135
131	B<-ip> is still accepted as an obsolete alias but will be removed in	136	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	137	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		138
137	=item B<-fade> I<number>	139	=item B<-fade> I<number>
138		140
139	Fade the text by the given percentage when focus is lost. Small values	141	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	142	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	147	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	148	is opaque black. resource B<fadeColor>.
147		149
148	=item B<-tint> I<colour>	150	=item B<-tint> I<colour>
149		151
150	Tint the transparent background pixmap with the given colour when	152	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	153	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 colors essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161		154
162	=item B<-sh> I<number>	155	=item B<-sh> I<number>
163		156
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	158	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> - color 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		159
178	=item B<-blr> I<HxV>	160	=item B<-blr> I<HxV>
179		161
180	Apply Gaussian Blur with the specified radii to the transparent	162	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	163	background. If a single number is specified, the vertical and
182	horizontal radii are considered to be the same. Setting one of the	164	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	165	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>;	166	on some backgrounds. The maximum radius value is 128. An horizontal or
		167	vertical radius of 0 disables blurring;
185	resource I<blurRadius>.	168	resource I<blurRadius>.
186		169
187	=item B<-icon> I<file>	170	=item B<-icon> I<file>
188		171
189	Compile I<afterimage>: Use the specified image as application icon. This	172	Compile I<pixbuf>: Use the specified image as application icon. This
190	is used by many window managers, taskbars and pagers to represent the	173	is used by many window managers, taskbars and pagers to represent the
191	application window; resource I<iconFile>.	174	application window; resource I<iconFile>.
192		175
193	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
194		177
…		…
196		179
197	=item B<-fg> I<colour>	180	=item B<-fg> I<colour>
198		181
199	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
200		183
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	184	=item B<-pixmap> I<file[;oplist]>
202		185
203	Compile I<afterimage>: Specify image file for the background and also	186	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	187	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	188	add quotes to avoid special shell interpretation of the C<;> in the
206	command-line; for more details see resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
207		190
208	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
209		192
…		…
320	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.	303	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
321		304
322	=item B<-bc>\|B<+bc>	305	=item B<-bc>\|B<+bc>
323		306
324	Blink the cursor; resource B<cursorBlink>.	307	Blink the cursor; resource B<cursorBlink>.
		308
		309	=item B<-uc>\|B<+uc>
		310
		311	Make the cursor underlined; resource B<cursorUnderline>.
325		312
326	=item B<-iconic>	313	=item B<-iconic>
327		314
328	Start iconified, if the window manager supports that option.	315	Start iconified, if the window manager supports that option.
329	Alternative form is B<-ic>.	316	Alternative form is B<-ic>.
…		…
567	You can set and change the resources using X11 tools like B<xrdb>. Many	554	You can set and change the resources using X11 tools like B<xrdb>. Many
568	distribution do also load settings from the B<~/.Xresources> file when X	555	distribution do also load settings from the B<~/.Xresources> file when X
569	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
571		558
572	1. system-wide app-defaults file, either locale-dependent OR global
573	2. app-defaults file in $XAPPLRESDIR	559	1. app-defaults file in $XAPPLRESDIR
		560	2. $HOME/.Xdefaults
574	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window of screen 0
575	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES property on root-window of the current screen
576	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577	6. resources specified via -xrm on the commandline	564	6. resources specified via -xrm on the commandline
578		565
579	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
580	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
621	Use the specified colour for the colour value I<n>, where 0-7	608	Use the specified colour for the colour value I<n>, where 0-7
622	corresponds to low-intensity (normal) colours and 8-15 corresponds to	609	corresponds to low-intensity (normal) colours and 8-15 corresponds to
623	high-intensity (bold = bright foreground, blink = bright background)	610	high-intensity (bold = bright foreground, blink = bright background)
624	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	611	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
625	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	612	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
626	names used are listed in the B<COLORS AND GRAPHICS> section.	613	names used are listed in the B<COLOURS AND GRAPHICS> section.
627		614
628	Colours higher than 15 cannot be set using resources (yet), but can be	615	Colours higher than 15 cannot be set using resources (yet), but can be
629	changed using an escape command (see @@RXVT_NAME@@(7)).	616	changed using an escape command (see @@RXVT_NAME@@(7)).
630		617
631	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	618	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
642	=item B<colorUL:> I<colour>	629	=item B<colorUL:> I<colour>
643		630
644	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
645	foreground colour is the default.	632	foreground colour is the default.
646		633
647	=item B<colorRV:> I<colour>
648
649	Use the specified colour as the background for reverse video characters
650	when OPTION_HC is disabled (--disable-frills).
651
652	=item B<underlineColor:> I<colour>	634	=item B<underlineColor:> I<colour>
653		635
654	If set, use the specified colour as the colour for the underline	636	If set, use the specified colour as the colour for the underline
655	itself. If unset, use the foreground colour.	637	itself. If unset, use the foreground colour.
		638
		639	=item B<highlightColor:> I<colour>
		640
		641	If set, use the specified colour as the background for highlighted
		642	characters. If unset, use reverse video.
		643
		644	=item B<highlightTextColor:> I<colour>
		645
		646	If set and highlightColor is set, use the specified colour as the
		647	foreground for highlighted characters.
656		648
657	=item B<cursorColor:> I<colour>	649	=item B<cursorColor:> I<colour>
658		650
659	Use the specified colour for the cursor. The default is to use the	651	Use the specified colour for the cursor. The default is to use the
660	foreground colour; option B<-cr>.	652	foreground colour; option B<-cr>.
…		…
667		659
668	=item B<reverseVideo:> I<boolean>	660	=item B<reverseVideo:> I<boolean>
669		661
670	B<True>: simulate reverse video by foreground and background colours;	662	B<True>: simulate reverse video by foreground and background colours;
671	option B<-rv>. B<False>: regular screen colours [default]; option	663	option B<-rv>. B<False>: regular screen colours [default]; option
672	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	664	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673		665
674	=item B<jumpScroll:> I<boolean>	666	=item B<jumpScroll:> I<boolean>
675		667
676	B<True>: specify that jump scrolling should be used. When receiving lots	668	B<True>: specify that jump scrolling should be used. When receiving lots
677	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	669	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
693	if the refresh is too fast for the human eye to read anything (or the	685	if the refresh is too fast for the human eye to read anything (or the
694	monitor to display anything); option B<+ss>.	686	monitor to display anything); option B<+ss>.
695		687
696	=item B<transparent:> I<boolean>	688	=item B<transparent:> I<boolean>
697		689
698	Turn on/off illusion of a transparent window background.	690	Turn on/off pseudo-transparency by using the root pixmap as background.
699		691
700	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
701	future versions.	693	future versions.
702		694
703	I<Please address all transparency related issues to Sasha Vasko at
704	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
705
706	=item B<fading:> I<number>	695	=item B<fading:> I<number>
707		696
708	Fade the text by the given percentage when focus is lost; option B<-fade>.	697	Fade the text by the given percentage when focus is lost; option B<-fade>.
709		698
710	=item B<fadeColor:> I<colour>	699	=item B<fadeColor:> I<colour>
…		…
712	Fade to this colour, when fading is used (see B<fading:>). The default	701	Fade to this colour, when fading is used (see B<fading:>). The default
713	colour is black; option B<-fadecolor>.	702	colour is black; option B<-fadecolor>.
714		703
715	=item B<tintColor:> I<colour>	704	=item B<tintColor:> I<colour>
716		705
717	Tint the transparent background pixmap with the given colour; option	706	Tint the transparent background with the given colour. If the RENDER
718	B<-tint>.	707	extension is not available only black, red, green, yellow, blue,
		708	magenta, cyan and white tints can be performed server-side. Note that
		709	a black tint yields a completely black image while a white tint yields
		710	the image unchanged; option B<-tint>.
719		711
720	=item B<shading:> I<number>	712	=item B<shading:> I<number>
721		713
722	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
723	in addition to tinting it; option B<-sh>.	715	A value of 100 means no shading; option B<-sh>.
724
725	=item B<blendType:> I<string>
726
727	Specify background blending type; option B<-blt>.
728		716
729	=item B<blurRadius:> I<number>	717	=item B<blurRadius:> I<number>
730		718
731	Apply gaussian blur with the specified radius to the transparent	719	Apply gaussian blur with the specified radius to the transparent
732	background image; option B<-blr>.	720	background; option B<-blr>.
733		721
734	=item B<iconFile:> I<file>	722	=item B<iconFile:> I<file>
735		723
736	Set the application icon pixmap; option B<-icon>.	724	Set the application icon pixmap; option B<-icon>.
737		725
…		…
747	=item B<borderColor:> I<colour>	735	=item B<borderColor:> I<colour>
748		736
749	The colour of the border around the text area and between the scrollbar	737	The colour of the border around the text area and between the scrollbar
750	and the text.	738	and the text.
751		739
752	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	740	=item B<backgroundPixmap:> I<file[;oplist]>
753		741
754	Use the specified image file for the background and also	742	Use the specified image file for the background and also
755	optionally specify its scaling with a geometry string B<WxH+X+Y>,	743	optionally specify a colon separated list of operations to modify it.
756	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
757	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758	centre (percent). A scale of 0 displays the image with tiling. A scale
759	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
760	an integer number of images in that direction. No image will be magnified
761	beyond 10 times its original size. The maximum permitted scale is 1000.
762	Additional operations can be specified after colon B<:op1:op2...>.
763	Supported operations are:	744	Supported operations are:
764		745
765	tile force background image to be tiled and not scaled. Equivalent to 0x0	746	=over 4
766	propscale will scale image keeping proportions	747
767	auto will scale image to match window size. Equivalent to 100x100	748	=item B<WxH+X+Y>
768	hscale will scale image horizontally to the window size	749
769	vscale will scale image vertically to the window size	750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
770	scale will scale image to match window size	751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
771	root will tile image as if it was a root window background, auto-adjusting	752	scale of 0 disables scaling.
772	whenever terminal window moves	753
		754	=item B<op=tile>
		755
		756	enables tiling
		757
		758	=item B<op=keep-aspect>
		759
		760	maintain the image aspect ratio when scaling
		761
		762	=item B<op=root-align>
		763
		764	use the position of the terminal window relative to the root window as
		765	the image offset, simulating a root window background
		766
		767	=back
		768
		769	The default scale and position setting is C<100x100+50+50>.
		770	Alternatively, a predefined set of templates can be used to achieve
		771	the most common setups:
		772
		773	=over 4
		774
		775	=item B<style=tiled>
		776
		777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		778
		779	=item B<style=aspect-stretched>
		780
		781	the image is scaled to fill the whole window maintaining the aspect
		782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		783
		784	=item B<style=stretched>
		785
		786	the image is scaled to fill the whole window. Equivalent to 100x100
		787
		788	=item B<style=centered>
		789
		790	the image is centered with no scaling. Equivalent to 0x0+50+50
		791
		792	=item B<style=root-tiled>
		793
		794	the image is tiled with no scaling and using 'root' positioning.
		795	Equivalent to 0x0:op=tile:op=root-align
		796
		797	=back
		798
		799	If multiple templates are specified the last one wins. Note that a
		800	template overrides all the scale, position and operations settings.
773		801
774	If used in conjunction with B<-tr> option, the specified pixmap will be	802	If used in conjunction with B<-tr> option, the specified pixmap will be
775	blended over transparency image using either alpha-blending, or any	803	blended over the transparent background using alpha-blending.
776	other blending type, specified with B<-blt "type"> option.
777		804
778	=item B<path:> I<path>	805	=item B<path:> I<path>
779		806
780	Specify the colon-delimited search path for finding background image files.	807	Specify the colon-delimited search path for finding background image files.
781		808
…		…
808	it is named first) and thus defines the character cell grid to be 9 pixels	835	it is named first) and thus defines the character cell grid to be 9 pixels
809	wide and 15 pixels high.	836	wide and 15 pixels high.
810		837
811	The second font is just used to add additional unicode characters not in	838	The second font is just used to add additional unicode characters not in
812	the base font, likewise the third, which is unfortunately non-bold, but	839	the base font, likewise the third, which is unfortunately non-bold, but
813	the bold version of the font does contain less characters, so this is a	840	the bold version of the font does contain fewer characters, so this is a
814	useful supplement.	841	useful supplement.
815		842
816	The third font is an Xft font with aliasing turned off, and the characters	843	The third font is an Xft font with aliasing turned off, and the characters
817	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	844	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
818	contains other characters, but we are not interested in them.	845	contains other characters, but we are not interested in them.
…		…
908	=item B<scrollstyle:> I<mode>	935	=item B<scrollstyle:> I<mode>
909		936
910	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	937	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
911	the author's favourite.	938	the author's favourite.
912		939
		940	=item B<thickness:> I<number>
		941
		942	Set the scrollbar width in pixels.
		943
913	=item B<scrollBar:> I<boolean>	944	=item B<scrollBar:> I<boolean>
914		945
915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	946	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
916	disable the scrollbar; option B<+sb>.	947	disable the scrollbar; option B<+sb>.
917		948
…		…
936	B<False>: do not scroll to bottom when tty receives output; option	967	B<False>: do not scroll to bottom when tty receives output; option
937	B<+si>.	968	B<+si>.
938		969
939	=item B<scrollWithBuffer:> I<boolean>	970	=item B<scrollWithBuffer:> I<boolean>
940		971
941	B<True>: scroll with scrollback buffer when tty receives new lines (and	972	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
942	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	973	try to show the same lines) and B<scrollTtyOutput> is False; option
943	with scrollback buffer when tty receives new lines; option B<+sw>.	974	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		975	new lines; option B<+sw>.
944		976
945	=item B<scrollTtyKeypress:> I<boolean>	977	=item B<scrollTtyKeypress:> I<boolean>
946		978
947	B<True>: scroll to bottom when a non-special key is pressed. Special keys	979	B<True>: scroll to bottom when a non-special key is pressed. Special keys
948	are those which are intercepted by rxvt-unicode for special handling and	980	are those which are intercepted by rxvt-unicode for special handling and
…		…
1004	=item B<cursorBlink:> I<boolean>	1036	=item B<cursorBlink:> I<boolean>
1005		1037
1006	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1038	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1007	option B<-bc>.	1039	option B<-bc>.
1008		1040
		1041	=item B<cursorUnderline:> I<boolean>
		1042
		1043	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1044	option B<-uc>.
		1045
1009	=item B<pointerBlank:> I<boolean>	1046	=item B<pointerBlank:> I<boolean>
1010		1047
1011	B<True>: blank the pointer when a key is pressed or after a set number	1048	B<True>: blank the pointer when a key is pressed or after a set number
1012	of seconds of inactivity. B<False>: the pointer is always visible	1049	of seconds of inactivity. B<False>: the pointer is always visible
1013	[default].	1050	[default].
…		…
1026	large number (e.g. C<987654321>) to effectively disable the timeout.	1063	large number (e.g. C<987654321>) to effectively disable the timeout.
1027		1064
1028	=item B<backspacekey:> I<string>	1065	=item B<backspacekey:> I<string>
1029		1066
1030	The string to send when the backspace key is pressed. If set to B<DEC>	1067	The string to send when the backspace key is pressed. If set to B<DEC>
1031	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1068	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1032	(code 8) - which can be reversed with the appropriate DEC private mode	1069	(code 8) - which can be reversed with the appropriate DEC private mode
1033	escape sequence.	1070	escape sequence.
1034		1071
1035	=item B<deletekey:> I<string>	1072	=item B<deletekey:> I<string>
1036		1073
…		…
1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1192	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1193	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1157	performed in an exact manner; however, the closest match is assured.	1194	performed in an exact manner; however, the closest match is assured.
1158		1195
1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1196	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1160	number), see RESOURCES in C<man 7 X> for futher details.	1197	number), see RESOURCES in C<man 7 X> for further details.
1161		1198
1162	You can define a range of keysyms in one shot by providing a I<string>	1199	You can define a range of keysyms in one shot by
		1200	loading the C<keysym-list> perl extension and providing a I<string>
1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164	should be a character not used by the strings.	1202	should be a character not used by the strings.
1165		1203
1166	Its usage can be demonstrated by an example:	1204	Its usage can be demonstrated by an example:
1167		1205
1168	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1169		1207
1170	The above line is equivalent to the following three lines:	1208	The above line is equivalent to the following three lines:
1171		1209
1172	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1210	URxvt.keysym.Meta-Control-0x61: \033<a>
1173	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1211	URxvt.keysym.Meta-Control-0x62: \033<b>
1174	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1212	URxvt.keysym.Meta-Control-0x63: \033<c>
1175		1213
1176	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1214	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	1215	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>	1216	example the following means "change the current locale to C<zh_CN.GBK>
1179	when Control-Meta-c is being pressed":	1217	when Control-Meta-c is being pressed":
1180		1218
1181	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1219	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182		1220
1183	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1221	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1184	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1222	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1185	manpage. For example, the F<selection> extension (activated via	1223	manpage. For example, the F<selection> extension (activated via
1186	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187		1225
1188	URxvt.keysym.M-C-c: perl:selection:rot13	1226	URxvt.keysym.M-C-c: perl:selection:rot13
1189		1227
1190	Due the the large number of modifier combinations, a defined key mapping	1228	Due the the large number of modifier combinations, a defined key mapping
1191	will match if at I<at least> the specified identifiers are being set, and	1229	will match if I<at least> the specified identifiers are being set, and
1192	no other key mappings with those and more bits are being defined. That	1230	no other key mappings with those and more bits are being defined. That
1193	means that defining a key map for C<a> will automatically provide	1231	means that defining a key map for C<a> will automatically provide
1194	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195	mappings themselves.	1233	mappings themselves.
1196		1234
…		…
1252	the @@RXVT_NAME@@perl(3) manpage.	1290	the @@RXVT_NAME@@perl(3) manpage.
1253		1291
1254	=item B<perl-lib>: I<path>	1292	=item B<perl-lib>: I<path>
1255		1293
1256	Colon-separated list of additional directories that hold extension	1294	Colon-separated list of additional directories that hold extension
1257	scripts. When looking for extensions specified by the C<perl> resource,	1295	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258	@@RXVT_NAME@@ will first look in these directories and then in	1296	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1297	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260		1298
1261	See the @@RXVT_NAME@@perl(3) manpage.	1299	See the @@RXVT_NAME@@perl(3) manpage.
1262		1300
1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1301	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264		1302
…		…
1286		1324
1287	=item B<override-redirect>: I<boolean>	1325	=item B<override-redirect>: I<boolean>
1288		1326
1289	Compile I<frills>: Sets override-redirect for the terminal window, making	1327	Compile I<frills>: Sets override-redirect for the terminal window, making
1290	it almost invisible to window managers; option B<-override-redirect>.	1328	it almost invisible to window managers; option B<-override-redirect>.
		1329
		1330	=item B<iso14755:> I<boolean>
		1331
		1332	Turn on/off ISO 14755 (default enabled).
1291		1333
1292	=item B<iso14755_52:> I<boolean>	1334	=item B<iso14755_52:> I<boolean>
1293		1335
1294	Turn on/off ISO 14755 5.2 mode (default enabled).	1336	Turn on/off ISO 14755 5.2 mode (default enabled).
1295		1337
…		…
1438	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1480	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1439	it can be seen via the I<who(1)> command, and can accept messages. To	1481	it can be seen via the I<who(1)> command, and can accept messages. To
1440	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1482	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1441	on some systems or setgid to root or to some other group on others.	1483	on some systems or setgid to root or to some other group on others.
1442		1484
1443	=head1 COLORS AND GRAPHICS	1485	=head1 COLOURS AND GRAPHICS
1444		1486
1445	In addition to the default foreground and background colours,	1487	In addition to the default foreground and background colours,
1446	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1488	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1447	high-intensity bold/blink versions of the same). Here is a list of the	1489	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1448	colours with their names.	1490	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1491	cube plus a 8 (24) colour greyscale ramp.
		1492
		1493	Here is a list of the ANSI colours with their names.
1449		1494
1450	=begin table	1495	=begin table
1451		1496
1452	B<color0> (black) = Black	1497	B<color0> (black) = Black
1453	B<color1> (red) = Red3	1498	B<color1> (red) = Red3
…		…
1473	It is also possible to specify the colour values of B<foreground>,	1518	It is also possible to specify the colour values of B<foreground>,
1474	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1519	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475	a number 0-15, as a convenient shorthand to reference the colour name of	1520	a number 0-15, as a convenient shorthand to reference the colour name of
1476	color0-color15.	1521	color0-color15.
1477		1522
1478	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1523	The following text gives values for the standard 88 colour mode (and
1479	additional 72 colours. The first 64 of those (with indices 16 to 79)	1524	values for the 256 colour mode in parentheses).
1480	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1481	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1482		1525
		1526	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1527
		1528	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1529	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1530
		1531	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1532	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1533	the RGB cube.
		1534
1483	Together, all those colours implement the 88 colour xterm colours. Only	1535	Together, all those colours implement the 88 (256) colour xterm
1484	the first 16 can be changed using resources currently, the rest can only	1536	colours. Only the first 16 can be changed using resources currently, the
1485	be changed via command sequences ("escape codes").	1537	rest can only be changed via command sequences ("escape codes").
		1538
		1539	Applications are advised to use terminfo or command sequences to discover
		1540	number and RGB values of all colours (yes, you can query this...).
1486		1541
1487	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1542	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488	always swapping the foreground/background colours. This is in contrast to	1543	always swapping the foreground/background colours. This is in contrast to
1489	I<xterm>(1) where the colours are only swapped if they have not otherwise	1544	I<xterm>(1) where the colours are only swapped if they have not otherwise
1490	been specified. For example,	1545	been specified. For example,
1491		1546
1492	=over 4
1493
1494	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1547	@@RXVT_NAME@@ -fg Black -bg White -rv
1495		1548
1496	would yield White on Black, while on I<xterm>(1) it would yield Black	1549	would yield White on Black, while on I<xterm>(1) it would yield Black on
1497	on White.	1550	White.
1498
1499	=back
1500		1551
1501	=head2 ALPHA CHANNEL SUPPORT	1552	=head2 ALPHA CHANNEL SUPPORT
1502		1553
1503	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1554	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1504	their act together, rxvt-unicode will do it's own alpha channel management:	1555	their act together, rxvt-unicode will do its own alpha channel management:
1505		1556
1506	You can prefix any color with an opaquenes percentage enclosed in	1557	You can prefix any colour with an opaqueness percentage enclosed in
1507	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1558	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508	(0-100) that specifies the opacity of the color, where C<0> is completely	1559	(0-100) that specifies the opacity of the colour, where C<0> is completely
1509	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1560	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1561	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511	is the recommended format to specify transparency values, and works with	1562	is the recommended format to specify transparency values, and works with
1512	all ways to specify a colour.	1563	all ways to specify a colour.
1513		1564
…		…
1591		1642
1592	=item B<SHELL>	1643	=item B<SHELL>
1593		1644
1594	The shell to be used for command execution, defaults to C</bin/sh>.	1645	The shell to be used for command execution, defaults to C</bin/sh>.
1595		1646
1596	=item B<RXVT_SOCKET>	1647	=item B<RXVT_SOCKET> [I<sic>]
1597		1648
1598	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1649	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1599	@@RXVT_NAME@@d(1).	1650	@@RXVT_NAME@@d(1).
1600		1651
1601	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1652	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1653
		1654	=item B<URXVT_PERL_LIB>
		1655
		1656	Additional F<:>-separated library search path for perl extensions. Will be
		1657	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1658	directory.
		1659
		1660	=item B<URXVT_PERL_VERBOSITY>
		1661
		1662	See L<@@RXVT_NAME@@perl>(3).
1602		1663
1603	=item B<HOME>	1664	=item B<HOME>
1604		1665
1605	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
1606	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1607	C<.Xdefaults>)	1668	C<.Xdefaults>)
1608		1669
1609	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1610		1671
1611	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1612		1673
1613	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1614		1675
1615	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
1616	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1621		1682
1622	=over 4	1683	=over 4
1623		1684
1624	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1625		1686
1626	Color names.	1687	Colour names.
1627		1688
1628	=back	1689	=back
1629		1690
1630	=head1 SEE ALSO	1691	=head1 SEE ALSO
1631		1692
		1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1632	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1694	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1633		1695
1634	=head1 CURRENT PROJECT COORDINATOR	1696	=head1 CURRENT PROJECT COORDINATOR
1635		1697
1636	=over 4	1698	=over 4
1637		1699
…		…
1682		1744
1683	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1684		1746
1685	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1686		1748
1687	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1688		1750
1689	=back	1751	=back
1690		1752

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs. Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC