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.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
		20	=head1 FREQUENTLY ASKED QUESTIONS
		21
		22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		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>.
		26
17	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
18		28
19	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
20	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
21	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
22	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
23	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
24	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
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	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
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
29	such as cursor-movement while editing -- break othwerwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
30	change.	40	change.
31		41
32	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
33	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
34	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
35	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
36	another for japanese.	46	another for japanese.
37		47
38	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
39	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
40	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
41	to choose any font for any script freely.	51	to choose any font for any script freely.
42		52
43	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
44	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
45	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
46	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
47		57
48	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
49	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
50	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
51	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
52	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
53	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
55		65
56	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
57	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
58	reference documentation (escape sequences etc.) and the FAQ section at the	68	reference documentation (escape sequences etc.).
59	end of this document.
60		69
61	=head1 OPTIONS	70	=head1 OPTIONS
62		71
63	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
64	below. In keeping with the smaller-is-better philosophy, options may be	73	below. In keeping with the smaller-is-better philosophy, options may be
…		…
83		92
84	Print out a message describing available options.	93	Print out a message describing available options.
85		94
86	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
87		96
88	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>
89	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
90	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]
91		110
92	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
93		112
94	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
95		114
…		…
97		116
98	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
99		118
100	=item B<-j>|B<+j>	119	=item B<-j>|B<+j>
101		120
102	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
103		122
104	=item B<-ip>|B<+ip>	123	=item B<-ss>|B<+ss>
105		124
106	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>.
107	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.
108		133
109	=item B<-fade> I<number>	134	=item B<-fade> I<number>
110		135
111	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>.
112		144
113	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
114		146
115	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
116	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	148	resource I<tintColor>.
117	option that can be used to brighten or darken the image in addition to
118	tinting it.
119		149
120	=item B<-sh>	150	=item B<-sh> I<number>
121		151
122	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
123	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
124	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>.
125		179
126	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
127		181
128	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
129		183
130	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
131		185
132	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
133		187
134	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
135		189
136	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
137	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
138	quotes to avoid special shell interpretation of the `;' in the	192	add quotes to avoid special shell interpretation of the C<;> in the
139	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
140		194
141	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
142		196
143	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
144		198
…		…
150		204
151	The mouse pointer background colour; resource B<pointerColor2>.	205	The mouse pointer background colour; resource B<pointerColor2>.
152		206
153	=item B<-bd> I<colour>	207	=item B<-bd> I<colour>
154		208
155	The colour of the border between the xterm scrollbar and the text;	209	The colour of the border around the text area and between the scrollbar and the text;
156	resource B<borderColor>.	210	resource B<borderColor>.
157		211
158	=item B<-fn> I<fontname>	212	=item B<-fn> I<fontlist>
159		213
160	Select the fonts to be used. This is a comma seperated list of font	214	Select the fonts to be used. This is a comma separated list of font names
161	names that are used in turn when trying to display Unicode characters.	215	that are checked in order when trying to find glyphs for characters. The
162	The first font defines the cell size for characters; other fonts might	216	first font defines the cell size for characters; other fonts might be
163	be smaller, but not larger. A reasonable default font list is always	217	smaller, but not (in general) larger. A (hopefully) reasonable default
164	appended to it. resource B<font>.	218	font list is always appended to it. See resource B<font> for more details.
		219
		220	In short, to specify an X11 core font, just specify its name or prefix it
		221	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		222	e.g.:
		223
		224	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		225	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165		226
166	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
167	section.	228	section of @@RXVT_NAME@@(7).
168		229
		230	=item B<-fb> I<fontlist>
		231
		232	Compile I<font-styles>: The bold font list to use when B<bold> characters
		233	are to be printed. See resource B<boldFont> for details.
		234
		235	=item B<-fi> I<fontlist>
		236
		237	Compile I<font-styles>: The italic font list to use when I<italic>
		238	characters are to be printed. See resource B<italicFont> for details.
		239
		240	=item B<-fbi> I<fontlist>
		241
		242	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		243	italic> >> characters are to be printed. See resource B<boldItalicFont>
		244	for details.
		245
169	=item B<-rb>|B<+rb>	246	=item B<-is>|B<+is>
170		247
171	Enable "real bold" support. When this option is on, bold text will be	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
172	displayed using the first available bold font in the font list. Bold	249	foreground/background (default). See resource B<intensityStyles> for
173	fonts should thus be specified in the font list after their	250	details.
174	corresponding regular fonts. If no bold font can be found, a regular
175	font will be used. resource B<realBold>.
176		251
177	=item B<-name> I<name>	252	=item B<-name> I<name>
178		253
179	Specify the application name under which resources are to be obtained,	254	Specify the application name under which resources are to be obtained,
180	rather than the default executable file name. Name should not contain	255	rather than the default executable file name. Name should not contain
…		…
196		271
197	=item B<-sb>|B<+sb>	272	=item B<-sb>|B<+sb>
198		273
199	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
200		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
201	=item B<-si>|B<+si>	285	=item B<-si>|B<+si>
202		286
203	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
204	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
205		289
…		…
212		296
213	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.
214	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
215	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
216		300
217	=item B<-sr>|B<+sr>
218
219	Put scrollbar on right/left; resource B<scrollBar_right>.
220
221	=item B<-st>|B<+st>	301	=item B<-ptab>|B<+ptab>
222		302
223	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	303	If enabled (default), "Horizontal Tab" characters are being stored as
224	resource B<scrollBar_floating>.	304	actual wide characters in the screen buffer, which makes it possible to
		305	select and paste them. Since a horizontal tab is a cursor movement and
		306	not an actual glyph, this can sometimes be visually annoying as the cursor
		307	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
225		308
226	=item B<-bc>|B<+bc>	309	=item B<-bc>|B<+bc>
227		310
228	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
		312
		313	=item B<-uc>|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
229		316
230	=item B<-iconic>	317	=item B<-iconic>
231		318
232	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
233	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
…		…
250		337
251	=item B<-bl>	338	=item B<-bl>
252		339
253	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.
254	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
255	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>.
256		356
257	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
258		358
259	Compile I<linespace>: Lines (pixel height) to insert between each row	359	Compile I<frills>: Lines (pixel height) to insert between each row of
260	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>.
261		369
262	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
263		371
264	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
265	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
274	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
275	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
276	run the program specified by the B<SHELL> environment variable or,	384	run the program specified by the B<SHELL> environment variable or,
277	failing that, I<sh(1)>.	385	failing that, I<sh(1)>.
278		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
279	=item B<-title> I<text>	392	=item B<-title> I<text>
280		393
281	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
282	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
283	application name; resource B<title>.	396	application name; resource B<title>.
…		…
301		414
302	Compile I<XIM>: input method name. resource B<inputMethod>.	415	Compile I<XIM>: input method name. resource B<inputMethod>.
303		416
304	=item B<-imlocale> I<string>	417	=item B<-imlocale> I<string>
305		418
306	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.
307	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
308	extension to be able to input japanese characters while staying in	421	input extension to be able to input japanese characters while staying in
309	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>.
310		435
311	=item B<-insecure>	436	=item B<-insecure>
312		437
313	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
314	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
328	=item B<-ssr>|B<+ssr>	453	=item B<-ssr>|B<+ssr>
329		454
330	Turn on/off secondary screen scroll (default enabled); resource	455	Turn on/off secondary screen scroll (default enabled); resource
331	B<secondaryScroll>.	456	B<secondaryScroll>.
332		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
333	=item B<-xrm> I<resourcestring>	471	=item B<-xrm> I<string>
334		472
335	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>
336	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
337	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.
338		549
339	=back	550	=back
340		551
341	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
342		553
343	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
344	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
345		557
346	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
347	Xresource data: using the X libraries (Xrm*-functions) or internal	559	distribution do also load settings from the B<~/.Xresources> file when X
348	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
349	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	561	with later settings overwriting earlier ones:
350	resources using X11 tools like B<xset>. Many distribution do also load
351	settings from the B<~/.Xresources> file when X starts.
352		562
353	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	563	1. app-defaults file in $XAPPLRESDIR
354	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	564	2. $HOME/.Xdefaults
355	set in XAPPLOADDIR/URxvt (compile-time defined: usually	565	3. RESOURCE_MANAGER property on root-window of screen 0
356	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	566	4. SCREEN_RESOURCES property on root-window of the current screen
357	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
358	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
359	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
360	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
361	easily configured, while the class name B<URxvt> allows resources	573	configured, while the class name B<URxvt> allows resources unique to
362	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	574	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
363	shared between different B<@@RXVT_NAME@@> configurations. If no	575	configurations. If no resources are specified, suitable defaults will
364	resources are specified, suitable defaults will be used. Command-line	576	be used. Command-line arguments can be used to override resource
365	arguments can be used to override resource settings. The following	577	settings. The following resources are supported (you might want to
366	resources are allowed:	578	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		579	extensions not documented here):
367		580
368	=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.
369		594
370	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
371		596
372	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
373	option B<-geometry>.	598	option B<-geometry>.
…		…
387	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
388	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
389	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
390	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,
391	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
392	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
		618
		619	Colours higher than 15 cannot be set using resources (yet), but can be
		620	changed using an escape command (see @@RXVT_NAME@@(7)).
		621
		622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		623	88 colour support). Colours 80-87 are evenly spaces grey steps.
393		624
394	=item B<colorBD:> I<colour>	625	=item B<colorBD:> I<colour>
395		626
		627	=item B<colorIT:> I<colour>
		628
396	Use the specified colour to display bold characters when the foreground	629	Use the specified colour to display bold or italic characters when the
397	colour is the default. This option will be ignored if B<realBold> is	630	foreground colour is the default. If font styles are not available
398	enabled.	631	(Compile I<styles>) and this option is unset, reverse video is used instead.
399		632
400	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
401		634
402	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
403	foreground colour is the default.	636	foreground colour is the default.
404		637
405	=item B<colorRV:> I<colour>	638	=item B<underlineColor:> I<colour>
406		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
407	Use the specified colour as the background for reverse video	645	If set, use the specified colour as the background for highlighted
408	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.
409		652
410	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
411		654
412	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
413	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
420		663
421	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
422		665
423	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
424	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
425	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
426		669
427	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
428		671
429	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
430	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
431	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>.
432		679
433	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
434		681
435	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
436	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
437	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.
438		698
439	=item B<fading:> I<number>	699	=item B<fading:> I<number>
440		700
441	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>.
442		707
443	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
444		709
445	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>.
446		715
447	=item B<shading:> I<number>	716	=item B<shading:> I<number>
448		717
449	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
450	image in addition to tinting it.	719	A value of 100 means no shading; option B<-sh>.
451		720
		721	=item B<blendType:> I<string>
		722
		723	Specify background blending type; option B<-blt>.
		724
452	=item B<fading:> I<number>	725	=item B<blurRadius:> I<number>
453		726
454	Scale the tint colour by the given percentage.	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>.
455		733
456	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
457		735
458	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
459		737
460	=item B<troughColor:> I<colour>	738	=item B<troughColor:> I<colour>
461		739
462	Use the specified colour for the scrollbar's trough area [default	740	Use the specified colour for the scrollbar's trough area [default
463	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	741	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
464		742
		743	=item B<borderColor:> I<colour>
		744
		745	The colour of the border around the text area and between the scrollbar
		746	and the text.
		747
465	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
466		749
467	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
468	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
469	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
470	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
471	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
472	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
473	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
474	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
475	scale is 1000. [default 0x0+50+50]
476		758
477	=item B<menu:> I<file[;tag]>	759	op=tile enables tiling
		760	op=pscale enables proportional scaling
		761	op=root use the position of the terminal window relative to the root
		762	window as the image offset, simulating a root window background
478		763
479	Read in the specified menu file (note the `.menu' extension is	764	Alternatively, a predefined set of templates can be used to achieve
480	optional) and also optionally specify a starting tag to find. See the	765	the most common setups:
481	reference documentation for details on the syntax for the menuBar.	766
		767	style=tiled the image is tiled with no scaling
		768	style=aspect-stretched the image is scaled to fill the whole window maintaining
		769	the aspect ratio and centered
		770	style=stretched the image is scaled to fill the whole window
		771	style=centered the image is centered with no scaling
		772	style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
		773
		774	If multiple templates are specified the last one wins. Note that a
		775	template overrides all the scale, position and operations settings.
		776	Indeed, the templates can be specified in terms of low level settings
		777	as follows:
		778
		779	style=tiled 0x0+0+0:op=tile
		780	style=aspect-stretched +50+50:op=pscale
		781	style=stretched 100x100
		782	style=centered 0x0+50+50
		783	style=root-tiled 0x0:op=tile:op=root
		784
		785	If used in conjunction with B<-tr> option, the specified pixmap will be
		786	blended over the transparent background using alpha-blending. If I<afterimage>
		787	support has been compiled in it is possible to choose other blending
		788	types with B<-blt "type"> option.
482		789
483	=item B<path:> I<path>	790	=item B<path:> I<path>
484		791
485	Specify the colon-delimited search path for finding files (XPM and	792	Specify the colon-delimited search path for finding background image files.
486	menus), in addition to the paths specified by the B<RXVTPATH> and
487	B<PATH> environment variables.
488		793
489	=item B<font:> I<fontname>	794	=item B<font:> I<fontlist>
490		795
491	Select the fonts to be used. This is a comma seperated list of font	796	Select the fonts to be used. This is a comma separated list of font names
492	names that are used in turn when trying to display Unicode characters.	797	that are checked in order when trying to find glyphs for characters. The
493	The first font defines the cell size for characters; other fonts might	798	first font defines the cell size for characters; other fonts might be
494	be smaller, but not larger. A reasonable default font list is always	799	smaller, but not (in general) larger. A (hopefully) reasonable default
495	appended to it. option B<-fn>.	800	font list is always appended to it; option B<-fn>.
496		801
497	=item B<realBold:> I<boolean>	802	Each font can either be a standard X11 core font (XLFD) name, with
		803	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498		804
499	B<True>: Enable "real bold" support. When this option is on, bold text	805	In addition, each font can be prefixed with additional hints and
500	will be displayed using the first available bold font in the font list.	806	specifications enclosed in square brackets (C<[]>). The only available
501	Bold fonts should thus be specified in the font list after their	807	hint currently is C<codeset=codeset-name>, and this is only used for Xft
502	corresponding regular fonts. If no bold font can be found, a regular	808	fonts.
503	font will be used. option B<-rb>. B<False>: Display bold text in a
504	regular font, using the color specified with B<colorBD>; option B<+rb>.
505		809
506	=item B<selectstyle:> I<mode>	810	For example, this font resource
507		811
508	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	812	URxvt.font: 9x15bold,\
509	xterm style with 2.20 old word selection, or anything else which gives	813	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
510	xterm style selection.	814	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		815	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		816	xft:Code2000:antialias=false
511		817
512	=item B<scrollstyle:> I<mode>	818	specifies five fonts to be used. The first one is C<9x15bold> (actually
		819	the iso8859-1 version of the second font), which is the base font (because
		820	it is named first) and thus defines the character cell grid to be 9 pixels
		821	wide and 15 pixels high.
513		822
514	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	823	The second font is just used to add additional unicode characters not in
515	the author's favourite..	824	the base font, likewise the third, which is unfortunately non-bold, but
		825	the bold version of the font does contain fewer characters, so this is a
		826	useful supplement.
		827
		828	The third font is an Xft font with aliasing turned off, and the characters
		829	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		830	contains other characters, but we are not interested in them.
		831
		832	The last font is a useful catch-all font that supplies most of the
		833	remaining unicode characters.
		834
		835	=item B<boldFont:> I<fontlist>
		836
		837	=item B<italicFont:> I<fontlist>
		838
		839	=item B<boldItalicFont:> I<fontlist>
		840
		841	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		842	italic> >> characters, respectively.
		843
		844	If specified and non-empty, then the syntax is the same as for the
		845	B<font>-resource, and the given font list will be used as is, which makes
		846	it possible to substitute completely different font styles for bold and
		847	italic.
		848
		849	If unset (the default), a suitable font list will be synthesized by
		850	"morphing" the normal text font list into the desired shape. If that is
		851	not possible, replacement fonts of the desired shape will be tried.
		852
		853	If set, but empty, then this specific style is disabled and the normal
		854	text font will being used for the given style.
		855
		856	=item B<intensityStyles:> I<boolean>
		857
		858	When font styles are not enabled, or this option is enabled (B<True>,
		859	option B<-is>, the default), bold/blink font styles imply high
		860	intensity foreground/background colours. Disabling this option (B<False>,
		861	option B<+is>) disables this behaviour, the high intensity colours are not
		862	reachable.
516		863
517	=item B<title:> I<string>	864	=item B<title:> I<string>
518		865
519	Set window title string, the default title is the command-line	866	Set window title string, the default title is the command-line
520	specified after the B<-e> option, if any, otherwise the application	867	specified after the B<-e> option, if any, otherwise the application
…		…
529	=item B<mapAlert:> I<boolean>	876	=item B<mapAlert:> I<boolean>
530		877
531	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	878	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
532	de-iconify (map) on receipt of a bell character [default].	879	de-iconify (map) on receipt of a bell character [default].
533		880
		881	=item B<urgentOnBell:> I<boolean>
		882
		883	B<True>: set the urgency hint for the wm on receipt of a bell character.
		884	B<False>: do not set the urgency hint [default].
		885
		886	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		887
534	=item B<visualBell:> I<boolean>	888	=item B<visualBell:> I<boolean>
535		889
536	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	890	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
537	B<False>: no visual bell [default]; option B<+vb>.	891	B<False>: no visual bell [default]; option B<+vb>.
538		892
…		…
552		906
553	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	907	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
554	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	908	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
555	B<Shift-Print> to include the scrollback as well.	909	B<Shift-Print> to include the scrollback as well.
556		910
		911	The string will be interpreted as if typed into the shell as-is.
		912
		913	Example:
		914
		915	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		916
		917	This creates a new file in your home directory with the screen contents
		918	every time you hit C<Print>.
		919
		920	=item B<scrollstyle:> I<mode>
		921
		922	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		923	the author's favourite.
		924
		925	=item B<thickness:> I<number>
		926
		927	Set the scrollbar width in pixels.
		928
557	=item B<scrollBar:> I<boolean>	929	=item B<scrollBar:> I<boolean>
558		930
559	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	931	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
560	disable the scrollbar; option B<+sb>.	932	disable the scrollbar; option B<+sb>.
561		933
…		…
580	B<False>: do not scroll to bottom when tty receives output; option	952	B<False>: do not scroll to bottom when tty receives output; option
581	B<+si>.	953	B<+si>.
582		954
583	=item B<scrollWithBuffer:> I<boolean>	955	=item B<scrollWithBuffer:> I<boolean>
584		956
585	B<True>: scroll with scrollback buffer when tty recieves new lines (and	957	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
586	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	958	try to show the same lines) and B<scrollTtyOutput> is False; option
587	with scrollback buffer when tty recieves new lines; option B<-sw>.	959	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		960	new lines; option B<+sw>.
588		961
589	=item B<scrollTtyKeypress:> I<boolean>	962	=item B<scrollTtyKeypress:> I<boolean>
590		963
591	B<True>: scroll to bottom when a non-special key is pressed. Special keys	964	B<True>: scroll to bottom when a non-special key is pressed. Special keys
592	are those which are intercepted by rxvt-unicode for special handling and	965	are those which are intercepted by rxvt-unicode for special handling and
…		…
611	=item B<borderLess:> I<boolean>	984	=item B<borderLess:> I<boolean>
612		985
613	Set MWM hints to request a borderless window, i.e. if honoured by the	986	Set MWM hints to request a borderless window, i.e. if honoured by the
614	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	987	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
615		988
		989	=item B<skipBuiltinGlyphs:> I<boolean>
		990
		991	Compile I<frills>: Disable the usage of the built-in block graphics/line
		992	drawing characters and just rely on what the specified fonts provide. Use
		993	this if you have a good font and want to use its block graphic glyphs;
		994	option B<-sbg>.
		995
616	=item B<termName:> I<termname>	996	=item B<termName:> I<termname>
617		997
618	Specifies the terminal type name to be set in the B<TERM> environment	998	Specifies the terminal type name to be set in the B<TERM> environment
619	variable; option B<-tn>.	999	variable; option B<-tn>.
620		1000
621	=item B<linespace:> I<number>	1001	=item B<lineSpace:> I<number>
622		1002
623	Specifies number of lines (pixel height) to insert between each row of	1003	Specifies number of lines (pixel height) to insert between each row of
624	the display [default 0]; option B<-lsp>.	1004	the display [default 0]; option B<-lsp>.
625		1005
626	=item B<meta8:> I<boolean>	1006	=item B<meta8:> I<boolean>
…		…
631	=item B<mouseWheelScrollPage:> I<boolean>	1011	=item B<mouseWheelScrollPage:> I<boolean>
632		1012
633	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	1013	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634	scrolls five lines [default].	1014	scrolls five lines [default].
635		1015
		1016	=item B<pastableTabs:> I<boolean>
		1017
		1018	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		1019	movement only; option C<-ptab>.
		1020
636	=item B<cursorBlink:> I<boolean>	1021	=item B<cursorBlink:> I<boolean>
637		1022
638	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1023	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639	option B<-bc>.	1024	option B<-bc>.
		1025
		1026	=item B<cursorUnderline:> I<boolean>
		1027
		1028	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1029	option B<-uc>.
640		1030
641	=item B<pointerBlank:> I<boolean>	1031	=item B<pointerBlank:> I<boolean>
642		1032
643	B<True>: blank the pointer when a key is pressed or after a set number	1033	B<True>: blank the pointer when a key is pressed or after a set number
644	of seconds of inactivity. B<False>: the pointer is always visible	1034	of seconds of inactivity. B<False>: the pointer is always visible
…		…
652		1042
653	Mouse pointer background colour.	1043	Mouse pointer background colour.
654		1044
655	=item B<pointerBlankDelay:> I<number>	1045	=item B<pointerBlankDelay:> I<number>
656		1046
657	Specifies number of seconds before blanking the pointer [default 2].	1047	Specifies number of seconds before blanking the pointer [default 2]. Use a
		1048	large number (e.g. C<987654321>) to effectively disable the timeout.
658		1049
659	=item B<backspacekey:> I<string>	1050	=item B<backspacekey:> I<string>
660		1051
661	The string to send when the backspace key is pressed. If set to B<DEC>	1052	The string to send when the backspace key is pressed. If set to B<DEC>
662	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1053	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
663	(code 8) - which can be reversed with the appropriate DEC private mode	1054	(code 8) - which can be reversed with the appropriate DEC private mode
664	escape sequence.	1055	escape sequence.
665		1056
666	=item B<deletekey:> I<string>	1057	=item B<deletekey:> I<string>
667		1058
…		…
669	pressed. If unset it will send the sequence traditionally associated	1060	pressed. If unset it will send the sequence traditionally associated
670	with the B<Execute> key.	1061	with the B<Execute> key.
671		1062
672	=item B<cutchars:> I<string>	1063	=item B<cutchars:> I<string>
673		1064
674	The characters used as delimiters for double-click word selection. The	1065	The characters used as delimiters for double-click word selection
675	built-in default:	1066	(whitespace delimiting is added automatically if resource is given).
676		1067
		1068	When the perl selection extension is in use (the default if compiled
		1069	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1070	characters will be created (if the resource exists, otherwise, no regex
		1071	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1072
		1073	When the selection extension is not used, only ISO-8859-1 characters can
		1074	be used. If not specified, the built-in default is used:
		1075
677	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1076	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
678		1077
679	=item B<preeditType:> I<style>	1078	=item B<preeditType:> I<style>
680		1079
681	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1080	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
682		1081
…		…
684		1083
685	I<name> of inputMethod to use; option B<-im>.	1084	I<name> of inputMethod to use; option B<-im>.
686		1085
687	=item B<imLocale:> I<name>	1086	=item B<imLocale:> I<name>
688		1087
689	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1088	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
690	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1089	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
691	extension to be able to input japanese characters while staying in	1090	input extension to be able to input japanese characters while staying in
692	another locale. option B<-imlocale>.	1091	another locale; option B<-imlocale>.
693		1092
694	=item B<insecure>	1093	=item B<imFont:> I<fontset>
		1094
		1095	Specify the font-set used for XIM styles C<OverTheSpot> or
		1096	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1097	by commas), i.e. it's not in the same format as the other font lists used
		1098	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1099	found, preferably one or two pixels differing in size to the base font.
		1100	option B<-imfont>.
		1101
		1102	=item B<tripleclickwords:> I<boolean>
		1103
		1104	Change the meaning of triple-click selection with the left mouse
		1105	button. Instead of selecting a full line it will extend the selection to
		1106	the end of the logical line only; option B<-tcw>.
		1107
		1108	=item B<insecure:> I<boolean>
695		1109
696	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1110	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697	echo arbitrary strings like the icon name or the locale. This could be	1111	echo arbitrary strings like the icon name or the locale. This could be
698	abused if somebody gets 8-bit-clean access to your display, wether	1112	abused if somebody gets 8-bit-clean access to your display, whether
699	throuh a mail client displaying mail bodies unfiltered or though	1113	through a mail client displaying mail bodies unfiltered or through
700	write(1). Therefore, these sequences are disabled by default. (Note	1114	write(1) or any other means. Therefore, these sequences are disabled by
701	that other terminals, including xterm, have these sequences	1115	default. (Note that many other terminals, including xterm, have these
702	enabled by default). You can enable them by setting this boolean	1116	sequences enabled by default, which doesn't make it safer, though).
703	resource or specifying B<-insecure> as an option. At the moment, this	1117
704	enabled display-answer, locale, findfont, icon label and window title	1118	You can enable them by setting this boolean resource or specifying
705	requests as well as dynamic menubar dispatch.	1119	B<-insecure> as an option. At the moment, this enables display-answer,
		1120	locale, findfont, icon label and window title requests.
706		1121
707	=item B<modifier:> I<modifier>	1122	=item B<modifier:> I<modifier>
708		1123
709	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1124	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
710	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1125	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
714		1129
715	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1130	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
716	character is passed through. It may contain escape values as described	1131	character is passed through. It may contain escape values as described
717	in the entry on B<keysym> following.	1132	in the entry on B<keysym> following.
718		1133
719	=item B<secondaryScreen:> I<bool>	1134	=item B<secondaryScreen:> I<boolean>
720		1135
721	Turn on/off secondary screen (default enabled).	1136	Turn on/off secondary screen (default enabled).
722		1137
723	=item B<secondaryScroll:> I<bool>	1138	=item B<secondaryScroll:> I<boolean>
724		1139
725	Turn on/off secondary screen scroll (default enabled). If the this	1140	Turn on/off secondary screen scroll (default enabled). If this
726	option is enabled, scrolls on the secondary screen will change the	1141	option is enabled, scrolls on the secondary screen will change the
727	scrollback buffer and switching to/from the secondary screen will	1142	scrollback buffer and, when secondaryScreen is off, switching
728	instead scroll the screen up.	1143	to/from the secondary screen will instead scroll the screen up.
		1144
		1145	=item B<hold>: I<boolean>
		1146
		1147	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1148	will not immediately destroy its window when the program executed within
		1149	it exits. Instead, it will wait till it is being killed or closed by the
		1150	user.
		1151
		1152	=item B<chdir>: I<path>
		1153
		1154	Sets the working directory for the shell (or the command specified via
		1155	B<-e>). The I<path> must be an absolute path and it must exist for
		1156	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1157	directory will be used; option B<-cd>.
729		1158
730	=item B<keysym.>I<sym>: I<string>	1159	=item B<keysym.>I<sym>: I<string>
731		1160
732	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1161	Compile I<frills>: Associate I<string> with keysym I<sym>. The
733	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
734	newline, \r: return, \t:
735	tab, \000: octal number) or control characters (^?: delete, ^@: null,
736	^A ...) and may enclosed with double quotes so that it can start or end
737	with whitespace. The intervening resource name B<keysym.> cannot be	1162	intervening resource name B<keysym.> cannot be omitted.
738	omitted. This resource is only available when compiled with	1163
739	KEYSYM_RESOURCE.	1164	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1165	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1166	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1167	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1168	B<2>, B<3>, B<4>, B<5>.
		1169
		1170	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1171	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1172	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1173	current application keymap mode state.
		1174
		1175	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1176	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1177	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1178	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1179	performed in an exact manner; however, the closest match is assured.
		1180
		1181	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1182	number), see RESOURCES in C<man 7 X> for further details.
		1183
		1184	You can define a range of keysyms in one shot by providing a I<string>
		1185	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1186	should be a character not used by the strings.
		1187
		1188	Its usage can be demonstrated by an example:
		1189
		1190	URxvt.keysym.M-C-0x61: list|\033<|abc|>
		1191
		1192	The above line is equivalent to the following three lines:
		1193
		1194	URxvt.keysym.Meta-Control-0x61: \033<a>
		1195	URxvt.keysym.Meta-Control-0x62: \033<b>
		1196	URxvt.keysym.Meta-Control-0x63: \033<c>
		1197
		1198	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1199	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1200	example the following means "change the current locale to C<zh_CN.GBK>
		1201	when Control-Meta-c is being pressed":
		1202
		1203	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1204
		1205	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1206	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1207	manpage. For example, the F<selection> extension (activated via
		1208	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1209
		1210	URxvt.keysym.M-C-c: perl:selection:rot13
		1211
		1212	Due the the large number of modifier combinations, a defined key mapping
		1213	will match if I<at least> the specified identifiers are being set, and
		1214	no other key mappings with those and more bits are being defined. That
		1215	means that defining a key map for C<a> will automatically provide
		1216	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1217	mappings themselves.
		1218
		1219	Unfortunately, this will override built-in key mappings. For example
		1220	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1221	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1222	user-defined keymap using the C<builtin:> replacement:
		1223
		1224	URxvt.keysym.Insert: <my insert key sequence>
		1225	URxvt.keysym.S-Insert: builtin:
		1226
		1227	The first line defines a mapping for C<Insert> and I<any> combination
		1228	of modifiers. The second line re-establishes the default mapping for
		1229	C<Shift-Insert>.
		1230
		1231	The following example will map Control-Meta-1 and Control-Meta-2 to
		1232	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1233	font-switching at runtime:
		1234
		1235	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1236	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1237
		1238	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1239	info):
		1240
		1241	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1242	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1243
		1244	=item B<perl-ext-common>: I<string>
		1245
		1246	=item B<perl-ext>: I<string>
		1247
		1248	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1249	use in this terminal instance; option B<-pe>.
		1250
		1251	Extension names can be prefixed with a C<-> sign to prohibit using
		1252	them. This can be useful to selectively disable some extensions loaded
		1253	by default, or specified via the C<perl-ext-common> resource. For
		1254	example, C<default,-selection> will use all the default extension except
		1255	C<selection>.
		1256
		1257	Extension names can also be followed by an argument in angle brackets
		1258	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1259	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1260	multiple times with different arguments will pass multiple arguments to
		1261	the extension.
		1262
		1263	Each extension is looked up in the library directories, loaded if
		1264	necessary, and bound to the current terminal instance.
		1265
		1266	If both of these resources are the empty string, then the perl
		1267	interpreter will not be initialized. The idea behind two options is that
		1268	B<perl-ext-common> will be used for extensions that should be available to
		1269	all instances, while B<perl-ext> is used for specific instances.
		1270
		1271	=item B<perl-eval>: I<string>
		1272
		1273	Perl code to be evaluated when all extensions have been registered. See
		1274	the @@RXVT_NAME@@perl(3) manpage.
		1275
		1276	=item B<perl-lib>: I<path>
		1277
		1278	Colon-separated list of additional directories that hold extension
		1279	scripts. When looking for extensions specified by the C<perl> resource,
		1280	@@RXVT_NAME@@ will first look in these directories and then in
		1281	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1282
		1283	See the @@RXVT_NAME@@perl(3) manpage.
		1284
		1285	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1286
		1287	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1288	details.
		1289
		1290	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1291
		1292	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1293	for details.
		1294
		1295	=item B<searchable-scrollback:> I<keysym>
		1296
		1297	Sets the hotkey that starts the incremental scrollback buffer search
		1298	(default: C<M-s>).
		1299
		1300	=item B<urlLauncher>: I<string>
		1301
		1302	Specifies the program to be started with a URL argument. Used by the
		1303	C<selection-popup> and C<matcher> perl extensions.
		1304
		1305	=item B<transient-for>: I<windowid>
		1306
		1307	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1308
		1309	=item B<override-redirect>: I<boolean>
		1310
		1311	Compile I<frills>: Sets override-redirect for the terminal window, making
		1312	it almost invisible to window managers; option B<-override-redirect>.
		1313
		1314	=item B<iso14755:> I<boolean>
		1315
		1316	Turn on/off ISO 14755 (default enabled).
		1317
		1318	=item B<iso14755_52:> I<boolean>
		1319
		1320	Turn on/off ISO 14755 5.2 mode (default enabled).
740		1321
741	=back	1322	=back
742		1323
743	=head1 THE SCROLLBAR	1324	=head1 THE SCROLLBAR
744		1325
…		…
758	the normal text selection/insertion, hold either the Shift or the Meta	1339	the normal text selection/insertion, hold either the Shift or the Meta
759	(Alt) key while performing the desired mouse action.	1340	(Alt) key while performing the desired mouse action.
760		1341
761	If mouse reporting mode is active, the normal scrollbar actions are	1342	If mouse reporting mode is active, the normal scrollbar actions are
762	disabled -- on the assumption that we are using a fullscreen	1343	disabled -- on the assumption that we are using a fullscreen
763	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1344	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1345	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
765	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1346	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766	respectively.	1347	respectively.
767		1348
768	=head1 TEXT SELECTION AND INSERTION	1349	=head1 THE SELECTION: SELECTING AND PASTING TEXT
769		1350
770	The behaviour of text selection and insertion mechanism is similar to	1351	The behaviour of text selection and insertion/pasting mechanism is similar
771	I<xterm>(1).	1352	to I<xterm>(1).
772		1353
773	=over 4	1354	=over 4
774		1355
775	=item B<Selection>:	1356	=item B<Selecting>:
776		1357
777	Left click at the beginning of the region, drag to the end of the	1358	Left click at the beginning of the region, drag to the end of the region
778	region and release; Right click to extend the marked region; Left	1359	and release; Right click to extend the marked region; Left double-click
779	double-click to select a word; Left triple-click to select the entire	1360	to select a word; Left triple-click to select the entire logical line
780	line.	1361	(which can span multiple screen lines), unless modified by resource
		1362	B<tripleclickwords>.
781		1363
		1364	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1365	(Compile: I<frills>) will create a rectangular selection instead of a
		1366	normal one. In this mode, every selected row becomes its own line in the
		1367	selection, and trailing whitespace is visually underlined and removed from
		1368	the selection.
		1369
782	=item B<Insertion>:	1370	=item B<Pasting>:
783		1371
784	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1372	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
785	an B<@@RXVT_NAME@@> window causes the current text selection to be	1373	window causes the value of the PRIMARY selection (or CLIPBOARD with the
786	inserted as if it had been typed on the keyboard.	1374	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1375
		1376	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1377	inserted too.
787		1378
788	=back	1379	=back
789		1380
790	=head1 CHANGING FONTS	1381	=head1 CHANGING FONTS
791		1382
792	Changing fonts (or font sizes, respectively) via the keypad is not yet	1383	Changing fonts (or font sizes, respectively) via the keypad is not yet
793	supported in rxvt-unicode. Bug me if you need this.	1384	supported in rxvt-unicode. Bug me if you need this.
794		1385
795	You can, however, switch fonts at runtime using escape sequences (and	1386	You can, however, switch fonts at runtime using escape sequences, e.g.:
796	therefore using the menubar), e.g.:
797		1387
798	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1388	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1389
		1390	You can use keyboard shortcuts, too:
		1391
		1392	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1393	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799		1394
800	rxvt-unicode will automatically re-apply these fonts to the output so far.	1395	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		1396
802	=head1 ISO 14755 SUPPORT	1397	=head1 ISO 14755 SUPPORT
803		1398
804	ISO 14755 is a standard for entering and viewing unicode characters	1399	ISO 14755 is a standard for entering and viewing unicode characters
805	and character codes using the keyboard. It consists of 4 parts. The	1400	and character codes using the keyboard. It consists of 4 parts. The
806	first part is available rxvt-unicode has been compiled with	1401	first part is available if rxvt-unicode has been compiled with
807	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1402	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808	with C<--enable-iso14755>.	1403	with C<--enable-iso14755>.
809		1404
810	=over 4	1405	=over 4
811		1406
812	=item 5.1: Basic method	1407	=item * 5.1: Basic method
813		1408
814	This allows you to enter unicode characters using their hexcode.	1409	This allows you to enter unicode characters using their hexcode.
815		1410
816	Start by pressing and holding both C<Control> and C<Shift>, then enter	1411	Start by pressing and holding both C<Control> and C<Shift>, then enter
817	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1412	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
824	address, which you cannot type. Fortunately, the card has the e-mail	1419	address, which you cannot type. Fortunately, the card has the e-mail
825	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1420	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
826	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1421	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827	followed by releasing the modifier keys.	1422	followed by releasing the modifier keys.
828		1423
829	=item 5.2: Keyboard symbols entry method	1424	=item * 5.2: Keyboard symbols entry method
830		1425
831	This mode lets you input characters representing the keycap symbols of	1426	This mode lets you input characters representing the keycap symbols of
832	your keyboard, if representable in the current locale encoding.	1427	your keyboard, if representable in the current locale encoding.
833		1428
834	Start by pressing C<Control> and C<Shift> together, then releasing	1429	Start by pressing C<Control> and C<Shift> together, then releasing
835	them. The next special key (cursor keys, home etc.) you enter will not	1430	them. The next special key (cursor keys, home etc.) you enter will not
836	invoke it's usual function but instead will insert the corresponding	1431	invoke its usual function but instead will insert the corresponding
837	keycap symbol. The symbol will only be entered when the key has been	1432	keycap symbol. The symbol will only be entered when the key has been
838	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1433	released, otherwise pressing e.g. C<Shift> would enter the symbol for
839	C<ISO Level 2 Switch>, although your intention might have beenm to enter a	1434	C<ISO Level 2 Switch>, although your intention might have been to enter a
840	reverse tab (Shift-Tab).	1435	reverse tab (Shift-Tab).
841		1436
842	=item 5.3: Screen-selection entry method	1437	=item * 5.3: Screen-selection entry method
843		1438
844	While this is implemented already (it's basically the selection	1439	While this is implemented already (it's basically the selection
845	mechanism), it could be extended by displaying a unicode character map.	1440	mechanism), it could be extended by displaying a unicode character map.
846		1441
847	=item 5.4: Feedback method for identifying displayed characters for later input	1442	=item * 5.4: Feedback method for identifying displayed characters for later input
848		1443
849	This method lets you display the unicode character code associated with	1444	This method lets you display the unicode character code associated with
850	characters already displayed.	1445	characters already displayed.
851		1446
852	You enter this mode by holding down C<Control> and C<Shift> together, then	1447	You enter this mode by holding down C<Control> and C<Shift> together, then
853	pressing and holding the left mouse button and moving around. The unicode	1448	pressing and holding the left mouse button and moving around. The unicode
854	hex code(s) (it might be a combining character) of the character under the	1449	hex code(s) (it might be a combining character) of the character under the
855	pointer is displayed until you release C<Control> and C<Shift>.	1450	pointer is displayed until you release C<Control> and C<Shift>.
856		1451
		1452	In addition to the hex codes it will display the font used to draw this
		1453	character - due to implementation reasons, characters combined with
		1454	combining characters, line drawing characters and unknown characters will
		1455	always be drawn using the built-in support font.
		1456
857	=back	1457	=back
858		1458
859	With respect to conformance, rxvt-unicode is supposed to be compliant to	1459	With respect to conformance, rxvt-unicode is supposed to be compliant to
860	both scenario A and B of ISO 14755, including part 5.2.	1460	both scenario A and B of ISO 14755, including part 5.2.
861		1461
862	=head1 LOGIN STAMP	1462	=head1 LOGIN STAMP
863		1463
864	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1464	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
865	that it can be seen via the I<who(1)> command, and can accept messages.	1465	it can be seen via the I<who(1)> command, and can accept messages. To
866	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1466	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867	some systems.	1467	on some systems or setgid to root or to some other group on others.
868		1468
869	=head1 COLORS AND GRAPHICS	1469	=head1 COLOURS AND GRAPHICS
870		1470
871	In addition to the default foreground and background colours,	1471	In addition to the default foreground and background colours,
872	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1472	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
873	high-intensity bold/blink versions of the same). Here is a list of the	1473	high-intensity (potentially bold/blink) versions of the same, and 72 (or
874	colours with their B<rgb.txt> names.	1474	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1475	cube plus a 8 (24) colour greyscale ramp.
		1476
		1477	Here is a list of the ANSI colours with their names.
875		1478
876	=begin table	1479	=begin table
877		1480
878	B<color0> (black) = Black	1481	B<color0> (black) = Black
879	B<color1> (red) = Red3	1482	B<color1> (red) = Red3
…		…
899	It is also possible to specify the colour values of B<foreground>,	1502	It is also possible to specify the colour values of B<foreground>,
900	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1503	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
901	a number 0-15, as a convenient shorthand to reference the colour name of	1504	a number 0-15, as a convenient shorthand to reference the colour name of
902	color0-color15.	1505	color0-color15.
903		1506
		1507	The following text gives values for the standard 88 colour mode (and
		1508	values for the 256 colour mode in parentheses).
		1509
		1510	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1511
		1512	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1513	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1514
		1515	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1516	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1517	the RGB cube.
		1518
		1519	Together, all those colours implement the 88 (256) colour xterm
		1520	colours. Only the first 16 can be changed using resources currently, the
		1521	rest can only be changed via command sequences ("escape codes").
		1522
		1523	Applications are advised to use terminfo or command sequences to discover
		1524	number and RGB values of all colours (yes, you can query this...).
		1525
904	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1526	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
905	always swapping the foreground/background colours. This is in contrast to	1527	always swapping the foreground/background colours. This is in contrast to
906	I<xterm>(1) where the colours are only swapped if they have not otherwise	1528	I<xterm>(1) where the colours are only swapped if they have not otherwise
907	been specified. For example,	1529	been specified. For example,
908		1530
		1531	@@RXVT_NAME@@ -fg Black -bg White -rv
		1532
		1533	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1534	White.
		1535
		1536	=head2 ALPHA CHANNEL SUPPORT
		1537
		1538	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1539	their act together, rxvt-unicode will do it's own alpha channel management:
		1540
		1541	You can prefix any colour with an opaqueness percentage enclosed in
		1542	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1543	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1544	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1545	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1546	is the recommended format to specify transparency values, and works with
		1547	all ways to specify a colour.
		1548
		1549	For complete control, rxvt-unicode also supports
		1550	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1551	specifications, where the additional C<aaaa> component specifies opacity
		1552	(alpha) values. The minimum value of C<0000> is completely transparent,
		1553	while C<ffff> is completely opaque). The two example colours from
		1554	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1555	C<rgba:0000/ff00/0000/f332>.
		1556
		1557	You probably need to specify B<"-depth 32">, too, to force a visual with
		1558	alpha channels, and have the luck that your X-server uses ARGB pixel
		1559	layout, as X is far from just supporting ARGB visuals out of the box, and
		1560	rxvt-unicode just fudges around.
		1561
		1562	For example, the following selects an almost completely transparent black
		1563	background, and an almost opaque pink foreground:
		1564
		1565	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1566
		1567	When not using a background image, then the interpretation of the
		1568	alpha channel is up to your compositing manager (most interpret it as
		1569	transparency of course).
		1570
		1571	When using a background pixmap or pseudo-transparency, then the background
		1572	colour will always behave as if it were completely transparent (so the
		1573	background image shows instead), regardless of how it was specified, while
		1574	other colours will either be transparent as specified (the background
		1575	image will show through) on servers supporting the RENDER extension, or
		1576	fully opaque on servers not supporting the RENDER EXTENSION.
		1577
		1578	Please note that due to bugs in Xft, specifying alpha values might result
		1579	in garbage being displayed when the X-server does not support the RENDER
		1580	extension.
		1581
		1582	=head1 ENVIRONMENT
		1583
		1584	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1585
909	=over 4	1586	=over 4
910		1587
911	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1588	=item B<TERM>
912		1589
913	would yield White on Black, while on I<xterm>(1) it would yield Black	1590	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
914	on White.	1591	resources or on the command line.
		1592
		1593	=item B<COLORTERM>
		1594
		1595	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1596	compiled with background image support, and optionally with the added
		1597	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1598	screen.
		1599
		1600	=item B<COLORFGBG>
		1601
		1602	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1603	the colour code used as default foreground/text colour (or the string
		1604	C<default> to indicate that the default-colour escape sequence is to be
		1605	used), C<bg> is the colour code used as default background colour (or the
		1606	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1607	was compiled with background image support. Libraries like C<ncurses>
		1608	and C<slang> can (and do) use this information to optimize screen output.
		1609
		1610	=item B<WINDOWID>
		1611
		1612	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1613	window, which usually has subwindows for the scrollbar, the terminal
		1614	window and so on).
		1615
		1616	=item B<TERMINFO>
		1617
		1618	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1619	C<--with-terminfo=PATH>.
		1620
		1621	=item B<DISPLAY>
		1622
		1623	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1624	display in its child processes if C<-display> isn't used to override. It
		1625	defaults to C<:0> if it doesn't exist.
		1626
		1627	=item B<SHELL>
		1628
		1629	The shell to be used for command execution, defaults to C</bin/sh>.
		1630
		1631	=item B<RXVT_SOCKET>
		1632
		1633	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1634	@@RXVT_NAME@@d(1).
		1635
		1636	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
		1637
		1638	=item B<HOME>
		1639
		1640	Used to locate the default directory for the unix domain socket for
		1641	daemon communications and to locate various resource files (such as
		1642	C<.Xdefaults>)
		1643
		1644	=item B<XAPPLRESDIR>
		1645
		1646	Directory where application-specific X resource files are located.
		1647
		1648	=item B<XENVIRONMENT>
		1649
		1650	If set and accessible, gives the name of a X resource file to be loaded by
		1651	@@RXVT_NAME@@.
915		1652
916	=back	1653	=back
917		1654
918	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1655	=head1 FILES
919		1656
920	=over 4	1657	=over 4
921		1658
922	=item How do I know which rxvt-unicode version I'm using?	1659	=item B</usr/lib/X11/rgb.txt>
923		1660
924	The version number is displayed with the usage (-h). For rxvt-unicode	1661	Colour names.
925	version 2.14 and later, the escape sequence C<ESC[8n> sets the window
926	title to the version number.
927
928	=item Rxvt-unicode does not seem to understand the selected encoding?
929
930	=item Unicode does not seem to work?
931
932	If you encounter strange problems like typing an accented character but
933	getting two unrelated other characters or similar, or if program output is
934	subtly garbled, then you should check your locale settings.
935
936	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
937	programs. Often rxvt-unicode is started in the C<C> locale, while the
938	login script running within the rxvt-unicode window changes the locale to
939	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
940
941	The best thing is to fix your startup environment, as you will likely run
942	into other problems. If nothing works you can try this in your .profile.
943
944	printf '\e]701;%s\007' "$LC_CTYPE"
945
946	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
947	supported on your systems. Some systems have a C<locale> comamnd which
948	displays this. If it displays sth. like:
949
950	locale: Cannot set LC_CTYPE to default locale: ...
951
952	Then the locale you specified is not supported on your system.
953
954	If nothing works and you are sure that everything is set correctly then
955	you will need to remember a little known fact: Some programs just don't
956	support locales :(
957
958	=item Why do the characters look ugly?
959
960	=item How does rxvt-unicode choose fonts?
961
962	Most fonts do not contain the full range of Unicode, which is
963	fine. Chances are that the font you (or the admin/package maintainer of
964	your system/os) have specified does not cover all the characters you want
965	to display.
966
967	B<rxvt-unicode> makes a best-effort try at finding a replacement
968	font. Often the result is fine, but sometimes the chosen font looks
969	bad. In that case, select a font of your taste and add it to the font
970	list, e.g.:
971
972	@@RXVT_NAME@@ -fn basefont,font2,font3...
973
974	When rxvt-unicode sees a character, it will first look at the base
975	font. If the base font does not contain the character, it will go to the
976	next font, and so on.
977
978	The only limitation is that all the fonts must not be larger than the base
979	font, as the base font defines the principial cell size, which must be the
980	same due to the way terminals work.
981
982	=item Why do some chinese characters look so different than others?
983
984	This is because there is a difference between script and language --
985	rxvt-unicode does not know which language the text that is output
986	is, as it only knows the unicode character codes. If rxvt-unicode
987	first sees a japanese character, it might choose a japanese font for
988	it. Subseqzuent japanese characters will take that font. Now, many chinese
989	characters aren't represented in japanese fonts, so when the first
990	non-japanese character comes up, rxvt-unicode will look for a chinese font
991	-- unfortunately at this point, it will still use the japanese font for
992	japanese characters that are also chinese.
993
994	The workaround is easy: just tag a chinese font at the end of your font
995	list (see the previous question). The key is to view the font list as
996	a preference list: If you expect more japanese, list a japanese font
997	first. If you expect more chinese, put a chinese font first.
998
999	In the future it might be possible to switch preferences at runtime (the
1000	internal data structure has no problem with using different fonts for
1001	the same character at the same time, but no interface for this has been
1002	designed yet).
1003
1004	=item How does rxvt-unicode determine the encoding to use?
1005
1006	=item Is there an option to switch encodings?
1007
1008	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1009	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1010	UTF-8 or any other encodings with respect to terminal I/O.
1011
1012	The reasons is that there exists a perfectly fine mechanism for selecting
1013	the encoding, doing I/O and (most important) communicating this to all
1014	applications so everybody agrees on character properties such as width and
1015	code number. This mechanism is the I<locale>.
1016
1017	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1018	programs doing the same (that is, most) will automatically agree in the
1019	interpretation of characters.
1020
1021	Unfortunately, there is no system-independent way to select locales, nor
1022	is there a standard on how locale specifiers will look like.
1023
1024	On most systems, the content of the C<LC_CTYPE> environment variable
1025	contains an arbitrary string which corresponds to an already-installed
1026	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1027	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1028	(i.e. C<de> or C<german>) are also common.
1029
1030	Rxvt-unicode ignores all other locale categories, and except for
1031	the encoding, ignores country or language-specific settings,
1032	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1033
1034	If you want to use a specific encoding you have to make sure you start
1035	rxvt-unicode with the correct C<LC_CTYPE> category.
1036
1037	=item Can I switch locales at runtime?
1038
1039	Yes, using an escape sequence. Try sth. like this, which sets
1040	rxvt-unicode's idea of C<LC_CTYPE>.
1041
1042	printf '\e]701;%s\007' ja_JP.SJIS
1043
1044	See also the previous question.
1045
1046	Sometimes this capability is rather handy when you want to work in one
1047	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1048	example, I use this script to start C<xjdic>, which first switches to a
1049	locale supported by xjdic and back later:
1050
1051	printf '\e]701;%s\007' ja_JP.SJIS
1052	xjdic -js
1053	printf '\e]701;%s\007' de_DE.UTF-8
1054
1055	=item Can I switch the fonts at runtime?
1056
1057	Yes, using an escape sequence. Try sth. like this, which has the same
1058	effect as using the C<-fn> switch, and takes effect immediately:
1059
1060	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1061
1062	This is useful if you e.g. work primarily with japanese (and prefer a
1063	japanese font), but you have to switch to chinese temporarily, where
1064	japanese fonts would only be in your way.
1065
1066	You can think of this as a kind of manual ISO-2022 switching.
1067
1068	=item Mouse cut/paste suddenly no longer works.
1069
1070	Make sure that mouse reporting is actually turned off since killing
1071	some editors prematurely may leave the mouse in mouse report mode. I've
1072	heard that tcsh may use mouse reporting unless it otherwise specified. A
1073	quick check is to see if cut/paste works when the Alt or Shift keys are
1074	depressed. See @@RXVT_NAME@@(7)
1075
1076	=item What's with this bold/blink stuff?
1077
1078	If no bold colour is set via C<colorBD:>, bold will invert text using the
1079	standard foreground colour.
1080
1081	For the standard background colour, blinking will actually make the
1082	text blink when compiled with C<--enable-blinking>. with standard
1083	colours. Without C<--enable-blinking>, the blink attribute will be
1084	ignored.
1085
1086	On ANSI colours, bold/blink attributes are used to set high-intensity
1087	foreground/background colors.
1088
1089	color0-7 are the low-intensity colors.
1090
1091	color8-15 are the corresponding high-intensity colors.
1092
1093	=item I don't like the screen colors. How do I change them?
1094
1095	You can change the screen colors at run-time using F<~/.Xdefaults>
1096	resources (or as long-options).
1097
1098	Here are values that are supposed to resemble a VGA screen,
1099	including the murky brown that passes for low-intensity yellow:
1100
1101	Rxvt*color0: #000000
1102	Rxvt*color1: #A80000
1103	Rxvt*color2: #00A800
1104	Rxvt*color3: #A8A800
1105	Rxvt*color4: #0000A8
1106	Rxvt*color5: #A800A8
1107	Rxvt*color6: #00A8A8
1108	Rxvt*color7: #A8A8A8
1109
1110	Rxvt*color8: #000054
1111	Rxvt*color9: #FF0054
1112	Rxvt*color10: #00FF54
1113	Rxvt*color11: #FFFF54
1114	Rxvt*color12: #0000FF
1115	Rxvt*color13: #FF00FF
1116	Rxvt*color14: #00FFFF
1117	Rxvt*color15: #FFFFFF
1118
1119	=item What's with the strange Backspace/Delete key behaviour?
1120
1121	Assuming that the physical Backspace key corresponds to the
1122	BackSpace keysym (not likely for Linux ... see the following
1123	question) there are two standard values that can be used for
1124	Backspace: C<^H> and C<^?>.
1125
1126	Historically, either value is correct, but rxvt-unicode adopts the debian
1127	policy of using C<^?> when unsure, because it's the one only only correct
1128	choice :).
1129
1130	Rxvt-unicode tries to inherit the current stty settings and uses the value
1131	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1132	started from a terminal (say, from a menu or by remote shell), then the
1133	system value of `erase', which corresponds to CERASE in <termios.h>, will
1134	be used (which may not be the same as your stty setting).
1135
1136	For starting a new rxvt-unicode:
1137
1138	# use Backspace = ^H
1139	$ stty erase ^H
1140	$ @@RXVT_NAME@@
1141
1142	# use Backspace = ^?
1143	$ stty erase ^?
1144	$ @@RXVT_NAME@@
1145
1146	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1147
1148	For an existing rxvt-unicode:
1149
1150	# use Backspace = ^H
1151	$ stty erase ^H
1152	$ echo -n "^[[36h"
1153
1154	# use Backspace = ^?
1155	$ stty erase ^?
1156	$ echo -n "^[[36l"
1157
1158	This helps satisfy some of the Backspace discrepancies that occur, but
1159	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1160	properly reflects that.
1161
1162	The Delete key is a another casualty of the ill-defined Backspace problem.
1163	To avoid confusion between the Backspace and Delete keys, the Delete
1164	key has been assigned an escape sequence to match the vt100 for Execute
1165	(ESC[3~) and is in the supplied termcap/terminfo.
1166
1167	Some other Backspace problems:
1168
1169	some editors use termcap/terminfo,
1170	some editors (vim I'm told) expect Backspace = ^H,
1171	GNU Emacs (and Emacs-like editors) use ^H for help.
1172
1173	Perhaps someday this will all be resolved in a consistent manner.
1174
1175	=item I don't like the key-bindings. How do I change them?
1176
1177	There are some compile-time selections available via configure. Unless
1178	you have run "configure" with the C<--disable-resources> option you can
1179	use the `keysym' resource to alter the keystrings associated with keysym
1180	0xFF00 - 0xFFFF (function, cursor keys, etc).
1181
1182	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1183
1184	!# ----- special uses ------:
1185	! tn3270 login, remap function and arrow keys.
1186	tn3270*font: *clean-bold-*-*--15-*
1187
1188	! keysym - used by rxvt only
1189	! Delete - ^D
1190	tn3270*keysym.0xFFFF: \004
1191
1192	! Home - ^A
1193	tn3270*keysym.0xFF50: \001
1194	! Left - ^B
1195	tn3270*keysym.0xFF51: \002
1196	! Up - ^P
1197	tn3270*keysym.0xFF52: \020
1198	! Right - ^F
1199	tn3270*keysym.0xFF53: \006
1200	! Down - ^N
1201	tn3270*keysym.0xFF54: \016
1202	! End - ^E
1203	tn3270*keysym.0xFF57: \005
1204
1205	! F1 - F12
1206	tn3270*keysym.0xFFBE: \e1
1207	tn3270*keysym.0xFFBF: \e2
1208	tn3270*keysym.0xFFC0: \e3
1209	tn3270*keysym.0xFFC1: \e4
1210	tn3270*keysym.0xFFC2: \e5
1211	tn3270*keysym.0xFFC3: \e6
1212	tn3270*keysym.0xFFC4: \e7
1213	tn3270*keysym.0xFFC5: \e8
1214	tn3270*keysym.0xFFC6: \e9
1215	tn3270*keysym.0xFFC7: \e0
1216	tn3270*keysym.0xFFC8: \e-
1217	tn3270*keysym.0xFFC9: \e=
1218
1219	! map Prior/Next to F7/F8
1220	tn3270*keysym.0xFF55: \e7
1221	tn3270*keysym.0xFF56: \e8
1222
1223	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1224	How do I make use of them? For example, the Sun Keyboard type 4
1225	has the following mappings that rxvt-unicode doesn't recognize.
1226
1227	KP_Insert == Insert
1228	F22 == Print
1229	F27 == Home
1230	F29 == Prior
1231	F33 == End
1232	F35 == Next
1233
1234	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1235	mappings, it is better to use `xmodmap' to remap the keys as required for
1236	your particular machine.
1237
1238	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1239	I need this to decide about setting colors etc.
1240
1241	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1242	check and see if that is set. Note that several programs, JED, slrn,
1243	Midnight Commander automatically check this variable to decide whether or
1244	not to use color.
1245
1246	=item How do I set the correct, full IP address for the DISPLAY variable?
1247
1248	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1249	insecure mode then it is possible to use the following shell script
1250	snippets to correctly set the display. If your version of rxvt-unicode
1251	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1252	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1253	regular xterm.
1254
1255	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1256	snippets:
1257
1258	# Bourne/Korn/POSIX family of shells:
1259	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1260	if [ ${TERM:-foo} = xterm ]; then
1261	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1262	echo -n '^[Z'
1263	read term_id
1264	stty icanon echo
1265	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1266	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1267	read DISPLAY # set it in our local shell
1268	fi
1269	fi
1270
1271	=item How do I compile the manual pages for myself?
1272
1273	You need to have a recent version of perl installed as F</usr/bin/perl>,
1274	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1275	the doc subdirectory and enter C<make alldoc>.
1276		1662
1277	=back	1663	=back
1278		1664
1279	=head1 ENVIRONMENT	1665	=head1 SEE ALSO
1280		1666
1281	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1667	@@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)
1282	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1283	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1284	sets the environment variable B<DISPLAY> to specify which display
1285	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1286	B<RXVTPATH> and B<PATH> to find XPM files.
1287		1668
1288	=head1 FILES	1669	=head1 CURRENT PROJECT COORDINATOR
1289		1670
1290	=over 4	1671	=over 4
1291		1672
1292	=item B</etc/utmp>	1673	=item Project Coordinator
1293		1674
1294	System file for login records.	1675	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1295		1676
1296	=item B</usr/lib/X11/rgb.txt>	1677	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1297
1298	Color names.
1299		1678
1300	=back	1679	=back
1301		1680
1302	=head1 SEE ALSO	1681	=head1 AUTHORS
1303
1304	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1305
1306	=head1 BUGS
1307
1308	Check the BUGS file for an up-to-date list.
1309
1310	Cursor change support is not yet implemented.
1311
1312	Click-and-drag doesn't work with X11 mouse report overriding.
1313
1314	=head1 CURRENT PROJECT COORDINATOR
1315		1682
1316	=over 4	1683	=over 4
1317		1684
1318	=item Project Coordinator	1685	=item John Bovey
1319		1686
1320	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1687	University of Kent, 1992, wrote the original Xvt.
1321		1688
1322	=item Web page maintainter	1689	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1323		1690
1324	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1691	very heavily modified Xvt and came up with Rxvt
1325		1692
1326	L<@@RXVT_WEBPAGE@@>	1693	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
		1694
		1695	wrote the Greek Keyboard Input (no longer in code)
		1696
		1697	=item mj olesen L<< <olesen@me.QueensU.CA> >>
		1698
		1699	Wrote the menu system.
		1700
		1701	Project Coordinator (changes.txt 2.11 to 2.21)
		1702
		1703	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
		1704
		1705	Project Coordinator (changes.txt 2.21a to 2.4.5)
		1706
		1707	=item Geoff Wing L<< <gcw@pobox.com> >>
		1708
		1709	Rewrote screen display and text selection routines.
		1710
		1711	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
		1712
		1713	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
		1714
		1715	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
		1716	extension, random hacks, numerous bugfixes and extensions.
		1717
		1718	Project Coordinator (Changes 1.0 -)
		1719
		1720	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1721
		1722	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1327		1723
1328	=back	1724	=back
1329		1725
1330	=head1 AUTHORS
1331
1332	=over 4
1333
1334	=item John Bovey
1335
1336	University of Kent, 1992, wrote the original Xvt.
1337
1338	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1339
1340	very heavily modified Xvt and came up with Rxvt
1341
1342	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
1343
1344	wrote the Greek Keyboard Input (no longer in code)
1345
1346	=item mj olesen L<< <olesen@me.QueensU.CA> >>
1347
1348	Wrote the menu system.
1349
1350	Project Coordinator (changes.txt 2.11 to 2.21)
1351
1352	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
1353
1354	Project Coordinator (changes.txt 2.21a to 2.4.5)
1355
1356	=item Geoff Wing L<< <gcw@pobox.com> >>
1357
1358	Rewrote screen display and text selection routines. Project Coordinator
1359	(changes.txt 2.4.6 - rxvt-unicode)
1360
1361	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>
1362
1363	Forked rxvt-unicode, rewrote most of the display code and internal
1364	character handling to store text in unicode, improve xterm
1365	compatibility and apply numerous other bugfixes and extensions.
1366
1367	Project Coordinator (Changes 1.0 -)
1368
1369	=back
1370

Diff Legend

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