ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.47 by root, Mon Feb 14 10:48:44 2005 UTC vs.
Revision 1.157 by ayin, Mon Dec 10 19:08:01 2007 UTC

…		…
16	=head1 DESCRIPTION	16	=head1 DESCRIPTION
17		17
18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting	18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19	all escape sequences, and other background information.	19	all escape sequences, and other background information.
20		20
21	The newest version of this document is	21	The newest version of this document is also available on the World Wide Web at
22	also available on the World Wide Web at
23	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.	22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
24		23
25	=head1 FREQUENTLY ASKED QUESTIONS	24	=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26		25
27	=over 4
28		26
		27	=head2 Meta, Features & Commandline Issues
		28
		29	=head3 My question isn't answered here, can I ask a human?
		30
		31	Before sending me mail, you could go to IRC: C<irc.freenode.net>,
		32	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
		33	interested in learning about new and exciting problems (but not FAQs :).
		34
		35	=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
		36
		37	Beginning with version 7.3, there is a perl extension that implements a
		38	simple tabbed terminal. It is installed by default, so any of these should
		39	give you tabs:
		40
		41	@@URXVT_NAME@@ -pe tabbed
		42
		43	URxvt.perl-ext-common: default,tabbed
		44
		45	It will also work fine with tabbing functionality of many window managers
		46	or similar tabbing programs, and its embedding-features allow it to be
		47	embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
		48	the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
		49	(murxvt) terminal as an example embedding application.
		50
29	=item How do I know which rxvt-unicode version I'm using?	51	=head3 How do I know which rxvt-unicode version I'm using?
30		52
31	The version number is displayed with the usage (-h). Also the escape	53	The version number is displayed with the usage (-h). Also the escape
32	sequence C<ESC [ 8 n> sets the window title to the version number.	54	sequence C<ESC [ 8 n> sets the window title to the version number. When
		55	using the @@URXVT_NAME@@c client, the version displayed is that of the
		56	daemon.
33		57
34	=item I am using Debian GNU/Linux and have a problem...
35
36	The Debian GNU/Linux package of rxvt-unicode contains large patches that
37	considerably change the behaviour of rxvt-unicode. Before reporting a
38	bug to the original rxvt-unicode author please download and install the
39	genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
40	reproduce the problem. If you cannot, chances are that the problems are
41	specific to Debian GNU/Linux, in which case it should be reported via the
42	Debian Bug Tracking System (use C<reportbug> to report the bug).
43
44	For other problems that also affect the Debian package, you can and
45	probably should use the Debian BTS, too, because, after all, it's also a
46	bug in the Debian version and it serves as a reminder for other users that
47	might encounter the same issue.
48
49	=item When I log-in to another system it tells me about missing terminfo data?
50
51	The terminal description used by rxvt-unicode is not as widely available
52	as that for xterm, or even rxvt (for which the same problem often arises).
53
54	The correct solution for this problem is to install the terminfo, this can
55	be done like this (with ncurses' infocmp):
56
57	REMOTE=remotesystem.domain
58	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
59
60	... or by installing rxvt-unicode normally on the remote system,
61
62	If you cannot or do not want to do this, then you can simply set
63	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
64	problems arising, which includes wrong keymapping, less and different
65	colours and some refresh errors in fullscreen applications. It's a nice
66	quick-and-dirty workaround for rare cases, though.
67
68	If you always want to do this (and are fine with the consequences) you
69	can either recompile rxvt-unicode with the desired TERM value or use a
70	resource to set it:
71
72	URxvt.termName: rxvt
73
74	If you don't plan to use B<rxvt> (quite common...) you could also replace
75	the rxvt terminfo file with the rxvt-unicode one.
76
77	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78
79	=item I need a termcap file entry.
80
81	One reason you might want this is that some distributions or operating
82	systems still compile some programs using the long-obsoleted termcap
83	library (Fedora Core's bash is one example) and rely on a termcap entry
84	for C<rxvt-unicode>.
85
86	You could use rxvt's termcap entry with resonable results in many cases.
87	You can also create a termcap entry by using terminfo's infocmp program
88	like this:
89
90	infocmp -C rxvt-unicode
91
92	Or you could use this termcap entry, generated by the command above:
93
94	rxvt-unicode|rxvt-unicode terminal (X Window System):\
95	:am:bw:eo:km:mi:ms:xn:xo:\
96	:co#80:it#8:li#24:lm#0:\
97	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
100	:as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
101	:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
102	:ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
103	:im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
109	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
110	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
111	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
112	:vs=\E[?25h:
113
114	=item Why does C<ls> no longer have coloured output?
115
116	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
117	decide wether a terminal has colour, but uses it's own configuration
118	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
119	with most other terminals supporting colour). Either add:
120
121	TERM rxvt-unicode
122
123	to C</etc/DIR_COLORS> or simply add:
124
125	alias ls='ls --color=auto'
126
127	to your C<.profile> or C<.bashrc>.
128
129	=item Why doesn't vim/emacs etc. use the 88 colour mode?
130
131	=item Why doesn't vim/emacs etc. make use of italic?
132
133	=item Why are the secondary screen-related options not working properly?
134
135	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
136	distributions (most notably Debian GNU/Linux) break rxvt-unicode
137	by setting C<TERM> to C<rxvt>, which doesn't have these extra
138	features. Unfortunately, some of these (most notably, again, Debian
139	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
140	file, so you will need to install it on your own (See the question B<When
141	I log-in to another system it tells me about missing terminfo data?> on
142	how to do this).
143
144	=item My numerical keypad acts weird and generates differing output?
145
146	Some Debian GNUL/Linux users seem to have this problem, although no
147	specific details were reported so far. It is possible that this is caused
148	by the wrong C<TERM> setting, although the details of wether and how
149	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
150	keymap. See the answer to the previous question, and please report if that
151	helped.
152
153	=item Rxvt-unicode does not seem to understand the selected encoding?
154
155	=item Unicode does not seem to work?
156
157	If you encounter strange problems like typing an accented character but
158	getting two unrelated other characters or similar, or if program output is
159	subtly garbled, then you should check your locale settings.
160
161	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
162	programs. Often rxvt-unicode is started in the C<C> locale, while the
163	login script running within the rxvt-unicode window changes the locale to
164	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
165
166	The best thing is to fix your startup environment, as you will likely run
167	into other problems. If nothing works you can try this in your .profile.
168
169	printf '\e]701;%s\007' "$LC_CTYPE"
170
171	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
172	supported on your systems. Some systems have a C<locale> command which
173	displays this (also, C<perl -e0> can be used to check locale settings, as
174	it will complain loudly if it cannot set the locale). If it displays something
175	like:
176
177	locale: Cannot set LC_CTYPE to default locale: ...
178
179	Then the locale you specified is not supported on your system.
180
181	If nothing works and you are sure that everything is set correctly then
182	you will need to remember a little known fact: Some programs just don't
183	support locales :(
184
185	=item Why do some characters look so much different than others?
186
187	=item How does rxvt-unicode choose fonts?
188
189	Most fonts do not contain the full range of Unicode, which is
190	fine. Chances are that the font you (or the admin/package maintainer of
191	your system/os) have specified does not cover all the characters you want
192	to display.
193
194	B<rxvt-unicode> makes a best-effort try at finding a replacement
195	font. Often the result is fine, but sometimes the chosen font looks
196	bad/ugly/wrong. Some fonts have totally strange characters that don't
197	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
198	intelligence to detect that a specific glyph is wrong: it has to believe
199	the font that the characters it claims to contain indeed look correct.
200
201	In that case, select a font of your taste and add it to the font list,
202	e.g.:
203
204	@@RXVT_NAME@@ -fn basefont,font2,font3...
205
206	When rxvt-unicode sees a character, it will first look at the base
207	font. If the base font does not contain the character, it will go to the
208	next font, and so on. Specifying your own fonts will also speed up this
209	search and use less resources within rxvt-unicode and the X-server.
210
211	The only limitation is that none of the fonts may be larger than the base
212	font, as the base font defines the terminal character cell size, which
213	must be the same due to the way terminals work.
214
215	=item Why do some chinese characters look so different than others?
216
217	This is because there is a difference between script and language --
218	rxvt-unicode does not know which language the text that is output is,
219	as it only knows the unicode character codes. If rxvt-unicode first
220	sees a japanese/chinese character, it might choose a japanese font for
221	display. Subsequent japanese characters will use that font. Now, many
222	chinese characters aren't represented in japanese fonts, so when the first
223	non-japanese character comes up, rxvt-unicode will look for a chinese font
224	-- unfortunately at this point, it will still use the japanese font for
225	chinese characters that are also in the japanese font.
226
227	The workaround is easy: just tag a chinese font at the end of your font
228	list (see the previous question). The key is to view the font list as
229	a preference list: If you expect more japanese, list a japanese font
230	first. If you expect more chinese, put a chinese font first.
231
232	In the future it might be possible to switch language preferences at
233	runtime (the internal data structure has no problem with using different
234	fonts for the same character at the same time, but no interface for this
235	has been designed yet).
236
237	Until then, you might get away with switching fonts at runtime (see L<Can
238	I switch the fonts at runtime?> later in this document).
239
240	=item Why does rxvt-unicode sometimes leave pixel droppings?
241
242	Most fonts were not designed for terminal use, which means that character
243	size varies a lot. A font that is otherwise fine for terminal use might
244	contain some characters that are simply too wide. Rxvt-unicode will avoid
245	these characters. For characters that are just "a bit" too wide a special
246	"careful" rendering mode is used that redraws adjacent characters.
247
248	All of this requires that fonts do not lie about character sizes,
249	however: Xft fonts often draw glyphs larger than their acclaimed bounding
250	box, and rxvt-unicode has no way of detecting this (the correct way is to
251	ask for the character bounding box, which unfortunately is wrong in these
252	cases).
253
254	It's not clear (to me at least), wether this is a bug in Xft, freetype,
255	or the respective font. If you encounter this problem you might try using
256	the C<-lsp> option to give the font more height. If that doesn't work, you
257	might be forced to use a different font.
258
259	All of this is not a problem when using X11 core fonts, as their bounding
260	box data is correct.
261
262	=item My Compose (Multi_key) key is no longer working.
263
264	The most common causes for this are that either your locale is not set
265	correctly, or you specified a B<preeditStyle> that is not supported by
266	your input method. For example, if you specified B<OverTheSpot> and
267	your input method (e.g. the default input method handling Compose keys)
268	does not support this (for instance because it is not visual), then
269	rxvt-unicode will continue without an input method.
270
271	In this case either do not specify a B<preeditStyle> or specify more than
272	one pre-edit style, such as B<OverTheSpot,Root,None>.
273
274	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
275
276	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
277	international keyboards) or simply use ISO 14755 support to your
278	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
279	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
280	character and so on.
281
282	=item How can I keep rxvt-unicode from using reverse video so much?
283
284	First of all, make sure you are running with the right terminal settings
285	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
286	make sure you have specified colours for italic and bold, as otherwise
287	rxvt-unicode might use reverse video to simulate the effect:
288
289	URxvt.colorBD: white
290	URxvt.colorIT: green
291
292	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
293
294	For some unexplainable reason, some rare programs assume a very weird
295	colour palette when confronted with a terminal with more than the standard
296	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
297	these programs not to assume non-ISO colours without very good reasons.
298
299	In the meantime, you can either edit your C<rxvt-unicode> terminfo
300	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
301	fix colours but keep you from using other rxvt-unicode features.
302
303	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
304
305	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
306	in your compile environment, or an implementation that implements it,
307	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
308	B<wchar_t> is represented as unicode.
309
310	As you might have guessed, FreeBSD does neither define this symobl nor
311	does it support it. Instead, it uses it's own internal representation of
312	B<wchar_t>. This is, of course, completely fine with respect to standards.
313
314	However, C<__STDC_ISO_10646__> is the only sane way to support
315	multi-language apps in an OS, as using a locale-dependent (and
316	non-standardized) representation of B<wchar_t> makes it impossible to
317	convert between B<wchar_t> (as used by X11 and your applications) and any
318	other encoding without implementing OS-specific-wrappers for each and
319	every locale. There simply are no APIs to convert B<wchar_t> into anything
320	except the current locale encoding.
321
322	Some applications (such as the formidable B<mlterm>) work around this
323	by carrying their own replacement functions for character set handling
324	with them, and either implementing OS-dependent hacks or doing multiple
325	conversions (which is slow and unreliable in case the OS implements
326	encodings slightly different than the terminal emulator).
327
328	The rxvt-unicode author insists that the right way to fix this is in the
329	system libraries once and for all, instead of forcing every app to carry
330	complete replacements for them :)
331
332	=item How does rxvt-unicode determine the encoding to use?
333
334	=item Is there an option to switch encodings?
335
336	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
337	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
338	UTF-8 or any other encodings with respect to terminal I/O.
339
340	The reasons is that there exists a perfectly fine mechanism for selecting
341	the encoding, doing I/O and (most important) communicating this to all
342	applications so everybody agrees on character properties such as width
343	and code number. This mechanism is the I<locale>. Applications not using
344	that info will have problems (for example, C<xterm> gets the width of
345	characters wrong as it uses it's own, locale-independent table under all
346	locales).
347
348	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
349	programs doing the same (that is, most) will automatically agree in the
350	interpretation of characters.
351
352	Unfortunately, there is no system-independent way to select locales, nor
353	is there a standard on how locale specifiers will look like.
354
355	On most systems, the content of the C<LC_CTYPE> environment variable
356	contains an arbitrary string which corresponds to an already-installed
357	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
358	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
359	(i.e. C<de> or C<german>) are also common.
360
361	Rxvt-unicode ignores all other locale categories, and except for
362	the encoding, ignores country or language-specific settings,
363	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
364	rxvt-unicode.
365
366	If you want to use a specific encoding you have to make sure you start
367	rxvt-unicode with the correct C<LC_CTYPE> category.
368
369	=item Can I switch locales at runtime?
370
371	Yes, using an escape sequence. Try something like this, which sets
372	rxvt-unicode's idea of C<LC_CTYPE>.
373
374	printf '\e]701;%s\007' ja_JP.SJIS
375
376	See also the previous answer.
377
378	Sometimes this capability is rather handy when you want to work in
379	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
380	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
381	first switches to a locale supported by xjdic and back later:
382
383	printf '\e]701;%s\007' ja_JP.SJIS
384	xjdic -js
385	printf '\e]701;%s\007' de_DE.UTF-8
386
387	You can also use xterm's C<luit> program, which usually works fine, except
388	for some locales where character width differs between program- and
389	rxvt-unicode-locales.
390
391	=item Can I switch the fonts at runtime?
392
393	Yes, using an escape sequence. Try something like this, which has the same
394	effect as using the C<-fn> switch, and takes effect immediately:
395
396	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
397
398	This is useful if you e.g. work primarily with japanese (and prefer a
399	japanese font), but you have to switch to chinese temporarily, where
400	japanese fonts would only be in your way.
401
402	You can think of this as a kind of manual ISO-2022 switching.
403
404	=item Why do italic characters look as if clipped?
405
406	Many fonts have difficulties with italic characters and hinting. For
407	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
408	Mono> completely fails in it's italic face. A workaround might be to
409	enable freetype autohinting, i.e. like this:
410
411	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
412	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
413
414	=item My input method wants <some encoding> but I want UTF-8, what can I do?
415
416	You can specify separate locales for the input method and the rest of the
417	terminal, using the resource C<imlocale>:
418
419	URxvt*imlocale: ja_JP.EUC-JP
420
421	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
422	use your input method. Please note, however, that you will not be able to
423	input characters outside C<EUC-JP> in a normal way then, as your input
424	method limits you.
425
426	=item Rxvt-unicode crashes when the X Input Method changes or exits.
427
428	Unfortunately, this is unavoidable, as the XIM protocol is racy by
429	design. Applications can avoid some crashes at the expense of memory
430	leaks, and Input Methods can avoid some crashes by careful ordering at
431	exit time. B<kinput2> (and derived input methods) generally succeeds,
432	while B<SCIM> (or similar input methods) fails. In the end, however,
433	crashes cannot be completely avoided even if both sides cooperate.
434
435	So the only workaround is not to kill your Input Method Servers.
436
437	=item Rxvt-unicode uses gobs of memory, how can I reduce that?	58	=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
438		59
439	Rxvt-unicode tries to obey the rule of not charging you for something you	60	Rxvt-unicode tries to obey the rule of not charging you for something you
440	don't use. One thing you should try is to configure out all settings that	61	don't use. One thing you should try is to configure out all settings that
441	you don't need, for example, Xft support is a resource hog by design,	62	you don't need, for example, Xft support is a resource hog by design,
442	when used. Compiling it out ensures that no Xft font will be loaded	63	when used. Compiling it out ensures that no Xft font will be loaded
…		…
447	6 bytes per screen cell. For a 160x?? window this amounts to almost a	68	6 bytes per screen cell. For a 160x?? window this amounts to almost a
448	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)	69	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
449	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as	70	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
450	rxvt-unicode then uses 8 bytes per screen cell.	71	rxvt-unicode then uses 8 bytes per screen cell.
451		72
		73	=head3 How can I start @@URXVT_NAME@@d in a race-free way?
		74
		75	Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
		76	display, create the listening socket and then fork.
		77
		78	=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
		79
		80	If you want to start @@URXVT_NAME@@d automatically whenever you run
		81	@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
		82
		83	#!/bin/sh
		84	@@URXVT_NAME@@c "$@"
		85	if [ $? -eq 2 ]; then
		86	@@URXVT_NAME@@d -q -o -f
		87	@@URXVT_NAME@@c "$@"
		88	fi
		89
		90	This tries to create a new terminal, and if fails with exit status 2,
		91	meaning it couldn't connect to the daemon, it will start the daemon and
		92	re-run the command. Subsequent invocations of the script will re-use the
		93	existing daemon.
		94
		95	=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
		96
		97	The original rxvt and rxvt-unicode always export the variable "COLORTERM",
		98	so you can check and see if that is set. Note that several programs, JED,
		99	slrn, Midnight Commander automatically check this variable to decide
		100	whether or not to use color.
		101
		102	=head3 How do I set the correct, full IP address for the DISPLAY variable?
		103
		104	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
		105	insecure mode then it is possible to use the following shell script
		106	snippets to correctly set the display. If your version of rxvt-unicode
		107	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
		108	the COLORTERM variable can be used to distinguish rxvt-unicode from a
		109	regular xterm.
		110
		111	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
		112	snippets:
		113
		114	# Bourne/Korn/POSIX family of shells:
		115	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
		116	if [ ${TERM:-foo} = xterm ]; then
		117	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
		118	echo -n '^[Z'
		119	read term_id
		120	stty icanon echo
		121	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
		122	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
		123	read DISPLAY # set it in our local shell
		124	fi
		125	fi
		126
		127	=head3 How do I compile the manual pages on my own?
		128
		129	You need to have a recent version of perl installed as F</usr/bin/perl>,
		130	one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
		131	F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
		132
		133	=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
		134
		135	I often get asked about this, and I think, no, they didn't cause extra
		136	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		137	that the urxvt binary is larger (due to some encoding tables always being
		138	compiled in), but it actually uses less memory (RSS) after startup. Even
		139	with C<--disable-everything>, this comparison is a bit unfair, as many
		140	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		141	already in use in this mode.
		142
		143	text data bss drs rss filename
		144	98398 1664 24 15695 1824 rxvt --disable-everything
		145	188985 9048 66616 18222 1788 urxvt --disable-everything
		146
		147	When you C<--enable-everything> (which I<is> unfair, as this involves xft
		148	and full locale/XIM support which are quite bloaty inside libX11 and my
		149	libc), the two diverge, but not unreasonably so.
		150
		151	text data bss drs rss filename
		152	163431 2152 24 20123 2060 rxvt --enable-everything
		153	1035683 49680 66648 29096 3680 urxvt --enable-everything
		154
		155	The very large size of the text section is explained by the east-asian
		156	encoding tables, which, if unused, take up disk space but nothing else
		157	and can be compiled out unless you rely on X11 core fonts that use those
		158	encodings. The BSS size comes from the 64k emergency buffer that my c++
		159	compiler allocates (but of course doesn't use unless you are out of
		160	memory). Also, using an xft font instead of a core font immediately adds a
		161	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		162	not used.
		163
		164	Of course, due to every character using two or four bytes instead of one,
		165	a large scrollback buffer will ultimately make rxvt-unicode use more
		166	memory.
		167
		168	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		169	still fares rather well. And compared to some monsters like gnome-terminal
		170	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		171	43180k in daemons that stay around after exit, plus half a minute of
		172	startup time, including the hundreds of warnings it spits out), it fares
		173	extremely well *g*.
		174
		175	=head3 Why C++, isn't that unportable/bloated/uncool?
		176
		177	Is this a question? :) It comes up very often. The simple answer is: I had
		178	to write it, and C++ allowed me to write and maintain it in a fraction
		179	of the time and effort (which is a scarce resource for me). Put even
		180	shorter: It simply wouldn't exist without C++.
		181
		182	My personal stance on this is that C++ is less portable than C, but in
		183	the case of rxvt-unicode this hardly matters, as its portability limits
		184	are defined by things like X11, pseudo terminals, locale support and unix
		185	domain sockets, which are all less portable than C++ itself.
		186
		187	Regarding the bloat, see the above question: It's easy to write programs
		188	in C that use gobs of memory, an certainly possible to write programs in
		189	C++ that don't. C++ also often comes with large libraries, but this is
		190	not necessarily the case with GCC. Here is what rxvt links against on my
		191	system with a minimal config:
		192
		193	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		194	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		195	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		196	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		197
		198	And here is rxvt-unicode:
		199
		200	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		201	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		202	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		203	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		204	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		205
		206	No large bloated libraries (of course, none were linked in statically),
		207	except maybe libX11 :)
		208
		209
		210	=head2 Rendering, Font & Look and Feel Issues
		211
		212	=head3 I can't get transparency working, what am I doing wrong?
		213
		214	First of all, please address all transparency related issues to Sasha Vasko at
		215	sasha@aftercode.net and do not bug the author about it. Also, if you can't
		216	get it working consider it a rite of passage: ... and you failed.
		217
		218	Here are four ways to get transparency. B<Do> read the manpage and option
		219	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		220
		221	1. Use transparent mode:
		222
		223	Esetroot wallpaper.jpg
		224	@@URXVT_NAME@@ -tr -tint red -sh 40
		225
		226	That works. If you think it doesn't, you lack transparency and tinting
		227	support, or you are unable to read.
		228
		229	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		230	to use effects other than tinting and shading: Just shade/tint/whatever
		231	your picture with gimp or any other tool:
		232
		233	convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
		234	@@URXVT_NAME@@ -pixmap "background.jpg;:root"
		235
		236	That works. If you think it doesn't, you lack AfterImage support, or you
		237	are unable to read.
		238
		239	3. Use an ARGB visual:
		240
		241	@@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		242
		243	This requires XFT support, and the support of your X-server. If that
		244	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		245	there yet, no matter what they claim. Rxvt-Unicode contains the necessary
		246	bugfixes and workarounds for Xft and Xlib to make it work, but that
		247	doesn't mean that your WM has the required kludges in place.
		248
		249	4. Use xcompmgr and let it do the job:
		250
		251	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		252	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		253
		254	Then click on a window you want to make transparent. Replace C<0xc0000000>
		255	by other values to change the degree of opacity. If it doesn't work and
		256	your server crashes, you got to keep the pieces.
		257
		258	=head3 Why does rxvt-unicode sometimes leave pixel droppings?
		259
		260	Most fonts were not designed for terminal use, which means that character
		261	size varies a lot. A font that is otherwise fine for terminal use might
		262	contain some characters that are simply too wide. Rxvt-unicode will avoid
		263	these characters. For characters that are just "a bit" too wide a special
		264	"careful" rendering mode is used that redraws adjacent characters.
		265
		266	All of this requires that fonts do not lie about character sizes,
		267	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		268	box, and rxvt-unicode has no way of detecting this (the correct way is to
		269	ask for the character bounding box, which unfortunately is wrong in these
		270	cases).
		271
		272	It's not clear (to me at least), whether this is a bug in Xft, freetype,
		273	or the respective font. If you encounter this problem you might try using
		274	the C<-lsp> option to give the font more height. If that doesn't work, you
		275	might be forced to use a different font.
		276
		277	All of this is not a problem when using X11 core fonts, as their bounding
		278	box data is correct.
		279
		280	=head3 How can I keep rxvt-unicode from using reverse video so much?
		281
		282	First of all, make sure you are running with the right terminal settings
		283	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		284	make sure you have specified colours for italic and bold, as otherwise
		285	rxvt-unicode might use reverse video to simulate the effect:
		286
		287	URxvt.colorBD: white
		288	URxvt.colorIT: green
		289
		290	=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
		291
		292	For some unexplainable reason, some rare programs assume a very weird
		293	colour palette when confronted with a terminal with more than the standard
		294	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		295	these programs not to assume non-ISO colours without very good reasons.
		296
		297	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		298	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		299	fix colours but keep you from using other rxvt-unicode features.
		300
		301	=head3 Can I switch the fonts at runtime?
		302
		303	Yes, using an escape sequence. Try something like this, which has the same
		304	effect as using the C<-fn> switch, and takes effect immediately:
		305
		306	printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
		307
		308	This is useful if you e.g. work primarily with japanese (and prefer a
		309	japanese font), but you have to switch to chinese temporarily, where
		310	japanese fonts would only be in your way.
		311
		312	You can think of this as a kind of manual ISO-2022 switching.
		313
		314	=head3 Why do italic characters look as if clipped?
		315
		316	Many fonts have difficulties with italic characters and hinting. For
		317	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		318	Mono> completely fails in its italic face. A workaround might be to
		319	enable freetype autohinting, i.e. like this:
		320
		321	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		322	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		323
