ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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