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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
124	I<Please address all transparency related issues to Sasha Vasko at	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	132	future versions.
126		133
127	=item B<-fade> I<number>	134	=item B<-fade> I<number>
128		135
129	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
130	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
135	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
136	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
137		144
138	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
139		146
140	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
141	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
142	non-tiled backgrounds, currently. See also the B<-sh> option that can be
143	used to brighten or darken the image in addition to tinting it.
144	Please note that certain tint colours can be applied on the server-side,
145	thus yielding performance gain of two orders of magnitude. These colours are:
146	blue, red, green, cyan, magenta, yellow, and those close to them; resource
147	I<tintColor>. Example:
148
149	@@RXVT_NAME@@ -tr -tint blue -sh 40
150		149
151	=item B<-sh> I<number>	150	=item B<-sh> I<number>
152		151
153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
154	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
155	resource I<shading>.
156
157	=item B<-blt> I<string>
158
159	Specify background blending type. If background pixmap is specified
160	at the same time as transparency - such pixmap will be blended over
161	transparency image, using method specified. Supported values are :
162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165	alpha-blending; resource I<blendType>.
166		154
167	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
168		156
169	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
170	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
171	horizontal radii are considered to be the same. Setting one of the	159	horizontal radii are considered to be the same. Setting one of the
172	radii to 1 and another to a large number creates interesting effects	160	radii to 1 and the other to a large number creates interesting effects
173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
		163	resource I<blurRadius>.
		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
174		170
175	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
176		172
177	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
178		174
179	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
180		176
181	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
182		178
183	=item B<-pixmap> I<file[;geom]>	179	=item B<-pixmap> I<file[;oplist]>
184		180
185	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
186	optionally specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
187	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
188	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
189		185
190	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
191		187
…		…
238	italic> >> characters are to be printed. See resource B<boldItalicFont>	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
239	for details.	235	for details.
240		236
241	=item B<-is>\|B<+is>	237	=item B<-is>\|B<+is>
242		238
243	Compile I<font-styles>: Bold/Italic font styles imply high intensity	239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
244	foreground/background (default). See resource B<intensityStyles> for	240	foreground/background (default). See resource B<intensityStyles> for
245	details.	241	details.
246		242
247	=item B<-name> I<name>	243	=item B<-name> I<name>
248		244
…		…
266		262
267	=item B<-sb>\|B<+sb>	263	=item B<-sb>\|B<+sb>
268		264
269	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
270		266
		267	=item B<-sr>\|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>\|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
271	=item B<-si>\|B<+si>	276	=item B<-si>\|B<+si>
272		277
273	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
274	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
275		280
…		…
281	=item B<-sw>\|B<+sw>	286	=item B<-sw>\|B<+sw>
282		287
283	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
284	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
285	B<scrollWithBuffer>.	290	B<scrollWithBuffer>.
286
287	=item B<-sr>\|B<+sr>
288
289	Put scrollbar on right/left; resource B<scrollBar_right>.
290
291	=item B<-st>\|B<+st>
292
293	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294	resource B<scrollBar_floating>.
295		291
296	=item B<-ptab>\|B<+ptab>	292	=item B<-ptab>\|B<+ptab>
297		293
298	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
299	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
303		299
304	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
305		301
306	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
307		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
308	=item B<-iconic>	308	=item B<-iconic>
309		309
310	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
311	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
312		312
…		…
328		328
329	=item B<-bl>	329	=item B<-bl>
330		330
331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
332	if honoured by the WM, the rxvt-unicode window will not have window	332	if honoured by the WM, the rxvt-unicode window will not have window
333	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
334		335
335	=item B<-override-redirect>	336	=item B<-override-redirect>
336		337
337	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
338	B<override-redirect>.	339	B<override-redirect>.
…		…
347	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
348		349
349	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
350	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
351	B<lineSpace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
352		360
353	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
354		362
355	This option specifies the name of the terminal type to be set in the	363	This option specifies the name of the terminal type to be set in the
356	B<TERM> environment variable. This terminal type must exist in the	364	B<TERM> environment variable. This terminal type must exist in the
…		…
411		419
412	=item B<-tcw>	420	=item B<-tcw>
413		421
414	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
415	button. Only effective when the original (non-perl) selection code is	423	button. Only effective when the original (non-perl) selection code is
416	in-use. Instead of selecting a full line it will extend the selection the	424	in-use. Instead of selecting a full line it will extend the selection to
417	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
418		426
419	=item B<-insecure>	427	=item B<-insecure>
420		428
421	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
422	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
442		450
443	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
444	will not immediately destroy its window when the program executed within	452	will not immediately destroy its window when the program executed within
445	it exits. Instead, it will wait till it is being killed or closed by the	453	it exits. Instead, it will wait till it is being killed or closed by the
446	user; resource B<hold>.	454	user; resource B<hold>.
		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
		461
		462	=item B<-xrm> I<string>
		463
		464	Works like the X Toolkit option of the same name, by adding the I<string>
		465	as if it were specified in a resource file. Resource values specified this
		466	way take precedence over all other resource specifications.
		467
		468	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		469	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		470	options can be specified as long-options on the commandline, so use
		471	of B<-xrm> is mostly limited to cases where you want to specify other
		472	resources (e.g. for input methods) or for compatibility with other
		473	programs.
447		474
448	=item B<-keysym.>I<sym> I<string>	475	=item B<-keysym.>I<sym> I<string>
449		476
450	Remap a key symbol. See resource B<keysym>.	477	Remap a key symbol. See resource B<keysym>.
451		478
…		…
486	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	513	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
487	entries and will not tinker with pty/tty permissions - you have to do that	514	entries and will not tinker with pty/tty permissions - you have to do that
488	yourself if you want that.	515	yourself if you want that.
489		516
490	As an extremely special case, specifying C<-1> will completely suppress	517	As an extremely special case, specifying C<-1> will completely suppress
491	pty/tty operations.	518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
492		520
493	Here is a example in perl that illustrates how this option can be used (a	521	Here is a example in perl that illustrates how this option can be used (a
494	longer example is in F<doc/pty-fd>):	522	longer example is in F<doc/pty-fd>):
495		523
496	use IO::Pty;	524	use IO::Pty;
…		…
510	Comma-separated list of perl extension scripts to use (or not to use) in	538	Comma-separated list of perl extension scripts to use (or not to use) in
511	this terminal instance. See resource B<perl-ext> for details.	539	this terminal instance. See resource B<perl-ext> for details.
512		540
513	=back	541	=back
514		542
515	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
516		544
517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
519		548
520	You can set and change the resources using X11 tools like B<xrdb>. Many	549	You can set and change the resources using X11 tools like B<xrdb>. Many
521	distribution do also load settings from the B<~/.Xresources> file when X	550	distribution do also load settings from the B<~/.Xresources> file when X
522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
524		553
525	1. system-wide app-defaults file, either locale-dependent OR global
526	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
528	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		559	6. resources specified via -xrm on the commandline
530		560
531	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
532	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	562	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
533	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	563	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
534	configured, while the class name B<URxvt> allows resources unique to	564	configured, while the class name B<URxvt> allows resources unique to
…		…
544	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
545		575
546	Compile I<xft>: Attempt to find a visual with the given bit depth;	576	Compile I<xft>: Attempt to find a visual with the given bit depth;
547	option B<-depth>.	577	option B<-depth>.
548		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
		585
549	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
550		587
551	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
552	option B<-geometry>.	589	option B<-geometry>.
553		590
…		…
566	Use the specified colour for the colour value I<n>, where 0-7	603	Use the specified colour for the colour value I<n>, where 0-7
567	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
568	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
569	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
570	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	607	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
571	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
572		609
573	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
574	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
575		612
576	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
587	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
588		625
589	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
590	foreground colour is the default.	627	foreground colour is the default.
591		628
592	=item B<colorRV:> I<colour>
593
594	Use the specified colour as the background for reverse video characters
595	when OPTION_HC is disabled (--disable-frills).
596
597	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
598		630
599	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
600	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
601		643
602	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
603		645
604	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
605	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
612		654
613	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
614		656
615	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
616	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
617	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
618		660
619	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
620		662
621	B<True>: specify that jump scrolling should be used. When receiving lots	663	B<True>: specify that jump scrolling should be used. When receiving lots
622	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
636		678
637	B<False>: specify that everything is to be displayed, even	679	B<False>: specify that everything is to be displayed, even
638	if the refresh is too fast for the human eye to read anything (or the	680	if the refresh is too fast for the human eye to read anything (or the
639	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
640		682
641	=item B<inheritPixmap:> I<boolean>	683	=item B<transparent:> I<boolean>
642		684
643	B<True>: make the background inherit the parent windows' pixmap, giving	685	Turn on/off pseudo-transparency by using the root pixmap as background.
644	artificial transparency. B<False>: do not inherit the parent windows'
645	pixmap.
646		686
647	I<Please note that transparency of any kind if completely unsupported by	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
648	the author. Don't bug him with installation questions!>	688	future versions.
649		689
650	=item B<fading:> I<number>	690	=item B<fading:> I<number>
651		691
652	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
653		693
…		…
656	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
657	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
658		698
659	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
660		700
661	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
662	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
663		706
664	=item B<shading:> I<number>	707	=item B<shading:> I<number>
665		708
666	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
667	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
668		711
669	=item B<blendType:> I<string>	712	=item B<blendType:> I<string>
670		713
671	Specify background blending type; option B<-blt>.	714	Specify background blending type; option B<-blt>.
672		715
673	=item B<blurRadius:> I<number>	716	=item B<blurRadius:> I<number>
674		717
675	Apply Gaussian Blurr with the specified radius to the transparent	718	Apply gaussian blur with the specified radius to the transparent
676	background image; option B<-blr>.	719	background; option B<-blr>.
		720
		721	=item B<iconFile:> I<file>
		722
		723	Set the application icon pixmap; option B<-icon>.
677		724
678	=item B<scrollColor:> I<colour>	725	=item B<scrollColor:> I<colour>
679		726
680	Use the specified colour for the scrollbar [default #B2B2B2].	727	Use the specified colour for the scrollbar [default #B2B2B2].
681		728
…		…
687	=item B<borderColor:> I<colour>	734	=item B<borderColor:> I<colour>
688		735
689	The colour of the border around the text area and between the scrollbar	736	The colour of the border around the text area and between the scrollbar
690	and the text.	737	and the text.
691		738
692	=item B<backgroundPixmap:> I<file[;geom]>	739	=item B<backgroundPixmap:> I<file[;oplist]>
693		740
694	Use the specified image file for the background and also optionally	741	Use the specified image file for the background and also
695	specify its scaling with a geometry string B<WxH+X+Y>,	742	optionally specify a colon separated list of operations to modify it.
696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	743	Supported operations are:
		744
		745	=over 4
		746
		747	=item B<WxH+X+Y>
		748
		749	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
697	and B<"X" / "Y"> locate the image centre (percent).	750	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
698	A scale of 0 displays the image with tiling. A scale of 1 displays the	751	scale of 0 disables scaling. The maximum permitted scale is 1000.
699	image without any scaling. A scale of 2 to 9 specifies an integer	752
700	number of images in that direction. No image will be magnified beyond	753	=item B<op=tile>
701	10 times its original size. The maximum permitted scale is 1000.	754
702	Special string of B<"auto"> used as a geometry will cause image to be	755	enables tiling
703	automatically scaled to match window size.	756
		757	=item B<op=keep-aspect>
		758
		759	maintain the image aspect ratio when scaling
		760
		761	=item B<op=root-align>
		762
		763	use the position of the terminal window relative to the root window as
		764	the image offset, simulating a root window background
		765
		766	=back
		767
		768	The default scale and position setting is C<100x100+50+50>.
		769	Alternatively, a predefined set of templates can be used to achieve
		770	the most common setups:
		771
		772	=over 4
		773
		774	=item B<style=tiled>
		775
		776	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		777
		778	=item B<style=aspect-stretched>
		779
		780	the image is scaled to fill the whole window maintaining the aspect
		781	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		782
		783	=item B<style=stretched>
		784
		785	the image is scaled to fill the whole window. Equivalent to 100x100
		786
		787	=item B<style=centered>
		788
		789	the image is centered with no scaling. Equivalent to 0x0+50+50
		790
		791	=item B<style=root-tiled>
		792
		793	the image is tiled with no scaling and using 'root' positioning.
		794	Equivalent to 0x0:op=tile:op=root-align
		795
		796	=back
		797
		798	If multiple templates are specified the last one wins. Note that a
		799	template overrides all the scale, position and operations settings.
		800
704	If used in conjunction with B<-tr> option - specified pixmap will be	801	If used in conjunction with B<-tr> option, the specified pixmap will be
705	blended over transparency image using either alpha-blending, or any	802	blended over the transparent background using alpha-blending.
706	other blending type, specified with B<-blt "type"> option.
707	[default 0x0+50+50]
708		803
709	=item B<path:> I<path>	804	=item B<path:> I<path>
710		805
711	Specify the colon-delimited search path for finding background image files.	806	Specify the colon-delimited search path for finding background image files.
712		807
…		…
739	it is named first) and thus defines the character cell grid to be 9 pixels	834	it is named first) and thus defines the character cell grid to be 9 pixels
740	wide and 15 pixels high.	835	wide and 15 pixels high.
741		836
742	The second font is just used to add additional unicode characters not in	837	The second font is just used to add additional unicode characters not in
743	the base font, likewise the third, which is unfortunately non-bold, but	838	the base font, likewise the third, which is unfortunately non-bold, but
744	the bold version of the font does contain less characters, so this is a	839	the bold version of the font does contain fewer characters, so this is a
745	useful supplement.	840	useful supplement.
746		841
747	The third font is an Xft font with aliasing turned off, and the characters	842	The third font is an Xft font with aliasing turned off, and the characters
748	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	843	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
749	contains other characters, but we are not interested in them.	844	contains other characters, but we are not interested in them.
…		…
773	text font will being used for the given style.	868	text font will being used for the given style.
774		869
775	=item B<intensityStyles:> I<boolean>	870	=item B<intensityStyles:> I<boolean>
776		871
777	When font styles are not enabled, or this option is enabled (B<True>,	872	When font styles are not enabled, or this option is enabled (B<True>,
778	option B<-is>, the default), bold and italic font styles imply high	873	option B<-is>, the default), bold/blink font styles imply high
779	intensity foreground/background colours. Disabling this option (B<False>,	874	intensity foreground/background colours. Disabling this option (B<False>,
780	option B<+is>) disables this behaviour, the high intensity colours are not	875	option B<+is>) disables this behaviour, the high intensity colours are not
781	reachable.	876	reachable.
782		877
783	=item B<selectstyle:> I<mode>
784
785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
786	is xterm style with 2.20 old word selection, or anything else which
787	gives xterm style selection. Only effective when the original (non-perl)
788	selection code is in use.
789
790	=item B<scrollstyle:> I<mode>
791
792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793	the author's favourite.
794
795	=item B<title:> I<string>	878	=item B<title:> I<string>
796		879
797	Set window title string, the default title is the command-line	880	Set window title string, the default title is the command-line
798	specified after the B<-e> option, if any, otherwise the application	881	specified after the B<-e> option, if any, otherwise the application
799	name; option B<-title>.	882	name; option B<-title>.
…		…
812	=item B<urgentOnBell:> I<boolean>	895	=item B<urgentOnBell:> I<boolean>
813		896
814	B<True>: set the urgency hint for the wm on receipt of a bell character.	897	B<True>: set the urgency hint for the wm on receipt of a bell character.
815	B<False>: do not set the urgency hint [default].	898	B<False>: do not set the urgency hint [default].
816		899
		900	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		901
817	=item B<visualBell:> I<boolean>	902	=item B<visualBell:> I<boolean>
818		903
819	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	904	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
820	B<False>: no visual bell [default]; option B<+vb>.	905	B<False>: no visual bell [default]; option B<+vb>.
821		906
…		…
844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	929	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845		930
846	This creates a new file in your home directory with the screen contents	931	This creates a new file in your home directory with the screen contents
847	every time you hit C<Print>.	932	every time you hit C<Print>.
848		933
		934	=item B<scrollstyle:> I<mode>
		935
		936	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		937	the author's favourite.
		938
		939	=item B<thickness:> I<number>
		940
		941	Set the scrollbar width in pixels.
		942
849	=item B<scrollBar:> I<boolean>	943	=item B<scrollBar:> I<boolean>
850		944
851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	945	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852	disable the scrollbar; option B<+sb>.	946	disable the scrollbar; option B<+sb>.
853		947
…		…
872	B<False>: do not scroll to bottom when tty receives output; option	966	B<False>: do not scroll to bottom when tty receives output; option
873	B<+si>.	967	B<+si>.
874		968
875	=item B<scrollWithBuffer:> I<boolean>	969	=item B<scrollWithBuffer:> I<boolean>
876		970
877	B<True>: scroll with scrollback buffer when tty receives new lines (and	971	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
878	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	972	try to show the same lines) and B<scrollTtyOutput> is False; option
879	with scrollback buffer when tty receives new lines; option B<+sw>.	973	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		974	new lines; option B<+sw>.
880		975
881	=item B<scrollTtyKeypress:> I<boolean>	976	=item B<scrollTtyKeypress:> I<boolean>
882		977
883	B<True>: scroll to bottom when a non-special key is pressed. Special keys	978	B<True>: scroll to bottom when a non-special key is pressed. Special keys
884	are those which are intercepted by rxvt-unicode for special handling and	979	are those which are intercepted by rxvt-unicode for special handling and
…		…
940	=item B<cursorBlink:> I<boolean>	1035	=item B<cursorBlink:> I<boolean>
941		1036
942	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1037	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
943	option B<-bc>.	1038	option B<-bc>.
944		1039
		1040	=item B<cursorUnderline:> I<boolean>
		1041
		1042	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1043	option B<-uc>.
		1044
945	=item B<pointerBlank:> I<boolean>	1045	=item B<pointerBlank:> I<boolean>
946		1046
947	B<True>: blank the pointer when a key is pressed or after a set number	1047	B<True>: blank the pointer when a key is pressed or after a set number
948	of seconds of inactivity. B<False>: the pointer is always visible	1048	of seconds of inactivity. B<False>: the pointer is always visible
949	[default].	1049	[default].
…		…
962	large number (e.g. C<987654321>) to effectively disable the timeout.	1062	large number (e.g. C<987654321>) to effectively disable the timeout.
963		1063
964	=item B<backspacekey:> I<string>	1064	=item B<backspacekey:> I<string>
965		1065
966	The string to send when the backspace key is pressed. If set to B<DEC>	1066	The string to send when the backspace key is pressed. If set to B<DEC>
967	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1067	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
968	(code 8) - which can be reversed with the appropriate DEC private mode	1068	(code 8) - which can be reversed with the appropriate DEC private mode
969	escape sequence.	1069	escape sequence.
970		1070
971	=item B<deletekey:> I<string>	1071	=item B<deletekey:> I<string>
972		1072
…		…
985	will be created). In this mode, characters outside ISO-8859-1 can be used.	1085	will be created). In this mode, characters outside ISO-8859-1 can be used.
986		1086
987	When the selection extension is not used, only ISO-8859-1 characters can	1087	When the selection extension is not used, only ISO-8859-1 characters can
988	be used. If not specified, the built-in default is used:	1088	be used. If not specified, the built-in default is used:
989		1089
990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1090	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
991		1091
992	=item B<preeditType:> I<style>	1092	=item B<preeditType:> I<style>
993		1093
994	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1094	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995		1095
…		…
1051		1151
1052	=item B<secondaryScroll:> I<boolean>	1152	=item B<secondaryScroll:> I<boolean>
1053		1153
1054	Turn on/off secondary screen scroll (default enabled). If this	1154	Turn on/off secondary screen scroll (default enabled). If this
1055	option is enabled, scrolls on the secondary screen will change the	1155	option is enabled, scrolls on the secondary screen will change the
1056	scrollback buffer and switching to/from the secondary screen will	1156	scrollback buffer and, when secondaryScreen is off, switching
1057	instead scroll the screen up.	1157	to/from the secondary screen will instead scroll the screen up.
1058		1158
1059	=item B<hold>: I<boolean>	1159	=item B<hold>: I<boolean>
1060		1160
1061	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1161	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1062	will not immediately destroy its window when the program executed within	1162	will not immediately destroy its window when the program executed within
1063	it exits. Instead, it will wait till it is being killed or closed by the	1163	it exits. Instead, it will wait till it is being killed or closed by the
1064	user.	1164	user.
		1165
		1166	=item B<chdir>: I<path>
		1167
		1168	Sets the working directory for the shell (or the command specified via
		1169	B<-e>). The I<path> must be an absolute path and it must exist for
		1170	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1171	directory will be used; option B<-cd>.
