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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.200 by sf-exg, Wed Aug 10 07:28:35 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
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. 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>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
123		133
124	=item B<-fade> I<number>	134	=item B<-fade> I<number>
125		135
126	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
127	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
…		…
132	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
133	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
134		144
135	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
136		146
137	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource
141	I<tintColor>. Example:
142		149
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
144		151
145	=item B<-sh>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
149	specified, too, e.g. C<-tint white>); resource I<shading>.	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified - both vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and another to a large number creates interesting effects
		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>.
150		179
151	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
152		181
153	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
154		183
155	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
156		185
157	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
158		187
159	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160		189
161	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
162	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
163	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
164	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
165		194
166	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
167		196
168	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
169		198
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	244	for details.
216		245
217	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
218		247
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
221	details.	250	details.
222		251
223	=item B<-name> I<name>	252	=item B<-name> I<name>
224		253
…		…
242		271
243	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
244		273
245	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
246		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
247	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
248		286
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
251		289
…		…
257	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
258		296
259	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.
260	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
262
263	=item B<-sr>\|B<+sr>
264
265	Put scrollbar on right/left; resource B<scrollBar_right>.
266
267	=item B<-st>\|B<+st>
268
269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270	resource B<scrollBar_floating>.
271		300
272	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
273		302
274	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
275	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
…		…
279		308
280	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
281		310
282	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
283		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
284	=item B<-iconic>	317	=item B<-iconic>
285		318
286	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
288		321
…		…
304		337
305	=item B<-bl>	338	=item B<-bl>
306		339
307	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.
308	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
309	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.
310		344
311	=item B<-override-redirect>	345	=item B<-override-redirect>
312		346
313	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	348	B<override-redirect>.
…		…
322		356
323	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
324		358
325	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
326	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
327	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>.
328		369
329	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
330		371
331	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
332	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
387		428
388	=item B<-tcw>	429	=item B<-tcw>
389		430
390	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
391	button. Only effective when the original (non-perl) selection code is	432	button. Only effective when the original (non-perl) selection code is
392	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
393	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
394		435
395	=item B<-insecure>	436	=item B<-insecure>
396		437
397	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
398	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
418		459
419	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@@
420	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
421	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
422	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.
423		483
424	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
425		485
426	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
427		487
…		…
462	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
463	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
464	yourself if you want that.	524	yourself if you want that.
465		525
466	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
467	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
468		529
469	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
470	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
471		532
472	use IO::Pty;	533	use IO::Pty;
…		…
486	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
487	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
488		549
489	=back	550	=back
490		551
491	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
492		553
493	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
494	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
495		557
496	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
497	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
498	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
499	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
500		562
501	1. system-wide app-defaults file, either locale-dependent OR global
502	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
503	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
504	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
505	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
506		569
507	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
508	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
509	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
510	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
520	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
521		584
522	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;
523	option B<-depth>.	586	option B<-depth>.
524		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
525	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
526		596
527	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
528	option B<-geometry>.	598	option B<-geometry>.
529		599
…		…
542	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
543	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
544	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
545	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,
546	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
547	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
548		618
549	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
550	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
551		621
552	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
…		…
563	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
564		634
565	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
566	foreground colour is the default.	636	foreground colour is the default.
567		637
568	=item B<colorRV:> I<colour>
569
570	Use the specified colour as the background for reverse video characters
571	when OPTION_HC is disabled (--disable-frills).
572
573	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
574		639
575	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
576	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.
577		652
578	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
579		654
580	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
581	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
588		663
589	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
590		665
591	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
592	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
593	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
594		669
595	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
596		671
597	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
598	quickly, fewer screen updates are performed [default]; option B<-j>.	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		674	has been read, resulting in fewer updates while still displaying every
		675	received line; option B<-j>.
		676
