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

Diff Legend

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