452	=item Can I speed up Xft rendering somehow?	324	=head3 Can I speed up Xft rendering somehow?
453		325
454	Yes, the most obvious way to speed it up is to avoid Xft entirely, as	326	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455	it is simply slow. If you still want Xft fonts you might try to disable	327	it is simply slow. If you still want Xft fonts you might try to disable
456	antialiasing (by appending C<:antialiasing=false>), which saves lots of	328	antialiasing (by appending C<:antialias=false>), which saves lots of
457	memory and also speeds up rendering considerably.	329	memory and also speeds up rendering considerably.
458		330
459	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?	331	=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460		332
461	Rxvt-unicode will use whatever you specify as a font. If it needs to	333	Rxvt-unicode will use whatever you specify as a font. If it needs to
462	fall back to it's default font search list it will prefer X11 core	334	fall back to its default font search list it will prefer X11 core
463	fonts, because they are small and fast, and then use Xft fonts. It has	335	fonts, because they are small and fast, and then use Xft fonts. It has
464	antialiasing disabled for most of them, because the author thinks they	336	antialiasing disabled for most of them, because the author thinks they
465	look best that way.	337	look best that way.
466		338
467	If you want antialiasing, you have to specify the fonts manually.	339	If you want antialiasing, you have to specify the fonts manually.
468		340
469	=item Mouse cut/paste suddenly no longer works.
470
471	Make sure that mouse reporting is actually turned off since killing
472	some editors prematurely may leave the mouse in mouse report mode. I've
473	heard that tcsh may use mouse reporting unless it otherwise specified. A
474	quick check is to see if cut/paste works when the Alt or Shift keys are
475	depressed. See @@RXVT_NAME@@(7)
476
477	=item What's with this bold/blink stuff?	341	=head3 What's with this bold/blink stuff?
478		342
479	If no bold colour is set via C<colorBD:>, bold will invert text using the	343	If no bold colour is set via C<colorBD:>, bold will invert text using the
480	standard foreground colour.	344	standard foreground colour.
481		345
482	For the standard background colour, blinking will actually make the	346	For the standard background colour, blinking will actually make
483	text blink when compiled with C<--enable-blinking>. with standard	347	the text blink when compiled with C<--enable-text-blink>. Without
484	colours. Without C<--enable-blinking>, the blink attribute will be	348	C<--enable-text-blink>, the blink attribute will be ignored.
485	ignored.
486		349
487	On ANSI colours, bold/blink attributes are used to set high-intensity	350	On ANSI colours, bold/blink attributes are used to set high-intensity
488	foreground/background colors.	351	foreground/background colors.
489		352
490	color0-7 are the low-intensity colors.	353	color0-7 are the low-intensity colors.
491		354
492	color8-15 are the corresponding high-intensity colors.	355	color8-15 are the corresponding high-intensity colors.
493		356
494	=item I don't like the screen colors. How do I change them?	357	=head3 I don't like the screen colors. How do I change them?
495		358
496	You can change the screen colors at run-time using F<~/.Xdefaults>	359	You can change the screen colors at run-time using F<~/.Xdefaults>
497	resources (or as long-options).	360	resources (or as long-options).
498		361
499	Here are values that are supposed to resemble a VGA screen,	362	Here are values that are supposed to resemble a VGA screen,
…		…
515	URxvt.color12: #0000FF	378	URxvt.color12: #0000FF
516	URxvt.color13: #FF00FF	379	URxvt.color13: #FF00FF
517	URxvt.color14: #00FFFF	380	URxvt.color14: #00FFFF
518	URxvt.color15: #FFFFFF	381	URxvt.color15: #FFFFFF
519		382
520	And here is a more complete set of non-standard colors described (not by	383	And here is a more complete set of non-standard colors.
521	me) as "pretty girly".
522		384
523	URxvt.cursorColor: #dc74d1	385	URxvt.cursorColor: #dc74d1
524	URxvt.pointerColor: #dc74d1	386	URxvt.pointerColor: #dc74d1
525	URxvt.background: #0e0e0e	387	URxvt.background: #0e0e0e
526	URxvt.foreground: #4ad5e1	388	URxvt.foreground: #4ad5e1
…		…
537	URxvt.color6: #73f7ff	399	URxvt.color6: #73f7ff
538	URxvt.color14: #73f7ff	400	URxvt.color14: #73f7ff
539	URxvt.color7: #e1dddd	401	URxvt.color7: #e1dddd
540	URxvt.color15: #e1dddd	402	URxvt.color15: #e1dddd
541		403
542	=item How can I start @@RXVT_NAME@@d in a race-free way?	404	They have been described (not by me) as "pretty girly".
543		405
544	Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a	406	=head3 Why do some characters look so much different than others?
545	server that answers @@RXVT_NAME@@c's requests, so it doesn't background
546	itself.
547		407
548	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the	408	See next entry.
549	following method to wait for the startup message before continuing:
550		409
551	{ @@RXVT_NAME@@d & } | read	410	=head3 How does rxvt-unicode choose fonts?
552		411
		412	Most fonts do not contain the full range of Unicode, which is
		413	fine. Chances are that the font you (or the admin/package maintainer of
		414	your system/os) have specified does not cover all the characters you want
		415	to display.
		416
		417	B<rxvt-unicode> makes a best-effort try at finding a replacement
		418	font. Often the result is fine, but sometimes the chosen font looks
		419	bad/ugly/wrong. Some fonts have totally strange characters that don't
		420	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		421	intelligence to detect that a specific glyph is wrong: it has to believe
		422	the font that the characters it claims to contain indeed look correct.
		423
		424	In that case, select a font of your taste and add it to the font list,
		425	e.g.:
		426
		427	@@URXVT_NAME@@ -fn basefont,font2,font3...
		428
		429	When rxvt-unicode sees a character, it will first look at the base
		430	font. If the base font does not contain the character, it will go to the
		431	next font, and so on. Specifying your own fonts will also speed up this
		432	search and use less resources within rxvt-unicode and the X-server.
		433
		434	The only limitation is that none of the fonts may be larger than the base
		435	font, as the base font defines the terminal character cell size, which
		436	must be the same due to the way terminals work.
		437
		438	=head3 Why do some chinese characters look so different than others?
		439
		440	This is because there is a difference between script and language --
		441	rxvt-unicode does not know which language the text that is output is,
		442	as it only knows the unicode character codes. If rxvt-unicode first
		443	sees a japanese/chinese character, it might choose a japanese font for
		444	display. Subsequent japanese characters will use that font. Now, many
		445	chinese characters aren't represented in japanese fonts, so when the first
		446	non-japanese character comes up, rxvt-unicode will look for a chinese font
		447	-- unfortunately at this point, it will still use the japanese font for
		448	chinese characters that are also in the japanese font.
		449
		450	The workaround is easy: just tag a chinese font at the end of your font
		451	list (see the previous question). The key is to view the font list as
		452	a preference list: If you expect more japanese, list a japanese font
		453	first. If you expect more chinese, put a chinese font first.
		454
		455	In the future it might be possible to switch language preferences at
		456	runtime (the internal data structure has no problem with using different
		457	fonts for the same character at the same time, but no interface for this
		458	has been designed yet).
		459
		460	Until then, you might get away with switching fonts at runtime (see L<Can
		461	I switch the fonts at runtime?> later in this document).
		462
		463	=head3 How can I make mplayer display video correctly?
		464
		465	We are working on it, in the meantime, as a workaround, use something like:
		466
		467	@@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
		468
		469
		470	=head2 Keyboard, Mouse & User Interaction
		471
		472	=head3 The new selection selects pieces that are too big, how can I select single words?
		473
		474	If you want to select e.g. alphanumeric words, you can use the following
		475	setting:
		476
		477	URxvt.selection.pattern-0: ([[:word:]]+)
		478
		479	If you click more than twice, the selection will be extended
		480	more and more.
		481
		482	To get a selection that is very similar to the old code, try this pattern:
		483
		484	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		485
		486	Please also note that the I<LeftClick Shift-LeftClik> combination also
		487	selects words like the old code.
		488
		489	=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
		490
		491	You can disable the perl extension completely by setting the
		492	B<perl-ext-common> resource to the empty string, which also keeps
		493	rxvt-unicode from initialising perl, saving memory.
		494
		495	If you only want to disable specific features, you first have to
		496	identify which perl extension is responsible. For this, read the section
		497	B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
		498	example, to disable the B<selection-popup> and B<option-popup>, specify
		499	this B<perl-ext-common> resource:
		500
		501	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		502
		503	This will keep the default extensions, but disable the two popup
		504	extensions. Some extensions can also be configured, for example,
		505	scrollback search mode is triggered by B<M-s>. You can move it to any
		506	other combination either by setting the B<searchable-scrollback> resource:
		507
		508	URxvt.searchable-scrollback: CM-s
		509
		510	=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
		511
		512	See next entry.
		513
		514	=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
		515
		516	These are caused by the C<readline> perl extension. Under normal
		517	circumstances, it will move your cursor around when you click into the
		518	line that contains it. It tries hard not to do this at the wrong moment,
		519	but when running a program that doesn't parse cursor movements or in some
		520	cases during rlogin sessions, it fails to detect this properly.
		521
		522	You can permanently switch this feature off by disabling the C<readline>
		523	extension:
		524
		525	URxvt.perl-ext-common: default,-readline
		526
		527	=head3 My numerical keypad acts weird and generates differing output?
		528
		529	Some Debian GNUL/Linux users seem to have this problem, although no
		530	specific details were reported so far. It is possible that this is caused
		531	by the wrong C<TERM> setting, although the details of whether and how
		532	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		533	keymap. See the answer to the previous question, and please report if that
		534	helped.
		535
		536	=head3 My Compose (Multi_key) key is no longer working.
		537
		538	The most common causes for this are that either your locale is not set
		539	correctly, or you specified a B<preeditStyle> that is not supported by
		540	your input method. For example, if you specified B<OverTheSpot> and
		541	your input method (e.g. the default input method handling Compose keys)
		542	does not support this (for instance because it is not visual), then
		543	rxvt-unicode will continue without an input method.
		544
		545	In this case either do not specify a B<preeditStyle> or specify more than
		546	one pre-edit style, such as B<OverTheSpot,Root,None>.
		547
		548	=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		549
		550	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		551	international keyboards) or simply use ISO 14755 support to your
		552	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		553	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		554	character and so on.
		555
		556	=head3 Mouse cut/paste suddenly no longer works.
		557
		558	Make sure that mouse reporting is actually turned off since killing
		559	some editors prematurely may leave the mouse in mouse report mode. I've
		560	heard that tcsh may use mouse reporting unless it otherwise specified. A
		561	quick check is to see if cut/paste works when the Alt or Shift keys are
		562	depressed.
		563
553	=item What's with the strange Backspace/Delete key behaviour?	564	=head3 What's with the strange Backspace/Delete key behaviour?
554		565
555	Assuming that the physical Backspace key corresponds to the	566	Assuming that the physical Backspace key corresponds to the
556	BackSpace keysym (not likely for Linux ... see the following	567	Backspace keysym (not likely for Linux ... see the following
557	question) there are two standard values that can be used for	568	question) there are two standard values that can be used for
558	Backspace: C<^H> and C<^?>.	569	Backspace: C<^H> and C<^?>.
559		570
560	Historically, either value is correct, but rxvt-unicode adopts the debian	571	Historically, either value is correct, but rxvt-unicode adopts the debian
561	policy of using C<^?> when unsure, because it's the one only only correct	572	policy of using C<^?> when unsure, because it's the one and only correct
562	choice :).	573	choice :).
563		574
564	Rxvt-unicode tries to inherit the current stty settings and uses the value	575	Rxvt-unicode tries to inherit the current stty settings and uses the value
565	of `erase' to guess the value for backspace. If rxvt-unicode wasn't	576	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
566	started from a terminal (say, from a menu or by remote shell), then the	577	started from a terminal (say, from a menu or by remote shell), then the
…		…
569		580
570	For starting a new rxvt-unicode:	581	For starting a new rxvt-unicode:
571		582
572	# use Backspace = ^H	583	# use Backspace = ^H
573	$ stty erase ^H	584	$ stty erase ^H
574	$ @@RXVT_NAME@@	585	$ @@URXVT_NAME@@
575		586
576	# use Backspace = ^?	587	# use Backspace = ^?
577	$ stty erase ^?	588	$ stty erase ^?
578	$ @@RXVT_NAME@@	589	$ @@URXVT_NAME@@
579		590
580	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	591	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
581		592
582	For an existing rxvt-unicode:	593	For an existing rxvt-unicode:
583		594
584	# use Backspace = ^H	595	# use Backspace = ^H
585	$ stty erase ^H	596	$ stty erase ^H
…		…
604	some editors (vim I'm told) expect Backspace = ^H,	615	some editors (vim I'm told) expect Backspace = ^H,
605	GNU Emacs (and Emacs-like editors) use ^H for help.	616	GNU Emacs (and Emacs-like editors) use ^H for help.
606		617
607	Perhaps someday this will all be resolved in a consistent manner.	618	Perhaps someday this will all be resolved in a consistent manner.
608		619
609	=item I don't like the key-bindings. How do I change them?	620	=head3 I don't like the key-bindings. How do I change them?
610		621
611	There are some compile-time selections available via configure. Unless	622	There are some compile-time selections available via configure. Unless
612	you have run "configure" with the C<--disable-resources> option you can	623	you have run "configure" with the C<--disable-resources> option you can
613	use the `keysym' resource to alter the keystrings associated with keysyms.	624	use the `keysym' resource to alter the keystrings associated with keysyms.
614		625
615	Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>	626	Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
616		627
617	URxvt.keysym.Home: \033[1~	628	URxvt.keysym.Home: \033[1~
618	URxvt.keysym.End: \033[4~	629	URxvt.keysym.End: \033[4~
619	URxvt.keysym.C-apostrophe: \033<C-'>	630	URxvt.keysym.C-apostrophe: \033<C-'>
620	URxvt.keysym.C-slash: \033<C-/>	631	URxvt.keysym.C-slash: \033<C-/>
…		…
635	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >	646	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
636	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007	647	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
637		648
638	See some more examples in the documentation for the B<keysym> resource.	649	See some more examples in the documentation for the B<keysym> resource.
639		650
640	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.	651	=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
641	How do I make use of them? For example, the Sun Keyboard type 4
642	has the following mappings that rxvt-unicode doesn't recognize.
643		652
644	KP_Insert == Insert	653	KP_Insert == Insert
645	F22 == Print	654	F22 == Print
646	F27 == Home	655	F27 == Home
647	F29 == Prior	656	F29 == Prior
…		…
650		659
651	Rather than have rxvt-unicode try to accommodate all the various possible	660	Rather than have rxvt-unicode try to accommodate all the various possible
652	keyboard mappings, it is better to use `xmodmap' to remap the keys as	661	keyboard mappings, it is better to use `xmodmap' to remap the keys as
653	required for your particular machine.	662	required for your particular machine.
654		663
655	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
656	I need this to decide about setting colors etc.
657		664
658	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can	665	=head2 Terminal Configuration
659	check and see if that is set. Note that several programs, JED, slrn,
660	Midnight Commander automatically check this variable to decide whether or
661	not to use color.
662		666
663	=item How do I set the correct, full IP address for the DISPLAY variable?	667	=head3 Can I see a typical configuration?
664		668
665	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled	669	The default configuration tries to be xterm-like, which I don't like that
666	insecure mode then it is possible to use the following shell script	670	much, but it's least surprise to regular users.
667	snippets to correctly set the display. If your version of rxvt-unicode
668	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
669	the COLORTERM variable can be used to distinguish rxvt-unicode from a
670	regular xterm.
671		671
672	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script	672	As a rxvt or rxvt-unicode user, you are practically supposed to invest
673	snippets:	673	time into customising your terminal. To get you started, here is the
		674	author's .Xdefaults entries, with comments on what they do. It's certainly
		675	not I<typical>, but what's typical...
674		676
675	# Bourne/Korn/POSIX family of shells:	677	URxvt.cutchars: "()*,<>[]{}|'
676	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know	678	URxvt.print-pipe: cat >/tmp/xxx
677	if [ ${TERM:-foo} = xterm ]; then
678	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
679	echo -n '^[Z'
680	read term_id
681	stty icanon echo
682	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
683	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
684	read DISPLAY # set it in our local shell
685	fi
686	fi
687		679
688	=item How do I compile the manual pages for myself?	680	These are just for testing stuff.
689		681
690	You need to have a recent version of perl installed as F</usr/bin/perl>,	682	URxvt.imLocale: ja_JP.UTF-8
691	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to	683	URxvt.preeditType: OnTheSpot,None
692	the doc subdirectory and enter C<make alldoc>.
693		684
694	=item My question isn't answered here, can I ask a human?	685	This tells rxvt-unicode to use a special locale when communicating with
		686	the X Input Method, and also tells it to only use the OnTheSpot pre-edit
		687	type, which requires the C<xim-onthespot> perl extension but rewards me
		688	with correct-looking fonts.
695		689
696	Before sending me mail, you could go to IRC: C<irc.freenode.net>,	690	URxvt.perl-lib: /root/lib/urxvt
697	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be	691	URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
698	interested in learning about new and exciting problems (but not FAQs :).	692	URxvt.selection.pattern-0: ( at .*? line \\d+)
		693	URxvt.selection.pattern-1: ^(/[^:]+):\
		694	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		695	URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
		696
		697	This is my perl configuration. The first two set the perl library
		698	directory and also tells urxvt to use a large number of extensions. I
		699	develop for myself mostly, so I actually use most of the extensions I
		700	write.
		701
		702	The selection stuff mainly makes the selection perl-error-message aware
		703	and tells it to convert perl error messages into vi-commands to load the
		704	relevant file and go tot he error line number.
		705
		706	URxvt.scrollstyle: plain
		707	URxvt.secondaryScroll: true
		708
		709	As the documentation says: plain is the preferred scrollbar for the
		710	author. The C<secondaryScroll> configures urxvt to scroll in full-screen
		711	apps, like screen, so lines scrolled out of screen end up in urxvt's
		712	scrollback buffer.
		713
		714	URxvt.background: #000000
		715	URxvt.foreground: gray90
		716	URxvt.color7: gray90
		717	URxvt.colorBD: #ffffff
		718	URxvt.cursorColor: #e0e080
		719	URxvt.throughColor: #8080f0
		720	URxvt.highlightColor: #f0f0f0
		721
		722	Some colours. Not sure which ones are being used or even non-defaults, but
		723	these are in my .Xdefaults. Most notably, they set foreground/background
		724	to light gray/black, and also make sure that the colour 7 matches the
		725	default foreground colour.
		726
		727	URxvt.underlineColor: yellow
		728
		729	Another colour, makes underline lines look different. Sometimes hurts, but
		730	is mostly a nice effect.
		731
		732	URxvt.geometry: 154x36
		733	URxvt.loginShell: false
		734	URxvt.meta: ignore
		735	URxvt.utmpInhibit: true
		736
		737	Uh, well, should be mostly self-explanatory. By specifying some defaults
		738	manually, I can quickly switch them for testing.
		739
		740	URxvt.saveLines: 8192
		741
		742	A large scrollback buffer is essential. Really.
		743
		744	URxvt.mapAlert: true
		745
		746	The only case I use it is for my IRC window, which I like to keep
		747	iconified till people msg me (which beeps).
		748
		749	URxvt.visualBell: true
		750
		751	The audible bell is often annoying, especially when in a crowd.
		752
		753	URxvt.insecure: true
		754
		755	Please don't hack my mutt! Ooops...
		756
		757	URxvt.pastableTabs: false
		758
		759	I once thought this is a great idea.
		760
		761	urxvt.font: 9x15bold,\
		762	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		763	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		764	[codeset=JISX0208]xft:Kochi Gothic, \
		765	xft:Bitstream Vera Sans Mono:autohint=true, \
		766	xft:Code2000:antialias=false
		767	urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
		768	urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		769	urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		770
		771	I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
		772	overwhelmed. A special note: the C<9x15bold> mentioned above is actually
		773	the version from XFree-3.3, as XFree-4 replaced it by a totally different
		774	font (different glyphs for C<;> and many other harmless characters),
		775	while the second font is actually the C<9x15bold> from XFree4/XOrg. The
		776	bold version has less chars than the medium version, so I use it for rare
		777	characters, too. When editing sources with vim, I use italic for comments
		778	and other stuff, which looks quite good with Bitstream Vera anti-aliased.
		779
		780	Terminus is a quite bad font (many very wrong glyphs), but for most of my
		781	purposes, it works, and gives a different look, as my normal (Non-bold)
		782	font is already bold, and I want to see a difference between bold and
		783	normal fonts.
		784
		785	Please note that I used the C<urxvt> instance name and not the C<URxvt>
		786	class name. Thats because I use different configs for different purposes,
		787	for example, my IRC window is started with C<-name IRC>, and uses these
		788	defaults:
		789
		790	IRC*title: IRC
		791	IRC*geometry: 87x12+535+542
		792	IRC*saveLines: 0
		793	IRC*mapAlert: true
		794	IRC*font: suxuseuro
		795	IRC*boldFont: suxuseuro
		796	IRC*colorBD: white
		797	IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		798	IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		799
		800	C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
		801	sizes. C<suxuseuro> allows me to keep an eye (and actually read)
		802	stuff while keeping a very small window. If somebody pastes something
		803	complicated (e.g. japanese), I temporarily switch to a larger font.
		804
		805	The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
		806	C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
		807	file for different hosts, for example, on ym main desktop, I use:
		808
		809	URxvt.keysym.C-M-q: command:\033[3;5;5t
		810	URxvt.keysym.C-M-y: command:\033[3;5;606t
		811	URxvt.keysym.C-M-e: command:\033[3;1605;5t
		812	URxvt.keysym.C-M-c: command:\033[3;1605;606t
		813	URxvt.keysym.C-M-p: perl:test
		814
		815	The first for keysym definitions allow me to quickly bring some windows
		816	in the layout I like most. Ion users might start laughing but will stop
		817	immediately when I tell them that I use my own Fvwm2 module for much the
		818	same effect as Ion provides, and I only very rarely use the above key
		819	combinations :->
		820
		821	=head3 Why doesn't rxvt-unicode read my resources?
		822
		823	Well, why, indeed? It does, in a way very similar to other X
		824	applications. Most importantly, this means that if you or your OS loads
		825	resources into the X display (the right way to do it), rxvt-unicode will
		826	ignore any resource files in your home directory. It will only read
		827	F<$HOME/.Xdefaults> when no resources are attached to the display.
		828
		829	If you have or use an F<$HOME/.Xresources> file, chances are that
		830	resources are loaded into your X-server. In this case, you have to
		831	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		832
		833	Also consider the form resources have to use:
		834
		835	URxvt.resource: value
		836
		837	If you want to use another form (there are lots of different ways of
		838	specifying resources), make sure you understand whether and why it
		839	works. If unsure, use the form above.
		840
		841	=head3 When I log-in to another system it tells me about missing terminfo data?
		842
		843	The terminal description used by rxvt-unicode is not as widely available
		844	as that for xterm, or even rxvt (for which the same problem often arises).
		845
		846	The correct solution for this problem is to install the terminfo, this can
		847	be done like this (with ncurses' infocmp and works as user and admin):
		848
		849	REMOTE=remotesystem.domain
		850	infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
		851
		852	... or by installing rxvt-unicode normally on the remote system,
		853
		854	One some systems you might need to set C<$TERMINFO> to the full path of
		855	F<$HOME/.terminfo> for this to work.
		856
		857	If you cannot or do not want to do this, then you can simply set
		858	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		859	problems arising, which includes wrong keymapping, less and different
		860	colours and some refresh errors in fullscreen applications. It's a nice
		861	quick-and-dirty workaround for rare cases, though.
		862
		863	If you always want to do this (and are fine with the consequences) you
		864	can either recompile rxvt-unicode with the desired TERM value or use a
		865	resource to set it:
		866
		867	URxvt.termName: rxvt
		868
		869	If you don't plan to use B<rxvt> (quite common...) you could also replace
		870	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		871
		872	=head3 C<tic> outputs some error when compiling the terminfo entry.
		873
		874	Most likely it's the empty definition for C<enacs=>. Just replace it by
		875	C<enacs=\E[0@> and try again.
		876
		877	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		878
		879	See next entry.
		880
		881	=head3 I need a termcap file entry.
		882
		883	One reason you might want this is that some distributions or operating
		884	systems still compile some programs using the long-obsoleted termcap
		885	library (Fedora Core's bash is one example) and rely on a termcap entry
		886	for C<rxvt-unicode>.
		887
		888	You could use rxvt's termcap entry with reasonable results in many cases.
		889	You can also create a termcap entry by using terminfo's infocmp program
		890	like this:
		891
		892	infocmp -C rxvt-unicode
		893
		894	Or you could use this termcap entry, generated by the command above:
		895
		896	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		897	:am:bw:eo:km:mi:ms:xn:xo:\
		898	:co#80:it#8:li#24:lm#0:\
		899	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		900	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		901	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		902	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		903	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		904	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		905	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		906	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		907	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		908	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		909	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		910	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		911	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		912	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		913	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		914	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		915	:vs=\E[?25h:
		916
		917	=head3 Why does C<ls> no longer have coloured output?
		918
		919	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		920	decide whether a terminal has colour, but uses its own configuration
		921	file. Needless to say, C<rxvt-unicode> is not in its default file (among
		922	with most other terminals supporting colour). Either add:
		923
		924	TERM rxvt-unicode
		925
		926	to C</etc/DIR_COLORS> or simply add:
		927
		928	alias ls='ls --color=auto'
		929
		930	to your C<.profile> or C<.bashrc>.
		931
		932	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		933
		934	See next entry.
		935
		936	=head3 Why doesn't vim/emacs etc. make use of italic?
		937
		938	See next entry.
		939
		940	=head3 Why are the secondary screen-related options not working properly?
		941
		942	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		943	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		944	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		945	features. Unfortunately, some of these (most notably, again, Debian
		946	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		947	file, so you will need to install it on your own (See the question B<When
		948	I log-in to another system it tells me about missing terminfo data?> on
		949	how to do this).
		950
		951
		952	=head2 Encoding / Locale / Input Method Issues
		953
		954	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		955
		956	See next entry.
		957
		958	=head3 Unicode does not seem to work?
		959
		960	If you encounter strange problems like typing an accented character but
		961	getting two unrelated other characters or similar, or if program output is
		962	subtly garbled, then you should check your locale settings.
		963
		964	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		965	programs running in it. Often rxvt-unicode is started in the C<C> locale,
		966	while the login script running within the rxvt-unicode window changes the
		967	locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
		968	not going to work, and is the most common cause for problems.
		969
		970	The best thing is to fix your startup environment, as you will likely run
		971	into other problems. If nothing works you can try this in your .profile.
		972
		973	printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
		974
		975	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		976	supported on your systems. Some systems have a C<locale> command which
		977	displays this (also, C<perl -e0> can be used to check locale settings, as
		978	it will complain loudly if it cannot set the locale). If it displays something
		979	like:
		980
		981	locale: Cannot set LC_CTYPE to default locale: ...
		982
		983	Then the locale you specified is not supported on your system.
		984
		985	If nothing works and you are sure that everything is set correctly then
		986	you will need to remember a little known fact: Some programs just don't
		987	support locales :(
		988
		989	=head3 How does rxvt-unicode determine the encoding to use?
		990
		991	See next entry.
		992
		993	=head3 Is there an option to switch encodings?
		994
		995	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		996	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		997	UTF-8 or any other encodings with respect to terminal I/O.
		998
		999	The reasons is that there exists a perfectly fine mechanism for selecting
		1000	the encoding, doing I/O and (most important) communicating this to all
		1001	applications so everybody agrees on character properties such as width
		1002	and code number. This mechanism is the I<locale>. Applications not using
		1003	that info will have problems (for example, C<xterm> gets the width of
		1004	characters wrong as it uses its own, locale-independent table under all
		1005	locales).
		1006
		1007	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		1008	programs doing the same (that is, most) will automatically agree in the
		1009	interpretation of characters.
		1010
		1011	Unfortunately, there is no system-independent way to select locales, nor
		1012	is there a standard on how locale specifiers will look like.
		1013
		1014	On most systems, the content of the C<LC_CTYPE> environment variable
		1015	contains an arbitrary string which corresponds to an already-installed
		1016	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		1017	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		1018	(i.e. C<de> or C<german>) are also common.
		1019
		1020	Rxvt-unicode ignores all other locale categories, and except for
		1021	the encoding, ignores country or language-specific settings,
		1022	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		1023	rxvt-unicode.
		1024
		1025	If you want to use a specific encoding you have to make sure you start
		1026	rxvt-unicode with the correct C<LC_CTYPE> category.
		1027
		1028	=head3 Can I switch locales at runtime?
		1029
		1030	Yes, using an escape sequence. Try something like this, which sets
		1031	rxvt-unicode's idea of C<LC_CTYPE>.
		1032
		1033	printf '\33]701;%s\007' ja_JP.SJIS
		1034
		1035	See also the previous answer.
		1036
		1037	Sometimes this capability is rather handy when you want to work in
		1038	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		1039	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		1040	first switches to a locale supported by xjdic and back later:
		1041
		1042	printf '\33]701;%s\007' ja_JP.SJIS
		1043	xjdic -js
		1044	printf '\33]701;%s\007' de_DE.UTF-8
		1045
		1046	You can also use xterm's C<luit> program, which usually works fine, except
		1047	for some locales where character width differs between program- and
		1048	rxvt-unicode-locales.
		1049
		1050	=head3 I have problems getting my input method working.
		1051
		1052	Try a search engine, as this is slightly different for every input method server.
		1053
		1054	Here is a checklist:
		1055
		1056	=over 4
		1057
		1058	=item - Make sure your locale I<and> the imLocale are supported on your OS.
		1059
		1060	Try C<locale -a> or check the documentation for your OS.
		1061
		1062	=item - Make sure your locale or imLocale matches a locale supported by your XIM.
		1063
		1064	For example, B<kinput2> does not support UTF-8 locales, you should use
		1065	C<ja_JP.EUC-JP> or equivalent.
		1066
		1067	=item - Make sure your XIM server is actually running.
		1068
		1069	=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
		1070
		1071	When you want to use e.g. B<kinput2>, it must be set to
		1072	C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
		1073	method servers are running with this command:
		1074
		1075	xprop -root XIM_SERVERS
		1076
		1077	=item
699		1078
700	=back	1079	=back
701		1080
		1081	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
		1082
		1083	You can specify separate locales for the input method and the rest of the
		1084	terminal, using the resource C<imlocale>:
		1085
		1086	URxvt.imlocale: ja_JP.EUC-JP
		1087
		1088	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		1089	use your input method. Please note, however, that, depending on your Xlib
		1090	version, you may not be able to input characters outside C<EUC-JP> in a
		1091	normal way then, as your input method limits you.
		1092
		1093	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		1094
		1095	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		1096	design. Applications can avoid some crashes at the expense of memory
		1097	leaks, and Input Methods can avoid some crashes by careful ordering at
		1098	exit time. B<kinput2> (and derived input methods) generally succeeds,
		1099	while B<SCIM> (or similar input methods) fails. In the end, however,
		1100	crashes cannot be completely avoided even if both sides cooperate.
		1101
		1102	So the only workaround is not to kill your Input Method Servers.
		1103
		1104
		1105	=head2 Operating Systems / Package Maintaining
		1106
		1107	=head3 I am using Debian GNU/Linux and have a problem...
		1108
		1109	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		1110	patches that considerably change the behaviour of rxvt-unicode (but
		1111	unfortunately this notice has been removed). Before reporting a bug to
		1112	the original rxvt-unicode author please download and install the genuine
		1113	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		1114	the problem. If you cannot, chances are that the problems are specific to
		1115	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		1116	Tracking System (use C<reportbug> to report the bug).
		1117
		1118	For other problems that also affect the Debian package, you can and
		1119	probably should use the Debian BTS, too, because, after all, it's also a
		1120	bug in the Debian version and it serves as a reminder for other users that
		1121	might encounter the same issue.
		1122
		1123	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		1124
		1125	You should build one binary with the default options. F<configure>
		1126	now enables most useful options, and the trend goes to making them
		1127	runtime-switchable, too, so there is usually no drawback to enabling them,
		1128	except higher disk and possibly memory usage. The perl interpreter should
		1129	be enabled, as important functionality (menus, selection, likely more in
		1130	the future) depends on it.
		1131
		1132	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		1133	system-wide (except maybe with C<defaults>). This will result in useful
		1134	behaviour. If your distribution aims at low memory, add an empty
		1135	C<perl-ext-common> resource to the app-defaults file. This will keep the
		1136	perl interpreter disabled until the user enables it.
		1137
		1138	If you can/want build more binaries, I recommend building a minimal
		1139	one with C<--disable-everything> (very useful) and a maximal one with
		1140	C<--enable-everything> (less useful, it will be very big due to a lot of
		1141	encodings built-in that increase download times and are rarely used).
		1142
		1143	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		1144
		1145	It should be, starting with release 7.1. You are encouraged to properly
		1146	install urxvt with privileges necessary for your OS now.
		1147
		1148	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		1149	into a helper process for privileged operations (pty handling on some
		1150	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		1151	immediately. This is much safer than most other terminals that keep
		1152	privileges while running (but is more relevant to urxvt, as it contains
		1153	things as perl interpreters, which might be "helpful" to attackers).
		1154
		1155	This forking is done as the very first within main(), which is very early
		1156	and reduces possible bugs to initialisation code run before main(), or
		1157	things like the dynamic loader of your system, which should result in very
		1158	little risk.
		1159
		1160	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		1161
		1162	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		1163	in your compile environment, or an implementation that implements it,
		1164	whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		1165	B<wchar_t> is represented as unicode.
		1166
		1167	As you might have guessed, FreeBSD does neither define this symbol nor
		1168	does it support it. Instead, it uses its own internal representation of
		1169	B<wchar_t>. This is, of course, completely fine with respect to standards.
		1170
		1171	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		1172	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		1173
		1174	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		1175	apps in an OS, as using a locale-dependent (and non-standardized)
		1176	representation of B<wchar_t> makes it impossible to convert between
		1177	B<wchar_t> (as used by X11 and your applications) and any other encoding
		1178	without implementing OS-specific-wrappers for each and every locale. There
		1179	simply are no APIs to convert B<wchar_t> into anything except the current
		1180	locale encoding.
		1181
		1182	Some applications (such as the formidable B<mlterm>) work around this
		1183	by carrying their own replacement functions for character set handling
		1184	with them, and either implementing OS-dependent hacks or doing multiple
		1185	conversions (which is slow and unreliable in case the OS implements
		1186	encodings slightly different than the terminal emulator).
		1187
		1188	The rxvt-unicode author insists that the right way to fix this is in the
		1189	system libraries once and for all, instead of forcing every app to carry
		1190	complete replacements for them :)
		1191
		1192	=head3 How can I use rxvt-unicode under cygwin?
		1193
		1194	rxvt-unicode should compile and run out of the box on cygwin, using
		1195	the X11 libraries that come with cygwin. libW11 emulation is no
		1196	longer supported (and makes no sense, either, as it only supported a
		1197	single font). I recommend starting the X-server in C<-multiwindow> or
		1198	C<-rootless> mode instead, which will result in similar look&feel as the
		1199	old libW11 emulation.
		1200
		1201	At the time of this writing, cygwin didn't seem to support any multi-byte
		1202	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1203	to 8-bit encodings.
		1204
		1205	=head3 Character widths are not correct.
		1206
		1207	urxvt uses the system wcwidth function to know the information about
		1208	the width of characters, so on systems with incorrect locale data you
		1209	will likely get bad results. Two notorious examples are Solaris 9,
		1210	where single-width characters like U+2514 are reported as double-width,
		1211	and Darwin 8, where combining chars are reported having width 1.
		1212
		1213	The solution is to upgrade your system or switch to a better one. A
		1214	possibly working workaround is to use a wcwidth implementation like
		1215
		1216	http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
		1217
702	=head1 RXVT TECHNICAL REFERENCE	1218	=head1 RXVT-UNICODE TECHNICAL REFERENCE
703
704	=head1 DESCRIPTION
705		1219
706	The rest of this document describes various technical aspects of	1220	The rest of this document describes various technical aspects of
707	B<rxvt-unicode>. First the description of supported command sequences,	1221	B<rxvt-unicode>. First the description of supported command sequences,
708	followed by menu and pixmap support and last by a description of all	1222	followed by pixmap support and last by a description of all features
709	features selectable at C<configure> time.	1223	selectable at C<configure> time.
710		1224
711	=head1 Definitions	1225	=head2 Definitions
712		1226
713	=over 4	1227	=over 4
714		1228
715	=item B<< C<c> >>	1229	=item B<< C<c> >>
716		1230
…		…
734		1248
735	A text parameter composed of printable characters.	1249	A text parameter composed of printable characters.
736		1250
737	=back	1251	=back
738		1252
739	=head1 Values	1253	=head2 Values
740		1254
741	=over 4	1255	=over 4
742		1256
743	=item B<< C<ENQ> >>	1257	=item B<< C<ENQ> >>
744		1258
…		…
787		1301
788	Space Character	1302	Space Character
789		1303
790	=back	1304	=back
791		1305
792	=head1 Escape Sequences	1306	=head2 Escape Sequences
793		1307
794	=over 4	1308	=over 4
795		1309
796	=item B<< C<ESC # 8> >>	1310	=item B<< C<ESC # 8> >>
797		1311
…		…
895		1409
896	=back	1410	=back
897		1411
898	X<CSI>	1412	X<CSI>
899		1413
900	=head1 CSI (Command Sequence Introducer) Sequences	1414	=head2 CSI (Command Sequence Introducer) Sequences
901		1415
902	=over 4	1416	=over 4
903		1417
904	=item B<< C<ESC [ Ps @> >>	1418	=item B<< C<ESC [ Ps @> >>
905		1419
…		…
1175		1689
1176	=back	1690	=back
1177		1691
1178	X<PrivateModes>	1692	X<PrivateModes>
1179		1693
1180	=head1 DEC Private Modes	1694	=head2 DEC Private Modes
1181		1695
1182	=over 4	1696	=over 4
1183		1697
1184	=item B<< C<ESC [ ? Pm h> >>	1698	=item B<< C<ESC [ ? Pm h> >>
1185		1699
…		…
1201		1715
1202	Toggle DEC Private Mode Values (rxvt extension). I<where>	1716	Toggle DEC Private Mode Values (rxvt extension). I<where>
1203		1717
1204	=over 4	1718	=over 4
1205		1719
1206	=item B<< C<Ps = 1> >> (DECCKM)	1720	=item B<< C<Pm = 1> >> (DECCKM)
1207		1721
1208	=begin table	1722	=begin table
1209		1723
1210	B<< C<h> >> Application Cursor Keys	1724	B<< C<h> >> Application Cursor Keys
1211	B<< C<l> >> Normal Cursor Keys	1725	B<< C<l> >> Normal Cursor Keys
1212		1726
1213	=end table	1727	=end table
1214		1728
1215	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1729	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1216		1730
1217	=begin table	1731	=begin table
1218		1732
1219	B<< C<h> >> Enter VT52 mode	1733	B<< C<h> >> Enter VT52 mode
1220	B<< C<l> >> Enter VT52 mode	1734	B<< C<l> >> Enter VT52 mode
1221		1735
1222	=end table	1736	=end table
1223		1737
1224	=item B<< C<Ps = 3> >>	1738	=item B<< C<Pm = 3> >>
1225		1739
1226	=begin table	1740	=begin table
1227		1741
1228	B<< C<h> >> 132 Column Mode (DECCOLM)	1742	B<< C<h> >> 132 Column Mode (DECCOLM)
1229	B<< C<l> >> 80 Column Mode (DECCOLM)	1743	B<< C<l> >> 80 Column Mode (DECCOLM)
1230		1744
1231	=end table	1745	=end table
1232		1746
1233	=item B<< C<Ps = 4> >>	1747	=item B<< C<Pm = 4> >>
1234		1748
1235	=begin table	1749	=begin table
1236		1750
1237	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1751	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1238	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1752	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1239		1753
1240	=end table	1754	=end table
1241		1755
1242	=item B<< C<Ps = 5> >>	1756	=item B<< C<Pm = 5> >>
1243		1757
1244	=begin table	1758	=begin table
1245		1759
1246	B<< C<h> >> Reverse Video (DECSCNM)	1760	B<< C<h> >> Reverse Video (DECSCNM)
1247	B<< C<l> >> Normal Video (DECSCNM)	1761	B<< C<l> >> Normal Video (DECSCNM)
1248		1762
1249	=end table	1763	=end table
1250		1764
1251	=item B<< C<Ps = 6> >>	1765	=item B<< C<Pm = 6> >>
1252		1766
1253	=begin table	1767	=begin table
1254		1768
1255	B<< C<h> >> Origin Mode (DECOM)	1769	B<< C<h> >> Origin Mode (DECOM)
1256	B<< C<l> >> Normal Cursor Mode (DECOM)	1770	B<< C<l> >> Normal Cursor Mode (DECOM)
1257		1771
1258	=end table	1772	=end table
1259		1773
1260	=item B<< C<Ps = 7> >>	1774	=item B<< C<Pm = 7> >>
1261		1775
1262	=begin table	1776	=begin table
1263		1777
1264	B<< C<h> >> Wraparound Mode (DECAWM)	1778	B<< C<h> >> Wraparound Mode (DECAWM)
1265	B<< C<l> >> No Wraparound Mode (DECAWM)	1779	B<< C<l> >> No Wraparound Mode (DECAWM)
1266		1780
1267	=end table	1781	=end table
1268		1782
1269	=item B<< C<Ps = 8> >> I<unimplemented>	1783	=item B<< C<Pm = 8> >> I<unimplemented>
1270		1784
1271	=begin table	1785	=begin table
1272		1786
1273	B<< C<h> >> Auto-repeat Keys (DECARM)	1787	B<< C<h> >> Auto-repeat Keys (DECARM)
1274	B<< C<l> >> No Auto-repeat Keys (DECARM)	1788	B<< C<l> >> No Auto-repeat Keys (DECARM)
1275		1789
1276	=end table	1790	=end table
1277		1791
1278	=item B<< C<Ps = 9> >> X10 XTerm	1792	=item B<< C<Pm = 9> >> X10 XTerm
1279		1793
1280	=begin table	1794	=begin table
1281		1795
1282	B<< C<h> >> Send Mouse X & Y on button press.	1796	B<< C<h> >> Send Mouse X & Y on button press.
1283	B<< C<l> >> No mouse reporting.	1797	B<< C<l> >> No mouse reporting.
1284		1798
1285	=end table	1799	=end table
1286		1800
1287	=item B<< C<Ps = 10> >> (B<rxvt>)
1288
1289	=begin table
1290
1291	B<< C<h> >> menuBar visible
1292	B<< C<l> >> menuBar invisible
1293
1294	=end table
1295
1296	=item B<< C<Ps = 25> >>	1801	=item B<< C<Pm = 25> >>
1297		1802
1298	=begin table	1803	=begin table
1299		1804
1300	B<< C<h> >> Visible cursor {cnorm/cvvis}	1805	B<< C<h> >> Visible cursor {cnorm/cvvis}
1301	B<< C<l> >> Invisible cursor {civis}	1806	B<< C<l> >> Invisible cursor {civis}
1302		1807
1303	=end table	1808	=end table
1304		1809
1305	=item B<< C<Ps = 30> >>	1810	=item B<< C<Pm = 30> >>
1306		1811
1307	=begin table	1812	=begin table
1308		1813
1309	B<< C<h> >> scrollBar visisble	1814	B<< C<h> >> scrollBar visisble
1310	B<< C<l> >> scrollBar invisisble	1815	B<< C<l> >> scrollBar invisisble
1311		1816
1312	=end table	1817	=end table
1313		1818
1314	=item B<< C<Ps = 35> >> (B<rxvt>)	1819	=item B<< C<Pm = 35> >> (B<rxvt>)
1315		1820
1316	=begin table	1821	=begin table
1317		1822
1318	B<< C<h> >> Allow XTerm Shift+key sequences	1823	B<< C<h> >> Allow XTerm Shift+key sequences
1319	B<< C<l> >> Disallow XTerm Shift+key sequences	1824	B<< C<l> >> Disallow XTerm Shift+key sequences
1320		1825
1321	=end table	1826	=end table
1322		1827
1323	=item B<< C<Ps = 38> >> I<unimplemented>	1828	=item B<< C<Pm = 38> >> I<unimplemented>
1324		1829
1325	Enter Tektronix Mode (DECTEK)	1830	Enter Tektronix Mode (DECTEK)
1326		1831
1327	=item B<< C<Ps = 40> >>	1832	=item B<< C<Pm = 40> >>
1328		1833
1329	=begin table	1834	=begin table
1330		1835
1331	B<< C<h> >> Allow 80/132 Mode	1836	B<< C<h> >> Allow 80/132 Mode
1332	B<< C<l> >> Disallow 80/132 Mode	1837	B<< C<l> >> Disallow 80/132 Mode
1333		1838
1334	=end table	1839	=end table
1335		1840
1336	=item B<< C<Ps = 44> >> I<unimplemented>	1841	=item B<< C<Pm = 44> >> I<unimplemented>
1337		1842
1338	=begin table	1843	=begin table
1339		1844
1340	B<< C<h> >> Turn On Margin Bell	1845	B<< C<h> >> Turn On Margin Bell
1341	B<< C<l> >> Turn Off Margin Bell	1846	B<< C<l> >> Turn Off Margin Bell
1342		1847
1343	=end table	1848	=end table
1344		1849
1345	=item B<< C<Ps = 45> >> I<unimplemented>	1850	=item B<< C<Pm = 45> >> I<unimplemented>
1346		1851
1347	=begin table	1852	=begin table
1348		1853
1349	B<< C<h> >> Reverse-wraparound Mode	1854	B<< C<h> >> Reverse-wraparound Mode
1350	B<< C<l> >> No Reverse-wraparound Mode	1855	B<< C<l> >> No Reverse-wraparound Mode
1351		1856
1352	=end table	1857	=end table
1353		1858
1354	=item B<< C<Ps = 46> >> I<unimplemented>	1859	=item B<< C<Pm = 46> >> I<unimplemented>
1355		1860
1356	=item B<< C<Ps = 47> >>	1861	=item B<< C<Pm = 47> >>
1357		1862
1358	=begin table	1863	=begin table
1359		1864
1360	B<< C<h> >> Use Alternate Screen Buffer	1865	B<< C<h> >> Use Alternate Screen Buffer
1361	B<< C<l> >> Use Normal Screen Buffer	1866	B<< C<l> >> Use Normal Screen Buffer
1362		1867
1363	=end table	1868	=end table
1364		1869
1365	X<Priv66>	1870	X<Priv66>
1366		1871
1367	=item B<< C<Ps = 66> >>	1872	=item B<< C<Pm = 66> >>
1368		1873
1369	=begin table	1874	=begin table
1370		1875
1371	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1876	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1372	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1877	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1373		1878
1374	=end table	1879	=end table
1375		1880
1376	=item B<< C<Ps = 67> >>	1881	=item B<< C<Pm = 67> >>
1377		1882
1378	=begin table	1883	=begin table
1379		1884
1380	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1885	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1381	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1886	B<< C<l> >> Backspace key sends B<< C<DEL> >>
1382		1887
1383	=end table	1888	=end table
1384		1889
1385	=item B<< C<Ps = 1000> >> (X11 XTerm)	1890	=item B<< C<Pm = 1000> >> (X11 XTerm)
1386		1891
1387	=begin table	1892	=begin table
1388		1893
1389	B<< C<h> >> Send Mouse X & Y on button press and release.	1894	B<< C<h> >> Send Mouse X & Y on button press and release.
1390	B<< C<l> >> No mouse reporting.	1895	B<< C<l> >> No mouse reporting.
1391		1896
1392	=end table	1897	=end table
1393		1898
1394	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1899	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1395		1900
1396	=begin table	1901	=begin table
1397		1902
1398	B<< C<h> >> Use Hilite Mouse Tracking.	1903	B<< C<h> >> Use Hilite Mouse Tracking.
1399	B<< C<l> >> No mouse reporting.	1904	B<< C<l> >> No mouse reporting.
1400		1905
1401	=end table	1906	=end table
1402		1907
		1908	=item B<< C<Pm = 1002> >> (X11 XTerm)
		1909
		1910	=begin table
		1911
		1912	B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
		1913	B<< C<l> >> No mouse reporting.
		1914
		1915	=end table
		1916
		1917	=item B<< C<Pm = 1003> >> (X11 XTerm)
		1918
		1919	=begin table
		1920
		1921	B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
		1922	B<< C<l> >> No mouse reporting.
		1923
		1924	=end table
		1925
1403	=item B<< C<Ps = 1010> >> (B<rxvt>)	1926	=item B<< C<Pm = 1010> >> (B<rxvt>)
1404		1927
1405	=begin table	1928	=begin table
1406		1929
1407	B<< C<h> >> Don't scroll to bottom on TTY output	1930	B<< C<h> >> Don't scroll to bottom on TTY output
1408	B<< C<l> >> Scroll to bottom on TTY output	1931	B<< C<l> >> Scroll to bottom on TTY output
1409		1932
1410	=end table	1933	=end table
1411		1934
1412	=item B<< C<Ps = 1011> >> (B<rxvt>)	1935	=item B<< C<Pm = 1011> >> (B<rxvt>)
1413		1936
1414	=begin table	1937	=begin table
1415		1938
1416	B<< C<h> >> Scroll to bottom when a key is pressed	1939	B<< C<h> >> Scroll to bottom when a key is pressed
1417	B<< C<l> >> Don't scroll to bottom when a key is pressed	1940	B<< C<l> >> Don't scroll to bottom when a key is pressed
1418		1941
1419	=end table	1942	=end table
1420		1943
		1944	=item B<< C<Pm = 1021> >> (B<rxvt>)
		1945
		1946	=begin table
		1947
		1948	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1949	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1950
		1951	=end table
		1952
1421	=item B<< C<Ps = 1047> >>	1953	=item B<< C<Pm = 1047> >>
1422		1954
1423	=begin table	1955	=begin table
1424		1956
1425	B<< C<h> >> Use Alternate Screen Buffer	1957	B<< C<h> >> Use Alternate Screen Buffer
1426	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it	1958	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1427		1959
1428	=end table	1960	=end table
1429		1961
1430	=item B<< C<Ps = 1048> >>	1962	=item B<< C<Pm = 1048> >>
1431		1963
1432	=begin table	1964	=begin table
1433		1965
1434	B<< C<h> >> Save cursor position	1966	B<< C<h> >> Save cursor position
1435	B<< C<l> >> Restore cursor position	1967	B<< C<l> >> Restore cursor position
1436		1968
1437	=end table	1969	=end table
1438		1970
1439	=item B<< C<Ps = 1049> >>	1971	=item B<< C<Pm = 1049> >>
1440		1972
1441	=begin table	1973	=begin table
1442		1974
1443	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it	1975	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1444	B<< C<l> >> Use Normal Screen Buffer	1976	B<< C<l> >> Use Normal Screen Buffer
…		…
1449		1981
1450	=back	1982	=back
1451		1983
1452	X<XTerm>	1984	X<XTerm>
1453		1985
1454	=head1 XTerm Operating System Commands	1986	=head2 XTerm Operating System Commands
1455		1987
1456	=over 4	1988	=over 4
1457		1989
1458	=item B<< C<ESC ] Ps;Pt ST> >>	1990	=item B<< C<ESC ] Ps;Pt ST> >>
1459		1991
…		…
1471	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	2003	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1472	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	2004	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1473	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	2005	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1474	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	2006	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1475	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	2007	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1476	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	2008	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1477	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	2009	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		2010	B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1478	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	2011	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1479	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1480	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	2012	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1481	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	2013	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1482	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>	2014	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1483	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	2015	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1484	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)	2016	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1485	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)	2017	B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1486	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	2018	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>	2019	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		2020	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		2021	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1488	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	2022	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	2023	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1490	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	2024	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	2025	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		2026	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2027	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2028	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1492		2029
1493	=end table	2030	=end table
1494		2031
1495	=back	2032	=back
1496		2033
1497	X<menuBar>	2034	=head1 BACKGROUND IMAGE
1498		2035
1499	=head1 menuBar
1500
1501	B<< The exact syntax used is I<almost> solidified. >>
1502	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1503	menuBar.
1504
1505	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1506	omitted: use B<./> to specify a menu relative to the current menu.
1507
1508	=head2 Overview of menuBar operation
1509
1510	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1511	of C<Pt> can be used for a variety of tasks:
1512
1513	At the top level is the current menuBar which is a member of a circular
1514	linked-list of other such menuBars.
1515
1516	The menuBar acts as a parent for the various drop-down menus, which in
1517	turn, may have labels, separator lines, menuItems and subMenus.
1518
1519	The menuItems are the useful bits: you can use them to mimic keyboard
1520	input or even to send text or escape sequences back to rxvt.
1521
1522	The menuBar syntax is intended to provide a simple yet robust method of
1523	constructing and manipulating menus and navigating through the
1524	menuBars.
1525
1526	The first step is to use the tag B<< [menu:I<name>] >> which creates
1527	the menuBar called I<name> and allows access. You may now or menus,
1528	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1529	menuBar access as B<readonly> to prevent accidental corruption of the
1530	menus. To re-access the current menuBar for alterations, use the tag
1531	B<[menu]>, make the alterations and then use B<[done]>
1532
1533	X<menuBarCommands>
1534
1535	=head2 Commands
1536
1537	=over 4
1538
1539	=item B<< [menu:+I<name>] >>
1540
1541	access the named menuBar for creation or alteration. If a new menuBar
1542	is created, it is called I<name> (max of 15 chars) and the current
1543	menuBar is pushed onto the stack
1544
1545	=item B<[menu]>
1546
1547	access the current menuBar for alteration
1548
1549	=item B<< [title:+I<string>] >>
1550
1551	set the current menuBar's title to I<string>, which may contain the
1552	following format specifiers:
1553
1554	B<%n> rxvt name (as per the B<-name> command-line option)
1555	B<%v> rxvt version
1556	B<%%> literal B<%> character
1557
1558	=item B<[done]>
1559
1560	set menuBar access as B<readonly>.
1561	End-of-file tag for B<< [read:+I<file>] >> operations.
1562
1563	=item B<< [read:+I<file>] >>
1564
1565	read menu commands directly from I<file> (extension ".menu" will be
1566	appended if required.) Start reading at a line with B<[menu]> or B<<
1567	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1568
1569	Blank and comment lines (starting with B<#>) are ignored. Actually,
1570	since any invalid menu commands are also ignored, almost anything could
1571	be construed as a comment line, but this may be tightened up in the
1572	future ... so don't count on it!.
1573
1574	=item B<< [read:+I<file>;+I<name>] >>
1575
1576	The same as B<< [read:+I<file>] >>, but start reading at a line with
1577	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1578	B<[done]> is encountered.
1579
1580	=item B<[dump]>
1581
1582	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1583	later rereading.
1584
1585	=item B<[rm:name]>
1586
1587	remove the named menuBar
1588
1589	=item B<[rm] [rm:]>
1590
1591	remove the current menuBar
1592
1593	=item B<[rm*] [rm:*]>
1594
1595	remove all menuBars
1596
1597	=item B<[swap]>
1598
1599	swap the top two menuBars
1600
1601	=item B<[prev]>
1602
1603	access the previous menuBar
1604
1605	=item B<[next]>
1606
1607	access the next menuBar
1608
1609	=item B<[show]>
1610
1611	Enable display of the menuBar
1612
1613	=item B<[hide]>
1614
1615	Disable display of the menuBar
1616
1617	=item B<< [pixmap:+I<name>] >>
1618
1619	=item B<< [pixmap:+I<name>;I<scaling>] >>
1620
1621	(set the background pixmap globally
1622
1623	B<< A Future implementation I<may> make this local to the menubar >>)
1624
1625	=item B<< [:+I<command>:] >>
1626
1627	ignore the menu readonly status and issue a I<command> to or a menu or
1628	menuitem or change the ; a useful shortcut for setting the quick arrows
1629	from a menuBar.
1630
1631	=back
1632
1633	X<menuBarAdd>
1634
1635	=head2 Adding and accessing menus
1636
1637	The following commands may also be B<+> prefixed.
1638
1639	=over 4
1640
1641	=item B</+>
1642
1643	access menuBar top level
1644
1645	=item B<./+>
1646
1647	access current menu level
1648
1649	=item B<../+>
1650
1651	access parent menu (1 level up)
1652
1653	=item B<../../>
1654
1655	access parent menu (multiple levels up)
1656
1657	=item B<< I</path/>menu >>
1658
1659	add/access menu
1660
1661	=item B<< I</path/>menu/* >>
1662
1663	add/access menu and clear it if it exists
1664
1665	=item B<< I</path/>{-} >>
1666
1667	add separator
1668
1669	=item B<< I</path/>{item} >>
1670
1671	add B<item> as a label
1672
1673	=item B<< I</path/>{item} action >>
1674
1675	add/alter I<menuitem> with an associated I<action>
1676
1677	=item B<< I</path/>{item}{right-text} >>
1678
1679	add/alter I<menuitem> with B<right-text> as the right-justified text
1680	and as the associated I<action>
1681
1682	=item B<< I</path/>{item}{rtext} action >>
1683
1684	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1685	the right-justified text.
1686
1687	=back
1688
1689	=over 4
1690
1691	=item Special characters in I<action> must be backslash-escaped:
1692
1693	B<\a \b \E \e \n \r \t \octal>
1694
1695	=item or in control-character notation:
1696
1697	B<^@, ^A .. ^Z .. ^_, ^?>
1698
1699	=back
1700
1701	To send a string starting with a B<NUL> (B<^@>) character to the
1702	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1703	the first of which will be stripped off and the balance directed to the
1704	program. Otherwise if I<action> begins with B<NUL> followed by
1705	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1706	balance is sent back to rxvt.
1707
1708	As a convenience for the many Emacs-type editors, I<action> may start
1709	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1710	appended if missed from B<M-x> commands.
1711
1712	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1713	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1714
1715	=over 4
1716
1717	=item For example,
1718
1719	B<M-xapropos> is equivalent to B<\Exapropos\r>
1720
1721	=item and
1722
1723	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1724
1725	=back
1726
1727	The option B<< {I<right-rtext>} >> will be right-justified. In the
1728	absence of a specified action, this text will be used as the I<action>
1729	as well.
1730
1731	=over 4
1732
1733	=item For example,
1734
1735	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1736
1737	=back
1738
1739	The left label I<is> necessary, since it's used for matching, but
1740	implicitly hiding the left label (by using same name for both left and
1741	right labels), or explicitly hiding the left label (by preceeding it
1742	with a dot), makes it possible to have right-justified text only.
1743
1744	=over 4
1745
1746	=item For example,
1747
1748	B</File/{Open}{Open} Open-File-Action>
1749
1750	=item or hiding it
1751
1752	B</File/{.anylabel}{Open} Open-File-Action>
1753
1754	=back
1755
1756	X<menuBarRemove>
1757
1758	=head2 Removing menus
1759
1760	=over 4
1761
1762	=item B<< -/*+ >>
1763
1764	remove all menus from the menuBar, the same as B<[clear]>
1765
1766	=item B<< -+I</path>menu+ >>
1767
1768	remove menu
1769
1770	=item B<< -+I</path>{item}+ >>
1771
1772	remove item
1773
1774	=item B<< -+I</path>{-} >>
1775
1776	remove separator)
1777
1778	=item B<-/path/menu/*>
1779
1780	remove all items, separators and submenus from menu
1781
1782	=back
1783
1784	X<menuBarArrows>
1785
1786	=head2 Quick Arrows
1787
1788	The menus also provide a hook for I<quick arrows> to provide easier
1789	user access. If nothing has been explicitly set, the default is to
1790	emulate the curror keys. The syntax permits each arrow to be altered
1791	individually or all four at once without re-entering their common
1792	beginning/end text. For example, to explicitly associate cursor actions
1793	with the arrows, any of the following forms could be used:
1794
1795	=over 4
1796
1797	=item B<< <r>+I<Right> >>
1798
1799	=item B<< <l>+I<Left> >>
1800
1801	=item B<< <u>+I<Up> >>
1802
1803	=item B<< <d>+I<Down> >>
1804
1805	Define actions for the respective arrow buttons
1806
1807	=item B<< <b>+I<Begin> >>
1808
1809	=item B<< <e>+I<End> >>
1810
1811	Define common beginning/end parts for I<quick arrows> which used in
1812	conjunction with the above <r> <l> <u> <d> constructs
1813
1814	=back
1815
1816	=over 4
1817
1818	=item For example, define arrows individually,
1819
1820	<u>\E[A
1821
1822	<d>\E[B
1823
1824	<r>\E[C
1825
1826	<l>\E[D
1827
1828	=item or all at once
1829
1830	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1831
1832	=item or more compactly (factoring out common parts)
1833
1834	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1835
1836	=back
1837
1838	X<menuBarSummary>
1839
1840	=head2 Command Summary
1841
1842	A short summary of the most I<common> commands:
1843
1844	=over 4
1845
1846	=item [menu:name]
1847
1848	use an existing named menuBar or start a new one
1849
1850	=item [menu]
1851
1852	use the current menuBar
1853
1854	=item [title:string]
1855
1856	set menuBar title
1857
1858	=item [done]
1859
1860	set menu access to readonly and, if reading from a file, signal EOF
1861
1862	=item [done:name]
1863
1864	if reading from a file using [read:file;name] signal EOF
1865
1866	=item [rm:name]
1867
1868	remove named menuBar(s)
1869
1870	=item [rm] [rm:]
1871
1872	remove current menuBar
1873
1874	=item [rm*] [rm:*]
1875
1876	remove all menuBar(s)
1877
1878	=item [swap]
1879
1880	swap top two menuBars
1881
1882	=item [prev]
1883
1884	access the previous menuBar
1885
1886	=item [next]
1887
1888	access the next menuBar
1889
1890	=item [show]
1891
1892	map menuBar
1893
1894	=item [hide]
1895
1896	unmap menuBar
1897
1898	=item [pixmap;file]
1899
1900	=item [pixmap;file;scaling]
1901
1902	set a background pixmap
1903
1904	=item [read:file]
1905
1906	=item [read:file;name]
1907
1908	read in a menu from a file
1909
1910	=item [dump]
1911
1912	dump out all menuBars to /tmp/rxvt-PID
1913
1914	=item /
1915
1916	access menuBar top level
1917
1918	=item ./
1919
1920	=item ../
1921
1922	=item ../../
1923
1924	access current or parent menu level
1925
1926	=item /path/menu
1927
1928	add/access menu
1929
1930	=item /path/{-}
1931
1932	add separator
1933
1934	=item /path/{item}{rtext} action
1935
1936	add/alter menu item
1937
1938	=item -/*
1939
1940	remove all menus from the menuBar
1941
1942	=item -/path/menu
1943
1944	remove menu items, separators and submenus from menu
1945
1946	=item -/path/menu
1947
1948	remove menu
1949
1950	=item -/path/{item}
1951
1952	remove item
1953
1954	=item -/path/{-}
1955
1956	remove separator
1957
1958	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1959
1960	menu quick arrows
1961
1962	=back
1963	X<XPM>
1964
1965	=head1 XPM
1966
1967	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	2036	For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1968	of B<< C<Pt> >> can be the name of the background pixmap followed by a	2037	of B<< C<Pt> >> can be the name of the background image file followed by a
1969	sequence of scaling/positioning commands separated by semi-colons. The	2038	sequence of scaling/positioning commands separated by semi-colons. The
1970	scaling/positioning commands are as follows:	2039	scaling/positioning commands are as follows:
1971		2040
1972	=over 4	2041	=over 4
1973		2042
…		…
2011		2080
2012	For example:	2081	For example:
2013		2082
2014	=over 4	2083	=over 4
2015		2084
2016	=item B<\E]20;funky\a>	2085	=item B<\E]20;funky.jpg\a>
2017		2086
2018	load B<funky.xpm> as a tiled image	2087	load B<funky.jpg> as a tiled image
2019		2088
2020	=item B<\E]20;mona;100\a>	2089	=item B<\E]20;mona.jpg;100\a>
2021		2090
2022	load B<mona.xpm> with a scaling of 100%	2091	load B<mona.jpg> with a scaling of 100%
2023		2092
2024	=item B<\E]20;;200;?\a>	2093	=item B<\E]20;;200;?\a>
2025		2094
2026	rescale the current pixmap to 200% and display the image geometry in	2095	rescale the current pixmap to 200% and display the image geometry in
2027	the title	2096	the title
…		…
2066	=begin table	2135	=begin table
2067		2136
2068	4 Shift	2137	4 Shift
2069	8 Meta	2138	8 Meta
2070	16 Control	2139	16 Control
2071	32 Double Click I<(Rxvt extension)>	2140	32 Double Click I<(rxvt extension)>
2072		2141
2073	=end table	2142	=end table
2074		2143
2075	Col = B<< C<< <x> - SPACE >> >>	2144	Col = B<< C<< <x> - SPACE >> >>
2076		2145
…		…
2153	=end table	2222	=end table
2154		2223
2155	=head1 CONFIGURE OPTIONS	2224	=head1 CONFIGURE OPTIONS
2156		2225
2157	General hint: if you get compile errors, then likely your configuration	2226	General hint: if you get compile errors, then likely your configuration
2158	hasn't been tested well. Either try with --enable-everything or use the	2227	hasn't been tested well. Either try with C<--enable-everything> or use
2159	./reconf script as a base for experiments. ./reconf is used by myself,	2228	the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2160	so it should generally be a working config. Of course, you should always	2229	switches). Of course, you should always report when a combination doesn't
2161	report when a combination doesn't work, so it can be fixed. Marc Lehmann	2230	work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2162	<rxvt@schmorp.de>.	2231
		2232	All
2163		2233
2164	=over 4	2234	=over 4
2165		2235
2166	=item --enable-everything	2236	=item --enable-everything
2167		2237
2168	Add support for all non-multichoice options listed in "./configure	2238	Add (or remove) support for all non-multichoice options listed in "./configure
2169	--help". Note that unlike other enable options this is order dependant.	2239	--help".
		2240
2170	You can specify this and then disable options which this enables by	2241	You can specify this and then disable options you do not like by
2171	I<following> this with the appropriate commands.	2242	I<following> this with the appropriate C<--disable-...> arguments,
		2243	or you can start with a minimal configuration by specifying
		2244	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2245	you want.
2172		2246
2173	=item --enable-xft	2247	=item --enable-xft (default: enabled)
2174		2248
2175	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	2249	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2176	slower and require lots of memory, but as long as you don't use them, you	2250	slower and require lots of memory, but as long as you don't use them, you
2177	don't pay for them.	2251	don't pay for them.
2178		2252
2179	=item --enable-font-styles	2253	=item --enable-font-styles (default: on)
2180		2254
2181	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	2255	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2182	styles. The fonts can be set manually or automatically.	2256	styles. The fonts can be set manually or automatically.
2183		2257
2184	=item --with-codesets=NAME,...	2258	=item --with-codesets=NAME,... (default: all)
2185		2259
2186	Compile in support for additional codeset (encoding) groups (eu, vn are	2260	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2187	always compiled in, which includes most 8-bit character sets). These	2261	are always compiled in, which includes most 8-bit character sets). These
2188	codeset tables are currently only used for driving X11 core fonts, they	2262	codeset tables are used for driving X11 core fonts, they are not required
2189	are not required for Xft fonts. Compiling them in will make your binary	2263	for Xft fonts, although having them compiled in lets rxvt-unicode choose
2190	bigger (together about 700kB), but it doesn't increase memory usage unless	2264	replacement fonts more intelligently. Compiling them in will make your
		2265	binary bigger (all of together cost about 700kB), but it doesn't increase
2191	you use an X11 font requiring one of these encodings.	2266	memory usage unless you use a font requiring one of these encodings.
2192		2267
2193	=begin table	2268	=begin table
2194		2269
2195	all all available codeset groups	2270	all all available codeset groups
2196	zh common chinese encodings	2271	zh common chinese encodings
2197	zh_ext rarely used but very big chinese encodigs	2272	zh_ext rarely used but very big chinese encodings
2198	jp common japanese encodings	2273	jp common japanese encodings
2199	jp_ext rarely used but big japanese encodings	2274	jp_ext rarely used but big japanese encodings
2200	kr korean encodings	2275	kr korean encodings
2201		2276
2202	=end table	2277	=end table
2203		2278
2204	=item --enable-xim	2279	=item --enable-xim (default: on)
2205		2280
2206	Add support for XIM (X Input Method) protocol. This allows using	2281	Add support for XIM (X Input Method) protocol. This allows using
2207	alternative input methods (e.g. kinput2) and will also correctly	2282	alternative input methods (e.g. kinput2) and will also correctly
2208	set up the input for people using dead keys or compose keys.	2283	set up the input for people using dead keys or compose keys.
2209		2284
2210	=item --enable-unicode3	2285	=item --enable-unicode3 (default: off)
		2286
		2287	Recommended to stay off unless you really need non-BMP characters.
2211		2288
2212	Enable direct support for displaying unicode codepoints above	2289	Enable direct support for displaying unicode codepoints above
2213	65535 (the basic multilingual page). This increases storage	2290	65535 (the basic multilingual page). This increases storage
2214	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2291	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2215	support these extra characters, but Xft does.	2292	support these extra characters, but Xft does.
2216		2293
2217	Please note that rxvt-unicode can store unicode code points >65535	2294	Please note that rxvt-unicode can store unicode code points >65535
2218	even without this flag, but the number of such characters is	2295	even without this flag, but the number of such characters is
2219	limited to a view thousand (shared with combining characters,	2296	limited to a few thousand (shared with combining characters,
2220	see next switch), and right now rxvt-unicode cannot display them	2297	see next switch), and right now rxvt-unicode cannot display them
2221	(input/output and cut&paste still work, though).	2298	(input/output and cut&paste still work, though).
2222		2299
2223	=item --enable-combining	2300	=item --enable-combining (default: on)
2224		2301
2225	Enable automatic composition of combining characters into	2302	Enable automatic composition of combining characters into
2226	composite characters. This is required for proper viewing of text	2303	composite characters. This is required for proper viewing of text
2227	where accents are encoded as seperate unicode characters. This is	2304	where accents are encoded as seperate unicode characters. This is
2228	done by using precomposited characters when available or creating	2305	done by using precomposited characters when available or creating
2229	new pseudo-characters when no precomposed form exists.	2306	new pseudo-characters when no precomposed form exists.
2230		2307
2231	Without --enable-unicode3, the number of additional precomposed characters	2308	Without --enable-unicode3, the number of additional precomposed
2232	is rather limited (2048, if this is full, rxvt-unicode will use the	2309	characters is somewhat limited (the 6400 private use characters will be
2233	private use area, extending the number of combinations to 8448). With
2234	--enable-unicode3, no practical limit exists.	2310	(ab-)used). With --enable-unicode3, no practical limit exists.
2235		2311
2236	This option will also enable storage (but not display) of characters	2312	This option will also enable storage (but not display) of characters
2237	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2313	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2238		2314
2239	The combining table also contains entries for arabic presentation forms,	2315	The combining table also contains entries for arabic presentation forms,
2240	but these are not currently used. Bug me if you want these to be used (and	2316	but these are not currently used. Bug me if you want these to be used (and
2241	tell me how these are to be used...).	2317	tell me how these are to be used...).
2242		2318
2243	=item --enable-fallback(=CLASS)	2319	=item --enable-fallback(=CLASS) (default: Rxvt)
2244		2320
2245	When reading resource settings, also read settings for class CLASS	2321	When reading resource settings, also read settings for class CLASS. To
2246	(default: Rxvt). To disable resource fallback use --disable-fallback.	2322	disable resource fallback use --disable-fallback.
2247		2323
2248	=item --with-res-name=NAME	2324	=item --with-res-name=NAME (default: urxvt)
2249		2325
2250	Use the given name (default: urxvt) as default application name when	2326	Use the given name as default application name when
2251	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2327	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2252		2328
2253	=item --with-res-class=CLASS	2329	=item --with-res-class=CLASS (default: URxvt)
2254		2330
2255	Use the given class (default: URxvt) as default application class	2331	Use the given class as default application class
2256	when reading resources. Specify --with-res-class=Rxvt to replace	2332	when reading resources. Specify --with-res-class=Rxvt to replace
2257	rxvt.	2333	rxvt.
2258		2334
2259	=item --enable-utmp	2335	=item --enable-utmp (default: on)
2260		2336
2261	Write user and tty to utmp file (used by programs like F<w>) at	2337	Write user and tty to utmp file (used by programs like F<w>) at
2262	start of rxvt execution and delete information when rxvt exits.	2338	start of rxvt execution and delete information when rxvt exits.
2263		2339
2264	=item --enable-wtmp	2340	=item --enable-wtmp (default: on)
2265		2341
2266	Write user and tty to wtmp file (used by programs like F<last>) at	2342	Write user and tty to wtmp file (used by programs like F<last>) at
2267	start of rxvt execution and write logout when rxvt exits. This	2343	start of rxvt execution and write logout when rxvt exits. This
2268	option requires --enable-utmp to also be specified.	2344	option requires --enable-utmp to also be specified.
2269		2345
2270	=item --enable-lastlog	2346	=item --enable-lastlog (default: on)
2271		2347
2272	Write user and tty to lastlog file (used by programs like	2348	Write user and tty to lastlog file (used by programs like
2273	F<lastlogin>) at start of rxvt execution. This option requires	2349	F<lastlogin>) at start of rxvt execution. This option requires
2274	--enable-utmp to also be specified.	2350	--enable-utmp to also be specified.
2275		2351
2276	=item --enable-xpm-background	2352	=item --enable-afterimage (default: on)
2277		2353
2278	Add support for XPM background pixmaps.	2354	Add support for libAfterImage to be used for transparency and background
		2355	images. It adds support for many file formats including JPG, PNG,
		2356	SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
		2357	(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2279		2358
		2359	This option also adds such eye candy as blending an image over the root
		2360	background, as well as dynamic scaling and bluring of background images.
		2361
		2362	Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
		2363	increase by a few megabytes even if no extra features are used (mostly due
		2364	to third-party libraries used by libAI). Memory footprint may somewhat be
		2365	lowered if libAfterImage is configured without support for SVG.
		2366
2280	=item --enable-transparency	2367	=item --enable-transparency (default: on)
2281		2368
2282	Add support for inheriting parent backgrounds thus giving a fake	2369	Add support for backgrounds, creating illusion of transparency in the term.
2283	transparency to the term.
2284		2370
2285	=item --enable-fading	2371	=item --enable-fading (default: on)
2286		2372
2287	Add support for fading the text when focus is lost.	2373	Add support for fading the text when focus is lost.
2288		2374
2289	=item --enable-tinting
2290
2291	Add support for tinting of transparent backgrounds.
2292
2293	=item --enable-menubar
2294
2295	Add support for our menu bar system (this interacts badly with
2296	dynamic locale switching currently).
2297
2298	=item --enable-rxvt-scroll	2375	=item --enable-rxvt-scroll (default: on)
2299		2376
2300	Add support for the original rxvt scrollbar.	2377	Add support for the original rxvt scrollbar.
2301		2378
2302	=item --enable-next-scroll	2379	=item --enable-next-scroll (default: on)
2303		2380
2304	Add support for a NeXT-like scrollbar.	2381	Add support for a NeXT-like scrollbar.
2305		2382
2306	=item --enable-xterm-scroll	2383	=item --enable-xterm-scroll (default: on)
2307		2384
2308	Add support for an Xterm-like scrollbar.	2385	Add support for an Xterm-like scrollbar.
2309		2386
2310	=item --enable-plain-scroll	2387	=item --enable-plain-scroll (default: on)
2311		2388
2312	Add support for a very unobtrusive, plain-looking scrollbar that	2389	Add support for a very unobtrusive, plain-looking scrollbar that
2313	is the favourite of the rxvt-unicode author, having used it for	2390	is the favourite of the rxvt-unicode author, having used it for
2314	many years.	2391	many years.
2315		2392
2316	=item --enable-half-shadow
2317
2318	Make shadows on the scrollbar only half the normal width & height.
2319	only applicable to rxvt scrollbars.
2320
2321	=item --enable-ttygid
2322
2323	Change tty device setting to group "tty" - only use this if
2324	your system uses this type of security.
2325
2326	=item --disable-backspace-key	2393	=item --disable-backspace-key
2327		2394
2328	Disable any handling of the backspace key by us - let the X server	2395	Removes any handling of the backspace key by us - let the X server do it.
		2396
		2397	=item --disable-delete-key
		2398
		2399	Removes any handling of the delete key by us - let the X server
2329	do it.	2400	do it.
2330		2401
2331	=item --disable-delete-key
2332
2333	Disable any handling of the delete key by us - let the X server
2334	do it.
2335
2336	=item --disable-resources	2402	=item --disable-resources
2337		2403
2338	Remove all resources checking.	2404	Removes any support for resource checking.
2339
2340	=item --enable-xgetdefault
2341
2342	Make resources checking via XGetDefault() instead of our small
2343	version which only checks ~/.Xdefaults, or if that doesn't exist then
2344	~/.Xresources.
2345
2346	Please note that nowadays, things like XIM will automatically pull in and
2347	use the full X resource manager, so the overhead of using it might be very
2348	small, if nonexistant.
2349
2350	=item --enable-strings
2351
2352	Add support for our possibly faster memset() function and other
2353	various routines, overriding your system's versions which may
2354	have been hand-crafted in assembly or may require extra libraries
2355	to link in. (this breaks ANSI-C rules and has problems on many
2356	GNU/Linux systems).
2357		2405
2358	=item --disable-swapscreen	2406	=item --disable-swapscreen
2359		2407
2360	Remove support for swap screen.	2408	Remove support for secondary/swap screen.
2361		2409
2362	=item --enable-frills	2410	=item --enable-frills (default: on)
2363		2411
2364	Add support for many small features that are not essential but nice to	2412	Add support for many small features that are not essential but nice to
2365	have. Normally you want this, but for very small binaries you may want to	2413	have. Normally you want this, but for very small binaries you may want to
2366	disable this.	2414	disable this.
2367		2415
2368	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2416	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2369	in combination with other switches) is:	2417	in combination with other switches) is:
2370		2418
2371	MWM-hints	2419	MWM-hints
		2420	EWMH-hints (pid, utf8 names) and protocols (ping)
		2421	urgency hint
2372	seperate underline colour	2422	seperate underline colour (-underlineColor)
2373	settable border widths and borderless switch	2423	settable border widths and borderless switch (-w, -b, -bl)
		2424	visual depth selection (-depth)
2374	settable extra linespacing	2425	settable extra linespacing /-lsp)
2375	extra window properties (e.g. UTF-8 window names and PID)	2426	iso-14755 5.1 (basic) support
2376	iso-14755-2 and -3, and visual feedback
2377	backindex and forwardindex escape sequence
2378	window op and locale change escape sequences
2379	tripleclickwords	2427	tripleclickwords (-tcw)
2380	settable insecure mode	2428	settable insecure mode (-insecure)
2381	keysym remapping support	2429	keysym remapping support
		2430	cursor blinking and underline cursor (-cb, -uc)
		2431	XEmbed support (-embed)
		2432	user-pty (-pty-fd)
		2433	hold on exit (-hold)
		2434	compile in built-in block graphics
		2435	skip builtin block graphics (-sbg)
		2436	separate highlightcolor support (-hc)
2382		2437
		2438	It also enables some non-essential features otherwise disabled, such as:
		2439
		2440	some round-trip time optimisations
		2441	nearest color allocation on pseudocolor screens
		2442	UTF8_STRING support for selection
		2443	sgr modes 90..97 and 100..107
		2444	backindex and forwardindex escape sequences
		2445	view change/zero scrollback escape sequences
		2446	locale switching escape sequence
		2447	window op and some xterm/OSC escape sequences
		2448	rectangular selections
		2449	trailing space removal for selections
		2450	verbose X error handling
		2451
2383	=item --enable-iso14755	2452	=item --enable-iso14755 (default: on)
2384		2453
2385	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2454	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2386	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2455	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2387	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2456	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2388	this switch.	2457	this switch.
2389		2458
2390	=item --enable-keepscrolling	2459	=item --enable-keepscrolling (default: on)
2391		2460
2392	Add support for continual scrolling of the display when you hold	2461	Add support for continual scrolling of the display when you hold
2393	the mouse button down on a scrollbar arrow.	2462	the mouse button down on a scrollbar arrow.
2394		2463
		2464	=item --enable-selectionscrolling (default: on)
		2465
		2466	Add support for scrolling when the selection moves to the top or
		2467	bottom of the screen.
		2468
2395	=item --enable-mousewheel	2469	=item --enable-mousewheel (default: on)
2396		2470
2397	Add support for scrolling via mouse wheel or buttons 4 & 5.	2471	Add support for scrolling via mouse wheel or buttons 4 & 5.
2398		2472
2399	=item --enable-slipwheeling	2473	=item --enable-slipwheeling (default: on)
2400		2474
2401	Add support for continual scrolling (using the mouse wheel as an	2475	Add support for continual scrolling (using the mouse wheel as an
2402	accelerator) while the control key is held down. This option	2476	accelerator) while the control key is held down. This option
2403	requires --enable-mousewheel to also be specified.	2477	requires --enable-mousewheel to also be specified.
2404		2478
2405	=item --disable-new-selection
2406
2407	Remove support for mouse selection style like that of xterm.
2408
2409	=item --enable-dmalloc
2410
2411	Use Gray Watson's malloc - which is good for debugging See
2412	http://www.letters.com/dmalloc/ for details If you use either this or the
2413	next option, you may need to edit src/Makefile after compiling to point
2414	DINCLUDE and DLIB to the right places.
2415
2416	You can only use either this option and the following (should
2417	you use either) .
2418
2419	=item --enable-dlmalloc
2420
2421	Use Doug Lea's malloc - which is good for a production version
2422	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2423
2424	=item --enable-smart-resize	2479	=item --enable-smart-resize (default: off)
2425		2480
2426	Add smart growth/shrink behaviour when changing font size via from hot	2481	Add smart growth/shrink behaviour when resizing.
2427	keys. This should keep in a fixed position the rxvt corner which is	2482	This should keep the window corner which is closest to a corner of
2428	closest to a corner of the screen.	2483	the screen in a fixed position.
2429		2484
2430	=item --enable-cursor-blink	2485	=item --enable-text-blink (default: on)
2431		2486
2432	Add support for a blinking cursor.	2487	Add support for blinking text.
2433		2488
2434	=item --enable-pointer-blank	2489	=item --enable-pointer-blank (default: on)
2435		2490
2436	Add support to have the pointer disappear when typing or inactive.	2491	Add support to have the pointer disappear when typing or inactive.
2437		2492
2438	=item --with-name=NAME	2493	=item --enable-perl (default: on)
2439		2494
		2495	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2496	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
		2497	files in F<src/perl-ext/> for the extensions that are installed by
		2498	default. The perl interpreter that is used can be specified via the
		2499	C<PERL> environment variable when running configure. Even when compiled
		2500	in, perl will I<not> be initialised when all extensions have been disabled
		2501	C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
		2502	resource standpoint.
		2503
		2504	=item --with-afterimage-config=DIR
		2505
		2506	Look for the libAfterImage config script in DIR.
		2507
		2508	=item --with-name=NAME (default: urxvt)
		2509
2440	Set the basename for the installed binaries (default: C<urxvt>, resulting	2510	Set the basename for the installed binaries, resulting
2441	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2511	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2442	C<rxvt>.	2512	C<rxvt>.
2443		2513
2444	=item --with-term=NAME	2514	=item --with-term=NAME (default: rxvt-unicode)
2445		2515
2446	Change the environmental variable for the terminal to NAME (default	2516	Change the environmental variable for the terminal to NAME.
2447	C<rxvt-unicode>)
2448		2517
2449	=item --with-terminfo=PATH	2518	=item --with-terminfo=PATH
2450		2519
2451	Change the environmental variable for the path to the terminfo tree to	2520	Change the environmental variable for the path to the terminfo tree to
2452	PATH.	2521	PATH.
2453		2522
2454	=item --with-x	2523	=item --with-x
2455		2524
2456	Use the X Window System (pretty much default, eh?).	2525	Use the X Window System (pretty much default, eh?).
2457
2458	=item --with-xpm-includes=DIR
2459
2460	Look for the XPM includes in DIR.
2461
2462	=item --with-xpm-library=DIR
2463
2464	Look for the XPM library in DIR.
2465
2466	=item --with-xpm
2467
2468	Not needed - define via --enable-xpm-background.
2469		2526
2470	=back	2527	=back
2471		2528
2472	=head1 AUTHORS	2529	=head1 AUTHORS
2473		2530

Diff Legend

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