1065		1172
1066	=item B<keysym.>I<sym>: I<string>	1173	=item B<keysym.>I<sym>: I<string>
1067		1174
1068	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1175	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1069	intervening resource name B<keysym.> cannot be omitted.	1176	intervening resource name B<keysym.> cannot be omitted.
…		…
1084	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1191	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1085	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1192	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1086	performed in an exact manner; however, the closest match is assured.	1193	performed in an exact manner; however, the closest match is assured.
1087		1194
1088	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1195	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1089	number), see RESOURCES in C<man 7 X> for futher details.	1196	number), see RESOURCES in C<man 7 X> for further details.
1090		1197
1091	You can define a range of keysyms in one shot by providing a I<string>	1198	You can define a range of keysyms in one shot by
		1199	loading the C<keysym-list> perl extension and providing a I<string>
1092	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1200	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1093	should be a character not used by the strings.	1201	should be a character not used by the strings.
1094		1202
1095	Its usage can be demonstrated by an example:	1203	Its usage can be demonstrated by an example:
1096		1204
1097	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1205	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1098		1206
1099	The above line is equivalent to the following three lines:	1207	The above line is equivalent to the following three lines:
1100		1208
1101	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1209	URxvt.keysym.Meta-Control-0x61: \033<a>
1102	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1210	URxvt.keysym.Meta-Control-0x62: \033<b>
1103	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1211	URxvt.keysym.Meta-Control-0x63: \033<c>
1104		1212
1105	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1213	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1106	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1214	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1107	example the following means "change the current locale to C<zh_CN.GBK>	1215	example the following means "change the current locale to C<zh_CN.GBK>
1108	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
1109		1217
1110	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1218	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1111		1219
1112	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1220	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1113	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1221	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1114	manpage. For example, the F<selection> extension (activated via	1222	manpage. For example, the F<selection> extension (activated via
1115	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1223	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1116		1224
1117	URxvt.keysym.M-C-c: perl:selection:rot13	1225	URxvt.keysym.M-C-c: perl:selection:rot13
1118		1226
1119	Due the the large number of modifier combinations, a defined key mapping	1227	Due the the large number of modifier combinations, a defined key mapping
1120	will match if at I<at least> the specified identifiers are being set, and	1228	will match if I<at least> the specified identifiers are being set, and
1121	no other key mappings with those and more bits are being defined. That	1229	no other key mappings with those and more bits are being defined. That
1122	means that defining a key map for C<a> will automatically provide	1230	means that defining a key map for C<a> will automatically provide
1123	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1231	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1124	mappings themselves.	1232	mappings themselves.
1125		1233
…		…
1176	all instances, while B<perl-ext> is used for specific instances.	1284	all instances, while B<perl-ext> is used for specific instances.
1177		1285
1178	=item B<perl-eval>: I<string>	1286	=item B<perl-eval>: I<string>
1179		1287
1180	Perl code to be evaluated when all extensions have been registered. See	1288	Perl code to be evaluated when all extensions have been registered. See
1181	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1289	the @@RXVT_NAME@@perl(3) manpage.
1182	will be ignored when running setuid/setgid.
1183		1290
1184	=item B<perl-lib>: I<path>	1291	=item B<perl-lib>: I<path>
1185		1292
1186	Colon-separated list of additional directories that hold extension	1293	Colon-separated list of additional directories that hold extension
1187	scripts. When looking for extensions specified by the C<perl> resource,	1294	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1188	@@RXVT_NAME@@ will first look in these directories and then in	1295	look in these directories, then in $HOME/.urxvt/ext and lastly in
1189	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1296	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1190	will be ignored when running setuid/setgid.
1191		1297
1192	See the @@RXVT_NAME@@perl(3) manpage.	1298	See the @@RXVT_NAME@@perl(3) manpage.
1193		1299
1194	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1300	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1195		1301
…		…
1217		1323
1218	=item B<override-redirect>: I<boolean>	1324	=item B<override-redirect>: I<boolean>
1219		1325
1220	Compile I<frills>: Sets override-redirect for the terminal window, making	1326	Compile I<frills>: Sets override-redirect for the terminal window, making
1221	it almost invisible to window managers; option B<-override-redirect>.	1327	it almost invisible to window managers; option B<-override-redirect>.
		1328
		1329	=item B<iso14755:> I<boolean>
		1330
		1331	Turn on/off ISO 14755 (default enabled).
1222		1332
1223	=item B<iso14755_52:> I<boolean>	1333	=item B<iso14755_52:> I<boolean>
1224		1334
1225	Turn on/off ISO 14755 5.2 mode (default enabled).	1335	Turn on/off ISO 14755 5.2 mode (default enabled).
1226		1336
…		…
1369	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1479	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1370	it can be seen via the I<who(1)> command, and can accept messages. To	1480	it can be seen via the I<who(1)> command, and can accept messages. To
1371	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1481	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1372	on some systems or setgid to root or to some other group on others.	1482	on some systems or setgid to root or to some other group on others.
1373		1483
1374	=head1 COLORS AND GRAPHICS	1484	=head1 COLOURS AND GRAPHICS
1375		1485
1376	In addition to the default foreground and background colours,	1486	In addition to the default foreground and background colours,
1377	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1487	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1378	high-intensity bold/blink versions of the same). Here is a list of the	1488	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1379	colours with their names.	1489	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1490	cube plus a 8 (24) colour greyscale ramp.
		1491
		1492	Here is a list of the ANSI colours with their names.
1380		1493
1381	=begin table	1494	=begin table
1382		1495
1383	B<color0> (black) = Black	1496	B<color0> (black) = Black
1384	B<color1> (red) = Red3	1497	B<color1> (red) = Red3
…		…
1404	It is also possible to specify the colour values of B<foreground>,	1517	It is also possible to specify the colour values of B<foreground>,
1405	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1518	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1406	a number 0-15, as a convenient shorthand to reference the colour name of	1519	a number 0-15, as a convenient shorthand to reference the colour name of
1407	color0-color15.	1520	color0-color15.
1408		1521
1409	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1522	The following text gives values for the standard 88 colour mode (and
1410	additional 72 colours. The first 64 of those (with indices 16 to 79)	1523	values for the 256 colour mode in parentheses).
1411	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1412	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1413		1524
		1525	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1526
		1527	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1528	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1529
		1530	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1531	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1532	the RGB cube.
		1533
1414	Together, all those colours implement the 88 colour xterm colours. Only	1534	Together, all those colours implement the 88 (256) colour xterm
1415	the first 16 can be changed using resources currently, the rest can only	1535	colours. Only the first 16 can be changed using resources currently, the
1416	be changed via command sequences ("escape codes").	1536	rest can only be changed via command sequences ("escape codes").
		1537
		1538	Applications are advised to use terminfo or command sequences to discover
		1539	number and RGB values of all colours (yes, you can query this...).
1417		1540
1418	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1541	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1419	always swapping the foreground/background colours. This is in contrast to	1542	always swapping the foreground/background colours. This is in contrast to
1420	I<xterm>(1) where the colours are only swapped if they have not otherwise	1543	I<xterm>(1) where the colours are only swapped if they have not otherwise
1421	been specified. For example,	1544	been specified. For example,
1422		1545
1423	=over 4
1424
1425	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1546	@@RXVT_NAME@@ -fg Black -bg White -rv
1426		1547
1427	would yield White on Black, while on I<xterm>(1) it would yield Black	1548	would yield White on Black, while on I<xterm>(1) it would yield Black on
1428	on White.	1549	White.
1429
1430	=back
1431		1550
1432	=head2 ALPHA CHANNEL SUPPORT	1551	=head2 ALPHA CHANNEL SUPPORT
1433		1552
1434	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1553	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1435	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1554	their act together, rxvt-unicode will do its own alpha channel management:
1436	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1555
1437	in addition to the ones provided by X, where the additional A component	1556	You can prefix any colour with an opaqueness percentage enclosed in
		1557	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1558	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1559	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1560	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1561	is the recommended format to specify transparency values, and works with
		1562	all ways to specify a colour.
		1563
		1564	For complete control, rxvt-unicode also supports
		1565	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1566	specifications, where the additional C<aaaa> component specifies opacity
1438	specifies opacity (alpha) values. The minimum value of C<0> is completely	1567	(alpha) values. The minimum value of C<0000> is completely transparent,
1439	transparent). You can also prefix any color with C<[percent]>, where	1568	while C<ffff> is completely opaque). The two example colours from
1440	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1569	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1441	the color, where C<0> is completely transparent and C<100> is completelxy	1570	C<rgba:0000/ff00/0000/f332>.
1442	opaque.
1443		1571
1444	You probably need to specify B<"-depth 32">, too, and have the luck that	1572	You probably need to specify B<"-depth 32">, too, to force a visual with
1445	your X-server uses ARGB pixel layout, as X is far from just supporting	1573	alpha channels, and have the luck that your X-server uses ARGB pixel
1446	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1574	layout, as X is far from just supporting ARGB visuals out of the box, and
		1575	rxvt-unicode just fudges around.
1447		1576
1448	For example, the following selects an almost completely transparent red	1577	For example, the following selects an almost completely transparent black
1449	background, and an almost opaque pink foreground:	1578	background, and an almost opaque pink foreground:
1450		1579
1451	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1580	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1452		1581
1453	I<Please note that transparency of any kind if completely unsupported by	1582	When not using a background image, then the interpretation of the
1454	the author. Don't bug him with installation questions!>	1583	alpha channel is up to your compositing manager (most interpret it as
		1584	transparency of course).
		1585
		1586	When using a background pixmap or pseudo-transparency, then the background
		1587	colour will always behave as if it were completely transparent (so the
		1588	background image shows instead), regardless of how it was specified, while
		1589	other colours will either be transparent as specified (the background
		1590	image will show through) on servers supporting the RENDER extension, or
		1591	fully opaque on servers not supporting the RENDER EXTENSION.
		1592
		1593	Please note that due to bugs in Xft, specifying alpha values might result
		1594	in garbage being displayed when the X-server does not support the RENDER
		1595	extension.
1455		1596
1456	=head1 ENVIRONMENT	1597	=head1 ENVIRONMENT
1457		1598
1458	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1599	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1459		1600
…		…
1465	resources or on the command line.	1606	resources or on the command line.
1466		1607
1467	=item B<COLORTERM>	1608	=item B<COLORTERM>
1468		1609
1469	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1610	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1470	compiled with background image support, and optionally with the added	1611	compiled with background image support, and optionally with the added
1471	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1612	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472	screen.	1613	screen.
1473		1614
1474	=item B<COLORFGBG>	1615	=item B<COLORFGBG>
1475		1616
1476	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1617	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1477	the colour code used as default foreground/text colour (or the string	1618	the colour code used as default foreground/text colour (or the string
1478	C<default> to indicate that the default-colour escape sequence is to be	1619	C<default> to indicate that the default-colour escape sequence is to be
1479	used), C<bg> is the colour code used as default background colour (or the	1620	used), C<bg> is the colour code used as default background colour (or the
1480	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1621	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1481	was compiled with background image support. Libraries like C<ncurses>	1622	was compiled with background image support. Libraries like C<ncurses>
1482	and C<slang> can (and do) use this information to optimize screen output.	1623	and C<slang> can (and do) use this information to optimize screen output.
1483		1624
1484	=item B<WINDOWID>	1625	=item B<WINDOWID>
1485		1626
1486	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1627	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1493	C<--with-terminfo=PATH>.	1634	C<--with-terminfo=PATH>.
1494		1635
1495	=item B<DISPLAY>	1636	=item B<DISPLAY>
1496		1637
1497	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1638	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1498	display in its child processes.	1639	display in its child processes if C<-display> isn't used to override. It
		1640	defaults to C<:0> if it doesn't exist.
1499		1641
1500	=item B<SHELL>	1642	=item B<SHELL>
1501		1643
1502	The shell to be used for command execution, defaults to C</bin/sh>.	1644	The shell to be used for command execution, defaults to C</bin/sh>.
1503		1645
1504	=item B<RXVT_SOCKET>	1646	=item B<RXVT_SOCKET>
1505		1647
1506	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1648	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1507	@@RXVT_NAME@@d(1).	1649	@@RXVT_NAME@@d(1).
1508		1650
1509	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1651	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1510		1652
1511	=item B<HOME>	1653	=item B<HOME>
1512		1654
1513	Used to locate the default directory for the unix domain socket for	1655	Used to locate the default directory for the unix domain socket for
1514	daemon communications and to locate various resource files (such as	1656	daemon communications and to locate various resource files (such as
1515	C<.Xdefaults>)	1657	C<.Xdefaults>)
1516		1658
1517	=item B<XAPPLRESDIR>	1659	=item B<XAPPLRESDIR>
1518		1660
1519	Directory where various X resource files are being located.	1661	Directory where application-specific X resource files are located.
1520		1662
1521	=item B<XENVIRONMENT>	1663	=item B<XENVIRONMENT>
1522		1664
1523	If set and accessible, gives the name of a X resource file to be loaded by	1665	If set and accessible, gives the name of a X resource file to be loaded by
1524	@@RXVT_NAME@@.	1666	@@RXVT_NAME@@.
…		…
1529		1671
1530	=over 4	1672	=over 4
1531		1673
1532	=item B</usr/lib/X11/rgb.txt>	1674	=item B</usr/lib/X11/rgb.txt>
1533		1675
1534	Color names.	1676	Colour names.
1535		1677
1536	=back	1678	=back
1537		1679
1538	=head1 SEE ALSO	1680	=head1 SEE ALSO
1539		1681
…		…
1578	Project Coordinator (changes.txt 2.21a to 2.4.5)	1720	Project Coordinator (changes.txt 2.21a to 2.4.5)
1579		1721
1580	=item Geoff Wing L<< <gcw@pobox.com> >>	1722	=item Geoff Wing L<< <gcw@pobox.com> >>
1581		1723
1582	Rewrote screen display and text selection routines.	1724	Rewrote screen display and text selection routines.
1583		1725
1584	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1726	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1585		1727
1586	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1728	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1587		1729
1588	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1730	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1590		1732
1591	Project Coordinator (Changes 1.0 -)	1733	Project Coordinator (Changes 1.0 -)
1592		1734
1593	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1735	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1594		1736
1595	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1737	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1596		1738
1597	=back	1739	=back
1598		1740

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs. Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC