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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC vs. Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.137 by root, Sat Sep 1 09:38:50 2007 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC