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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	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>
95	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
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	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;
101	resource B<depth>.	104	resource B<depth>.
102		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
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
116		124
117	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>.
118		126
119	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off illusion of a transparent window background. Obsolete form of it is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123		130
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will	132	future versions.
126	be phased out in future versions of rxvt!>
127		133
128	I<Please address all transparency related issues to Sasha Vasko at	134	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		136
131	=item B<-fade> I<number>	137	=item B<-fade> I<number>
132		138
133	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
…		…
145	transparency is enabled with B<-tr>. This only works for	151	transparency is enabled with B<-tr>. This only works for
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
147	used to brighten or darken the image in addition to tinting it.	153	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,	154	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:	155	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them. Also	156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentialy mean no tinting; resource	157	pure black and pure white colours essentially mean no tinting; resource
152	I<tintColor>. Example:	158	I<tintColor>. Example:
153		159
154	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
155		161
156	=item B<-sh> I<number>	162	=item B<-sh> I<number>
…		…
162	=item B<-blt> I<string>	168	=item B<-blt> I<string>
163		169
164	Specify background blending type. If background pixmap is specified	170	Specify background blending type. If background pixmap is specified
165	at the same time as transparency - such pixmap will be blended over	171	at the same time as transparency - such pixmap will be blended over
166	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170	alpha-blending. Compile I<afterimage>; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
171		177
172	=item B<-blr> I<HxV>	178	=item B<-blr> I<HxV>
173		179
174	Apply Gaussian Blur with the specified radii to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and	181	background image. If single number is specified - both vertical and
176	horizontal radii are considered to be the same. Setting one of the	182	horizontal radii are considered to be the same. Setting one of the
177	radii to 1 and another to a large number creates interesting effects	183	radii to 1 and another to a large number creates interesting effects
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
179	resource I<blurRadius>.	185	resource I<blurRadius>.
180		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
		192
181	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
182		194
183	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
184		196
185	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
186		198
187	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
188		200
189	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190		202
191	Compile I<afterimage>: Specify image file for the background and also	203	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
192	optionally specify its scaling with a geometry string. Note you may need to	204	optionally specify its scaling with a geometry string. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the	205	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
195		207
196	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	257	for details.
246		258
247	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
248		260
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
251	details.	263	details.
252		264
253	=item B<-name> I<name>	265	=item B<-name> I<name>
254		266
…		…
272		284
273	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
274		286
275	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
276		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
277	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
278		299
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
281		302
…		…
287	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
288		309
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
292
293	=item B<-sr>\|B<+sr>
294
295	Put scrollbar on right/left; resource B<scrollBar_right>.
296
297	=item B<-st>\|B<+st>
298
299	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300	resource B<scrollBar_floating>.
301		313
302	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
303		315
304	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
309		321
310	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
311		323
312	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
313		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
314	=item B<-iconic>	330	=item B<-iconic>
315		331
316	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
318		334
…		…
334		350
335	=item B<-bl>	351	=item B<-bl>
336		352
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
338	if honoured by the WM, the rxvt-unicode window will not have window	354	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
340		357
341	=item B<-override-redirect>	358	=item B<-override-redirect>
342		359
343	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	361	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
354		371
355	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
358		382
359	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
360		384
361	This option specifies the name of the terminal type to be set in the	385	This option specifies the name of the terminal type to be set in the
362	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
417		441
418	=item B<-tcw>	442	=item B<-tcw>
419		443
420	Change the meaning of triple-click selection with the left mouse	444	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	445	button. Only effective when the original (non-perl) selection code is
422	in-use. Instead of selecting a full line it will extend the selection the	446	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
424		448
425	=item B<-insecure>	449	=item B<-insecure>
426		450
427	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
448		472
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
451	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	476	user; resource B<hold>.
		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
		483
		484	=item B<-xrm> I<string>
		485
		486	Works like the X Toolkit option of the same name, by adding the I<string>
		487	as if it were specified in a resource file. Resource values specified this
		488	way take precedence over all other resource specifications.
		489
		490	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		491	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		492	options can be specified as long-options on the commandline, so use
		493	of B<-xrm> is mostly limited to cases where you want to specify other
		494	resources (e.g. for input methods) or for compatibility with other
		495	programs.
453		496
454	=item B<-keysym.>I<sym> I<string>	497	=item B<-keysym.>I<sym> I<string>
455		498
456	Remap a key symbol. See resource B<keysym>.	499	Remap a key symbol. See resource B<keysym>.
457		500
…		…
492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493	entries and will not tinker with pty/tty permissions - you have to do that	536	entries and will not tinker with pty/tty permissions - you have to do that
494	yourself if you want that.	537	yourself if you want that.
495		538
496	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
497	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
498		542
499	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
500	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
501		545
502	use IO::Pty;	546	use IO::Pty;
…		…
516	Comma-separated list of perl extension scripts to use (or not to use) in	560	Comma-separated list of perl extension scripts to use (or not to use) in
517	this terminal instance. See resource B<perl-ext> for details.	561	this terminal instance. See resource B<perl-ext> for details.
518		562
519	=back	563	=back
520		564
521	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
522		566
523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
525		570
526	You can set and change the resources using X11 tools like B<xrdb>. Many	571	You can set and change the resources using X11 tools like B<xrdb>. Many
527	distribution do also load settings from the B<~/.Xresources> file when X	572	distribution do also load settings from the B<~/.Xresources> file when X
528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
531	1. system-wide app-defaults file, either locale-dependent OR global	576	1. system-wide app-defaults file, either locale-dependent OR global
532	2. app-defaults file in $XAPPLRESDIR	577	2. app-defaults file in $XAPPLRESDIR
533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534	4. SCREEN_RESOURCES for the current screen	579	4. SCREEN_RESOURCES for the current screen
535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		581	6. resources specified via -xrm on the commandline
536		582
537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	584	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
539	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	585	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540	configured, while the class name B<URxvt> allows resources unique to	586	configured, while the class name B<URxvt> allows resources unique to
…		…
550	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
551		597
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	598	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	599	option B<-depth>.
554		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
555	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
556		609
557	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
558	option B<-geometry>.	611	option B<-geometry>.
559		612
…		…
572	Use the specified colour for the colour value I<n>, where 0-7	625	Use the specified colour for the colour value I<n>, where 0-7
573	corresponds to low-intensity (normal) colours and 8-15 corresponds to	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
574	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
575	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
576	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
577	names used are listed in the B<COLORS AND GRAPHICS> section.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
578		631
579	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
580	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
581		634
582	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
593	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
594		647
595	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
596	foreground colour is the default.	649	foreground colour is the default.
597		650
598	=item B<colorRV:> I<colour>
599
600	Use the specified colour as the background for reverse video characters
601	when OPTION_HC is disabled (--disable-frills).
602
603	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
604		652
605	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
606	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
607		665
608	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
609		667
610	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
611	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
618		676
619	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
620		678
621	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
622	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
624		682
625	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
626		684
627	B<True>: specify that jump scrolling should be used. When receiving lots	685	B<True>: specify that jump scrolling should be used. When receiving lots
628	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
642		700
643	B<False>: specify that everything is to be displayed, even	701	B<False>: specify that everything is to be displayed, even
644	if the refresh is too fast for the human eye to read anything (or the	702	if the refresh is too fast for the human eye to read anything (or the
645	monitor to display anything); option B<+ss>.	703	monitor to display anything); option B<+ss>.
646		704
647	=item B<inheritPixmap:> I<boolean>	705	=item B<transparent:> I<boolean>
648		706
649	B<True>: make the background inherit the parent windows' pixmap, giving	707	Turn on/off illusion of a transparent window background.
650	artificial transparency. B<False>: do not inherit the parent windows'
651	pixmap.
652		708
653	I<Please note that transparency of any kind if completely unsupported by	709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654	the author. Don't bug him with installation questions!>	710	future versions.
		711
		712	I<Please address all transparency related issues to Sasha Vasko at
		713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655		714
656	=item B<fading:> I<number>	715	=item B<fading:> I<number>
657		716
658	Fade the text by the given percentage when focus is lost; option B<-fade>.	717	Fade the text by the given percentage when focus is lost; option B<-fade>.
659		718
…		…
676		735
677	Specify background blending type; option B<-blt>.	736	Specify background blending type; option B<-blt>.
678		737
679	=item B<blurRadius:> I<number>	738	=item B<blurRadius:> I<number>
680		739
681	Apply Gaussian Blurr with the specified radius to the transparent	740	Apply gaussian blur with the specified radius to the transparent
682	background image; option B<-blr>.	741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
683		746
684	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
685		748
686	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
687		750
…		…
693	=item B<borderColor:> I<colour>	756	=item B<borderColor:> I<colour>
694		757
695	The colour of the border around the text area and between the scrollbar	758	The colour of the border around the text area and between the scrollbar
696	and the text.	759	and the text.
697		760
698	=item B<backgroundPixmap:> I<file[;geom]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699		762
700	Use the specified image file for the background and also optionally	763	Use the specified image file for the background and also
701	specify its scaling with a geometry string B<WxH+X+Y>,	764	optionally specify its scaling with a geometry string B<WxH+X+Y>,
702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
703	and B<"X" / "Y"> locate the image centre (percent).	766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
704	A scale of 0 displays the image with tiling. A scale of 1 displays the	767	centre (percent). A scale of 0 displays the image with tiling.
705	image without any scaling. A scale of 2 to 9 specifies an integer	768	The maximum permitted scale is 1000.
706	number of images in that direction. No image will be magnified beyond	769	Additional operations can be specified after colon B<:op1:op2...>.
707	10 times its original size. The maximum permitted scale is 1000.	770	Supported operations are:
708	Special string of B<"auto"> used as a geometry will cause image to be	771
709	automatically scaled to match window size.	772	tile force background image to be tiled and not scaled. Equivalent to 0x0
		773	propscale will scale image keeping proportions
		774	auto will scale image to match window size. Equivalent to 100x100
		775	hscale will scale image horizontally to the window size
		776	vscale will scale image vertically to the window size
		777	scale will scale image to match window size
		778	root will tile image as if it was a root window background, auto-adjusting
		779	whenever terminal window moves
		780
710	If used in conjunction with B<-tr> option - specified pixmap will be	781	If used in conjunction with B<-tr> option, the specified pixmap will be
711	blended over transparency image using either alpha-blending, or any	782	blended over transparency image using alpha-blending. If I<afterimage>
712	other blending type, specified with B<-blt "type"> option.	783	support has been compiled in it is possible to choose other blending
713	[default 0x0+50+50]	784	types with B<-blt "type"> option.
714		785
715	=item B<path:> I<path>	786	=item B<path:> I<path>
716		787
717	Specify the colon-delimited search path for finding background image files.	788	Specify the colon-delimited search path for finding background image files.
718		789
…		…
745	it is named first) and thus defines the character cell grid to be 9 pixels	816	it is named first) and thus defines the character cell grid to be 9 pixels
746	wide and 15 pixels high.	817	wide and 15 pixels high.
747		818
748	The second font is just used to add additional unicode characters not in	819	The second font is just used to add additional unicode characters not in
749	the base font, likewise the third, which is unfortunately non-bold, but	820	the base font, likewise the third, which is unfortunately non-bold, but
750	the bold version of the font does contain less characters, so this is a	821	the bold version of the font does contain fewer characters, so this is a
751	useful supplement.	822	useful supplement.
752		823
753	The third font is an Xft font with aliasing turned off, and the characters	824	The third font is an Xft font with aliasing turned off, and the characters
754	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	825	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
755	contains other characters, but we are not interested in them.	826	contains other characters, but we are not interested in them.
…		…
779	text font will being used for the given style.	850	text font will being used for the given style.
780		851
781	=item B<intensityStyles:> I<boolean>	852	=item B<intensityStyles:> I<boolean>
782		853
783	When font styles are not enabled, or this option is enabled (B<True>,	854	When font styles are not enabled, or this option is enabled (B<True>,
784	option B<-is>, the default), bold and italic font styles imply high	855	option B<-is>, the default), bold/blink font styles imply high
785	intensity foreground/background colours. Disabling this option (B<False>,	856	intensity foreground/background colours. Disabling this option (B<False>,
786	option B<+is>) disables this behaviour, the high intensity colours are not	857	option B<+is>) disables this behaviour, the high intensity colours are not
787	reachable.	858	reachable.
788		859
789	=item B<selectstyle:> I<mode>
790
791	Set mouse selection style to B<old> which is 2.20, B<oldword> which
792	is xterm style with 2.20 old word selection, or anything else which
793	gives xterm style selection. Only effective when the original (non-perl)
794	selection code is in use.
795
796	=item B<scrollstyle:> I<mode>
797
798	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
799	the author's favourite.
800
801	=item B<title:> I<string>	860	=item B<title:> I<string>
802		861
803	Set window title string, the default title is the command-line	862	Set window title string, the default title is the command-line
804	specified after the B<-e> option, if any, otherwise the application	863	specified after the B<-e> option, if any, otherwise the application
805	name; option B<-title>.	864	name; option B<-title>.
…		…
818	=item B<urgentOnBell:> I<boolean>	877	=item B<urgentOnBell:> I<boolean>
819		878
820	B<True>: set the urgency hint for the wm on receipt of a bell character.	879	B<True>: set the urgency hint for the wm on receipt of a bell character.
821	B<False>: do not set the urgency hint [default].	880	B<False>: do not set the urgency hint [default].
822		881
		882	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		883
823	=item B<visualBell:> I<boolean>	884	=item B<visualBell:> I<boolean>
824		885
825	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	886	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
826	B<False>: no visual bell [default]; option B<+vb>.	887	B<False>: no visual bell [default]; option B<+vb>.
827		888
…		…
849		910
850	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	911	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
851		912
852	This creates a new file in your home directory with the screen contents	913	This creates a new file in your home directory with the screen contents
853	every time you hit C<Print>.	914	every time you hit C<Print>.
		915
		916	=item B<scrollstyle:> I<mode>
		917
		918	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		919	the author's favourite.
854		920
855	=item B<scrollBar:> I<boolean>	921	=item B<scrollBar:> I<boolean>
856		922
857	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	923	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
858	disable the scrollbar; option B<+sb>.	924	disable the scrollbar; option B<+sb>.
…		…
946	=item B<cursorBlink:> I<boolean>	1012	=item B<cursorBlink:> I<boolean>
947		1013
948	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1014	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
949	option B<-bc>.	1015	option B<-bc>.
950		1016
		1017	=item B<cursorUnderline:> I<boolean>
		1018
		1019	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1020	option B<-uc>.
		1021
951	=item B<pointerBlank:> I<boolean>	1022	=item B<pointerBlank:> I<boolean>
952		1023
953	B<True>: blank the pointer when a key is pressed or after a set number	1024	B<True>: blank the pointer when a key is pressed or after a set number
954	of seconds of inactivity. B<False>: the pointer is always visible	1025	of seconds of inactivity. B<False>: the pointer is always visible
955	[default].	1026	[default].
…		…
968	large number (e.g. C<987654321>) to effectively disable the timeout.	1039	large number (e.g. C<987654321>) to effectively disable the timeout.
969		1040
970	=item B<backspacekey:> I<string>	1041	=item B<backspacekey:> I<string>
971		1042
972	The string to send when the backspace key is pressed. If set to B<DEC>	1043	The string to send when the backspace key is pressed. If set to B<DEC>
973	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1044	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
974	(code 8) - which can be reversed with the appropriate DEC private mode	1045	(code 8) - which can be reversed with the appropriate DEC private mode
975	escape sequence.	1046	escape sequence.
976		1047
977	=item B<deletekey:> I<string>	1048	=item B<deletekey:> I<string>
978		1049
…		…
991	will be created). In this mode, characters outside ISO-8859-1 can be used.	1062	will be created). In this mode, characters outside ISO-8859-1 can be used.
992		1063
993	When the selection extension is not used, only ISO-8859-1 characters can	1064	When the selection extension is not used, only ISO-8859-1 characters can
994	be used. If not specified, the built-in default is used:	1065	be used. If not specified, the built-in default is used:
995		1066
996	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1067	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
997		1068
998	=item B<preeditType:> I<style>	1069	=item B<preeditType:> I<style>
999		1070
1000	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1071	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001		1072
…		…
1057		1128
1058	=item B<secondaryScroll:> I<boolean>	1129	=item B<secondaryScroll:> I<boolean>
1059		1130
1060	Turn on/off secondary screen scroll (default enabled). If this	1131	Turn on/off secondary screen scroll (default enabled). If this
1061	option is enabled, scrolls on the secondary screen will change the	1132	option is enabled, scrolls on the secondary screen will change the
1062	scrollback buffer and switching to/from the secondary screen will	1133	scrollback buffer and, when secondaryScreen is off, switching
1063	instead scroll the screen up.	1134	to/from the secondary screen will instead scroll the screen up.
1064		1135
1065	=item B<hold>: I<boolean>	1136	=item B<hold>: I<boolean>
1066		1137
1067	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1138	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1068	will not immediately destroy its window when the program executed within	1139	will not immediately destroy its window when the program executed within
1069	it exits. Instead, it will wait till it is being killed or closed by the	1140	it exits. Instead, it will wait till it is being killed or closed by the
1070	user.	1141	user.
		1142
		1143	=item B<chdir>: I<path>
		1144
		1145	Sets the working directory for the shell (or the command specified via
		1146	B<-e>). The I<path> must be an absolute path and it must exist for
		1147	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1148	directory will be used; option B<-cd>.
1071		1149
1072	=item B<keysym.>I<sym>: I<string>	1150	=item B<keysym.>I<sym>: I<string>
1073		1151
1074	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1152	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1075	intervening resource name B<keysym.> cannot be omitted.	1153	intervening resource name B<keysym.> cannot be omitted.
…		…
1090	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1168	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1091	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1169	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1092	performed in an exact manner; however, the closest match is assured.	1170	performed in an exact manner; however, the closest match is assured.
1093		1171
1094	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1172	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1095	number), see RESOURCES in C<man 7 X> for futher details.	1173	number), see RESOURCES in C<man 7 X> for further details.
1096		1174
1097	You can define a range of keysyms in one shot by providing a I<string>	1175	You can define a range of keysyms in one shot by providing a I<string>
1098	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1176	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1099	should be a character not used by the strings.	1177	should be a character not used by the strings.
1100		1178
…		…
1114	when Control-Meta-c is being pressed":	1192	when Control-Meta-c is being pressed":
1115		1193
1116	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1194	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1117		1195
1118	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1196	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1119	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1197	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1120	manpage. For example, the F<selection> extension (activated via	1198	manpage. For example, the F<selection> extension (activated via
1121	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1199	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1122		1200
1123	URxvt.keysym.M-C-c: perl:selection:rot13	1201	URxvt.keysym.M-C-c: perl:selection:rot13
1124		1202
1125	Due the the large number of modifier combinations, a defined key mapping	1203	Due the the large number of modifier combinations, a defined key mapping
1126	will match if at I<at least> the specified identifiers are being set, and	1204	will match if I<at least> the specified identifiers are being set, and
1127	no other key mappings with those and more bits are being defined. That	1205	no other key mappings with those and more bits are being defined. That
1128	means that defining a key map for C<a> will automatically provide	1206	means that defining a key map for C<a> will automatically provide
1129	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1207	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1130	mappings themselves.	1208	mappings themselves.
1131		1209
…		…
1182	all instances, while B<perl-ext> is used for specific instances.	1260	all instances, while B<perl-ext> is used for specific instances.
1183		1261
1184	=item B<perl-eval>: I<string>	1262	=item B<perl-eval>: I<string>
1185		1263
1186	Perl code to be evaluated when all extensions have been registered. See	1264	Perl code to be evaluated when all extensions have been registered. See
1187	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1265	the @@RXVT_NAME@@perl(3) manpage.
1188	will be ignored when running setuid/setgid.
1189		1266
1190	=item B<perl-lib>: I<path>	1267	=item B<perl-lib>: I<path>
1191		1268
1192	Colon-separated list of additional directories that hold extension	1269	Colon-separated list of additional directories that hold extension
1193	scripts. When looking for extensions specified by the C<perl> resource,	1270	scripts. When looking for extensions specified by the C<perl> resource,
1194	@@RXVT_NAME@@ will first look in these directories and then in	1271	@@RXVT_NAME@@ will first look in these directories and then in
1195	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1272	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1196	will be ignored when running setuid/setgid.
1197		1273
1198	See the @@RXVT_NAME@@perl(3) manpage.	1274	See the @@RXVT_NAME@@perl(3) manpage.
1199		1275
1200	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1276	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1201		1277
…		…
1223		1299
1224	=item B<override-redirect>: I<boolean>	1300	=item B<override-redirect>: I<boolean>
1225		1301
1226	Compile I<frills>: Sets override-redirect for the terminal window, making	1302	Compile I<frills>: Sets override-redirect for the terminal window, making
1227	it almost invisible to window managers; option B<-override-redirect>.	1303	it almost invisible to window managers; option B<-override-redirect>.
		1304
		1305	=item B<iso14755:> I<boolean>
		1306
		1307	Turn on/off ISO 14755 (default enabled).
1228		1308
1229	=item B<iso14755_52:> I<boolean>	1309	=item B<iso14755_52:> I<boolean>
1230		1310
1231	Turn on/off ISO 14755 5.2 mode (default enabled).	1311	Turn on/off ISO 14755 5.2 mode (default enabled).
1232		1312
…		…
1375	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1455	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1376	it can be seen via the I<who(1)> command, and can accept messages. To	1456	it can be seen via the I<who(1)> command, and can accept messages. To
1377	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1457	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1378	on some systems or setgid to root or to some other group on others.	1458	on some systems or setgid to root or to some other group on others.
1379		1459
1380	=head1 COLORS AND GRAPHICS	1460	=head1 COLOURS AND GRAPHICS
1381		1461
1382	In addition to the default foreground and background colours,	1462	In addition to the default foreground and background colours,
1383	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1463	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1384	high-intensity bold/blink versions of the same). Here is a list of the	1464	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1385	colours with their names.	1465	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1466	cube plus a 8 (24) colour greyscale ramp.
		1467
		1468	Here is a list of the ANSI colours with their names.
1386		1469
1387	=begin table	1470	=begin table
1388		1471
1389	B<color0> (black) = Black	1472	B<color0> (black) = Black
1390	B<color1> (red) = Red3	1473	B<color1> (red) = Red3
…		…
1410	It is also possible to specify the colour values of B<foreground>,	1493	It is also possible to specify the colour values of B<foreground>,
1411	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1494	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1412	a number 0-15, as a convenient shorthand to reference the colour name of	1495	a number 0-15, as a convenient shorthand to reference the colour name of
1413	color0-color15.	1496	color0-color15.
1414		1497
1415	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1498	The following text gives values for the standard 88 colour mode (and
1416	additional 72 colours. The first 64 of those (with indices 16 to 79)	1499	values for the 256 colour mode in parentheses).
1417	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1418	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1419		1500
		1501	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1502
		1503	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1504	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1505
		1506	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1507	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1508	the RGB cube.
		1509
1420	Together, all those colours implement the 88 colour xterm colours. Only	1510	Together, all those colours implement the 88 (256) colour xterm
1421	the first 16 can be changed using resources currently, the rest can only	1511	colours. Only the first 16 can be changed using resources currently, the
1422	be changed via command sequences ("escape codes").	1512	rest can only be changed via command sequences ("escape codes").
		1513
		1514	Applications are advised to use terminfo or command sequences to discover
		1515	number and RGB values of all colours (yes, you can query this...).
1423		1516
1424	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1517	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1425	always swapping the foreground/background colours. This is in contrast to	1518	always swapping the foreground/background colours. This is in contrast to
1426	I<xterm>(1) where the colours are only swapped if they have not otherwise	1519	I<xterm>(1) where the colours are only swapped if they have not otherwise
1427	been specified. For example,	1520	been specified. For example,
1428		1521
1429	=over 4
1430
1431	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1522	@@RXVT_NAME@@ -fg Black -bg White -rv
1432		1523
1433	would yield White on Black, while on I<xterm>(1) it would yield Black	1524	would yield White on Black, while on I<xterm>(1) it would yield Black on
1434	on White.	1525	White.
1435
1436	=back
1437		1526
1438	=head2 ALPHA CHANNEL SUPPORT	1527	=head2 ALPHA CHANNEL SUPPORT
1439		1528
1440	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1529	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1441	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1530	their act together, rxvt-unicode will do it's own alpha channel management:
1442	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1531
1443	in addition to the ones provided by X, where the additional A component	1532	You can prefix any colour with an opaqueness percentage enclosed in
		1533	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1534	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1535	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1536	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1537	is the recommended format to specify transparency values, and works with
		1538	all ways to specify a colour.
		1539
		1540	For complete control, rxvt-unicode also supports
		1541	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1542	specifications, where the additional C<aaaa> component specifies opacity
1444	specifies opacity (alpha) values. The minimum value of C<0> is completely	1543	(alpha) values. The minimum value of C<0000> is completely transparent,
1445	transparent). You can also prefix any color with C<[percent]>, where	1544	while C<ffff> is completely opaque). The two example colours from
1446	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1545	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1447	the color, where C<0> is completely transparent and C<100> is completelxy	1546	C<rgba:0000/ff00/0000/f332>.
1448	opaque.
1449		1547
1450	You probably need to specify B<"-depth 32">, too, and have the luck that	1548	You probably need to specify B<"-depth 32">, too, to force a visual with
1451	your X-server uses ARGB pixel layout, as X is far from just supporting	1549	alpha channels, and have the luck that your X-server uses ARGB pixel
1452	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1550	layout, as X is far from just supporting ARGB visuals out of the box, and
		1551	rxvt-unicode just fudges around.
1453		1552
1454	For example, the following selects an almost completely transparent red	1553	For example, the following selects an almost completely transparent black
1455	background, and an almost opaque pink foreground:	1554	background, and an almost opaque pink foreground:
1456		1555
1457	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1556	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1458		1557
1459	I<Please note that transparency of any kind if completely unsupported by	1558	When not using a background image, then the interpretation of the
1460	the author. Don't bug him with installation questions!>	1559	alpha channel is up to your compositing manager (most interpret it as
		1560	transparency of course).
		1561
		1562	When using a background pixmap or pseudo-transparency, then the background
		1563	colour will always behave as if it were completely transparent (so the
		1564	background image shows instead), regardless of how it was specified, while
		1565	other colours will either be transparent as specified (the background
		1566	image will show through) on servers supporting the RENDER extension, or
		1567	fully opaque on servers not supporting the RENDER EXTENSION.
		1568
		1569	Please note that due to bugs in Xft, specifying alpha values might result
		1570	in garbage being displayed when the X-server does not support the RENDER
		1571	extension.
1461		1572
1462	=head1 ENVIRONMENT	1573	=head1 ENVIRONMENT
1463		1574
1464	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1575	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1465		1576
…		…
1471	resources or on the command line.	1582	resources or on the command line.
1472		1583
1473	=item B<COLORTERM>	1584	=item B<COLORTERM>
1474		1585
1475	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1586	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1476	compiled with background image support, and optionally with the added	1587	compiled with background image support, and optionally with the added
1477	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1588	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478	screen.	1589	screen.
1479		1590
1480	=item B<COLORFGBG>	1591	=item B<COLORFGBG>
1481		1592
1482	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1593	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1483	the colour code used as default foreground/text colour (or the string	1594	the colour code used as default foreground/text colour (or the string
1484	C<default> to indicate that the default-colour escape sequence is to be	1595	C<default> to indicate that the default-colour escape sequence is to be
1485	used), C<bg> is the colour code used as default background colour (or the	1596	used), C<bg> is the colour code used as default background colour (or the
1486	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1597	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1487	was compiled with background image support. Libraries like C<ncurses>	1598	was compiled with background image support. Libraries like C<ncurses>
1488	and C<slang> can (and do) use this information to optimize screen output.	1599	and C<slang> can (and do) use this information to optimize screen output.
1489		1600
1490	=item B<WINDOWID>	1601	=item B<WINDOWID>
1491		1602
1492	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1603	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1499	C<--with-terminfo=PATH>.	1610	C<--with-terminfo=PATH>.
1500		1611
1501	=item B<DISPLAY>	1612	=item B<DISPLAY>
1502		1613
1503	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1614	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1504	display in its child processes.	1615	display in its child processes if C<-display> isn't used to override. It
		1616	defaults to C<:0> if it doesn't exist.
1505		1617
1506	=item B<SHELL>	1618	=item B<SHELL>
1507		1619
1508	The shell to be used for command execution, defaults to C</bin/sh>.	1620	The shell to be used for command execution, defaults to C</bin/sh>.
1509		1621
…		…
1535		1647
1536	=over 4	1648	=over 4
1537		1649
1538	=item B</usr/lib/X11/rgb.txt>	1650	=item B</usr/lib/X11/rgb.txt>
1539		1651
1540	Color names.	1652	Colour names.
1541		1653
1542	=back	1654	=back
1543		1655
1544	=head1 SEE ALSO	1656	=head1 SEE ALSO
1545		1657
…		…
1584	Project Coordinator (changes.txt 2.21a to 2.4.5)	1696	Project Coordinator (changes.txt 2.21a to 2.4.5)
1585		1697
1586	=item Geoff Wing L<< <gcw@pobox.com> >>	1698	=item Geoff Wing L<< <gcw@pobox.com> >>
1587		1699
1588	Rewrote screen display and text selection routines.	1700	Rewrote screen display and text selection routines.
1589		1701
1590	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1702	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1591		1703
1592	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1704	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1593		1705
1594	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1706	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs. Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC