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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC vs.
Revision 1.211 by sf-exg, Sat Dec 31 17:17:12 2011 UTC

…		…
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
95	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
96		96
97	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
98	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
99	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<xft>: 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
		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
		109	this, so watch out]
		110
106	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
107		112
108	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
109		114
110	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
119		124
120	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>.
121		126
122	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
123		128
124	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>.
125		130
126	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
127	future versions.	132	future versions.
128
129	I<Please address all transparency related issues to Sasha Vasko at
130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
131		133
132	=item B<-fade> I<number>	134	=item B<-fade> I<number>
133		135
134	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
135	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
…		…
140	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
141	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
142		144
143	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
144		146
145	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
146	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
148	used to brighten or darken the image in addition to tinting it.
149	Please note that certain tint colours can be applied on the server-side,
150	thus yielding performance gain of two orders of magnitude. These colours are:
151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
152	pure black and pure white colors essentially mean no tinting; resource
153	I<tintColor>. Example:
154
155	@@RXVT_NAME@@ -tr -tint blue -sh 40
156		149
157	=item B<-sh> I<number>	150	=item B<-sh> I<number>
158		151
159	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
160	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
161	resource I<shading>.
162		154
163	=item B<-blt> I<string>	155	=item B<-blt> I<string>
164		156
165	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
166	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
167	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
169	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>,
170	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
171	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
172		164
173	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
174		166
175	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
176	background image. If single number is specified - both vertical and	168	background. If a single number is specified, the vertical and
177	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
178	radii to 1 and another to a large number creates interesting effects	170	radii to 1 and the other to a large number creates interesting effects
179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. The maximum radius value is 128;
180	resource I<blurRadius>.	172	resource I<blurRadius>.
181		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
182	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
183		181
184	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
185		183
186	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
187		185
188	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
189		187
190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;oplist]>
191		189
192	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
193	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
194	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
195	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
196		194
197	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
198		196
…		…
310		308
311	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
312		310
313	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
314		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
315	=item B<-iconic>	317	=item B<-iconic>
316		318
317	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
319		321
…		…
335		337
336	=item B<-bl>	338	=item B<-bl>
337		339
338	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.
339	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
340	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.
341		344
342	=item B<-override-redirect>	345	=item B<-override-redirect>
343		346
344	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	348	B<override-redirect>.
…		…
354	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
355		358
356	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
357	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
358	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>.
359		369
360	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
361		371
362	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
363	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
452	it exits. Instead, it will wait till it is being killed or closed by the	462	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	463	user; resource B<hold>.
454		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
455	=item B<-xrm> I<string>	471	=item B<-xrm> I<string>
456		472
457	Works like the X Toolkit option of the same name, by adding the I<string>	473	Works like the X Toolkit option of the same name, by adding the I<string>
458	as if it were specified in a resource file. Resource values specified this	474	as if it were specified in a resource file. Resource values specified this
459	way take precedence over all other resource specifications.	475	way take precedence over all other resource specifications.
…		…
542	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
543	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
544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
546		562
547	1. system-wide app-defaults file, either locale-dependent OR global
548	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
550	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
553		569
554	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
555	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
…		…
567	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
568		584
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	585	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	586	option B<-depth>.
571		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
572	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
573		596
574	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	598	option B<-geometry>.
576		599
…		…
589	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
590	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
592	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,
593	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
594	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		618
596	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
597	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
598		621
599	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
…		…
610	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
611		634
612	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	636	foreground colour is the default.
614		637
615	=item B<colorRV:> I<colour>
616
617	Use the specified colour as the background for reverse video characters
618	when OPTION_HC is disabled (--disable-frills).
619
620	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
621		639
622	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
623	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.
624		652
625	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
626		654
627	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
628	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
635		663
636	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
637		665
638	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		669
642	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
643		671
644	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
645	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
…		…
661	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
662	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
663		691
664	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
665		693
666	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
667		695
668	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
669	future versions.	697	future versions.
670		698
671	I<Please address all transparency related issues to Sasha Vasko at
672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
673
674	=item B<fading:> I<number>	699	=item B<fading:> I<number>
675		700
676	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>.
677		702
678	=item B<fadeColor:> I<colour>	703	=item B<fadeColor:> I<colour>
…		…
680	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
681	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
682		707
683	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
684		709
685	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
686	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>.
687		715
688	=item B<shading:> I<number>	716	=item B<shading:> I<number>
689		717
690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
691	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
692		720
693	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
694		722
695	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
696		724
697	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
698		726
699	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
700	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>.
701		733
702	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
703		735
704	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
705		737
…		…
711	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
712		744
713	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
714	and the text.	746	and the text.
715		747
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
717		749
718	Use the specified image file for the background and also	750	Use the specified image file for the background and also
719	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722	centre (percent). A scale of 0 displays the image with tiling. A scale
723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
724	an integer number of images in that direction. No image will be magnified
725	beyond 10 times its original size. The maximum permitted scale is 1000.
726	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	752	Supported operations are:
728		753
729	tile force background image to be tiled and not scaled. Equivalent to 0x0	754	=over 4
730	propscale will scale image keeping proportions	755
731	auto will scale image to match window size. Equivalent to 100x100	756	=item B<WxH+X+Y>
732	hscale will scale image horizontally to the window size	757
733	vscale will scale image vertically to the window size	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
734	scale will scale image to match window size	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
735	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.
736	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.
737		809
738	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
739	blended over transparency image using either alpha-blending, or any	811	blended over the transparent background using alpha-blending. If I<afterimage>
740	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.
741		814
742	=item B<path:> I<path>	815	=item B<path:> I<path>
743		816
744	Specify the colon-delimited search path for finding background image files.	817	Specify the colon-delimited search path for finding background image files.
745		818
…		…
772	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
773	wide and 15 pixels high.	846	wide and 15 pixels high.
774		847
775	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
776	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
777	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
778	useful supplement.	851	useful supplement.
779		852
780	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
781	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
782	contains other characters, but we are not interested in them.	855	contains other characters, but we are not interested in them.
…		…
833	=item B<urgentOnBell:> I<boolean>	906	=item B<urgentOnBell:> I<boolean>
834		907
835	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.
836	B<False>: do not set the urgency hint [default].	909	B<False>: do not set the urgency hint [default].
837		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
838	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
839		914
840	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>.
841	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
842		917
…		…
870	=item B<scrollstyle:> I<mode>	945	=item B<scrollstyle:> I<mode>
871		946
872	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
873	the author's favourite.	948	the author's favourite.
874		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
875	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
876		955
877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
879		958
…		…
898	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
899	B<+si>.	978	B<+si>.
900		979
901	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
902		981
903	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.
904	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
905	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>.
906		986
907	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
908		988
909	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
910	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
…		…
966	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
967		1047
968	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];
969	option B<-bc>.	1049	option B<-bc>.
970		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
971	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
972		1057
973	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
974	of seconds of inactivity. B<False>: the pointer is always visible	1059	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	1060	[default].
…		…
988	large number (e.g. C<987654321>) to effectively disable the timeout.	1073	large number (e.g. C<987654321>) to effectively disable the timeout.
989		1074
990	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
991		1076
992	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>
993	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>
994	(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
995	escape sequence.	1080	escape sequence.
996		1081
997	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
998		1083
…		…
1077		1162
1078	=item B<secondaryScroll:> I<boolean>	1163	=item B<secondaryScroll:> I<boolean>
1079		1164
1080	Turn on/off secondary screen scroll (default enabled). If this	1165	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1166	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1167	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1168	to/from the secondary screen will instead scroll the screen up.
1084		1169
1085	=item B<hold>: I<boolean>	1170	=item B<hold>: I<boolean>
1086		1171
1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1172	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088	will not immediately destroy its window when the program executed within	1173	will not immediately destroy its window when the program executed within
1089	it exits. Instead, it will wait till it is being killed or closed by the	1174	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1175	user.
		1176
		1177	=item B<chdir>: I<path>
		1178
		1179	Sets the working directory for the shell (or the command specified via
		1180	B<-e>). The I<path> must be an absolute path and it must exist for
		1181	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1182	directory will be used; option B<-cd>.
1091		1183
1092	=item B<keysym.>I<sym>: I<string>	1184	=item B<keysym.>I<sym>: I<string>
1093		1185
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095	intervening resource name B<keysym.> cannot be omitted.	1187	intervening resource name B<keysym.> cannot be omitted.
…		…
1110	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
1111	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
1112	performed in an exact manner; however, the closest match is assured.	1204	performed in an exact manner; however, the closest match is assured.
1113		1205
1114	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
1115	number), see RESOURCES in C<man 7 X> for futher details.	1207	number), see RESOURCES in C<man 7 X> for further details.
1116		1208
1117	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>
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1119	should be a character not used by the strings.	1212	should be a character not used by the strings.
1120		1213
1121	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1122		1215
1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1124		1217
1125	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1126		1219
1127	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: \033<a>
1128	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: \033<b>
1129	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: \033<c>
1130		1223
1131	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>
1132	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1225	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1133	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>
1134	when Control-Meta-c is being pressed":	1227	when Control-Meta-c is being pressed":
1135		1228
1136	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
1137		1230
1138	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>
1139	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)
1140	manpage. For example, the F<selection> extension (activated via	1233	manpage. For example, the F<selection> extension (activated via
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1234	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1235
1143	URxvt.keysym.M-C-c: perl:selection:rot13	1236	URxvt.keysym.M-C-c: perl:selection:rot13
1144		1237
1145	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
1146	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
1147	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
1148	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
1149	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
1150	mappings themselves.	1243	mappings themselves.
1151		1244
…		…
1202	all instances, while B<perl-ext> is used for specific instances.	1295	all instances, while B<perl-ext> is used for specific instances.
1203		1296
1204	=item B<perl-eval>: I<string>	1297	=item B<perl-eval>: I<string>
1205		1298
1206	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
1207	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1300	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1301
1210	=item B<perl-lib>: I<path>	1302	=item B<perl-lib>: I<path>
1211		1303
1212	Colon-separated list of additional directories that hold extension	1304	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1214	@@RXVT_NAME@@ will first look in these directories and then in	1306	look in these directories, then in $HOME/.urxvt/ext and lastly in
1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1308
1218	See the @@RXVT_NAME@@perl(3) manpage.	1309	See the @@RXVT_NAME@@perl(3) manpage.
1219		1310
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1312
…		…
1243		1334
1244	=item B<override-redirect>: I<boolean>	1335	=item B<override-redirect>: I<boolean>
1245		1336
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1337	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	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).
1248		1343
1249	=item B<iso14755_52:> I<boolean>	1344	=item B<iso14755_52:> I<boolean>
1250		1345
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1346	Turn on/off ISO 14755 5.2 mode (default enabled).
1252		1347
…		…
1395	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
1396	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
1397	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
1398	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.
1399		1494
1400	=head1 COLORS AND GRAPHICS	1495	=head1 COLOURS AND GRAPHICS
1401		1496
1402	In addition to the default foreground and background colours,	1497	In addition to the default foreground and background colours,
1403	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
1404	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
1405	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.
1406		1504
1407	=begin table	1505	=begin table
1408		1506
1409	B<color0> (black) = Black	1507	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1508	B<color1> (red) = Red3
…		…
1430	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>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1529	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432	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
1433	color0-color15.	1531	color0-color15.
1434		1532
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1533	The following text gives values for the standard 88 colour mode (and
1436	additional 72 colours. The first 64 of those (with indices 16 to 79)	1534	values for the 256 colour mode in parentheses).
1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1439		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
1440	Together, all those colours implement the 88 colour xterm colours. Only	1545	Together, all those colours implement the 88 (256) colour xterm
1441	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
1442	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...).
1443		1551
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1552	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1553	always swapping the foreground/background colours. This is in contrast to
1446	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
1447	been specified. For example,	1555	been specified. For example,
1448		1556
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1557	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1558
1453	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
1454	on White.	1560	White.
1455		1561
1456	=back	1562	=head2 ALPHA CHANNEL SUPPORT
1457
1458	=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS
1459		1563
1460	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
1461	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:
1462		1566
1463	You can prefix any color with an opaquenes percentage enclosed in	1567	You can prefix any colour with an opaqueness percentage enclosed in
1464	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
1465	(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
1466	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
1467	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
1468	is the recommended format to specify transparency values, and works with	1572	is the recommended format to specify transparency values, and works with
1469	all ways to specify a colour.	1573	all ways to specify a colour.
1470		1574
…		…
1541	C<--with-terminfo=PATH>.	1645	C<--with-terminfo=PATH>.
1542		1646
1543	=item B<DISPLAY>	1647	=item B<DISPLAY>
1544		1648
1545	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1649	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1546	display in its child processes.	1650	display in its child processes if C<-display> isn't used to override. It
		1651	defaults to C<:0> if it doesn't exist.
1547		1652
1548	=item B<SHELL>	1653	=item B<SHELL>
1549		1654
1550	The shell to be used for command execution, defaults to C</bin/sh>.	1655	The shell to be used for command execution, defaults to C</bin/sh>.
1551		1656
1552	=item B<RXVT_SOCKET>	1657	=item B<RXVT_SOCKET>
1553		1658
1554	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
1555	@@RXVT_NAME@@d(1).	1660	@@RXVT_NAME@@d(1).
1556		1661
1557	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1558		1663
1559	=item B<HOME>	1664	=item B<HOME>
1560		1665
1561	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
1562	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1563	C<.Xdefaults>)	1668	C<.Xdefaults>)
1564		1669
1565	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1566		1671
1567	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1568		1673
1569	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1570		1675
1571	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
1572	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1577		1682
1578	=over 4	1683	=over 4
1579		1684
1580	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1581		1686
1582	Color names.	1687	Colour names.
1583		1688
1584	=back	1689	=back
1585		1690
1586	=head1 SEE ALSO	1691	=head1 SEE ALSO
1587		1692
…		…
1638		1743
1639	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1640		1745
1641	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1642		1747
1643	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1644		1749
1645	=back	1750	=back
1646		1751

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC vs. Revision 1.211 by sf-exg, Sat Dec 31 17:17:12 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC vs.
Revision 1.211 by sf-exg, Sat Dec 31 17:17:12 2011 UTC