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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs. Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC vs.
Revision 1.196 by root, Fri May 6 10:18:00 2011 UTC