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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs.
Revision 1.190 by sf-exg, Thu Dec 9 10:03:56 2010 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 - both 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 another to a large number creates interesting effects
179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. 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[;geom[:op1][:op2][...]]>
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 its scaling with a geometry string. 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>
…		…
273		271
274	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
275		273
276	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
277		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
278	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
279		286
280	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
281	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
282		289
…		…
288	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
289		296
290	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
291	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
292	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
293
294	=item B<-sr>\|B<+sr>
295
296	Put scrollbar on right/left; resource B<scrollBar_right>.
297
298	=item B<-st>\|B<+st>
299
300	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301	resource B<scrollBar_floating>.
302		300
303	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
304		302
305	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
306	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
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
…		…
449		459
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>.
		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>.
454		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
…		…
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
…		…
715		747
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
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 its scaling with a geometry string B<WxH+X+Y>,
720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	753	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	754	centre (percent). A scale of 0 displays the image with tiling.
723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	755	The maximum permitted scale is 1000.
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...>.	756	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	757	Supported operations are:
728		758
729	tile force background image to be tiled and not scaled. Equivalent to 0x0,	759	tile force background image to be tiled and not scaled. Equivalent to 0x0
730	propscale will scale image keeping proportions,	760	propscale will scale image keeping proportions
731	auto will scale image to match window size. Equivalent to 100x100;	761	auto will scale image to match window size. Equivalent to 100x100
732	hscale will scale image horizontally to the window size;	762	hscale will scale image horizontally to the window size
733	vscale will scale image vertically to the window size;	763	vscale will scale image vertically to the window size
734	scale will scale image to match window size;	764	scale will scale image to match window size
735	root will tile image as if it was a root window background, auto-adjusting	765	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves.	766	whenever terminal window moves
737		767
738	If used in conjunction with B<-tr> option, the specified pixmap will be	768	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any	769	blended over the transparent background using alpha-blending. If I<afterimage>
740	other blending type, specified with B<-blt "type"> option.	770	support has been compiled in it is possible to choose other blending
		771	types with B<-blt "type"> option.
741		772
742	=item B<path:> I<path>	773	=item B<path:> I<path>
743		774
744	Specify the colon-delimited search path for finding background image files.	775	Specify the colon-delimited search path for finding background image files.
745		776
…		…
772	it is named first) and thus defines the character cell grid to be 9 pixels	803	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	804	wide and 15 pixels high.
774		805
775	The second font is just used to add additional unicode characters not in	806	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	807	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	808	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	809	useful supplement.
779		810
780	The third font is an Xft font with aliasing turned off, and the characters	811	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	812	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.	813	contains other characters, but we are not interested in them.
…		…
811	option B<-is>, the default), bold/blink font styles imply high	842	option B<-is>, the default), bold/blink font styles imply high
812	intensity foreground/background colours. Disabling this option (B<False>,	843	intensity foreground/background colours. Disabling this option (B<False>,
813	option B<+is>) disables this behaviour, the high intensity colours are not	844	option B<+is>) disables this behaviour, the high intensity colours are not
814	reachable.	845	reachable.
815		846
816	=item B<selectstyle:> I<mode>
817
818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
819	is xterm style with 2.20 old word selection, or anything else which
820	gives xterm style selection. Only effective when the original (non-perl)
821	selection code is in use.
822
823	=item B<scrollstyle:> I<mode>
824
825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826	the author's favourite.
827
828	=item B<title:> I<string>	847	=item B<title:> I<string>
829		848
830	Set window title string, the default title is the command-line	849	Set window title string, the default title is the command-line
831	specified after the B<-e> option, if any, otherwise the application	850	specified after the B<-e> option, if any, otherwise the application
832	name; option B<-title>.	851	name; option B<-title>.
…		…
845	=item B<urgentOnBell:> I<boolean>	864	=item B<urgentOnBell:> I<boolean>
846		865
847	B<True>: set the urgency hint for the wm on receipt of a bell character.	866	B<True>: set the urgency hint for the wm on receipt of a bell character.
848	B<False>: do not set the urgency hint [default].	867	B<False>: do not set the urgency hint [default].
849		868
		869	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		870
850	=item B<visualBell:> I<boolean>	871	=item B<visualBell:> I<boolean>
851		872
852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	873	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853	B<False>: no visual bell [default]; option B<+vb>.	874	B<False>: no visual bell [default]; option B<+vb>.
854		875
…		…
876		897
877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	898	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878		899
879	This creates a new file in your home directory with the screen contents	900	This creates a new file in your home directory with the screen contents
880	every time you hit C<Print>.	901	every time you hit C<Print>.
		902
		903	=item B<scrollstyle:> I<mode>
		904
		905	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		906	the author's favourite.
881		907
882	=item B<scrollBar:> I<boolean>	908	=item B<scrollBar:> I<boolean>
883		909
884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	910	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885	disable the scrollbar; option B<+sb>.	911	disable the scrollbar; option B<+sb>.
…		…
973	=item B<cursorBlink:> I<boolean>	999	=item B<cursorBlink:> I<boolean>
974		1000
975	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1001	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
976	option B<-bc>.	1002	option B<-bc>.
977		1003
		1004	=item B<cursorUnderline:> I<boolean>
		1005
		1006	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1007	option B<-uc>.
		1008
978	=item B<pointerBlank:> I<boolean>	1009	=item B<pointerBlank:> I<boolean>
979		1010
980	B<True>: blank the pointer when a key is pressed or after a set number	1011	B<True>: blank the pointer when a key is pressed or after a set number
981	of seconds of inactivity. B<False>: the pointer is always visible	1012	of seconds of inactivity. B<False>: the pointer is always visible
982	[default].	1013	[default].
…		…
995	large number (e.g. C<987654321>) to effectively disable the timeout.	1026	large number (e.g. C<987654321>) to effectively disable the timeout.
996		1027
997	=item B<backspacekey:> I<string>	1028	=item B<backspacekey:> I<string>
998		1029
999	The string to send when the backspace key is pressed. If set to B<DEC>	1030	The string to send when the backspace key is pressed. If set to B<DEC>
1000	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1031	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1001	(code 8) - which can be reversed with the appropriate DEC private mode	1032	(code 8) - which can be reversed with the appropriate DEC private mode
1002	escape sequence.	1033	escape sequence.
1003		1034
1004	=item B<deletekey:> I<string>	1035	=item B<deletekey:> I<string>
1005		1036
…		…
1084		1115
1085	=item B<secondaryScroll:> I<boolean>	1116	=item B<secondaryScroll:> I<boolean>
1086		1117
1087	Turn on/off secondary screen scroll (default enabled). If this	1118	Turn on/off secondary screen scroll (default enabled). If this
1088	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
1089	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
1090	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
1091		1122
1092	=item B<hold>: I<boolean>	1123	=item B<hold>: I<boolean>
1093		1124
1094	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1125	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095	will not immediately destroy its window when the program executed within	1126	will not immediately destroy its window when the program executed within
1096	it exits. Instead, it will wait till it is being killed or closed by the	1127	it exits. Instead, it will wait till it is being killed or closed by the
1097	user.	1128	user.
		1129
		1130	=item B<chdir>: I<path>
		1131
		1132	Sets the working directory for the shell (or the command specified via
		1133	B<-e>). The I<path> must be an absolute path and it must exist for
		1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1135	directory will be used; option B<-cd>.
1098		1136
1099	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
1100		1138
1101	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1102	intervening resource name B<keysym.> cannot be omitted.	1140	intervening resource name B<keysym.> cannot be omitted.
…		…
1117	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1118	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1119	performed in an exact manner; however, the closest match is assured.	1157	performed in an exact manner; however, the closest match is assured.
1120		1158
1121	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1122	number), see RESOURCES in C<man 7 X> for futher details.	1160	number), see RESOURCES in C<man 7 X> for further details.
1123		1161
1124	You can define a range of keysyms in one shot by providing a I<string>	1162	You can define a range of keysyms in one shot by providing a I<string>
1125	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1126	should be a character not used by the strings.	1164	should be a character not used by the strings.
1127		1165
…		…
1141	when Control-Meta-c is being pressed":	1179	when Control-Meta-c is being pressed":
1142		1180
1143	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1181	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1144		1182
1145	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1183	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1146	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1184	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1147	manpage. For example, the F<selection> extension (activated via	1185	manpage. For example, the F<selection> extension (activated via
1148	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1186	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1149		1187
1150	URxvt.keysym.M-C-c: perl:selection:rot13	1188	URxvt.keysym.M-C-c: perl:selection:rot13
1151		1189
1152	Due the the large number of modifier combinations, a defined key mapping	1190	Due the the large number of modifier combinations, a defined key mapping
1153	will match if at I<at least> the specified identifiers are being set, and	1191	will match if I<at least> the specified identifiers are being set, and
1154	no other key mappings with those and more bits are being defined. That	1192	no other key mappings with those and more bits are being defined. That
1155	means that defining a key map for C<a> will automatically provide	1193	means that defining a key map for C<a> will automatically provide
1156	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1194	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1157	mappings themselves.	1195	mappings themselves.
1158		1196
…		…
1209	all instances, while B<perl-ext> is used for specific instances.	1247	all instances, while B<perl-ext> is used for specific instances.
1210		1248
1211	=item B<perl-eval>: I<string>	1249	=item B<perl-eval>: I<string>
1212		1250
1213	Perl code to be evaluated when all extensions have been registered. See	1251	Perl code to be evaluated when all extensions have been registered. See
1214	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1252	the @@RXVT_NAME@@perl(3) manpage.
1215	will be ignored when running setuid/setgid.
1216		1253
1217	=item B<perl-lib>: I<path>	1254	=item B<perl-lib>: I<path>
1218		1255
1219	Colon-separated list of additional directories that hold extension	1256	Colon-separated list of additional directories that hold extension
1220	scripts. When looking for extensions specified by the C<perl> resource,	1257	scripts. When looking for extensions specified by the C<perl> resource,
1221	@@RXVT_NAME@@ will first look in these directories and then in	1258	@@RXVT_NAME@@ will first look in these directories and then in
1222	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1223	will be ignored when running setuid/setgid.
1224		1260
1225	See the @@RXVT_NAME@@perl(3) manpage.	1261	See the @@RXVT_NAME@@perl(3) manpage.
1226		1262
1227	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228		1264
…		…
1250		1286
1251	=item B<override-redirect>: I<boolean>	1287	=item B<override-redirect>: I<boolean>
1252		1288
1253	Compile I<frills>: Sets override-redirect for the terminal window, making	1289	Compile I<frills>: Sets override-redirect for the terminal window, making
1254	it almost invisible to window managers; option B<-override-redirect>.	1290	it almost invisible to window managers; option B<-override-redirect>.
		1291
		1292	=item B<iso14755:> I<boolean>
		1293
		1294	Turn on/off ISO 14755 (default enabled).
1255		1295
1256	=item B<iso14755_52:> I<boolean>	1296	=item B<iso14755_52:> I<boolean>
1257		1297
1258	Turn on/off ISO 14755 5.2 mode (default enabled).	1298	Turn on/off ISO 14755 5.2 mode (default enabled).
1259		1299
…		…
1402	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1442	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1403	it can be seen via the I<who(1)> command, and can accept messages. To	1443	it can be seen via the I<who(1)> command, and can accept messages. To
1404	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1444	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1405	on some systems or setgid to root or to some other group on others.	1445	on some systems or setgid to root or to some other group on others.
1406		1446
1407	=head1 COLORS AND GRAPHICS	1447	=head1 COLOURS AND GRAPHICS
1408		1448
1409	In addition to the default foreground and background colours,	1449	In addition to the default foreground and background colours,
1410	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1450	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1411	high-intensity bold/blink versions of the same). Here is a list of the	1451	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1412	colours with their names.	1452	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1453	cube plus a 8 (24) colour greyscale ramp.
		1454
		1455	Here is a list of the ANSI colours with their names.
1413		1456
1414	=begin table	1457	=begin table
1415		1458
1416	B<color0> (black) = Black	1459	B<color0> (black) = Black
1417	B<color1> (red) = Red3	1460	B<color1> (red) = Red3
…		…
1437	It is also possible to specify the colour values of B<foreground>,	1480	It is also possible to specify the colour values of B<foreground>,
1438	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1481	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1439	a number 0-15, as a convenient shorthand to reference the colour name of	1482	a number 0-15, as a convenient shorthand to reference the colour name of
1440	color0-color15.	1483	color0-color15.
1441		1484
1442	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1485	The following text gives values for the standard 88 colour mode (and
1443	additional 72 colours. The first 64 of those (with indices 16 to 79)	1486	values for the 256 colour mode in parentheses).
1444	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1445	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1446		1487
		1488	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1489
		1490	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1491	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1492
		1493	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1494	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1495	the RGB cube.
		1496
1447	Together, all those colours implement the 88 colour xterm colours. Only	1497	Together, all those colours implement the 88 (256) colour xterm
1448	the first 16 can be changed using resources currently, the rest can only	1498	colours. Only the first 16 can be changed using resources currently, the
1449	be changed via command sequences ("escape codes").	1499	rest can only be changed via command sequences ("escape codes").
		1500
		1501	Applications are advised to use terminfo or command sequences to discover
		1502	number and RGB values of all colours (yes, you can query this...).
1450		1503
1451	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1504	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1452	always swapping the foreground/background colours. This is in contrast to	1505	always swapping the foreground/background colours. This is in contrast to
1453	I<xterm>(1) where the colours are only swapped if they have not otherwise	1506	I<xterm>(1) where the colours are only swapped if they have not otherwise
1454	been specified. For example,	1507	been specified. For example,
1455		1508
1456	=over 4
1457
1458	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1509	@@RXVT_NAME@@ -fg Black -bg White -rv
1459		1510
1460	would yield White on Black, while on I<xterm>(1) it would yield Black	1511	would yield White on Black, while on I<xterm>(1) it would yield Black on
1461	on White.	1512	White.
1462
1463	=back
1464		1513
1465	=head2 ALPHA CHANNEL SUPPORT	1514	=head2 ALPHA CHANNEL SUPPORT
1466		1515
1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1516	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1517	their act together, rxvt-unicode will do it's own alpha channel management:
1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1518
1470	in addition to the ones provided by X, where the additional A component	1519	You can prefix any colour with an opaqueness percentage enclosed in
		1520	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1521	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1522	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1523	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1524	is the recommended format to specify transparency values, and works with
		1525	all ways to specify a colour.
		1526
		1527	For complete control, rxvt-unicode also supports
		1528	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1529	specifications, where the additional C<aaaa> component specifies opacity
1471	specifies opacity (alpha) values. The minimum value of C<0> is completely	1530	(alpha) values. The minimum value of C<0000> is completely transparent,
1472	transparent). You can also prefix any color with C<[percent]>, where	1531	while C<ffff> is completely opaque). The two example colours from
1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1532	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1474	the color, where C<0> is completely transparent and C<100> is completelxy	1533	C<rgba:0000/ff00/0000/f332>.
1475	opaque.
1476		1534
1477	You probably need to specify B<"-depth 32">, too, and have the luck that	1535	You probably need to specify B<"-depth 32">, too, to force a visual with
1478	your X-server uses ARGB pixel layout, as X is far from just supporting	1536	alpha channels, and have the luck that your X-server uses ARGB pixel
1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1537	layout, as X is far from just supporting ARGB visuals out of the box, and
		1538	rxvt-unicode just fudges around.
1480		1539
1481	For example, the following selects an almost completely transparent red	1540	For example, the following selects an almost completely transparent black
1482	background, and an almost opaque pink foreground:	1541	background, and an almost opaque pink foreground:
1483		1542
1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1543	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485		1544
1486	I<Please note that transparency of any kind if completely unsupported by	1545	When not using a background image, then the interpretation of the
1487	the author. Don't bug him with installation questions!>	1546	alpha channel is up to your compositing manager (most interpret it as
		1547	transparency of course).
		1548
		1549	When using a background pixmap or pseudo-transparency, then the background
		1550	colour will always behave as if it were completely transparent (so the
		1551	background image shows instead), regardless of how it was specified, while
		1552	other colours will either be transparent as specified (the background
		1553	image will show through) on servers supporting the RENDER extension, or
		1554	fully opaque on servers not supporting the RENDER EXTENSION.
		1555
		1556	Please note that due to bugs in Xft, specifying alpha values might result
		1557	in garbage being displayed when the X-server does not support the RENDER
		1558	extension.
1488		1559
1489	=head1 ENVIRONMENT	1560	=head1 ENVIRONMENT
1490		1561
1491	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1562	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492		1563
…		…
1526	C<--with-terminfo=PATH>.	1597	C<--with-terminfo=PATH>.
1527		1598
1528	=item B<DISPLAY>	1599	=item B<DISPLAY>
1529		1600
1530	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1601	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531	display in its child processes.	1602	display in its child processes if C<-display> isn't used to override. It
		1603	defaults to C<:0> if it doesn't exist.
1532		1604
1533	=item B<SHELL>	1605	=item B<SHELL>
1534		1606
1535	The shell to be used for command execution, defaults to C</bin/sh>.	1607	The shell to be used for command execution, defaults to C</bin/sh>.
1536		1608
…		…
1562		1634
1563	=over 4	1635	=over 4
1564		1636
1565	=item B</usr/lib/X11/rgb.txt>	1637	=item B</usr/lib/X11/rgb.txt>
1566		1638
1567	Color names.	1639	Colour names.
1568		1640
1569	=back	1641	=back
1570		1642
1571	=head1 SEE ALSO	1643	=head1 SEE ALSO
1572		1644

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs. Revision 1.190 by sf-exg, Thu Dec 9 10:03:56 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs.
Revision 1.190 by sf-exg, Thu Dec 9 10:03:56 2010 UTC