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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC vs. Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC vs.
Revision 1.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC