[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.216 by root, Tue Jun 5 21:29:51 2012 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
160	=item B<-blt> I<string>
161
162	Specify background blending type. If background pixmap is specified
163	at the same time as transparency - such pixmap will be blended over
164	transparency image, using method specified. Supported values are :
165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166	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
168	alpha-blending. Compile I<afterimage>; resource I<blendType>.
169		154
170	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
171		156
172	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
173	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
174	horizontal radii are considered to be the same. Setting one of the	159	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	160	radii to 1 and the other to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
177	resource I<blurRadius>.	163	resource I<blurRadius>.
178		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
		170
179	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
180		172
181	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
182		174
183	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
184		176
185	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
186		178
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	179	=item B<-pixmap> I<file[;oplist]>
188		180
189	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
190	optionally specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
191	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
193		185
194	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
195		187
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	235	for details.
244		236
245	=item B<-is>\|B<+is>	237	=item B<-is>\|B<+is>
246		238
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	240	foreground/background (default). See resource B<intensityStyles> for
249	details.	241	details.
250		242
251	=item B<-name> I<name>	243	=item B<-name> I<name>
252		244
…		…
270		262
271	=item B<-sb>\|B<+sb>	263	=item B<-sb>\|B<+sb>
272		264
273	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
274		266
		267	=item B<-sr>\|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>\|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
275	=item B<-si>\|B<+si>	276	=item B<-si>\|B<+si>
276		277
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
279		280
…		…
285	=item B<-sw>\|B<+sw>	286	=item B<-sw>\|B<+sw>
286		287
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	290	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		291
300	=item B<-ptab>\|B<+ptab>	292	=item B<-ptab>\|B<+ptab>
301		293
302	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
307		299
308	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
309		301
310	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
311		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
312	=item B<-iconic>	308	=item B<-iconic>
313		309
314	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
316		312
…		…
332		328
333	=item B<-bl>	329	=item B<-bl>
334		330
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	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	332	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
338		335
339	=item B<-override-redirect>	336	=item B<-override-redirect>
340		337
341	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	339	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
352		349
353	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
356		360
357	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
358		362
359	This option specifies the name of the terminal type to be set in the	363	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	364	B<TERM> environment variable. This terminal type must exist in the
…		…
415		419
416	=item B<-tcw>	420	=item B<-tcw>
417		421
418	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
419	button. Only effective when the original (non-perl) selection code is	423	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	424	in-use. Instead of selecting a full line it will extend the selection to
421	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
422		426
423	=item B<-insecure>	427	=item B<-insecure>
424		428
425	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
426	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
446		450
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	452	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	453	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	454	user; resource B<hold>.
		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
451		461
452	=item B<-xrm> I<string>	462	=item B<-xrm> I<string>
453		463
454	Works like the X Toolkit option of the same name, by adding the I<string>	464	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	465	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	513	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	514	entries and will not tinker with pty/tty permissions - you have to do that
505	yourself if you want that.	515	yourself if you want that.
506		516
507	As an extremely special case, specifying C<-1> will completely suppress	517	As an extremely special case, specifying C<-1> will completely suppress
508	pty/tty operations.	518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
509		520
510	Here is a example in perl that illustrates how this option can be used (a	521	Here is a example in perl that illustrates how this option can be used (a
511	longer example is in F<doc/pty-fd>):	522	longer example is in F<doc/pty-fd>):
512		523
513	use IO::Pty;	524	use IO::Pty;
…		…
527	Comma-separated list of perl extension scripts to use (or not to use) in	538	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.	539	this terminal instance. See resource B<perl-ext> for details.
529		540
530	=back	541	=back
531		542
532	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
533		544
534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
536		548
537	You can set and change the resources using X11 tools like B<xrdb>. Many	549	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	550	distribution do also load settings from the B<~/.Xresources> file when X
539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
541		553
542	1. system-wide app-defaults file, either locale-dependent OR global
543	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
544	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
545	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
546	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547	6. resources specified via -xrm on the commandline	559	6. resources specified via -xrm on the commandline
548		560
549	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	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	562	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
562	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
563		575
564	Compile I<xft>: Attempt to find a visual with the given bit depth;	576	Compile I<xft>: Attempt to find a visual with the given bit depth;
565	option B<-depth>.	577	option B<-depth>.
566		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
		585
567	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
568		587
569	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
570	option B<-geometry>.	589	option B<-geometry>.
571		590
…		…
584	Use the specified colour for the colour value I<n>, where 0-7	603	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	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
586	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
587	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	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	607	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.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
590		609
591	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
592	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
593		612
594	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
605	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
606		625
607	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
608	foreground colour is the default.	627	foreground colour is the default.
609		628
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>	629	=item B<underlineColor:> I<colour>
616		630
617	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
618	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
619		643
620	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
621		645
622	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
623	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
630		654
631	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
632		656
633	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
634	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
635	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636		660
637	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
638		662
639	B<True>: specify that jump scrolling should be used. When receiving lots	663	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	664	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	680	if the refresh is too fast for the human eye to read anything (or the
657	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
658		682
659	=item B<transparent:> I<boolean>	683	=item B<transparent:> I<boolean>
660		684
661	Turn on/off illusion of a transparent window background.	685	Turn on/off pseudo-transparency by using the root pixmap as background.
662		686
663	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664	future versions.	688	future versions.
665		689
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>	690	=item B<fading:> I<number>
670		691
671	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
672		693
673	=item B<fadeColor:> I<colour>	694	=item B<fadeColor:> I<colour>
…		…
675	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
676	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
677		698
678	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
679		700
680	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
681	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
682		706
683	=item B<shading:> I<number>	707	=item B<shading:> I<number>
684		708
685	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
686	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
687
688	=item B<blendType:> I<string>
689
690	Specify background blending type; option B<-blt>.
691		711
692	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
693		713
694	Apply Gaussian Blurr with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
695	background image; option B<-blr>.	715	background; option B<-blr>.
		716
		717	=item B<iconFile:> I<file>
		718
		719	Set the application icon pixmap; option B<-icon>.
696		720
697	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
698		722
699	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
700		724
…		…
706	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
707		731
708	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
709	and the text.	733	and the text.
710		734
711	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
712		736
713	Use the specified image file for the background and also	737	Use the specified image file for the background and also
714	optionally specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify a colon separated list of operations to modify it.
715	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
716	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
718	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
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...>.
722	Supported operations are:	739	Supported operations are:
723		740
724	tile force background image to be tiled and not scaled. Equivalent to 0x0,	741	=over 4
725	propscale will scale image keeping proportions,	742
726	auto will scale image to match window size. Equivalent to 100x100;	743	=item B<WxH+X+Y>
727	hscale will scale image horizontally to the window size;	744
728	vscale will scale image vertically to the window size;	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
729	scale will scale image to match window size;	746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
730	root will tile image as if it was a root window background, auto-adjusting	747	scale of 0 disables scaling.
731	whenever terminal window moves.	748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
732		796
733	If used in conjunction with B<-tr> option, the specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
734	blended over transparency image using either alpha-blending, or any	798	blended over the transparent background using alpha-blending.
735	other blending type, specified with B<-blt "type"> option.
736		799
737	=item B<path:> I<path>	800	=item B<path:> I<path>
738		801
739	Specify the colon-delimited search path for finding background image files.	802	Specify the colon-delimited search path for finding background image files.
740		803
…		…
767	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
768	wide and 15 pixels high.	831	wide and 15 pixels high.
769		832
770	The second font is just used to add additional unicode characters not in	833	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	834	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	835	the bold version of the font does contain fewer characters, so this is a
773	useful supplement.	836	useful supplement.
774		837
775	The third font is an Xft font with aliasing turned off, and the characters	838	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	839	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.	840	contains other characters, but we are not interested in them.
…		…
801	text font will being used for the given style.	864	text font will being used for the given style.
802		865
803	=item B<intensityStyles:> I<boolean>	866	=item B<intensityStyles:> I<boolean>
804		867
805	When font styles are not enabled, or this option is enabled (B<True>,	868	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	869	option B<-is>, the default), bold/blink font styles imply high
807	intensity foreground/background colours. Disabling this option (B<False>,	870	intensity foreground/background colours. Disabling this option (B<False>,
808	option B<+is>) disables this behaviour, the high intensity colours are not	871	option B<+is>) disables this behaviour, the high intensity colours are not
809	reachable.	872	reachable.
810		873
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>	874	=item B<title:> I<string>
824		875
825	Set window title string, the default title is the command-line	876	Set window title string, the default title is the command-line
826	specified after the B<-e> option, if any, otherwise the application	877	specified after the B<-e> option, if any, otherwise the application
827	name; option B<-title>.	878	name; option B<-title>.
…		…
840	=item B<urgentOnBell:> I<boolean>	891	=item B<urgentOnBell:> I<boolean>
841		892
842	B<True>: set the urgency hint for the wm on receipt of a bell character.	893	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].	894	B<False>: do not set the urgency hint [default].
844		895
		896	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		897
845	=item B<visualBell:> I<boolean>	898	=item B<visualBell:> I<boolean>
846		899
847	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	900	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848	B<False>: no visual bell [default]; option B<+vb>.	901	B<False>: no visual bell [default]; option B<+vb>.
849		902
…		…
872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	925	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873		926
874	This creates a new file in your home directory with the screen contents	927	This creates a new file in your home directory with the screen contents
875	every time you hit C<Print>.	928	every time you hit C<Print>.
876		929
		930	=item B<scrollstyle:> I<mode>
		931
		932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		933	the author's favourite.
		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
877	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
878		940
879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
881		943
…		…
900	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
901	B<+si>.	963	B<+si>.
902		964
903	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
904		966
905	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	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	968	try to show the same lines) and B<scrollTtyOutput> is False; option
907	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
908		971
909	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
910		973
911	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	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	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
968	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
969		1032
970	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971	option B<-bc>.	1034	option B<-bc>.
972		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
		1040
973	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
974		1042
975	B<True>: blank the pointer when a key is pressed or after a set number	1043	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	1044	of seconds of inactivity. B<False>: the pointer is always visible
977	[default].	1045	[default].
…		…
990	large number (e.g. C<987654321>) to effectively disable the timeout.	1058	large number (e.g. C<987654321>) to effectively disable the timeout.
991		1059
992	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
993		1061
994	The string to send when the backspace key is pressed. If set to B<DEC>	1062	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>	1063	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	1064	(code 8) - which can be reversed with the appropriate DEC private mode
997	escape sequence.	1065	escape sequence.
998		1066
999	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
1000		1068
…		…
1079		1147
1080	=item B<secondaryScroll:> I<boolean>	1148	=item B<secondaryScroll:> I<boolean>
1081		1149
1082	Turn on/off secondary screen scroll (default enabled). If this	1150	Turn on/off secondary screen scroll (default enabled). If this
1083	option is enabled, scrolls on the secondary screen will change the	1151	option is enabled, scrolls on the secondary screen will change the
1084	scrollback buffer and switching to/from the secondary screen will	1152	scrollback buffer and, when secondaryScreen is off, switching
1085	instead scroll the screen up.	1153	to/from the secondary screen will instead scroll the screen up.
1086		1154
1087	=item B<hold>: I<boolean>	1155	=item B<hold>: I<boolean>
1088		1156
1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1157	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090	will not immediately destroy its window when the program executed within	1158	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	1159	it exits. Instead, it will wait till it is being killed or closed by the
1092	user.	1160	user.
		1161
		1162	=item B<chdir>: I<path>
		1163
		1164	Sets the working directory for the shell (or the command specified via
		1165	B<-e>). The I<path> must be an absolute path and it must exist for
		1166	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1167	directory will be used; option B<-cd>.
1093		1168
1094	=item B<keysym.>I<sym>: I<string>	1169	=item B<keysym.>I<sym>: I<string>
1095		1170
1096	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1171	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097	intervening resource name B<keysym.> cannot be omitted.	1172	intervening resource name B<keysym.> cannot be omitted.
…		…
1112	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1187	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	1188	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.	1189	performed in an exact manner; however, the closest match is assured.
1115		1190
1116	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1117	number), see RESOURCES in C<man 7 X> for futher details.	1192	number), see RESOURCES in C<man 7 X> for further details.
1118		1193
1119	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1120	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1121	should be a character not used by the strings.	1197	should be a character not used by the strings.
1122		1198
1123	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1124		1200
1125	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1126		1202
1127	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1128		1204
1129	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1130	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1131	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1132		1208
1133	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	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	1210	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>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1136	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
1137		1213
1138	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139		1215
1140	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1216	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)	1217	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	1218	manpage. For example, the F<selection> extension (activated via
1143	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144		1220
1145	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1146		1222
1147	Due the the large number of modifier combinations, a defined key mapping	1223	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	1224	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	1225	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	1226	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	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152	mappings themselves.	1228	mappings themselves.
1153		1229
…		…
1204	all instances, while B<perl-ext> is used for specific instances.	1280	all instances, while B<perl-ext> is used for specific instances.
1205		1281
1206	=item B<perl-eval>: I<string>	1282	=item B<perl-eval>: I<string>
1207		1283
1208	Perl code to be evaluated when all extensions have been registered. See	1284	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	1285	the @@RXVT_NAME@@perl(3) manpage.
1210	will be ignored when running setuid/setgid.
1211		1286
1212	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1213		1288
1214	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1215	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1216	@@RXVT_NAME@@ will first look in these directories and then in	1291	in these directories, then in C<$RXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1217	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1292	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218	will be ignored when running setuid/setgid.
1219		1293
1220	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1221		1295
1222	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223		1297
…		…
1245		1319
1246	=item B<override-redirect>: I<boolean>	1320	=item B<override-redirect>: I<boolean>
1247		1321
1248	Compile I<frills>: Sets override-redirect for the terminal window, making	1322	Compile I<frills>: Sets override-redirect for the terminal window, making
1249	it almost invisible to window managers; option B<-override-redirect>.	1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
1250		1328
1251	=item B<iso14755_52:> I<boolean>	1329	=item B<iso14755_52:> I<boolean>
1252		1330
1253	Turn on/off ISO 14755 5.2 mode (default enabled).	1331	Turn on/off ISO 14755 5.2 mode (default enabled).
1254		1332
…		…
1397	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	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	1476	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	1477	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.	1478	on some systems or setgid to root or to some other group on others.
1401		1479
1402	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1403		1481
1404	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1405	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	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	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407	colours with their names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1408		1489
1409	=begin table	1490	=begin table
1410		1491
1411	B<color0> (black) = Black	1492	B<color0> (black) = Black
1412	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1432	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1433	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	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	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1435	color0-color15.	1516	color0-color15.
1436		1517
1437	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1518	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)	1519	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		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
1442	Together, all those colours implement the 88 colour xterm colours. Only	1530	Together, all those colours implement the 88 (256) colour xterm
1443	the first 16 can be changed using resources currently, the rest can only	1531	colours. Only the first 16 can be changed using resources currently, the
1444	be changed via command sequences ("escape codes").	1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
1445		1536
1446	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447	always swapping the foreground/background colours. This is in contrast to	1538	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	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1449	been specified. For example,	1540	been specified. For example,
1450		1541
1451	=over 4
1452
1453	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1542	@@RXVT_NAME@@ -fg Black -bg White -rv
1454		1543
1455	would yield White on Black, while on I<xterm>(1) it would yield Black	1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
1456	on White.	1545	White.
1457
1458	=back
1459		1546
1460	=head2 ALPHA CHANNEL SUPPORT	1547	=head2 ALPHA CHANNEL SUPPORT
1461		1548
1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	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>	1550	their act together, rxvt-unicode will do its own alpha channel management:
1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1551
1465	in addition to the ones provided by X, where the additional A component	1552	You can prefix any colour with an opaqueness percentage enclosed in
		1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1556	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1557	is the recommended format to specify transparency values, and works with
		1558	all ways to specify a colour.
		1559
		1560	For complete control, rxvt-unicode also supports
		1561	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1562	specifications, where the additional C<aaaa> component specifies opacity
1466	specifies opacity (alpha) values. The minimum value of C<0> is completely	1563	(alpha) values. The minimum value of C<0000> is completely transparent,
1467	transparent). You can also prefix any color with C<[percent]>, where	1564	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	1565	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	1566	C<rgba:0000/ff00/0000/f332>.
1470	opaque.
1471		1567
1472	You probably need to specify B<"-depth 32">, too, and have the luck that	1568	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	1569	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.	1570	layout, as X is far from just supporting ARGB visuals out of the box, and
		1571	rxvt-unicode just fudges around.
1475		1572
1476	For example, the following selects an almost completely transparent red	1573	For example, the following selects an almost completely transparent black
1477	background, and an almost opaque pink foreground:	1574	background, and an almost opaque pink foreground:
1478		1575
1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1576	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480		1577
1481	I<Please note that transparency of any kind if completely unsupported by	1578	When not using a background image, then the interpretation of the
1482	the author. Don't bug him with installation questions!>	1579	alpha channel is up to your compositing manager (most interpret it as
		1580	transparency of course).
		1581
		1582	When using a background pixmap or pseudo-transparency, then the background
		1583	colour will always behave as if it were completely transparent (so the
		1584	background image shows instead), regardless of how it was specified, while
		1585	other colours will either be transparent as specified (the background
		1586	image will show through) on servers supporting the RENDER extension, or
		1587	fully opaque on servers not supporting the RENDER EXTENSION.
		1588
		1589	Please note that due to bugs in Xft, specifying alpha values might result
		1590	in garbage being displayed when the X-server does not support the RENDER
		1591	extension.
1483		1592
1484	=head1 ENVIRONMENT	1593	=head1 ENVIRONMENT
1485		1594
1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1595	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487		1596
…		…
1521	C<--with-terminfo=PATH>.	1630	C<--with-terminfo=PATH>.
1522		1631
1523	=item B<DISPLAY>	1632	=item B<DISPLAY>
1524		1633
1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1634	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526	display in its child processes.	1635	display in its child processes if C<-display> isn't used to override. It
		1636	defaults to C<:0> if it doesn't exist.
1527		1637
1528	=item B<SHELL>	1638	=item B<SHELL>
1529		1639
1530	The shell to be used for command execution, defaults to C</bin/sh>.	1640	The shell to be used for command execution, defaults to C</bin/sh>.
1531		1641
1532	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET> (sic)
1533		1643
1534	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1535	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1536		1646
1537	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1648
		1649	=item B<RXVT_PERL_LIB> (sic)
		1650
		1651	Additional F<:>-separated library search path for perl extensions. Will be
		1652	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1653	directory.
1538		1654
1539	=item B<HOME>	1655	=item B<HOME>
1540		1656
1541	Used to locate the default directory for the unix domain socket for	1657	Used to locate the default directory for the unix domain socket for
1542	daemon communications and to locate various resource files (such as	1658	daemon communications and to locate various resource files (such as
1543	C<.Xdefaults>)	1659	C<.Xdefaults>)
1544		1660
1545	=item B<XAPPLRESDIR>	1661	=item B<XAPPLRESDIR>
1546		1662
1547	Directory where various X resource files are being located.	1663	Directory where application-specific X resource files are located.
1548		1664
1549	=item B<XENVIRONMENT>	1665	=item B<XENVIRONMENT>
1550		1666
1551	If set and accessible, gives the name of a X resource file to be loaded by	1667	If set and accessible, gives the name of a X resource file to be loaded by
1552	@@RXVT_NAME@@.	1668	@@RXVT_NAME@@.
…		…
1557		1673
1558	=over 4	1674	=over 4
1559		1675
1560	=item B</usr/lib/X11/rgb.txt>	1676	=item B</usr/lib/X11/rgb.txt>
1561		1677
1562	Color names.	1678	Colour names.
1563		1679
1564	=back	1680	=back
1565		1681
1566	=head1 SEE ALSO	1682	=head1 SEE ALSO
1567		1683
…		…
1618		1734
1619	Project Coordinator (Changes 1.0 -)	1735	Project Coordinator (Changes 1.0 -)
1620		1736
1621	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1737	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1622		1738
1623	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1739	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624		1740
1625	=back	1741	=back
1626		1742

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.216 by root, Tue Jun 5 21:29:51 2012 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.216 by root, Tue Jun 5 21:29:51 2012 UTC