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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.200 by sf-exg, Wed Aug 10 07:28:35 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>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
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<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
124	I<Please address all transparency related issues to Sasha Vasko at	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	132	future versions.
126		133
127	=item B<-fade> I<number>	134	=item B<-fade> I<number>
128		135
129	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
130	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
…		…
135	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
136	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
137		144
138	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
139		146
140	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
141	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
142	non-tiled backgrounds, currently. See also the B<-sh> option that can be
143	used to brighten or darken the image in addition to tinting it.
144	Please note that certain tint colours can be applied on the server-side,
145	thus yielding performance gain of two orders of magnitude. These colours are:
146	blue, red, green, cyan, magenta, yellow, and those close to them; resource
147	I<tintColor>. Example:
148
149	@@RXVT_NAME@@ -tr -tint blue -sh 40
150		149
151	=item B<-sh> I<number>	150	=item B<-sh> I<number>
152		151
153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
154	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
155	resource I<shading>.
156		154
157	=item B<-blt> I<string>	155	=item B<-blt> I<string>
158		156
159	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
160	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
161	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
163	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>,
164	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
165	alpha-blending; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
166		164
167	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
168		166
169	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
170	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
171	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
172	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
173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	171	on some backgrounds. Maximum radius value is 128;
		172	resource I<blurRadius>.
		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>.
174		179
175	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
176		181
177	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
178		183
179	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
180		185
181	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
182		187
183	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
184		189
185	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
186	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
187	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
188	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
189		194
190	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
…		…
238	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
239	for details.	244	for details.
240		245
241	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
242		247
243	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
244	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
245	details.	250	details.
246		251
247	=item B<-name> I<name>	252	=item B<-name> I<name>
248		253
…		…
266		271
267	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
268		273
269	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
270		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
271	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
272		286
273	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
274	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
275		289
…		…
281	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
282		296
283	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.
284	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
285	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
286
287	=item B<-sr>\|B<+sr>
288
289	Put scrollbar on right/left; resource B<scrollBar_right>.
290
291	=item B<-st>\|B<+st>
292
293	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294	resource B<scrollBar_floating>.
295		300
296	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
297		302
298	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
299	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
…		…
303		308
304	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
305		310
306	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
307		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
308	=item B<-iconic>	317	=item B<-iconic>
309		318
310	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
311	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
312		321
…		…
328		337
329	=item B<-bl>	338	=item B<-bl>
330		339
331	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.
332	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
333	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.
334		344
335	=item B<-override-redirect>	345	=item B<-override-redirect>
336		346
337	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
338	B<override-redirect>.	348	B<override-redirect>.
…		…
347	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
348		358
349	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
350	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
351	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>.
352		369
353	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
354		371
355	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
356	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
411		428
412	=item B<-tcw>	429	=item B<-tcw>
413		430
414	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
415	button. Only effective when the original (non-perl) selection code is	432	button. Only effective when the original (non-perl) selection code is
416	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
417	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
418		435
419	=item B<-insecure>	436	=item B<-insecure>
420		437
421	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
422	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
442		459
443	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@@
444	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
445	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
446	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>.
		470
		471	=item B<-xrm> I<string>
		472
		473	Works like the X Toolkit option of the same name, by adding the I<string>
		474	as if it were specified in a resource file. Resource values specified this
		475	way take precedence over all other resource specifications.
		476
		477	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		478	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		479	options can be specified as long-options on the commandline, so use
		480	of B<-xrm> is mostly limited to cases where you want to specify other
		481	resources (e.g. for input methods) or for compatibility with other
		482	programs.
447		483
448	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
449		485
450	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
451		487
…		…
486	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
487	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
488	yourself if you want that.	524	yourself if you want that.
489		525
490	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
491	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
492		529
493	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
494	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
495		532
496	use IO::Pty;	533	use IO::Pty;
…		…
510	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
511	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
512		549
513	=back	550	=back
514		551
515	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
516		553
517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
519		557
520	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
521	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
522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
524		562
525	1. system-wide app-defaults file, either locale-dependent OR global
526	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
528	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
530		569
531	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
532	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
533	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	572	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
534	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
544	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
545		584
546	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;
547	option B<-depth>.	586	option B<-depth>.
548		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
549	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
550		596
551	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
552	option B<-geometry>.	598	option B<-geometry>.
553		599
…		…
566	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
567	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
568	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
569	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,
570	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
571	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
572		618
573	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
574	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
575		621
576	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
…		…
587	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
588		634
589	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
590	foreground colour is the default.	636	foreground colour is the default.
591		637
592	=item B<colorRV:> I<colour>
593
594	Use the specified colour as the background for reverse video characters
595	when OPTION_HC is disabled (--disable-frills).
596
597	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
598		639
599	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
600	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.
601		652
602	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
603		654
604	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
605	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
612		663
613	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
614		665
615	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
616	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
617	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
618		669
619	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
620		671
621	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
622	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
…		…
636		687
637	B<False>: specify that everything is to be displayed, even	688	B<False>: specify that everything is to be displayed, even
638	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
639	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
640		691
641	=item B<inheritPixmap:> I<boolean>	692	=item B<transparent:> I<boolean>
642		693
643	B<True>: make the background inherit the parent windows' pixmap, giving	694	Turn on/off pseudo-transparency by using the root pixmap as background.
644	artificial transparency. B<False>: do not inherit the parent windows'
645	pixmap.
646		695
647	I<Please note that transparency of any kind if completely unsupported by	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
648	the author. Don't bug him with installation questions!>	697	future versions.
649		698
650	=item B<fading:> I<number>	699	=item B<fading:> I<number>
651		700
652	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>.
653		702
…		…
656	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
657	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
658		707
659	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
660		709
661	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
662	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>.
663		715
664	=item B<shading:> I<number>	716	=item B<shading:> I<number>
665		717
666	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
667	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
668		720
669	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
670		722
671	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
672		724
673	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
674		726
675	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
676	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>.
677		733
678	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
679		735
680	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
681		737
…		…
687	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
688		744
689	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
690	and the text.	746	and the text.
691		747
692	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
693		749
694	Use the specified image file for the background and also optionally	750	Use the specified image file for the background and also
695	specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
697	and B<"X" / "Y"> locate the image centre (percent).	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
698	A scale of 0 displays the image with tiling. A scale of 1 displays the	754	centre (percent). A scale of 0 disables scaling.
699	image without any scaling. A scale of 2 to 9 specifies an integer	755	The maximum permitted scale is 1000.
700	number of images in that direction. No image will be magnified beyond	756	Additional operations can be specified after colon B<:op1:op2...>.
701	10 times its original size. The maximum permitted scale is 1000.	757	Supported operations are:
702	Special string of B<"auto"> used as a geometry will cause image to be	758
703	automatically scaled to match window size.	759	tile will tile image
		760	propscale will scale image keeping proportions
		761	scale will scale image to match window size
		762	root will tile image as if it was a root window background, auto-adjusting
		763	whenever terminal window moves
		764
704	If used in conjunction with B<-tr> option - specified pixmap will be	765	If used in conjunction with B<-tr> option, the specified pixmap will be
705	blended over transparency image using either alpha-blending, or any	766	blended over the transparent background using alpha-blending. If I<afterimage>
706	other blending type, specified with B<-blt "type"> option.	767	support has been compiled in it is possible to choose other blending
707	[default 0x0+50+50]	768	types with B<-blt "type"> option.
708		769
709	=item B<path:> I<path>	770	=item B<path:> I<path>
710		771
711	Specify the colon-delimited search path for finding background image files.	772	Specify the colon-delimited search path for finding background image files.
712		773
…		…
739	it is named first) and thus defines the character cell grid to be 9 pixels	800	it is named first) and thus defines the character cell grid to be 9 pixels
740	wide and 15 pixels high.	801	wide and 15 pixels high.
741		802
742	The second font is just used to add additional unicode characters not in	803	The second font is just used to add additional unicode characters not in
743	the base font, likewise the third, which is unfortunately non-bold, but	804	the base font, likewise the third, which is unfortunately non-bold, but
744	the bold version of the font does contain less characters, so this is a	805	the bold version of the font does contain fewer characters, so this is a
745	useful supplement.	806	useful supplement.
746		807
747	The third font is an Xft font with aliasing turned off, and the characters	808	The third font is an Xft font with aliasing turned off, and the characters
748	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	809	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
749	contains other characters, but we are not interested in them.	810	contains other characters, but we are not interested in them.
…		…
773	text font will being used for the given style.	834	text font will being used for the given style.
774		835
775	=item B<intensityStyles:> I<boolean>	836	=item B<intensityStyles:> I<boolean>
776		837
777	When font styles are not enabled, or this option is enabled (B<True>,	838	When font styles are not enabled, or this option is enabled (B<True>,
778	option B<-is>, the default), bold and italic font styles imply high	839	option B<-is>, the default), bold/blink font styles imply high
779	intensity foreground/background colours. Disabling this option (B<False>,	840	intensity foreground/background colours. Disabling this option (B<False>,
780	option B<+is>) disables this behaviour, the high intensity colours are not	841	option B<+is>) disables this behaviour, the high intensity colours are not
781	reachable.	842	reachable.
782		843
783	=item B<selectstyle:> I<mode>
784
785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
786	is xterm style with 2.20 old word selection, or anything else which
787	gives xterm style selection. Only effective when the original (non-perl)
788	selection code is in use.
789
790	=item B<scrollstyle:> I<mode>
791
792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793	the author's favourite.
794
795	=item B<title:> I<string>	844	=item B<title:> I<string>
796		845
797	Set window title string, the default title is the command-line	846	Set window title string, the default title is the command-line
798	specified after the B<-e> option, if any, otherwise the application	847	specified after the B<-e> option, if any, otherwise the application
799	name; option B<-title>.	848	name; option B<-title>.
…		…
812	=item B<urgentOnBell:> I<boolean>	861	=item B<urgentOnBell:> I<boolean>
813		862
814	B<True>: set the urgency hint for the wm on receipt of a bell character.	863	B<True>: set the urgency hint for the wm on receipt of a bell character.
815	B<False>: do not set the urgency hint [default].	864	B<False>: do not set the urgency hint [default].
816		865
		866	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		867
817	=item B<visualBell:> I<boolean>	868	=item B<visualBell:> I<boolean>
818		869
819	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	870	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
820	B<False>: no visual bell [default]; option B<+vb>.	871	B<False>: no visual bell [default]; option B<+vb>.
821		872
…		…
844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	895	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845		896
846	This creates a new file in your home directory with the screen contents	897	This creates a new file in your home directory with the screen contents
847	every time you hit C<Print>.	898	every time you hit C<Print>.
848		899
		900	=item B<scrollstyle:> I<mode>
		901
		902	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		903	the author's favourite.
		904
		905	=item B<thickness:> I<number>
		906
		907	Set the scrollbar width in pixels.
		908
849	=item B<scrollBar:> I<boolean>	909	=item B<scrollBar:> I<boolean>
850		910
851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	911	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852	disable the scrollbar; option B<+sb>.	912	disable the scrollbar; option B<+sb>.
853		913
…		…
872	B<False>: do not scroll to bottom when tty receives output; option	932	B<False>: do not scroll to bottom when tty receives output; option
873	B<+si>.	933	B<+si>.
874		934
875	=item B<scrollWithBuffer:> I<boolean>	935	=item B<scrollWithBuffer:> I<boolean>
876		936
877	B<True>: scroll with scrollback buffer when tty receives new lines (and	937	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
878	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	938	try to show the same lines) and B<scrollTtyOutput> is False; option
879	with scrollback buffer when tty receives new lines; option B<+sw>.	939	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		940	new lines; option B<+sw>.
880		941
881	=item B<scrollTtyKeypress:> I<boolean>	942	=item B<scrollTtyKeypress:> I<boolean>
882		943
883	B<True>: scroll to bottom when a non-special key is pressed. Special keys	944	B<True>: scroll to bottom when a non-special key is pressed. Special keys
884	are those which are intercepted by rxvt-unicode for special handling and	945	are those which are intercepted by rxvt-unicode for special handling and
…		…
940	=item B<cursorBlink:> I<boolean>	1001	=item B<cursorBlink:> I<boolean>
941		1002
942	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1003	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
943	option B<-bc>.	1004	option B<-bc>.
944		1005
		1006	=item B<cursorUnderline:> I<boolean>
		1007
		1008	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1009	option B<-uc>.
		1010
945	=item B<pointerBlank:> I<boolean>	1011	=item B<pointerBlank:> I<boolean>
946		1012
947	B<True>: blank the pointer when a key is pressed or after a set number	1013	B<True>: blank the pointer when a key is pressed or after a set number
948	of seconds of inactivity. B<False>: the pointer is always visible	1014	of seconds of inactivity. B<False>: the pointer is always visible
949	[default].	1015	[default].
…		…
962	large number (e.g. C<987654321>) to effectively disable the timeout.	1028	large number (e.g. C<987654321>) to effectively disable the timeout.
963		1029
964	=item B<backspacekey:> I<string>	1030	=item B<backspacekey:> I<string>
965		1031
966	The string to send when the backspace key is pressed. If set to B<DEC>	1032	The string to send when the backspace key is pressed. If set to B<DEC>
967	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1033	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
968	(code 8) - which can be reversed with the appropriate DEC private mode	1034	(code 8) - which can be reversed with the appropriate DEC private mode
969	escape sequence.	1035	escape sequence.
970		1036
971	=item B<deletekey:> I<string>	1037	=item B<deletekey:> I<string>
972		1038
…		…
985	will be created). In this mode, characters outside ISO-8859-1 can be used.	1051	will be created). In this mode, characters outside ISO-8859-1 can be used.
986		1052
987	When the selection extension is not used, only ISO-8859-1 characters can	1053	When the selection extension is not used, only ISO-8859-1 characters can
988	be used. If not specified, the built-in default is used:	1054	be used. If not specified, the built-in default is used:
989		1055
990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1056	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
991		1057
992	=item B<preeditType:> I<style>	1058	=item B<preeditType:> I<style>
993		1059
994	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1060	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995		1061
…		…
1051		1117
1052	=item B<secondaryScroll:> I<boolean>	1118	=item B<secondaryScroll:> I<boolean>
1053		1119
1054	Turn on/off secondary screen scroll (default enabled). If this	1120	Turn on/off secondary screen scroll (default enabled). If this
1055	option is enabled, scrolls on the secondary screen will change the	1121	option is enabled, scrolls on the secondary screen will change the
1056	scrollback buffer and switching to/from the secondary screen will	1122	scrollback buffer and, when secondaryScreen is off, switching
1057	instead scroll the screen up.	1123	to/from the secondary screen will instead scroll the screen up.
1058		1124
1059	=item B<hold>: I<boolean>	1125	=item B<hold>: I<boolean>
1060		1126
1061	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1127	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1062	will not immediately destroy its window when the program executed within	1128	will not immediately destroy its window when the program executed within
1063	it exits. Instead, it will wait till it is being killed or closed by the	1129	it exits. Instead, it will wait till it is being killed or closed by the
1064	user.	1130	user.
		1131
		1132	=item B<chdir>: I<path>
		1133
		1134	Sets the working directory for the shell (or the command specified via
		1135	B<-e>). The I<path> must be an absolute path and it must exist for
		1136	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1137	directory will be used; option B<-cd>.
1065		1138
1066	=item B<keysym.>I<sym>: I<string>	1139	=item B<keysym.>I<sym>: I<string>
1067		1140
1068	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1141	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1069	intervening resource name B<keysym.> cannot be omitted.	1142	intervening resource name B<keysym.> cannot be omitted.
…		…
1083	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1156	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1084	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1157	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1085	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1158	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1086	performed in an exact manner; however, the closest match is assured.	1159	performed in an exact manner; however, the closest match is assured.
1087		1160
1088	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1161	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1089	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1162	number), see RESOURCES in C<man 7 X> for further details.
1090	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1091	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1092	can start or end with whitespace. B<This feature is deprecated and will
1093	be removed>.
1094
1095	Please note that you need to double the C<\> in resource files, as
1096	Xlib itself does its own de-escaping (you can use C<\033> instead of
1097	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1098	processing).
1099		1163
1100	You can define a range of keysyms in one shot by providing a I<string>	1164	You can define a range of keysyms in one shot by providing a I<string>
1101	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1165	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1102	should be a character not used by the strings.	1166	should be a character not used by the strings.
1103		1167
1104	Its usage can be demonstrated by an example:	1168	Its usage can be demonstrated by an example:
1105		1169
1106	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1170	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1107		1171
1108	The above line is equivalent to the following three lines:	1172	The above line is equivalent to the following three lines:
1109		1173
1110	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1174	URxvt.keysym.Meta-Control-0x61: \033<a>
1111	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1175	URxvt.keysym.Meta-Control-0x62: \033<b>
1112	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1176	URxvt.keysym.Meta-Control-0x63: \033<c>
1113		1177
1114	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1178	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1115	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1179	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1116	example the following means "change the current locale to C<zh_CN.GBK>	1180	example the following means "change the current locale to C<zh_CN.GBK>
1117	when Control-Meta-c is being pressed":	1181	when Control-Meta-c is being pressed":
1118		1182
1119	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1183	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1120		1184
1121	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1185	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1122	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1186	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1123	manpage. For example, the F<selection> extension (activated via	1187	manpage. For example, the F<selection> extension (activated via
1124	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1188	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1125		1189
1126	URxvt.keysym.M-C-c: perl:selection:rot13	1190	URxvt.keysym.M-C-c: perl:selection:rot13
1127		1191
1128	Due the the large number of modifier combinations, a defined key mapping	1192	Due the the large number of modifier combinations, a defined key mapping
1129	will match if at I<at least> the specified identifiers are being set, and	1193	will match if I<at least> the specified identifiers are being set, and
1130	no other key mappings with those and more bits are being defined. That	1194	no other key mappings with those and more bits are being defined. That
1131	means that defining a key map for C<a> will automatically provide	1195	means that defining a key map for C<a> will automatically provide
1132	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1196	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1133	mappings themselves.	1197	mappings themselves.
1134		1198
…		…
1185	all instances, while B<perl-ext> is used for specific instances.	1249	all instances, while B<perl-ext> is used for specific instances.
1186		1250
1187	=item B<perl-eval>: I<string>	1251	=item B<perl-eval>: I<string>
1188		1252
1189	Perl code to be evaluated when all extensions have been registered. See	1253	Perl code to be evaluated when all extensions have been registered. See
1190	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1254	the @@RXVT_NAME@@perl(3) manpage.
1191	will be ignored when running setuid/setgid.
1192		1255
1193	=item B<perl-lib>: I<path>	1256	=item B<perl-lib>: I<path>
1194		1257
1195	Colon-separated list of additional directories that hold extension	1258	Colon-separated list of additional directories that hold extension
1196	scripts. When looking for extensions specified by the C<perl> resource,	1259	scripts. When looking for extensions specified by the C<perl> resource,
1197	@@RXVT_NAME@@ will first look in these directories and then in	1260	@@RXVT_NAME@@ will first look in these directories and then in
1198	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1261	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1199	will be ignored when running setuid/setgid.
1200		1262
1201	See the @@RXVT_NAME@@perl(3) manpage.	1263	See the @@RXVT_NAME@@perl(3) manpage.
1202		1264
1203	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1265	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1204		1266
…		…
1226		1288
1227	=item B<override-redirect>: I<boolean>	1289	=item B<override-redirect>: I<boolean>
1228		1290
1229	Compile I<frills>: Sets override-redirect for the terminal window, making	1291	Compile I<frills>: Sets override-redirect for the terminal window, making
1230	it almost invisible to window managers; option B<-override-redirect>.	1292	it almost invisible to window managers; option B<-override-redirect>.
		1293
		1294	=item B<iso14755:> I<boolean>
		1295
		1296	Turn on/off ISO 14755 (default enabled).
1231		1297
1232	=item B<iso14755_52:> I<boolean>	1298	=item B<iso14755_52:> I<boolean>
1233		1299
1234	Turn on/off ISO 14755 5.2 mode (default enabled).	1300	Turn on/off ISO 14755 5.2 mode (default enabled).
1235		1301
…		…
1378	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1444	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1379	it can be seen via the I<who(1)> command, and can accept messages. To	1445	it can be seen via the I<who(1)> command, and can accept messages. To
1380	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1446	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1381	on some systems or setgid to root or to some other group on others.	1447	on some systems or setgid to root or to some other group on others.
1382		1448
1383	=head1 COLORS AND GRAPHICS	1449	=head1 COLOURS AND GRAPHICS
1384		1450
1385	In addition to the default foreground and background colours,	1451	In addition to the default foreground and background colours,
1386	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1452	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1387	high-intensity bold/blink versions of the same). Here is a list of the	1453	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1388	colours with their names.	1454	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1455	cube plus a 8 (24) colour greyscale ramp.
		1456
		1457	Here is a list of the ANSI colours with their names.
1389		1458
1390	=begin table	1459	=begin table
1391		1460
1392	B<color0> (black) = Black	1461	B<color0> (black) = Black
1393	B<color1> (red) = Red3	1462	B<color1> (red) = Red3
…		…
1413	It is also possible to specify the colour values of B<foreground>,	1482	It is also possible to specify the colour values of B<foreground>,
1414	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1483	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1415	a number 0-15, as a convenient shorthand to reference the colour name of	1484	a number 0-15, as a convenient shorthand to reference the colour name of
1416	color0-color15.	1485	color0-color15.
1417		1486
1418	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1487	The following text gives values for the standard 88 colour mode (and
1419	additional 72 colours. The first 64 of those (with indices 16 to 79)	1488	values for the 256 colour mode in parentheses).
1420	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1421	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1422		1489
		1490	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1491
		1492	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1493	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1494
		1495	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1496	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1497	the RGB cube.
		1498
1423	Together, all those colours implement the 88 colour xterm colours. Only	1499	Together, all those colours implement the 88 (256) colour xterm
1424	the first 16 can be changed using resources currently, the rest can only	1500	colours. Only the first 16 can be changed using resources currently, the
1425	be changed via command sequences ("escape codes").	1501	rest can only be changed via command sequences ("escape codes").
		1502
		1503	Applications are advised to use terminfo or command sequences to discover
		1504	number and RGB values of all colours (yes, you can query this...).
1426		1505
1427	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1506	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1428	always swapping the foreground/background colours. This is in contrast to	1507	always swapping the foreground/background colours. This is in contrast to
1429	I<xterm>(1) where the colours are only swapped if they have not otherwise	1508	I<xterm>(1) where the colours are only swapped if they have not otherwise
1430	been specified. For example,	1509	been specified. For example,
1431		1510
1432	=over 4
1433
1434	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1511	@@RXVT_NAME@@ -fg Black -bg White -rv
1435		1512
1436	would yield White on Black, while on I<xterm>(1) it would yield Black	1513	would yield White on Black, while on I<xterm>(1) it would yield Black on
1437	on White.	1514	White.
1438
1439	=back
1440		1515
1441	=head2 ALPHA CHANNEL SUPPORT	1516	=head2 ALPHA CHANNEL SUPPORT
1442		1517
1443	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1518	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1444	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1519	their act together, rxvt-unicode will do it's own alpha channel management:
1445	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1520
1446	in addition to the ones provided by X, where the additional A component	1521	You can prefix any colour with an opaqueness percentage enclosed in
		1522	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1523	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1524	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1525	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1526	is the recommended format to specify transparency values, and works with
		1527	all ways to specify a colour.
		1528
		1529	For complete control, rxvt-unicode also supports
		1530	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1531	specifications, where the additional C<aaaa> component specifies opacity
1447	specifies opacity (alpha) values. The minimum value of C<0> is completely	1532	(alpha) values. The minimum value of C<0000> is completely transparent,
1448	transparent). You can also prefix any color with C<[percent]>, where	1533	while C<ffff> is completely opaque). The two example colours from
1449	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1534	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1450	the color, where C<0> is completely transparent and C<100> is completelxy	1535	C<rgba:0000/ff00/0000/f332>.
1451	opaque.
1452		1536
1453	You probably need to specify B<"-depth 32">, too, and have the luck that	1537	You probably need to specify B<"-depth 32">, too, to force a visual with
1454	your X-server uses ARGB pixel layout, as X is far from just supporting	1538	alpha channels, and have the luck that your X-server uses ARGB pixel
1455	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1539	layout, as X is far from just supporting ARGB visuals out of the box, and
		1540	rxvt-unicode just fudges around.
1456		1541
1457	For example, the following selects an almost completely transparent red	1542	For example, the following selects an almost completely transparent black
1458	background, and an almost opaque pink foreground:	1543	background, and an almost opaque pink foreground:
1459		1544
1460	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1545	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1461		1546
1462	I<Please note that transparency of any kind if completely unsupported by	1547	When not using a background image, then the interpretation of the
1463	the author. Don't bug him with installation questions!>	1548	alpha channel is up to your compositing manager (most interpret it as
		1549	transparency of course).
		1550
		1551	When using a background pixmap or pseudo-transparency, then the background
		1552	colour will always behave as if it were completely transparent (so the
		1553	background image shows instead), regardless of how it was specified, while
		1554	other colours will either be transparent as specified (the background
		1555	image will show through) on servers supporting the RENDER extension, or
		1556	fully opaque on servers not supporting the RENDER EXTENSION.
		1557
		1558	Please note that due to bugs in Xft, specifying alpha values might result
		1559	in garbage being displayed when the X-server does not support the RENDER
		1560	extension.
1464		1561
1465	=head1 ENVIRONMENT	1562	=head1 ENVIRONMENT
1466		1563
1467	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1564	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1468		1565
…		…
1474	resources or on the command line.	1571	resources or on the command line.
1475		1572
1476	=item B<COLORTERM>	1573	=item B<COLORTERM>
1477		1574
1478	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1575	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1479	compiled with background image support, and optionally with the added	1576	compiled with background image support, and optionally with the added
1480	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1577	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1481	screen.	1578	screen.
1482		1579
1483	=item B<COLORFGBG>	1580	=item B<COLORFGBG>
1484		1581
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1582	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486	the colour code used as default foreground/text colour (or the string	1583	the colour code used as default foreground/text colour (or the string
1487	C<default> to indicate that the default-colour escape sequence is to be	1584	C<default> to indicate that the default-colour escape sequence is to be
1488	used), C<bg> is the colour code used as default background colour (or the	1585	used), C<bg> is the colour code used as default background colour (or the
1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1586	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490	was compiled with background image support. Libraries like C<ncurses>	1587	was compiled with background image support. Libraries like C<ncurses>
1491	and C<slang> can (and do) use this information to optimize screen output.	1588	and C<slang> can (and do) use this information to optimize screen output.
1492		1589
1493	=item B<WINDOWID>	1590	=item B<WINDOWID>
1494		1591
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1592	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1502	C<--with-terminfo=PATH>.	1599	C<--with-terminfo=PATH>.
1503		1600
1504	=item B<DISPLAY>	1601	=item B<DISPLAY>
1505		1602
1506	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1603	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1507	display in its child processes.	1604	display in its child processes if C<-display> isn't used to override. It
		1605	defaults to C<:0> if it doesn't exist.
1508		1606
1509	=item B<SHELL>	1607	=item B<SHELL>
1510		1608
1511	The shell to be used for command execution, defaults to C</bin/sh>.	1609	The shell to be used for command execution, defaults to C</bin/sh>.
1512		1610
1513	=item B<RXVT_SOCKET>	1611	=item B<RXVT_SOCKET>
1514		1612
1515	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1613	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1516	@@RXVT_NAME@@d(1).	1614	@@RXVT_NAME@@d(1).
1517		1615
1518	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1616	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1519		1617
1520	=item B<HOME>	1618	=item B<HOME>
1521		1619
1522	Used to locate the default directory for the unix domain socket for	1620	Used to locate the default directory for the unix domain socket for
1523	daemon communications and to locate various resource files (such as	1621	daemon communications and to locate various resource files (such as
1524	C<.Xdefaults>)	1622	C<.Xdefaults>)
1525		1623
1526	=item B<XAPPLRESDIR>	1624	=item B<XAPPLRESDIR>
1527		1625
1528	Directory where various X resource files are being located.	1626	Directory where application-specific X resource files are located.
1529		1627
1530	=item B<XENVIRONMENT>	1628	=item B<XENVIRONMENT>
1531		1629
1532	If set and accessible, gives the name of a X resource file to be loaded by	1630	If set and accessible, gives the name of a X resource file to be loaded by
1533	@@RXVT_NAME@@.	1631	@@RXVT_NAME@@.
…		…
1538		1636
1539	=over 4	1637	=over 4
1540		1638
1541	=item B</usr/lib/X11/rgb.txt>	1639	=item B</usr/lib/X11/rgb.txt>
1542		1640
1543	Color names.	1641	Colour names.
1544		1642
1545	=back	1643	=back
1546		1644
1547	=head1 SEE ALSO	1645	=head1 SEE ALSO
1548		1646
…		…
1587	Project Coordinator (changes.txt 2.21a to 2.4.5)	1685	Project Coordinator (changes.txt 2.21a to 2.4.5)
1588		1686
1589	=item Geoff Wing L<< <gcw@pobox.com> >>	1687	=item Geoff Wing L<< <gcw@pobox.com> >>
1590		1688
1591	Rewrote screen display and text selection routines.	1689	Rewrote screen display and text selection routines.
1592		1690
1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1691	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594		1692
1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1693	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596		1694
1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1695	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1599		1697
1600	Project Coordinator (Changes 1.0 -)	1698	Project Coordinator (Changes 1.0 -)
1601		1699
1602	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1700	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1603		1701
1604	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1702	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1605		1703
1606	=back	1704	=back
1607		1705

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs. Revision 1.200 by sf-exg, Wed Aug 10 07:28:35 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.200 by sf-exg, Wed Aug 10 07:28:35 2011 UTC