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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 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
128	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		133
131	=item B<-fade> I<number>	134	=item B<-fade> I<number>
132		135
133	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
134	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
…		…
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be	149	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.	150	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,	151	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:	152	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	153	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentially mean no tinting; resource	154	pure black and pure white colours essentially mean no tinting; resource
152	I<tintColor>. Example:	155	I<tintColor>. Example:
153		156
154	@@RXVT_NAME@@ -tr -tint blue -sh 40	157	@@RXVT_NAME@@ -tr -tint blue -sh 40
155		158
156	=item B<-sh> I<number>	159	=item B<-sh> I<number>
…		…
162	=item B<-blt> I<string>	165	=item B<-blt> I<string>
163		166
164	Specify background blending type. If background pixmap is specified	167	Specify background blending type. If background pixmap is specified
165	at the same time as transparency - such pixmap will be blended over	168	at the same time as transparency - such pixmap will be blended over
166	transparency image, using method specified. Supported values are :	169	transparency image, using method specified. Supported values are :
167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	171	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	172	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170	alpha-blending. Compile I<afterimage>; resource I<blendType>.	173	alpha-blending. Compile I<afterimage>; resource I<blendType>.
171		174
172	=item B<-blr> I<HxV>	175	=item B<-blr> I<HxV>
173		176
174	Apply Gaussian Blur with the specified radii to the transparent	177	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and	178	background image. If single number is specified - both vertical and
176	horizontal radii are considered to be the same. Setting one of the	179	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	180	radii to 1 and another to a large number creates interesting effects
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
179	resource I<blurRadius>.	182	resource I<blurRadius>.
180		183
		184	=item B<-icon> I<file>
		185
		186	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		187	is used by many window managers, taskbars and pagers to represent the
		188	application window; resource I<iconFile>.
		189
181	=item B<-bg> I<colour>	190	=item B<-bg> I<colour>
182		191
183	Window background colour; resource B<background>.	192	Window background colour; resource B<background>.
184		193
185	=item B<-fg> I<colour>	194	=item B<-fg> I<colour>
186		195
187	Window foreground colour; resource B<foreground>.	196	Window foreground colour; resource B<foreground>.
188		197
189	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190		199
191	Compile I<afterimage>: Specify image file for the background and also	200	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	201	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	202	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.	203	command-line; for more details see resource B<backgroundPixmap>.
195		204
196	=item B<-cr> I<colour>	205	=item B<-cr> I<colour>
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	253	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	254	for details.
246		255
247	=item B<-is>\|B<+is>	256	=item B<-is>\|B<+is>
248		257
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	258	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	259	foreground/background (default). See resource B<intensityStyles> for
251	details.	260	details.
252		261
253	=item B<-name> I<name>	262	=item B<-name> I<name>
254		263
…		…
272		281
273	=item B<-sb>\|B<+sb>	282	=item B<-sb>\|B<+sb>
274		283
275	Turn on/off scrollbar; resource B<scrollBar>.	284	Turn on/off scrollbar; resource B<scrollBar>.
276		285
		286	=item B<-sr>\|B<+sr>
		287
		288	Put scrollbar on right/left; resource B<scrollBar_right>.
		289
		290	=item B<-st>\|B<+st>
		291
		292	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		293	resource B<scrollBar_floating>.
		294
277	=item B<-si>\|B<+si>	295	=item B<-si>\|B<+si>
278		296
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	297	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	298	B<scrollTtyOutput> has opposite effect.
281		299
…		…
287	=item B<-sw>\|B<+sw>	305	=item B<-sw>\|B<+sw>
288		306
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	307	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	308	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	309	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		310
302	=item B<-ptab>\|B<+ptab>	311	=item B<-ptab>\|B<+ptab>
303		312
304	If enabled (default), "Horizontal Tab" characters are being stored as	313	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	314	actual wide characters in the screen buffer, which makes it possible to
…		…
309		318
310	=item B<-bc>\|B<+bc>	319	=item B<-bc>\|B<+bc>
311		320
312	Blink the cursor; resource B<cursorBlink>.	321	Blink the cursor; resource B<cursorBlink>.
313		322
		323	=item B<-uc>\|B<+uc>
		324
		325	Make the cursor underlined; resource B<cursorUnderline>.
		326
314	=item B<-iconic>	327	=item B<-iconic>
315		328
316	Start iconified, if the window manager supports that option.	329	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	330	Alternative form is B<-ic>.
318		331
…		…
334		347
335	=item B<-bl>	348	=item B<-bl>
336		349
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	350	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	351	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	352	decorations; resource B<borderLess>. If the window manager does not
		353	support MWM hints (e.g. kwin), enables override-redirect mode.
340		354
341	=item B<-override-redirect>	355	=item B<-override-redirect>
342		356
343	Compile I<frills>: Sets override-redirect on the window; resource	357	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	358	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	367	=item B<-lsp> I<number>
354		368
355	Compile I<frills>: Lines (pixel height) to insert between each row of	369	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	370	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	371	B<lineSpace>.
		372
		373	=item B<-letsp> I<number>
		374
		375	Compile I<frills>: Amount to adjust the computed character width by
		376	to control overall letter spacing. Negative values will tighten up the
		377	letter spacing, positive values will space letters out more. Useful to
		378	work around odd font metrics; resource B<letterSpace>.
358		379
359	=item B<-tn> I<termname>	380	=item B<-tn> I<termname>
360		381
361	This option specifies the name of the terminal type to be set in the	382	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	383	B<TERM> environment variable. This terminal type must exist in the
…		…
417		438
418	=item B<-tcw>	439	=item B<-tcw>
419		440
420	Change the meaning of triple-click selection with the left mouse	441	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	442	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	443	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	444	the end of the logical line only. resource B<tripleclickwords>.
424		445
425	=item B<-insecure>	446	=item B<-insecure>
426		447
427	Enable "insecure" mode, which currently enables most of the escape	448	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	449	sequences that echo strings. See the resource B<insecure> for more
…		…
448		469
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	470	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	471	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	472	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	473	user; resource B<hold>.
		474
		475	=item B<-cd> I<path>
		476
		477	Sets the working directory for the shell (or the command specified via
		478	B<-e>). The I<path> must be an absolute path and it must exist for
		479	@@RXVT_NAME@@ to start; resource B<chdir>.
		480
		481	=item B<-xrm> I<string>
		482
		483	Works like the X Toolkit option of the same name, by adding the I<string>
		484	as if it were specified in a resource file. Resource values specified this
		485	way take precedence over all other resource specifications.
		486
		487	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		488	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		489	options can be specified as long-options on the commandline, so use
		490	of B<-xrm> is mostly limited to cases where you want to specify other
		491	resources (e.g. for input methods) or for compatibility with other
		492	programs.
453		493
454	=item B<-keysym.>I<sym> I<string>	494	=item B<-keysym.>I<sym> I<string>
455		495
456	Remap a key symbol. See resource B<keysym>.	496	Remap a key symbol. See resource B<keysym>.
457		497
…		…
492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	532	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	533	entries and will not tinker with pty/tty permissions - you have to do that
494	yourself if you want that.	534	yourself if you want that.
495		535
496	As an extremely special case, specifying C<-1> will completely suppress	536	As an extremely special case, specifying C<-1> will completely suppress
497	pty/tty operations.	537	pty/tty operations, which is probably only useful in conjunction with some
		538	perl extension that manages the terminal.
498		539
499	Here is a example in perl that illustrates how this option can be used (a	540	Here is a example in perl that illustrates how this option can be used (a
500	longer example is in F<doc/pty-fd>):	541	longer example is in F<doc/pty-fd>):
501		542
502	use IO::Pty;	543	use IO::Pty;
…		…
516	Comma-separated list of perl extension scripts to use (or not to use) in	557	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.	558	this terminal instance. See resource B<perl-ext> for details.
518		559
519	=back	560	=back
520		561
521	=head1 RESOURCES (available also as long-options)	562	=head1 RESOURCES
522		563
523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	564	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524	options) compiled into your version.	565	options) compiled into your version. All resources are also available as
		566	long-options.
525		567
526	You can set and change the resources using X11 tools like B<xrdb>. Many	568	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	569	distribution do also load settings from the B<~/.Xresources> file when X
528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529	with later settings overwriting earlier ones:	571	with later settings overwriting earlier ones:
…		…
531	1. system-wide app-defaults file, either locale-dependent OR global	573	1. system-wide app-defaults file, either locale-dependent OR global
532	2. app-defaults file in $XAPPLRESDIR	574	2. app-defaults file in $XAPPLRESDIR
533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	575	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534	4. SCREEN_RESOURCES for the current screen	576	4. SCREEN_RESOURCES for the current screen
535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		578	6. resources specified via -xrm on the commandline
536		579
537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	580	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	581	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	582	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	583	configured, while the class name B<URxvt> allows resources unique to
…		…
550	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
551		594
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	596	option B<-depth>.
554		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
		604
555	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
556		606
557	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
558	option B<-geometry>.	608	option B<-geometry>.
559		609
…		…
572	Use the specified colour for the colour value I<n>, where 0-7	622	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	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
574	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
575	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	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	626	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.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
578		628
579	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
580	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
581		631
582	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
593	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
594		644
595	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
596	foreground colour is the default.	646	foreground colour is the default.
597		647
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>	648	=item B<underlineColor:> I<colour>
604		649
605	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
606	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
607		662
608	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
609		664
610	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
611	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
618		673
619	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
620		675
621	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
622	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
624		679
625	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
626		681
627	B<True>: specify that jump scrolling should be used. When receiving lots	682	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	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
642		697
643	B<False>: specify that everything is to be displayed, even	698	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	699	if the refresh is too fast for the human eye to read anything (or the
645	monitor to display anything); option B<+ss>.	700	monitor to display anything); option B<+ss>.
646		701
647	=item B<inheritPixmap:> I<boolean>	702	=item B<transparent:> I<boolean>
648		703
649	B<True>: make the background inherit the parent windows' pixmap, giving	704	Turn on/off illusion of a transparent window background.
650	artificial transparency. B<False>: do not inherit the parent windows'
651	pixmap.
652		705
653	I<Please note that transparency of any kind if completely unsupported by	706	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654	the author. Don't bug him with installation questions!>	707	future versions.
655		708
656	=item B<fading:> I<number>	709	=item B<fading:> I<number>
657		710
658	Fade the text by the given percentage when focus is lost; option B<-fade>.	711	Fade the text by the given percentage when focus is lost; option B<-fade>.
659		712
…		…
676		729
677	Specify background blending type; option B<-blt>.	730	Specify background blending type; option B<-blt>.
678		731
679	=item B<blurRadius:> I<number>	732	=item B<blurRadius:> I<number>
680		733
681	Apply Gaussian Blurr with the specified radius to the transparent	734	Apply gaussian blur with the specified radius to the transparent
682	background image; option B<-blr>.	735	background image; option B<-blr>.
		736
		737	=item B<iconFile:> I<file>
		738
		739	Set the application icon pixmap; option B<-icon>.
