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.33 by root, Sun Jan 16 18:48:04 2005 UTC vs.
Revision 1.89 by root, Wed Jan 18 21:00:39 2006 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	RXVT REFERENCE - FAQ, command sequences and other background information	3	RXVT REFERENCE - FAQ, command sequences and other background information
4		4
		5	=head1 SYNOPSIS
		6
		7	# set a new font set
		8	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
		9
		10	# change the locale and tell rxvt-unicode about it
		11	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
		12
		13	# set window title
		14	printf '\33]2;%s\007' "new window title"
		15
		16	=head1 DESCRIPTION
		17
		18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
		19	all escape sequences, and other background information.
		20
		21	The newest version of this document is
		22	also available on the World Wide Web at
		23	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
		24
5	=head1 FREQUENTLY ASKED QUESTIONS	25	=head1 FREQUENTLY ASKED QUESTIONS
6		26
7	=over 4	27	=over 4
8		28
		29	=item The new selection selects pieces that are too big, how can I select
		30	single words?
		31
		32	Yes. For example, if you want to select alphanumeric words, you can use
		33	the following resource:
		34
		35	URxvt.selection.pattern-0: ([[:word:]]+)
		36
		37	If you click more than twice, the selection will be extended
		38	more and more.
		39
		40	To get a selection that is very similar to the old code, try this pattern:
		41
		42	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		43
		44	Please also note that the I<LeftClick Shift-LeftClik> combination also
		45	selects words like the old code.
		46
		47	=item I don't like the new selection/popups/hotkeys/perl, how do I
		48	change/disable it?
		49
		50	You can disable the perl extension completely by setting the
		51	B<perl-ext-common> resource to the empty string, which also keeps
		52	rxvt-unicode from initialising perl, saving memory.
		53
		54	If you only want to disable specific features, you first have to
		55	identify which perl extension is responsible. For this, read the section
		56	B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
		57	example, to disable the B<selection-popup> and B<option-popup>, specify
		58	this B<perl-ext-common> resource:
		59
		60	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		61
		62	This will keep the default extensions, but disable the two popup
		63	extensions. Some extensions can also be configured, for example,
		64	scrollback search mode is triggered by B<M-s>. You can move it to any
		65	other combination either by setting the B<searchable-scrollback> resource:
		66
		67	URxvt.searchable-scrollback: CM-s
		68
		69	=item Isn't rxvt supposed to be small? Don't all those features bloat?
		70
		71	I often get asked about this, and I think, no, they didn't cause extra
		72	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		73	that the urxvt binary is larger (due to some encoding tables always being
		74	compiled in), but it actually uses less memory (RSS) after startup. Even
		75	with C<--disable-everything>, this comparison is a bit unfair, as many
		76	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		77	already in use in this mode.
		78
		79	text data bss drs rss filename
		80	98398 1664 24 15695 1824 rxvt --disable-everything
		81	188985 9048 66616 18222 1788 urxvt --disable-everything
		82
		83	When you C<--enable-everything> (which _is_ unfair, as this involves xft
		84	and full locale/XIM support which are quite bloaty inside libX11 and my
		85	libc), the two diverge, but not unreasnobaly so.
		86
		87	text data bss drs rss filename
		88	163431 2152 24 20123 2060 rxvt --enable-everything
		89	1035683 49680 66648 29096 3680 urxvt --enable-everything
		90
		91	The very large size of the text section is explained by the east-asian
		92	encoding tables, which, if unused, take up disk space but nothing else
		93	and can be compiled out unless you rely on X11 core fonts that use those
		94	encodings. The BSS size comes from the 64k emergency buffer that my c++
		95	compiler allocates (but of course doesn't use unless you are out of
		96	memory). Also, using an xft font instead of a core font immediately adds a
		97	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		98	not used.
		99
		100	Of course, due to every character using two or four bytes instead of one,
		101	a large scrollback buffer will ultimately make rxvt-unicode use more
		102	memory.
		103
		104	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		105	still fares rather well. And compared to some monsters like gnome-terminal
		106	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		107	43180k in daemons that stay around after exit, plus half a minute of
		108	startup time, including the hundreds of warnings it spits out), it fares
		109	extremely well *g*.
		110
		111	=item Why C++, isn't that unportable/bloated/uncool?
		112
		113	Is this a question? :) It comes up very often. The simple answer is: I had
		114	to write it, and C++ allowed me to write and maintain it in a fraction
		115	of the time and effort (which is a scarce resource for me). Put even
		116	shorter: It simply wouldn't exist without C++.
		117
		118	My personal stance on this is that C++ is less portable than C, but in
		119	the case of rxvt-unicode this hardly matters, as its portability limits
		120	are defined by things like X11, pseudo terminals, locale support and unix
		121	domain sockets, which are all less portable than C++ itself.
		122
		123	Regarding the bloat, see the above question: It's easy to write programs
		124	in C that use gobs of memory, an certainly possible to write programs in
		125	C++ that don't. C++ also often comes with large libraries, but this is
		126	not necessarily the case with GCC. Here is what rxvt links against on my
		127	system with a minimal config:
		128
		129	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		130	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		131	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		132	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		133
		134	And here is rxvt-unicode:
		135
		136	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		137	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		138	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		139	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		140	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		141
		142	No large bloated libraries (of course, none were linked in statically),
		143	except maybe libX11 :)
		144
		145	=item Does it support tabs, can I have a tabbed rxvt-unicode?
		146
		147	rxvt-unicode does not directly support tabs. It will work fine with
		148	tabbing functionality of many window managers or similar tabbing programs,
		149	and its embedding-features allow it to be embedded into other programs,
		150	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
		151	module, which features a tabbed urxvt (murxvt) terminal as an example
		152	embedding application.
		153
9	=item How do I know which rxvt-unicode version I'm using?	154	=item How do I know which rxvt-unicode version I'm using?
10		155
11	The version number is displayed with the usage (-h). Also the escape	156	The version number is displayed with the usage (-h). Also the escape
12	sequence C<ESC[8n> sets the window title to the version number.	157	sequence C<ESC [ 8 n> sets the window title to the version number. When
		158	using the @@RXVT_NAME@@c client, the version displayed is that of the
		159	daemon.
		160
		161	=item I am using Debian GNU/Linux and have a problem...
		162
		163	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		164	patches that considerably change the behaviour of rxvt-unicode (but
		165	unfortunately this notice has been removed). Before reporting a bug to
		166	the original rxvt-unicode author please download and install the genuine
		167	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		168	the problem. If you cannot, chances are that the problems are specific to
		169	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		170	Tracking System (use C<reportbug> to report the bug).
		171
		172	For other problems that also affect the Debian package, you can and
		173	probably should use the Debian BTS, too, because, after all, it's also a
		174	bug in the Debian version and it serves as a reminder for other users that
		175	might encounter the same issue.
		176
		177	=item I am maintaining rxvt-unicode for distribution/OS XXX, any
		178	recommendation?
		179
		180	You should build one binary with the default options. F<configure>
		181	now enables most useful options, and the trend goes to making them
		182	runtime-switchable, too, so there is usually no drawback to enbaling them,
		183	except higher disk and possibly memory usage. The perl interpreter should
		184	be enabled, as important functionality (menus, selection, likely more in
		185	the future) depends on it.
		186
		187	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		188	system-wide (except maybe with C<defaults>). This will result in useful
		189	behaviour. If your distribution aims at low memory, add an empty
		190	C<perl-ext-common> resource to the app-defaults file. This will keep the
		191	perl interpreter disabled until the user enables it.
		192
		193	If you can/want build more binaries, I recommend building a minimal
		194	one with C<--disable-everything> (very useful) and a maximal one with
		195	C<--enable-everything> (less useful, it will be very big due to a lot of
		196	encodings built-in that increase download times and are rarely used).
		197
		198	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		199
		200	It should be, starting with release 7.1. You are encouraged to properly
		201	install urxvt with privileges necessary for your OS now.
		202
		203	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		204	into a helper process for privileged operations (pty handling on some
		205	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		206	immediately. This is much safer than most other terminals that keep
		207	privileges while running (but is more relevant to urxvt, as it contains
		208	things as perl interpreters, which might be "helpful" to attackers).
		209
		210	This forking is done as the very first within main(), which is very early
		211	and reduces possible bugs to initialisation code run before main(), or
		212	things like the dynamic loader of your system, which should result in very
		213	little risk.
13		214
14	=item When I log-in to another system it tells me about missing terminfo data?	215	=item When I log-in to another system it tells me about missing terminfo data?
15		216
16	The terminal description used by rxvt-unicode is not as widely available	217	The terminal description used by rxvt-unicode is not as widely available
17	as that for xterm, or even rxvt (for which the same problem often arises).	218	as that for xterm, or even rxvt (for which the same problem often arises).
…		…
28	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of	229	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29	problems arising, which includes wrong keymapping, less and different	230	problems arising, which includes wrong keymapping, less and different
30	colours and some refresh errors in fullscreen applications. It's a nice	231	colours and some refresh errors in fullscreen applications. It's a nice
31	quick-and-dirty workaround for rare cases, though.	232	quick-and-dirty workaround for rare cases, though.
32		233
33	If you always want to do this you can either recompile rxvt-unicode with	234	If you always want to do this (and are fine with the consequences) you
34	the desired TERM value or use a resource to set it:	235	can either recompile rxvt-unicode with the desired TERM value or use a
		236	resource to set it:
35		237
36	URxvt.termName: rxvt	238	URxvt.termName: rxvt
37		239
38	If you don't plan to use B<rxvt> (quite common...) you could also replace	240	If you don't plan to use B<rxvt> (quite common...) you could also replace
39	the rxvt terminfo file with the rxvt-unicode one.	241	the rxvt terminfo file with the rxvt-unicode one.
40		242
		243	=item C<tic> outputs some error when compiling the terminfo entry.
		244
		245	Most likely it's the empty definition for C<enacs=>. Just replace it by
		246	C<enacs=\E[0@> and try again.
		247
		248	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
		249
41	=item I need a termcap file entry.	250	=item I need a termcap file entry.
		251
		252	One reason you might want this is that some distributions or operating
		253	systems still compile some programs using the long-obsoleted termcap
		254	library (Fedora Core's bash is one example) and rely on a termcap entry
		255	for C<rxvt-unicode>.
42		256
43	You could use rxvt's termcap entry with resonable results in many cases.	257	You could use rxvt's termcap entry with resonable results in many cases.
44	You can also create a termcap entry by using terminfo's infocmp program	258	You can also create a termcap entry by using terminfo's infocmp program
45	like this:	259	like this:
46		260
47	infocmp -C rxvt-unicode	261	infocmp -C rxvt-unicode
48		262
49	OR you could this termcap entry:	263	Or you could use this termcap entry, generated by the command above:
50		264
51	rxvt-unicode|rxvt-unicode terminal (X Window System):\	265	rxvt-unicode|rxvt-unicode terminal (X Window System):\
52	:am:bw:eo:km:mi:ms:xn:xo:\	266	:am:bw:eo:km:mi:ms:xn:xo:\
53	:co#80:it#8:li#24:\	267	:co#80:it#8:li#24:lm#0:\
54	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\	268	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\	269	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\	270	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
57	:as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\	271	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
58	:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\	272	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
59	:ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\	273	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		274	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
60	:im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\	275	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61	:k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\	276	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
62	:k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\	277	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
63	:kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\	278	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
64	:ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\	279	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
65	:ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\	280	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
66	:nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\	281	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
67	:st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\	282	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
68	:up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\	283	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69	:vs=\E[?25h:	284	:vs=\E[?25h:
70		285
71	=item Why does C<ls> no longer have coloured output?	286	=item Why does C<ls> no longer have coloured output?
72		287
73	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to	288	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
…		…
96	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo	311	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
97	file, so you will need to install it on your own (See the question B<When	312	file, so you will need to install it on your own (See the question B<When
98	I log-in to another system it tells me about missing terminfo data?> on	313	I log-in to another system it tells me about missing terminfo data?> on
99	how to do this).	314	how to do this).
100		315
		316	=item My numerical keypad acts weird and generates differing output?
		317
		318	Some Debian GNUL/Linux users seem to have this problem, although no
		319	specific details were reported so far. It is possible that this is caused
		320	by the wrong C<TERM> setting, although the details of wether and how
		321	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		322	keymap. See the answer to the previous question, and please report if that
		323	helped.
		324
101	=item Rxvt-unicode does not seem to understand the selected encoding?	325	=item Rxvt-unicode does not seem to understand the selected encoding?
102		326
103	=item Unicode does not seem to work?	327	=item Unicode does not seem to work?
104		328
105	If you encounter strange problems like typing an accented character but	329	If you encounter strange problems like typing an accented character but
…		…
107	subtly garbled, then you should check your locale settings.	331	subtly garbled, then you should check your locale settings.
108		332
109	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the	333	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
110	programs. Often rxvt-unicode is started in the C<C> locale, while the	334	programs. Often rxvt-unicode is started in the C<C> locale, while the
111	login script running within the rxvt-unicode window changes the locale to	335	login script running within the rxvt-unicode window changes the locale to
112	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.	336	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
113		337
114	The best thing is to fix your startup environment, as you will likely run	338	The best thing is to fix your startup environment, as you will likely run
115	into other problems. If nothing works you can try this in your .profile.	339	into other problems. If nothing works you can try this in your .profile.
116		340
117	printf '\e]701;%s\007' "$LC_CTYPE"	341	printf '\e]701;%s\007' "$LC_CTYPE"
118		342
119	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not	343	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
120	supported on your systems. Some systems have a C<locale> command which	344	supported on your systems. Some systems have a C<locale> command which
121	displays this. If it displays sth. like:	345	displays this (also, C<perl -e0> can be used to check locale settings, as
		346	it will complain loudly if it cannot set the locale). If it displays something
		347	like:
122		348
123	locale: Cannot set LC_CTYPE to default locale: ...	349	locale: Cannot set LC_CTYPE to default locale: ...
124		350
125	Then the locale you specified is not supported on your system.	351	Then the locale you specified is not supported on your system.
126		352
…		…
137	your system/os) have specified does not cover all the characters you want	363	your system/os) have specified does not cover all the characters you want
138	to display.	364	to display.
139		365
140	B<rxvt-unicode> makes a best-effort try at finding a replacement	366	B<rxvt-unicode> makes a best-effort try at finding a replacement
141	font. Often the result is fine, but sometimes the chosen font looks	367	font. Often the result is fine, but sometimes the chosen font looks
142	bad. Many fonts have totally strange characters that don't resemble the	368	bad/ugly/wrong. Some fonts have totally strange characters that don't
143	correct glyph at all, and rxvt-unicode lacks the artificial intelligence	369	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
144	to detect that a specific glyph is wrong: it has to believe the font that	370	intelligence to detect that a specific glyph is wrong: it has to believe
145	the characters it contains indeed look correct.	371	the font that the characters it claims to contain indeed look correct.
146		372
147	In that case, select a font of your taste and add it to the font list,	373	In that case, select a font of your taste and add it to the font list,
148	e.g.:	374	e.g.:
149		375
150	@@RXVT_NAME@@ -fn basefont,font2,font3...	376	@@RXVT_NAME@@ -fn basefont,font2,font3...
…		…
152	When rxvt-unicode sees a character, it will first look at the base	378	When rxvt-unicode sees a character, it will first look at the base
153	font. If the base font does not contain the character, it will go to the	379	font. If the base font does not contain the character, it will go to the
154	next font, and so on. Specifying your own fonts will also speed up this	380	next font, and so on. Specifying your own fonts will also speed up this
155	search and use less resources within rxvt-unicode and the X-server.	381	search and use less resources within rxvt-unicode and the X-server.
156		382
157	The only limitation is that all the fonts must not be larger than the base	383	The only limitation is that none of the fonts may be larger than the base
158	font, as the base font defines the principal cell size, which must be the	384	font, as the base font defines the terminal character cell size, which
159	same due to the way terminals work.	385	must be the same due to the way terminals work.
160		386
161	=item Why do some chinese characters look so different than others?	387	=item Why do some chinese characters look so different than others?
162		388
163	This is because there is a difference between script and language --	389	This is because there is a difference between script and language --
164	rxvt-unicode does not know which language the text that is output	390	rxvt-unicode does not know which language the text that is output is,
165	is, as it only knows the unicode character codes. If rxvt-unicode	391	as it only knows the unicode character codes. If rxvt-unicode first
166	first sees a japanese character, it might choose a japanese font for	392	sees a japanese/chinese character, it might choose a japanese font for
167	it. Subsequent japanese characters will take that font. Now, many chinese	393	display. Subsequent japanese characters will use that font. Now, many
168	characters aren't represented in japanese fonts, so when the first	394	chinese characters aren't represented in japanese fonts, so when the first
169	non-japanese character comes up, rxvt-unicode will look for a chinese font	395	non-japanese character comes up, rxvt-unicode will look for a chinese font
170	-- unfortunately at this point, it will still use the japanese font for	396	-- unfortunately at this point, it will still use the japanese font for
171	japanese characters that are also chinese.	397	chinese characters that are also in the japanese font.
172		398
173	The workaround is easy: just tag a chinese font at the end of your font	399	The workaround is easy: just tag a chinese font at the end of your font
174	list (see the previous question). The key is to view the font list as	400	list (see the previous question). The key is to view the font list as
175	a preference list: If you expect more japanese, list a japanese font	401	a preference list: If you expect more japanese, list a japanese font
176	first. If you expect more chinese, put a chinese font first.	402	first. If you expect more chinese, put a chinese font first.
177		403
178	In the future it might be possible to switch preferences at runtime (the	404	In the future it might be possible to switch language preferences at
179	internal data structure has no problem with using different fonts for	405	runtime (the internal data structure has no problem with using different
180	the same character at the same time, but no interface for this has been	406	fonts for the same character at the same time, but no interface for this
181	designed yet).	407	has been designed yet).
		408
		409	Until then, you might get away with switching fonts at runtime (see L<Can
		410	I switch the fonts at runtime?> later in this document).
182		411
183	=item Why does rxvt-unicode sometimes leave pixel droppings?	412	=item Why does rxvt-unicode sometimes leave pixel droppings?
184		413
185	Most fonts were not designed for terminal use, which means that character	414	Most fonts were not designed for terminal use, which means that character
186	size varies a lot. A font that is otherwise fine for terminal use might	415	size varies a lot. A font that is otherwise fine for terminal use might
…		…
199	the C<-lsp> option to give the font more height. If that doesn't work, you	428	the C<-lsp> option to give the font more height. If that doesn't work, you
200	might be forced to use a different font.	429	might be forced to use a different font.
201		430
202	All of this is not a problem when using X11 core fonts, as their bounding	431	All of this is not a problem when using X11 core fonts, as their bounding
203	box data is correct.	432	box data is correct.
		433
		434	=item On Solaris 9, many line-drawing characters are too wide.
		435
		436	Seems to be a known bug, read
		437	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		438	following ugly workaround to get non-double-wide-characters working:
		439
		440	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
204		441
205	=item My Compose (Multi_key) key is no longer working.	442	=item My Compose (Multi_key) key is no longer working.
206		443
207	The most common causes for this are that either your locale is not set	444	The most common causes for this are that either your locale is not set
208	correctly, or you specified a B<preeditStyle> that is not supported by	445	correctly, or you specified a B<preeditStyle> that is not supported by
…		…
222	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape	459	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
223	character and so on.	460	character and so on.
224		461
225	=item How can I keep rxvt-unicode from using reverse video so much?	462	=item How can I keep rxvt-unicode from using reverse video so much?
226		463
227	First of all, make sure you are running with the right terminfo	464	First of all, make sure you are running with the right terminal settings
228	(C<urxvt>), which will get rid of most of these effects. Then make sure	465	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
229	you have specified colours for italic and bold, as otherwise rxvt-unicode	466	make sure you have specified colours for italic and bold, as otherwise
230	might use reverse video to simulate the effect:	467	rxvt-unicode might use reverse video to simulate the effect:
231		468
232	URxvt*colorBD: white	469	URxvt.colorBD: white
233	URxvt*colorIT: green	470	URxvt.colorIT: green
234		471
235	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?	472	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
236		473
237	For some unexplainable reason, some programs (i.e. irssi) assume a very	474	For some unexplainable reason, some rare programs assume a very weird
238	weird colour palette when confronted with a terminal with more than the	475	colour palette when confronted with a terminal with more than the standard
239	standard 8 colours (rxvt-unicode supports 88). The right fix is, of	476	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
240	course, to fix these programs not to assume non-ISO colours without very	477	these programs not to assume non-ISO colours without very good reasons.
241	good reasons.
242		478
243	In the meantime, you can either edit your C<urxvt> terminfo definition to	479	In the meantime, you can either edit your C<rxvt-unicode> terminfo
244	only claim 8 colour support or use C<TERM=rxvt>, which will fix colours	480	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
245	but keep you from using other rxvt-unicode features.	481	fix colours but keep you from using other rxvt-unicode features.
246		482
247	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.	483	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
248		484
249	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined	485	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
250	in your compile environment, or an implementation that implements it,	486	in your compile environment, or an implementation that implements it,
251	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that	487	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
252	B<wchar_t> is represented as unicode.	488	B<wchar_t> is represented as unicode.
253		489
254	As you might have guessed, FreeBSD does neither define this symobl nor	490	As you might have guessed, FreeBSD does neither define this symobl nor
255	does it support it. Instead, it uses it's own internal representation of	491	does it support it. Instead, it uses it's own internal representation of
256	B<wchar_t>. This is, of course, completely legal.	492	B<wchar_t>. This is, of course, completely fine with respect to standards.
257		493
		494	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		495	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		496
258	However, C<__STDC_ISO_10646__> is the only sane way to support	497	C<__STDC_ISO_10646__> is the only sane way to support multi-language
259	multi-language apps in an OS, as using a locale-dependent (and	498	apps in an OS, as using a locale-dependent (and non-standardized)
260	non-standardized) representation of B<wchar_t> makes it impossible to	499	representation of B<wchar_t> makes it impossible to convert between
261	convert between B<wchar_t> (as used by X11 and your applications) and any	500	B<wchar_t> (as used by X11 and your applications) and any other encoding
262	other encoding without implementing OS-specific-wrappers for each and	501	without implementing OS-specific-wrappers for each and every locale. There
263	every locale. There simply are no APIs to convert B<wchar_t> into anything	502	simply are no APIs to convert B<wchar_t> into anything except the current
264	except the current locale encoding.	503	locale encoding.
265		504
266	Some applications (such as the formidable B<mlterm>) work around this	505	Some applications (such as the formidable B<mlterm>) work around this
267	by carrying their own replacement functions for character set handling	506	by carrying their own replacement functions for character set handling
268	with them, and either implementing OS-dependent hacks or doing multiple	507	with them, and either implementing OS-dependent hacks or doing multiple
269	conversions (which is slow and unreliable in case the OS implements	508	conversions (which is slow and unreliable in case the OS implements
270	encodings slightly different than the terminal emulator).	509	encodings slightly different than the terminal emulator).
271		510
272	The rxvt-unicode author insists that the right way to fix this is in the	511	The rxvt-unicode author insists that the right way to fix this is in the
273	system libraries once and for all, instead of forcing every app to carry	512	system libraries once and for all, instead of forcing every app to carry
274	complete replacements.	513	complete replacements for them :)
		514
		515	=item I use Solaris 9 and it doesn't compile/work/etc.
		516
		517	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		518	problems with C<wcwidth> and a compile problem.
		519
		520	=item How can I use rxvt-unicode under cygwin?
		521
		522	rxvt-unicode should compile and run out of the box on cygwin, using
		523	the X11 libraries that come with cygwin. libW11 emulation is no
		524	longer supported (and makes no sense, either, as it only supported a
		525	single font). I recommend starting the X-server in C<-multiwindow> or
		526	C<-rootless> mode instead, which will result in similar look&feel as the
		527	old libW11 emulation.
		528
		529	At the time of this writing, cygwin didn't seem to support any multi-byte
		530	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		531	to 8-bit encodings.
275		532
276	=item How does rxvt-unicode determine the encoding to use?	533	=item How does rxvt-unicode determine the encoding to use?
277		534
278	=item Is there an option to switch encodings?	535	=item Is there an option to switch encodings?
279		536
…		…
281	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about	538	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
282	UTF-8 or any other encodings with respect to terminal I/O.	539	UTF-8 or any other encodings with respect to terminal I/O.
283		540
284	The reasons is that there exists a perfectly fine mechanism for selecting	541	The reasons is that there exists a perfectly fine mechanism for selecting
285	the encoding, doing I/O and (most important) communicating this to all	542	the encoding, doing I/O and (most important) communicating this to all
286	applications so everybody agrees on character properties such as width and	543	applications so everybody agrees on character properties such as width
287	code number. This mechanism is the I<locale>.	544	and code number. This mechanism is the I<locale>. Applications not using
		545	that info will have problems (for example, C<xterm> gets the width of
		546	characters wrong as it uses it's own, locale-independent table under all
		547	locales).
288		548
289	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All	549	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
290	programs doing the same (that is, most) will automatically agree in the	550	programs doing the same (that is, most) will automatically agree in the
291	interpretation of characters.	551	interpretation of characters.
292		552
…		…
299	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms	559	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
300	(i.e. C<de> or C<german>) are also common.	560	(i.e. C<de> or C<german>) are also common.
301		561
302	Rxvt-unicode ignores all other locale categories, and except for	562	Rxvt-unicode ignores all other locale categories, and except for
303	the encoding, ignores country or language-specific settings,	563	the encoding, ignores country or language-specific settings,
304	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.	564	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		565	rxvt-unicode.
305		566
306	If you want to use a specific encoding you have to make sure you start	567	If you want to use a specific encoding you have to make sure you start
307	rxvt-unicode with the correct C<LC_CTYPE> category.	568	rxvt-unicode with the correct C<LC_CTYPE> category.
308		569
309	=item Can I switch locales at runtime?	570	=item Can I switch locales at runtime?
310		571
311	Yes, using an escape sequence. Try sth. like this, which sets	572	Yes, using an escape sequence. Try something like this, which sets
312	rxvt-unicode's idea of C<LC_CTYPE>.	573	rxvt-unicode's idea of C<LC_CTYPE>.
313		574
314	printf '\e]701;%s\007' ja_JP.SJIS	575	printf '\e]701;%s\007' ja_JP.SJIS
315		576
316	See also the previous question.	577	See also the previous answer.
317		578
318	Sometimes this capability is rather handy when you want to work in one	579	Sometimes this capability is rather handy when you want to work in
319	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For	580	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
320	example, I use this script to start C<xjdic>, which first switches to a	581	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
321	locale supported by xjdic and back later:	582	first switches to a locale supported by xjdic and back later:
322		583
323	printf '\e]701;%s\007' ja_JP.SJIS	584	printf '\e]701;%s\007' ja_JP.SJIS
324	xjdic -js	585	xjdic -js
325	printf '\e]701;%s\007' de_DE.UTF-8	586	printf '\e]701;%s\007' de_DE.UTF-8
326		587
		588	You can also use xterm's C<luit> program, which usually works fine, except
		589	for some locales where character width differs between program- and
		590	rxvt-unicode-locales.
		591
327	=item Can I switch the fonts at runtime?	592	=item Can I switch the fonts at runtime?
328		593
329	Yes, using an escape sequence. Try sth. like this, which has the same	594	Yes, using an escape sequence. Try something like this, which has the same
330	effect as using the C<-fn> switch, and takes effect immediately:	595	effect as using the C<-fn> switch, and takes effect immediately:
331		596
332	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"	597	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
333		598
334	This is useful if you e.g. work primarily with japanese (and prefer a	599	This is useful if you e.g. work primarily with japanese (and prefer a
…		…
339		604
340	=item Why do italic characters look as if clipped?	605	=item Why do italic characters look as if clipped?
341		606
342	Many fonts have difficulties with italic characters and hinting. For	607	Many fonts have difficulties with italic characters and hinting. For
343	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans	608	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
344	Mono> completely fails in it's italic face. A workaround is to enable	609	Mono> completely fails in it's italic face. A workaround might be to
345	freetype autohinting, i.e. like this:	610	enable freetype autohinting, i.e. like this:
346		611
347	URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true	612	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
348	URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true	613	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
349		614
350	=item My input method wants <some encoding> but I want UTF-8, what can I do?	615	=item My input method wants <some encoding> but I want UTF-8, what can I do?
351		616
352	You can specify separate locales for the input method and the rest of the	617	You can specify separate locales for the input method and the rest of the
353	terminal, using the resource C<imlocale>:	618	terminal, using the resource C<imlocale>:
354		619
355	URxvt*imlocale: ja_JP.EUC-JP	620	URxvt.imlocale: ja_JP.EUC-JP
356		621
357	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	622	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
358	use your input method. Please note, however, that you will not be able to	623	use your input method. Please note, however, that you will not be able to
359	input characters outside C<EUC-JP> in a normal way then, as your input	624	input characters outside C<EUC-JP> in a normal way then, as your input
360	method limits you.	625	method limits you.
361		626
		627	=item Rxvt-unicode crashes when the X Input Method changes or exits.
		628
		629	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		630	design. Applications can avoid some crashes at the expense of memory
		631	leaks, and Input Methods can avoid some crashes by careful ordering at
		632	exit time. B<kinput2> (and derived input methods) generally succeeds,
		633	while B<SCIM> (or similar input methods) fails. In the end, however,
		634	crashes cannot be completely avoided even if both sides cooperate.
		635
		636	So the only workaround is not to kill your Input Method Servers.
		637
362	=item Rxvt-unicode uses gobs of memory, how can I reduce that?	638	=item Rxvt-unicode uses gobs of memory, how can I reduce that?
363		639
364	Rxvt-unicode tries to obey the rule of not charging you for sth. you	640	Rxvt-unicode tries to obey the rule of not charging you for something you
365	don't use. One thing you should try is to configure out all settings that	641	don't use. One thing you should try is to configure out all settings that
366	you don't need, for example, Xft support is a resource hog by design,	642	you don't need, for example, Xft support is a resource hog by design,
367	when used. Compiling it out ensures that no Xft font will be loaded	643	when used. Compiling it out ensures that no Xft font will be loaded
368	accidentally when rxvt-unicode tries to find a font for your characters.	644	accidentally when rxvt-unicode tries to find a font for your characters.
369		645
…		…
376		652
377	=item Can I speed up Xft rendering somehow?	653	=item Can I speed up Xft rendering somehow?
378		654
379	Yes, the most obvious way to speed it up is to avoid Xft entirely, as	655	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
380	it is simply slow. If you still want Xft fonts you might try to disable	656	it is simply slow. If you still want Xft fonts you might try to disable
381	antialiasing (by appending C<:antialiasing=false>), which saves lots of	657	antialiasing (by appending C<:antialias=false>), which saves lots of
382	memory and also speeds up rendering considerably.	658	memory and also speeds up rendering considerably.
383		659
384	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?	660	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
385		661
386	Rxvt-unicode will use whatever you specify as a font. If it needs to	662	Rxvt-unicode will use whatever you specify as a font. If it needs to
…		…
395		671
396	Make sure that mouse reporting is actually turned off since killing	672	Make sure that mouse reporting is actually turned off since killing
397	some editors prematurely may leave the mouse in mouse report mode. I've	673	some editors prematurely may leave the mouse in mouse report mode. I've
398	heard that tcsh may use mouse reporting unless it otherwise specified. A	674	heard that tcsh may use mouse reporting unless it otherwise specified. A
399	quick check is to see if cut/paste works when the Alt or Shift keys are	675	quick check is to see if cut/paste works when the Alt or Shift keys are
400	depressed. See @@RXVT_NAME@@(7)	676	depressed.
401		677
402	=item What's with this bold/blink stuff?	678	=item What's with this bold/blink stuff?
403		679
404	If no bold colour is set via C<colorBD:>, bold will invert text using the	680	If no bold colour is set via C<colorBD:>, bold will invert text using the
405	standard foreground colour.	681	standard foreground colour.
…		…
422	resources (or as long-options).	698	resources (or as long-options).
423		699
424	Here are values that are supposed to resemble a VGA screen,	700	Here are values that are supposed to resemble a VGA screen,
425	including the murky brown that passes for low-intensity yellow:	701	including the murky brown that passes for low-intensity yellow:
426		702
427	URxvt*color0: #000000	703	URxvt.color0: #000000
428	URxvt*color1: #A80000	704	URxvt.color1: #A80000
429	URxvt*color2: #00A800	705	URxvt.color2: #00A800
430	URxvt*color3: #A8A800	706	URxvt.color3: #A8A800
431	URxvt*color4: #0000A8	707	URxvt.color4: #0000A8
432	URxvt*color5: #A800A8	708	URxvt.color5: #A800A8
433	URxvt*color6: #00A8A8	709	URxvt.color6: #00A8A8
434	URxvt*color7: #A8A8A8	710	URxvt.color7: #A8A8A8
435		711
436	URxvt*color8: #000054	712	URxvt.color8: #000054
437	URxvt*color9: #FF0054	713	URxvt.color9: #FF0054
438	URxvt*color10: #00FF54	714	URxvt.color10: #00FF54
439	URxvt*color11: #FFFF54	715	URxvt.color11: #FFFF54
440	URxvt*color12: #0000FF	716	URxvt.color12: #0000FF
441	URxvt*color13: #FF00FF	717	URxvt.color13: #FF00FF
442	URxvt*color14: #00FFFF	718	URxvt.color14: #00FFFF
443	URxvt*color15: #FFFFFF	719	URxvt.color15: #FFFFFF
444		720
445	And here is a more complete set of non-standard colors described as	721	And here is a more complete set of non-standard colors described (not by
446	"pretty girly":	722	me) as "pretty girly".
447		723
448	URxvt.cursorColor: #dc74d1	724	URxvt.cursorColor: #dc74d1
449	URxvt.pointerColor: #dc74d1	725	URxvt.pointerColor: #dc74d1
450	URxvt.background: #0e0e0e	726	URxvt.background: #0e0e0e
451	URxvt.foreground: #4ad5e1	727	URxvt.foreground: #4ad5e1
…		…
462	URxvt.color6: #73f7ff	738	URxvt.color6: #73f7ff
463	URxvt.color14: #73f7ff	739	URxvt.color14: #73f7ff
464	URxvt.color7: #e1dddd	740	URxvt.color7: #e1dddd
465	URxvt.color15: #e1dddd	741	URxvt.color15: #e1dddd
466		742
		743	=item How can I start @@RXVT_NAME@@d in a race-free way?
		744
		745	Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
		746	display, create the listening socket and then fork.
		747
467	=item What's with the strange Backspace/Delete key behaviour?	748	=item What's with the strange Backspace/Delete key behaviour?
468		749
469	Assuming that the physical Backspace key corresponds to the	750	Assuming that the physical Backspace key corresponds to the
470	BackSpace keysym (not likely for Linux ... see the following	751	BackSpace keysym (not likely for Linux ... see the following
471	question) there are two standard values that can be used for	752	question) there are two standard values that can be used for
…		…
489		770
490	# use Backspace = ^?	771	# use Backspace = ^?
491	$ stty erase ^?	772	$ stty erase ^?
492	$ @@RXVT_NAME@@	773	$ @@RXVT_NAME@@
493		774
494	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).	775	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
495		776
496	For an existing rxvt-unicode:	777	For an existing rxvt-unicode:
497		778
498	# use Backspace = ^H	779	# use Backspace = ^H
499	$ stty erase ^H	780	$ stty erase ^H
…		…
508	properly reflects that.	789	properly reflects that.
509		790
510	The Delete key is a another casualty of the ill-defined Backspace problem.	791	The Delete key is a another casualty of the ill-defined Backspace problem.
511	To avoid confusion between the Backspace and Delete keys, the Delete	792	To avoid confusion between the Backspace and Delete keys, the Delete
512	key has been assigned an escape sequence to match the vt100 for Execute	793	key has been assigned an escape sequence to match the vt100 for Execute
513	(ESC[3~) and is in the supplied termcap/terminfo.	794	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
514		795
515	Some other Backspace problems:	796	Some other Backspace problems:
516		797
517	some editors use termcap/terminfo,	798	some editors use termcap/terminfo,
518	some editors (vim I'm told) expect Backspace = ^H,	799	some editors (vim I'm told) expect Backspace = ^H,
…		…
524		805
525	There are some compile-time selections available via configure. Unless	806	There are some compile-time selections available via configure. Unless
526	you have run "configure" with the C<--disable-resources> option you can	807	you have run "configure" with the C<--disable-resources> option you can
527	use the `keysym' resource to alter the keystrings associated with keysyms.	808	use the `keysym' resource to alter the keystrings associated with keysyms.
528		809
529	Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt'	810	Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
530		811
531	URxvt*keysym.Home: \e[1~	812	URxvt.keysym.Home: \033[1~
532	URxvt*keysym.End: \e[4~	813	URxvt.keysym.End: \033[4~
533	URxvt*keysym.C-apostrophe: \e<C-'>	814	URxvt.keysym.C-apostrophe: \033<C-'>
534	URxvt*keysym.C-slash: \e<C-/>	815	URxvt.keysym.C-slash: \033<C-/>
535	URxvt*keysym.C-semicolon: \e<C-;>	816	URxvt.keysym.C-semicolon: \033<C-;>
536	URxvt*keysym.C-grave: \e<C-`>	817	URxvt.keysym.C-grave: \033<C-`>
537	URxvt*keysym.C-comma: \e<C-,>	818	URxvt.keysym.C-comma: \033<C-,>
538	URxvt*keysym.C-period: \e<C-.>	819	URxvt.keysym.C-period: \033<C-.>
539	URxvt*keysym.C-0x60: \e<C-`>	820	URxvt.keysym.C-0x60: \033<C-`>
540	URxvt*keysym.C-Tab: \e<C-Tab>	821	URxvt.keysym.C-Tab: \033<C-Tab>
541	URxvt*keysym.C-Return: \e<C-Return>	822	URxvt.keysym.C-Return: \033<C-Return>
542	URxvt*keysym.S-Return: \e<S-Return>	823	URxvt.keysym.S-Return: \033<S-Return>
543	URxvt*keysym.S-space: \e<S-Space>	824	URxvt.keysym.S-space: \033<S-Space>
544	URxvt*keysym.M-Up: \e<M-Up>	825	URxvt.keysym.M-Up: \033<M-Up>
545	URxvt*keysym.M-Down: \e<M-Down>	826	URxvt.keysym.M-Down: \033<M-Down>
546	URxvt*keysym.M-Left: \e<M-Left>	827	URxvt.keysym.M-Left: \033<M-Left>
547	URxvt*keysym.M-Right: \e<M-Right>	828	URxvt.keysym.M-Right: \033<M-Right>
548	URxvt*keysym.M-C-0: list.0123456789.\e<M-C-.>	829	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
549	URxvt*keysym.M-C-a: list.abcdefghijklmnopqrstuvwxyz.\033<M-C-.>	830	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
550	URxvt*keysym.F12: proto:\033]701;zh_CN.GBK\007	831	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
		832
		833	See some more examples in the documentation for the B<keysym> resource.
551		834
552	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.	835	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
553	How do I make use of them? For example, the Sun Keyboard type 4	836	How do I make use of them? For example, the Sun Keyboard type 4
554	has the following mappings that rxvt-unicode doesn't recognize.	837	has the following mappings that rxvt-unicode doesn't recognize.
555		838
…		…
558	F27 == Home	841	F27 == Home
559	F29 == Prior	842	F29 == Prior
560	F33 == End	843	F33 == End
561	F35 == Next	844	F35 == Next
562		845
563	Rather than have rxvt-unicode try to accommodate all the various possible keyboard	846	Rather than have rxvt-unicode try to accommodate all the various possible
564	mappings, it is better to use `xmodmap' to remap the keys as required for	847	keyboard mappings, it is better to use `xmodmap' to remap the keys as
565	your particular machine.	848	required for your particular machine.
566		849
567	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?	850	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
568	I need this to decide about setting colors etc.	851	I need this to decide about setting colors etc.
569		852
570	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can	853	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
571	check and see if that is set. Note that several programs, JED, slrn,	854	check and see if that is set. Note that several programs, JED, slrn,
572	Midnight Commander automatically check this variable to decide whether or	855	Midnight Commander automatically check this variable to decide whether or
…		…
609	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be	892	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
610	interested in learning about new and exciting problems (but not FAQs :).	893	interested in learning about new and exciting problems (but not FAQs :).
611		894
612	=back	895	=back
613		896
614	=head1 SYNOPSIS	897	=head1 RXVT TECHNICAL REFERENCE
615
616	# set a new font set
617	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
618
619	# change the locale and tell rxvt-unicode about it
620	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
621
622	# set window title
623	printf '\33]2;%s\007' "new window title"
624		898
625	=head1 DESCRIPTION	899	=head1 DESCRIPTION
626		900
627	The rest of this document describes various technical aspects of	901	The rest of this document describes various technical aspects of
628	B<rxvt-unicode>. First the description of supported command sequences,	902	B<rxvt-unicode>. First the description of supported command sequences,
629	followed by menu and pixmap support and last by a description of all	903	followed by pixmap support and last by a description of all features
630	features selectable at C<configure> time.	904	selectable at C<configure> time.
631
632	=head1 RXVT TECHNICAL REFERENCE
633		905
634	=head1 Definitions	906	=head1 Definitions
635		907
636	=over 4	908	=over 4
637		909
…		…
766	Single Shift Select of G3 Character Set (SS3): affects next character	1038	Single Shift Select of G3 Character Set (SS3): affects next character
767	only I<unimplemented>	1039	only I<unimplemented>
768		1040
769	=item B<< C<ESC Z> >>	1041	=item B<< C<ESC Z> >>
770		1042
771	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>	1043	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
772		1044
773	=item B<< C<ESC c> >>	1045	=item B<< C<ESC c> >>
774		1046
775	Full reset (RIS)	1047	Full reset (RIS)
776		1048
…		…
780		1052
781	=item B<< C<ESC o> >>	1053	=item B<< C<ESC o> >>
782		1054
783	Invoke the G3 Character Set (LS3)	1055	Invoke the G3 Character Set (LS3)
784		1056
785	=item B<< C<ESC> ( C> >>	1057	=item B<< C<ESC ( C> >>
786		1058
787	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	1059	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
788		1060
789	=item B<< C<ESC> ) C> >>	1061	=item B<< C<ESC ) C> >>
790		1062
791	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	1063	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
792		1064
793	=item B<< C<ESC * C> >>	1065	=item B<< C<ESC * C> >>
794		1066
…		…
935		1207
936	=item B<< C<ESC [ Ps c> >>	1208	=item B<< C<ESC [ Ps c> >>
937		1209
938	Send Device Attributes (DA)	1210	Send Device Attributes (DA)
939	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1211	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
940	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1212	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
941	Option'')	1213	Option'')
942		1214
943	=item B<< C<ESC [ Ps d> >>	1215	=item B<< C<ESC [ Ps d> >>
944		1216
945	Cursor to Line B<< C<Ps> >> (VPA)	1217	Cursor to Line B<< C<Ps> >> (VPA)
…		…
1061		1333
1062	=item B<< C<ESC [ s> >>	1334	=item B<< C<ESC [ s> >>
1063		1335
1064	Save Cursor (SC)	1336	Save Cursor (SC)
1065		1337
		1338	=item B<< C<ESC [ Ps;Pt t> >>
		1339
		1340	Window Operations
		1341
		1342	=begin table
		1343
		1344	B<< C<Ps = 1> >> Deiconify (map) window
		1345	B<< C<Ps = 2> >> Iconify window
		1346	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
		1347	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1348	B<< C<Ps = 5> >> Raise window
		1349	B<< C<Ps = 6> >> Lower window
		1350	B<< C<Ps = 7> >> Refresh screen once
		1351	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1352	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1353	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1354	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1355	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1356	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1357	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1358	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1359	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1360
		1361	=end table
		1362
		1363	=item B<< C<ESC [ u> >>
		1364
		1365	Restore Cursor
		1366
1066	=item B<< C<ESC [ Ps x> >>	1367	=item B<< C<ESC [ Ps x> >>
1067		1368
1068	Request Terminal Parameters (DECREQTPARM)	1369	Request Terminal Parameters (DECREQTPARM)
1069
1070	=item B<< C<ESC [ u> >>
1071
1072	Restore Cursor
1073		1370
1074	=back	1371	=back
1075		1372
1076	X<PrivateModes>	1373	X<PrivateModes>
1077		1374
…		…
1180	B<< C<h> >> Send Mouse X & Y on button press.	1477	B<< C<h> >> Send Mouse X & Y on button press.
1181	B<< C<l> >> No mouse reporting.	1478	B<< C<l> >> No mouse reporting.
1182		1479
1183	=end table	1480	=end table
1184		1481
1185	=item B<< C<Ps = 10> >> (B<rxvt>)
1186
1187	=begin table
1188
1189	B<< C<h> >> menuBar visible
1190	B<< C<l> >> menuBar invisible
1191
1192	=end table
1193
1194	=item B<< C<Ps = 25> >>	1482	=item B<< C<Ps = 25> >>
1195		1483
1196	=begin table	1484	=begin table
1197		1485
1198	B<< C<h> >> Visible cursor {cnorm/cvvis}	1486	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1311		1599
1312	=begin table	1600	=begin table
1313		1601
1314	B<< C<h> >> Scroll to bottom when a key is pressed	1602	B<< C<h> >> Scroll to bottom when a key is pressed
1315	B<< C<l> >> Don't scroll to bottom when a key is pressed	1603	B<< C<l> >> Don't scroll to bottom when a key is pressed
		1604
		1605	=end table
		1606
		1607	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1608
		1609	=begin table
		1610
		1611	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1612	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1316		1613
1317	=end table	1614	=end table
1318		1615
1319	=item B<< C<Ps = 1047> >>	1616	=item B<< C<Ps = 1047> >>
1320		1617
…		…
1369	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1666	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1370	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1667	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1371	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1668	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1372	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1669	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1373	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1670	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1374	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1671	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1375	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1672	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		1673	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1376	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1674	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1377	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1378	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1675	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1379	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	1676	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1380	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> >>	1677	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> >>
1381	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1678	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1382	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)	1679	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).
1383	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1384	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1680	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1385	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>	1681	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1682	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1683	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1386	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	1684	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1387	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1685	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1388	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1686	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1389	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1687	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1688	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1689	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1690	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1390		1691
1391	=end table	1692	=end table
1392		1693
1393	=back	1694	=back
1394		1695
1395	X<menuBar>
1396
1397	=head1 menuBar
1398
1399	B<< The exact syntax used is I<almost> solidified. >>
1400	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1401	menuBar.
1402
1403	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1404	omitted: use B<./> to specify a menu relative to the current menu.
1405
1406	=head2 Overview of menuBar operation
1407
1408	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1409	of C<Pt> can be used for a variety of tasks:
1410
1411	At the top level is the current menuBar which is a member of a circular
1412	linked-list of other such menuBars.
1413
1414	The menuBar acts as a parent for the various drop-down menus, which in
1415	turn, may have labels, separator lines, menuItems and subMenus.
1416
1417	The menuItems are the useful bits: you can use them to mimic keyboard
1418	input or even to send text or escape sequences back to rxvt.
1419
1420	The menuBar syntax is intended to provide a simple yet robust method of
1421	constructing and manipulating menus and navigating through the
1422	menuBars.
1423
1424	The first step is to use the tag B<< [menu:I<name>] >> which creates
1425	the menuBar called I<name> and allows access. You may now or menus,
1426	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1427	menuBar access as B<readonly> to prevent accidental corruption of the
1428	menus. To re-access the current menuBar for alterations, use the tag
1429	B<[menu]>, make the alterations and then use B<[done]>
1430
1431	X<menuBarCommands>
1432
1433	=head2 Commands
1434
1435	=over 4
1436
1437	=item B<< [menu:+I<name>] >>
1438
1439	access the named menuBar for creation or alteration. If a new menuBar
1440	is created, it is called I<name> (max of 15 chars) and the current
1441	menuBar is pushed onto the stack
1442
1443	=item B<[menu]>
1444
1445	access the current menuBar for alteration
1446
1447	=item B<< [title:+I<string>] >>
1448
1449	set the current menuBar's title to I<string>, which may contain the
1450	following format specifiers:
1451	B<%%> : literal B<%> character
1452	B<%n> : rxvt name (as per the B<-name> command-line option)
1453	B<%v> : rxvt version
1454
1455	=item B<[done]>
1456
1457	set menuBar access as B<readonly>.
1458	End-of-file tag for B<< [read:+I<file>] >> operations.
1459
1460	=item B<< [read:+I<file>] >>
1461
1462	read menu commands directly from I<file> (extension ".menu" will be
1463	appended if required.) Start reading at a line with B<[menu]> or B<<
1464	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1465
1466	Blank and comment lines (starting with B<#>) are ignored. Actually,
1467	since any invalid menu commands are also ignored, almost anything could
1468	be construed as a comment line, but this may be tightened up in the
1469	future ... so don't count on it!.
1470
1471	=item B<< [read:+I<file>;+I<name>] >>
1472
1473	The same as B<< [read:+I<file>] >>, but start reading at a line with
1474	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1475	B<[done]> is encountered.
1476
1477	=item B<[dump]>
1478
1479	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1480	later rereading.
1481
1482	=item B<[rm:name]>
1483
1484	remove the named menuBar
1485
1486	=item B<[rm] [rm:]>
1487
1488	remove the current menuBar
1489
1490	=item B<[rm*] [rm:*]>
1491
1492	remove all menuBars
1493
1494	=item B<[swap]>
1495
1496	swap the top two menuBars
1497
1498	=item B<[prev]>
1499
1500	access the previous menuBar
1501
1502	=item B<[next]>
1503
1504	access the next menuBar
1505
1506	=item B<[show]>
1507
1508	Enable display of the menuBar
1509
1510	=item B<[hide]>
1511
1512	Disable display of the menuBar
1513
1514	=item B<< [pixmap:+I<name>] >>
1515
1516	=item B<< [pixmap:+I<name>;I<scaling>] >>
1517
1518	(set the background pixmap globally
1519
1520	B<< A Future implementation I<may> make this local to the menubar >>)
1521
1522	=item B<< [:+I<command>:] >>
1523
1524	ignore the menu readonly status and issue a I<command> to or a menu or
1525	menuitem or change the ; a useful shortcut for setting the quick arrows
1526	from a menuBar.
1527
1528	=back
1529
1530	X<menuBarAdd>
1531
1532	=head2 Adding and accessing menus
1533
1534	The following commands may also be B<+> prefixed.
1535
1536	=over 4
1537
1538	=item B</+>
1539
1540	access menuBar top level
1541
1542	=item B<./+>
1543
1544	access current menu level
1545
1546	=item B<../+>
1547
1548	access parent menu (1 level up)
1549
1550	=item B<../../>
1551
1552	access parent menu (multiple levels up)
1553
1554	=item B<< I</path/>menu >>
1555
1556	add/access menu
1557
1558	=item B<< I</path/>menu/* >>
1559
1560	add/access menu and clear it if it exists
1561
1562	=item B<< I</path/>{-} >>
1563
1564	add separator
1565
1566	=item B<< I</path/>{item} >>
1567
1568	add B<item> as a label
1569
1570	=item B<< I</path/>{item} action >>
1571
1572	add/alter I<menuitem> with an associated I<action>
1573
1574	=item B<< I</path/>{item}{right-text} >>
1575
1576	add/alter I<menuitem> with B<right-text> as the right-justified text
1577	and as the associated I<action>
1578
1579	=item B<< I</path/>{item}{rtext} action >>
1580
1581	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1582	the right-justified text.
1583
1584	=back
1585
1586	=over 4
1587
1588	=item Special characters in I<action> must be backslash-escaped:
1589
1590	B<\a \b \E \e \n \r \t \octal>
1591
1592	=item or in control-character notation:
1593
1594	B<^@, ^A .. ^Z .. ^_, ^?>
1595
1596	=back
1597
1598	To send a string starting with a B<NUL> (B<^@>) character to the
1599	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1600	the first of which will be stripped off and the balance directed to the
1601	program. Otherwise if I<action> begins with B<NUL> followed by
1602	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1603	balance is sent back to rxvt.
1604
1605	As a convenience for the many Emacs-type editors, I<action> may start
1606	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1607	appended if missed from B<M-x> commands.
1608
1609	As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1610	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1611
1612	=over 4
1613
1614	=item For example,
1615
1616	B<M-xapropos> is equivalent to B<\Exapropos\r>
1617
1618	=item and
1619
1620	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1621
1622	=back
1623
1624	The option B<< {I<right-rtext>} >> will be right-justified. In the
1625	absence of a specified action, this text will be used as the I<action>
1626	as well.
1627
1628	=over 4
1629
1630	=item For example,
1631
1632	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1633
1634	=back
1635
1636	The left label I<is> necessary, since it's used for matching, but
1637	implicitly hiding the left label (by using same name for both left and
1638	right labels), or explicitly hiding the left label (by preceeding it
1639	with a dot), makes it possible to have right-justified text only.
1640
1641	=over 4
1642
1643	=item For example,
1644
1645	B</File/{Open}{Open} Open-File-Action>
1646
1647	=item or hiding it
1648
1649	B</File/{.anylabel}{Open} Open-File-Action>
1650
1651	=back
1652
1653	X<menuBarRemove>
1654
1655	=head2 Removing menus
1656
1657	=over 4
1658
1659	=item B<< -/*+ >>
1660
1661	remove all menus from the menuBar, the same as B<[clear]>
1662
1663	=item B<< -+I</path>menu+ >>
1664
1665	remove menu
1666
1667	=item B<< -+I</path>{item}+ >>
1668
1669	remove item
1670
1671	=item B<< -+I</path>{-} >>
1672
1673	remove separator)
1674
1675	=item B<-/path/menu/*>
1676
1677	remove all items, separators and submenus from menu
1678
1679	=back
1680
1681	X<menuBarArrows>
1682
1683	=head2 Quick Arrows
1684
1685	The menus also provide a hook for I<quick arrows> to provide easier
1686	user access. If nothing has been explicitly set, the default is to
1687	emulate the curror keys. The syntax permits each arrow to be altered
1688	individually or all four at once without re-entering their common
1689	beginning/end text. For example, to explicitly associate cursor actions
1690	with the arrows, any of the following forms could be used:
1691
1692	=over 4
1693
1694	=item B<< <r>+I<Right> >>
1695
1696	=item B<< <l>+I<Left> >>
1697
1698	=item B<< <u>+I<Up> >>
1699
1700	=item B<< <d>+I<Down> >>
1701
1702	Define actions for the respective arrow buttons
1703
1704	=item B<< <b>+I<Begin> >>
1705
1706	=item B<< <e>+I<End> >>
1707
1708	Define common beginning/end parts for I<quick arrows> which used in
1709	conjunction with the above <r> <l> <u> <d> constructs
1710
1711	=back
1712
1713	=over 4
1714
1715	=item For example, define arrows individually,
1716
1717	<u>\E[A
1718
1719	<d>\E[B
1720
1721	<r>\E[C
1722
1723	<l>\E[D
1724
1725	=item or all at once
1726
1727	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1728
1729	=item or more compactly (factoring out common parts)
1730
1731	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1732
1733	=back
1734
1735	X<menuBarSummary>
1736
1737	=head2 Command Summary
1738
1739	A short summary of the most I<common> commands:
1740
1741	=over 4
1742
1743	=item [menu:name]
1744
1745	use an existing named menuBar or start a new one
1746
1747	=item [menu]
1748
1749	use the current menuBar
1750
1751	=item [title:string]
1752
1753	set menuBar title
1754
1755	=item [done]
1756
1757	set menu access to readonly and, if reading from a file, signal EOF
1758
1759	=item [done:name]
1760
1761	if reading from a file using [read:file;name] signal EOF
1762
1763	=item [rm:name]
1764
1765	remove named menuBar(s)
1766
1767	=item [rm] [rm:]
1768
1769	remove current menuBar
1770
1771	=item [rm*] [rm:*]
1772
1773	remove all menuBar(s)
1774
1775	=item [swap]
1776
1777	swap top two menuBars
1778
1779	=item [prev]
1780
1781	access the previous menuBar
1782
1783	=item [next]
1784
1785	access the next menuBar
1786
1787	=item [show]
1788
1789	map menuBar
1790
1791	=item [hide]
1792
1793	unmap menuBar
1794
1795	=item [pixmap;file]
1796
1797	=item [pixmap;file;scaling]
1798
1799	set a background pixmap
1800
1801	=item [read:file]
1802
1803	=item [read:file;name]
1804
1805	read in a menu from a file
1806
1807	=item [dump]
1808
1809	dump out all menuBars to /tmp/rxvt-PID
1810
1811	=item /
1812
1813	access menuBar top level
1814
1815	=item ./
1816
1817	=item ../
1818
1819	=item ../../
1820
1821	access current or parent menu level
1822
1823	=item /path/menu
1824
1825	add/access menu
1826
1827	=item /path/{-}
1828
1829	add separator
1830
1831	=item /path/{item}{rtext} action
1832
1833	add/alter menu item
1834
1835	=item -/*
1836
1837	remove all menus from the menuBar
1838
1839	=item -/path/menu
1840
1841	remove menu items, separators and submenus from menu
1842
1843	=item -/path/menu
1844
1845	remove menu
1846
1847	=item -/path/{item}
1848
1849	remove item
1850
1851	=item -/path/{-}
1852
1853	remove separator
1854
1855	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1856
1857	menu quick arrows
1858
1859	=back
1860	X<XPM>	1696	X<XPM>
1861		1697
1862	=head1 XPM	1698	=head1 XPM
1863		1699
1864	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1700	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2050	=end table	1886	=end table
2051		1887
2052	=head1 CONFIGURE OPTIONS	1888	=head1 CONFIGURE OPTIONS
2053		1889
2054	General hint: if you get compile errors, then likely your configuration	1890	General hint: if you get compile errors, then likely your configuration
2055	hasn't been tested well. Either try with --enable-everything or use the	1891	hasn't been tested well. Either try with C<--enable-everything> or use
2056	./reconf script as a base for experiments. ./reconf is used by myself,	1892	the F<./reconf> script as a base for experiments. F<./reconf> is used by
2057	so it should generally be a working config. Of course, you should always	1893	myself, so it should generally be a working config. Of course, you should
2058	report when a combination doesn't work, so it can be fixed. Marc Lehmann	1894	always report when a combination doesn't work, so it can be fixed. Marc
2059	<rxvt@schmorp.de>.	1895	Lehmann <rxvt@schmorp.de>.
		1896
		1897	All
2060		1898
2061	=over 4	1899	=over 4
2062		1900
2063	=item --enable-everything	1901	=item --enable-everything
2064		1902
2065	Add support for all non-multichoice options listed in "./configure	1903	Add (or remove) support for all non-multichoice options listed in "./configure
2066	--help". Note that unlike other enable options this is order dependant.	1904	--help".
		1905
2067	You can specify this and then disable options which this enables by	1906	You can specify this and then disable options you do not like by
2068	I<following> this with the appropriate commands.	1907	I<following> this with the appropriate C<--disable-...> arguments,
		1908	or you can start with a minimal configuration by specifying
		1909	C<--disable-everything> and than adding just the C<--enable-...> arguments
		1910	you want.
2069		1911
2070	=item --enable-xft	1912	=item --enable-xft (default: enabled)
2071		1913
2072	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	1914	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2073	slower and require lots of memory, but as long as you don't use them, you	1915	slower and require lots of memory, but as long as you don't use them, you
2074	don't pay for them.	1916	don't pay for them.
2075		1917
2076	=item --enable-font-styles	1918	=item --enable-font-styles (default: on)
2077		1919
2078	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	1920	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2079	styles. The fonts can be set manually or automatically.	1921	styles. The fonts can be set manually or automatically.
2080		1922
2081	=item --with-codesets=NAME,...	1923	=item --with-codesets=NAME,... (default: all)
2082		1924
2083	Compile in support for additional codeset (encoding) groups (eu, vn are	1925	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2084	always compiled in, which includes most 8-bit character sets). These	1926	are always compiled in, which includes most 8-bit character sets). These
2085	codeset tables are currently only used for driving X11 core fonts, they	1927	codeset tables are used for driving X11 core fonts, they are not required
2086	are not required for Xft fonts. Compiling them in will make your binary	1928	for Xft fonts, although having them compiled in lets rxvt-unicode choose
2087	bigger (together about 700kB), but it doesn't increase memory usage unless	1929	replacement fonts more intelligently. Compiling them in will make your
		1930	binary bigger (all of together cost about 700kB), but it doesn't increase
2088	you use an X11 font requiring one of these encodings.	1931	memory usage unless you use a font requiring one of these encodings.
2089		1932
2090	=begin table	1933	=begin table
2091		1934
2092	all all available codeset groups	1935	all all available codeset groups
2093	zh common chinese encodings	1936	zh common chinese encodings
…		…
2096	jp_ext rarely used but big japanese encodings	1939	jp_ext rarely used but big japanese encodings
2097	kr korean encodings	1940	kr korean encodings
2098		1941
2099	=end table	1942	=end table
2100		1943
2101	=item --enable-xim	1944	=item --enable-xim (default: on)
2102		1945
2103	Add support for XIM (X Input Method) protocol. This allows using	1946	Add support for XIM (X Input Method) protocol. This allows using
2104	alternative input methods (e.g. kinput2) and will also correctly	1947	alternative input methods (e.g. kinput2) and will also correctly
2105	set up the input for people using dead keys or compose keys.	1948	set up the input for people using dead keys or compose keys.
2106		1949
2107	=item --enable-unicode3	1950	=item --enable-unicode3 (default: off)
2108		1951
2109	Enable direct support for displaying unicode codepoints above	1952	Enable direct support for displaying unicode codepoints above
2110	65535 (the basic multilingual page). This increases storage	1953	65535 (the basic multilingual page). This increases storage
2111	requirements per character from 2 to 4 bytes. X11 fonts do not yet	1954	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2112	support these extra characters, but Xft does.	1955	support these extra characters, but Xft does.
…		…
2115	even without this flag, but the number of such characters is	1958	even without this flag, but the number of such characters is
2116	limited to a view thousand (shared with combining characters,	1959	limited to a view thousand (shared with combining characters,
2117	see next switch), and right now rxvt-unicode cannot display them	1960	see next switch), and right now rxvt-unicode cannot display them
2118	(input/output and cut&paste still work, though).	1961	(input/output and cut&paste still work, though).
2119		1962
2120	=item --enable-combining	1963	=item --enable-combining (default: on)
2121		1964
2122	Enable automatic composition of combining characters into	1965	Enable automatic composition of combining characters into
2123	composite characters. This is required for proper viewing of text	1966	composite characters. This is required for proper viewing of text
2124	where accents are encoded as seperate unicode characters. This is	1967	where accents are encoded as seperate unicode characters. This is
2125	done by using precomposited characters when available or creating	1968	done by using precomposited characters when available or creating
2126	new pseudo-characters when no precomposed form exists.	1969	new pseudo-characters when no precomposed form exists.
2127		1970
2128	Without --enable-unicode3, the number of additional precomposed	1971	Without --enable-unicode3, the number of additional precomposed characters
2129	characters is rather limited (2048, if this is full, rxvt will use the	1972	is rather limited (2048, if this is full, rxvt-unicode will use the
2130	private use area, extending the number of combinations to 8448). With	1973	private use area, extending the number of combinations to 8448). With
2131	--enable-unicode3, no practical limit exists. This will also enable	1974	--enable-unicode3, no practical limit exists.
2132	storage of characters >65535.	1975
		1976	This option will also enable storage (but not display) of characters
		1977	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2133		1978
2134	The combining table also contains entries for arabic presentation forms,	1979	The combining table also contains entries for arabic presentation forms,
2135	but these are not currently used. Bug me if you want these to be used.	1980	but these are not currently used. Bug me if you want these to be used (and
		1981	tell me how these are to be used...).
2136		1982
2137	=item --enable-fallback(=CLASS)	1983	=item --enable-fallback(=CLASS) (default: Rxvt)
2138		1984
2139	When reading resource settings, also read settings for class CLASS	1985	When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2140	(default: Rxvt). To disable resource fallback use --disable-fallback.
2141		1986
2142	=item --with-res-name=NAME	1987	=item --with-res-name=NAME (default: urxvt)
2143		1988
2144	Use the given name (default: urxvt) as default application name when	1989	Use the given name as default application name when
2145	reading resources. Specify --with-res-name=rxvt to replace rxvt.	1990	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2146		1991
2147	=item --with-res-class=CLASS	1992	=item --with-res-class=CLASS /default: URxvt)
2148		1993
2149	Use the given class (default: URxvt) as default application class	1994	Use the given class as default application class
2150	when reading resources. Specify --with-res-class=Rxvt to replace	1995	when reading resources. Specify --with-res-class=Rxvt to replace
2151	rxvt.	1996	rxvt.
2152		1997
2153	=item --enable-utmp	1998	=item --enable-utmp (default: on)
2154		1999
2155	Write user and tty to utmp file (used by programs like F<w>) at	2000	Write user and tty to utmp file (used by programs like F<w>) at
2156	start of rxvt execution and delete information when rxvt exits.	2001	start of rxvt execution and delete information when rxvt exits.
2157		2002
2158	=item --enable-wtmp	2003	=item --enable-wtmp (default: on)
2159		2004
2160	Write user and tty to wtmp file (used by programs like F<last>) at	2005	Write user and tty to wtmp file (used by programs like F<last>) at
2161	start of rxvt execution and write logout when rxvt exits. This	2006	start of rxvt execution and write logout when rxvt exits. This
2162	option requires --enable-utmp to also be specified.	2007	option requires --enable-utmp to also be specified.
2163		2008
2164	=item --enable-lastlog	2009	=item --enable-lastlog (default: on)
2165		2010
2166	Write user and tty to lastlog file (used by programs like	2011	Write user and tty to lastlog file (used by programs like
2167	F<lastlogin>) at start of rxvt execution. This option requires	2012	F<lastlogin>) at start of rxvt execution. This option requires
2168	--enable-utmp to also be specified.	2013	--enable-utmp to also be specified.
2169		2014
2170	=item --enable-xpm-background	2015	=item --enable-xpm-background (default: on)
2171		2016
2172	Add support for XPM background pixmaps.	2017	Add support for XPM background pixmaps.
2173		2018
2174	=item --enable-transparency	2019	=item --enable-transparency (default: on)
2175		2020
2176	Add support for inheriting parent backgrounds thus giving a fake	2021	Add support for inheriting parent backgrounds thus giving a fake
2177	transparency to the term.	2022	transparency to the term.
2178		2023
2179	=item --enable-fading	2024	=item --enable-fading (default: on)
2180		2025
2181	Add support for fading the text when focus is lost.	2026	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2182		2027
2183	=item --enable-tinting	2028	=item --enable-tinting (default: on)
2184		2029
2185	Add support for tinting of transparent backgrounds.	2030	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2186		2031
2187	=item --enable-menubar
2188
2189	Add support for our menu bar system (this interacts badly with
2190	dynamic locale switching currently).
2191
2192	=item --enable-rxvt-scroll	2032	=item --enable-rxvt-scroll (default: on)
2193		2033
2194	Add support for the original rxvt scrollbar.	2034	Add support for the original rxvt scrollbar.
2195		2035
2196	=item --enable-next-scroll	2036	=item --enable-next-scroll (default: on)
2197		2037
2198	Add support for a NeXT-like scrollbar.	2038	Add support for a NeXT-like scrollbar.
2199		2039
2200	=item --enable-xterm-scroll	2040	=item --enable-xterm-scroll (default: on)
2201		2041
2202	Add support for an Xterm-like scrollbar.	2042	Add support for an Xterm-like scrollbar.
2203		2043
2204	=item --enable-plain-scroll	2044	=item --enable-plain-scroll (default: on)
2205		2045
2206	Add support for a very unobtrusive, plain-looking scrollbar that	2046	Add support for a very unobtrusive, plain-looking scrollbar that
2207	is the favourite of the rxvt-unicode author, having used it for	2047	is the favourite of the rxvt-unicode author, having used it for
2208	many years.	2048	many years.
2209		2049
2210	=item --enable-half-shadow	2050	=item --enable-ttygid (default: off)
2211
2212	Make shadows on the scrollbar only half the normal width & height.
2213	only applicable to rxvt scrollbars.
2214
2215	=item --enable-ttygid
2216		2051
2217	Change tty device setting to group "tty" - only use this if	2052	Change tty device setting to group "tty" - only use this if
2218	your system uses this type of security.	2053	your system uses this type of security.
2219		2054
2220	=item --disable-backspace-key	2055	=item --disable-backspace-key
2221		2056
2222	Disable any handling of the backspace key by us - let the X server	2057	Removes any handling of the backspace key by us - let the X server do it.
		2058
		2059	=item --disable-delete-key
		2060
		2061	Removes any handling of the delete key by us - let the X server
2223	do it.	2062	do it.
2224		2063
2225	=item --disable-delete-key
2226
2227	Disable any handling of the delete key by us - let the X server
2228	do it.
2229
2230	=item --disable-resources	2064	=item --disable-resources
2231		2065
2232	Remove all resources checking.	2066	Removes any support for resource checking.
2233
2234	=item --enable-xgetdefault
2235
2236	Make resources checking via XGetDefault() instead of our small
2237	version which only checks ~/.Xdefaults, or if that doesn't exist
2238	then ~/.Xresources.
2239
2240	=item --enable-strings
2241
2242	Add support for our possibly faster memset() function and other
2243	various routines, overriding your system's versions which may
2244	have been hand-crafted in assembly or may require extra libraries
2245	to link in. (this breaks ANSI-C rules and has problems on many
2246	GNU/Linux systems).
2247		2067
2248	=item --disable-swapscreen	2068	=item --disable-swapscreen
2249		2069
2250	Remove support for swap screen.	2070	Remove support for secondary/swap screen.
2251		2071
2252	=item --enable-frills	2072	=item --enable-frills (default: on)
2253		2073
2254	Add support for many small features that are not essential but nice to	2074	Add support for many small features that are not essential but nice to
2255	have. Normally you want this, but for very small binaries you may want to	2075	have. Normally you want this, but for very small binaries you may want to
2256	disable this.	2076	disable this.
2257		2077
2258	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2078	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2259	in combination with other switches) is:	2079	in combination with other switches) is:
2260		2080
2261	MWM-hints	2081	MWM-hints
		2082	EWMH-hints (pid, utf8 names) and protocols (ping)
2262	seperate underline colour	2083	seperate underline colour (-underlineColor)
2263	settable border widths and borderless switch	2084	settable border widths and borderless switch (-w, -b, -bl)
2264	settable extra linespacing	2085	settable extra linespacing /-lsp)
2265	extra window properties (e.g. UTF-8 window names and PID)
2266	iso-14755-2 and -3, and visual feedback	2086	iso-14755-2 and -3, and visual feedback
2267	backindex and forwardindex escape sequence	2087	backindex and forwardindex escape sequence
2268	window op and locale change escape sequences	2088	window op and some xterm/OSC escape sequences
2269	tripleclickwords	2089	tripleclickwords (-tcw)
2270	settable insecure mode	2090	settable insecure mode (-insecure)
		2091	keysym remapping support
		2092	cursor blinking and underline cursor (-cb, -uc)
		2093	XEmbed support (-embed)
		2094	user-pty (-pty-fd)
		2095	hold on exit (-hold)
		2096	skip builtin block graphics (-sbg)
		2097	sgr modes 90..97 and 100..107
2271		2098
2272	=item --enable-iso14755	2099	=item --enable-iso14755 (default: on)
2273		2100
2274	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2101	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2275	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2102	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2276	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2103	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2277	this switch.	2104	this switch.
2278		2105
2279	=item --enable-keepscrolling	2106	=item --enable-keepscrolling (default: on)
2280		2107
2281	Add support for continual scrolling of the display when you hold	2108	Add support for continual scrolling of the display when you hold
2282	the mouse button down on a scrollbar arrow.	2109	the mouse button down on a scrollbar arrow.
2283		2110
2284	=item --enable-mousewheel	2111	=item --enable-mousewheel (default: on)
2285		2112
2286	Add support for scrolling via mouse wheel or buttons 4 & 5.	2113	Add support for scrolling via mouse wheel or buttons 4 & 5.
2287		2114
2288	=item --enable-slipwheeling	2115	=item --enable-slipwheeling (default: on)
2289		2116
2290	Add support for continual scrolling (using the mouse wheel as an	2117	Add support for continual scrolling (using the mouse wheel as an
2291	accelerator) while the control key is held down. This option	2118	accelerator) while the control key is held down. This option
2292	requires --enable-mousewheel to also be specified.	2119	requires --enable-mousewheel to also be specified.
2293		2120
2294	=item --disable-new-selection	2121	=item --disable-new-selection
2295		2122
2296	Remove support for mouse selection style like that of xterm.	2123	Remove support for mouse selection style like that of xterm.
2297		2124
2298	=item --enable-dmalloc	2125	=item --enable-dmalloc (default: off)
2299		2126
2300	Use Gray Watson's malloc - which is good for debugging See	2127	Use Gray Watson's malloc - which is good for debugging See
2301	http://www.letters.com/dmalloc/ for details If you use either this or the	2128	http://www.letters.com/dmalloc/ for details If you use either this or the
2302	next option, you may need to edit src/Makefile after compiling to point	2129	next option, you may need to edit src/Makefile after compiling to point
2303	DINCLUDE and DLIB to the right places.	2130	DINCLUDE and DLIB to the right places.
2304		2131
2305	You can only use either this option and the following (should	2132	You can only use either this option and the following (should
2306	you use either) .	2133	you use either) .
2307		2134
2308	=item --enable-dlmalloc	2135	=item --enable-dlmalloc (default: off)
2309		2136
2310	Use Doug Lea's malloc - which is good for a production version	2137	Use Doug Lea's malloc - which is good for a production version
2311	See L<http://g.oswego.edu/dl/html/malloc.html> for details.	2138	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2312		2139
2313	=item --enable-smart-resize	2140	=item --enable-smart-resize (default: on)
2314		2141
2315	Add smart growth/shrink behaviour when changing font size via from hot	2142	Add smart growth/shrink behaviour when changing font size via hot
2316	keys. This should keep in a fixed position the rxvt corner which is	2143	keys. This should keep the window corner which is closest to a corner of
2317	closest to a corner of the screen.	2144	the screen in a fixed position.
2318		2145
2319	=item --enable-cursor-blink
2320
2321	Add support for a blinking cursor.
2322
2323	=item --enable-pointer-blank	2146	=item --enable-pointer-blank (default: on)
2324		2147
2325	Add support to have the pointer disappear when typing or inactive.	2148	Add support to have the pointer disappear when typing or inactive.
2326		2149
2327	=item --with-name=NAME	2150	=item --enable-perl (default: off)
2328		2151
		2152	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2153	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2154	in F<src/perl-ext/> for the extensions that are installed by default. The
		2155	perl interpreter that is used can be specified via the C<PERL> environment
		2156	variable when running configure.
		2157
		2158	=item --with-name=NAME (default: urxvt)
		2159
2329	Set the basename for the installed binaries (default: C<urxvt>, resulting	2160	Set the basename for the installed binaries, resulting
2330	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2161	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2331	C<rxvt>.	2162	C<rxvt>.
2332		2163
2333	=item --with-term=NAME	2164	=item --with-term=NAME (default: rxvt-unicode)
2334		2165
2335	Change the environmental variable for the terminal to NAME (default	2166	Change the environmental variable for the terminal to NAME.
2336	C<rxvt-unicode>)
2337		2167
2338	=item --with-terminfo=PATH	2168	=item --with-terminfo=PATH
2339		2169
2340	Change the environmental variable for the path to the terminfo tree to	2170	Change the environmental variable for the path to the terminfo tree to
2341	PATH.	2171	PATH.

Diff Legend

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