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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.223 by root, Thu May 30 18:49:16 2013 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>
…		…
113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		127
115	=item B<-ss>\|B<+ss>	128	=item B<-ss>\|B<+ss>
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
119	=item B<-tr>\|B<+tr>
120
121	Turn on/off illusion of a transparent window background. Obsolete form of it is
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
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		131
131	=item B<-fade> I<number>	132	=item B<-fade> I<number>
132		133
133	Fade the text by the given percentage when focus is lost. Small values	134	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	135	fade a little only, 100 completely replaces all colours by the fade
…		…
137	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
138		139
139	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
140	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
141		142
142	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
143		144
144	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
145	transparency is enabled with B<-tr>. This only works for	146	is used by many window managers, taskbars and pagers to represent the
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
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
156	=item B<-sh> I<number>
157
158	Darken (0 .. 100) or lighten (100 .. 200) the transparent
159	background image in addition to (or instead of) tinting it;
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
172	=item B<-blr> I<HxV>
173
174	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and
176	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
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179	resource I<blurRadius>.
180		148
181	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
182		150
183	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
184		152
185	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
186		154
187	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
188
189	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190
191	Compile I<afterimage>: Specify image file for the background and also
192	optionally specify its scaling with a geometry string. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.
195		156
196	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
197		158
198	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
199		160
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	206	for details.
246		207
247	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
248		209
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
251	details.	212	details.
252		213
253	=item B<-name> I<name>	214	=item B<-name> I<name>
254		215
…		…
272		233
273	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
274		235
275	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
276		237
		238	=item B<-sr>\|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>\|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
277	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
278		248
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
281		251
…		…
287	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
288		258
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	261	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		262
302	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
303		264
304	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
309		270
310	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
311		272
312	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
313		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
314	=item B<-iconic>	279	=item B<-iconic>
315		280
316	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
318		283
…		…
334		299
335	=item B<-bl>	300	=item B<-bl>
336		301
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	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	303	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
340		306
341	=item B<-override-redirect>	307	=item B<-override-redirect>
342		308
343	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	310	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
354		320
355	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	323	B<lineSpace>.
		324
		325	=item B<-letsp> I<number>
		326
		327	Compile I<frills>: Amount to adjust the computed character width by
		328	to control overall letter spacing. Negative values will tighten up the
		329	letter spacing, positive values will space letters out more. Useful to
		330	work around odd font metrics; resource B<letterSpace>.
358		331
359	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
360		333
361	This option specifies the name of the terminal type to be set in the	334	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	335	B<TERM> environment variable. This terminal type must exist in the
…		…
417		390
418	=item B<-tcw>	391	=item B<-tcw>
419		392
420	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	394	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	395	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
424		397
425	=item B<-insecure>	398	=item B<-insecure>
426		399
427	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
448		421
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	423	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	424	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	425	user; resource B<hold>.
		426
		427	=item B<-cd> I<path>
		428
		429	Sets the working directory for the shell (or the command specified via
		430	B<-e>). The I<path> must be an absolute path and it must exist for
		431	@@RXVT_NAME@@ to start; resource B<chdir>.
		432
		433	=item B<-xrm> I<string>
		434
		435	Works like the X Toolkit option of the same name, by adding the I<string>
		436	as if it were specified in a resource file. Resource values specified this
		437	way take precedence over all other resource specifications.
		438
		439	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		440	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		441	options can be specified as long-options on the commandline, so use
		442	of B<-xrm> is mostly limited to cases where you want to specify other
		443	resources (e.g. for input methods) or for compatibility with other
		444	programs.
453		445
454	=item B<-keysym.>I<sym> I<string>	446	=item B<-keysym.>I<sym> I<string>
455		447
456	Remap a key symbol. See resource B<keysym>.	448	Remap a key symbol. See resource B<keysym>.
457		449
…		…
492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	484	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493	entries and will not tinker with pty/tty permissions - you have to do that	485	entries and will not tinker with pty/tty permissions - you have to do that
494	yourself if you want that.	486	yourself if you want that.
495		487
496	As an extremely special case, specifying C<-1> will completely suppress	488	As an extremely special case, specifying C<-1> will completely suppress
497	pty/tty operations.	489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
498		491
499	Here is a example in perl that illustrates how this option can be used (a	492	Here is a example in perl that illustrates how this option can be used (a
500	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
501		494
502	use IO::Pty;	495	use IO::Pty;
…		…
516	Comma-separated list of perl extension scripts to use (or not to use) in	509	Comma-separated list of perl extension scripts to use (or not to use) in
517	this terminal instance. See resource B<perl-ext> for details.	510	this terminal instance. See resource B<perl-ext> for details.
518		511
519	=back	512	=back
520		513
521	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
522		515
523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
525		519
526	You can set and change the resources using X11 tools like B<xrdb>. Many	520	You can set and change the resources using X11 tools like B<xrdb>. Many
527	distribution do also load settings from the B<~/.Xresources> file when X	521	distribution do also load settings from the B<~/.Xresources> file when X
528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
530		524
531	1. system-wide app-defaults file, either locale-dependent OR global
532	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
534	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		530	6. resources specified via -xrm on the commandline
536		531
537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
539	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540	configured, while the class name B<URxvt> allows resources unique to	535	configured, while the class name B<URxvt> allows resources unique to
…		…
550	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
551		546
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	547	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	548	option B<-depth>.
554		549
		550	=item B<buffered:> I<boolean>
		551
		552	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		553	On some card/driver combination enabling it slightly decreases
		554	performance, on most it greatly helps it. The slowdown is small, so it
		555	should normally be enabled.
		556
555	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
556		558
557	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
558	option B<-geometry>.	560	option B<-geometry>.
559		561
…		…
572	Use the specified colour for the colour value I<n>, where 0-7	574	Use the specified colour for the colour value I<n>, where 0-7
573	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
574	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
575	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	577	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
576	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	578	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
577	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
578		580
579	Colours higher than 15 cannot be set using resources (yet), but can be	581	Colours higher than 15 cannot be set using resources (yet), but can be
580	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
581		583
582	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	584	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
593	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
594		596
595	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
596	foreground colour is the default.	598	foreground colour is the default.
597		599
598	=item B<colorRV:> I<colour>
599
600	Use the specified colour as the background for reverse video characters
601	when OPTION_HC is disabled (--disable-frills).
602
603	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
604		601
605	If set, use the specified colour as the colour for the underline	602	If set, use the specified colour as the colour for the underline
606	itself. If unset, use the foreground colour.	603	itself. If unset, use the foreground colour.
		604
		605	=item B<highlightColor:> I<colour>
		606
		607	If set, use the specified colour as the background for highlighted
		608	characters. If unset, use reverse video.
		609
		610	=item B<highlightTextColor:> I<colour>
		611
		612	If set and highlightColor is set, use the specified colour as the
		613	foreground for highlighted characters.
607		614
608	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
609		616
610	Use the specified colour for the cursor. The default is to use the	617	Use the specified colour for the cursor. The default is to use the
611	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
618		625
619	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
620		627
621	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
622	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
624		631
625	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
626		633
627	B<True>: specify that jump scrolling should be used. When receiving lots	634	B<True>: specify that jump scrolling should be used. When receiving lots
628	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	635	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
642		649
643	B<False>: specify that everything is to be displayed, even	650	B<False>: specify that everything is to be displayed, even
644	if the refresh is too fast for the human eye to read anything (or the	651	if the refresh is too fast for the human eye to read anything (or the
645	monitor to display anything); option B<+ss>.	652	monitor to display anything); option B<+ss>.
646		653
647	=item B<inheritPixmap:> I<boolean>
648
649	B<True>: make the background inherit the parent windows' pixmap, giving
650	artificial transparency. B<False>: do not inherit the parent windows'
651	pixmap.
652
653	I<Please note that transparency of any kind if completely unsupported by
654	the author. Don't bug him with installation questions!>
655
656	=item B<fading:> I<number>	654	=item B<fading:> I<number>
657		655
658	Fade the text by the given percentage when focus is lost; option B<-fade>.	656	Fade the text by the given percentage when focus is lost; option B<-fade>.
659		657
660	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
661		659
662	Fade to this colour, when fading is used (see B<fading:>). The default	660	Fade to this colour, when fading is used (see B<fading:>). The default
663	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
664		662
665	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
666		664
667	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
668	B<-tint>.
669
670	=item B<shading:> I<number>
671
672	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
673	in addition to tinting it; option B<-sh>.
674
675	=item B<blendType:> I<string>
676
677	Specify background blending type; option B<-blt>.
678
679	=item B<blurRadius:> I<number>
680
681	Apply Gaussian Blurr with the specified radius to the transparent
682	background image; option B<-blr>.
683		666
684	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
685		668
686	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
687		670
…		…
692		675
693	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
694		677
695	The colour of the border around the text area and between the scrollbar	678	The colour of the border around the text area and between the scrollbar
696	and the text.	679	and the text.
697
698	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699
700	Use the specified image file for the background and also optionally
701	specify its scaling with a geometry string B<WxH+X+Y>,
702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
703	and B<"X" / "Y"> locate the image centre (percent).
704	A scale of 0 displays the image with tiling. A scale of 1 displays the
705	image without any scaling. A scale of 2 to 9 specifies an integer
706	number of images in that direction. No image will be magnified beyond
707	10 times its original size. The maximum permitted scale is 1000.
708	Additional operations can be specified after colon B<:op1:op2...>.
709	Supported operations are:
710	B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,
711	B<"propscale"> - will scale image keeping proportions,
712	B<"auto"> - will scale image to match window size. Equivalent to 100x100;
713	B<"hscale"> - will scale image horizontally to the window size;
714	B<"vscale"> - will scale image vertically to the window size;
715	B<"scale"> - will scale image to match window size;
716	B<"root"> - will tile image as if it was a root window background, auto-adjusting
717	whenever terminal window moves.
718
719	If used in conjunction with B<-tr> option - specified pixmap will be
720	blended over transparency image using either alpha-blending, or any
721	other blending type, specified with B<-blt "type"> option.
722	[default 0x0+50+50]
723
724	=item B<path:> I<path>
725
726	Specify the colon-delimited search path for finding background image files.
727		680
728	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
729		682
730	Select the fonts to be used. This is a comma separated list of font names	683	Select the fonts to be used. This is a comma separated list of font names
731	that are checked in order when trying to find glyphs for characters. The	684	that are checked in order when trying to find glyphs for characters. The
…		…
754	it is named first) and thus defines the character cell grid to be 9 pixels	707	it is named first) and thus defines the character cell grid to be 9 pixels
755	wide and 15 pixels high.	708	wide and 15 pixels high.
756		709
757	The second font is just used to add additional unicode characters not in	710	The second font is just used to add additional unicode characters not in
758	the base font, likewise the third, which is unfortunately non-bold, but	711	the base font, likewise the third, which is unfortunately non-bold, but
759	the bold version of the font does contain less characters, so this is a	712	the bold version of the font does contain fewer characters, so this is a
760	useful supplement.	713	useful supplement.
761		714
762	The third font is an Xft font with aliasing turned off, and the characters	715	The third font is an Xft font with aliasing turned off, and the characters
763	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	716	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
764	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
788	text font will being used for the given style.	741	text font will being used for the given style.
789		742
790	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
791		744
792	When font styles are not enabled, or this option is enabled (B<True>,	745	When font styles are not enabled, or this option is enabled (B<True>,
793	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
794	intensity foreground/background colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
795	option B<+is>) disables this behaviour, the high intensity colours are not	748	option B<+is>) disables this behaviour, the high intensity colours are not
796	reachable.	749	reachable.
797		750
798	=item B<selectstyle:> I<mode>
799
800	Set mouse selection style to B<old> which is 2.20, B<oldword> which
801	is xterm style with 2.20 old word selection, or anything else which
802	gives xterm style selection. Only effective when the original (non-perl)
803	selection code is in use.
804
805	=item B<scrollstyle:> I<mode>
806
807	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
808	the author's favourite.
809
810	=item B<title:> I<string>	751	=item B<title:> I<string>
811		752
812	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
813	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
814	name; option B<-title>.	755	name; option B<-title>.
…		…
827	=item B<urgentOnBell:> I<boolean>	768	=item B<urgentOnBell:> I<boolean>
828		769
829	B<True>: set the urgency hint for the wm on receipt of a bell character.	770	B<True>: set the urgency hint for the wm on receipt of a bell character.
830	B<False>: do not set the urgency hint [default].	771	B<False>: do not set the urgency hint [default].
831		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
832	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
833		776
834	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	777	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
835	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
836		779
…		…
859	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
860		803
861	This creates a new file in your home directory with the screen contents	804	This creates a new file in your home directory with the screen contents
862	every time you hit C<Print>.	805	every time you hit C<Print>.
863		806
		807	=item B<scrollstyle:> I<mode>
		808
		809	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		810	the author's favourite.
		811
		812	=item B<thickness:> I<number>
		813
		814	Set the scrollbar width in pixels.
		815
864	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
865		817
866	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
867	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
868		820
…		…
887	B<False>: do not scroll to bottom when tty receives output; option	839	B<False>: do not scroll to bottom when tty receives output; option
888	B<+si>.	840	B<+si>.
889		841
890	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
891		843
892	B<True>: scroll with scrollback buffer when tty receives new lines (and	844	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
893	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	845	try to show the same lines) and B<scrollTtyOutput> is False; option
894	with scrollback buffer when tty receives new lines; option B<+sw>.	846	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		847	new lines; option B<+sw>.
895		848
896	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
897		850
898	B<True>: scroll to bottom when a non-special key is pressed. Special keys	851	B<True>: scroll to bottom when a non-special key is pressed. Special keys
899	are those which are intercepted by rxvt-unicode for special handling and	852	are those which are intercepted by rxvt-unicode for special handling and
…		…
955	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
956		909
957	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	910	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
958	option B<-bc>.	911	option B<-bc>.
959		912
		913	=item B<cursorUnderline:> I<boolean>
		914
		915	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		916	option B<-uc>.
		917
960	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
961		919
962	B<True>: blank the pointer when a key is pressed or after a set number	920	B<True>: blank the pointer when a key is pressed or after a set number
963	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
964	[default].	922	[default].
…		…
977	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
978		936
979	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
980		938
981	The string to send when the backspace key is pressed. If set to B<DEC>	939	The string to send when the backspace key is pressed. If set to B<DEC>
982	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	940	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
983	(code 8) - which can be reversed with the appropriate DEC private mode	941	(code 8) - which can be reversed with the appropriate DEC private mode
984	escape sequence.	942	escape sequence.
985		943
986	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
987		945
…		…
1000	will be created). In this mode, characters outside ISO-8859-1 can be used.	958	will be created). In this mode, characters outside ISO-8859-1 can be used.
1001		959
1002	When the selection extension is not used, only ISO-8859-1 characters can	960	When the selection extension is not used, only ISO-8859-1 characters can
1003	be used. If not specified, the built-in default is used:	961	be used. If not specified, the built-in default is used:
1004		962
1005	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1006		964
1007	=item B<preeditType:> I<style>	965	=item B<preeditType:> I<style>
1008		966
1009	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1010		968
…		…
1066		1024
1067	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
1068		1026
1069	Turn on/off secondary screen scroll (default enabled). If this	1027	Turn on/off secondary screen scroll (default enabled). If this
1070	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
1071	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
1072	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
1073		1031
1074	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
1075		1033
1076	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1034	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1077	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1078	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1079	user.	1037	user.
		1038
		1039	=item B<chdir>: I<path>
		1040
		1041	Sets the working directory for the shell (or the command specified via
		1042	B<-e>). The I<path> must be an absolute path and it must exist for
		1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1044	directory will be used; option B<-cd>.
1080		1045
1081	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<string>
1082		1047
1083	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1084	intervening resource name B<keysym.> cannot be omitted.	1049	intervening resource name B<keysym.> cannot be omitted.
…		…
1099	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1064	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1100	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1065	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1101	performed in an exact manner; however, the closest match is assured.	1066	performed in an exact manner; however, the closest match is assured.
1102		1067
1103	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1104	number), see RESOURCES in C<man 7 X> for futher details.	1069	number), see RESOURCES in C<man 7 X> for further details.
1105		1070
1106	You can define a range of keysyms in one shot by providing a I<string>	1071	You can define a range of keysyms in one shot by
		1072	loading the C<keysym-list> perl extension and providing a I<string>
1107	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1108	should be a character not used by the strings.	1074	should be a character not used by the strings.
1109		1075
1110	Its usage can be demonstrated by an example:	1076	Its usage can be demonstrated by an example:
1111		1077
1112	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1113		1079
1114	The above line is equivalent to the following three lines:	1080	The above line is equivalent to the following three lines:
1115		1081
1116	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1082	URxvt.keysym.Meta-Control-0x61: \033<a>
1117	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1083	URxvt.keysym.Meta-Control-0x62: \033<b>
1118	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1084	URxvt.keysym.Meta-Control-0x63: \033<c>
1119		1085
1120	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1086	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1121	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1122	example the following means "change the current locale to C<zh_CN.GBK>	1088	example the following means "change the current locale to C<zh_CN.GBK>
1123	when Control-Meta-c is being pressed":	1089	when Control-Meta-c is being pressed":
1124		1090
1125	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1091	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1126		1092
1127	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1093	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1128	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1094	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1129	manpage. For example, the F<selection> extension (activated via	1095	manpage. For example, the F<selection> extension (activated via
1130	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1131		1097
1132	URxvt.keysym.M-C-c: perl:selection:rot13	1098	URxvt.keysym.M-C-c: perl:selection:rot13
1133		1099
1134	Due the the large number of modifier combinations, a defined key mapping	1100	Due the the large number of modifier combinations, a defined key mapping
1135	will match if at I<at least> the specified identifiers are being set, and	1101	will match if I<at least> the specified identifiers are being set, and
1136	no other key mappings with those and more bits are being defined. That	1102	no other key mappings with those and more bits are being defined. That
1137	means that defining a key map for C<a> will automatically provide	1103	means that defining a key map for C<a> will automatically provide
1138	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1104	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1139	mappings themselves.	1105	mappings themselves.
1140		1106
…		…
1191	all instances, while B<perl-ext> is used for specific instances.	1157	all instances, while B<perl-ext> is used for specific instances.
1192		1158
1193	=item B<perl-eval>: I<string>	1159	=item B<perl-eval>: I<string>
1194		1160
1195	Perl code to be evaluated when all extensions have been registered. See	1161	Perl code to be evaluated when all extensions have been registered. See
1196	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1162	the @@RXVT_NAME@@perl(3) manpage.
1197	will be ignored when running setuid/setgid.
1198		1163
1199	=item B<perl-lib>: I<path>	1164	=item B<perl-lib>: I<path>
1200		1165
1201	Colon-separated list of additional directories that hold extension	1166	Colon-separated list of additional directories that hold extension
1202	scripts. When looking for extensions specified by the C<perl> resource,	1167	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1203	@@RXVT_NAME@@ will first look in these directories and then in	1168	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1204	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1169	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1205	will be ignored when running setuid/setgid.
1206		1170
1207	See the @@RXVT_NAME@@perl(3) manpage.	1171	See the @@RXVT_NAME@@perl(3) manpage.
1208		1172
1209	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1173	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1210		1174
…		…
1219	=item B<searchable-scrollback:> I<keysym>	1183	=item B<searchable-scrollback:> I<keysym>
1220		1184
1221	Sets the hotkey that starts the incremental scrollback buffer search	1185	Sets the hotkey that starts the incremental scrollback buffer search
1222	(default: C<M-s>).	1186	(default: C<M-s>).
1223		1187
1224	=item B<urlLauncher>: I<string>	1188	=item B<url-launcher>: I<string>
1225		1189
1226	Specifies the program to be started with a URL argument. Used by the	1190	Specifies the program to be started with a URL argument. Used by the
1227	C<selection-popup> and C<matcher> perl extensions.	1191	C<selection-popup> and C<matcher> perl extensions.
1228		1192
1229	=item B<transient-for>: I<windowid>	1193	=item B<transient-for>: I<windowid>
…		…
1233	=item B<override-redirect>: I<boolean>	1197	=item B<override-redirect>: I<boolean>
1234		1198
1235	Compile I<frills>: Sets override-redirect for the terminal window, making	1199	Compile I<frills>: Sets override-redirect for the terminal window, making
1236	it almost invisible to window managers; option B<-override-redirect>.	1200	it almost invisible to window managers; option B<-override-redirect>.
1237		1201
		1202	=item B<iso14755:> I<boolean>
		1203
		1204	Turn on/off ISO 14755 (default enabled).
		1205
1238	=item B<iso14755_52:> I<boolean>	1206	=item B<iso14755_52:> I<boolean>
1239		1207
1240	Turn on/off ISO 14755 5.2 mode (default enabled).	1208	Turn on/off ISO 14755 5.2 mode (default enabled).
		1209
		1210	=back
		1211
		1212	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1213
		1214	=over 4
		1215
		1216	=item B<-pixmap> I<file[;oplist]>
		1217
		1218	=item B<backgroundPixmap:> I<file[;oplist]>
		1219
		1220	Compile I<pixbuf>: Use the specified image file as the window's
		1221	background and also optionally specify a colon separated list of
		1222	operations to modify it. Note that you may need to quote the C<;>
		1223	character when using the command line option, as C<;> is usually a
		1224	metacharacter in shells. Supported operations are:
		1225
		1226	=over 4
		1227
		1228	=item B<WxH+X+Y>
		1229
		1230	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1231	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1232	scale of 0 disables scaling.
		1233
		1234	=item B<op=tile>
		1235
		1236	enables tiling
		1237
		1238	=item B<op=keep-aspect>
		1239
		1240	maintain the image aspect ratio when scaling
		1241
		1242	=item B<op=root-align>
		1243
		1244	use the position of the terminal window relative to the root window as
		1245	the image offset, simulating a root window background
		1246
		1247	=back
		1248
		1249	The default scale and position setting is C<100x100+50+50>.
		1250	Alternatively, a predefined set of templates can be used to achieve
		1251	the most common setups:
		1252
		1253	=over 4
		1254
		1255	=item B<style=tiled>
		1256
		1257	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1258
		1259	=item B<style=aspect-stretched>
		1260
		1261	the image is scaled to fill the whole window maintaining the aspect
		1262	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1263
		1264	=item B<style=stretched>
		1265
		1266	the image is scaled to fill the whole window. Equivalent to 100x100
		1267
		1268	=item B<style=centered>
		1269
		1270	the image is centered with no scaling. Equivalent to 0x0+50+50
		1271
		1272	=item B<style=root-tiled>
		1273
		1274	the image is tiled with no scaling and using 'root' positioning.
		1275	Equivalent to 0x0:op=tile:op=root-align
		1276
		1277	=back
		1278
		1279	If multiple templates are specified the last one wins. Note that a
		1280	template overrides all the scale, position and operations settings.
		1281
		1282	If used in conjunction with pseudo-transparency, the specified pixmap
		1283	will be blended over the transparent background using alpha-blending.
		1284
		1285	=item B<-tr>\|B<+tr>
		1286
		1287	=item B<transparent:> I<boolean>
		1288
		1289	Turn on/off pseudo-transparency by using the root pixmap as background.
		1290
		1291	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1292	will be removed in future versions.
		1293
		1294	=item B<-tint> I<colour>
		1295
		1296	=item B<tintColor:> I<colour>
		1297
		1298	Tint the transparent background with the given colour. Note that a
		1299	black tint yields a completely black image while a white tint yields
		1300	the image unchanged.
		1301
		1302	=item B<-sh> I<number>
		1303
		1304	=item B<shading:> I<number>
		1305
		1306	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1307	A value of 100 means no shading.
		1308
		1309	=item B<-blr> I<HxV>
		1310
		1311	=item B<blurRadius:> I<HxV>
		1312
		1313	Apply gaussian blur with the specified radius to the transparent
		1314	background. If a single number is specified, the vertical and
		1315	horizontal radii are considered to be the same. Setting one of the
		1316	radii to 1 and the other to a large number creates interesting effects
		1317	on some backgrounds. The maximum radius value is 128. An horizontal or
		1318	vertical radius of 0 disables blurring.
		1319
		1320	=item B<path:> I<path>
		1321
		1322	Specify the colon-delimited search path for finding background image files.
1241		1323
1242	=back	1324	=back
1243		1325
1244	=head1 THE SCROLLBAR	1326	=head1 THE SCROLLBAR
1245		1327
…		…
1384	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1466	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1385	it can be seen via the I<who(1)> command, and can accept messages. To	1467	it can be seen via the I<who(1)> command, and can accept messages. To
1386	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1468	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1387	on some systems or setgid to root or to some other group on others.	1469	on some systems or setgid to root or to some other group on others.
1388		1470
1389	=head1 COLORS AND GRAPHICS	1471	=head1 COLOURS AND GRAPHICS
1390		1472
1391	In addition to the default foreground and background colours,	1473	In addition to the default foreground and background colours,
1392	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1474	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1393	high-intensity bold/blink versions of the same). Here is a list of the	1475	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1394	colours with their names.	1476	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1477	cube plus a 8 (24) colour greyscale ramp.
		1478
		1479	Here is a list of the ANSI colours with their names.
1395		1480
1396	=begin table	1481	=begin table
1397		1482
1398	B<color0> (black) = Black	1483	B<color0> (black) = Black
1399	B<color1> (red) = Red3	1484	B<color1> (red) = Red3
…		…
1419	It is also possible to specify the colour values of B<foreground>,	1504	It is also possible to specify the colour values of B<foreground>,
1420	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1505	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1421	a number 0-15, as a convenient shorthand to reference the colour name of	1506	a number 0-15, as a convenient shorthand to reference the colour name of
1422	color0-color15.	1507	color0-color15.
1423		1508
1424	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1509	The following text gives values for the standard 88 colour mode (and
1425	additional 72 colours. The first 64 of those (with indices 16 to 79)	1510	values for the 256 colour mode in parentheses).
1426	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1427	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1428		1511
		1512	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1513
		1514	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1515	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1516
		1517	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1518	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1519	the RGB cube.
		1520
1429	Together, all those colours implement the 88 colour xterm colours. Only	1521	Together, all those colours implement the 88 (256) colour xterm
1430	the first 16 can be changed using resources currently, the rest can only	1522	colours. Only the first 16 can be changed using resources currently, the
1431	be changed via command sequences ("escape codes").	1523	rest can only be changed via command sequences ("escape codes").
		1524
		1525	Applications are advised to use terminfo or command sequences to discover
		1526	number and RGB values of all colours (yes, you can query this...).
1432		1527
1433	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1528	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1434	always swapping the foreground/background colours. This is in contrast to	1529	always swapping the foreground/background colours. This is in contrast to
1435	I<xterm>(1) where the colours are only swapped if they have not otherwise	1530	I<xterm>(1) where the colours are only swapped if they have not otherwise
1436	been specified. For example,	1531	been specified. For example,
1437		1532
1438	=over 4
1439
1440	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1533	@@RXVT_NAME@@ -fg Black -bg White -rv
1441		1534
1442	would yield White on Black, while on I<xterm>(1) it would yield Black	1535	would yield White on Black, while on I<xterm>(1) it would yield Black on
1443	on White.	1536	White.
1444
1445	=back
1446		1537
1447	=head2 ALPHA CHANNEL SUPPORT	1538	=head2 ALPHA CHANNEL SUPPORT
1448		1539
1449	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1540	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1541	their act together, rxvt-unicode will do its own alpha channel management:
1451	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1542
1452	in addition to the ones provided by X, where the additional A component	1543	You can prefix any colour with an opaqueness percentage enclosed in
		1544	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1545	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1546	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1547	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1548	is the recommended format to specify transparency values, and works with
		1549	all ways to specify a colour.
		1550
		1551	For complete control, rxvt-unicode also supports
		1552	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1553	specifications, where the additional C<aaaa> component specifies opacity
1453	specifies opacity (alpha) values. The minimum value of C<0> is completely	1554	(alpha) values. The minimum value of C<0000> is completely transparent,
1454	transparent). You can also prefix any color with C<[percent]>, where	1555	while C<ffff> is completely opaque). The two example colours from
1455	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1556	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1456	the color, where C<0> is completely transparent and C<100> is completelxy	1557	C<rgba:0000/ff00/0000/f332>.
1457	opaque.
1458		1558
1459	You probably need to specify B<"-depth 32">, too, and have the luck that	1559	You probably need to specify B<"-depth 32">, too, to force a visual with
1460	your X-server uses ARGB pixel layout, as X is far from just supporting	1560	alpha channels, and have the luck that your X-server uses ARGB pixel
1461	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1561	layout, as X is far from just supporting ARGB visuals out of the box, and
		1562	rxvt-unicode just fudges around.
1462		1563
1463	For example, the following selects an almost completely transparent red	1564	For example, the following selects an almost completely transparent black
1464	background, and an almost opaque pink foreground:	1565	background, and an almost opaque pink foreground:
1465		1566
1466	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1567	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1467		1568
1468	I<Please note that transparency of any kind if completely unsupported by	1569	When not using a background image, then the interpretation of the
1469	the author. Don't bug him with installation questions!>	1570	alpha channel is up to your compositing manager (most interpret it as
		1571	transparency of course).
		1572
		1573	When using a background pixmap or pseudo-transparency, then the background
		1574	colour will always behave as if it were completely transparent (so the
		1575	background image shows instead), regardless of how it was specified, while
		1576	other colours will either be transparent as specified (the background
		1577	image will show through) on servers supporting the RENDER extension, or
		1578	fully opaque on servers not supporting the RENDER EXTENSION.
		1579
		1580	Please note that due to bugs in Xft, specifying alpha values might result
		1581	in garbage being displayed when the X-server does not support the RENDER
		1582	extension.
1470		1583
1471	=head1 ENVIRONMENT	1584	=head1 ENVIRONMENT
1472		1585
1473	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1586	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1474		1587
…		…
1508	C<--with-terminfo=PATH>.	1621	C<--with-terminfo=PATH>.
1509		1622
1510	=item B<DISPLAY>	1623	=item B<DISPLAY>
1511		1624
1512	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1625	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1513	display in its child processes.	1626	display in its child processes if C<-display> isn't used to override. It
		1627	defaults to C<:0> if it doesn't exist.
1514		1628
1515	=item B<SHELL>	1629	=item B<SHELL>
1516		1630
1517	The shell to be used for command execution, defaults to C</bin/sh>.	1631	The shell to be used for command execution, defaults to C</bin/sh>.
1518		1632
1519	=item B<RXVT_SOCKET>	1633	=item B<RXVT_SOCKET> [I<sic>]
1520		1634
1521	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1635	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1522	@@RXVT_NAME@@d(1).	1636	@@RXVT_NAME@@d(1).
1523		1637
1524	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1638	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1639
		1640	=item B<URXVT_PERL_LIB>
		1641
		1642	Additional F<:>-separated library search path for perl extensions. Will be
		1643	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1644	directory.
		1645
		1646	=item B<URXVT_PERL_VERBOSITY>
		1647
		1648	See L<@@RXVT_NAME@@perl>(3).
1525		1649
1526	=item B<HOME>	1650	=item B<HOME>
1527		1651
1528	Used to locate the default directory for the unix domain socket for	1652	Used to locate the default directory for the unix domain socket for
1529	daemon communications and to locate various resource files (such as	1653	daemon communications and to locate various resource files (such as
1530	C<.Xdefaults>)	1654	C<.Xdefaults>)
1531		1655
1532	=item B<XAPPLRESDIR>	1656	=item B<XAPPLRESDIR>
1533		1657
1534	Directory where various X resource files are being located.	1658	Directory where application-specific X resource files are located.
1535		1659
1536	=item B<XENVIRONMENT>	1660	=item B<XENVIRONMENT>
1537		1661
1538	If set and accessible, gives the name of a X resource file to be loaded by	1662	If set and accessible, gives the name of a X resource file to be loaded by
1539	@@RXVT_NAME@@.	1663	@@RXVT_NAME@@.
…		…
1544		1668
1545	=over 4	1669	=over 4
1546		1670
1547	=item B</usr/lib/X11/rgb.txt>	1671	=item B</usr/lib/X11/rgb.txt>
1548		1672
1549	Color names.	1673	Colour names.
1550		1674
1551	=back	1675	=back
1552		1676
1553	=head1 SEE ALSO	1677	=head1 SEE ALSO
1554		1678
		1679	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1555	@@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)	1680	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1556		1681
1557	=head1 CURRENT PROJECT COORDINATOR	1682	=head1 CURRENT PROJECT COORDINATOR
1558		1683
1559	=over 4	1684	=over 4
1560		1685
…		…
1605		1730
1606	Project Coordinator (Changes 1.0 -)	1731	Project Coordinator (Changes 1.0 -)
1607		1732
1608	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1733	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1609		1734
1610	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1735	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1611		1736
1612	=back	1737	=back
1613		1738

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs. Revision 1.223 by root, Thu May 30 18:49:16 2013 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.223 by root, Thu May 30 18:49:16 2013 UTC