599	B<False>: specify that smooth scrolling should be used; option B<+j>.	677	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		678	force a screen refresh on each new line it received; option B<+j>.
600		679
601	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
602		681
603	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
604	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
605	pixmap.	684	(around 60 times per second), resulting in far fewer updates. This can
		685	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		686	option B<-ss>.
606		687
607	I<Please note that transparency of any kind if completely unsupported by	688	B<False>: specify that everything is to be displayed, even
608	the author. Don't bug him with installation questions!>	689	if the refresh is too fast for the human eye to read anything (or the
		690	monitor to display anything); option B<+ss>.
		691
		692	=item B<transparent:> I<boolean>
		693
		694	Turn on/off pseudo-transparency by using the root pixmap as background.
		695
		696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		697	future versions.
609		698
610	=item B<fading:> I<number>	699	=item B<fading:> I<number>
611		700
612	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>.
613		702
…		…
616	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
617	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
618		707
619	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
620		709
621	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
622	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>.
623		715
624	=item B<shading:> I<number>	716	=item B<shading:> I<number>
625		717
626	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
627	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
		720
		721	=item B<blendType:> I<string>
		722
		723	Specify background blending type; option B<-blt>.
		724
		725	=item B<blurRadius:> I<number>
		726
		727	Apply gaussian blur with the specified radius to the transparent
		728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
628		733
629	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
630		735
631	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
632		737
…		…
638	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
639		744
640	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
641	and the text.	746	and the text.
642		747
643	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
644		749
645	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
646	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
647	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
648	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
649	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
650	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
651	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
652	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
653	scale is 1000. [default 0x0+50+50]	758
		759	tile will tile image
		760	propscale will scale image keeping proportions
		761	scale will scale image to match window size
		762	root will tile image as if it was a root window background, auto-adjusting
		763	whenever terminal window moves
		764
		765	If used in conjunction with B<-tr> option, the specified pixmap will be
		766	blended over the transparent background using alpha-blending. If I<afterimage>
		767	support has been compiled in it is possible to choose other blending
		768	types with B<-blt "type"> option.
654		769
655	=item B<path:> I<path>	770	=item B<path:> I<path>
656		771
657	Specify the colon-delimited search path for finding XPM files.	772	Specify the colon-delimited search path for finding background image files.
658		773
659	=item B<font:> I<fontlist>	774	=item B<font:> I<fontlist>
660		775
661	Select the fonts to be used. This is a comma separated list of font names	776	Select the fonts to be used. This is a comma separated list of font names
662	that are checked in order when trying to find glyphs for characters. The	777	that are checked in order when trying to find glyphs for characters. The
…		…
685	it is named first) and thus defines the character cell grid to be 9 pixels	800	it is named first) and thus defines the character cell grid to be 9 pixels
686	wide and 15 pixels high.	801	wide and 15 pixels high.
687		802
688	The second font is just used to add additional unicode characters not in	803	The second font is just used to add additional unicode characters not in
689	the base font, likewise the third, which is unfortunately non-bold, but	804	the base font, likewise the third, which is unfortunately non-bold, but
690	the bold version of the font does contain less characters, so this is a	805	the bold version of the font does contain fewer characters, so this is a
691	useful supplement.	806	useful supplement.
692		807
693	The third font is an Xft font with aliasing turned off, and the characters	808	The third font is an Xft font with aliasing turned off, and the characters
694	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	809	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
695	contains other characters, but we are not interested in them.	810	contains other characters, but we are not interested in them.
…		…
719	text font will being used for the given style.	834	text font will being used for the given style.
720		835
721	=item B<intensityStyles:> I<boolean>	836	=item B<intensityStyles:> I<boolean>
722		837
723	When font styles are not enabled, or this option is enabled (B<True>,	838	When font styles are not enabled, or this option is enabled (B<True>,
724	option B<-is>, the default), bold and italic font styles imply high	839	option B<-is>, the default), bold/blink font styles imply high
725	intensity foreground/background colours. Disabling this option (B<False>,	840	intensity foreground/background colours. Disabling this option (B<False>,
726	option B<+is>) disables this behaviour, the high intensity colours are not	841	option B<+is>) disables this behaviour, the high intensity colours are not
727	reachable.	842	reachable.
728		843
729	=item B<selectstyle:> I<mode>
730
731	Set mouse selection style to B<old> which is 2.20, B<oldword> which
732	is xterm style with 2.20 old word selection, or anything else which
733	gives xterm style selection. Only effective when the original (non-perl)
734	selection code is in use.
735
736	=item B<scrollstyle:> I<mode>
737
738	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
739	the author's favourite.
740
741	=item B<title:> I<string>	844	=item B<title:> I<string>
742		845
743	Set window title string, the default title is the command-line	846	Set window title string, the default title is the command-line
744	specified after the B<-e> option, if any, otherwise the application	847	specified after the B<-e> option, if any, otherwise the application
745	name; option B<-title>.	848	name; option B<-title>.
…		…
758	=item B<urgentOnBell:> I<boolean>	861	=item B<urgentOnBell:> I<boolean>
759		862
760	B<True>: set the urgency hint for the wm on receipt of a bell character.	863	B<True>: set the urgency hint for the wm on receipt of a bell character.
761	B<False>: do not set the urgency hint [default].	864	B<False>: do not set the urgency hint [default].
762		865
		866	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		867
763	=item B<visualBell:> I<boolean>	868	=item B<visualBell:> I<boolean>
764		869
765	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	870	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
766	B<False>: no visual bell [default]; option B<+vb>.	871	B<False>: no visual bell [default]; option B<+vb>.
767		872
…		…
790	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	895	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
791		896
792	This creates a new file in your home directory with the screen contents	897	This creates a new file in your home directory with the screen contents
793	every time you hit C<Print>.	898	every time you hit C<Print>.
794		899
		900	=item B<scrollstyle:> I<mode>
		901
		902	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		903	the author's favourite.
		904
		905	=item B<thickness:> I<number>
		906
		907	Set the scrollbar width in pixels.
		908
795	=item B<scrollBar:> I<boolean>	909	=item B<scrollBar:> I<boolean>
796		910
797	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	911	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
798	disable the scrollbar; option B<+sb>.	912	disable the scrollbar; option B<+sb>.
799		913
…		…
818	B<False>: do not scroll to bottom when tty receives output; option	932	B<False>: do not scroll to bottom when tty receives output; option
819	B<+si>.	933	B<+si>.
820		934
821	=item B<scrollWithBuffer:> I<boolean>	935	=item B<scrollWithBuffer:> I<boolean>
822		936
823	B<True>: scroll with scrollback buffer when tty receives new lines (and	937	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
824	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	938	try to show the same lines) and B<scrollTtyOutput> is False; option
825	with scrollback buffer when tty receives new lines; option B<+sw>.	939	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		940	new lines; option B<+sw>.
826		941
827	=item B<scrollTtyKeypress:> I<boolean>	942	=item B<scrollTtyKeypress:> I<boolean>
828		943
829	B<True>: scroll to bottom when a non-special key is pressed. Special keys	944	B<True>: scroll to bottom when a non-special key is pressed. Special keys
830	are those which are intercepted by rxvt-unicode for special handling and	945	are those which are intercepted by rxvt-unicode for special handling and
…		…
861	=item B<termName:> I<termname>	976	=item B<termName:> I<termname>
862		977
863	Specifies the terminal type name to be set in the B<TERM> environment	978	Specifies the terminal type name to be set in the B<TERM> environment
864	variable; option B<-tn>.	979	variable; option B<-tn>.
865		980
866	=item B<linespace:> I<number>	981	=item B<lineSpace:> I<number>
867		982
868	Specifies number of lines (pixel height) to insert between each row of	983	Specifies number of lines (pixel height) to insert between each row of
869	the display [default 0]; option B<-lsp>.	984	the display [default 0]; option B<-lsp>.
870		985
871	=item B<meta8:> I<boolean>	986	=item B<meta8:> I<boolean>
…		…
885		1000
886	=item B<cursorBlink:> I<boolean>	1001	=item B<cursorBlink:> I<boolean>
887		1002
888	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1003	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
889	option B<-bc>.	1004	option B<-bc>.
		1005
		1006	=item B<cursorUnderline:> I<boolean>
		1007
		1008	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1009	option B<-uc>.
890		1010
891	=item B<pointerBlank:> I<boolean>	1011	=item B<pointerBlank:> I<boolean>
892		1012
893	B<True>: blank the pointer when a key is pressed or after a set number	1013	B<True>: blank the pointer when a key is pressed or after a set number
894	of seconds of inactivity. B<False>: the pointer is always visible	1014	of seconds of inactivity. B<False>: the pointer is always visible
…		…
908	large number (e.g. C<987654321>) to effectively disable the timeout.	1028	large number (e.g. C<987654321>) to effectively disable the timeout.
909		1029
910	=item B<backspacekey:> I<string>	1030	=item B<backspacekey:> I<string>
911		1031
912	The string to send when the backspace key is pressed. If set to B<DEC>	1032	The string to send when the backspace key is pressed. If set to B<DEC>
913	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1033	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
914	(code 8) - which can be reversed with the appropriate DEC private mode	1034	(code 8) - which can be reversed with the appropriate DEC private mode
915	escape sequence.	1035	escape sequence.
916		1036
917	=item B<deletekey:> I<string>	1037	=item B<deletekey:> I<string>
918		1038
…		…
931	will be created). In this mode, characters outside ISO-8859-1 can be used.	1051	will be created). In this mode, characters outside ISO-8859-1 can be used.
932		1052
933	When the selection extension is not used, only ISO-8859-1 characters can	1053	When the selection extension is not used, only ISO-8859-1 characters can
934	be used. If not specified, the built-in default is used:	1054	be used. If not specified, the built-in default is used:
935		1055
936	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1056	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
937		1057
938	=item B<preeditType:> I<style>	1058	=item B<preeditType:> I<style>
939		1059
940	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1060	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
941		1061
…		…
997		1117
998	=item B<secondaryScroll:> I<boolean>	1118	=item B<secondaryScroll:> I<boolean>
999		1119
1000	Turn on/off secondary screen scroll (default enabled). If this	1120	Turn on/off secondary screen scroll (default enabled). If this
1001	option is enabled, scrolls on the secondary screen will change the	1121	option is enabled, scrolls on the secondary screen will change the
1002	scrollback buffer and switching to/from the secondary screen will	1122	scrollback buffer and, when secondaryScreen is off, switching
1003	instead scroll the screen up.	1123	to/from the secondary screen will instead scroll the screen up.
1004		1124
1005	=item B<hold>: I<boolean>	1125	=item B<hold>: I<boolean>
1006		1126
1007	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1127	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1008	will not immediately destroy its window when the program executed within	1128	will not immediately destroy its window when the program executed within
1009	it exits. Instead, it will wait till it is being killed or closed by the	1129	it exits. Instead, it will wait till it is being killed or closed by the
1010	user.	1130	user.
		1131
		1132	=item B<chdir>: I<path>
		1133
		1134	Sets the working directory for the shell (or the command specified via
		1135	B<-e>). The I<path> must be an absolute path and it must exist for
		1136	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1137	directory will be used; option B<-cd>.
1011		1138
1012	=item B<keysym.>I<sym>: I<string>	1139	=item B<keysym.>I<sym>: I<string>
1013		1140
1014	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1141	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1015	intervening resource name B<keysym.> cannot be omitted.	1142	intervening resource name B<keysym.> cannot be omitted.
…		…
1029	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1156	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1030	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1157	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1031	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1158	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1032	performed in an exact manner; however, the closest match is assured.	1159	performed in an exact manner; however, the closest match is assured.
1033		1160
1034	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1161	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1035	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1162	number), see RESOURCES in C<man 7 X> for further details.
1036	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1037	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1038	can start or end with whitespace. B<This feature is deprecated and will
1039	be removed>.
1040
1041	Please note that you need to double the C<\> in resource files, as
1042	Xlib itself does its own de-escaping (you can use C<\033> instead of
1043	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1044	processing).
1045		1163
1046	You can define a range of keysyms in one shot by providing a I<string>	1164	You can define a range of keysyms in one shot by providing a I<string>
1047	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1165	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1048	should be a character not used by the strings.	1166	should be a character not used by the strings.
1049		1167
1050	Its usage can be demonstrated by an example:	1168	Its usage can be demonstrated by an example:
1051		1169
1052	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1170	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1053		1171
1054	The above line is equivalent to the following three lines:	1172	The above line is equivalent to the following three lines:
1055		1173
1056	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1174	URxvt.keysym.Meta-Control-0x61: \033<a>
1057	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1175	URxvt.keysym.Meta-Control-0x62: \033<b>
1058	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1176	URxvt.keysym.Meta-Control-0x63: \033<c>
1059		1177
1060	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1178	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1061	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1179	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1062	example the following means "change the current locale to C<zh_CN.GBK>	1180	example the following means "change the current locale to C<zh_CN.GBK>
1063	when Control-Meta-c is being pressed":	1181	when Control-Meta-c is being pressed":
1064		1182
1065	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1183	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1066		1184
1067	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1185	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1068	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1186	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1069	manpage. For example, the F<selection> extension (activated via	1187	manpage. For example, the F<selection> extension (activated via
1070	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1188	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1071		1189
1072	URxvt.keysym.M-C-c: perl:selection:rot13	1190	URxvt.keysym.M-C-c: perl:selection:rot13
1073		1191
1074	Due the the large number of modifier combinations, a defined key mapping	1192	Due the the large number of modifier combinations, a defined key mapping
1075	will match if at I<at least> the specified identifiers are being set, and	1193	will match if I<at least> the specified identifiers are being set, and
1076	no other key mappings with those and more bits are being defined. That	1194	no other key mappings with those and more bits are being defined. That
1077	means that defining a key map for C<a> will automatically provide	1195	means that defining a key map for C<a> will automatically provide
1078	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1196	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1079	mappings themselves.	1197	mappings themselves.
1080		1198
…		…
1131	all instances, while B<perl-ext> is used for specific instances.	1249	all instances, while B<perl-ext> is used for specific instances.
1132		1250
1133	=item B<perl-eval>: I<string>	1251	=item B<perl-eval>: I<string>
1134		1252
1135	Perl code to be evaluated when all extensions have been registered. See	1253	Perl code to be evaluated when all extensions have been registered. See
1136	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1254	the @@RXVT_NAME@@perl(3) manpage.
1137	will be ignored when running setuid/setgid.
1138		1255
1139	=item B<perl-lib>: I<path>	1256	=item B<perl-lib>: I<path>
1140		1257
1141	Colon-separated list of additional directories that hold extension	1258	Colon-separated list of additional directories that hold extension
1142	scripts. When looking for extensions specified by the C<perl> resource,	1259	scripts. When looking for extensions specified by the C<perl> resource,
1143	@@RXVT_NAME@@ will first look in these directories and then in	1260	@@RXVT_NAME@@ will first look in these directories and then in
1144	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1261	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1145	will be ignored when running setuid/setgid.
1146		1262
1147	See the @@RXVT_NAME@@perl(3) manpage.	1263	See the @@RXVT_NAME@@perl(3) manpage.
1148		1264
1149	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1265	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1150		1266
…		…
1172		1288
1173	=item B<override-redirect>: I<boolean>	1289	=item B<override-redirect>: I<boolean>
1174		1290
1175	Compile I<frills>: Sets override-redirect for the terminal window, making	1291	Compile I<frills>: Sets override-redirect for the terminal window, making
1176	it almost invisible to window managers; option B<-override-redirect>.	1292	it almost invisible to window managers; option B<-override-redirect>.
		1293
		1294	=item B<iso14755:> I<boolean>
		1295
		1296	Turn on/off ISO 14755 (default enabled).
		1297
		1298	=item B<iso14755_52:> I<boolean>
		1299
		1300	Turn on/off ISO 14755 5.2 mode (default enabled).
1177		1301
1178	=back	1302	=back
1179		1303
1180	=head1 THE SCROLLBAR	1304	=head1 THE SCROLLBAR
1181		1305
…		…
1252		1376
1253	=head1 ISO 14755 SUPPORT	1377	=head1 ISO 14755 SUPPORT
1254		1378
1255	ISO 14755 is a standard for entering and viewing unicode characters	1379	ISO 14755 is a standard for entering and viewing unicode characters
1256	and character codes using the keyboard. It consists of 4 parts. The	1380	and character codes using the keyboard. It consists of 4 parts. The
1257	first part is available rxvt-unicode has been compiled with	1381	first part is available if rxvt-unicode has been compiled with
1258	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1382	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1259	with C<--enable-iso14755>.	1383	with C<--enable-iso14755>.
1260		1384
1261	=over 4	1385	=over 4
1262		1386
…		…
1320	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1444	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1321	it can be seen via the I<who(1)> command, and can accept messages. To	1445	it can be seen via the I<who(1)> command, and can accept messages. To
1322	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1446	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1323	on some systems or setgid to root or to some other group on others.	1447	on some systems or setgid to root or to some other group on others.
1324		1448
1325	=head1 COLORS AND GRAPHICS	1449	=head1 COLOURS AND GRAPHICS
1326		1450
1327	In addition to the default foreground and background colours,	1451	In addition to the default foreground and background colours,
1328	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1452	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1329	high-intensity bold/blink versions of the same). Here is a list of the	1453	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1330	colours with their names.	1454	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1455	cube plus a 8 (24) colour greyscale ramp.
		1456
		1457	Here is a list of the ANSI colours with their names.
1331		1458
1332	=begin table	1459	=begin table
1333		1460
1334	B<color0> (black) = Black	1461	B<color0> (black) = Black
1335	B<color1> (red) = Red3	1462	B<color1> (red) = Red3
…		…
1355	It is also possible to specify the colour values of B<foreground>,	1482	It is also possible to specify the colour values of B<foreground>,
1356	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1483	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1357	a number 0-15, as a convenient shorthand to reference the colour name of	1484	a number 0-15, as a convenient shorthand to reference the colour name of
1358	color0-color15.	1485	color0-color15.
1359		1486
1360	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1487	The following text gives values for the standard 88 colour mode (and
1361	additional 72 colours. The first 64 of those (with indices 16 to 79)	1488	values for the 256 colour mode in parentheses).
1362	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1363	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1364		1489
		1490	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1491
		1492	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1493	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1494
		1495	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1496	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1497	the RGB cube.
		1498
1365	Together, all those colours implement the 88 colour xterm colours. Only	1499	Together, all those colours implement the 88 (256) colour xterm
1366	the first 16 can be changed using resources currently, the rest can only	1500	colours. Only the first 16 can be changed using resources currently, the
1367	be changed via command sequences ("escape codes").	1501	rest can only be changed via command sequences ("escape codes").
		1502
		1503	Applications are advised to use terminfo or command sequences to discover
		1504	number and RGB values of all colours (yes, you can query this...).
1368		1505
1369	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1506	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1370	always swapping the foreground/background colours. This is in contrast to	1507	always swapping the foreground/background colours. This is in contrast to
1371	I<xterm>(1) where the colours are only swapped if they have not otherwise	1508	I<xterm>(1) where the colours are only swapped if they have not otherwise
1372	been specified. For example,	1509	been specified. For example,
1373		1510
1374	=over 4
1375
1376	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1511	@@RXVT_NAME@@ -fg Black -bg White -rv
1377		1512
1378	would yield White on Black, while on I<xterm>(1) it would yield Black	1513	would yield White on Black, while on I<xterm>(1) it would yield Black on
1379	on White.	1514	White.
1380
1381	=back
1382		1515
1383	=head2 ALPHA CHANNEL SUPPORT	1516	=head2 ALPHA CHANNEL SUPPORT
1384		1517
1385	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1518	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1386	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1519	their act together, rxvt-unicode will do it's own alpha channel management:
1387	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1520
1388	in addition to the ones provided by X, where the additional A component	1521	You can prefix any colour with an opaqueness percentage enclosed in
		1522	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1523	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1524	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1525	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1526	is the recommended format to specify transparency values, and works with
		1527	all ways to specify a colour.
		1528
		1529	For complete control, rxvt-unicode also supports
		1530	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1531	specifications, where the additional C<aaaa> component specifies opacity
1389	specifies opacity (alpha) values. The minimum value of C<0> is completely	1532	(alpha) values. The minimum value of C<0000> is completely transparent,
1390	transparent). You can also prefix any color with C<[percent]>, where	1533	while C<ffff> is completely opaque). The two example colours from
1391	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1534	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1392	the color, where C<0> is completely transparent and C<100> is completelxy	1535	C<rgba:0000/ff00/0000/f332>.
1393	opaque.
1394		1536
1395	You probably need to specify B<"-depth 32">, too, and have the luck that	1537	You probably need to specify B<"-depth 32">, too, to force a visual with
1396	your X-server uses ARGB pixel layout, as X is far from just supporting	1538	alpha channels, and have the luck that your X-server uses ARGB pixel
1397	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1539	layout, as X is far from just supporting ARGB visuals out of the box, and
		1540	rxvt-unicode just fudges around.
1398		1541
1399	For example, the following selects an almost completely transparent red	1542	For example, the following selects an almost completely transparent black
1400	background, and an almost opaque pink foreground:	1543	background, and an almost opaque pink foreground:
1401		1544
1402	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1545	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1403		1546
1404	I<Please note that transparency of any kind if completely unsupported by	1547	When not using a background image, then the interpretation of the
1405	the author. Don't bug him with installation questions!>	1548	alpha channel is up to your compositing manager (most interpret it as
		1549	transparency of course).
		1550
		1551	When using a background pixmap or pseudo-transparency, then the background
		1552	colour will always behave as if it were completely transparent (so the
		1553	background image shows instead), regardless of how it was specified, while
		1554	other colours will either be transparent as specified (the background
		1555	image will show through) on servers supporting the RENDER extension, or
		1556	fully opaque on servers not supporting the RENDER EXTENSION.
		1557
		1558	Please note that due to bugs in Xft, specifying alpha values might result
		1559	in garbage being displayed when the X-server does not support the RENDER
		1560	extension.
1406		1561
1407	=head1 ENVIRONMENT	1562	=head1 ENVIRONMENT
1408		1563
1409	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1564	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1410		1565
…		…
1416	resources or on the command line.	1571	resources or on the command line.
1417		1572
1418	=item B<COLORTERM>	1573	=item B<COLORTERM>
1419		1574
1420	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1575	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1421	compiled with XPM support, and optionally with the added extension	1576	compiled with background image support, and optionally with the added
1422	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1577	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1578	screen.
1423		1579
1424	=item B<COLORFGBG>	1580	=item B<COLORFGBG>
1425		1581
1426	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1582	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1427	the colour code used as default foreground/text colour (or the string	1583	the colour code used as default foreground/text colour (or the string
1428	C<default> to indicate that the default-colour escape sequence is to be	1584	C<default> to indicate that the default-colour escape sequence is to be
1429	used), C<bg> is the colour code used as default background colour (or the	1585	used), C<bg> is the colour code used as default background colour (or the
1430	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1586	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1431	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1587	was compiled with background image support. Libraries like C<ncurses>
1432	(and do) use this information to optimize screen output.	1588	and C<slang> can (and do) use this information to optimize screen output.
1433		1589
1434	=item B<WINDOWID>	1590	=item B<WINDOWID>
1435		1591
1436	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1592	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1437	window, which usually has subwindows for the scrollbar, the terminal	1593	window, which usually has subwindows for the scrollbar, the terminal
…		…
1443	C<--with-terminfo=PATH>.	1599	C<--with-terminfo=PATH>.
1444		1600
1445	=item B<DISPLAY>	1601	=item B<DISPLAY>
1446		1602
1447	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1603	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1448	display in its child processes.	1604	display in its child processes if C<-display> isn't used to override. It
		1605	defaults to C<:0> if it doesn't exist.
1449		1606
1450	=item B<SHELL>	1607	=item B<SHELL>
1451		1608
1452	The shell to be used for command execution, defaults to C</bin/sh>.	1609	The shell to be used for command execution, defaults to C</bin/sh>.
1453		1610
1454	=item B<RXVT_SOCKET>	1611	=item B<RXVT_SOCKET>
1455		1612
1456	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1613	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1457	@@RXVT_NAME@@d(1).	1614	@@RXVT_NAME@@d(1).
1458		1615
1459	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1616	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1460		1617
1461	=item B<HOME>	1618	=item B<HOME>
1462		1619
1463	Used to locate the default directory for the unix domain socket for	1620	Used to locate the default directory for the unix domain socket for
1464	daemon communications and to locate various resource files (such as	1621	daemon communications and to locate various resource files (such as
1465	C<.Xdefaults>)	1622	C<.Xdefaults>)
1466		1623
1467	=item B<XAPPLRESDIR>	1624	=item B<XAPPLRESDIR>
1468		1625
1469	Directory where various X resource files are being located.	1626	Directory where application-specific X resource files are located.
1470		1627
1471	=item B<XENVIRONMENT>	1628	=item B<XENVIRONMENT>
1472		1629
1473	If set and accessible, gives the name of a X resource file to be loaded by	1630	If set and accessible, gives the name of a X resource file to be loaded by
1474	@@RXVT_NAME@@.	1631	@@RXVT_NAME@@.
…		…
1479		1636
1480	=over 4	1637	=over 4
1481		1638
1482	=item B</usr/lib/X11/rgb.txt>	1639	=item B</usr/lib/X11/rgb.txt>
1483		1640
1484	Color names.	1641	Colour names.
1485		1642
1486	=back	1643	=back
1487		1644
1488	=head1 SEE ALSO	1645	=head1 SEE ALSO
1489		1646
…		…
1528	Project Coordinator (changes.txt 2.21a to 2.4.5)	1685	Project Coordinator (changes.txt 2.21a to 2.4.5)
1529		1686
1530	=item Geoff Wing L<< <gcw@pobox.com> >>	1687	=item Geoff Wing L<< <gcw@pobox.com> >>
1531		1688
1532	Rewrote screen display and text selection routines.	1689	Rewrote screen display and text selection routines.
1533		1690
1534	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1691	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1535		1692
1536	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1693	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1537		1694
1538	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1695	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1540		1697
1541	Project Coordinator (Changes 1.0 -)	1698	Project Coordinator (Changes 1.0 -)
1542		1699
1543	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1700	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1544		1701
1545	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1702	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1546		1703
1547	=back	1704	=back
1548		1705

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs. Revision 1.200 by sf-exg, Wed Aug 10 07:28:35 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.200 by sf-exg, Wed Aug 10 07:28:35 2011 UTC