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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 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<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
120
121	Turn on/off inheriting parent window's pixmap. Alternative form is
122	B<-tr>; resource B<inheritPixmap>.
123
124	I<Please address all transparency related issues to Sasha Vasko at
125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
126		131
127	=item B<-fade> I<number>	132	=item B<-fade> I<number>
128		133
129	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
130	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
…		…
133	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
134		139
135	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
136	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
137		142
138	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
139		144
140	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
141	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	is used by many window managers, taskbars and pagers to represent the
142	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
143	used to brighten or darken the image in addition to tinting it.
144	Please note that certain tint colours can be applied on the server-side,
145	thus yielding performance gain of two orders of magnitude. These colours are:
146	blue, red, green, cyan, magenta, yellow, and those close to them; resource
147	I<tintColor>. Example:
148
149	@@RXVT_NAME@@ -tr -tint blue -sh 40
150
151	=item B<-sh> I<number>
152
153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
154	background image in addition to (or instead of) tinting it;
155	resource I<shading>.
156
157	=item B<-blt> I<string>
158
159	Specify background blending type. If background pixmap is specified
160	at the same time as transparency - such pixmap will be blended over
161	transparency image, using method specified. Supported values are :
162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165	alpha-blending; resource I<blendType>.
166
167	=item B<-blr> I<HxV>
168
169	Apply Gaussian Blur with the specified radii to the transparent
170	background image. If single number is specified - both vertical and
171	horizontal radii are considered to be the same. Setting one of the
172	radii to 1 and another to a large number creates interesting effects
173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
174		148
175	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
176		150
177	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
178		152
179	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
180		154
181	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
182
183	=item B<-pixmap> I<file[;geom]>
184
185	Compile I<afterimage>: Specify image file for the background and also
186	optionally specify its scaling with a geometry string. Note you may need to
187	add quotes to avoid special shell interpretation of the C<;> in the
188	command-line; for more details see resource B<backgroundPixmap>.
189		156
190	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
191		158
192	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
193		160
…		…
238	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
239	for details.	206	for details.
240		207
241	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
242		209
243	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
244	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
245	details.	212	details.
246		213
247	=item B<-name> I<name>	214	=item B<-name> I<name>
248		215
…		…
266		233
267	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
268		235
269	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
270		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
271	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
272		248
273	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
274	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
275		251
…		…
281	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
282		258
283	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.
284	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
285	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
286
287	=item B<-sr>\|B<+sr>
288
289	Put scrollbar on right/left; resource B<scrollBar_right>.
290
291	=item B<-st>\|B<+st>
292
293	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294	resource B<scrollBar_floating>.
295		262
296	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
297		264
298	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
299	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
…		…
303		270
304	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
305		272
306	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
307		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
308	=item B<-iconic>	279	=item B<-iconic>
309		280
310	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
311	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
312		283
…		…
328		299
329	=item B<-bl>	300	=item B<-bl>
330		301
331	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.
332	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
333	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.
334		306
335	=item B<-override-redirect>	307	=item B<-override-redirect>
336		308
337	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
338	B<override-redirect>.	310	B<override-redirect>.
…		…
347	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
348		320
349	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
350	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
351	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>.
352		331
353	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
354		333
355	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
356	B<TERM> environment variable. This terminal type must exist in the	335	B<TERM> environment variable. This terminal type must exist in the
…		…
411		390
412	=item B<-tcw>	391	=item B<-tcw>
413		392
414	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
415	button. Only effective when the original (non-perl) selection code is	394	button. Only effective when the original (non-perl) selection code is
416	in-use. Instead of selecting a full line it will extend the selection the	395	in-use. Instead of selecting a full line it will extend the selection to
417	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
418		397
419	=item B<-insecure>	398	=item B<-insecure>
420		399
421	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
422	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
442		421
443	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@@
444	will not immediately destroy its window when the program executed within	423	will not immediately destroy its window when the program executed within
445	it exits. Instead, it will wait till it is being killed or closed by the	424	it exits. Instead, it will wait till it is being killed or closed by the
446	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.
447		445
448	=item B<-keysym.>I<sym> I<string>	446	=item B<-keysym.>I<sym> I<string>
449		447
450	Remap a key symbol. See resource B<keysym>.	448	Remap a key symbol. See resource B<keysym>.
451		449
…		…
486	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
487	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
488	yourself if you want that.	486	yourself if you want that.
489		487
490	As an extremely special case, specifying C<-1> will completely suppress	488	As an extremely special case, specifying C<-1> will completely suppress
491	pty/tty operations.	489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
492		491
493	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
494	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
495		494
496	use IO::Pty;	495	use IO::Pty;
…		…
510	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
511	this terminal instance. See resource B<perl-ext> for details.	510	this terminal instance. See resource B<perl-ext> for details.
512		511
513	=back	512	=back
514		513
515	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
516		515
517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
519		519
520	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
521	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
522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
524		524
525	1. system-wide app-defaults file, either locale-dependent OR global
526	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
528	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		530	6. resources specified via -xrm on the commandline
530		531
531	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
532	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
533	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
534	configured, while the class name B<URxvt> allows resources unique to	535	configured, while the class name B<URxvt> allows resources unique to
…		…
544	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
545		546
546	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;
547	option B<-depth>.	548	option B<-depth>.
548		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
549	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
550		558
551	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
552	option B<-geometry>.	560	option B<-geometry>.
553		561
…		…
566	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
567	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
568	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
569	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,
570	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
571	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
572		580
573	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
574	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
575		583
576	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
…		…
587	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
588		596
589	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
590	foreground colour is the default.	598	foreground colour is the default.
591		599
592	=item B<colorRV:> I<colour>
593
594	Use the specified colour as the background for reverse video characters
595	when OPTION_HC is disabled (--disable-frills).
596
597	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
598		601
599	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
600	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.
601		614
602	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
603		616
604	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
605	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
612		625
613	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
614		627
615	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
616	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
617	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
618		631
619	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
620		633
621	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
622	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
…		…
636		649
637	B<False>: specify that everything is to be displayed, even	650	B<False>: specify that everything is to be displayed, even
638	if the refresh is too fast for the human eye to read anything (or the	651	if the refresh is too fast for the human eye to read anything (or the
639	monitor to display anything); option B<+ss>.	652	monitor to display anything); option B<+ss>.
640		653
641	=item B<inheritPixmap:> I<boolean>
642
643	B<True>: make the background inherit the parent windows' pixmap, giving
644	artificial transparency. B<False>: do not inherit the parent windows'
645	pixmap.
646
647	I<Please note that transparency of any kind if completely unsupported by
648	the author. Don't bug him with installation questions!>
649
650	=item B<fading:> I<number>	654	=item B<fading:> I<number>
651		655
652	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>.
653		657
654	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
655		659
656	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
657	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
658		662
659	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
660		664
661	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
662	B<-tint>.
663
664	=item B<shading:> I<number>
665
666	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
667	in addition to tinting it; option B<-sh>.
668
669	=item B<blendType:> I<string>
670
671	Specify background blending type; option B<-blt>.
672
673	=item B<blurRadius:> I<number>
674
675	Apply Gaussian Blurr with the specified radius to the transparent
676	background image; option B<-blr>.
677		666
678	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
679		668
680	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
681		670
…		…
686		675
687	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
688		677
689	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
690	and the text.	679	and the text.
691
692	=item B<backgroundPixmap:> I<file[;geom]>
693
694	Use the specified image file for the background and also optionally
695	specify its scaling with a geometry string B<WxH+X+Y>,
696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
697	and B<"X" / "Y"> locate the image centre (percent).
698	A scale of 0 displays the image with tiling. A scale of 1 displays the
699	image without any scaling. A scale of 2 to 9 specifies an integer
700	number of images in that direction. No image will be magnified beyond
701	10 times its original size. The maximum permitted scale is 1000.
702	Special string of B<"auto"> used as a geometry will cause image to be
703	automatically scaled to match window size.
704	If used in conjunction with B<-tr> option - specified pixmap will be
705	blended over transparency image using either alpha-blending, or any
706	other blending type, specified with B<-blt "type"> option.
707	[default 0x0+50+50]
708
709	=item B<path:> I<path>
710
711	Specify the colon-delimited search path for finding background image files.
712		680
713	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
714		682
715	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
716	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
…		…
739	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
740	wide and 15 pixels high.	708	wide and 15 pixels high.
741		709
742	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
743	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
744	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
745	useful supplement.	713	useful supplement.
746		714
747	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
748	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
749	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
773	text font will being used for the given style.	741	text font will being used for the given style.
774		742
775	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
776		744
777	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>,
778	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
779	intensity foreground/background colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
780	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
781	reachable.	749	reachable.
782		750
783	=item B<selectstyle:> I<mode>
784
785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
786	is xterm style with 2.20 old word selection, or anything else which
787	gives xterm style selection. Only effective when the original (non-perl)
788	selection code is in use.
789
790	=item B<scrollstyle:> I<mode>
791
792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793	the author's favourite.
794
795	=item B<title:> I<string>	751	=item B<title:> I<string>
796		752
797	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
798	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
799	name; option B<-title>.	755	name; option B<-title>.
…		…
812	=item B<urgentOnBell:> I<boolean>	768	=item B<urgentOnBell:> I<boolean>
813		769
814	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.
815	B<False>: do not set the urgency hint [default].	771	B<False>: do not set the urgency hint [default].
816		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
817	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
818		776
819	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>.
820	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
821		779
…		…
844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845		803
846	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
847	every time you hit C<Print>.	805	every time you hit C<Print>.
848		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
849	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
850		817
851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
853		820
…		…
872	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
873	B<+si>.	840	B<+si>.
874		841
875	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
876		843
877	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.
878	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
879	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>.
880		848
881	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
882		850
883	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
884	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
…		…
940	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
941		909
942	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];
943	option B<-bc>.	911	option B<-bc>.
944		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
945	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
946		919
947	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
948	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
949	[default].	922	[default].
…		…
962	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
963		936
964	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
965		938
966	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>
967	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>
968	(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
969	escape sequence.	942	escape sequence.
970		943
971	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
972		945
…		…
985	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.
986		959
987	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
988	be used. If not specified, the built-in default is used:	961	be used. If not specified, the built-in default is used:
989		962
990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
991		964
992	=item B<preeditType:> I<style>	965	=item B<preeditType:> I<style>
993		966
994	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995		968
…		…
1051		1024
1052	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
1053		1026
1054	Turn on/off secondary screen scroll (default enabled). If this	1027	Turn on/off secondary screen scroll (default enabled). If this
1055	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
1056	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
1057	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
1058		1031
1059	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
1060		1033
1061	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@@
1062	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1063	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1064	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>.
1065		1045
1066	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<string>
1067		1047
1068	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1069	intervening resource name B<keysym.> cannot be omitted.	1049	intervening resource name B<keysym.> cannot be omitted.
…		…
1083	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1063	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1084	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
1085	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
1086	performed in an exact manner; however, the closest match is assured.	1066	performed in an exact manner; however, the closest match is assured.
1087		1067
1088	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1089	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1069	number), see RESOURCES in C<man 7 X> for further details.
1090	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1091	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1092	can start or end with whitespace. B<This feature is deprecated and will
1093	be removed>.
1094		1070
1095	Please note that you need to double the C<\> in resource files, as
1096	Xlib itself does its own de-escaping (you can use C<\033> instead of
1097	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1098	processing).
1099
1100	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>
1101	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1102	should be a character not used by the strings.	1074	should be a character not used by the strings.
1103		1075
1104	Its usage can be demonstrated by an example:	1076	Its usage can be demonstrated by an example:
1105		1077
1106	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1107		1079
1108	The above line is equivalent to the following three lines:	1080	The above line is equivalent to the following three lines:
1109		1081
1110	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1082	URxvt.keysym.Meta-Control-0x61: \033<a>
1111	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1083	URxvt.keysym.Meta-Control-0x62: \033<b>
1112	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1084	URxvt.keysym.Meta-Control-0x63: \033<c>
1113		1085
1114	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>
1115	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1116	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>
1117	when Control-Meta-c is being pressed":	1089	when Control-Meta-c is being pressed":
1118		1090
1119	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
1120		1092
1121	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>
1122	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)
1123	manpage. For example, the F<selection> extension (activated via	1095	manpage. For example, the F<selection> extension (activated via
1124	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1125		1097
1126	URxvt.keysym.M-C-c: perl:selection:rot13	1098	URxvt.keysym.M-C-c: perl:selection:rot13
1127		1099
1128	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
1129	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
1130	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
1131	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
1132	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
1133	mappings themselves.	1105	mappings themselves.
1134		1106
…		…
1185	all instances, while B<perl-ext> is used for specific instances.	1157	all instances, while B<perl-ext> is used for specific instances.
1186		1158
1187	=item B<perl-eval>: I<string>	1159	=item B<perl-eval>: I<string>
1188		1160
1189	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
1190	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1162	the @@RXVT_NAME@@perl(3) manpage.
1191	will be ignored when running setuid/setgid.
1192		1163
1193	=item B<perl-lib>: I<path>	1164	=item B<perl-lib>: I<path>
1194		1165
1195	Colon-separated list of additional directories that hold extension	1166	Colon-separated list of additional directories that hold extension
1196	scripts. When looking for extensions specified by the C<perl> resource,	1167	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1197	@@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
1198	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1169	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1199	will be ignored when running setuid/setgid.
1200		1170
1201	See the @@RXVT_NAME@@perl(3) manpage.	1171	See the @@RXVT_NAME@@perl(3) manpage.
1202		1172
1203	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1173	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1204		1174
…		…
1213	=item B<searchable-scrollback:> I<keysym>	1183	=item B<searchable-scrollback:> I<keysym>
1214		1184
1215	Sets the hotkey that starts the incremental scrollback buffer search	1185	Sets the hotkey that starts the incremental scrollback buffer search
1216	(default: C<M-s>).	1186	(default: C<M-s>).
1217		1187
1218	=item B<urlLauncher>: I<string>	1188	=item B<url-launcher>: I<string>
1219		1189
1220	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
1221	C<selection-popup> and C<matcher> perl extensions.	1191	C<selection-popup> and C<matcher> perl extensions.
1222		1192
1223	=item B<transient-for>: I<windowid>	1193	=item B<transient-for>: I<windowid>
…		…
1227	=item B<override-redirect>: I<boolean>	1197	=item B<override-redirect>: I<boolean>
1228		1198
1229	Compile I<frills>: Sets override-redirect for the terminal window, making	1199	Compile I<frills>: Sets override-redirect for the terminal window, making
1230	it almost invisible to window managers; option B<-override-redirect>.	1200	it almost invisible to window managers; option B<-override-redirect>.
1231		1201
		1202	=item B<iso14755:> I<boolean>
		1203
		1204	Turn on/off ISO 14755 (default enabled).
		1205
1232	=item B<iso14755_52:> I<boolean>	1206	=item B<iso14755_52:> I<boolean>
1233		1207
1234	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.
1235		1323
1236	=back	1324	=back
1237		1325
1238	=head1 THE SCROLLBAR	1326	=head1 THE SCROLLBAR
1239		1327
…		…
1378	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
1379	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
1380	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
1381	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.
1382		1470
1383	=head1 COLORS AND GRAPHICS	1471	=head1 COLOURS AND GRAPHICS
1384		1472
1385	In addition to the default foreground and background colours,	1473	In addition to the default foreground and background colours,
1386	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
1387	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
1388	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.
1389		1480
1390	=begin table	1481	=begin table
1391		1482
1392	B<color0> (black) = Black	1483	B<color0> (black) = Black
1393	B<color1> (red) = Red3	1484	B<color1> (red) = Red3
…		…
1413	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>,
1414	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1505	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1415	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
1416	color0-color15.	1507	color0-color15.
1417		1508
1418	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1509	The following text gives values for the standard 88 colour mode (and
1419	additional 72 colours. The first 64 of those (with indices 16 to 79)	1510	values for the 256 colour mode in parentheses).
1420	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1421	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1422		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
1423	Together, all those colours implement the 88 colour xterm colours. Only	1521	Together, all those colours implement the 88 (256) colour xterm
1424	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
1425	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...).
1426		1527
1427	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1528	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1428	always swapping the foreground/background colours. This is in contrast to	1529	always swapping the foreground/background colours. This is in contrast to
1429	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
1430	been specified. For example,	1531	been specified. For example,
1431		1532
1432	=over 4
1433
1434	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1533	@@RXVT_NAME@@ -fg Black -bg White -rv
1435		1534
1436	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
1437	on White.	1536	White.
1438
1439	=back
1440		1537
1441	=head2 ALPHA CHANNEL SUPPORT	1538	=head2 ALPHA CHANNEL SUPPORT
1442		1539
1443	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
1444	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:
1445	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1542
1446	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
1447	specifies opacity (alpha) values. The minimum value of C<0> is completely	1554	(alpha) values. The minimum value of C<0000> is completely transparent,
1448	transparent). You can also prefix any color with C<[percent]>, where	1555	while C<ffff> is completely opaque). The two example colours from
1449	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
1450	the color, where C<0> is completely transparent and C<100> is completelxy	1557	C<rgba:0000/ff00/0000/f332>.
1451	opaque.
1452		1558
1453	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
1454	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
1455	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.
1456		1563
1457	For example, the following selects an almost completely transparent red	1564	For example, the following selects an almost completely transparent black
1458	background, and an almost opaque pink foreground:	1565	background, and an almost opaque pink foreground:
1459		1566
1460	@@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"
1461		1568
1462	I<Please note that transparency of any kind if completely unsupported by	1569	When not using a background image, then the interpretation of the
1463	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.
1464		1583
1465	=head1 ENVIRONMENT	1584	=head1 ENVIRONMENT
1466		1585
1467	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1586	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1468		1587
…		…
1474	resources or on the command line.	1593	resources or on the command line.
1475		1594
1476	=item B<COLORTERM>	1595	=item B<COLORTERM>
1477		1596
1478	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1597	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1479	compiled with background image support, and optionally with the added	1598	compiled with background image support, and optionally with the added
1480	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1599	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1481	screen.	1600	screen.
1482		1601
1483	=item B<COLORFGBG>	1602	=item B<COLORFGBG>
1484		1603
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1604	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486	the colour code used as default foreground/text colour (or the string	1605	the colour code used as default foreground/text colour (or the string
1487	C<default> to indicate that the default-colour escape sequence is to be	1606	C<default> to indicate that the default-colour escape sequence is to be
1488	used), C<bg> is the colour code used as default background colour (or the	1607	used), C<bg> is the colour code used as default background colour (or the
1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1608	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490	was compiled with background image support. Libraries like C<ncurses>	1609	was compiled with background image support. Libraries like C<ncurses>
1491	and C<slang> can (and do) use this information to optimize screen output.	1610	and C<slang> can (and do) use this information to optimize screen output.
1492		1611
1493	=item B<WINDOWID>	1612	=item B<WINDOWID>
1494		1613
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1614	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1502	C<--with-terminfo=PATH>.	1621	C<--with-terminfo=PATH>.
1503		1622
1504	=item B<DISPLAY>	1623	=item B<DISPLAY>
1505		1624
1506	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
1507	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.
1508		1628
1509	=item B<SHELL>	1629	=item B<SHELL>
1510		1630
1511	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>.
1512		1632
1513	=item B<RXVT_SOCKET>	1633	=item B<RXVT_SOCKET> [I<sic>]
1514		1634
1515	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
1516	@@RXVT_NAME@@d(1).	1636	@@RXVT_NAME@@d(1).
1517		1637
1518	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).
1519		1649
1520	=item B<HOME>	1650	=item B<HOME>
1521		1651
1522	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
1523	daemon communications and to locate various resource files (such as	1653	daemon communications and to locate various resource files (such as
1524	C<.Xdefaults>)	1654	C<.Xdefaults>)
1525		1655
1526	=item B<XAPPLRESDIR>	1656	=item B<XAPPLRESDIR>
1527		1657
1528	Directory where various X resource files are being located.	1658	Directory where application-specific X resource files are located.
1529		1659
1530	=item B<XENVIRONMENT>	1660	=item B<XENVIRONMENT>
1531		1661
1532	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
1533	@@RXVT_NAME@@.	1663	@@RXVT_NAME@@.
…		…
1538		1668
1539	=over 4	1669	=over 4
1540		1670
1541	=item B</usr/lib/X11/rgb.txt>	1671	=item B</usr/lib/X11/rgb.txt>
1542		1672
1543	Color names.	1673	Colour names.
1544		1674
1545	=back	1675	=back
1546		1676
1547	=head1 SEE ALSO	1677	=head1 SEE ALSO
1548		1678
		1679	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1549	@@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)
1550		1681
1551	=head1 CURRENT PROJECT COORDINATOR	1682	=head1 CURRENT PROJECT COORDINATOR
1552		1683
1553	=over 4	1684	=over 4
1554		1685
1555	=item Project Coordinator	1686	=item Project Coordinator
1556		1687
1557	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1688	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1558		1689
1559	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1690	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1560		1691
1561	=back	1692	=back
1562		1693
…		…
1566		1697
1567	=item John Bovey	1698	=item John Bovey
1568		1699
1569	University of Kent, 1992, wrote the original Xvt.	1700	University of Kent, 1992, wrote the original Xvt.
1570		1701
1571	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1702	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1572		1703
1573	very heavily modified Xvt and came up with Rxvt	1704	very heavily modified Xvt and came up with Rxvt
1574		1705
1575	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1706	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1576		1707
1577	wrote the Greek Keyboard Input (no longer in code)	1708	wrote the Greek Keyboard Input (no longer in code)
1578		1709
1579	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1710	=item mj olesen <olesen@me.QueensU.CA>
1580		1711
1581	Wrote the menu system.	1712	Wrote the menu system.
1582		1713
1583	Project Coordinator (changes.txt 2.11 to 2.21)	1714	Project Coordinator (changes.txt 2.11 to 2.21)
1584		1715
1585	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1716	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1586		1717
1587	Project Coordinator (changes.txt 2.21a to 2.4.5)	1718	Project Coordinator (changes.txt 2.21a to 2.4.5)
1588		1719
1589	=item Geoff Wing L<< <gcw@pobox.com> >>	1720	=item Geoff Wing <gcw@pobox.com>
1590		1721
1591	Rewrote screen display and text selection routines.	1722	Rewrote screen display and text selection routines.
1592		1723
1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1724	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594		1725
1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1726	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1596		1727
1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1728	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1598	extension, random hacks, numerous bugfixes and extensions.	1729	extension, random hacks, numerous bugfixes and extensions.
1599		1730
1600	Project Coordinator (Changes 1.0 -)	1731	Project Coordinator (Changes 1.0 -)
1601		1732
1602	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1733	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1603		1734
1604	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1735	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1605		1736
1606	=back	1737	=back
1607		1738

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs. Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC