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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC

…		…
124		124
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		126
127	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
128		128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		130
131	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	132	future versions.
133
134	I<Please address all transparency related issues to Sasha Vasko at
135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136		133
137	=item B<-fade> I<number>	134	=item B<-fade> I<number>
138		135
139	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
140	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
145	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
147		144
148	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
149		146
150	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colors essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161		149
162	=item B<-sh> I<number>	150	=item B<-sh> I<number>
163		151
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
166	resource I<shading>.
167		154
168	=item B<-blt> I<string>	155	=item B<-blt> I<string>
169		156
170	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	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	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177		164
178	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
179		166
180	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
182	horizontal radii are considered to be the same. Setting one of the	169	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	170	radii to 1 and another to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
185	resource I<blurRadius>.	172	resource I<blurRadius>.
186		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
		179
187	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
188		181
189	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
190		183
191	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
192		185
193	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
194		187
195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;oplist]>
196		189
197	Compile I<afterimage>: Specify image file for the background and also	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
198	optionally specify its scaling with a geometry string. Note you may need to	191	optionally specify a list of operations to modify it. Note you may need to
199	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
200	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
201		194
202	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
203		196
…		…
315		308
316	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
317		310
318	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
319		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
320	=item B<-iconic>	317	=item B<-iconic>
321		318
322	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
323	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
324		321
…		…
340		337
341	=item B<-bl>	338	=item B<-bl>
342		339
343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344	if honoured by the WM, the rxvt-unicode window will not have window	341	if honoured by the WM, the rxvt-unicode window will not have window
345	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
346		344
347	=item B<-override-redirect>	345	=item B<-override-redirect>
348		346
349	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
350	B<override-redirect>.	348	B<override-redirect>.
…		…
359	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
360		358
361	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
362	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
363	B<lineSpace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
364		369
365	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
366		371
367	This option specifies the name of the terminal type to be set in the	372	This option specifies the name of the terminal type to be set in the
368	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
553	You can set and change the resources using X11 tools like B<xrdb>. Many	558	You can set and change the resources using X11 tools like B<xrdb>. Many
554	distribution do also load settings from the B<~/.Xresources> file when X	559	distribution do also load settings from the B<~/.Xresources> file when X
555	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
556	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
557		562
558	1. system-wide app-defaults file, either locale-dependent OR global
559	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
560	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
561	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
562	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
564		569
565	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
566	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
607	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
608	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
609	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
610	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
611	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	616	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
612	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
613		618
614	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
615	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
616		621
617	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
628	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
629		634
630	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
631	foreground colour is the default.	636	foreground colour is the default.
632		637
633	=item B<colorRV:> I<colour>
634
635	Use the specified colour as the background for reverse video characters
636	when OPTION_HC is disabled (--disable-frills).
637
638	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
639		639
640	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
641	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
642		652
643	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
644		654
645	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
646	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
653		663
654	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
655		665
656	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
657	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
658	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
659		669
660	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
661		671
662	B<True>: specify that jump scrolling should be used. When receiving lots	672	B<True>: specify that jump scrolling should be used. When receiving lots
663	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
679	if the refresh is too fast for the human eye to read anything (or the	689	if the refresh is too fast for the human eye to read anything (or the
680	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
681		691
682	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
683		693
684	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
685		695
686	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
687	future versions.	697	future versions.
688		698
689	I<Please address all transparency related issues to Sasha Vasko at
690	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
691
692	=item B<fading:> I<number>	699	=item B<fading:> I<number>
693		700
694	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
695		702
696	=item B<fadeColor:> I<colour>	703	=item B<fadeColor:> I<colour>
…		…
698	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
699	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
700		707
701	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
702		709
703	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
704	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
705		715
706	=item B<shading:> I<number>	716	=item B<shading:> I<number>
707		717
708	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
709	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
710		720
711	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
712		722
713	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
714		724
715	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
716		726
717	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
718	background image; option B<-blr>.	728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
719		733
720	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
721		735
722	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
723		737
…		…
729	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
730		744
731	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
732	and the text.	746	and the text.
733		747
734	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
735		749
736	Use the specified image file for the background and also	750	Use the specified image file for the background and also
737	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
738	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
739	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
740	centre (percent). A scale of 0 displays the image with tiling. A scale
741	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
742	an integer number of images in that direction. No image will be magnified
743	beyond 10 times its original size. The maximum permitted scale is 1000.
744	Additional operations can be specified after colon B<:op1:op2...>.
745	Supported operations are:	752	Supported operations are:
746		753
747	tile force background image to be tiled and not scaled. Equivalent to 0x0	754	=over 4
748	propscale will scale image keeping proportions	755
749	auto will scale image to match window size. Equivalent to 100x100	756	=item B<WxH+X+Y>
750	hscale will scale image horizontally to the window size	757
751	vscale will scale image vertically to the window size	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
752	scale will scale image to match window size	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
753	root will tile image as if it was a root window background, auto-adjusting	760	scale of 0 disables scaling. The maximum permitted scale is 1000.
754	whenever terminal window moves	761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=keep-aspect>
		767
		768	maintain the image aspect ratio when scaling
		769
		770	=item B<op=root-align>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root-align
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
755		809
756	If used in conjunction with B<-tr> option, the specified pixmap will be	810	If used in conjunction with B<-tr> option, the specified pixmap will be
757	blended over transparency image using either alpha-blending, or any	811	blended over the transparent background using alpha-blending. If I<afterimage>
758	other blending type, specified with B<-blt "type"> option.	812	support has been compiled in it is possible to choose other blending
		813	types with B<-blt "type"> option.
759		814
760	=item B<path:> I<path>	815	=item B<path:> I<path>
761		816
762	Specify the colon-delimited search path for finding background image files.	817	Specify the colon-delimited search path for finding background image files.
763		818
…		…
790	it is named first) and thus defines the character cell grid to be 9 pixels	845	it is named first) and thus defines the character cell grid to be 9 pixels
791	wide and 15 pixels high.	846	wide and 15 pixels high.
792		847
793	The second font is just used to add additional unicode characters not in	848	The second font is just used to add additional unicode characters not in
794	the base font, likewise the third, which is unfortunately non-bold, but	849	the base font, likewise the third, which is unfortunately non-bold, but
795	the bold version of the font does contain less characters, so this is a	850	the bold version of the font does contain fewer characters, so this is a
796	useful supplement.	851	useful supplement.
797		852
798	The third font is an Xft font with aliasing turned off, and the characters	853	The third font is an Xft font with aliasing turned off, and the characters
799	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	854	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
800	contains other characters, but we are not interested in them.	855	contains other characters, but we are not interested in them.
…		…
851	=item B<urgentOnBell:> I<boolean>	906	=item B<urgentOnBell:> I<boolean>
852		907
853	B<True>: set the urgency hint for the wm on receipt of a bell character.	908	B<True>: set the urgency hint for the wm on receipt of a bell character.
854	B<False>: do not set the urgency hint [default].	909	B<False>: do not set the urgency hint [default].
855		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
856	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
857		914
858	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	915	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
859	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
860		917
…		…
888	=item B<scrollstyle:> I<mode>	945	=item B<scrollstyle:> I<mode>
889		946
890	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891	the author's favourite.	948	the author's favourite.
892		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
893	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
894		955
895	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
896	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
897		958
…		…
916	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
917	B<+si>.	978	B<+si>.
918		979
919	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
920		981
921	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
922	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	983	try to show the same lines) and B<scrollTtyOutput> is False; option
923	with scrollback buffer when tty receives new lines; option B<+sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
924		986
925	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
926		988
927	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	B<True>: scroll to bottom when a non-special key is pressed. Special keys
928	are those which are intercepted by rxvt-unicode for special handling and	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
984	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
985		1047
986	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1048	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
987	option B<-bc>.	1049	option B<-bc>.
988		1050
		1051	=item B<cursorUnderline:> I<boolean>
		1052
		1053	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1054	option B<-uc>.
		1055
989	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
990		1057
991	B<True>: blank the pointer when a key is pressed or after a set number	1058	B<True>: blank the pointer when a key is pressed or after a set number
992	of seconds of inactivity. B<False>: the pointer is always visible	1059	of seconds of inactivity. B<False>: the pointer is always visible
993	[default].	1060	[default].
…		…
1006	large number (e.g. C<987654321>) to effectively disable the timeout.	1073	large number (e.g. C<987654321>) to effectively disable the timeout.
1007		1074
1008	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
1009		1076
1010	The string to send when the backspace key is pressed. If set to B<DEC>	1077	The string to send when the backspace key is pressed. If set to B<DEC>
1011	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1078	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1012	(code 8) - which can be reversed with the appropriate DEC private mode	1079	(code 8) - which can be reversed with the appropriate DEC private mode
1013	escape sequence.	1080	escape sequence.
1014		1081
1015	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
1016		1083
…		…
1135	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1202	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1136	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1137	performed in an exact manner; however, the closest match is assured.	1204	performed in an exact manner; however, the closest match is assured.
1138		1205
1139	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1206	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1140	number), see RESOURCES in C<man 7 X> for futher details.	1207	number), see RESOURCES in C<man 7 X> for further details.
1141		1208
1142	You can define a range of keysyms in one shot by providing a I<string>	1209	You can define a range of keysyms in one shot by
		1210	loading the C<keysym-list> perl extension and providing a I<string>
1143	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1144	should be a character not used by the strings.	1212	should be a character not used by the strings.
1145		1213
1146	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1147		1215
1148	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1149		1217
1150	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1151		1219
1152	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: \033<a>
1153	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: \033<b>
1154	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: \033<c>
1155		1223
1156	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1224	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1157	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1225	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1158	example the following means "change the current locale to C<zh_CN.GBK>	1226	example the following means "change the current locale to C<zh_CN.GBK>
1159	when Control-Meta-c is being pressed":	1227	when Control-Meta-c is being pressed":
1160		1228
1161	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1229	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1162		1230
1163	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1231	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1164	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1232	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1165	manpage. For example, the F<selection> extension (activated via	1233	manpage. For example, the F<selection> extension (activated via
1166	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1234	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167		1235
1168	URxvt.keysym.M-C-c: perl:selection:rot13	1236	URxvt.keysym.M-C-c: perl:selection:rot13
1169		1237
1170	Due the the large number of modifier combinations, a defined key mapping	1238	Due the the large number of modifier combinations, a defined key mapping
1171	will match if at I<at least> the specified identifiers are being set, and	1239	will match if I<at least> the specified identifiers are being set, and
1172	no other key mappings with those and more bits are being defined. That	1240	no other key mappings with those and more bits are being defined. That
1173	means that defining a key map for C<a> will automatically provide	1241	means that defining a key map for C<a> will automatically provide
1174	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1242	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1175	mappings themselves.	1243	mappings themselves.
1176		1244
…		…
1227	all instances, while B<perl-ext> is used for specific instances.	1295	all instances, while B<perl-ext> is used for specific instances.
1228		1296
1229	=item B<perl-eval>: I<string>	1297	=item B<perl-eval>: I<string>
1230		1298
1231	Perl code to be evaluated when all extensions have been registered. See	1299	Perl code to be evaluated when all extensions have been registered. See
1232	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1300	the @@RXVT_NAME@@perl(3) manpage.
1233	will be ignored when running setuid/setgid.
1234		1301
1235	=item B<perl-lib>: I<path>	1302	=item B<perl-lib>: I<path>
1236		1303
1237	Colon-separated list of additional directories that hold extension	1304	Colon-separated list of additional directories that hold extension
1238	scripts. When looking for extensions specified by the C<perl> resource,	1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1239	@@RXVT_NAME@@ will first look in these directories and then in	1306	look in these directories, then in $HOME/.urxvt/ext and lastly in
1240	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241	will be ignored when running setuid/setgid.
1242		1308
1243	See the @@RXVT_NAME@@perl(3) manpage.	1309	See the @@RXVT_NAME@@perl(3) manpage.
1244		1310
1245	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246		1312
…		…
1268		1334
1269	=item B<override-redirect>: I<boolean>	1335	=item B<override-redirect>: I<boolean>
1270		1336
1271	Compile I<frills>: Sets override-redirect for the terminal window, making	1337	Compile I<frills>: Sets override-redirect for the terminal window, making
1272	it almost invisible to window managers; option B<-override-redirect>.	1338	it almost invisible to window managers; option B<-override-redirect>.
		1339
		1340	=item B<iso14755:> I<boolean>
		1341
		1342	Turn on/off ISO 14755 (default enabled).
1273		1343
1274	=item B<iso14755_52:> I<boolean>	1344	=item B<iso14755_52:> I<boolean>
1275		1345
1276	Turn on/off ISO 14755 5.2 mode (default enabled).	1346	Turn on/off ISO 14755 5.2 mode (default enabled).
1277		1347
…		…
1420	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1490	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1421	it can be seen via the I<who(1)> command, and can accept messages. To	1491	it can be seen via the I<who(1)> command, and can accept messages. To
1422	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1492	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1423	on some systems or setgid to root or to some other group on others.	1493	on some systems or setgid to root or to some other group on others.
1424		1494
1425	=head1 COLORS AND GRAPHICS	1495	=head1 COLOURS AND GRAPHICS
1426		1496
1427	In addition to the default foreground and background colours,	1497	In addition to the default foreground and background colours,
1428	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1498	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1429	high-intensity bold/blink versions of the same). Here is a list of the	1499	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1430	colours with their names.	1500	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1501	cube plus a 8 (24) colour greyscale ramp.
		1502
		1503	Here is a list of the ANSI colours with their names.
1431		1504
1432	=begin table	1505	=begin table
1433		1506
1434	B<color0> (black) = Black	1507	B<color0> (black) = Black
1435	B<color1> (red) = Red3	1508	B<color1> (red) = Red3
…		…
1455	It is also possible to specify the colour values of B<foreground>,	1528	It is also possible to specify the colour values of B<foreground>,
1456	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1529	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1457	a number 0-15, as a convenient shorthand to reference the colour name of	1530	a number 0-15, as a convenient shorthand to reference the colour name of
1458	color0-color15.	1531	color0-color15.
1459		1532
1460	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1533	The following text gives values for the standard 88 colour mode (and
1461	additional 72 colours. The first 64 of those (with indices 16 to 79)	1534	values for the 256 colour mode in parentheses).
1462	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1463	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1464		1535
		1536	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1537
		1538	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1539	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1540
		1541	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1542	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1543	the RGB cube.
		1544
1465	Together, all those colours implement the 88 colour xterm colours. Only	1545	Together, all those colours implement the 88 (256) colour xterm
1466	the first 16 can be changed using resources currently, the rest can only	1546	colours. Only the first 16 can be changed using resources currently, the
1467	be changed via command sequences ("escape codes").	1547	rest can only be changed via command sequences ("escape codes").
		1548
		1549	Applications are advised to use terminfo or command sequences to discover
		1550	number and RGB values of all colours (yes, you can query this...).
1468		1551
1469	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1552	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1470	always swapping the foreground/background colours. This is in contrast to	1553	always swapping the foreground/background colours. This is in contrast to
1471	I<xterm>(1) where the colours are only swapped if they have not otherwise	1554	I<xterm>(1) where the colours are only swapped if they have not otherwise
1472	been specified. For example,	1555	been specified. For example,
1473		1556
1474	=over 4
1475
1476	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1557	@@RXVT_NAME@@ -fg Black -bg White -rv
1477		1558
1478	would yield White on Black, while on I<xterm>(1) it would yield Black	1559	would yield White on Black, while on I<xterm>(1) it would yield Black on
1479	on White.	1560	White.
1480
1481	=back
1482		1561
1483	=head2 ALPHA CHANNEL SUPPORT	1562	=head2 ALPHA CHANNEL SUPPORT
1484		1563
1485	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1564	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1486	their act together, rxvt-unicode will do it's own alpha channel management:	1565	their act together, rxvt-unicode will do its own alpha channel management:
1487		1566
1488	You can prefix any color with an opaquenes percentage enclosed in	1567	You can prefix any colour with an opaqueness percentage enclosed in
1489	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1568	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490	(0-100) that specifies the opacity of the color, where C<0> is completely	1569	(0-100) that specifies the opacity of the colour, where C<0> is completely
1491	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1570	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1571	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493	is the recommended format to specify transparency values, and works with	1572	is the recommended format to specify transparency values, and works with
1494	all ways to specify a colour.	1573	all ways to specify a colour.
1495		1574
…		…
1578	=item B<RXVT_SOCKET>	1657	=item B<RXVT_SOCKET>
1579		1658
1580	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1659	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1581	@@RXVT_NAME@@d(1).	1660	@@RXVT_NAME@@d(1).
1582		1661
1583	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1584		1663
1585	=item B<HOME>	1664	=item B<HOME>
1586		1665
1587	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
1588	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1589	C<.Xdefaults>)	1668	C<.Xdefaults>)
1590		1669
1591	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1592		1671
1593	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1594		1673
1595	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1596		1675
1597	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
1598	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1603		1682
1604	=over 4	1683	=over 4
1605		1684
1606	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1607		1686
1608	Color names.	1687	Colour names.
1609		1688
1610	=back	1689	=back
1611		1690
1612	=head1 SEE ALSO	1691	=head1 SEE ALSO
1613		1692
…		…
1664		1743
1665	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1666		1745
1667	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1668		1747
1669	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1670		1749
1671	=back	1750	=back
1672		1751

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs. Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC