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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.171 by root, Sat May 30 08:53:48 2009 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 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
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
		116
111	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
112		118
113	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
114		120
115	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122		128
123	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
124		130
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127	=item B<-tr>\|B<+tr>
128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131	B<-ip> is still accepted as an obsolete alias but will be removed in
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		132
137	=item B<-fade> I<number>	133	=item B<-fade> I<number>
138		134
139	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
…		…
143	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
144		140
145	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
147		143
148	=item B<-tint> I<colour>
149
150	Tint the transparent background pixmap with the given colour when
151	transparency is enabled with B<-tr>. This only works for
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
162	=item B<-sh> I<number>
163
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
165	background image in addition to (or instead of) tinting it;
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
178	=item B<-blr> I<HxV>
179
180	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and
182	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
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185	resource I<blurRadius>.
186
187	=item B<-icon> I<file>	144	=item B<-icon> I<file>
188		145
189	Compile I<afterimage>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
190	is used by many window managers, taskbars and pagers to represent the	147	is used by many window managers, taskbars and pagers to represent the
191	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
192		149
193	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
194		151
195	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
196		153
197	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
198		155
199	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
200
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203	Compile I<afterimage>: Specify image file for the background and also
204	optionally specify its scaling with a geometry string. Note you may need to
205	add quotes to avoid special shell interpretation of the C<;> in the
206	command-line; for more details see resource B<backgroundPixmap>.
207		157
208	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
209		159
210	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
211		161
…		…
270		220
271	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
272		222
273	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
274		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
275	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
276		230
277	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278	B<utmpInhibit>.	232	B<utmpInhibit>.
279		233
…		…
357		311
358	=item B<-override-redirect>	312	=item B<-override-redirect>
359		313
360	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
361	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
362		321
363	=item B<-sbg>	322	=item B<-sbg>
364		323
365	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
366	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
421	=item B<-pt> I<style>	380	=item B<-pt> I<style>
422		381
423	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
424	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
425		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
426	=item B<-im> I<text>	388	=item B<-im> I<text>
427		389
428	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
429		391
430	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
571	You can set and change the resources using X11 tools like B<xrdb>. Many	533	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	534	distribution do also load settings from the B<~/.Xresources> file when X
573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
575		537
576	1. system-wide app-defaults file, either locale-dependent OR global
577	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
579	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581	6. resources specified via -xrm on the commandline	543	6. resources specified via -xrm on the commandline
582		544
583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	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	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
625	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
626	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
627	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
631		593
632	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
633	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
634		596
635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
646	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
647		609
648	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
649	foreground colour is the default.	611	foreground colour is the default.
650		612
651	=item B<colorRV:> I<colour>
652
653	Use the specified colour as the background for reverse video characters
654	when OPTION_HC is disabled (--disable-frills).
655
656	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
657		614
658	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
659	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
660		627
661	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
662		629
663	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
664	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
671		638
672	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
673		640
674	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
675	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
676	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
677		644
678	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
679		646
680	B<True>: specify that jump scrolling should be used. When receiving lots	647	B<True>: specify that jump scrolling should be used. When receiving lots
681	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
695		662
696	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
697	if the refresh is too fast for the human eye to read anything (or the	664	if the refresh is too fast for the human eye to read anything (or the
698	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
699		666
700	=item B<transparent:> I<boolean>
701
702	Turn on/off illusion of a transparent window background.
703
704	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
705	future versions.
706
707	I<Please address all transparency related issues to Sasha Vasko at
708	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
709
710	=item B<fading:> I<number>	667	=item B<fading:> I<number>
711		668
712	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
713		670
714	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
715		672
716	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
717	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
718		675
719	=item B<tintColor:> I<colour>
720
721	Tint the transparent background pixmap with the given colour; option
722	B<-tint>.
723
724	=item B<shading:> I<number>
725
726	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
727	in addition to tinting it; option B<-sh>.
728
729	=item B<blendType:> I<string>
730
731	Specify background blending type; option B<-blt>.
732
733	=item B<blurRadius:> I<number>
734
735	Apply gaussian blur with the specified radius to the transparent
736	background image; option B<-blr>.
737
738	=item B<iconFile:> I<file>	676	=item B<iconFile:> I<file>
739		677
740	Set the application icon pixmap; option B<-icon>.	678	Set the application icon pixmap; option B<-icon>.
741		679
742	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
…		…
750		688
751	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
752		690
753	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
754	and the text.	692	and the text.
755
756	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
757
758	Use the specified image file for the background and also
759	optionally specify its scaling with a geometry string B<WxH+X+Y>,
760	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
761	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
762	centre (percent). A scale of 0 displays the image with tiling. A scale
763	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
764	an integer number of images in that direction. No image will be magnified
765	beyond 10 times its original size. The maximum permitted scale is 1000.
766	Additional operations can be specified after colon B<:op1:op2...>.
767	Supported operations are:
768
769	tile force background image to be tiled and not scaled. Equivalent to 0x0
770	propscale will scale image keeping proportions
771	auto will scale image to match window size. Equivalent to 100x100
772	hscale will scale image horizontally to the window size
773	vscale will scale image vertically to the window size
774	scale will scale image to match window size
775	root will tile image as if it was a root window background, auto-adjusting
776	whenever terminal window moves
777
778	If used in conjunction with B<-tr> option, the specified pixmap will be
779	blended over transparency image using either alpha-blending, or any
780	other blending type, specified with B<-blt "type"> option.
781
782	=item B<path:> I<path>
783
784	Specify the colon-delimited search path for finding background image files.
785		693
786	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
787		695
788	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
789	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
812	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
813	wide and 15 pixels high.	721	wide and 15 pixels high.
814		722
815	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
816	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
817	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
818	useful supplement.	726	useful supplement.
819		727
820	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
821	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
822	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
886		794
887	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
888	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
889	[default]; option B<+ls>.	797	[default]; option B<+ls>.
890		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
891	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
892		805
893	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
894	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
895	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
912	=item B<scrollstyle:> I<mode>	825	=item B<scrollstyle:> I<mode>
913		826
914	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915	the author's favourite.	828	the author's favourite.
916		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
917	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
918		835
919	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
920	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
921		838
…		…
940	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
941	B<+si>.	858	B<+si>.
942		859
943	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
944		861
945	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
946	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
947	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
948		866
949	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
950		868
951	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
952	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
…		…
1027		945
1028	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
1029		947
1030	Mouse pointer background colour.	948	Mouse pointer background colour.
1031		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
1032	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
1033		957
1034	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
1035	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
1036		960
1037	=item B<backspacekey:> I<string>	961	=item B<backspacekey:> I<string>
1038		962
1039	The string to send when the backspace key is pressed. If set to B<DEC>	963	The string to send when the backspace key is pressed. If set to B<DEC>
1040	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	964	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1041	(code 8) - which can be reversed with the appropriate DEC private mode	965	(code 8) - which can be reversed with the appropriate DEC private mode
1042	escape sequence.	966	escape sequence.
1043		967
1044	=item B<deletekey:> I<string>	968	=item B<deletekey:> I<string>
1045		969
…		…
1062		986
1063	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1064		988
1065	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
1066		990
1067	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1068		992
1069	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
1070		994
1071	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
1072		996
…		…
1141	Sets the working directory for the shell (or the command specified via	1065	Sets the working directory for the shell (or the command specified via
1142	B<-e>). The I<path> must be an absolute path and it must exist for	1066	B<-e>). The I<path> must be an absolute path and it must exist for
1143	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1144	directory will be used; option B<-cd>.	1068	directory will be used; option B<-cd>.
1145		1069
1146	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1147		1071
1148	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1149	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1150		1074
1151	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1152	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1153	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1077	string than would normally result from that combination, making the
1154	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1078	terminal scroll up or down the way you want it, or any other thing an
1155	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1156		1089
1157	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1158	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1159	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1160	current application keymap mode state.	1093	current application keymap mode state.
1161		1094
1162	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1163	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1164	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1165	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1166	performed in an exact manner; however, the closest match is assured.
1167		1108
1168	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1169	number), see RESOURCES in C<man 7 X> for futher details.	1111	number), see RESOURCES in C<man 7 X> for further details.
1170		1112
1171	You can define a range of keysyms in one shot by providing a I<string>	1113	An action starts with an action prefix that selects a certain type
1172	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1114	of action, followed by a colon. An action string without colons is
		1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1173	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1174		1138
1175	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1176		1140
1177	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1178		1142
1179	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1180		1144
1181	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1182	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1183	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1184		1148
		1149	=item command:STRING
		1150
1185	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1186	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1187	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1188	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1189		1159
1190	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1191		1161
1192	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1193	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1194	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1195	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1196		1165
1197	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1198		1168
1199	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1200	will match if at I<at least> the specified identifiers are being set, and	1170	info):
1201	no other key mappings with those and more bits are being defined. That
1202	means that defining a key map for C<a> will automatically provide
1203	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1204	mappings themselves.
1205		1171
1206	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1207	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1208	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1209	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1210		1185
1211	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1212	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1213		1188
1214	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1215	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1216	C<Shift-Insert>.	1191	C<Shift-Insert>.
1217		1192
1218	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1219	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1220	font-switching at runtime:
1221		1194
1222	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1223	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1224		1200
1225	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1226	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1227		1205
1228	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1229	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1230		1243
1231	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1232		1245
1233	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1234		1247
…		…
1236	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1237		1250
1238	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1239	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1240	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1241	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1242	C<selection>.	1255	C<selection>.
1243		1256
1244	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1245	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1246	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1247	multiple times with different arguments will pass multiple arguments to	1260
1248	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1249		1263
1250	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1251	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1252		1268
1253	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1254	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1255	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1256	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1257		1273
1258	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1259		1275
…		…
1261	the @@RXVT_NAME@@perl(3) manpage.	1277	the @@RXVT_NAME@@perl(3) manpage.
1262		1278
1263	=item B<perl-lib>: I<path>	1279	=item B<perl-lib>: I<path>
1264		1280
1265	Colon-separated list of additional directories that hold extension	1281	Colon-separated list of additional directories that hold extension
1266	scripts. When looking for extensions specified by the C<perl> resource,	1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1267	@@RXVT_NAME@@ will first look in these directories and then in	1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1268	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1269		1285
1270	See the @@RXVT_NAME@@perl(3) manpage.	1286	See the @@RXVT_NAME@@perl(3) manpage.
1271		1287
1272	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1273		1289
…		…
1277	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1278		1294
1279	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1280	for details.	1296	for details.
1281		1297
1282	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1283		1299
1284	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1285	(default: C<M-s>).	1301	instead, e.g.:
1286		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1287	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1288		1306
1289	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1290	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1291		1309
1292	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1296	=item B<override-redirect>: I<boolean>	1314	=item B<override-redirect>: I<boolean>
1297		1315
1298	Compile I<frills>: Sets override-redirect for the terminal window, making	1316	Compile I<frills>: Sets override-redirect for the terminal window, making
1299	it almost invisible to window managers; option B<-override-redirect>.	1317	it almost invisible to window managers; option B<-override-redirect>.
1300		1318
		1319	=item B<iso14755:> I<boolean>
		1320
		1321	Turn on/off ISO 14755 (default enabled).
		1322
1301	=item B<iso14755_52:> I<boolean>	1323	=item B<iso14755_52:> I<boolean>
1302		1324
1303	Turn on/off ISO 14755 5.2 mode (default enabled).	1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1304		1440
1305	=back	1441	=back
1306		1442
1307	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1308		1444
…		…
1356	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1357	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1358		1494
1359	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1360	inserted too.	1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
1361		1503
1362	=back	1504	=back
1363		1505
1364	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1365		1507
…		…
1447	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1589	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1448	it can be seen via the I<who(1)> command, and can accept messages. To	1590	it can be seen via the I<who(1)> command, and can accept messages. To
1449	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1591	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1450	on some systems or setgid to root or to some other group on others.	1592	on some systems or setgid to root or to some other group on others.
1451		1593
1452	=head1 COLORS AND GRAPHICS	1594	=head1 COLOURS AND GRAPHICS
1453		1595
1454	In addition to the default foreground and background colours,	1596	In addition to the default foreground and background colours,
1455	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1597	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1456	high-intensity bold/blink versions of the same). Here is a list of the	1598	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1457	colours with their names.	1599	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1600	cube plus a 8 (24) colour greyscale ramp.
		1601
		1602	Here is a list of the ANSI colours with their names.
1458		1603
1459	=begin table	1604	=begin table
1460		1605
1461	B<color0> (black) = Black	1606	B<color0> (black) = Black
1462	B<color1> (red) = Red3	1607	B<color1> (red) = Red3
…		…
1482	It is also possible to specify the colour values of B<foreground>,	1627	It is also possible to specify the colour values of B<foreground>,
1483	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1628	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1484	a number 0-15, as a convenient shorthand to reference the colour name of	1629	a number 0-15, as a convenient shorthand to reference the colour name of
1485	color0-color15.	1630	color0-color15.
1486		1631
1487	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1632	The following text gives values for the standard 88 colour mode (and
1488	additional 72 colours. The first 64 of those (with indices 16 to 79)	1633	values for the 256 colour mode in parentheses).
1489	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1490	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1491		1634
		1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1636
		1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1639
		1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1642	the RGB cube.
		1643
1492	Together, all those colours implement the 88 colour xterm colours. Only	1644	Together, all those colours implement the 88 (256) colour xterm
1493	the first 16 can be changed using resources currently, the rest can only	1645	colours. Only the first 16 can be changed using resources currently, the
1494	be changed via command sequences ("escape codes").	1646	rest can only be changed via command sequences ("escape codes").
		1647
		1648	Applications are advised to use terminfo or command sequences to discover
		1649	number and RGB values of all colours (yes, you can query this...).
1495		1650
1496	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1651	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1497	always swapping the foreground/background colours. This is in contrast to	1652	always swapping the foreground/background colours. This is in contrast to
1498	I<xterm>(1) where the colours are only swapped if they have not otherwise	1653	I<xterm>(1) where the colours are only swapped if they have not otherwise
1499	been specified. For example,	1654	been specified. For example,
1500		1655
1501	=over 4
1502
1503	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1656	@@RXVT_NAME@@ -fg Black -bg White -rv
1504		1657
1505	would yield White on Black, while on I<xterm>(1) it would yield Black	1658	would yield White on Black, while on I<xterm>(1) it would yield Black on
1506	on White.	1659	White.
1507
1508	=back
1509		1660
1510	=head2 ALPHA CHANNEL SUPPORT	1661	=head2 ALPHA CHANNEL SUPPORT
1511		1662
1512	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1663	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1513	their act together, rxvt-unicode will do it's own alpha channel management:	1664	their act together, rxvt-unicode will do its own alpha channel management:
1514		1665
1515	You can prefix any color with an opaquenes percentage enclosed in	1666	You can prefix any colour with an opaqueness percentage enclosed in
1516	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1667	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517	(0-100) that specifies the opacity of the color, where C<0> is completely	1668	(0-100) that specifies the opacity of the colour, where C<0> is completely
1518	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1669	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1519	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1670	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520	is the recommended format to specify transparency values, and works with	1671	is the recommended format to specify transparency values, and works with
1521	all ways to specify a colour.	1672	all ways to specify a colour.
1522		1673
…		…
1600		1751
1601	=item B<SHELL>	1752	=item B<SHELL>
1602		1753
1603	The shell to be used for command execution, defaults to C</bin/sh>.	1754	The shell to be used for command execution, defaults to C</bin/sh>.
1604		1755
1605	=item B<RXVT_SOCKET>	1756	=item B<RXVT_SOCKET> [I<sic>]
1606		1757
1607	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1608	@@RXVT_NAME@@d(1).	1759	@@RXVT_NAME@@d(1).
1609		1760
1610	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
1611		1772
1612	=item B<HOME>	1773	=item B<HOME>
1613		1774
1614	Used to locate the default directory for the unix domain socket for	1775	Used to locate the default directory for the unix domain socket for
1615	daemon communications and to locate various resource files (such as	1776	daemon communications and to locate various resource files (such as
1616	C<.Xdefaults>)	1777	C<.Xdefaults>)
1617		1778
1618	=item B<XAPPLRESDIR>	1779	=item B<XAPPLRESDIR>
1619		1780
1620	Directory where various X resource files are being located.	1781	Directory where application-specific X resource files are located.
1621		1782
1622	=item B<XENVIRONMENT>	1783	=item B<XENVIRONMENT>
1623		1784
1624	If set and accessible, gives the name of a X resource file to be loaded by	1785	If set and accessible, gives the name of a X resource file to be loaded by
1625	@@RXVT_NAME@@.	1786	@@RXVT_NAME@@.
…		…
1630		1791
1631	=over 4	1792	=over 4
1632		1793
1633	=item B</usr/lib/X11/rgb.txt>	1794	=item B</usr/lib/X11/rgb.txt>
1634		1795
1635	Color names.	1796	Colour names.
1636		1797
1637	=back	1798	=back
1638		1799
1639	=head1 SEE ALSO	1800	=head1 SEE ALSO
1640		1801
		1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1641	@@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)	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1642		1804
1643	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1644		1806
1645	=over 4	1807	=over 4
1646		1808
1647	=item Project Coordinator	1809	=item Project Coordinator
1648		1810
1649	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1650		1812
1651	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1652		1814
1653	=back	1815	=back
1654		1816
…		…
1658		1820
1659	=item John Bovey	1821	=item John Bovey
1660		1822
1661	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1662		1824
1663	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1664		1826
1665	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1666		1828
1667	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1668		1830
1669	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1670		1832
1671	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1672		1834
1673	Wrote the menu system.	1835	Wrote the menu system.
1674		1836
1675	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1676		1838
1677	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1678		1840
1679	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1680		1842
1681	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1682		1844
1683	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1684		1846
1685	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1686		1848
1687	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1688		1850
1689	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1690	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1691		1853
1692	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1693		1855
1694	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1695		1857
1696	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1697		1859
1698	=back	1860	=back
1699		1861

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.171 by root, Sat May 30 08:53:48 2009 UTC vs. Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.171 by root, Sat May 30 08:53:48 2009 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC