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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC vs.
Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC vs. Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC vs.
Revision 1.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC