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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs.
Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 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; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122		130
123	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
124	future versions.	132	future versions.
125
126	I<Please address all transparency related issues to Sasha Vasko at
127	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128		133
129	=item B<-fade> I<number>	134	=item B<-fade> I<number>
130		135
131	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
132	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
…		…
137	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
138	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
139		144
140	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
141		146
142	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
143	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
144	non-tiled backgrounds, currently. See also the B<-sh> option that can be
145	used to brighten or darken the image in addition to tinting it.
146	Please note that certain tint colours can be applied on the server-side,
147	thus yielding performance gain of two orders of magnitude. These colours are:
148	blue, red, green, cyan, magenta, yellow, and those close to them. Also
149	pure black and pure white colors essentially mean no tinting; resource
150	I<tintColor>. Example:
151
152	@@RXVT_NAME@@ -tr -tint blue -sh 40
153		149
154	=item B<-sh> I<number>	150	=item B<-sh> I<number>
155		151
156	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
157	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
158	resource I<shading>.
159		154
160	=item B<-blt> I<string>	155	=item B<-blt> I<string>
161		156
162	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
163	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
164	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
166	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
169		164
170	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
171		166
172	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
173	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
174	horizontal radii are considered to be the same. Setting one of the	169	horizontal radii are considered to be the same. Setting one of the
175	radii to 1 and another to a large number creates interesting effects	170	radii to 1 and another to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
177	resource I<blurRadius>.	172	resource I<blurRadius>.
178		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
		179
179	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
180		181
181	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
182		183
183	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
184		185
185	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
186		187
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188		189
189	Compile I<afterimage>: Specify image file for the background and also	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
190	optionally specify its scaling with a geometry string. Note you may need to	191	optionally specify its scaling with a geometry string. Note you may need to
191	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
193		194
194	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	244	for details.
244		245
245	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
246		247
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
249	details.	250	details.
250		251
251	=item B<-name> I<name>	252	=item B<-name> I<name>
252		253
…		…
270		271
271	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
272		273
273	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
274		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
275	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
276		286
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
279		289
…		…
285	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
286		296
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
290
291	=item B<-sr>\|B<+sr>
292
293	Put scrollbar on right/left; resource B<scrollBar_right>.
294
295	=item B<-st>\|B<+st>
296
297	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298	resource B<scrollBar_floating>.
299		300
300	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
301		302
302	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
307		308
308	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
309		310
310	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
311		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
312	=item B<-iconic>	317	=item B<-iconic>
313		318
314	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
316		321
…		…
332		337
333	=item B<-bl>	338	=item B<-bl>
334		339
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336	if honoured by the WM, the rxvt-unicode window will not have window	341	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
338		344
339	=item B<-override-redirect>	345	=item B<-override-redirect>
340		346
341	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	348	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
352		358
353	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
356		369
357	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
358		371
359	This option specifies the name of the terminal type to be set in the	372	This option specifies the name of the terminal type to be set in the
360	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
415		428
416	=item B<-tcw>	429	=item B<-tcw>
417		430
418	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
419	button. Only effective when the original (non-perl) selection code is	432	button. Only effective when the original (non-perl) selection code is
420	in-use. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
421	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
422		435
423	=item B<-insecure>	436	=item B<-insecure>
424		437
425	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
426	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
446		459
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
449	it exits. Instead, it will wait till it is being killed or closed by the	462	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	463	user; resource B<hold>.
		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
451		470
452	=item B<-xrm> I<string>	471	=item B<-xrm> I<string>
453		472
454	Works like the X Toolkit option of the same name, by adding the I<string>	473	Works like the X Toolkit option of the same name, by adding the I<string>
455	as if it were specified in a resource file. Resource values specified this	474	as if it were specified in a resource file. Resource values specified this
…		…
503	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504	entries and will not tinker with pty/tty permissions - you have to do that	523	entries and will not tinker with pty/tty permissions - you have to do that
505	yourself if you want that.	524	yourself if you want that.
506		525
507	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
508	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
509		529
510	Here is a example in perl that illustrates how this option can be used (a	530	Here is a example in perl that illustrates how this option can be used (a
511	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
512		532
513	use IO::Pty;	533	use IO::Pty;
…		…
527	Comma-separated list of perl extension scripts to use (or not to use) in	547	Comma-separated list of perl extension scripts to use (or not to use) in
528	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
529		549
530	=back	550	=back
531		551
532	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
533		553
534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
536		557
537	You can set and change the resources using X11 tools like B<xrdb>. Many	558	You can set and change the resources using X11 tools like B<xrdb>. Many
538	distribution do also load settings from the B<~/.Xresources> file when X	559	distribution do also load settings from the B<~/.Xresources> file when X
539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
541		562
542	1. system-wide app-defaults file, either locale-dependent OR global
543	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
544	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
545	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
546	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
548		569
549	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
550	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
562	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
563		584
564	Compile I<xft>: Attempt to find a visual with the given bit depth;	585	Compile I<xft>: Attempt to find a visual with the given bit depth;
565	option B<-depth>.	586	option B<-depth>.
566		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
567	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
568		596
569	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
570	option B<-geometry>.	598	option B<-geometry>.
571		599
…		…
584	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
585	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
586	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
587	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
588	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	616	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
590		618
591	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
592	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
593		621
594	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
605	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
606		634
607	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
608	foreground colour is the default.	636	foreground colour is the default.
609		637
610	=item B<colorRV:> I<colour>
611
612	Use the specified colour as the background for reverse video characters
613	when OPTION_HC is disabled (--disable-frills).
614
615	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
616		639
617	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
618	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
619		652
620	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
621		654
622	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
623	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
630		663
631	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
632		665
633	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
634	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
635	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636		669
637	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
638		671
639	B<True>: specify that jump scrolling should be used. When receiving lots	672	B<True>: specify that jump scrolling should be used. When receiving lots
640	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
656	if the refresh is too fast for the human eye to read anything (or the	689	if the refresh is too fast for the human eye to read anything (or the
657	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
658		691
659	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
660		693
661	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
662		695
663	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664	future versions.	697	future versions.
665		698
666	I<Please address all transparency related issues to Sasha Vasko at
667	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
668
669	=item B<fading:> I<number>	699	=item B<fading:> I<number>
670		700
671	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
672		702
673	=item B<fadeColor:> I<colour>	703	=item B<fadeColor:> I<colour>
…		…
675	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
676	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
677		707
678	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
679		709
680	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
681	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
682		715
683	=item B<shading:> I<number>	716	=item B<shading:> I<number>
684		717
685	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
686	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
687		720
688	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
689		722
690	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
691		724
692	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
693		726
694	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
695	background image; option B<-blr>.	728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
696		733
697	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
698		735
699	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
700		737
…		…
710		747
711	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
712		749
713	Use the specified image file for the background and also	750	Use the specified image file for the background and also
714	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
715	(default C<0x0+50+50>) in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
716	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
717	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
718	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	755	The maximum permitted scale is 1000.
719	an integer number of images in that direction. No image will be magnified
720	beyond 10 times its original size. The maximum permitted scale is 1000.
721	Additional operations can be specified after colon B<:op1:op2...>.	756	Additional operations can be specified after colon B<:op1:op2...>.
722	Supported operations are:	757	Supported operations are:
723		758
724	tile force background image to be tiled and not scaled. Equivalent to 0x0,	759	tile will tile image
725	propscale will scale image keeping proportions,	760	propscale will scale image keeping proportions
726	auto will scale image to match window size. Equivalent to 100x100;
727	hscale will scale image horizontally to the window size;	761	hscale will scale image horizontally to the window size
728	vscale will scale image vertically to the window size;	762	vscale will scale image vertically to the window size
729	scale will scale image to match window size;	763	scale will scale image to match window size
730	root will tile image as if it was a root window background, auto-adjusting	764	root will tile image as if it was a root window background, auto-adjusting
731	whenever terminal window moves.	765	whenever terminal window moves
732		766
733	If used in conjunction with B<-tr> option, the specified pixmap will be	767	If used in conjunction with B<-tr> option, the specified pixmap will be
734	blended over transparency image using either alpha-blending, or any	768	blended over the transparent background using alpha-blending. If I<afterimage>
735	other blending type, specified with B<-blt "type"> option.	769	support has been compiled in it is possible to choose other blending
		770	types with B<-blt "type"> option.
736		771
737	=item B<path:> I<path>	772	=item B<path:> I<path>
738		773
739	Specify the colon-delimited search path for finding background image files.	774	Specify the colon-delimited search path for finding background image files.
740		775
…		…
767	it is named first) and thus defines the character cell grid to be 9 pixels	802	it is named first) and thus defines the character cell grid to be 9 pixels
768	wide and 15 pixels high.	803	wide and 15 pixels high.
769		804
770	The second font is just used to add additional unicode characters not in	805	The second font is just used to add additional unicode characters not in
771	the base font, likewise the third, which is unfortunately non-bold, but	806	the base font, likewise the third, which is unfortunately non-bold, but
772	the bold version of the font does contain less characters, so this is a	807	the bold version of the font does contain fewer characters, so this is a
773	useful supplement.	808	useful supplement.
774		809
775	The third font is an Xft font with aliasing turned off, and the characters	810	The third font is an Xft font with aliasing turned off, and the characters
776	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	811	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777	contains other characters, but we are not interested in them.	812	contains other characters, but we are not interested in them.
…		…
801	text font will being used for the given style.	836	text font will being used for the given style.
802		837
803	=item B<intensityStyles:> I<boolean>	838	=item B<intensityStyles:> I<boolean>
804		839
805	When font styles are not enabled, or this option is enabled (B<True>,	840	When font styles are not enabled, or this option is enabled (B<True>,
806	option B<-is>, the default), bold and italic font styles imply high	841	option B<-is>, the default), bold/blink font styles imply high
807	intensity foreground/background colours. Disabling this option (B<False>,	842	intensity foreground/background colours. Disabling this option (B<False>,
808	option B<+is>) disables this behaviour, the high intensity colours are not	843	option B<+is>) disables this behaviour, the high intensity colours are not
809	reachable.	844	reachable.
810		845
811	=item B<selectstyle:> I<mode>
812
813	Set mouse selection style to B<old> which is 2.20, B<oldword> which
814	is xterm style with 2.20 old word selection, or anything else which
815	gives xterm style selection. Only effective when the original (non-perl)
816	selection code is in use.
817
818	=item B<scrollstyle:> I<mode>
819
820	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821	the author's favourite.
822
823	=item B<title:> I<string>	846	=item B<title:> I<string>
824		847
825	Set window title string, the default title is the command-line	848	Set window title string, the default title is the command-line
826	specified after the B<-e> option, if any, otherwise the application	849	specified after the B<-e> option, if any, otherwise the application
827	name; option B<-title>.	850	name; option B<-title>.
…		…
840	=item B<urgentOnBell:> I<boolean>	863	=item B<urgentOnBell:> I<boolean>
841		864
842	B<True>: set the urgency hint for the wm on receipt of a bell character.	865	B<True>: set the urgency hint for the wm on receipt of a bell character.
843	B<False>: do not set the urgency hint [default].	866	B<False>: do not set the urgency hint [default].
844		867
		868	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		869
845	=item B<visualBell:> I<boolean>	870	=item B<visualBell:> I<boolean>
846		871
847	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	872	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848	B<False>: no visual bell [default]; option B<+vb>.	873	B<False>: no visual bell [default]; option B<+vb>.
849		874
…		…
872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	897	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873		898
874	This creates a new file in your home directory with the screen contents	899	This creates a new file in your home directory with the screen contents
875	every time you hit C<Print>.	900	every time you hit C<Print>.
876		901
		902	=item B<scrollstyle:> I<mode>
		903
		904	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		905	the author's favourite.
		906
		907	=item B<thickness:> I<number>
		908
		909	Set the scrollbar width in pixels.
		910
877	=item B<scrollBar:> I<boolean>	911	=item B<scrollBar:> I<boolean>
878		912
879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	913	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880	disable the scrollbar; option B<+sb>.	914	disable the scrollbar; option B<+sb>.
881		915
…		…
900	B<False>: do not scroll to bottom when tty receives output; option	934	B<False>: do not scroll to bottom when tty receives output; option
901	B<+si>.	935	B<+si>.
902		936
903	=item B<scrollWithBuffer:> I<boolean>	937	=item B<scrollWithBuffer:> I<boolean>
904		938
905	B<True>: scroll with scrollback buffer when tty receives new lines (and	939	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
906	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	940	try to show the same lines) and B<scrollTtyOutput> is False; option
907	with scrollback buffer when tty receives new lines; option B<+sw>.	941	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		942	new lines; option B<+sw>.
908		943
909	=item B<scrollTtyKeypress:> I<boolean>	944	=item B<scrollTtyKeypress:> I<boolean>
910		945
911	B<True>: scroll to bottom when a non-special key is pressed. Special keys	946	B<True>: scroll to bottom when a non-special key is pressed. Special keys
912	are those which are intercepted by rxvt-unicode for special handling and	947	are those which are intercepted by rxvt-unicode for special handling and
…		…
968	=item B<cursorBlink:> I<boolean>	1003	=item B<cursorBlink:> I<boolean>
969		1004
970	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1005	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971	option B<-bc>.	1006	option B<-bc>.
972		1007
		1008	=item B<cursorUnderline:> I<boolean>
		1009
		1010	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1011	option B<-uc>.
		1012
973	=item B<pointerBlank:> I<boolean>	1013	=item B<pointerBlank:> I<boolean>
974		1014
975	B<True>: blank the pointer when a key is pressed or after a set number	1015	B<True>: blank the pointer when a key is pressed or after a set number
976	of seconds of inactivity. B<False>: the pointer is always visible	1016	of seconds of inactivity. B<False>: the pointer is always visible
977	[default].	1017	[default].
…		…
990	large number (e.g. C<987654321>) to effectively disable the timeout.	1030	large number (e.g. C<987654321>) to effectively disable the timeout.
991		1031
992	=item B<backspacekey:> I<string>	1032	=item B<backspacekey:> I<string>
993		1033
994	The string to send when the backspace key is pressed. If set to B<DEC>	1034	The string to send when the backspace key is pressed. If set to B<DEC>
995	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1035	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
996	(code 8) - which can be reversed with the appropriate DEC private mode	1036	(code 8) - which can be reversed with the appropriate DEC private mode
997	escape sequence.	1037	escape sequence.
998		1038
999	=item B<deletekey:> I<string>	1039	=item B<deletekey:> I<string>
1000		1040
…		…
1079		1119
1080	=item B<secondaryScroll:> I<boolean>	1120	=item B<secondaryScroll:> I<boolean>
1081		1121
1082	Turn on/off secondary screen scroll (default enabled). If this	1122	Turn on/off secondary screen scroll (default enabled). If this
1083	option is enabled, scrolls on the secondary screen will change the	1123	option is enabled, scrolls on the secondary screen will change the
1084	scrollback buffer and switching to/from the secondary screen will	1124	scrollback buffer and, when secondaryScreen is off, switching
1085	instead scroll the screen up.	1125	to/from the secondary screen will instead scroll the screen up.
1086		1126
1087	=item B<hold>: I<boolean>	1127	=item B<hold>: I<boolean>
1088		1128
1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1129	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090	will not immediately destroy its window when the program executed within	1130	will not immediately destroy its window when the program executed within
1091	it exits. Instead, it will wait till it is being killed or closed by the	1131	it exits. Instead, it will wait till it is being killed or closed by the
1092	user.	1132	user.
		1133
		1134	=item B<chdir>: I<path>
		1135
		1136	Sets the working directory for the shell (or the command specified via
		1137	B<-e>). The I<path> must be an absolute path and it must exist for
		1138	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1139	directory will be used; option B<-cd>.
1093		1140
1094	=item B<keysym.>I<sym>: I<string>	1141	=item B<keysym.>I<sym>: I<string>
1095		1142
1096	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1143	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097	intervening resource name B<keysym.> cannot be omitted.	1144	intervening resource name B<keysym.> cannot be omitted.
…		…
1112	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1159	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1113	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1160	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1114	performed in an exact manner; however, the closest match is assured.	1161	performed in an exact manner; however, the closest match is assured.
1115		1162
1116	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1163	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1117	number), see RESOURCES in C<man 7 X> for futher details.	1164	number), see RESOURCES in C<man 7 X> for further details.
1118		1165
1119	You can define a range of keysyms in one shot by providing a I<string>	1166	You can define a range of keysyms in one shot by providing a I<string>
1120	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1167	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1121	should be a character not used by the strings.	1168	should be a character not used by the strings.
1122		1169
1123	Its usage can be demonstrated by an example:	1170	Its usage can be demonstrated by an example:
1124		1171
1125	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1172	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1126		1173
1127	The above line is equivalent to the following three lines:	1174	The above line is equivalent to the following three lines:
1128		1175
1129	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1176	URxvt.keysym.Meta-Control-0x61: \033<a>
1130	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1177	URxvt.keysym.Meta-Control-0x62: \033<b>
1131	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1178	URxvt.keysym.Meta-Control-0x63: \033<c>
1132		1179
1133	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1180	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1134	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1181	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1135	example the following means "change the current locale to C<zh_CN.GBK>	1182	example the following means "change the current locale to C<zh_CN.GBK>
1136	when Control-Meta-c is being pressed":	1183	when Control-Meta-c is being pressed":
1137		1184
1138	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1185	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139		1186
1140	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1187	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1141	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1188	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1142	manpage. For example, the F<selection> extension (activated via	1189	manpage. For example, the F<selection> extension (activated via
1143	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1190	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144		1191
1145	URxvt.keysym.M-C-c: perl:selection:rot13	1192	URxvt.keysym.M-C-c: perl:selection:rot13
1146		1193
1147	Due the the large number of modifier combinations, a defined key mapping	1194	Due the the large number of modifier combinations, a defined key mapping
1148	will match if at I<at least> the specified identifiers are being set, and	1195	will match if I<at least> the specified identifiers are being set, and
1149	no other key mappings with those and more bits are being defined. That	1196	no other key mappings with those and more bits are being defined. That
1150	means that defining a key map for C<a> will automatically provide	1197	means that defining a key map for C<a> will automatically provide
1151	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1198	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152	mappings themselves.	1199	mappings themselves.
1153		1200
…		…
1204	all instances, while B<perl-ext> is used for specific instances.	1251	all instances, while B<perl-ext> is used for specific instances.
1205		1252
1206	=item B<perl-eval>: I<string>	1253	=item B<perl-eval>: I<string>
1207		1254
1208	Perl code to be evaluated when all extensions have been registered. See	1255	Perl code to be evaluated when all extensions have been registered. See
1209	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1256	the @@RXVT_NAME@@perl(3) manpage.
1210	will be ignored when running setuid/setgid.
1211		1257
1212	=item B<perl-lib>: I<path>	1258	=item B<perl-lib>: I<path>
1213		1259
1214	Colon-separated list of additional directories that hold extension	1260	Colon-separated list of additional directories that hold extension
1215	scripts. When looking for extensions specified by the C<perl> resource,	1261	scripts. When looking for extensions specified by the C<perl> resource,
1216	@@RXVT_NAME@@ will first look in these directories and then in	1262	@@RXVT_NAME@@ will first look in these directories and then in
1217	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1263	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218	will be ignored when running setuid/setgid.
1219		1264
1220	See the @@RXVT_NAME@@perl(3) manpage.	1265	See the @@RXVT_NAME@@perl(3) manpage.
1221		1266
1222	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1267	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223		1268
…		…
1245		1290
1246	=item B<override-redirect>: I<boolean>	1291	=item B<override-redirect>: I<boolean>
1247		1292
1248	Compile I<frills>: Sets override-redirect for the terminal window, making	1293	Compile I<frills>: Sets override-redirect for the terminal window, making
1249	it almost invisible to window managers; option B<-override-redirect>.	1294	it almost invisible to window managers; option B<-override-redirect>.
		1295
		1296	=item B<iso14755:> I<boolean>
		1297
		1298	Turn on/off ISO 14755 (default enabled).
1250		1299
1251	=item B<iso14755_52:> I<boolean>	1300	=item B<iso14755_52:> I<boolean>
1252		1301
1253	Turn on/off ISO 14755 5.2 mode (default enabled).	1302	Turn on/off ISO 14755 5.2 mode (default enabled).
1254		1303
…		…
1397	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1446	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1398	it can be seen via the I<who(1)> command, and can accept messages. To	1447	it can be seen via the I<who(1)> command, and can accept messages. To
1399	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1448	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1400	on some systems or setgid to root or to some other group on others.	1449	on some systems or setgid to root or to some other group on others.
1401		1450
1402	=head1 COLORS AND GRAPHICS	1451	=head1 COLOURS AND GRAPHICS
1403		1452
1404	In addition to the default foreground and background colours,	1453	In addition to the default foreground and background colours,
1405	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1454	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1406	high-intensity bold/blink versions of the same). Here is a list of the	1455	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407	colours with their names.	1456	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1457	cube plus a 8 (24) colour greyscale ramp.
		1458
		1459	Here is a list of the ANSI colours with their names.
1408		1460
1409	=begin table	1461	=begin table
1410		1462
1411	B<color0> (black) = Black	1463	B<color0> (black) = Black
1412	B<color1> (red) = Red3	1464	B<color1> (red) = Red3
…		…
1432	It is also possible to specify the colour values of B<foreground>,	1484	It is also possible to specify the colour values of B<foreground>,
1433	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1485	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434	a number 0-15, as a convenient shorthand to reference the colour name of	1486	a number 0-15, as a convenient shorthand to reference the colour name of
1435	color0-color15.	1487	color0-color15.
1436		1488
1437	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1489	The following text gives values for the standard 88 colour mode (and
1438	additional 72 colours. The first 64 of those (with indices 16 to 79)	1490	values for the 256 colour mode in parentheses).
1439	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1440	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1441		1491
		1492	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1493
		1494	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1495	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1496
		1497	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1498	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1499	the RGB cube.
		1500
1442	Together, all those colours implement the 88 colour xterm colours. Only	1501	Together, all those colours implement the 88 (256) colour xterm
1443	the first 16 can be changed using resources currently, the rest can only	1502	colours. Only the first 16 can be changed using resources currently, the
1444	be changed via command sequences ("escape codes").	1503	rest can only be changed via command sequences ("escape codes").
		1504
		1505	Applications are advised to use terminfo or command sequences to discover
		1506	number and RGB values of all colours (yes, you can query this...).
1445		1507
1446	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1508	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447	always swapping the foreground/background colours. This is in contrast to	1509	always swapping the foreground/background colours. This is in contrast to
1448	I<xterm>(1) where the colours are only swapped if they have not otherwise	1510	I<xterm>(1) where the colours are only swapped if they have not otherwise
1449	been specified. For example,	1511	been specified. For example,
1450		1512
1451	=over 4
1452
1453	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1513	@@RXVT_NAME@@ -fg Black -bg White -rv
1454		1514
1455	would yield White on Black, while on I<xterm>(1) it would yield Black	1515	would yield White on Black, while on I<xterm>(1) it would yield Black on
1456	on White.	1516	White.
1457
1458	=back
1459		1517
1460	=head2 ALPHA CHANNEL SUPPORT	1518	=head2 ALPHA CHANNEL SUPPORT
1461		1519
1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1520	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1521	their act together, rxvt-unicode will do it's own alpha channel management:
1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1522
1465	in addition to the ones provided by X, where the additional A component	1523	You can prefix any colour with an opaqueness percentage enclosed in
		1524	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1525	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1526	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1527	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1528	is the recommended format to specify transparency values, and works with
		1529	all ways to specify a colour.
		1530
		1531	For complete control, rxvt-unicode also supports
		1532	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1533	specifications, where the additional C<aaaa> component specifies opacity
1466	specifies opacity (alpha) values. The minimum value of C<0> is completely	1534	(alpha) values. The minimum value of C<0000> is completely transparent,
1467	transparent). You can also prefix any color with C<[percent]>, where	1535	while C<ffff> is completely opaque). The two example colours from
1468	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1536	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469	the color, where C<0> is completely transparent and C<100> is completelxy	1537	C<rgba:0000/ff00/0000/f332>.
1470	opaque.
1471		1538
1472	You probably need to specify B<"-depth 32">, too, and have the luck that	1539	You probably need to specify B<"-depth 32">, too, to force a visual with
1473	your X-server uses ARGB pixel layout, as X is far from just supporting	1540	alpha channels, and have the luck that your X-server uses ARGB pixel
1474	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1541	layout, as X is far from just supporting ARGB visuals out of the box, and
		1542	rxvt-unicode just fudges around.
1475		1543
1476	For example, the following selects an almost completely transparent red	1544	For example, the following selects an almost completely transparent black
1477	background, and an almost opaque pink foreground:	1545	background, and an almost opaque pink foreground:
1478		1546
1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1547	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480		1548
1481	I<Please note that transparency of any kind if completely unsupported by	1549	When not using a background image, then the interpretation of the
1482	the author. Don't bug him with installation questions!>	1550	alpha channel is up to your compositing manager (most interpret it as
		1551	transparency of course).
		1552
		1553	When using a background pixmap or pseudo-transparency, then the background
		1554	colour will always behave as if it were completely transparent (so the
		1555	background image shows instead), regardless of how it was specified, while
		1556	other colours will either be transparent as specified (the background
		1557	image will show through) on servers supporting the RENDER extension, or
		1558	fully opaque on servers not supporting the RENDER EXTENSION.
		1559
		1560	Please note that due to bugs in Xft, specifying alpha values might result
		1561	in garbage being displayed when the X-server does not support the RENDER
		1562	extension.
1483		1563
1484	=head1 ENVIRONMENT	1564	=head1 ENVIRONMENT
1485		1565
1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1566	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487		1567
…		…
1521	C<--with-terminfo=PATH>.	1601	C<--with-terminfo=PATH>.
1522		1602
1523	=item B<DISPLAY>	1603	=item B<DISPLAY>
1524		1604
1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1605	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526	display in its child processes.	1606	display in its child processes if C<-display> isn't used to override. It
		1607	defaults to C<:0> if it doesn't exist.
1527		1608
1528	=item B<SHELL>	1609	=item B<SHELL>
1529		1610
1530	The shell to be used for command execution, defaults to C</bin/sh>.	1611	The shell to be used for command execution, defaults to C</bin/sh>.
1531		1612
1532	=item B<RXVT_SOCKET>	1613	=item B<RXVT_SOCKET>
1533		1614
1534	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1615	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1535	@@RXVT_NAME@@d(1).	1616	@@RXVT_NAME@@d(1).
1536		1617
1537	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1618	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1538		1619
1539	=item B<HOME>	1620	=item B<HOME>
1540		1621
1541	Used to locate the default directory for the unix domain socket for	1622	Used to locate the default directory for the unix domain socket for
1542	daemon communications and to locate various resource files (such as	1623	daemon communications and to locate various resource files (such as
1543	C<.Xdefaults>)	1624	C<.Xdefaults>)
1544		1625
1545	=item B<XAPPLRESDIR>	1626	=item B<XAPPLRESDIR>
1546		1627
1547	Directory where various X resource files are being located.	1628	Directory where application-specific X resource files are located.
1548		1629
1549	=item B<XENVIRONMENT>	1630	=item B<XENVIRONMENT>
1550		1631
1551	If set and accessible, gives the name of a X resource file to be loaded by	1632	If set and accessible, gives the name of a X resource file to be loaded by
1552	@@RXVT_NAME@@.	1633	@@RXVT_NAME@@.
…		…
1557		1638
1558	=over 4	1639	=over 4
1559		1640
1560	=item B</usr/lib/X11/rgb.txt>	1641	=item B</usr/lib/X11/rgb.txt>
1561		1642
1562	Color names.	1643	Colour names.
1563		1644
1564	=back	1645	=back
1565		1646
1566	=head1 SEE ALSO	1647	=head1 SEE ALSO
1567		1648
…		…
1618		1699
1619	Project Coordinator (Changes 1.0 -)	1700	Project Coordinator (Changes 1.0 -)
1620		1701
1621	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1702	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1622		1703
1623	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1704	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624		1705
1625	=back	1706	=back
1626		1707

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs. Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs.
Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 UTC