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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 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>
…		…
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<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off illusion of a transparent window background. Obsolete form of it is	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123		130
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will	132	future versions.
126	be phased out in future versions of rxvt!>
127
128	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		133
131	=item B<-fade> I<number>	134	=item B<-fade> I<number>
132		135
133	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
134	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
…		…
139	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
140	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
141		144
142	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
143		146
144	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
145	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
147	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them; resource
151	I<tintColor>. Example:
152
153	@@RXVT_NAME@@ -tr -tint blue -sh 40
154		149
155	=item B<-sh> I<number>	150	=item B<-sh> I<number>
156		151
157	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
159	resource I<shading>.
160		154
161	=item B<-blt> I<string>	155	=item B<-blt> I<string>
162		156
163	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
164	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
165	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
166	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
167	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>,
168	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
169	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
170		164
171	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
172		166
173	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
174	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
175	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
176	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
177	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
178	resource I<blurRadius>.	172	resource I<blurRadius>.
179		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>.
		179
180	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
181		181
182	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
183		183
184	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
185		185
186	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
187		187
188	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;oplist]>
189		189
190	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
191	optionally specify its scaling with a geometry string. Note you may need to	191	optionally specify a list of operations to modify it. Note you may need to
192	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
193	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
194		194
195	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
196		196
…		…
243	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
244	for details.	244	for details.
245		245
246	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
247		247
248	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
249	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
250	details.	250	details.
251		251
252	=item B<-name> I<name>	252	=item B<-name> I<name>
253		253
…		…
271		271
272	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
273		273
274	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
275		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
276	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
277		286
278	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
279	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
280		289
…		…
286	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
287		296
288	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.
289	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
290	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
291
292	=item B<-sr>\|B<+sr>
293
294	Put scrollbar on right/left; resource B<scrollBar_right>.
295
296	=item B<-st>\|B<+st>
297
298	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
299	resource B<scrollBar_floating>.
300		300
301	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
302		302
303	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
304	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
…		…
308		308
309	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
310		310
311	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
312		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
313	=item B<-iconic>	317	=item B<-iconic>
314		318
315	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
316	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
317		321
…		…
333		337
334	=item B<-bl>	338	=item B<-bl>
335		339
336	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.
337	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
338	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.
339		344
340	=item B<-override-redirect>	345	=item B<-override-redirect>
341		346
342	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
343	B<override-redirect>.	348	B<override-redirect>.
…		…
352	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
353		358
354	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
355	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
356	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>.
357		369
358	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
359		371
360	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
361	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
416		428
417	=item B<-tcw>	429	=item B<-tcw>
418		430
419	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
420	button. Only effective when the original (non-perl) selection code is	432	button. Only effective when the original (non-perl) selection code is
421	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
422	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
423		435
424	=item B<-insecure>	436	=item B<-insecure>
425		437
426	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
427	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
447		459
448	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@@
449	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
450	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
451	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.
452		483
453	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
454		485
455	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
456		487
…		…
491	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
492	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
493	yourself if you want that.	524	yourself if you want that.
494		525
495	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
496	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
497		529
498	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
499	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
500		532
501	use IO::Pty;	533	use IO::Pty;
…		…
515	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
516	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
517		549
518	=back	550	=back
519		551
520	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
521		553
522	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
523	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
524		557
525	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
526	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
527	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
528	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
529		562
530	1. system-wide app-defaults file, either locale-dependent OR global
531	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
532	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
533	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
534	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
535		569
536	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
537	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
538	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
539	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
549	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
550		584
551	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;
552	option B<-depth>.	586	option B<-depth>.
553		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
554	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
555		596
556	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
557	option B<-geometry>.	598	option B<-geometry>.
558		599
…		…
571	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
572	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
573	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
574	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,
575	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
576	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
577		618
578	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
579	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
580		621
581	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
…		…
592	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
593		634
594	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
595	foreground colour is the default.	636	foreground colour is the default.
596		637
597	=item B<colorRV:> I<colour>
598
599	Use the specified colour as the background for reverse video characters
600	when OPTION_HC is disabled (--disable-frills).
601
602	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
603		639
604	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
605	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.
606		652
607	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
608		654
609	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
610	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
617		663
618	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
619		665
620	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
621	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
622	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
623		669
624	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
625		671
626	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
627	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
…		…
641		687
642	B<False>: specify that everything is to be displayed, even	688	B<False>: specify that everything is to be displayed, even
643	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
644	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
645		691
646	=item B<inheritPixmap:> I<boolean>	692	=item B<transparent:> I<boolean>
647		693
648	B<True>: make the background inherit the parent windows' pixmap, giving	694	Turn on/off pseudo-transparency by using the root pixmap as background.
649	artificial transparency. B<False>: do not inherit the parent windows'
650	pixmap.
651		695
652	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
653	the author. Don't bug him with installation questions!>	697	future versions.
654		698
655	=item B<fading:> I<number>	699	=item B<fading:> I<number>
656		700
657	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>.
658		702
…		…
661	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
662	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
663		707
664	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
665		709
666	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
667	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>.
668		715
669	=item B<shading:> I<number>	716	=item B<shading:> I<number>
670		717
671	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
672	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
673		720
674	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
675		722
676	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
677		724
678	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
679		726
680	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
681	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>.
682		733
683	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
684		735
685	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
686		737
…		…
692	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
693		744
694	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
695	and the text.	746	and the text.
696		747
697	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
698		749
699	Use the specified image file for the background and also optionally	750	Use the specified image file for the background and also
700	specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
701	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	752	Supported operations are:
		753
		754	=over 4
		755
		756	=item B<WxH+X+Y>
		757
		758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
702	and B<"X" / "Y"> locate the image centre (percent).	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
703	A scale of 0 displays the image with tiling. A scale of 1 displays the	760	scale of 0 disables scaling. The maximum permitted scale is 1000.
704	image without any scaling. A scale of 2 to 9 specifies an integer	761
705	number of images in that direction. No image will be magnified beyond	762	=item B<op=tile>
706	10 times its original size. The maximum permitted scale is 1000.	763
707	Special string of B<"auto"> used as a geometry will cause image to be	764	enables tiling
708	automatically scaled to match window size.	765
		766	=item B<op=pscale>
		767
		768	enables proportional scaling
		769
		770	=item B<op=root>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=pscale
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
		809
709	If used in conjunction with B<-tr> option - specified pixmap will be	810	If used in conjunction with B<-tr> option, the specified pixmap will be
710	blended over transparency image using either alpha-blending, or any	811	blended over the transparent background using alpha-blending. If I<afterimage>
711	other blending type, specified with B<-blt "type"> option.	812	support has been compiled in it is possible to choose other blending
712	[default 0x0+50+50]	813	types with B<-blt "type"> option.
713		814
714	=item B<path:> I<path>	815	=item B<path:> I<path>
715		816
716	Specify the colon-delimited search path for finding background image files.	817	Specify the colon-delimited search path for finding background image files.
717		818
…		…
744	it is named first) and thus defines the character cell grid to be 9 pixels	845	it is named first) and thus defines the character cell grid to be 9 pixels
745	wide and 15 pixels high.	846	wide and 15 pixels high.
746		847
747	The second font is just used to add additional unicode characters not in	848	The second font is just used to add additional unicode characters not in
748	the base font, likewise the third, which is unfortunately non-bold, but	849	the base font, likewise the third, which is unfortunately non-bold, but
749	the bold version of the font does contain less characters, so this is a	850	the bold version of the font does contain fewer characters, so this is a
750	useful supplement.	851	useful supplement.
751		852
752	The third font is an Xft font with aliasing turned off, and the characters	853	The third font is an Xft font with aliasing turned off, and the characters
753	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	854	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
754	contains other characters, but we are not interested in them.	855	contains other characters, but we are not interested in them.
…		…
778	text font will being used for the given style.	879	text font will being used for the given style.
779		880
780	=item B<intensityStyles:> I<boolean>	881	=item B<intensityStyles:> I<boolean>
781		882
782	When font styles are not enabled, or this option is enabled (B<True>,	883	When font styles are not enabled, or this option is enabled (B<True>,
783	option B<-is>, the default), bold and italic font styles imply high	884	option B<-is>, the default), bold/blink font styles imply high
784	intensity foreground/background colours. Disabling this option (B<False>,	885	intensity foreground/background colours. Disabling this option (B<False>,
785	option B<+is>) disables this behaviour, the high intensity colours are not	886	option B<+is>) disables this behaviour, the high intensity colours are not
786	reachable.	887	reachable.
787		888
788	=item B<selectstyle:> I<mode>
789
790	Set mouse selection style to B<old> which is 2.20, B<oldword> which
791	is xterm style with 2.20 old word selection, or anything else which
792	gives xterm style selection. Only effective when the original (non-perl)
793	selection code is in use.
794
795	=item B<scrollstyle:> I<mode>
796
797	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
798	the author's favourite.
799
800	=item B<title:> I<string>	889	=item B<title:> I<string>
801		890
802	Set window title string, the default title is the command-line	891	Set window title string, the default title is the command-line
803	specified after the B<-e> option, if any, otherwise the application	892	specified after the B<-e> option, if any, otherwise the application
804	name; option B<-title>.	893	name; option B<-title>.
…		…
817	=item B<urgentOnBell:> I<boolean>	906	=item B<urgentOnBell:> I<boolean>
818		907
819	B<True>: set the urgency hint for the wm on receipt of a bell character.	908	B<True>: set the urgency hint for the wm on receipt of a bell character.
820	B<False>: do not set the urgency hint [default].	909	B<False>: do not set the urgency hint [default].
821		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
822	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
823		914
824	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	915	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
825	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
826		917
…		…
849	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	940	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
850		941
851	This creates a new file in your home directory with the screen contents	942	This creates a new file in your home directory with the screen contents
852	every time you hit C<Print>.	943	every time you hit C<Print>.
853		944
		945	=item B<scrollstyle:> I<mode>
		946
		947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		948	the author's favourite.
		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
854	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
855		955
856	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
857	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
858		958
…		…
877	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
878	B<+si>.	978	B<+si>.
879		979
880	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
881		981
882	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
883	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	983	try to show the same lines) and B<scrollTtyOutput> is False; option
884	with scrollback buffer when tty receives new lines; option B<+sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
885		986
886	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
887		988
888	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	B<True>: scroll to bottom when a non-special key is pressed. Special keys
889	are those which are intercepted by rxvt-unicode for special handling and	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
945	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
946		1047
947	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1048	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
948	option B<-bc>.	1049	option B<-bc>.
949		1050
		1051	=item B<cursorUnderline:> I<boolean>
		1052
		1053	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1054	option B<-uc>.
		1055
950	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
951		1057
952	B<True>: blank the pointer when a key is pressed or after a set number	1058	B<True>: blank the pointer when a key is pressed or after a set number
953	of seconds of inactivity. B<False>: the pointer is always visible	1059	of seconds of inactivity. B<False>: the pointer is always visible
954	[default].	1060	[default].
…		…
967	large number (e.g. C<987654321>) to effectively disable the timeout.	1073	large number (e.g. C<987654321>) to effectively disable the timeout.
968		1074
969	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
970		1076
971	The string to send when the backspace key is pressed. If set to B<DEC>	1077	The string to send when the backspace key is pressed. If set to B<DEC>
972	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1078	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
973	(code 8) - which can be reversed with the appropriate DEC private mode	1079	(code 8) - which can be reversed with the appropriate DEC private mode
974	escape sequence.	1080	escape sequence.
975		1081
976	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
977		1083
…		…
990	will be created). In this mode, characters outside ISO-8859-1 can be used.	1096	will be created). In this mode, characters outside ISO-8859-1 can be used.
991		1097
992	When the selection extension is not used, only ISO-8859-1 characters can	1098	When the selection extension is not used, only ISO-8859-1 characters can
993	be used. If not specified, the built-in default is used:	1099	be used. If not specified, the built-in default is used:
994		1100
995	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1101	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
996		1102
997	=item B<preeditType:> I<style>	1103	=item B<preeditType:> I<style>
998		1104
999	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1105	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1000		1106
…		…
1056		1162
1057	=item B<secondaryScroll:> I<boolean>	1163	=item B<secondaryScroll:> I<boolean>
1058		1164
1059	Turn on/off secondary screen scroll (default enabled). If this	1165	Turn on/off secondary screen scroll (default enabled). If this
1060	option is enabled, scrolls on the secondary screen will change the	1166	option is enabled, scrolls on the secondary screen will change the
1061	scrollback buffer and switching to/from the secondary screen will	1167	scrollback buffer and, when secondaryScreen is off, switching
1062	instead scroll the screen up.	1168	to/from the secondary screen will instead scroll the screen up.
1063		1169
1064	=item B<hold>: I<boolean>	1170	=item B<hold>: I<boolean>
1065		1171
1066	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1172	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1067	will not immediately destroy its window when the program executed within	1173	will not immediately destroy its window when the program executed within
1068	it exits. Instead, it will wait till it is being killed or closed by the	1174	it exits. Instead, it will wait till it is being killed or closed by the
1069	user.	1175	user.
		1176
		1177	=item B<chdir>: I<path>
		1178
		1179	Sets the working directory for the shell (or the command specified via
		1180	B<-e>). The I<path> must be an absolute path and it must exist for
		1181	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1182	directory will be used; option B<-cd>.
1070		1183
1071	=item B<keysym.>I<sym>: I<string>	1184	=item B<keysym.>I<sym>: I<string>
1072		1185
1073	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1074	intervening resource name B<keysym.> cannot be omitted.	1187	intervening resource name B<keysym.> cannot be omitted.
…		…
1089	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1202	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1090	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1091	performed in an exact manner; however, the closest match is assured.	1204	performed in an exact manner; however, the closest match is assured.
1092		1205
1093	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1206	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1094	number), see RESOURCES in C<man 7 X> for futher details.	1207	number), see RESOURCES in C<man 7 X> for further details.
1095		1208
1096	You can define a range of keysyms in one shot by providing a I<string>	1209	You can define a range of keysyms in one shot by providing a I<string>
1097	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1210	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1098	should be a character not used by the strings.	1211	should be a character not used by the strings.
1099		1212
1100	Its usage can be demonstrated by an example:	1213	Its usage can be demonstrated by an example:
1101		1214
1102	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1215	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1103		1216
1104	The above line is equivalent to the following three lines:	1217	The above line is equivalent to the following three lines:
1105		1218
1106	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1219	URxvt.keysym.Meta-Control-0x61: \033<a>
1107	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1220	URxvt.keysym.Meta-Control-0x62: \033<b>
1108	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1221	URxvt.keysym.Meta-Control-0x63: \033<c>
1109		1222
1110	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1223	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1111	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1224	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1112	example the following means "change the current locale to C<zh_CN.GBK>	1225	example the following means "change the current locale to C<zh_CN.GBK>
1113	when Control-Meta-c is being pressed":	1226	when Control-Meta-c is being pressed":
1114		1227
1115	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1228	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1116		1229
1117	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1230	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1118	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1231	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1119	manpage. For example, the F<selection> extension (activated via	1232	manpage. For example, the F<selection> extension (activated via
1120	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1233	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1121		1234
1122	URxvt.keysym.M-C-c: perl:selection:rot13	1235	URxvt.keysym.M-C-c: perl:selection:rot13
1123		1236
1124	Due the the large number of modifier combinations, a defined key mapping	1237	Due the the large number of modifier combinations, a defined key mapping
1125	will match if at I<at least> the specified identifiers are being set, and	1238	will match if I<at least> the specified identifiers are being set, and
1126	no other key mappings with those and more bits are being defined. That	1239	no other key mappings with those and more bits are being defined. That
1127	means that defining a key map for C<a> will automatically provide	1240	means that defining a key map for C<a> will automatically provide
1128	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1241	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1129	mappings themselves.	1242	mappings themselves.
1130		1243
…		…
1181	all instances, while B<perl-ext> is used for specific instances.	1294	all instances, while B<perl-ext> is used for specific instances.
1182		1295
1183	=item B<perl-eval>: I<string>	1296	=item B<perl-eval>: I<string>
1184		1297
1185	Perl code to be evaluated when all extensions have been registered. See	1298	Perl code to be evaluated when all extensions have been registered. See
1186	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1299	the @@RXVT_NAME@@perl(3) manpage.
1187	will be ignored when running setuid/setgid.
1188		1300
1189	=item B<perl-lib>: I<path>	1301	=item B<perl-lib>: I<path>
1190		1302
1191	Colon-separated list of additional directories that hold extension	1303	Colon-separated list of additional directories that hold extension
1192	scripts. When looking for extensions specified by the C<perl> resource,	1304	scripts. When looking for extensions specified by the C<perl> resource,
1193	@@RXVT_NAME@@ will first look in these directories and then in	1305	@@RXVT_NAME@@ will first look in these directories and then in
1194	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1306	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1195	will be ignored when running setuid/setgid.
1196		1307
1197	See the @@RXVT_NAME@@perl(3) manpage.	1308	See the @@RXVT_NAME@@perl(3) manpage.
1198		1309
1199	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1310	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1200		1311
…		…
1222		1333
1223	=item B<override-redirect>: I<boolean>	1334	=item B<override-redirect>: I<boolean>
1224		1335
1225	Compile I<frills>: Sets override-redirect for the terminal window, making	1336	Compile I<frills>: Sets override-redirect for the terminal window, making
1226	it almost invisible to window managers; option B<-override-redirect>.	1337	it almost invisible to window managers; option B<-override-redirect>.
		1338
		1339	=item B<iso14755:> I<boolean>
		1340
		1341	Turn on/off ISO 14755 (default enabled).
1227		1342
1228	=item B<iso14755_52:> I<boolean>	1343	=item B<iso14755_52:> I<boolean>
1229		1344
1230	Turn on/off ISO 14755 5.2 mode (default enabled).	1345	Turn on/off ISO 14755 5.2 mode (default enabled).
1231		1346
…		…
1374	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1489	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1375	it can be seen via the I<who(1)> command, and can accept messages. To	1490	it can be seen via the I<who(1)> command, and can accept messages. To
1376	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1491	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1377	on some systems or setgid to root or to some other group on others.	1492	on some systems or setgid to root or to some other group on others.
1378		1493
1379	=head1 COLORS AND GRAPHICS	1494	=head1 COLOURS AND GRAPHICS
1380		1495
1381	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1382	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1383	high-intensity bold/blink versions of the same). Here is a list of the	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1384	colours with their names.	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	Here is a list of the ANSI colours with their names.
1385		1503
1386	=begin table	1504	=begin table
1387		1505
1388	B<color0> (black) = Black	1506	B<color0> (black) = Black
1389	B<color1> (red) = Red3	1507	B<color1> (red) = Red3
…		…
1409	It is also possible to specify the colour values of B<foreground>,	1527	It is also possible to specify the colour values of B<foreground>,
1410	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1528	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1411	a number 0-15, as a convenient shorthand to reference the colour name of	1529	a number 0-15, as a convenient shorthand to reference the colour name of
1412	color0-color15.	1530	color0-color15.
1413		1531
1414	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1532	The following text gives values for the standard 88 colour mode (and
1415	additional 72 colours. The first 64 of those (with indices 16 to 79)	1533	values for the 256 colour mode in parentheses).
1416	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1417	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1418		1534
		1535	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1536
		1537	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1538	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1539
		1540	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1541	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1542	the RGB cube.
		1543
1419	Together, all those colours implement the 88 colour xterm colours. Only	1544	Together, all those colours implement the 88 (256) colour xterm
1420	the first 16 can be changed using resources currently, the rest can only	1545	colours. Only the first 16 can be changed using resources currently, the
1421	be changed via command sequences ("escape codes").	1546	rest can only be changed via command sequences ("escape codes").
		1547
		1548	Applications are advised to use terminfo or command sequences to discover
		1549	number and RGB values of all colours (yes, you can query this...).
1422		1550
1423	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1551	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1424	always swapping the foreground/background colours. This is in contrast to	1552	always swapping the foreground/background colours. This is in contrast to
1425	I<xterm>(1) where the colours are only swapped if they have not otherwise	1553	I<xterm>(1) where the colours are only swapped if they have not otherwise
1426	been specified. For example,	1554	been specified. For example,
1427		1555
1428	=over 4
1429
1430	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1556	@@RXVT_NAME@@ -fg Black -bg White -rv
1431		1557
1432	would yield White on Black, while on I<xterm>(1) it would yield Black	1558	would yield White on Black, while on I<xterm>(1) it would yield Black on
1433	on White.	1559	White.
1434
1435	=back
1436		1560
1437	=head2 ALPHA CHANNEL SUPPORT	1561	=head2 ALPHA CHANNEL SUPPORT
1438		1562
1439	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1563	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1440	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1564	their act together, rxvt-unicode will do it's own alpha channel management:
1441	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1565
1442	in addition to the ones provided by X, where the additional A component	1566	You can prefix any colour with an opaqueness percentage enclosed in
		1567	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1568	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1569	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1570	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1571	is the recommended format to specify transparency values, and works with
		1572	all ways to specify a colour.
		1573
		1574	For complete control, rxvt-unicode also supports
		1575	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1576	specifications, where the additional C<aaaa> component specifies opacity
1443	specifies opacity (alpha) values. The minimum value of C<0> is completely	1577	(alpha) values. The minimum value of C<0000> is completely transparent,
1444	transparent). You can also prefix any color with C<[percent]>, where	1578	while C<ffff> is completely opaque). The two example colours from
1445	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1579	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1446	the color, where C<0> is completely transparent and C<100> is completelxy	1580	C<rgba:0000/ff00/0000/f332>.
1447	opaque.
1448		1581
1449	You probably need to specify B<"-depth 32">, too, and have the luck that	1582	You probably need to specify B<"-depth 32">, too, to force a visual with
1450	your X-server uses ARGB pixel layout, as X is far from just supporting	1583	alpha channels, and have the luck that your X-server uses ARGB pixel
1451	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1584	layout, as X is far from just supporting ARGB visuals out of the box, and
		1585	rxvt-unicode just fudges around.
1452		1586
1453	For example, the following selects an almost completely transparent red	1587	For example, the following selects an almost completely transparent black
1454	background, and an almost opaque pink foreground:	1588	background, and an almost opaque pink foreground:
1455		1589
1456	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1590	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1457		1591
1458	I<Please note that transparency of any kind if completely unsupported by	1592	When not using a background image, then the interpretation of the
1459	the author. Don't bug him with installation questions!>	1593	alpha channel is up to your compositing manager (most interpret it as
		1594	transparency of course).
		1595
		1596	When using a background pixmap or pseudo-transparency, then the background
		1597	colour will always behave as if it were completely transparent (so the
		1598	background image shows instead), regardless of how it was specified, while
		1599	other colours will either be transparent as specified (the background
		1600	image will show through) on servers supporting the RENDER extension, or
		1601	fully opaque on servers not supporting the RENDER EXTENSION.
		1602
		1603	Please note that due to bugs in Xft, specifying alpha values might result
		1604	in garbage being displayed when the X-server does not support the RENDER
		1605	extension.
1460		1606
1461	=head1 ENVIRONMENT	1607	=head1 ENVIRONMENT
1462		1608
1463	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1609	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1464		1610
…		…
1470	resources or on the command line.	1616	resources or on the command line.
1471		1617
1472	=item B<COLORTERM>	1618	=item B<COLORTERM>
1473		1619
1474	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1620	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1475	compiled with background image support, and optionally with the added	1621	compiled with background image support, and optionally with the added
1476	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1622	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477	screen.	1623	screen.
1478		1624
1479	=item B<COLORFGBG>	1625	=item B<COLORFGBG>
1480		1626
1481	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1627	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1482	the colour code used as default foreground/text colour (or the string	1628	the colour code used as default foreground/text colour (or the string
1483	C<default> to indicate that the default-colour escape sequence is to be	1629	C<default> to indicate that the default-colour escape sequence is to be
1484	used), C<bg> is the colour code used as default background colour (or the	1630	used), C<bg> is the colour code used as default background colour (or the
1485	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1631	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1486	was compiled with background image support. Libraries like C<ncurses>	1632	was compiled with background image support. Libraries like C<ncurses>
1487	and C<slang> can (and do) use this information to optimize screen output.	1633	and C<slang> can (and do) use this information to optimize screen output.
1488		1634
1489	=item B<WINDOWID>	1635	=item B<WINDOWID>
1490		1636
1491	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1637	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1498	C<--with-terminfo=PATH>.	1644	C<--with-terminfo=PATH>.
1499		1645
1500	=item B<DISPLAY>	1646	=item B<DISPLAY>
1501		1647
1502	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1648	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1503	display in its child processes.	1649	display in its child processes if C<-display> isn't used to override. It
		1650	defaults to C<:0> if it doesn't exist.
1504		1651
1505	=item B<SHELL>	1652	=item B<SHELL>
1506		1653
1507	The shell to be used for command execution, defaults to C</bin/sh>.	1654	The shell to be used for command execution, defaults to C</bin/sh>.
1508		1655
1509	=item B<RXVT_SOCKET>	1656	=item B<RXVT_SOCKET>
1510		1657
1511	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1658	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1512	@@RXVT_NAME@@d(1).	1659	@@RXVT_NAME@@d(1).
1513		1660
1514	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1661	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1515		1662
1516	=item B<HOME>	1663	=item B<HOME>
1517		1664
1518	Used to locate the default directory for the unix domain socket for	1665	Used to locate the default directory for the unix domain socket for
1519	daemon communications and to locate various resource files (such as	1666	daemon communications and to locate various resource files (such as
1520	C<.Xdefaults>)	1667	C<.Xdefaults>)
1521		1668
1522	=item B<XAPPLRESDIR>	1669	=item B<XAPPLRESDIR>
1523		1670
1524	Directory where various X resource files are being located.	1671	Directory where application-specific X resource files are located.
1525		1672
1526	=item B<XENVIRONMENT>	1673	=item B<XENVIRONMENT>
1527		1674
1528	If set and accessible, gives the name of a X resource file to be loaded by	1675	If set and accessible, gives the name of a X resource file to be loaded by
1529	@@RXVT_NAME@@.	1676	@@RXVT_NAME@@.
…		…
1534		1681
1535	=over 4	1682	=over 4
1536		1683
1537	=item B</usr/lib/X11/rgb.txt>	1684	=item B</usr/lib/X11/rgb.txt>
1538		1685
1539	Color names.	1686	Colour names.
1540		1687
1541	=back	1688	=back
1542		1689
1543	=head1 SEE ALSO	1690	=head1 SEE ALSO
1544		1691
…		…
1583	Project Coordinator (changes.txt 2.21a to 2.4.5)	1730	Project Coordinator (changes.txt 2.21a to 2.4.5)
1584		1731
1585	=item Geoff Wing L<< <gcw@pobox.com> >>	1732	=item Geoff Wing L<< <gcw@pobox.com> >>
1586		1733
1587	Rewrote screen display and text selection routines.	1734	Rewrote screen display and text selection routines.
1588		1735
1589	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1736	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1590		1737
1591	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1738	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1592		1739
1593	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1740	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1595		1742
1596	Project Coordinator (Changes 1.0 -)	1743	Project Coordinator (Changes 1.0 -)
1597		1744
1598	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1745	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1599		1746
1600	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1747	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1601		1748
1602	=back	1749	=back
1603		1750

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs. Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.205 by sf-exg, Fri Nov 18 02:15:22 2011 UTC