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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 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<frills>: 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
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
103	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
104		117
105	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
106		119
107	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
…		…
116		129
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		131
119	=item B<-tr>\|B<+tr>	132	=item B<-tr>\|B<+tr>
120		133
121	Turn on/off illusion of a transparent window background. Obsolete form of it is	134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123		135
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be	136	B<-ip> is still accepted as an obsolete alias but will be removed in
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will	137	future versions.
126	be phased out in future versions of rxvt!>
127
128	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		138
131	=item B<-fade> I<number>	139	=item B<-fade> I<number>
132		140
133	Fade the text by the given percentage when focus is lost. Small values	141	Fade the text by the given percentage when focus is lost. Small values
134	fade a little only, 100 completely replaces all colours by the fade	142	fade a little only, 100 completely replaces all colours by the fade
…		…
139	Fade to this colour when fading is used (see B<-fade>). The default colour	147	Fade to this colour when fading is used (see B<-fade>). The default colour
140	is opaque black. resource B<fadeColor>.	148	is opaque black. resource B<fadeColor>.
141		149
142	=item B<-tint> I<colour>	150	=item B<-tint> I<colour>
143		151
144	Tint the transparent background pixmap with the given colour when	152	Tint the transparent background with the given colour;
145	transparency is enabled with B<-tr>. This only works for	153	resource I<tintColor>.
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
147	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentially mean no tinting; resource
152	I<tintColor>. Example:
153
154	@@RXVT_NAME@@ -tr -tint blue -sh 40
155		154
156	=item B<-sh> I<number>	155	=item B<-sh> I<number>
157		156
158	Darken (0 .. 100) or lighten (100 .. 200) the transparent	157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
159	background image in addition to (or instead of) tinting it;	158	A value of 100 means no shading; resource I<shading>.
160	resource I<shading>.
161
162	=item B<-blt> I<string>
163
164	Specify background blending type. If background pixmap is specified
165	at the same time as transparency - such pixmap will be blended over
166	transparency image, using method specified. Supported values are :
167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170	alpha-blending. Compile I<afterimage>; resource I<blendType>.
171		159
172	=item B<-blr> I<HxV>	160	=item B<-blr> I<HxV>
173		161
174	Apply Gaussian Blur with the specified radii to the transparent	162	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and	163	background. If a single number is specified, the vertical and
176	horizontal radii are considered to be the same. Setting one of the	164	horizontal radii are considered to be the same. Setting one of the
177	radii to 1 and another to a large number creates interesting effects	165	radii to 1 and the other to a large number creates interesting effects
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	166	on some backgrounds. The maximum radius value is 128. An horizontal or
		167	vertical radius of 0 disables blurring;
179	resource I<blurRadius>.	168	resource I<blurRadius>.
180		169
		170	=item B<-icon> I<file>
		171
		172	Compile I<pixbuf>: Use the specified image as application icon. This
		173	is used by many window managers, taskbars and pagers to represent the
		174	application window; resource I<iconFile>.
		175
181	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
182		177
183	Window background colour; resource B<background>.	178	Window background colour; resource B<background>.
184		179
185	=item B<-fg> I<colour>	180	=item B<-fg> I<colour>
186		181
187	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
188		183
189	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	184	=item B<-pixmap> I<file[;oplist]>
190		185
191	Compile I<afterimage>: Specify image file for the background and also	186	Compile I<pixbuf>: Specify image file for the background and also
192	optionally specify its scaling with a geometry string. Note you may need to	187	optionally specify a list of operations to modify it. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the	188	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
195		190
196	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
197		192
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	239	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	240	for details.
246		241
247	=item B<-is>\|B<+is>	242	=item B<-is>\|B<+is>
248		243
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	244	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	245	foreground/background (default). See resource B<intensityStyles> for
251	details.	246	details.
252		247
253	=item B<-name> I<name>	248	=item B<-name> I<name>
254		249
…		…
272		267
273	=item B<-sb>\|B<+sb>	268	=item B<-sb>\|B<+sb>
274		269
275	Turn on/off scrollbar; resource B<scrollBar>.	270	Turn on/off scrollbar; resource B<scrollBar>.
276		271
		272	=item B<-sr>\|B<+sr>
		273
		274	Put scrollbar on right/left; resource B<scrollBar_right>.
		275
		276	=item B<-st>\|B<+st>
		277
		278	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		279	resource B<scrollBar_floating>.
		280
277	=item B<-si>\|B<+si>	281	=item B<-si>\|B<+si>
278		282
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	283	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	284	B<scrollTtyOutput> has opposite effect.
281		285
…		…
287	=item B<-sw>\|B<+sw>	291	=item B<-sw>\|B<+sw>
288		292
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	293	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	294	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	295	B<scrollWithBuffer>.
292
293	=item B<-sr>\|B<+sr>
294
295	Put scrollbar on right/left; resource B<scrollBar_right>.
296
297	=item B<-st>\|B<+st>
298
299	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300	resource B<scrollBar_floating>.
301		296
302	=item B<-ptab>\|B<+ptab>	297	=item B<-ptab>\|B<+ptab>
303		298
304	If enabled (default), "Horizontal Tab" characters are being stored as	299	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	300	actual wide characters in the screen buffer, which makes it possible to
…		…
309		304
310	=item B<-bc>\|B<+bc>	305	=item B<-bc>\|B<+bc>
311		306
312	Blink the cursor; resource B<cursorBlink>.	307	Blink the cursor; resource B<cursorBlink>.
313		308
		309	=item B<-uc>\|B<+uc>
		310
		311	Make the cursor underlined; resource B<cursorUnderline>.
		312
314	=item B<-iconic>	313	=item B<-iconic>
315		314
316	Start iconified, if the window manager supports that option.	315	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	316	Alternative form is B<-ic>.
318		317
…		…
334		333
335	=item B<-bl>	334	=item B<-bl>
336		335
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	336	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
338	if honoured by the WM, the rxvt-unicode window will not have window	337	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	338	decorations; resource B<borderLess>. If the window manager does not
		339	support MWM hints (e.g. kwin), enables override-redirect mode.
340		340
341	=item B<-override-redirect>	341	=item B<-override-redirect>
342		342
343	Compile I<frills>: Sets override-redirect on the window; resource	343	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	344	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	353	=item B<-lsp> I<number>
354		354
355	Compile I<frills>: Lines (pixel height) to insert between each row of	355	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	356	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	357	B<lineSpace>.
		358
		359	=item B<-letsp> I<number>
		360
		361	Compile I<frills>: Amount to adjust the computed character width by
		362	to control overall letter spacing. Negative values will tighten up the
		363	letter spacing, positive values will space letters out more. Useful to
		364	work around odd font metrics; resource B<letterSpace>.
358		365
359	=item B<-tn> I<termname>	366	=item B<-tn> I<termname>
360		367
361	This option specifies the name of the terminal type to be set in the	368	This option specifies the name of the terminal type to be set in the
362	B<TERM> environment variable. This terminal type must exist in the	369	B<TERM> environment variable. This terminal type must exist in the
…		…
417		424
418	=item B<-tcw>	425	=item B<-tcw>
419		426
420	Change the meaning of triple-click selection with the left mouse	427	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	428	button. Only effective when the original (non-perl) selection code is
422	in-use. Instead of selecting a full line it will extend the selection the	429	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	430	the end of the logical line only. resource B<tripleclickwords>.
424		431
425	=item B<-insecure>	432	=item B<-insecure>
426		433
427	Enable "insecure" mode, which currently enables most of the escape	434	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	435	sequences that echo strings. See the resource B<insecure> for more
…		…
448		455
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	457	will not immediately destroy its window when the program executed within
451	it exits. Instead, it will wait till it is being killed or closed by the	458	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	459	user; resource B<hold>.
		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
453		466
454	=item B<-xrm> I<string>	467	=item B<-xrm> I<string>
455		468
456	Works like the X Toolkit option of the same name, by adding the I<string>	469	Works like the X Toolkit option of the same name, by adding the I<string>
457	as if it were specified in a resource file. Resource values specified this	470	as if it were specified in a resource file. Resource values specified this
…		…
505	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	518	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
506	entries and will not tinker with pty/tty permissions - you have to do that	519	entries and will not tinker with pty/tty permissions - you have to do that
507	yourself if you want that.	520	yourself if you want that.
508		521
509	As an extremely special case, specifying C<-1> will completely suppress	522	As an extremely special case, specifying C<-1> will completely suppress
510	pty/tty operations.	523	pty/tty operations, which is probably only useful in conjunction with some
		524	perl extension that manages the terminal.
511		525
512	Here is a example in perl that illustrates how this option can be used (a	526	Here is a example in perl that illustrates how this option can be used (a
513	longer example is in F<doc/pty-fd>):	527	longer example is in F<doc/pty-fd>):
514		528
515	use IO::Pty;	529	use IO::Pty;
…		…
529	Comma-separated list of perl extension scripts to use (or not to use) in	543	Comma-separated list of perl extension scripts to use (or not to use) in
530	this terminal instance. See resource B<perl-ext> for details.	544	this terminal instance. See resource B<perl-ext> for details.
531		545
532	=back	546	=back
533		547
534	=head1 RESOURCES (available also as long-options)	548	=head1 RESOURCES
535		549
536	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	550	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
537	options) compiled into your version.	551	options) compiled into your version. All resources are also available as
		552	long-options.
538		553
539	You can set and change the resources using X11 tools like B<xrdb>. Many	554	You can set and change the resources using X11 tools like B<xrdb>. Many
540	distribution do also load settings from the B<~/.Xresources> file when X	555	distribution do also load settings from the B<~/.Xresources> file when X
541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
543		558
544	1. system-wide app-defaults file, either locale-dependent OR global
545	2. app-defaults file in $XAPPLRESDIR	559	1. app-defaults file in $XAPPLRESDIR
		560	2. $HOME/.Xdefaults
546	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window of screen 0
547	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES property on root-window of the current screen
548	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549	6. resources specified via -xrm on the commandline	564	6. resources specified via -xrm on the commandline
550		565
551	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
552	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
564	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
565		580
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	581	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	582	option B<-depth>.
568		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
		590
569	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
570		592
571	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	594	option B<-geometry>.
573		595
…		…
586	Use the specified colour for the colour value I<n>, where 0-7	608	Use the specified colour for the colour value I<n>, where 0-7
587	corresponds to low-intensity (normal) colours and 8-15 corresponds to	609	corresponds to low-intensity (normal) colours and 8-15 corresponds to
588	high-intensity (bold = bright foreground, blink = bright background)	610	high-intensity (bold = bright foreground, blink = bright background)
589	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	611	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
590	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	612	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
591	names used are listed in the B<COLORS AND GRAPHICS> section.	613	names used are listed in the B<COLOURS AND GRAPHICS> section.
592		614
593	Colours higher than 15 cannot be set using resources (yet), but can be	615	Colours higher than 15 cannot be set using resources (yet), but can be
594	changed using an escape command (see @@RXVT_NAME@@(7)).	616	changed using an escape command (see @@RXVT_NAME@@(7)).
595		617
596	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	618	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
607	=item B<colorUL:> I<colour>	629	=item B<colorUL:> I<colour>
608		630
609	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	632	foreground colour is the default.
611		633
612	=item B<colorRV:> I<colour>
613
614	Use the specified colour as the background for reverse video characters
615	when OPTION_HC is disabled (--disable-frills).
616
617	=item B<underlineColor:> I<colour>	634	=item B<underlineColor:> I<colour>
618		635
619	If set, use the specified colour as the colour for the underline	636	If set, use the specified colour as the colour for the underline
620	itself. If unset, use the foreground colour.	637	itself. If unset, use the foreground colour.
		638
		639	=item B<highlightColor:> I<colour>
		640
		641	If set, use the specified colour as the background for highlighted
		642	characters. If unset, use reverse video.
		643
		644	=item B<highlightTextColor:> I<colour>
		645
		646	If set and highlightColor is set, use the specified colour as the
		647	foreground for highlighted characters.
621		648
622	=item B<cursorColor:> I<colour>	649	=item B<cursorColor:> I<colour>
623		650
624	Use the specified colour for the cursor. The default is to use the	651	Use the specified colour for the cursor. The default is to use the
625	foreground colour; option B<-cr>.	652	foreground colour; option B<-cr>.
…		…
632		659
633	=item B<reverseVideo:> I<boolean>	660	=item B<reverseVideo:> I<boolean>
634		661
635	B<True>: simulate reverse video by foreground and background colours;	662	B<True>: simulate reverse video by foreground and background colours;
636	option B<-rv>. B<False>: regular screen colours [default]; option	663	option B<-rv>. B<False>: regular screen colours [default]; option
637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	664	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638		665
639	=item B<jumpScroll:> I<boolean>	666	=item B<jumpScroll:> I<boolean>
640		667
641	B<True>: specify that jump scrolling should be used. When receiving lots	668	B<True>: specify that jump scrolling should be used. When receiving lots
642	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	669	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
656		683
657	B<False>: specify that everything is to be displayed, even	684	B<False>: specify that everything is to be displayed, even
658	if the refresh is too fast for the human eye to read anything (or the	685	if the refresh is too fast for the human eye to read anything (or the
659	monitor to display anything); option B<+ss>.	686	monitor to display anything); option B<+ss>.
660		687
661	=item B<inheritPixmap:> I<boolean>	688	=item B<transparent:> I<boolean>
662		689
663	B<True>: make the background inherit the parent windows' pixmap, giving	690	Turn on/off pseudo-transparency by using the root pixmap as background.
664	artificial transparency. B<False>: do not inherit the parent windows'
665	pixmap.
666		691
667	I<Please note that transparency of any kind if completely unsupported by	692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
668	the author. Don't bug him with installation questions!>	693	future versions.
669		694
670	=item B<fading:> I<number>	695	=item B<fading:> I<number>
671		696
672	Fade the text by the given percentage when focus is lost; option B<-fade>.	697	Fade the text by the given percentage when focus is lost; option B<-fade>.
673		698
…		…
676	Fade to this colour, when fading is used (see B<fading:>). The default	701	Fade to this colour, when fading is used (see B<fading:>). The default
677	colour is black; option B<-fadecolor>.	702	colour is black; option B<-fadecolor>.
678		703
679	=item B<tintColor:> I<colour>	704	=item B<tintColor:> I<colour>
680		705
681	Tint the transparent background pixmap with the given colour; option	706	Tint the transparent background with the given colour. If the RENDER
682	B<-tint>.	707	extension is not available only black, red, green, yellow, blue,
		708	magenta, cyan and white tints can be performed server-side. Note that
		709	a black tint yields a completely black image while a white tint yields
		710	the image unchanged; option B<-tint>.
683		711
684	=item B<shading:> I<number>	712	=item B<shading:> I<number>
685		713
686	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
687	in addition to tinting it; option B<-sh>.	715	A value of 100 means no shading; option B<-sh>.
688
689	=item B<blendType:> I<string>
690
691	Specify background blending type; option B<-blt>.
692		716
693	=item B<blurRadius:> I<number>	717	=item B<blurRadius:> I<number>
694		718
695	Apply Gaussian Blurr with the specified radius to the transparent	719	Apply gaussian blur with the specified radius to the transparent
696	background image; option B<-blr>.	720	background; option B<-blr>.
		721
		722	=item B<iconFile:> I<file>
		723
		724	Set the application icon pixmap; option B<-icon>.
697		725
698	=item B<scrollColor:> I<colour>	726	=item B<scrollColor:> I<colour>
699		727
700	Use the specified colour for the scrollbar [default #B2B2B2].	728	Use the specified colour for the scrollbar [default #B2B2B2].
701		729
…		…
707	=item B<borderColor:> I<colour>	735	=item B<borderColor:> I<colour>
708		736
709	The colour of the border around the text area and between the scrollbar	737	The colour of the border around the text area and between the scrollbar
710	and the text.	738	and the text.
711		739
712	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	740	=item B<backgroundPixmap:> I<file[;oplist]>
713		741
714	Use the specified image file for the background and also	742	Use the specified image file for the background and also
715	optionally specify its scaling with a geometry string B<WxH+X+Y>,	743	optionally specify a colon separated list of operations to modify it.
716	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
717	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
718	centre (percent). A scale of 0 displays the image with tiling. A scale
719	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
720	an integer number of images in that direction. No image will be magnified
721	beyond 10 times its original size. The maximum permitted scale is 1000.
722	Additional operations can be specified after colon B<:op1:op2...>.
723	Supported operations are:	744	Supported operations are:
724		745
725	tile force background image to be tiled and not scaled. Equivalent to 0x0,	746	=over 4
726	propscale will scale image keeping proportions,	747
727	auto will scale image to match window size. Equivalent to 100x100;	748	=item B<WxH+X+Y>
728	hscale will scale image horizontally to the window size;	749
729	vscale will scale image vertically to the window size;	750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
730	scale will scale image to match window size;	751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
731	root will tile image as if it was a root window background, auto-adjusting	752	scale of 0 disables scaling.
732	whenever terminal window moves.	753
		754	=item B<op=tile>
		755
		756	enables tiling
		757
		758	=item B<op=keep-aspect>
		759
		760	maintain the image aspect ratio when scaling
		761
		762	=item B<op=root-align>
		763
		764	use the position of the terminal window relative to the root window as
		765	the image offset, simulating a root window background
		766
		767	=back
		768
		769	The default scale and position setting is C<100x100+50+50>.
		770	Alternatively, a predefined set of templates can be used to achieve
		771	the most common setups:
		772
		773	=over 4
		774
		775	=item B<style=tiled>
		776
		777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		778
		779	=item B<style=aspect-stretched>
		780
		781	the image is scaled to fill the whole window maintaining the aspect
		782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		783
		784	=item B<style=stretched>
		785
		786	the image is scaled to fill the whole window. Equivalent to 100x100
		787
		788	=item B<style=centered>
		789
		790	the image is centered with no scaling. Equivalent to 0x0+50+50
		791
		792	=item B<style=root-tiled>
		793
		794	the image is tiled with no scaling and using 'root' positioning.
		795	Equivalent to 0x0:op=tile:op=root-align
		796
		797	=back
		798
		799	If multiple templates are specified the last one wins. Note that a
		800	template overrides all the scale, position and operations settings.
733		801
734	If used in conjunction with B<-tr> option, the specified pixmap will be	802	If used in conjunction with B<-tr> option, the specified pixmap will be
735	blended over transparency image using either alpha-blending, or any	803	blended over the transparent background using alpha-blending.
736	other blending type, specified with B<-blt "type"> option.
737		804
738	=item B<path:> I<path>	805	=item B<path:> I<path>
739		806
740	Specify the colon-delimited search path for finding background image files.	807	Specify the colon-delimited search path for finding background image files.
741		808
…		…
768	it is named first) and thus defines the character cell grid to be 9 pixels	835	it is named first) and thus defines the character cell grid to be 9 pixels
769	wide and 15 pixels high.	836	wide and 15 pixels high.
770		837
771	The second font is just used to add additional unicode characters not in	838	The second font is just used to add additional unicode characters not in
772	the base font, likewise the third, which is unfortunately non-bold, but	839	the base font, likewise the third, which is unfortunately non-bold, but
773	the bold version of the font does contain less characters, so this is a	840	the bold version of the font does contain fewer characters, so this is a
774	useful supplement.	841	useful supplement.
775		842
776	The third font is an Xft font with aliasing turned off, and the characters	843	The third font is an Xft font with aliasing turned off, and the characters
777	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	844	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
778	contains other characters, but we are not interested in them.	845	contains other characters, but we are not interested in them.
…		…
802	text font will being used for the given style.	869	text font will being used for the given style.
803		870
804	=item B<intensityStyles:> I<boolean>	871	=item B<intensityStyles:> I<boolean>
805		872
806	When font styles are not enabled, or this option is enabled (B<True>,	873	When font styles are not enabled, or this option is enabled (B<True>,
807	option B<-is>, the default), bold and italic font styles imply high	874	option B<-is>, the default), bold/blink font styles imply high
808	intensity foreground/background colours. Disabling this option (B<False>,	875	intensity foreground/background colours. Disabling this option (B<False>,
809	option B<+is>) disables this behaviour, the high intensity colours are not	876	option B<+is>) disables this behaviour, the high intensity colours are not
810	reachable.	877	reachable.
811		878
812	=item B<selectstyle:> I<mode>
813
814	Set mouse selection style to B<old> which is 2.20, B<oldword> which
815	is xterm style with 2.20 old word selection, or anything else which
816	gives xterm style selection. Only effective when the original (non-perl)
817	selection code is in use.
818
819	=item B<scrollstyle:> I<mode>
820
821	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
822	the author's favourite.
823
824	=item B<title:> I<string>	879	=item B<title:> I<string>
825		880
826	Set window title string, the default title is the command-line	881	Set window title string, the default title is the command-line
827	specified after the B<-e> option, if any, otherwise the application	882	specified after the B<-e> option, if any, otherwise the application
828	name; option B<-title>.	883	name; option B<-title>.
…		…
841	=item B<urgentOnBell:> I<boolean>	896	=item B<urgentOnBell:> I<boolean>
842		897
843	B<True>: set the urgency hint for the wm on receipt of a bell character.	898	B<True>: set the urgency hint for the wm on receipt of a bell character.
844	B<False>: do not set the urgency hint [default].	899	B<False>: do not set the urgency hint [default].
845		900
		901	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		902
846	=item B<visualBell:> I<boolean>	903	=item B<visualBell:> I<boolean>
847		904
848	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	905	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
849	B<False>: no visual bell [default]; option B<+vb>.	906	B<False>: no visual bell [default]; option B<+vb>.
850		907
…		…
873	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	930	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
874		931
875	This creates a new file in your home directory with the screen contents	932	This creates a new file in your home directory with the screen contents
876	every time you hit C<Print>.	933	every time you hit C<Print>.
877		934
		935	=item B<scrollstyle:> I<mode>
		936
		937	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		938	the author's favourite.
		939
		940	=item B<thickness:> I<number>
		941
		942	Set the scrollbar width in pixels.
		943
878	=item B<scrollBar:> I<boolean>	944	=item B<scrollBar:> I<boolean>
879		945
880	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	946	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
881	disable the scrollbar; option B<+sb>.	947	disable the scrollbar; option B<+sb>.
882		948
…		…
901	B<False>: do not scroll to bottom when tty receives output; option	967	B<False>: do not scroll to bottom when tty receives output; option
902	B<+si>.	968	B<+si>.
903		969
904	=item B<scrollWithBuffer:> I<boolean>	970	=item B<scrollWithBuffer:> I<boolean>
905		971
906	B<True>: scroll with scrollback buffer when tty receives new lines (and	972	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
907	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	973	try to show the same lines) and B<scrollTtyOutput> is False; option
908	with scrollback buffer when tty receives new lines; option B<+sw>.	974	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		975	new lines; option B<+sw>.
909		976
910	=item B<scrollTtyKeypress:> I<boolean>	977	=item B<scrollTtyKeypress:> I<boolean>
911		978
912	B<True>: scroll to bottom when a non-special key is pressed. Special keys	979	B<True>: scroll to bottom when a non-special key is pressed. Special keys
913	are those which are intercepted by rxvt-unicode for special handling and	980	are those which are intercepted by rxvt-unicode for special handling and
…		…
969	=item B<cursorBlink:> I<boolean>	1036	=item B<cursorBlink:> I<boolean>
970		1037
971	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1038	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
972	option B<-bc>.	1039	option B<-bc>.
973		1040
		1041	=item B<cursorUnderline:> I<boolean>
		1042
		1043	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1044	option B<-uc>.
		1045
974	=item B<pointerBlank:> I<boolean>	1046	=item B<pointerBlank:> I<boolean>
975		1047
976	B<True>: blank the pointer when a key is pressed or after a set number	1048	B<True>: blank the pointer when a key is pressed or after a set number
977	of seconds of inactivity. B<False>: the pointer is always visible	1049	of seconds of inactivity. B<False>: the pointer is always visible
978	[default].	1050	[default].
…		…
991	large number (e.g. C<987654321>) to effectively disable the timeout.	1063	large number (e.g. C<987654321>) to effectively disable the timeout.
992		1064
993	=item B<backspacekey:> I<string>	1065	=item B<backspacekey:> I<string>
994		1066
995	The string to send when the backspace key is pressed. If set to B<DEC>	1067	The string to send when the backspace key is pressed. If set to B<DEC>
996	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1068	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
997	(code 8) - which can be reversed with the appropriate DEC private mode	1069	(code 8) - which can be reversed with the appropriate DEC private mode
998	escape sequence.	1070	escape sequence.
999		1071
1000	=item B<deletekey:> I<string>	1072	=item B<deletekey:> I<string>
1001		1073
…		…
1080		1152
1081	=item B<secondaryScroll:> I<boolean>	1153	=item B<secondaryScroll:> I<boolean>
1082		1154
1083	Turn on/off secondary screen scroll (default enabled). If this	1155	Turn on/off secondary screen scroll (default enabled). If this
1084	option is enabled, scrolls on the secondary screen will change the	1156	option is enabled, scrolls on the secondary screen will change the
1085	scrollback buffer and switching to/from the secondary screen will	1157	scrollback buffer and, when secondaryScreen is off, switching
1086	instead scroll the screen up.	1158	to/from the secondary screen will instead scroll the screen up.
1087		1159
1088	=item B<hold>: I<boolean>	1160	=item B<hold>: I<boolean>
1089		1161
1090	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1162	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1091	will not immediately destroy its window when the program executed within	1163	will not immediately destroy its window when the program executed within
1092	it exits. Instead, it will wait till it is being killed or closed by the	1164	it exits. Instead, it will wait till it is being killed or closed by the
1093	user.	1165	user.
		1166
		1167	=item B<chdir>: I<path>
		1168
		1169	Sets the working directory for the shell (or the command specified via
		1170	B<-e>). The I<path> must be an absolute path and it must exist for
		1171	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1172	directory will be used; option B<-cd>.
1094		1173
1095	=item B<keysym.>I<sym>: I<string>	1174	=item B<keysym.>I<sym>: I<string>
1096		1175
1097	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1098	intervening resource name B<keysym.> cannot be omitted.	1177	intervening resource name B<keysym.> cannot be omitted.
…		…
1113	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1192	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1114	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1193	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1115	performed in an exact manner; however, the closest match is assured.	1194	performed in an exact manner; however, the closest match is assured.
1116		1195
1117	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1196	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1118	number), see RESOURCES in C<man 7 X> for futher details.	1197	number), see RESOURCES in C<man 7 X> for further details.
1119		1198
1120	You can define a range of keysyms in one shot by providing a I<string>	1199	You can define a range of keysyms in one shot by
		1200	loading the C<keysym-list> perl extension and providing a I<string>
1121	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1122	should be a character not used by the strings.	1202	should be a character not used by the strings.
1123		1203
1124	Its usage can be demonstrated by an example:	1204	Its usage can be demonstrated by an example:
1125		1205
1126	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1127		1207
1128	The above line is equivalent to the following three lines:	1208	The above line is equivalent to the following three lines:
1129		1209
1130	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1210	URxvt.keysym.Meta-Control-0x61: \033<a>
1131	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1211	URxvt.keysym.Meta-Control-0x62: \033<b>
1132	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1212	URxvt.keysym.Meta-Control-0x63: \033<c>
1133		1213
1134	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1214	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1135	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1215	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1136	example the following means "change the current locale to C<zh_CN.GBK>	1216	example the following means "change the current locale to C<zh_CN.GBK>
1137	when Control-Meta-c is being pressed":	1217	when Control-Meta-c is being pressed":
1138		1218
1139	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1219	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1140		1220
1141	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1221	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1142	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1222	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1143	manpage. For example, the F<selection> extension (activated via	1223	manpage. For example, the F<selection> extension (activated via
1144	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1145		1225
1146	URxvt.keysym.M-C-c: perl:selection:rot13	1226	URxvt.keysym.M-C-c: perl:selection:rot13
1147		1227
1148	Due the the large number of modifier combinations, a defined key mapping	1228	Due the the large number of modifier combinations, a defined key mapping
1149	will match if at I<at least> the specified identifiers are being set, and	1229	will match if I<at least> the specified identifiers are being set, and
1150	no other key mappings with those and more bits are being defined. That	1230	no other key mappings with those and more bits are being defined. That
1151	means that defining a key map for C<a> will automatically provide	1231	means that defining a key map for C<a> will automatically provide
1152	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1153	mappings themselves.	1233	mappings themselves.
1154		1234
…		…
1205	all instances, while B<perl-ext> is used for specific instances.	1285	all instances, while B<perl-ext> is used for specific instances.
1206		1286
1207	=item B<perl-eval>: I<string>	1287	=item B<perl-eval>: I<string>
1208		1288
1209	Perl code to be evaluated when all extensions have been registered. See	1289	Perl code to be evaluated when all extensions have been registered. See
1210	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1290	the @@RXVT_NAME@@perl(3) manpage.
1211	will be ignored when running setuid/setgid.
1212		1291
1213	=item B<perl-lib>: I<path>	1292	=item B<perl-lib>: I<path>
1214		1293
1215	Colon-separated list of additional directories that hold extension	1294	Colon-separated list of additional directories that hold extension
1216	scripts. When looking for extensions specified by the C<perl> resource,	1295	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1217	@@RXVT_NAME@@ will first look in these directories and then in	1296	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1218	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1297	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1219	will be ignored when running setuid/setgid.
1220		1298
1221	See the @@RXVT_NAME@@perl(3) manpage.	1299	See the @@RXVT_NAME@@perl(3) manpage.
1222		1300
1223	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1301	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1224		1302
…		…
1246		1324
1247	=item B<override-redirect>: I<boolean>	1325	=item B<override-redirect>: I<boolean>
1248		1326
1249	Compile I<frills>: Sets override-redirect for the terminal window, making	1327	Compile I<frills>: Sets override-redirect for the terminal window, making
1250	it almost invisible to window managers; option B<-override-redirect>.	1328	it almost invisible to window managers; option B<-override-redirect>.
		1329
		1330	=item B<iso14755:> I<boolean>
		1331
		1332	Turn on/off ISO 14755 (default enabled).
1251		1333
1252	=item B<iso14755_52:> I<boolean>	1334	=item B<iso14755_52:> I<boolean>
1253		1335
1254	Turn on/off ISO 14755 5.2 mode (default enabled).	1336	Turn on/off ISO 14755 5.2 mode (default enabled).
1255		1337
…		…
1398	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1480	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1399	it can be seen via the I<who(1)> command, and can accept messages. To	1481	it can be seen via the I<who(1)> command, and can accept messages. To
1400	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1482	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1401	on some systems or setgid to root or to some other group on others.	1483	on some systems or setgid to root or to some other group on others.
1402		1484
1403	=head1 COLORS AND GRAPHICS	1485	=head1 COLOURS AND GRAPHICS
1404		1486
1405	In addition to the default foreground and background colours,	1487	In addition to the default foreground and background colours,
1406	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1488	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1407	high-intensity bold/blink versions of the same). Here is a list of the	1489	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1408	colours with their names.	1490	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1491	cube plus a 8 (24) colour greyscale ramp.
		1492
		1493	Here is a list of the ANSI colours with their names.
1409		1494
1410	=begin table	1495	=begin table
1411		1496
1412	B<color0> (black) = Black	1497	B<color0> (black) = Black
1413	B<color1> (red) = Red3	1498	B<color1> (red) = Red3
…		…
1433	It is also possible to specify the colour values of B<foreground>,	1518	It is also possible to specify the colour values of B<foreground>,
1434	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1519	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1435	a number 0-15, as a convenient shorthand to reference the colour name of	1520	a number 0-15, as a convenient shorthand to reference the colour name of
1436	color0-color15.	1521	color0-color15.
1437		1522
1438	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1523	The following text gives values for the standard 88 colour mode (and
1439	additional 72 colours. The first 64 of those (with indices 16 to 79)	1524	values for the 256 colour mode in parentheses).
1440	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1441	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1442		1525
		1526	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1527
		1528	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1529	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1530
		1531	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1532	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1533	the RGB cube.
		1534
1443	Together, all those colours implement the 88 colour xterm colours. Only	1535	Together, all those colours implement the 88 (256) colour xterm
1444	the first 16 can be changed using resources currently, the rest can only	1536	colours. Only the first 16 can be changed using resources currently, the
1445	be changed via command sequences ("escape codes").	1537	rest can only be changed via command sequences ("escape codes").
		1538
		1539	Applications are advised to use terminfo or command sequences to discover
		1540	number and RGB values of all colours (yes, you can query this...).
1446		1541
1447	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1542	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1448	always swapping the foreground/background colours. This is in contrast to	1543	always swapping the foreground/background colours. This is in contrast to
1449	I<xterm>(1) where the colours are only swapped if they have not otherwise	1544	I<xterm>(1) where the colours are only swapped if they have not otherwise
1450	been specified. For example,	1545	been specified. For example,
1451		1546
1452	=over 4
1453
1454	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1547	@@RXVT_NAME@@ -fg Black -bg White -rv
1455		1548
1456	would yield White on Black, while on I<xterm>(1) it would yield Black	1549	would yield White on Black, while on I<xterm>(1) it would yield Black on
1457	on White.	1550	White.
1458
1459	=back
1460		1551
1461	=head2 ALPHA CHANNEL SUPPORT	1552	=head2 ALPHA CHANNEL SUPPORT
1462		1553
1463	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1554	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1464	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1555	their act together, rxvt-unicode will do its own alpha channel management:
1465	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1556
1466	in addition to the ones provided by X, where the additional A component	1557	You can prefix any colour with an opaqueness percentage enclosed in
		1558	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1559	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1560	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1561	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1562	is the recommended format to specify transparency values, and works with
		1563	all ways to specify a colour.
		1564
		1565	For complete control, rxvt-unicode also supports
		1566	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1567	specifications, where the additional C<aaaa> component specifies opacity
1467	specifies opacity (alpha) values. The minimum value of C<0> is completely	1568	(alpha) values. The minimum value of C<0000> is completely transparent,
1468	transparent). You can also prefix any color with C<[percent]>, where	1569	while C<ffff> is completely opaque). The two example colours from
1469	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1570	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1470	the color, where C<0> is completely transparent and C<100> is completelxy	1571	C<rgba:0000/ff00/0000/f332>.
1471	opaque.
1472		1572
1473	You probably need to specify B<"-depth 32">, too, and have the luck that	1573	You probably need to specify B<"-depth 32">, too, to force a visual with
1474	your X-server uses ARGB pixel layout, as X is far from just supporting	1574	alpha channels, and have the luck that your X-server uses ARGB pixel
1475	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1575	layout, as X is far from just supporting ARGB visuals out of the box, and
		1576	rxvt-unicode just fudges around.
1476		1577
1477	For example, the following selects an almost completely transparent red	1578	For example, the following selects an almost completely transparent black
1478	background, and an almost opaque pink foreground:	1579	background, and an almost opaque pink foreground:
1479		1580
1480	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1581	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1481		1582
1482	I<Please note that transparency of any kind if completely unsupported by	1583	When not using a background image, then the interpretation of the
1483	the author. Don't bug him with installation questions!>	1584	alpha channel is up to your compositing manager (most interpret it as
		1585	transparency of course).
		1586
		1587	When using a background pixmap or pseudo-transparency, then the background
		1588	colour will always behave as if it were completely transparent (so the
		1589	background image shows instead), regardless of how it was specified, while
		1590	other colours will either be transparent as specified (the background
		1591	image will show through) on servers supporting the RENDER extension, or
		1592	fully opaque on servers not supporting the RENDER EXTENSION.
		1593
		1594	Please note that due to bugs in Xft, specifying alpha values might result
		1595	in garbage being displayed when the X-server does not support the RENDER
		1596	extension.
1484		1597
1485	=head1 ENVIRONMENT	1598	=head1 ENVIRONMENT
1486		1599
1487	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1600	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1488		1601
…		…
1522	C<--with-terminfo=PATH>.	1635	C<--with-terminfo=PATH>.
1523		1636
1524	=item B<DISPLAY>	1637	=item B<DISPLAY>
1525		1638
1526	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1639	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1527	display in its child processes.	1640	display in its child processes if C<-display> isn't used to override. It
		1641	defaults to C<:0> if it doesn't exist.
1528		1642
1529	=item B<SHELL>	1643	=item B<SHELL>
1530		1644
1531	The shell to be used for command execution, defaults to C</bin/sh>.	1645	The shell to be used for command execution, defaults to C</bin/sh>.
1532		1646
1533	=item B<RXVT_SOCKET>	1647	=item B<RXVT_SOCKET> [I<sic>]
1534		1648
1535	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1649	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1536	@@RXVT_NAME@@d(1).	1650	@@RXVT_NAME@@d(1).
1537		1651
1538	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1652	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1653
		1654	=item B<URXVT_PERL_LIB>
		1655
		1656	Additional F<:>-separated library search path for perl extensions. Will be
		1657	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1658	directory.
		1659
		1660	=item B<URXVT_PERL_VERBOSITY>
		1661
		1662	See L<@@RXVT_NAME@@perl>(3).
1539		1663
1540	=item B<HOME>	1664	=item B<HOME>
1541		1665
1542	Used to locate the default directory for the unix domain socket for	1666	Used to locate the default directory for the unix domain socket for
1543	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1544	C<.Xdefaults>)	1668	C<.Xdefaults>)
1545		1669
1546	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1547		1671
1548	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1549		1673
1550	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1551		1675
1552	If set and accessible, gives the name of a X resource file to be loaded by	1676	If set and accessible, gives the name of a X resource file to be loaded by
1553	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1558		1682
1559	=over 4	1683	=over 4
1560		1684
1561	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1562		1686
1563	Color names.	1687	Colour names.
1564		1688
1565	=back	1689	=back
1566		1690
1567	=head1 SEE ALSO	1691	=head1 SEE ALSO
1568		1692
		1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1569	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1694	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1570		1695
1571	=head1 CURRENT PROJECT COORDINATOR	1696	=head1 CURRENT PROJECT COORDINATOR
1572		1697
1573	=over 4	1698	=over 4
1574		1699
…		…
1619		1744
1620	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1621		1746
1622	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1623		1748
1624	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1625		1750
1626	=back	1751	=back
1627		1752

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs. Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC