ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.201 by sf-exg, Wed Aug 10 07:34: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 frequently	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	23	frequently asked questions and answer to them and some common
		24	problems. That document is also accessible on the World-Wide-Web at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
21		26
22	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
23		28
24	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
25	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
26	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
29	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
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
35	change.	40	change.
36		41
37	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
38	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
39	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
40	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
41	another for japanese.	46	another for japanese.
42		47
43	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
44	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
45	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
46	to choose any font for any script freely.	51	to choose any font for any script freely.
47		52
48	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
49	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
50	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
51	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
52		57
53	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
54	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
55	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
56	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
57	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
60		65
61	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
64		69
65	=head1 OPTIONS	70	=head1 OPTIONS
66		71
67	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
…		…
87		92
88	Print out a message describing available options.	93	Print out a message describing available options.
89		94
90	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
91		96
92	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>
93	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
94	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		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]
95		110
96	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
97		112
98	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
99		114
…		…
101		116
102	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
103		118
104	=item B<-j>|B<+j>	119	=item B<-j>|B<+j>
105		120
106	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107		122
108	=item B<-ip>|B<+ip>	123	=item B<-ss>|B<+ss>
109		124
110	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>.
111	B<-tr>; resource B<inheritPixmap>.	126
		127	=item B<-tr>|B<+tr>
		128
		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.
112		133
113	=item B<-fade> I<number>	134	=item B<-fade> I<number>
114		135
115	Fade the text by the given percentage when focus is lost. resource B<fading>.	136	Fade the text by the given percentage when focus is lost. Small values
		137	fade a little only, 100 completely replaces all colours by the fade
		138	colour; resource B<fading>.
		139
		140	=item B<-fadecolor> I<colour>
		141
		142	Fade to this colour when fading is used (see B<-fade>). The default colour
		143	is opaque black. resource B<fadeColor>.
116		144
117	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
118		146
119	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	148	resource I<tintColor>.
121	option that can be used to brighten or darken the image in addition to
122	tinting it.
123		149
124	=item B<-sh>	150	=item B<-sh> I<number>
125		151
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
127	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
128	specified, too, e.g. C<-tint white>).	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>.
129		179
130	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
131		181
132	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
133		183
134	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
135		185
136	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
137		187
138	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
139		189
140	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
141	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
142	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
143	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
144		194
145	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
146		196
147	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
148		198
…		…
160	resource B<borderColor>.	210	resource B<borderColor>.
161		211
162	=item B<-fn> I<fontlist>	212	=item B<-fn> I<fontlist>
163		213
164	Select the fonts to be used. This is a comma separated list of font names	214	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	215	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	216	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A (hopefully) reasonable default	217	smaller, but not (in general) larger. A (hopefully) reasonable default
168	font list is always appended to it. See resource B<font> for more details.	218	font list is always appended to it. See resource B<font> for more details.
169		219
170	In short, to specify an X11 core font, just specify it's name or prefix it	220	In short, to specify an X11 core font, just specify its name or prefix it
171	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	221	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172	e.g.:	222	e.g.:
173		223
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	227	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	228	section of @@RXVT_NAME@@(7).
179		229
180	=item B<-fb> I<fontlist>	230	=item B<-fb> I<fontlist>
181		231
182	Compile font-styles: The bold font list to use when bold characters are to	232	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	233	are to be printed. See resource B<boldFont> for details.
184		234
185	=item B<-fi> I<fontlist>	235	=item B<-fi> I<fontlist>
186		236
187	Compile font-styles: The italic font list to use when bold characters are to	237	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	238	characters are to be printed. See resource B<italicFont> for details.
189		239
190	=item B<-fbi> I<fontlist>	240	=item B<-fbi> I<fontlist>
191		241
192	Compile font-styles: The bold italic font list to use when bold characters are to	242	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
		244	for details.
		245
		246	=item B<-is>|B<+is>
		247
		248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		249	foreground/background (default). See resource B<intensityStyles> for
		250	details.
194		251
195	=item B<-name> I<name>	252	=item B<-name> I<name>
196		253
197	Specify the application name under which resources are to be obtained,	254	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	255	rather than the default executable file name. Name should not contain
…		…
214		271
215	=item B<-sb>|B<+sb>	272	=item B<-sb>|B<+sb>
216		273
217	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
218		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
219	=item B<-si>|B<+si>	285	=item B<-si>|B<+si>
220		286
221	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
222	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
223		289
…		…
229	=item B<-sw>|B<+sw>	295	=item B<-sw>|B<+sw>
230		296
231	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.
232	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
233	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
234
235	=item B<-sr>|B<+sr>
236
237	Put scrollbar on right/left; resource B<scrollBar_right>.
238
239	=item B<-st>|B<+st>
240
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.
243		300
244	=item B<-ptab>|B<+ptab>	301	=item B<-ptab>|B<+ptab>
245		302
246	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
247	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
…		…
251		308
252	=item B<-bc>|B<+bc>	309	=item B<-bc>|B<+bc>
253		310
254	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
255		312
		313	=item B<-uc>|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
256	=item B<-iconic>	317	=item B<-iconic>
257		318
258	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
259	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
260		321
…		…
276		337
277	=item B<-bl>	338	=item B<-bl>
278		339
279	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.
280	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
281	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.
		344
		345	=item B<-override-redirect>
		346
		347	Compile I<frills>: Sets override-redirect on the window; resource
		348	B<override-redirect>.
		349
		350	=item B<-sbg>
		351
		352	Compile I<frills>: Disable the usage of the built-in block graphics/line
		353	drawing characters and just rely on what the specified fonts provide. Use
		354	this if you have a good font and want to use its block graphic glyphs;
		355	resource B<skipBuiltinGlyphs>.
282		356
283	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
284		358
285	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
286	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
287	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>.
288		369
289	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
290		371
291	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
292	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
301	given on the command line. If this option is used, it must be the last	382	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	383	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	384	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	385	failing that, I<sh(1)>.
305		386
		387	Please note that you must specify a program with arguments. If you want to
		388	run shell commands, you have to specify the shell, like this:
		389
		390	@@RXVT_NAME@@ -e sh -c "shell commands"
		391
306	=item B<-title> I<text>	392	=item B<-title> I<text>
307		393
308	Window title (B<-T> still respected); the default title is the basename	394	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	395	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	396	application name; resource B<title>.
…		…
341	for more info.	427	for more info.
342		428
343	=item B<-tcw>	429	=item B<-tcw>
344		430
345	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
346	button. 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
347	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
348		435
349	=item B<-insecure>	436	=item B<-insecure>
350		437
351	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
352	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
366	=item B<-ssr>|B<+ssr>	453	=item B<-ssr>|B<+ssr>
367		454
368	Turn on/off secondary screen scroll (default enabled); resource	455	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	456	B<secondaryScroll>.
370		457
		458	=item B<-hold>|B<+hold>
		459
		460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		461	will not immediately destroy its window when the program executed within
		462	it exits. Instead, it will wait till it is being killed or closed by the
		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
371	=item B<-xrm> I<resourcestring>	471	=item B<-xrm> I<string>
372		472
373	No effect on rxvt-unicode. Simply passes through an argument to be made	473	Works like the X Toolkit option of the same name, by adding the I<string>
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	474	as if it were specified in a resource file. Resource values specified this
375	some window managers.	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.
		483
		484	=item B<-keysym.>I<sym> I<string>
		485
		486	Remap a key symbol. See resource B<keysym>.
		487
		488	=item B<-embed> I<windowid>
		489
		490	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		491	which enables applications to easily embed a terminal.
		492
		493	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		494	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		495	quite a bit, so don't expect it to keep some specific state. It's best to
		496	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		497
		498	The window will not be destroyed when @@RXVT_NAME@@ exits.
		499
		500	It might be useful to know that @@RXVT_NAME@@ will not close file
		501	descriptors passed to it (except for stdin/out/err, of course), so you
		502	can use file descriptors to communicate with the programs within the
		503	terminal. This works regardless of whether the C<-embed> option was used or
		504	not.
		505
		506	Here is a short Gtk2-perl snippet that illustrates how this option can be
		507	used (a longer example is in F<doc/embed>):
		508
		509	my $rxvt = new Gtk2::Socket;
		510	$rxvt->signal_connect_after (realize => sub {
		511	my $xid = $_[0]->window->get_xid;
		512	system "@@RXVT_NAME@@ -embed $xid &";
		513	});
		514
		515	=item B<-pty-fd> I<file descriptor>
		516
		517	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		518	pair but instead use the given file descriptor as the tty master. This is
		519	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		520	without having to run a program within it.
		521
		522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		523	entries and will not tinker with pty/tty permissions - you have to do that
		524	yourself if you want that.
		525
		526	As an extremely special case, specifying C<-1> will completely suppress
		527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
		529
		530	Here is a example in perl that illustrates how this option can be used (a
		531	longer example is in F<doc/pty-fd>):
		532
		533	use IO::Pty;
		534	use Fcntl;
		535
		536	my $pty = new IO::Pty;
		537	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		538	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		539	close $pty;
		540
		541	# now communicate with rxvt
		542	my $slave = $pty->slave;
		543	while (<$slave>) { print $slave "got <$_>\n" }
		544
		545	=item B<-pe> I<string>
		546
		547	Comma-separated list of perl extension scripts to use (or not to use) in
		548	this terminal instance. See resource B<perl-ext> for details.
376		549
377	=back	550	=back
378		551
379	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
380		553
381	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
383		557
384	There are two different methods that @@RXVT_NAME@@ can use to get the	558	You can set and change the resources using X11 tools like B<xrdb>. Many
385	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	561	with later settings overwriting earlier ones:
388	resources using X11 tools like B<xset>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.
390		562
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	563	1. app-defaults file in $XAPPLRESDIR
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	564	2. $HOME/.Xdefaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	565	3. RESOURCE_MANAGER property on root-window of screen 0
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	566	4. SCREEN_RESOURCES property on root-window of the current screen
395	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
		569
396	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	572	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399	easily configured, while the class name B<URxvt> allows resources	573	configured, while the class name B<URxvt> allows resources unique to
400	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
402	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
403	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
404	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
405		580
406	=over 4	581	=over 4
		582
		583	=item B<depth:> I<bitdepth>
		584
		585	Compile I<xft>: Attempt to find a visual with the given bit depth;
		586	option B<-depth>.
		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.
407		594
408	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
409		596
410	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
411	option B<-geometry>.	598	option B<-geometry>.
…		…
425	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
426	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
427	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
428	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,
429	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
430	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
431		618
432	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
433	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
434		621
435	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
…		…
446	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
447		634
448	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
449	foreground colour is the default.	636	foreground colour is the default.
450		637
451	=item B<colorRV:> I<colour>
452
453	Use the specified colour as the background for reverse video
454	characters.
455
456	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
457		639
458	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
459	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.
460		652
461	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
462		654
463	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
464	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
471		663
472	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
473		665
474	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
475	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
476	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
477		669
478	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
479		671
480	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
481	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
482	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>.
483		679
484	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
485		681
486	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
487	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
488	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>.
		687
		688	B<False>: specify that everything is to be displayed, even
		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.
489		698
490	=item B<fading:> I<number>	699	=item B<fading:> I<number>
491		700
492	Fade the text by the given percentage when focus is lost.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
		702
		703	=item B<fadeColor:> I<colour>
		704
		705	Fade to this colour, when fading is used (see B<fading:>). The default
		706	colour is black; option B<-fadecolor>.
493		707
494	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
495		709
496	Tint the transparent background pixmap with the given colour.	710	Tint the transparent background with the given colour. If the RENDER
		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>.
497		715
498	=item B<shading:> I<number>	716	=item B<shading:> I<number>
499		717
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
501	image in addition to tinting it.	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>.
502		733
503	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
504		735
505	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
506		737
507	=item B<troughColor:> I<colour>	738	=item B<troughColor:> I<colour>
508		739
509	Use the specified colour for the scrollbar's trough area [default	740	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	741	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		742
512	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
513		744
514	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
515	and the text.	746	and the text.
516		747
517	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
518		749
519	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
520	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
521	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
522	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
523	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
524	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
525	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
526	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
527	scale is 1000. [default 0x0+50+50]
528		758
529	=item B<menu:> I<file[;tag]>	759	tile will tile image
		760	propscale will scale image keeping proportions
		761	scale will scale image to match window size
		762	center will center image with no scaling
		763	root will tile image as if it was a root window background, auto-adjusting
		764	whenever terminal window moves
530		765
531	Read in the specified menu file (note the `.menu' extension is	766	If used in conjunction with B<-tr> option, the specified pixmap will be
532	optional) and also optionally specify a starting tag to find. See the	767	blended over the transparent background using alpha-blending. If I<afterimage>
533	reference documentation for details on the syntax for the menuBar.	768	support has been compiled in it is possible to choose other blending
		769	types with B<-blt "type"> option.
534		770
535	=item B<path:> I<path>	771	=item B<path:> I<path>
536		772
537	Specify the colon-delimited search path for finding files (XPM and	773	Specify the colon-delimited search path for finding background image files.
538	menus), in addition to the paths specified by the B<RXVTPATH> and
539	B<PATH> environment variables.
540		774
541	=item B<font:> I<fontlist>	775	=item B<font:> I<fontlist>
542		776
543	Select the fonts to be used. This is a comma separated list of font	777	Select the fonts to be used. This is a comma separated list of font names
544	names that are used in turn when trying to display Unicode characters.	778	that are checked in order when trying to find glyphs for characters. The
545	The first font defines the cell size for characters; other fonts might	779	first font defines the cell size for characters; other fonts might be
546	be smaller, but not larger. A reasonable default font list is always	780	smaller, but not (in general) larger. A (hopefully) reasonable default
547	appended to it. option B<-fn>.	781	font list is always appended to it; option B<-fn>.
548		782
549	Each font can either be a standard X11 core font (XLFD) name, with	783	Each font can either be a standard X11 core font (XLFD) name, with
550	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	784	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551		785
552	In addition, each font can be prefixed with additional hints and	786	In addition, each font can be prefixed with additional hints and
…		…
554	hint currently is C<codeset=codeset-name>, and this is only used for Xft	788	hint currently is C<codeset=codeset-name>, and this is only used for Xft
555	fonts.	789	fonts.
556		790
557	For example, this font resource	791	For example, this font resource
558		792
559	URxvt*font: 9x15bold,\	793	URxvt.font: 9x15bold,\
560	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	794	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	795	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	796	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563	xft:Code2000:antialias=false	797	xft:Code2000:antialias=false
564		798
…		…
567	it is named first) and thus defines the character cell grid to be 9 pixels	801	it is named first) and thus defines the character cell grid to be 9 pixels
568	wide and 15 pixels high.	802	wide and 15 pixels high.
569		803
570	The second font is just used to add additional unicode characters not in	804	The second font is just used to add additional unicode characters not in
571	the base font, likewise the third, which is unfortunately non-bold, but	805	the base font, likewise the third, which is unfortunately non-bold, but
572	the bold version of the font does contain less characters, so this is a	806	the bold version of the font does contain fewer characters, so this is a
573	useful supplement.	807	useful supplement.
574		808
575	The third font is an Xft font with aliasing turned off, and the characters	809	The third font is an Xft font with aliasing turned off, and the characters
576	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	810	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
577	contains other characters, but we are not interested in them.	811	contains other characters, but we are not interested in them.
…		…
598	not possible, replacement fonts of the desired shape will be tried.	832	not possible, replacement fonts of the desired shape will be tried.
599		833
600	If set, but empty, then this specific style is disabled and the normal	834	If set, but empty, then this specific style is disabled and the normal
601	text font will being used for the given style.	835	text font will being used for the given style.
602		836
603	=item B<selectstyle:> I<mode>	837	=item B<intensityStyles:> I<boolean>
604		838
605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	839	When font styles are not enabled, or this option is enabled (B<True>,
606	xterm style with 2.20 old word selection, or anything else which gives	840	option B<-is>, the default), bold/blink font styles imply high
607	xterm style selection.	841	intensity foreground/background colours. Disabling this option (B<False>,
608		842	option B<+is>) disables this behaviour, the high intensity colours are not
609	=item B<scrollstyle:> I<mode>	843	reachable.
610
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..
613		844
614	=item B<title:> I<string>	845	=item B<title:> I<string>
615		846
616	Set window title string, the default title is the command-line	847	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	848	specified after the B<-e> option, if any, otherwise the application
…		…
626	=item B<mapAlert:> I<boolean>	857	=item B<mapAlert:> I<boolean>
627		858
628	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	859	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
629	de-iconify (map) on receipt of a bell character [default].	860	de-iconify (map) on receipt of a bell character [default].
630		861
		862	=item B<urgentOnBell:> I<boolean>
		863
		864	B<True>: set the urgency hint for the wm on receipt of a bell character.
		865	B<False>: do not set the urgency hint [default].
		866
		867	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		868
631	=item B<visualBell:> I<boolean>	869	=item B<visualBell:> I<boolean>
632		870
633	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	871	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
634	B<False>: no visual bell [default]; option B<+vb>.	872	B<False>: no visual bell [default]; option B<+vb>.
635		873
…		…
649		887
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	888	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	889	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652	B<Shift-Print> to include the scrollback as well.	890	B<Shift-Print> to include the scrollback as well.
653		891
		892	The string will be interpreted as if typed into the shell as-is.
		893
		894	Example:
		895
		896	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		897
		898	This creates a new file in your home directory with the screen contents
		899	every time you hit C<Print>.
		900
		901	=item B<scrollstyle:> I<mode>
		902
		903	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		904	the author's favourite.
		905
		906	=item B<thickness:> I<number>
		907
		908	Set the scrollbar width in pixels.
		909
654	=item B<scrollBar:> I<boolean>	910	=item B<scrollBar:> I<boolean>
655		911
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	912	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	913	disable the scrollbar; option B<+sb>.
658		914
…		…
677	B<False>: do not scroll to bottom when tty receives output; option	933	B<False>: do not scroll to bottom when tty receives output; option
678	B<+si>.	934	B<+si>.
679		935
680	=item B<scrollWithBuffer:> I<boolean>	936	=item B<scrollWithBuffer:> I<boolean>
681		937
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	938	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	939	try to show the same lines) and B<scrollTtyOutput> is False; option
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	940	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		941	new lines; option B<+sw>.
685		942
686	=item B<scrollTtyKeypress:> I<boolean>	943	=item B<scrollTtyKeypress:> I<boolean>
687		944
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	945	B<True>: scroll to bottom when a non-special key is pressed. Special keys
689	are those which are intercepted by rxvt-unicode for special handling and	946	are those which are intercepted by rxvt-unicode for special handling and
…		…
708	=item B<borderLess:> I<boolean>	965	=item B<borderLess:> I<boolean>
709		966
710	Set MWM hints to request a borderless window, i.e. if honoured by the	967	Set MWM hints to request a borderless window, i.e. if honoured by the
711	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	968	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712		969
		970	=item B<skipBuiltinGlyphs:> I<boolean>
		971
		972	Compile I<frills>: Disable the usage of the built-in block graphics/line
		973	drawing characters and just rely on what the specified fonts provide. Use
		974	this if you have a good font and want to use its block graphic glyphs;
		975	option B<-sbg>.
		976
713	=item B<termName:> I<termname>	977	=item B<termName:> I<termname>
714		978
715	Specifies the terminal type name to be set in the B<TERM> environment	979	Specifies the terminal type name to be set in the B<TERM> environment
716	variable; option B<-tn>.	980	variable; option B<-tn>.
717		981
718	=item B<linespace:> I<number>	982	=item B<lineSpace:> I<number>
719		983
720	Specifies number of lines (pixel height) to insert between each row of	984	Specifies number of lines (pixel height) to insert between each row of
721	the display [default 0]; option B<-lsp>.	985	the display [default 0]; option B<-lsp>.
722		986
723	=item B<meta8:> I<boolean>	987	=item B<meta8:> I<boolean>
…		…
737		1001
738	=item B<cursorBlink:> I<boolean>	1002	=item B<cursorBlink:> I<boolean>
739		1003
740	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1004	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
741	option B<-bc>.	1005	option B<-bc>.
		1006
		1007	=item B<cursorUnderline:> I<boolean>
		1008
		1009	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1010	option B<-uc>.
742		1011
743	=item B<pointerBlank:> I<boolean>	1012	=item B<pointerBlank:> I<boolean>
744		1013
745	B<True>: blank the pointer when a key is pressed or after a set number	1014	B<True>: blank the pointer when a key is pressed or after a set number
746	of seconds of inactivity. B<False>: the pointer is always visible	1015	of seconds of inactivity. B<False>: the pointer is always visible
…		…
754		1023
755	Mouse pointer background colour.	1024	Mouse pointer background colour.
756		1025
757	=item B<pointerBlankDelay:> I<number>	1026	=item B<pointerBlankDelay:> I<number>
758		1027
759	Specifies number of seconds before blanking the pointer [default 2].	1028	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1029	large number (e.g. C<987654321>) to effectively disable the timeout.
760		1030
761	=item B<backspacekey:> I<string>	1031	=item B<backspacekey:> I<string>
762		1032
763	The string to send when the backspace key is pressed. If set to B<DEC>	1033	The string to send when the backspace key is pressed. If set to B<DEC>
764	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1034	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
765	(code 8) - which can be reversed with the appropriate DEC private mode	1035	(code 8) - which can be reversed with the appropriate DEC private mode
766	escape sequence.	1036	escape sequence.
767		1037
768	=item B<deletekey:> I<string>	1038	=item B<deletekey:> I<string>
769		1039
…		…
771	pressed. If unset it will send the sequence traditionally associated	1041	pressed. If unset it will send the sequence traditionally associated
772	with the B<Execute> key.	1042	with the B<Execute> key.
773		1043
774	=item B<cutchars:> I<string>	1044	=item B<cutchars:> I<string>
775		1045
776	The characters used as delimiters for double-click word selection. The	1046	The characters used as delimiters for double-click word selection
777	built-in default:	1047	(whitespace delimiting is added automatically if resource is given).
778		1048
		1049	When the perl selection extension is in use (the default if compiled
		1050	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1051	characters will be created (if the resource exists, otherwise, no regex
		1052	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1053
		1054	When the selection extension is not used, only ISO-8859-1 characters can
		1055	be used. If not specified, the built-in default is used:
		1056
779	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1057	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
780		1058
781	=item B<preeditType:> I<style>	1059	=item B<preeditType:> I<style>
782		1060
783	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1061	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
784		1062
…		…
789	=item B<imLocale:> I<name>	1067	=item B<imLocale:> I<name>
790		1068
791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1069	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1070	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793	input extension to be able to input japanese characters while staying in	1071	input extension to be able to input japanese characters while staying in
794	another locale. option B<-imlocale>.	1072	another locale; option B<-imlocale>.
795		1073
796	=item B<imFont:> I<fontset>	1074	=item B<imFont:> I<fontset>
797		1075
798	Specify the font-set used for XIM styles C<OverTheSpot> or	1076	Specify the font-set used for XIM styles C<OverTheSpot> or
799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1077	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		1082
805	=item B<tripleclickwords:> I<boolean>	1083	=item B<tripleclickwords:> I<boolean>
806		1084
807	Change the meaning of triple-click selection with the left mouse	1085	Change the meaning of triple-click selection with the left mouse
808	button. Instead of selecting a full line it will extend the selection to	1086	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	1087	the end of the logical line only; option B<-tcw>.
810		1088
811	=item B<insecure:> I<boolean>	1089	=item B<insecure:> I<boolean>
812		1090
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1091	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814	echo arbitrary strings like the icon name or the locale. This could be	1092	echo arbitrary strings like the icon name or the locale. This could be
815	abused if somebody gets 8-bit-clean access to your display, whether	1093	abused if somebody gets 8-bit-clean access to your display, whether
816	throuh a mail client displaying mail bodies unfiltered or though	1094	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	1095	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	1096	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	1097	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	1098
821	enabled display-answer, locale, findfont, icon label and window title	1099	You can enable them by setting this boolean resource or specifying
822	requests as well as dynamic menubar dispatch.	1100	B<-insecure> as an option. At the moment, this enables display-answer,
		1101	locale, findfont, icon label and window title requests.
823		1102
824	=item B<modifier:> I<modifier>	1103	=item B<modifier:> I<modifier>
825		1104
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1105	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1106	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
831		1110
832	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1111	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833	character is passed through. It may contain escape values as described	1112	character is passed through. It may contain escape values as described
834	in the entry on B<keysym> following.	1113	in the entry on B<keysym> following.
835		1114
836	=item B<secondaryScreen:> I<bool>	1115	=item B<secondaryScreen:> I<boolean>
837		1116
838	Turn on/off secondary screen (default enabled).	1117	Turn on/off secondary screen (default enabled).
839		1118
840	=item B<secondaryScroll:> I<bool>	1119	=item B<secondaryScroll:> I<boolean>
841		1120
842	Turn on/off secondary screen scroll (default enabled). If the this	1121	Turn on/off secondary screen scroll (default enabled). If this
843	option is enabled, scrolls on the secondary screen will change the	1122	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	1123	scrollback buffer and, when secondaryScreen is off, switching
845	instead scroll the screen up.	1124	to/from the secondary screen will instead scroll the screen up.
		1125
		1126	=item B<hold>: I<boolean>
		1127
		1128	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1129	will not immediately destroy its window when the program executed within
		1130	it exits. Instead, it will wait till it is being killed or closed by the
		1131	user.
		1132
		1133	=item B<chdir>: I<path>
		1134
		1135	Sets the working directory for the shell (or the command specified via
		1136	B<-e>). The I<path> must be an absolute path and it must exist for
		1137	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1138	directory will be used; option B<-cd>.
846		1139
847	=item B<keysym.>I<sym>: I<string>	1140	=item B<keysym.>I<sym>: I<string>
848		1141
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1142	Compile I<frills>: Associate I<string> with keysym I<sym>. The
850	intervening resource name B<keysym.> cannot be omitted.	1143	intervening resource name B<keysym.> cannot be omitted.
…		…
864	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1157	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
865	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1158	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
866	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1159	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
867	performed in an exact manner; however, the closest match is assured.	1160	performed in an exact manner; however, the closest match is assured.
868		1161
869	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1162	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
870	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1163	number), see RESOURCES in C<man 7 X> for further details.
871	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
872	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873	can start or end with whitespace.
874
875	Please note that you need to double the C<\> when using
876	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
877	use C<\033> instead of C<\e> (and so on), which will work with both Xt and
878	@@RXVT_NAME@@'s own processing).
879		1164
880	You can define a range of keysyms in one shot by providing a I<string>	1165	You can define a range of keysyms in one shot by providing a I<string>
881	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1166	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
882	should be a character not used by the strings.	1167	should be a character not used by the strings.
883		1168
884	Its usage can be demonstrated by an example:	1169	Its usage can be demonstrated by an example:
885		1170
886	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1171	URxvt.keysym.M-C-0x61: list|\033<|abc|>
887		1172
888	The above line is equivalent to the following three lines:	1173	The above line is equivalent to the following three lines:
889		1174
890	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1175	URxvt.keysym.Meta-Control-0x61: \033<a>
891	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1176	URxvt.keysym.Meta-Control-0x62: \033<b>
892	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1177	URxvt.keysym.Meta-Control-0x63: \033<c>
893		1178
894	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1179	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
895	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1180	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
896	example the following means "change the current locale to C<zh_CN.GBK>	1181	example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1182	when Control-Meta-c is being pressed":
898		1183
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1184	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1185
		1186	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1187	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1188	manpage. For example, the F<selection> extension (activated via
		1189	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1190
		1191	URxvt.keysym.M-C-c: perl:selection:rot13
		1192
		1193	Due the the large number of modifier combinations, a defined key mapping
		1194	will match if I<at least> the specified identifiers are being set, and
		1195	no other key mappings with those and more bits are being defined. That
		1196	means that defining a key map for C<a> will automatically provide
		1197	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1198	mappings themselves.
		1199
		1200	Unfortunately, this will override built-in key mappings. For example
		1201	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1202	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1203	user-defined keymap using the C<builtin:> replacement:
		1204
		1205	URxvt.keysym.Insert: <my insert key sequence>
		1206	URxvt.keysym.S-Insert: builtin:
		1207
		1208	The first line defines a mapping for C<Insert> and I<any> combination
		1209	of modifiers. The second line re-establishes the default mapping for
		1210	C<Shift-Insert>.
		1211
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1212	The following example will map Control-Meta-1 and Control-Meta-2 to
902	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited	1213	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903	font-switching at runtime:	1214	font-switching at runtime:
904		1215
905	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1216	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1219	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1220	info):
910		1221
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1222	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1223	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1224
		1225	=item B<perl-ext-common>: I<string>
		1226
		1227	=item B<perl-ext>: I<string>
		1228
		1229	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1230	use in this terminal instance; option B<-pe>.
		1231
		1232	Extension names can be prefixed with a C<-> sign to prohibit using
		1233	them. This can be useful to selectively disable some extensions loaded
		1234	by default, or specified via the C<perl-ext-common> resource. For
		1235	example, C<default,-selection> will use all the default extension except
		1236	C<selection>.
		1237
		1238	Extension names can also be followed by an argument in angle brackets
		1239	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1240	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1241	multiple times with different arguments will pass multiple arguments to
		1242	the extension.
		1243
		1244	Each extension is looked up in the library directories, loaded if
		1245	necessary, and bound to the current terminal instance.
		1246
		1247	If both of these resources are the empty string, then the perl
		1248	interpreter will not be initialized. The idea behind two options is that
		1249	B<perl-ext-common> will be used for extensions that should be available to
		1250	all instances, while B<perl-ext> is used for specific instances.
		1251
		1252	=item B<perl-eval>: I<string>
		1253
		1254	Perl code to be evaluated when all extensions have been registered. See
		1255	the @@RXVT_NAME@@perl(3) manpage.
		1256
		1257	=item B<perl-lib>: I<path>
		1258
		1259	Colon-separated list of additional directories that hold extension
		1260	scripts. When looking for extensions specified by the C<perl> resource,
		1261	@@RXVT_NAME@@ will first look in these directories and then in
		1262	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1263
		1264	See the @@RXVT_NAME@@perl(3) manpage.
		1265
		1266	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1267
		1268	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1269	details.
		1270
		1271	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1272
		1273	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1274	for details.
		1275
		1276	=item B<searchable-scrollback:> I<keysym>
		1277
		1278	Sets the hotkey that starts the incremental scrollback buffer search
		1279	(default: C<M-s>).
		1280
		1281	=item B<urlLauncher>: I<string>
		1282
		1283	Specifies the program to be started with a URL argument. Used by the
		1284	C<selection-popup> and C<matcher> perl extensions.
		1285
		1286	=item B<transient-for>: I<windowid>
		1287
		1288	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1289
		1290	=item B<override-redirect>: I<boolean>
		1291
		1292	Compile I<frills>: Sets override-redirect for the terminal window, making
		1293	it almost invisible to window managers; option B<-override-redirect>.
		1294
		1295	=item B<iso14755:> I<boolean>
		1296
		1297	Turn on/off ISO 14755 (default enabled).
		1298
		1299	=item B<iso14755_52:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 5.2 mode (default enabled).
913		1302
914	=back	1303	=back
915		1304
916	=head1 THE SCROLLBAR	1305	=head1 THE SCROLLBAR
917		1306
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1320	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1321	(Alt) key while performing the desired mouse action.
933		1322
934	If mouse reporting mode is active, the normal scrollbar actions are	1323	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1324	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1325	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1326	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1327	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1328	respectively.
940		1329
941	=head1 TEXT SELECTION AND INSERTION	1330	=head1 THE SELECTION: SELECTING AND PASTING TEXT
942		1331
943	The behaviour of text selection and insertion mechanism is similar to	1332	The behaviour of text selection and insertion/pasting mechanism is similar
944	I<xterm>(1).	1333	to I<xterm>(1).
945		1334
946	=over 4	1335	=over 4
947		1336
948	=item B<Selection>:	1337	=item B<Selecting>:
949		1338
950	Left click at the beginning of the region, drag to the end of the region	1339	Left click at the beginning of the region, drag to the end of the region
951	and release; Right click to extend the marked region; Left double-click	1340	and release; Right click to extend the marked region; Left double-click
952	to select a word; Left triple-click to select the entire logical line	1341	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1342	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1343	B<tripleclickwords>.
955		1344
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1345	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957	(Compile: I<frills>) will create a rectangular selection instead of a normal	1346	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1347	normal one. In this mode, every selected row becomes its own line in the
		1348	selection, and trailing whitespace is visually underlined and removed from
		1349	the selection.
959		1350
960	=item B<Insertion>:	1351	=item B<Pasting>:
961		1352
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1353	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963	an B<@@RXVT_NAME@@> window causes the current text selection to be	1354	window causes the value of the PRIMARY selection (or CLIPBOARD with the
964	inserted as if it had been typed on the keyboard.	1355	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1356
		1357	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1358	inserted too.
965		1359
966	=back	1360	=back
967		1361
968	=head1 CHANGING FONTS	1362	=head1 CHANGING FONTS
969		1363
970	Changing fonts (or font sizes, respectively) via the keypad is not yet	1364	Changing fonts (or font sizes, respectively) via the keypad is not yet
971	supported in rxvt-unicode. Bug me if you need this.	1365	supported in rxvt-unicode. Bug me if you need this.
972		1366
973	You can, however, switch fonts at runtime using escape sequences (and	1367	You can, however, switch fonts at runtime using escape sequences, e.g.:
974	therefore using the menubar), e.g.:
975		1368
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1369	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1370
		1371	You can use keyboard shortcuts, too:
		1372
		1373	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1374	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977		1375
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1376	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1377
980	=head1 ISO 14755 SUPPORT	1378	=head1 ISO 14755 SUPPORT
981		1379
982	ISO 14755 is a standard for entering and viewing unicode characters	1380	ISO 14755 is a standard for entering and viewing unicode characters
983	and character codes using the keyboard. It consists of 4 parts. The	1381	and character codes using the keyboard. It consists of 4 parts. The
984	first part is available rxvt-unicode has been compiled with	1382	first part is available if rxvt-unicode has been compiled with
985	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1383	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
986	with C<--enable-iso14755>.	1384	with C<--enable-iso14755>.
987		1385
988	=over 4	1386	=over 4
989		1387
…		…
1009	This mode lets you input characters representing the keycap symbols of	1407	This mode lets you input characters representing the keycap symbols of
1010	your keyboard, if representable in the current locale encoding.	1408	your keyboard, if representable in the current locale encoding.
1011		1409
1012	Start by pressing C<Control> and C<Shift> together, then releasing	1410	Start by pressing C<Control> and C<Shift> together, then releasing
1013	them. The next special key (cursor keys, home etc.) you enter will not	1411	them. The next special key (cursor keys, home etc.) you enter will not
1014	invoke it's usual function but instead will insert the corresponding	1412	invoke its usual function but instead will insert the corresponding
1015	keycap symbol. The symbol will only be entered when the key has been	1413	keycap symbol. The symbol will only be entered when the key has been
1016	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1414	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1017	C<ISO Level 2 Switch>, although your intention might have been to enter a	1415	C<ISO Level 2 Switch>, although your intention might have been to enter a
1018	reverse tab (Shift-Tab).	1416	reverse tab (Shift-Tab).
1019		1417
…		…
1047	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1445	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1048	it can be seen via the I<who(1)> command, and can accept messages. To	1446	it can be seen via the I<who(1)> command, and can accept messages. To
1049	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1447	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1050	on some systems or setgid to root or to some other group on others.	1448	on some systems or setgid to root or to some other group on others.
1051		1449
1052	=head1 COLORS AND GRAPHICS	1450	=head1 COLOURS AND GRAPHICS
1053		1451
1054	In addition to the default foreground and background colours,	1452	In addition to the default foreground and background colours,
1055	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1453	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1056	high-intensity bold/blink versions of the same). Here is a list of the	1454	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1057	colours with their B<rgb.txt> names.	1455	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1456	cube plus a 8 (24) colour greyscale ramp.
		1457
		1458	Here is a list of the ANSI colours with their names.
1058		1459
1059	=begin table	1460	=begin table
1060		1461
1061	B<color0> (black) = Black	1462	B<color0> (black) = Black
1062	B<color1> (red) = Red3	1463	B<color1> (red) = Red3
…		…
1082	It is also possible to specify the colour values of B<foreground>,	1483	It is also possible to specify the colour values of B<foreground>,
1083	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1484	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1084	a number 0-15, as a convenient shorthand to reference the colour name of	1485	a number 0-15, as a convenient shorthand to reference the colour name of
1085	color0-color15.	1486	color0-color15.
1086		1487
		1488	The following text gives values for the standard 88 colour mode (and
		1489	values for the 256 colour mode in parentheses).
		1490
		1491	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1492
		1493	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1494	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1495
		1496	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1497	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1498	the RGB cube.
		1499
		1500	Together, all those colours implement the 88 (256) colour xterm
		1501	colours. Only the first 16 can be changed using resources currently, the
		1502	rest can only be changed via command sequences ("escape codes").
		1503
		1504	Applications are advised to use terminfo or command sequences to discover
		1505	number and RGB values of all colours (yes, you can query this...).
		1506
1087	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1507	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1088	always swapping the foreground/background colours. This is in contrast to	1508	always swapping the foreground/background colours. This is in contrast to
1089	I<xterm>(1) where the colours are only swapped if they have not otherwise	1509	I<xterm>(1) where the colours are only swapped if they have not otherwise
1090	been specified. For example,	1510	been specified. For example,
1091		1511
		1512	@@RXVT_NAME@@ -fg Black -bg White -rv
		1513
		1514	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1515	White.
		1516
		1517	=head2 ALPHA CHANNEL SUPPORT
		1518
		1519	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1520	their act together, rxvt-unicode will do it's own alpha channel management:
		1521
		1522	You can prefix any colour with an opaqueness percentage enclosed in
		1523	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1524	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1525	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1526	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1527	is the recommended format to specify transparency values, and works with
		1528	all ways to specify a colour.
		1529
		1530	For complete control, rxvt-unicode also supports
		1531	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1532	specifications, where the additional C<aaaa> component specifies opacity
		1533	(alpha) values. The minimum value of C<0000> is completely transparent,
		1534	while C<ffff> is completely opaque). The two example colours from
		1535	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1536	C<rgba:0000/ff00/0000/f332>.
		1537
		1538	You probably need to specify B<"-depth 32">, too, to force a visual with
		1539	alpha channels, and have the luck that your X-server uses ARGB pixel
		1540	layout, as X is far from just supporting ARGB visuals out of the box, and
		1541	rxvt-unicode just fudges around.
		1542
		1543	For example, the following selects an almost completely transparent black
		1544	background, and an almost opaque pink foreground:
		1545
		1546	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1547
		1548	When not using a background image, then the interpretation of the
		1549	alpha channel is up to your compositing manager (most interpret it as
		1550	transparency of course).
		1551
		1552	When using a background pixmap or pseudo-transparency, then the background
		1553	colour will always behave as if it were completely transparent (so the
		1554	background image shows instead), regardless of how it was specified, while
		1555	other colours will either be transparent as specified (the background
		1556	image will show through) on servers supporting the RENDER extension, or
		1557	fully opaque on servers not supporting the RENDER EXTENSION.
		1558
		1559	Please note that due to bugs in Xft, specifying alpha values might result
		1560	in garbage being displayed when the X-server does not support the RENDER
		1561	extension.
		1562
		1563	=head1 ENVIRONMENT
		1564
		1565	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1566
1092	=over 4	1567	=over 4
1093		1568
1094	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1569	=item B<TERM>
1095		1570
1096	would yield White on Black, while on I<xterm>(1) it would yield Black	1571	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1097	on White.	1572	resources or on the command line.
		1573
		1574	=item B<COLORTERM>
		1575
		1576	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1577	compiled with background image support, and optionally with the added
		1578	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1579	screen.
		1580
		1581	=item B<COLORFGBG>
		1582
		1583	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1584	the colour code used as default foreground/text colour (or the string
		1585	C<default> to indicate that the default-colour escape sequence is to be
		1586	used), C<bg> is the colour code used as default background colour (or the
		1587	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1588	was compiled with background image support. Libraries like C<ncurses>
		1589	and C<slang> can (and do) use this information to optimize screen output.
		1590
		1591	=item B<WINDOWID>
		1592
		1593	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1594	window, which usually has subwindows for the scrollbar, the terminal
		1595	window and so on).
		1596
		1597	=item B<TERMINFO>
		1598
		1599	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1600	C<--with-terminfo=PATH>.
		1601
		1602	=item B<DISPLAY>
		1603
		1604	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1605	display in its child processes if C<-display> isn't used to override. It
		1606	defaults to C<:0> if it doesn't exist.
		1607
		1608	=item B<SHELL>
		1609
		1610	The shell to be used for command execution, defaults to C</bin/sh>.
		1611
		1612	=item B<RXVT_SOCKET>
		1613
		1614	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1615	@@RXVT_NAME@@d(1).
		1616
		1617	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
		1618
		1619	=item B<HOME>
		1620
		1621	Used to locate the default directory for the unix domain socket for
		1622	daemon communications and to locate various resource files (such as
		1623	C<.Xdefaults>)
		1624
		1625	=item B<XAPPLRESDIR>
		1626
		1627	Directory where application-specific X resource files are located.
		1628
		1629	=item B<XENVIRONMENT>
		1630
		1631	If set and accessible, gives the name of a X resource file to be loaded by
		1632	@@RXVT_NAME@@.
1098		1633
1099	=back	1634	=back
1100		1635
1101	=head1 ENVIRONMENT
1102
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1106	sets the environment variable B<DISPLAY> to specify which display
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1108	B<RXVTPATH> and B<PATH> to find XPM files.
1109
1110	=head1 FILES	1636	=head1 FILES
1111		1637
1112	=over 4	1638	=over 4
1113		1639
1114	=item B</usr/lib/X11/rgb.txt>	1640	=item B</usr/lib/X11/rgb.txt>
1115		1641
1116	Color names.	1642	Colour names.
1117		1643
1118	=back	1644	=back
1119		1645
1120	=head1 SEE ALSO	1646	=head1 SEE ALSO
1121		1647
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1648	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1123
1124	=head1 BUGS
1125
1126	Check the BUGS file for an up-to-date list.
1127
1128	Cursor change support is not yet implemented.
1129
1130	Click-and-drag doesn't work with X11 mouse report overriding.
1131		1649
1132	=head1 CURRENT PROJECT COORDINATOR	1650	=head1 CURRENT PROJECT COORDINATOR
1133		1651
1134	=over 4	1652	=over 4
1135		1653
1136	=item Project Coordinator	1654	=item Project Coordinator
1137		1655
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1656	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139		1657
1140	=item Web page maintainter	1658	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1659
1146	=back	1660	=back
1147		1661
1148	=head1 AUTHORS	1662	=head1 AUTHORS
1149		1663
…		…
1171		1685
1172	Project Coordinator (changes.txt 2.21a to 2.4.5)	1686	Project Coordinator (changes.txt 2.21a to 2.4.5)
1173		1687
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1688	=item Geoff Wing L<< <gcw@pobox.com> >>
1175		1689
1176	Rewrote screen display and text selection routines. Project Coordinator	1690	Rewrote screen display and text selection routines.
		1691
1177	(changes.txt 2.4.6 - rxvt-unicode)	1692	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178		1693
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1694	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180		1695
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1696	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182	character handling to store text in unicode, improve xterm	1697	extension, random hacks, numerous bugfixes and extensions.
1183	compatibility and apply numerous other bugfixes and extensions.
1184		1698
1185	Project Coordinator (Changes 1.0 -)	1699	Project Coordinator (Changes 1.0 -)
1186		1700
		1701	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1702
		1703	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1704
1187	=back	1705	=back
1188		1706

Diff Legend

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