683		740
684	=item B<scrollColor:> I<colour>	741	=item B<scrollColor:> I<colour>
685		742
686	Use the specified colour for the scrollbar [default #B2B2B2].	743	Use the specified colour for the scrollbar [default #B2B2B2].
687		744
…		…
695	The colour of the border around the text area and between the scrollbar	752	The colour of the border around the text area and between the scrollbar
696	and the text.	753	and the text.
697		754
698	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699		756
700	Use the specified image file for the background and also optionally	757	Use the specified image file for the background and also
701	specify its scaling with a geometry string B<WxH+X+Y>,	758	optionally specify its scaling with a geometry string B<WxH+X+Y>,
702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	759	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
703	and B<"X" / "Y"> locate the image centre (percent).	760	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	761	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	762	The maximum permitted scale is 1000.
706	number of images in that direction. No image will be magnified beyond
707	10 times its original size. The maximum permitted scale is 1000.
708	Additional operations can be specified after colon B<:op1:op2...>.	763	Additional operations can be specified after colon B<:op1:op2...>.
709	Supported operations are:	764	Supported operations are:
		765
710	B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,	766	tile force background image to be tiled and not scaled. Equivalent to 0x0
711	B<"propscale"> - will scale image keeping proportions,	767	propscale will scale image keeping proportions
712	B<"auto"> - will scale image to match window size. Equivalent to 100x100;	768	auto will scale image to match window size. Equivalent to 100x100
713	B<"hscale"> - will scale image horizontally to the window size;	769	hscale will scale image horizontally to the window size
714	B<"vscale"> - will scale image vertically to the window size;	770	vscale will scale image vertically to the window size
715	B<"scale"> - will scale image to match window size;	771	scale will scale image to match window size
716	B<"root"> - will tile image as if it was a root window background, auto-adjusting	772	root will tile image as if it was a root window background, auto-adjusting
717	whenever terminal window moves.	773	whenever terminal window moves
718		774
719	If used in conjunction with B<-tr> option - specified pixmap will be	775	If used in conjunction with B<-tr> option, the specified pixmap will be
720	blended over transparency image using either alpha-blending, or any	776	blended over transparency image using alpha-blending. If I<afterimage>
721	other blending type, specified with B<-blt "type"> option.	777	support has been compiled in it is possible to choose other blending
722	[default 0x0+50+50]	778	types with B<-blt "type"> option.
723		779
724	=item B<path:> I<path>	780	=item B<path:> I<path>
725		781
726	Specify the colon-delimited search path for finding background image files.	782	Specify the colon-delimited search path for finding background image files.
727		783
…		…
754	it is named first) and thus defines the character cell grid to be 9 pixels	810	it is named first) and thus defines the character cell grid to be 9 pixels
755	wide and 15 pixels high.	811	wide and 15 pixels high.
756		812
757	The second font is just used to add additional unicode characters not in	813	The second font is just used to add additional unicode characters not in
758	the base font, likewise the third, which is unfortunately non-bold, but	814	the base font, likewise the third, which is unfortunately non-bold, but
759	the bold version of the font does contain less characters, so this is a	815	the bold version of the font does contain fewer characters, so this is a
760	useful supplement.	816	useful supplement.
761		817
762	The third font is an Xft font with aliasing turned off, and the characters	818	The third font is an Xft font with aliasing turned off, and the characters
763	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	819	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
764	contains other characters, but we are not interested in them.	820	contains other characters, but we are not interested in them.
…		…
788	text font will being used for the given style.	844	text font will being used for the given style.
789		845
790	=item B<intensityStyles:> I<boolean>	846	=item B<intensityStyles:> I<boolean>
791		847
792	When font styles are not enabled, or this option is enabled (B<True>,	848	When font styles are not enabled, or this option is enabled (B<True>,
793	option B<-is>, the default), bold and italic font styles imply high	849	option B<-is>, the default), bold/blink font styles imply high
794	intensity foreground/background colours. Disabling this option (B<False>,	850	intensity foreground/background colours. Disabling this option (B<False>,
795	option B<+is>) disables this behaviour, the high intensity colours are not	851	option B<+is>) disables this behaviour, the high intensity colours are not
796	reachable.	852	reachable.
797		853
798	=item B<selectstyle:> I<mode>
799
800	Set mouse selection style to B<old> which is 2.20, B<oldword> which
801	is xterm style with 2.20 old word selection, or anything else which
802	gives xterm style selection. Only effective when the original (non-perl)
803	selection code is in use.
804
805	=item B<scrollstyle:> I<mode>
806
807	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
808	the author's favourite.
809
810	=item B<title:> I<string>	854	=item B<title:> I<string>
811		855
812	Set window title string, the default title is the command-line	856	Set window title string, the default title is the command-line
813	specified after the B<-e> option, if any, otherwise the application	857	specified after the B<-e> option, if any, otherwise the application
814	name; option B<-title>.	858	name; option B<-title>.
…		…
827	=item B<urgentOnBell:> I<boolean>	871	=item B<urgentOnBell:> I<boolean>
828		872
829	B<True>: set the urgency hint for the wm on receipt of a bell character.	873	B<True>: set the urgency hint for the wm on receipt of a bell character.
830	B<False>: do not set the urgency hint [default].	874	B<False>: do not set the urgency hint [default].
831		875
		876	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		877
832	=item B<visualBell:> I<boolean>	878	=item B<visualBell:> I<boolean>
833		879
834	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	880	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
835	B<False>: no visual bell [default]; option B<+vb>.	881	B<False>: no visual bell [default]; option B<+vb>.
836		882
…		…
858		904
859	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	905	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
860		906
861	This creates a new file in your home directory with the screen contents	907	This creates a new file in your home directory with the screen contents
862	every time you hit C<Print>.	908	every time you hit C<Print>.
		909
		910	=item B<scrollstyle:> I<mode>
		911
		912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		913	the author's favourite.
863		914
864	=item B<scrollBar:> I<boolean>	915	=item B<scrollBar:> I<boolean>
865		916
866	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
867	disable the scrollbar; option B<+sb>.	918	disable the scrollbar; option B<+sb>.
…		…
955	=item B<cursorBlink:> I<boolean>	1006	=item B<cursorBlink:> I<boolean>
956		1007
957	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1008	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
958	option B<-bc>.	1009	option B<-bc>.
959		1010
		1011	=item B<cursorUnderline:> I<boolean>
		1012
		1013	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1014	option B<-uc>.
		1015
960	=item B<pointerBlank:> I<boolean>	1016	=item B<pointerBlank:> I<boolean>
961		1017
962	B<True>: blank the pointer when a key is pressed or after a set number	1018	B<True>: blank the pointer when a key is pressed or after a set number
963	of seconds of inactivity. B<False>: the pointer is always visible	1019	of seconds of inactivity. B<False>: the pointer is always visible
964	[default].	1020	[default].
…		…
977	large number (e.g. C<987654321>) to effectively disable the timeout.	1033	large number (e.g. C<987654321>) to effectively disable the timeout.
978		1034
979	=item B<backspacekey:> I<string>	1035	=item B<backspacekey:> I<string>
980		1036
981	The string to send when the backspace key is pressed. If set to B<DEC>	1037	The string to send when the backspace key is pressed. If set to B<DEC>
982	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1038	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
983	(code 8) - which can be reversed with the appropriate DEC private mode	1039	(code 8) - which can be reversed with the appropriate DEC private mode
984	escape sequence.	1040	escape sequence.
985		1041
986	=item B<deletekey:> I<string>	1042	=item B<deletekey:> I<string>
987		1043
…		…
1000	will be created). In this mode, characters outside ISO-8859-1 can be used.	1056	will be created). In this mode, characters outside ISO-8859-1 can be used.
1001		1057
1002	When the selection extension is not used, only ISO-8859-1 characters can	1058	When the selection extension is not used, only ISO-8859-1 characters can
1003	be used. If not specified, the built-in default is used:	1059	be used. If not specified, the built-in default is used:
1004		1060
1005	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1061	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1006		1062
1007	=item B<preeditType:> I<style>	1063	=item B<preeditType:> I<style>
1008		1064
1009	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1065	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1010		1066
…		…
1066		1122
1067	=item B<secondaryScroll:> I<boolean>	1123	=item B<secondaryScroll:> I<boolean>
1068		1124
1069	Turn on/off secondary screen scroll (default enabled). If this	1125	Turn on/off secondary screen scroll (default enabled). If this
1070	option is enabled, scrolls on the secondary screen will change the	1126	option is enabled, scrolls on the secondary screen will change the
1071	scrollback buffer and switching to/from the secondary screen will	1127	scrollback buffer and, when secondaryScreen is off, switching
1072	instead scroll the screen up.	1128	to/from the secondary screen will instead scroll the screen up.
1073		1129
1074	=item B<hold>: I<boolean>	1130	=item B<hold>: I<boolean>
1075		1131
1076	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1132	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1077	will not immediately destroy its window when the program executed within	1133	will not immediately destroy its window when the program executed within
1078	it exits. Instead, it will wait till it is being killed or closed by the	1134	it exits. Instead, it will wait till it is being killed or closed by the
1079	user.	1135	user.
		1136
		1137	=item B<chdir>: I<path>
		1138
		1139	Sets the working directory for the shell (or the command specified via
		1140	B<-e>). The I<path> must be an absolute path and it must exist for
		1141	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1142	directory will be used; option B<-cd>.
1080		1143
1081	=item B<keysym.>I<sym>: I<string>	1144	=item B<keysym.>I<sym>: I<string>
1082		1145
1083	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1146	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1084	intervening resource name B<keysym.> cannot be omitted.	1147	intervening resource name B<keysym.> cannot be omitted.
…		…
1099	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1162	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1100	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1163	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1101	performed in an exact manner; however, the closest match is assured.	1164	performed in an exact manner; however, the closest match is assured.
1102		1165
1103	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1166	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1104	number), see RESOURCES in C<man 7 X> for futher details.	1167	number), see RESOURCES in C<man 7 X> for further details.
1105		1168
1106	You can define a range of keysyms in one shot by providing a I<string>	1169	You can define a range of keysyms in one shot by providing a I<string>
1107	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1108	should be a character not used by the strings.	1171	should be a character not used by the strings.
1109		1172
…		…
1123	when Control-Meta-c is being pressed":	1186	when Control-Meta-c is being pressed":
1124		1187
1125	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1188	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1126		1189
1127	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1190	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1128	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1191	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1129	manpage. For example, the F<selection> extension (activated via	1192	manpage. For example, the F<selection> extension (activated via
1130	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1193	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1131		1194
1132	URxvt.keysym.M-C-c: perl:selection:rot13	1195	URxvt.keysym.M-C-c: perl:selection:rot13
1133		1196
1134	Due the the large number of modifier combinations, a defined key mapping	1197	Due the the large number of modifier combinations, a defined key mapping
1135	will match if at I<at least> the specified identifiers are being set, and	1198	will match if I<at least> the specified identifiers are being set, and
1136	no other key mappings with those and more bits are being defined. That	1199	no other key mappings with those and more bits are being defined. That
1137	means that defining a key map for C<a> will automatically provide	1200	means that defining a key map for C<a> will automatically provide
1138	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1201	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1139	mappings themselves.	1202	mappings themselves.
1140		1203
…		…
1191	all instances, while B<perl-ext> is used for specific instances.	1254	all instances, while B<perl-ext> is used for specific instances.
1192		1255
1193	=item B<perl-eval>: I<string>	1256	=item B<perl-eval>: I<string>
1194		1257
1195	Perl code to be evaluated when all extensions have been registered. See	1258	Perl code to be evaluated when all extensions have been registered. See
1196	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1259	the @@RXVT_NAME@@perl(3) manpage.
1197	will be ignored when running setuid/setgid.
1198		1260
1199	=item B<perl-lib>: I<path>	1261	=item B<perl-lib>: I<path>
1200		1262
1201	Colon-separated list of additional directories that hold extension	1263	Colon-separated list of additional directories that hold extension
1202	scripts. When looking for extensions specified by the C<perl> resource,	1264	scripts. When looking for extensions specified by the C<perl> resource,
1203	@@RXVT_NAME@@ will first look in these directories and then in	1265	@@RXVT_NAME@@ will first look in these directories and then in
1204	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1205	will be ignored when running setuid/setgid.
1206		1267
1207	See the @@RXVT_NAME@@perl(3) manpage.	1268	See the @@RXVT_NAME@@perl(3) manpage.
1208		1269
1209	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1210		1271
…		…
1232		1293
1233	=item B<override-redirect>: I<boolean>	1294	=item B<override-redirect>: I<boolean>
1234		1295
1235	Compile I<frills>: Sets override-redirect for the terminal window, making	1296	Compile I<frills>: Sets override-redirect for the terminal window, making
1236	it almost invisible to window managers; option B<-override-redirect>.	1297	it almost invisible to window managers; option B<-override-redirect>.
		1298
		1299	=item B<iso14755:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 (default enabled).
1237		1302
1238	=item B<iso14755_52:> I<boolean>	1303	=item B<iso14755_52:> I<boolean>
1239		1304
1240	Turn on/off ISO 14755 5.2 mode (default enabled).	1305	Turn on/off ISO 14755 5.2 mode (default enabled).
1241		1306
…		…
1384	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1449	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1385	it can be seen via the I<who(1)> command, and can accept messages. To	1450	it can be seen via the I<who(1)> command, and can accept messages. To
1386	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1451	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1387	on some systems or setgid to root or to some other group on others.	1452	on some systems or setgid to root or to some other group on others.
1388		1453
1389	=head1 COLORS AND GRAPHICS	1454	=head1 COLOURS AND GRAPHICS
1390		1455
1391	In addition to the default foreground and background colours,	1456	In addition to the default foreground and background colours,
1392	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1457	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1393	high-intensity bold/blink versions of the same). Here is a list of the	1458	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1394	colours with their names.	1459	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1460	cube plus a 8 (24) colour greyscale ramp.
		1461
		1462	Here is a list of the ANSI colours with their names.
1395		1463
1396	=begin table	1464	=begin table
1397		1465
1398	B<color0> (black) = Black	1466	B<color0> (black) = Black
1399	B<color1> (red) = Red3	1467	B<color1> (red) = Red3
…		…
1419	It is also possible to specify the colour values of B<foreground>,	1487	It is also possible to specify the colour values of B<foreground>,
1420	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1488	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1421	a number 0-15, as a convenient shorthand to reference the colour name of	1489	a number 0-15, as a convenient shorthand to reference the colour name of
1422	color0-color15.	1490	color0-color15.
1423		1491
1424	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1492	The following text gives values for the standard 88 colour mode (and
1425	additional 72 colours. The first 64 of those (with indices 16 to 79)	1493	values for the 256 colour mode in parentheses).
1426	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1427	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1428		1494
		1495	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1496
		1497	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1498	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1499
		1500	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1501	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1502	the RGB cube.
		1503
1429	Together, all those colours implement the 88 colour xterm colours. Only	1504	Together, all those colours implement the 88 (256) colour xterm
1430	the first 16 can be changed using resources currently, the rest can only	1505	colours. Only the first 16 can be changed using resources currently, the
1431	be changed via command sequences ("escape codes").	1506	rest can only be changed via command sequences ("escape codes").
		1507
		1508	Applications are advised to use terminfo or command sequences to discover
		1509	number and RGB values of all colours (yes, you can query this...).
1432		1510
1433	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1511	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1434	always swapping the foreground/background colours. This is in contrast to	1512	always swapping the foreground/background colours. This is in contrast to
1435	I<xterm>(1) where the colours are only swapped if they have not otherwise	1513	I<xterm>(1) where the colours are only swapped if they have not otherwise
1436	been specified. For example,	1514	been specified. For example,
1437		1515
1438	=over 4
1439
1440	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1516	@@RXVT_NAME@@ -fg Black -bg White -rv
1441		1517
1442	would yield White on Black, while on I<xterm>(1) it would yield Black	1518	would yield White on Black, while on I<xterm>(1) it would yield Black on
1443	on White.	1519	White.
1444
1445	=back
1446		1520
1447	=head2 ALPHA CHANNEL SUPPORT	1521	=head2 ALPHA CHANNEL SUPPORT
1448		1522
1449	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1523	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1524	their act together, rxvt-unicode will do it's own alpha channel management:
1451	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1525
1452	in addition to the ones provided by X, where the additional A component	1526	You can prefix any colour with an opaqueness percentage enclosed in
		1527	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1528	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1529	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1530	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1531	is the recommended format to specify transparency values, and works with
		1532	all ways to specify a colour.
		1533
		1534	For complete control, rxvt-unicode also supports
		1535	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1536	specifications, where the additional C<aaaa> component specifies opacity
1453	specifies opacity (alpha) values. The minimum value of C<0> is completely	1537	(alpha) values. The minimum value of C<0000> is completely transparent,
1454	transparent). You can also prefix any color with C<[percent]>, where	1538	while C<ffff> is completely opaque). The two example colours from
1455	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1539	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1456	the color, where C<0> is completely transparent and C<100> is completelxy	1540	C<rgba:0000/ff00/0000/f332>.
1457	opaque.
1458		1541
1459	You probably need to specify B<"-depth 32">, too, and have the luck that	1542	You probably need to specify B<"-depth 32">, too, to force a visual with
1460	your X-server uses ARGB pixel layout, as X is far from just supporting	1543	alpha channels, and have the luck that your X-server uses ARGB pixel
1461	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1544	layout, as X is far from just supporting ARGB visuals out of the box, and
		1545	rxvt-unicode just fudges around.
1462		1546
1463	For example, the following selects an almost completely transparent red	1547	For example, the following selects an almost completely transparent black
1464	background, and an almost opaque pink foreground:	1548	background, and an almost opaque pink foreground:
1465		1549
1466	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1550	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1467		1551
1468	I<Please note that transparency of any kind if completely unsupported by	1552	When not using a background image, then the interpretation of the
1469	the author. Don't bug him with installation questions!>	1553	alpha channel is up to your compositing manager (most interpret it as
		1554	transparency of course).
		1555
		1556	When using a background pixmap or pseudo-transparency, then the background
		1557	colour will always behave as if it were completely transparent (so the
		1558	background image shows instead), regardless of how it was specified, while
		1559	other colours will either be transparent as specified (the background
		1560	image will show through) on servers supporting the RENDER extension, or
		1561	fully opaque on servers not supporting the RENDER EXTENSION.
		1562
		1563	Please note that due to bugs in Xft, specifying alpha values might result
		1564	in garbage being displayed when the X-server does not support the RENDER
		1565	extension.
1470		1566
1471	=head1 ENVIRONMENT	1567	=head1 ENVIRONMENT
1472		1568
1473	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1569	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1474		1570
…		…
1508	C<--with-terminfo=PATH>.	1604	C<--with-terminfo=PATH>.
1509		1605
1510	=item B<DISPLAY>	1606	=item B<DISPLAY>
1511		1607
1512	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1608	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1513	display in its child processes.	1609	display in its child processes if C<-display> isn't used to override. It
		1610	defaults to C<:0> if it doesn't exist.
1514		1611
1515	=item B<SHELL>	1612	=item B<SHELL>
1516		1613
1517	The shell to be used for command execution, defaults to C</bin/sh>.	1614	The shell to be used for command execution, defaults to C</bin/sh>.
1518		1615
…		…
1544		1641
1545	=over 4	1642	=over 4
1546		1643
1547	=item B</usr/lib/X11/rgb.txt>	1644	=item B</usr/lib/X11/rgb.txt>
1548		1645
1549	Color names.	1646	Colour names.
1550		1647
1551	=back	1648	=back
1552		1649
1553	=head1 SEE ALSO	1650	=head1 SEE ALSO
1554		1651

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs. Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC