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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs. Revision 1.188 by sf-exg, Thu Nov 4 12:13:20 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.188 by sf-exg, Thu Nov 4 12:13:20 2010 UTC