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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.60 by root, Fri Jul 29 03:12:10 2005 UTC

1	=head1 Rxvt Technical Reference	1	=head1 NAME
2		2
3	Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the	3	RXVT REFERENCE - FAQ, command sequences and other background information
4	original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used	4
5	the XTerm documentation and other sources.	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
		25	=head1 FREQUENTLY ASKED QUESTIONS
		26
		27	=over 4
		28
		29	=item How do I know which rxvt-unicode version I'm using?
		30
		31	The version number is displayed with the usage (-h). Also the escape
		32	sequence C<ESC [ 8 n> sets the window title to the version number.
		33
		34	=item I am using Debian GNU/Linux and have a problem...
		35
		36	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		37	patches that considerably change the behaviour of rxvt-unicode. Before
		38	reporting a bug to the original rxvt-unicode author please download and
		39	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
		40	and try to reproduce the problem. If you cannot, chances are that the
		41	problems are specific to Debian GNU/Linux, in which case it should be
		42	reported via the Debian Bug Tracking System (use C<reportbug> to report
		43	the bug).
		44
		45	For other problems that also affect the Debian package, you can and
		46	probably should use the Debian BTS, too, because, after all, it's also a
		47	bug in the Debian version and it serves as a reminder for other users that
		48	might encounter the same issue.
		49
		50	=item When I log-in to another system it tells me about missing terminfo data?
		51
		52	The terminal description used by rxvt-unicode is not as widely available
		53	as that for xterm, or even rxvt (for which the same problem often arises).
		54
		55	The correct solution for this problem is to install the terminfo, this can
		56	be done like this (with ncurses' infocmp):
		57
		58	REMOTE=remotesystem.domain
		59	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
		60
		61	... or by installing rxvt-unicode normally on the remote system,
		62
		63	If you cannot or do not want to do this, then you can simply set
		64	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		65	problems arising, which includes wrong keymapping, less and different
		66	colours and some refresh errors in fullscreen applications. It's a nice
		67	quick-and-dirty workaround for rare cases, though.
		68
		69	If you always want to do this (and are fine with the consequences) you
		70	can either recompile rxvt-unicode with the desired TERM value or use a
		71	resource to set it:
		72
		73	URxvt.termName: rxvt
		74
		75	If you don't plan to use B<rxvt> (quite common...) you could also replace
		76	the rxvt terminfo file with the rxvt-unicode one.
		77
		78	=item C<tic> outputs some error when compiling the terminfo entry.
		79
		80	Most likely it's the empty definition for C<enacs=>. Just replace it by
		81	C<enacs=\E[0@> and try again.
		82
		83	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
		84
		85	=item I need a termcap file entry.
		86
		87	One reason you might want this is that some distributions or operating
		88	systems still compile some programs using the long-obsoleted termcap
		89	library (Fedora Core's bash is one example) and rely on a termcap entry
		90	for C<rxvt-unicode>.
		91
		92	You could use rxvt's termcap entry with resonable results in many cases.
		93	You can also create a termcap entry by using terminfo's infocmp program
		94	like this:
		95
		96	infocmp -C rxvt-unicode
		97
		98	Or you could use this termcap entry, generated by the command above:
		99
		100	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		101	:am:bw:eo:km:mi:ms:xn:xo:\
		102	:co#80:it#8:li#24:lm#0:\
		103	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		104	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		105	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		106	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		107	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		108	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		109	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		110	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		111	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		112	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		113	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		114	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		115	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		116	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		117	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		118	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		119	:vs=\E[?25h:
		120
		121	=item Why does C<ls> no longer have coloured output?
		122
		123	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		124	decide wether a terminal has colour, but uses it's own configuration
		125	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
		126	with most other terminals supporting colour). Either add:
		127
		128	TERM rxvt-unicode
		129
		130	to C</etc/DIR_COLORS> or simply add:
		131
		132	alias ls='ls --color=auto'
		133
		134	to your C<.profile> or C<.bashrc>.
		135
		136	=item Why doesn't vim/emacs etc. use the 88 colour mode?
		137
		138	=item Why doesn't vim/emacs etc. make use of italic?
		139
		140	=item Why are the secondary screen-related options not working properly?
		141
		142	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		143	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		144	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		145	features. Unfortunately, some of these (most notably, again, Debian
		146	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		147	file, so you will need to install it on your own (See the question B<When
		148	I log-in to another system it tells me about missing terminfo data?> on
		149	how to do this).
		150
		151	=item My numerical keypad acts weird and generates differing output?
		152
		153	Some Debian GNUL/Linux users seem to have this problem, although no
		154	specific details were reported so far. It is possible that this is caused
		155	by the wrong C<TERM> setting, although the details of wether and how
		156	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		157	keymap. See the answer to the previous question, and please report if that
		158	helped.
		159
		160	=item Rxvt-unicode does not seem to understand the selected encoding?
		161
		162	=item Unicode does not seem to work?
		163
		164	If you encounter strange problems like typing an accented character but
		165	getting two unrelated other characters or similar, or if program output is
		166	subtly garbled, then you should check your locale settings.
		167
		168	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		169	programs. Often rxvt-unicode is started in the C<C> locale, while the
		170	login script running within the rxvt-unicode window changes the locale to
		171	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
		172
		173	The best thing is to fix your startup environment, as you will likely run
		174	into other problems. If nothing works you can try this in your .profile.
		175
		176	printf '\e]701;%s\007' "$LC_CTYPE"
		177
		178	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		179	supported on your systems. Some systems have a C<locale> command which
		180	displays this (also, C<perl -e0> can be used to check locale settings, as
		181	it will complain loudly if it cannot set the locale). If it displays something
		182	like:
		183
		184	locale: Cannot set LC_CTYPE to default locale: ...
		185
		186	Then the locale you specified is not supported on your system.
		187
		188	If nothing works and you are sure that everything is set correctly then
		189	you will need to remember a little known fact: Some programs just don't
		190	support locales :(
		191
		192	=item Why do some characters look so much different than others?
		193
		194	=item How does rxvt-unicode choose fonts?
		195
		196	Most fonts do not contain the full range of Unicode, which is
		197	fine. Chances are that the font you (or the admin/package maintainer of
		198	your system/os) have specified does not cover all the characters you want
		199	to display.
		200
		201	B<rxvt-unicode> makes a best-effort try at finding a replacement
		202	font. Often the result is fine, but sometimes the chosen font looks
		203	bad/ugly/wrong. Some fonts have totally strange characters that don't
		204	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		205	intelligence to detect that a specific glyph is wrong: it has to believe
		206	the font that the characters it claims to contain indeed look correct.
		207
		208	In that case, select a font of your taste and add it to the font list,
		209	e.g.:
		210
		211	@@RXVT_NAME@@ -fn basefont,font2,font3...
		212
		213	When rxvt-unicode sees a character, it will first look at the base
		214	font. If the base font does not contain the character, it will go to the
		215	next font, and so on. Specifying your own fonts will also speed up this
		216	search and use less resources within rxvt-unicode and the X-server.
		217
		218	The only limitation is that none of the fonts may be larger than the base
		219	font, as the base font defines the terminal character cell size, which
		220	must be the same due to the way terminals work.
		221
		222	=item Why do some chinese characters look so different than others?
		223
		224	This is because there is a difference between script and language --
		225	rxvt-unicode does not know which language the text that is output is,
		226	as it only knows the unicode character codes. If rxvt-unicode first
		227	sees a japanese/chinese character, it might choose a japanese font for
		228	display. Subsequent japanese characters will use that font. Now, many
		229	chinese characters aren't represented in japanese fonts, so when the first
		230	non-japanese character comes up, rxvt-unicode will look for a chinese font
		231	-- unfortunately at this point, it will still use the japanese font for
		232	chinese characters that are also in the japanese font.
		233
		234	The workaround is easy: just tag a chinese font at the end of your font
		235	list (see the previous question). The key is to view the font list as
		236	a preference list: If you expect more japanese, list a japanese font
		237	first. If you expect more chinese, put a chinese font first.
		238
		239	In the future it might be possible to switch language preferences at
		240	runtime (the internal data structure has no problem with using different
		241	fonts for the same character at the same time, but no interface for this
		242	has been designed yet).
		243
		244	Until then, you might get away with switching fonts at runtime (see L<Can
		245	I switch the fonts at runtime?> later in this document).
		246
		247	=item Why does rxvt-unicode sometimes leave pixel droppings?
		248
		249	Most fonts were not designed for terminal use, which means that character
		250	size varies a lot. A font that is otherwise fine for terminal use might
		251	contain some characters that are simply too wide. Rxvt-unicode will avoid
		252	these characters. For characters that are just "a bit" too wide a special
		253	"careful" rendering mode is used that redraws adjacent characters.
		254
		255	All of this requires that fonts do not lie about character sizes,
		256	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		257	box, and rxvt-unicode has no way of detecting this (the correct way is to
		258	ask for the character bounding box, which unfortunately is wrong in these
		259	cases).
		260
		261	It's not clear (to me at least), wether this is a bug in Xft, freetype,
		262	or the respective font. If you encounter this problem you might try using
		263	the C<-lsp> option to give the font more height. If that doesn't work, you
		264	might be forced to use a different font.
		265
		266	All of this is not a problem when using X11 core fonts, as their bounding
		267	box data is correct.
		268
		269	=item On Solaris 9, many line-drawing characters are too wide.
		270
		271	Seems to be a known bug, read
		272	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		273	following ugly workaround to get non-double-wide-characters working:
		274
		275	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
		276
		277	=item My Compose (Multi_key) key is no longer working.
		278
		279	The most common causes for this are that either your locale is not set
		280	correctly, or you specified a B<preeditStyle> that is not supported by
		281	your input method. For example, if you specified B<OverTheSpot> and
		282	your input method (e.g. the default input method handling Compose keys)
		283	does not support this (for instance because it is not visual), then
		284	rxvt-unicode will continue without an input method.
		285
		286	In this case either do not specify a B<preeditStyle> or specify more than
		287	one pre-edit style, such as B<OverTheSpot,Root,None>.
		288
		289	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		290
		291	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		292	international keyboards) or simply use ISO 14755 support to your
		293	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		294	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		295	character and so on.
		296
		297	=item How can I keep rxvt-unicode from using reverse video so much?
		298
		299	First of all, make sure you are running with the right terminal settings
		300	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		301	make sure you have specified colours for italic and bold, as otherwise
		302	rxvt-unicode might use reverse video to simulate the effect:
		303
		304	URxvt.colorBD: white
		305	URxvt.colorIT: green
		306
		307	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
		308
		309	For some unexplainable reason, some rare programs assume a very weird
		310	colour palette when confronted with a terminal with more than the standard
		311	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		312	these programs not to assume non-ISO colours without very good reasons.
		313
		314	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		315	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		316	fix colours but keep you from using other rxvt-unicode features.
		317
		318	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
		319
		320	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		321	in your compile environment, or an implementation that implements it,
		322	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		323	B<wchar_t> is represented as unicode.
		324
		325	As you might have guessed, FreeBSD does neither define this symobl nor
		326	does it support it. Instead, it uses it's own internal representation of
		327	B<wchar_t>. This is, of course, completely fine with respect to standards.
		328
		329	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		330	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		331
		332	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		333	apps in an OS, as using a locale-dependent (and non-standardized)
		334	representation of B<wchar_t> makes it impossible to convert between
		335	B<wchar_t> (as used by X11 and your applications) and any other encoding
		336	without implementing OS-specific-wrappers for each and every locale. There
		337	simply are no APIs to convert B<wchar_t> into anything except the current
		338	locale encoding.
		339
		340	Some applications (such as the formidable B<mlterm>) work around this
		341	by carrying their own replacement functions for character set handling
		342	with them, and either implementing OS-dependent hacks or doing multiple
		343	conversions (which is slow and unreliable in case the OS implements
		344	encodings slightly different than the terminal emulator).
		345
		346	The rxvt-unicode author insists that the right way to fix this is in the
		347	system libraries once and for all, instead of forcing every app to carry
		348	complete replacements for them :)
		349
		350	=item I use Solaris 9 and it doesn't compile/work/etc.
		351
		352	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		353	problems with C<wcwidth> and a compile problem.
		354
		355	=item How can I use rxvt-unicode under cygwin?
		356
		357	rxvt-unicode should compile and run out of the box on cygwin, using
		358	the X11 libraries that come with cygwin. libW11 emulation is no
		359	longer supported (and makes no sense, either, as it only supported a
		360	single font). I recommend starting the X-server in C<-multiwindow> or
		361	C<-rootless> mode instead, which will result in similar look&feel as the
		362	old libW11 emulation.
		363
		364	At the time of this writing, cygwin didn't seem to support any multi-byte
		365	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		366	to 8-bit encodings.
		367
		368	=item How does rxvt-unicode determine the encoding to use?
		369
		370	=item Is there an option to switch encodings?
		371
		372	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		373	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		374	UTF-8 or any other encodings with respect to terminal I/O.
		375
		376	The reasons is that there exists a perfectly fine mechanism for selecting
		377	the encoding, doing I/O and (most important) communicating this to all
		378	applications so everybody agrees on character properties such as width
		379	and code number. This mechanism is the I<locale>. Applications not using
		380	that info will have problems (for example, C<xterm> gets the width of
		381	characters wrong as it uses it's own, locale-independent table under all
		382	locales).
		383
		384	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		385	programs doing the same (that is, most) will automatically agree in the
		386	interpretation of characters.
		387
		388	Unfortunately, there is no system-independent way to select locales, nor
		389	is there a standard on how locale specifiers will look like.
		390
		391	On most systems, the content of the C<LC_CTYPE> environment variable
		392	contains an arbitrary string which corresponds to an already-installed
		393	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		394	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		395	(i.e. C<de> or C<german>) are also common.
		396
		397	Rxvt-unicode ignores all other locale categories, and except for
		398	the encoding, ignores country or language-specific settings,
		399	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		400	rxvt-unicode.
		401
		402	If you want to use a specific encoding you have to make sure you start
		403	rxvt-unicode with the correct C<LC_CTYPE> category.
		404
		405	=item Can I switch locales at runtime?
		406
		407	Yes, using an escape sequence. Try something like this, which sets
		408	rxvt-unicode's idea of C<LC_CTYPE>.
		409
		410	printf '\e]701;%s\007' ja_JP.SJIS
		411
		412	See also the previous answer.
		413
		414	Sometimes this capability is rather handy when you want to work in
		415	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		416	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		417	first switches to a locale supported by xjdic and back later:
		418
		419	printf '\e]701;%s\007' ja_JP.SJIS
		420	xjdic -js
		421	printf '\e]701;%s\007' de_DE.UTF-8
		422
		423	You can also use xterm's C<luit> program, which usually works fine, except
		424	for some locales where character width differs between program- and
		425	rxvt-unicode-locales.
		426
		427	=item Can I switch the fonts at runtime?
		428
		429	Yes, using an escape sequence. Try something like this, which has the same
		430	effect as using the C<-fn> switch, and takes effect immediately:
		431
		432	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
		433
		434	This is useful if you e.g. work primarily with japanese (and prefer a
		435	japanese font), but you have to switch to chinese temporarily, where
		436	japanese fonts would only be in your way.
		437
		438	You can think of this as a kind of manual ISO-2022 switching.
		439
		440	=item Why do italic characters look as if clipped?
		441
		442	Many fonts have difficulties with italic characters and hinting. For
		443	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		444	Mono> completely fails in it's italic face. A workaround might be to
		445	enable freetype autohinting, i.e. like this:
		446
		447	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		448	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		449
		450	=item My input method wants <some encoding> but I want UTF-8, what can I do?
		451
		452	You can specify separate locales for the input method and the rest of the
		453	terminal, using the resource C<imlocale>:
		454
		455	URxvt*imlocale: ja_JP.EUC-JP
		456
		457	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		458	use your input method. Please note, however, that you will not be able to
		459	input characters outside C<EUC-JP> in a normal way then, as your input
		460	method limits you.
		461
		462	=item Rxvt-unicode crashes when the X Input Method changes or exits.
		463
		464	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		465	design. Applications can avoid some crashes at the expense of memory
		466	leaks, and Input Methods can avoid some crashes by careful ordering at
		467	exit time. B<kinput2> (and derived input methods) generally succeeds,
		468	while B<SCIM> (or similar input methods) fails. In the end, however,
		469	crashes cannot be completely avoided even if both sides cooperate.
		470
		471	So the only workaround is not to kill your Input Method Servers.
		472
		473	=item Rxvt-unicode uses gobs of memory, how can I reduce that?
		474
		475	Rxvt-unicode tries to obey the rule of not charging you for something you
		476	don't use. One thing you should try is to configure out all settings that
		477	you don't need, for example, Xft support is a resource hog by design,
		478	when used. Compiling it out ensures that no Xft font will be loaded
		479	accidentally when rxvt-unicode tries to find a font for your characters.
		480
		481	Also, many people (me included) like large windows and even larger
		482	scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
		483	6 bytes per screen cell. For a 160x?? window this amounts to almost a
		484	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
		485	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
		486	rxvt-unicode then uses 8 bytes per screen cell.
		487
		488	=item Can I speed up Xft rendering somehow?
		489
		490	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
		491	it is simply slow. If you still want Xft fonts you might try to disable
		492	antialiasing (by appending C<:antialias=false>), which saves lots of
		493	memory and also speeds up rendering considerably.
		494
		495	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
		496
		497	Rxvt-unicode will use whatever you specify as a font. If it needs to
		498	fall back to it's default font search list it will prefer X11 core
		499	fonts, because they are small and fast, and then use Xft fonts. It has
		500	antialiasing disabled for most of them, because the author thinks they
		501	look best that way.
		502
		503	If you want antialiasing, you have to specify the fonts manually.
		504
		505	=item Mouse cut/paste suddenly no longer works.
		506
		507	Make sure that mouse reporting is actually turned off since killing
		508	some editors prematurely may leave the mouse in mouse report mode. I've
		509	heard that tcsh may use mouse reporting unless it otherwise specified. A
		510	quick check is to see if cut/paste works when the Alt or Shift keys are
		511	depressed. See @@RXVT_NAME@@(7)
		512
		513	=item What's with this bold/blink stuff?
		514
		515	If no bold colour is set via C<colorBD:>, bold will invert text using the
		516	standard foreground colour.
		517
		518	For the standard background colour, blinking will actually make the
		519	text blink when compiled with C<--enable-blinking>. with standard
		520	colours. Without C<--enable-blinking>, the blink attribute will be
		521	ignored.
		522
		523	On ANSI colours, bold/blink attributes are used to set high-intensity
		524	foreground/background colors.
		525
		526	color0-7 are the low-intensity colors.
		527
		528	color8-15 are the corresponding high-intensity colors.
		529
		530	=item I don't like the screen colors. How do I change them?
		531
		532	You can change the screen colors at run-time using F<~/.Xdefaults>
		533	resources (or as long-options).
		534
		535	Here are values that are supposed to resemble a VGA screen,
		536	including the murky brown that passes for low-intensity yellow:
		537
		538	URxvt.color0: #000000
		539	URxvt.color1: #A80000
		540	URxvt.color2: #00A800
		541	URxvt.color3: #A8A800
		542	URxvt.color4: #0000A8
		543	URxvt.color5: #A800A8
		544	URxvt.color6: #00A8A8
		545	URxvt.color7: #A8A8A8
		546
		547	URxvt.color8: #000054
		548	URxvt.color9: #FF0054
		549	URxvt.color10: #00FF54
		550	URxvt.color11: #FFFF54
		551	URxvt.color12: #0000FF
		552	URxvt.color13: #FF00FF
		553	URxvt.color14: #00FFFF
		554	URxvt.color15: #FFFFFF
		555
		556	And here is a more complete set of non-standard colors described (not by
		557	me) as "pretty girly".
		558
		559	URxvt.cursorColor: #dc74d1
		560	URxvt.pointerColor: #dc74d1
		561	URxvt.background: #0e0e0e
		562	URxvt.foreground: #4ad5e1
		563	URxvt.color0: #000000
		564	URxvt.color8: #8b8f93
		565	URxvt.color1: #dc74d1
		566	URxvt.color9: #dc74d1
		567	URxvt.color2: #0eb8c7
		568	URxvt.color10: #0eb8c7
		569	URxvt.color3: #dfe37e
		570	URxvt.color11: #dfe37e
		571	URxvt.color5: #9e88f0
		572	URxvt.color13: #9e88f0
		573	URxvt.color6: #73f7ff
		574	URxvt.color14: #73f7ff
		575	URxvt.color7: #e1dddd
		576	URxvt.color15: #e1dddd
		577
		578	=item How can I start @@RXVT_NAME@@d in a race-free way?
		579
		580	Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
		581	display, create the listening socket and then fork.
		582
		583	=item What's with the strange Backspace/Delete key behaviour?
		584
		585	Assuming that the physical Backspace key corresponds to the
		586	BackSpace keysym (not likely for Linux ... see the following
		587	question) there are two standard values that can be used for
		588	Backspace: C<^H> and C<^?>.
		589
		590	Historically, either value is correct, but rxvt-unicode adopts the debian
		591	policy of using C<^?> when unsure, because it's the one only only correct
		592	choice :).
		593
		594	Rxvt-unicode tries to inherit the current stty settings and uses the value
		595	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
		596	started from a terminal (say, from a menu or by remote shell), then the
		597	system value of `erase', which corresponds to CERASE in <termios.h>, will
		598	be used (which may not be the same as your stty setting).
		599
		600	For starting a new rxvt-unicode:
		601
		602	# use Backspace = ^H
		603	$ stty erase ^H
		604	$ @@RXVT_NAME@@
		605
		606	# use Backspace = ^?
		607	$ stty erase ^?
		608	$ @@RXVT_NAME@@
		609
		610	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
		611
		612	For an existing rxvt-unicode:
		613
		614	# use Backspace = ^H
		615	$ stty erase ^H
		616	$ echo -n "^[[36h"
		617
		618	# use Backspace = ^?
		619	$ stty erase ^?
		620	$ echo -n "^[[36l"
		621
		622	This helps satisfy some of the Backspace discrepancies that occur, but
		623	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
		624	properly reflects that.
		625
		626	The Delete key is a another casualty of the ill-defined Backspace problem.
		627	To avoid confusion between the Backspace and Delete keys, the Delete
		628	key has been assigned an escape sequence to match the vt100 for Execute
		629	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
		630
		631	Some other Backspace problems:
		632
		633	some editors use termcap/terminfo,
		634	some editors (vim I'm told) expect Backspace = ^H,
		635	GNU Emacs (and Emacs-like editors) use ^H for help.
		636
		637	Perhaps someday this will all be resolved in a consistent manner.
		638
		639	=item I don't like the key-bindings. How do I change them?
		640
		641	There are some compile-time selections available via configure. Unless
		642	you have run "configure" with the C<--disable-resources> option you can
		643	use the `keysym' resource to alter the keystrings associated with keysyms.
		644
		645	Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
		646
		647	URxvt.keysym.Home: \033[1~
		648	URxvt.keysym.End: \033[4~
		649	URxvt.keysym.C-apostrophe: \033<C-'>
		650	URxvt.keysym.C-slash: \033<C-/>
		651	URxvt.keysym.C-semicolon: \033<C-;>
		652	URxvt.keysym.C-grave: \033<C-`>
		653	URxvt.keysym.C-comma: \033<C-,>
		654	URxvt.keysym.C-period: \033<C-.>
		655	URxvt.keysym.C-0x60: \033<C-`>
		656	URxvt.keysym.C-Tab: \033<C-Tab>
		657	URxvt.keysym.C-Return: \033<C-Return>
		658	URxvt.keysym.S-Return: \033<S-Return>
		659	URxvt.keysym.S-space: \033<S-Space>
		660	URxvt.keysym.M-Up: \033<M-Up>
		661	URxvt.keysym.M-Down: \033<M-Down>
		662	URxvt.keysym.M-Left: \033<M-Left>
		663	URxvt.keysym.M-Right: \033<M-Right>
		664	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
		665	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
		666	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
		667
		668	See some more examples in the documentation for the B<keysym> resource.
		669
		670	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
		671	How do I make use of them? For example, the Sun Keyboard type 4
		672	has the following mappings that rxvt-unicode doesn't recognize.
		673
		674	KP_Insert == Insert
		675	F22 == Print
		676	F27 == Home
		677	F29 == Prior
		678	F33 == End
		679	F35 == Next
		680
		681	Rather than have rxvt-unicode try to accommodate all the various possible
		682	keyboard mappings, it is better to use `xmodmap' to remap the keys as
		683	required for your particular machine.
		684
		685	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
		686	I need this to decide about setting colors etc.
		687
		688	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
		689	check and see if that is set. Note that several programs, JED, slrn,
		690	Midnight Commander automatically check this variable to decide whether or
		691	not to use color.
		692
		693	=item How do I set the correct, full IP address for the DISPLAY variable?
		694
		695	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
		696	insecure mode then it is possible to use the following shell script
		697	snippets to correctly set the display. If your version of rxvt-unicode
		698	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
		699	the COLORTERM variable can be used to distinguish rxvt-unicode from a
		700	regular xterm.
		701
		702	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
		703	snippets:
		704
		705	# Bourne/Korn/POSIX family of shells:
		706	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
		707	if [ ${TERM:-foo} = xterm ]; then
		708	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
		709	echo -n '^[Z'
		710	read term_id
		711	stty icanon echo
		712	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
		713	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
		714	read DISPLAY # set it in our local shell
		715	fi
		716	fi
		717
		718	=item How do I compile the manual pages for myself?
		719
		720	You need to have a recent version of perl installed as F</usr/bin/perl>,
		721	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
		722	the doc subdirectory and enter C<make alldoc>.
		723
		724	=item My question isn't answered here, can I ask a human?
		725
		726	Before sending me mail, you could go to IRC: C<irc.freenode.net>,
		727	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
		728	interested in learning about new and exciting problems (but not FAQs :).
		729
		730	=back
		731
		732	=head1 RXVT TECHNICAL REFERENCE
		733
		734	=head1 DESCRIPTION
		735
		736	The rest of this document describes various technical aspects of
		737	B<rxvt-unicode>. First the description of supported command sequences,
		738	followed by menu and pixmap support and last by a description of all
		739	features selectable at C<configure> time.
6		740
7	=head1 Definitions	741	=head1 Definitions
8		742
9	=over 4	743	=over 4
10		744
…		…
37	=over 4	771	=over 4
38		772
39	=item B<< C<ENQ> >>	773	=item B<< C<ENQ> >>
40		774
41	Enquiry (Ctrl-E) = Send Device Attributes (DA)	775	Enquiry (Ctrl-E) = Send Device Attributes (DA)
42	request attributes from terminal ==	776	request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43		777
44	=item B<< C<BEL> >>	778	=item B<< C<BEL> >>
45		779
46	Bell (Ctrl-G)	780	Bell (Ctrl-G)
47		781
…		…
139	Single Shift Select of G3 Character Set (SS3): affects next character	873	Single Shift Select of G3 Character Set (SS3): affects next character
140	only I<unimplemented>	874	only I<unimplemented>
141		875
142	=item B<< C<ESC Z> >>	876	=item B<< C<ESC Z> >>
143		877
144	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option>	878	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145		879
146	=item B<< C<ESC c> >>	880	=item B<< C<ESC c> >>
147		881
148	Full reset (RIS)	882	Full reset (RIS)
149		883
…		…
153		887
154	=item B<< C<ESC o> >>	888	=item B<< C<ESC o> >>
155		889
156	Invoke the G3 Character Set (LS3)	890	Invoke the G3 Character Set (LS3)
157		891
158	=item B<< C<ESC>(C<C> >>	892	=item B<< C<ESC ( C> >>
159		893
160	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	894	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161		895
162	=item B<< C<ESC>)C<C> >>	896	=item B<< C<ESC ) C> >>
163		897
164	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	898	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165		899
166	=item B<< C<ESC * C> >>	900	=item B<< C<ESC * C> >>
167		901
…		…
191		925
192	=back	926	=back
193		927
194	X<CSI>	928	X<CSI>
195		929
196	=head1 CSI (Code Sequence Introducer) Sequences	930	=head1 CSI (Command Sequence Introducer) Sequences
197		931
198	=over 4	932	=over 4
199		933
200	=item B<< C<ESC [ Ps @> >>	934	=item B<< C<ESC [ Ps @> >>
201		935
…		…
298		1032
299	Move backward B<< C<Ps> >> [default: 1] tab stops	1033	Move backward B<< C<Ps> >> [default: 1] tab stops
300		1034
301	=item B<< C<ESC [ Ps '> >>	1035	=item B<< C<ESC [ Ps '> >>
302		1036
303	==	1037	See B<< C<ESC [ Ps G> >>
304		1038
305	=item B<< C<ESC [ Ps a> >>	1039	=item B<< C<ESC [ Ps a> >>
306		1040
307	==X<ESCOBPsc>	1041	See B<< C<ESC [ Ps C> >>
308		1042
309	=item B<< C<ESC [ Ps c> >>	1043	=item B<< C<ESC [ Ps c> >>
310		1044
311	Send Device Attributes (DA)	1045	Send Device Attributes (DA)
312	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1046	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1047	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314	Option'')	1048	Option'')
315		1049
316	=item B<< C<ESC [ Ps d> >>	1050	=item B<< C<ESC [ Ps d> >>
317		1051
318	Cursor to Line B<< C<Ps> >> (VPA)	1052	Cursor to Line B<< C<Ps> >> (VPA)
319		1053
320	=item B<< C<ESC [ Ps e> >>	1054	=item B<< C<ESC [ Ps e> >>
321		1055
322	==	1056	See B<< C<ESC [ Ps A> >>
323		1057
324	=item B<< C<ESC [ Ps;Ps f> >>	1058	=item B<< C<ESC [ Ps;Ps f> >>
325		1059
326	Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]	1060	Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327		1061
…		…
334	B<< C<Ps = 0> >> Clear Current Column (default)	1068	B<< C<Ps = 0> >> Clear Current Column (default)
335	B<< C<Ps = 3> >> Clear All (TBC)	1069	B<< C<Ps = 3> >> Clear All (TBC)
336		1070
337	=end table	1071	=end table
338		1072
		1073	=item B<< C<ESC [ Pm h> >>
		1074
		1075	Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
		1076
339	=item B<< C<ESC [ Ps i> >>	1077	=item B<< C<ESC [ Ps i> >>
340		1078
341	Printing	1079	Printing. See also the C<print-pipe> resource.
342		1080
343	=begin table	1081	=begin table
344		1082
		1083	B<< C<Ps = 0> >> print screen (MC0)
345	B<< C<Ps = 4> >> disable transparent print mode (MC4)	1084	B<< C<Ps = 4> >> disable transparent print mode (MC4)
346	B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented>	1085	B<< C<Ps = 5> >> enable transparent print mode (MC5)
347		1086
348	=end table	1087	=end table
349
350	=item B<< C<ESC [ Pm h> >>
351
352	Set Mode (SM). See next sequence for description of C<Pm>.
353		1088
354	=item B<< C<ESC [ Pm l> >>	1089	=item B<< C<ESC [ Pm l> >>
355		1090
356	Reset Mode (RM)	1091	Reset Mode (RM)
357		1092
…		…
364	B<< C<h> >> Insert Mode (SMIR)	1099	B<< C<h> >> Insert Mode (SMIR)
365	B<< C<l> >> Replace Mode (RMIR)	1100	B<< C<l> >> Replace Mode (RMIR)
366		1101
367	=end table	1102	=end table
368		1103
369	=item B<< C<Ps = 20> >> I<unimplemented>	1104	=item B<< C<Ps = 20> >> (partially implemented)
370		1105
371	=begin table	1106	=begin table
372		1107
373	B<< C<h> >> Automatic Newline (LNM)	1108	B<< C<h> >> Automatic Newline (LNM)
374	B<< C<h> >> Normal Linefeed (LNM)	1109	B<< C<l> >> Normal Linefeed (LNM)
375		1110
376	=end table	1111	=end table
377		1112
378	=back	1113	=back
379		1114
…		…
382	Character Attributes (SGR)	1117	Character Attributes (SGR)
383		1118
384	=begin table	1119	=begin table
385		1120
386	B<< C<Ps = 0> >> Normal (default)	1121	B<< C<Ps = 0> >> Normal (default)
387	B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg)	1122	B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
		1123	B<< C<Ps = 3 / 23> >> On / Off Italic
388	B<< C<Ps = 4 / 24> >> On / Off Underline	1124	B<< C<Ps = 4 / 24> >> On / Off Underline
389	B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg)	1125	B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
		1126	B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390	B<< C<Ps = 7 / 27> >> On / Off Inverse	1127	B<< C<Ps = 7 / 27> >> On / Off Inverse
		1128	B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391	B<< C<Ps = 30 / 40> >> fg/bg Black	1129	B<< C<Ps = 30 / 40> >> fg/bg Black
392	B<< C<Ps = 31 / 41> >> fg/bg Red	1130	B<< C<Ps = 31 / 41> >> fg/bg Red
393	B<< C<Ps = 32 / 42> >> fg/bg Green	1131	B<< C<Ps = 32 / 42> >> fg/bg Green
394	B<< C<Ps = 33 / 43> >> fg/bg Yellow	1132	B<< C<Ps = 33 / 43> >> fg/bg Yellow
395	B<< C<Ps = 34 / 44> >> fg/bg Blue	1133	B<< C<Ps = 34 / 44> >> fg/bg Blue
396	B<< C<Ps = 35 / 45> >> fg/bg Magenta	1134	B<< C<Ps = 35 / 45> >> fg/bg Magenta
397	B<< C<Ps = 36 / 46> >> fg/bg Cyan	1135	B<< C<Ps = 36 / 46> >> fg/bg Cyan
		1136	B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
398	B<< C<Ps = 37 / 47> >> fg/bg White	1137	B<< C<Ps = 37 / 47> >> fg/bg White
399	B<< C<Ps = 39 / 49> >> fg/bg Default	1138	B<< C<Ps = 39 / 49> >> fg/bg Default
		1139	B<< C<Ps = 90 / 100> >> fg/bg Bright Black
		1140	B<< C<Ps = 91 / 101> >> fg/bg Bright Red
		1141	B<< C<Ps = 92 / 102> >> fg/bg Bright Green
		1142	B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
		1143	B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
		1144	B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
		1145	B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
		1146	B<< C<Ps = 97 / 107> >> fg/bg Bright White
		1147	B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400		1148
401	=end table	1149	=end table
402		1150
403	=item B<< C<ESC [ Ps n> >>	1151	=item B<< C<ESC [ Ps n> >>
404		1152
…		…
420		1168
421	=item B<< C<ESC [ s> >>	1169	=item B<< C<ESC [ s> >>
422		1170
423	Save Cursor (SC)	1171	Save Cursor (SC)
424		1172
		1173	=item B<< C<ESC [ Ps;Pt t> >>
		1174
		1175	Window Operations
		1176
		1177	=begin table
		1178
		1179	B<< C<Ps = 1> >> Deiconify (map) window
		1180	B<< C<Ps = 2> >> Iconify window
		1181	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
		1182	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1183	B<< C<Ps = 5> >> Raise window
		1184	B<< C<Ps = 6> >> Lower window
		1185	B<< C<Ps = 7> >> Refresh screen once
		1186	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1187	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1188	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1189	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1190	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1191	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1192	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1193	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1194	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1195
		1196	=end table
		1197
		1198	=item B<< C<ESC [ u> >>
		1199
		1200	Restore Cursor
		1201
425	=item B<< C<ESC [ Ps x> >>	1202	=item B<< C<ESC [ Ps x> >>
426		1203
427	Request Terminal Parameters (DECREQTPARM)	1204	Request Terminal Parameters (DECREQTPARM)
428
429	=item B<< C<ESC [ u> >>
430
431	Restore Cursor
432		1205
433	=back	1206	=back
434		1207
435	X<PrivateModes>	1208	X<PrivateModes>
436		1209
…		…
539	B<< C<h> >> Send Mouse X & Y on button press.	1312	B<< C<h> >> Send Mouse X & Y on button press.
540	B<< C<l> >> No mouse reporting.	1313	B<< C<l> >> No mouse reporting.
541		1314
542	=end table	1315	=end table
543		1316
544	)X<Priv10>
545
546	=item B<< C<Ps = 10> >> (B<rxvt>)	1317	=item B<< C<Ps = 10> >> (B<rxvt>)
547		1318
548	=begin table	1319	=begin table
549		1320
550	B<< C<h> >> visible	1321	B<< C<h> >> menuBar visible
551	B<< C<l> >> invisible	1322	B<< C<l> >> menuBar invisible
552		1323
553	=end table	1324	=end table
554		1325
555	=item B<< C<Ps = 25> >>	1326	=item B<< C<Ps = 25> >>
556		1327
…		…
625		1396
626	=item B<< C<Ps = 66> >>	1397	=item B<< C<Ps = 66> >>
627		1398
628	=begin table	1399	=begin table
629		1400
630	B<< C<h> >> Application Keypad (DECPAM) ==	1401	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631	B<< C<l> >> Normal Keypad (DECPNM) ==	1402	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632		1403
633	=end table	1404	=end table
634		1405
635	=item B<< C<Ps = 67> >>	1406	=item B<< C<Ps = 67> >>
636		1407
…		…
657	B<< C<h> >> Use Hilite Mouse Tracking.	1428	B<< C<h> >> Use Hilite Mouse Tracking.
658	B<< C<l> >> No mouse reporting.	1429	B<< C<l> >> No mouse reporting.
659		1430
660	=end table	1431	=end table
661		1432
662	=item B<< C<Ps = 1010> >>	1433	=item B<< C<Ps = 1010> >> (B<rxvt>)
663		1434
664	=begin table	1435	=begin table
665		1436
666	B<< C<h> >> Don't scroll to bottom on TTY output	1437	B<< C<h> >> Don't scroll to bottom on TTY output
667	B<< C<l> >> Scroll to bottom on TTY output	1438	B<< C<l> >> Scroll to bottom on TTY output
668		1439
669	=end table	1440	=end table
670		1441
671	=item B<< C<Ps = 1011> >>	1442	=item B<< C<Ps = 1011> >> (B<rxvt>)
672		1443
673	=begin table	1444	=begin table
674		1445
675	B<< C<h> >> Scroll to bottom when a key is pressed	1446	B<< C<h> >> Scroll to bottom when a key is pressed
676	B<< C<l> >> Don't scroll to bottom when a key is pressed	1447	B<< C<l> >> Don't scroll to bottom when a key is pressed
…		…
690		1461
691	=begin table	1462	=begin table
692		1463
693	B<< C<h> >> Save cursor position	1464	B<< C<h> >> Save cursor position
694	B<< C<l> >> Restore cursor position	1465	B<< C<l> >> Restore cursor position
		1466
		1467	=end table
		1468
		1469	=item B<< C<Ps = 1049> >>
		1470
		1471	=begin table
		1472
		1473	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
		1474	B<< C<l> >> Use Normal Screen Buffer
695		1475
696	=end table	1476	=end table
697		1477
698	=back	1478	=back
699		1479
…		…
724	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1504	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
725	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1505	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
726	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1506	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
727	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1507	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
728	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1508	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
729	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>	1509	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
730	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1510	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	1511	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
732	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> >>	1512	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> >>
733	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1513	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
734	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension)	1514	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).
735	B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension)	1515	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
736	B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension)	1516	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
		1517	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1518	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
		1519	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1520	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1521	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1522	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1523	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
737		1524
738	=end table	1525	=end table
739		1526
740	=back	1527	=back
741		1528
…		…
793		1580
794	=item B<< [title:+I<string>] >>	1581	=item B<< [title:+I<string>] >>
795		1582
796	set the current menuBar's title to I<string>, which may contain the	1583	set the current menuBar's title to I<string>, which may contain the
797	following format specifiers:	1584	following format specifiers:
798	B<%%> : literal B<%> character	1585
799	B<%n> : rxvt name (as per the B<-name> command-line option)	1586	B<%n> rxvt name (as per the B<-name> command-line option)
800	B<%v> : rxvt version	1587	B<%v> rxvt version
		1588	B<%%> literal B<%> character
801		1589
802	=item B<[done]>	1590	=item B<[done]>
803		1591
804	set menuBar access as B<readonly>.	1592	set menuBar access as B<readonly>.
805	End-of-file tag for B<< [read:+I<file>] >> operations.	1593	End-of-file tag for B<< [read:+I<file>] >> operations.
…		…
951		1739
952	As a convenience for the many Emacs-type editors, I<action> may start	1740	As a convenience for the many Emacs-type editors, I<action> may start
953	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be	1741	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954	appended if missed from B<M-x> commands.	1742	appended if missed from B<M-x> commands.
955		1743
956	As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or	1744	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
957	quick arrow), a B<BEL> (B<^G>) will be appended if needed.	1745	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958		1746
959	=over 4	1747	=over 4
960		1748
961	=item For example,	1749	=item For example,
…		…
1320		2108
1321	Row = B<< C<< <y> - SPACE >> >>	2109	Row = B<< C<< <y> - SPACE >> >>
1322		2110
1323	=back	2111	=back
1324	X<KeyCodes>	2112	X<KeyCodes>
1325
1326	=head1 ISO 14755 support
1327
1328	Partial ISO 14755-support is implemented. that means that pressing
1329
1330	section 5.1: Control and Shift together enters unicode input
1331	mode. Entering hex digits composes a Unicode character, pressing space or
1332	releasing the modifiers commits the keycode and every other key cancels
1333	the current input character.
1334
1335	section 5.2: Pressing and immediately releasing Control and Shift together
1336	enters keycap entry mode for the next key: pressing a function key (tab,
1337	return etc..) will enter the unicode character corresponding to the given
1338	key.
1339		2113
1340	=head1 Key Codes	2114	=head1 Key Codes
1341		2115
1342	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>	2116	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343		2117
…		…
1408	XK_KP_8 8 ESC O x	2182	XK_KP_8 8 ESC O x
1409	XK_KP_9 9 ESC O y	2183	XK_KP_9 9 ESC O y
1410		2184
1411	=end table	2185	=end table
1412		2186
		2187	=head1 CONFIGURE OPTIONS
		2188
		2189	General hint: if you get compile errors, then likely your configuration
		2190	hasn't been tested well. Either try with --enable-everything or use the
		2191	./reconf script as a base for experiments. ./reconf is used by myself,
		2192	so it should generally be a working config. Of course, you should always
		2193	report when a combination doesn't work, so it can be fixed. Marc Lehmann
		2194	<rxvt@schmorp.de>.
		2195
		2196	=over 4
		2197
		2198	=item --enable-everything
		2199
		2200	Add support for all non-multichoice options listed in "./configure
		2201	--help". Note that unlike other enable options this is order dependant.
		2202	You can specify this and then disable options which this enables by
		2203	I<following> this with the appropriate commands.
		2204
		2205	=item --enable-xft
		2206
		2207	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
		2208	slower and require lots of memory, but as long as you don't use them, you
		2209	don't pay for them.
		2210
		2211	=item --enable-font-styles
		2212
		2213	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
		2214	styles. The fonts can be set manually or automatically.
		2215
		2216	=item --with-codesets=NAME,...
		2217
		2218	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
		2219	are always compiled in, which includes most 8-bit character sets). These
		2220	codeset tables are used for driving X11 core fonts, they are not required
		2221	for Xft fonts, although having them compiled in lets rxvt-unicode choose
		2222	replacement fonts more intelligently. Compiling them in will make your
		2223	binary bigger (all of together cost about 700kB), but it doesn't increase
		2224	memory usage unless you use a font requiring one of these encodings.
		2225
		2226	=begin table
		2227
		2228	all all available codeset groups
		2229	zh common chinese encodings
		2230	zh_ext rarely used but very big chinese encodigs
		2231	jp common japanese encodings
		2232	jp_ext rarely used but big japanese encodings
		2233	kr korean encodings
		2234
		2235	=end table
		2236
		2237	=item --enable-xim
		2238
		2239	Add support for XIM (X Input Method) protocol. This allows using
		2240	alternative input methods (e.g. kinput2) and will also correctly
		2241	set up the input for people using dead keys or compose keys.
		2242
		2243	=item --enable-unicode3
		2244
		2245	Enable direct support for displaying unicode codepoints above
		2246	65535 (the basic multilingual page). This increases storage
		2247	requirements per character from 2 to 4 bytes. X11 fonts do not yet
		2248	support these extra characters, but Xft does.
		2249
		2250	Please note that rxvt-unicode can store unicode code points >65535
		2251	even without this flag, but the number of such characters is
		2252	limited to a view thousand (shared with combining characters,
		2253	see next switch), and right now rxvt-unicode cannot display them
		2254	(input/output and cut&paste still work, though).
		2255
		2256	=item --enable-combining
		2257
		2258	Enable automatic composition of combining characters into
		2259	composite characters. This is required for proper viewing of text
		2260	where accents are encoded as seperate unicode characters. This is
		2261	done by using precomposited characters when available or creating
		2262	new pseudo-characters when no precomposed form exists.
		2263
		2264	Without --enable-unicode3, the number of additional precomposed characters
		2265	is rather limited (2048, if this is full, rxvt-unicode will use the
		2266	private use area, extending the number of combinations to 8448). With
		2267	--enable-unicode3, no practical limit exists.
		2268
		2269	This option will also enable storage (but not display) of characters
		2270	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
		2271
		2272	The combining table also contains entries for arabic presentation forms,
		2273	but these are not currently used. Bug me if you want these to be used (and
		2274	tell me how these are to be used...).
		2275
		2276	=item --enable-fallback(=CLASS)
		2277
		2278	When reading resource settings, also read settings for class CLASS
		2279	(default: Rxvt). To disable resource fallback use --disable-fallback.
		2280
		2281	=item --with-res-name=NAME
		2282
		2283	Use the given name (default: urxvt) as default application name when
		2284	reading resources. Specify --with-res-name=rxvt to replace rxvt.
		2285
		2286	=item --with-res-class=CLASS
		2287
		2288	Use the given class (default: URxvt) as default application class
		2289	when reading resources. Specify --with-res-class=Rxvt to replace
		2290	rxvt.
		2291
		2292	=item --enable-utmp
		2293
		2294	Write user and tty to utmp file (used by programs like F<w>) at
		2295	start of rxvt execution and delete information when rxvt exits.
		2296
		2297	=item --enable-wtmp
		2298
		2299	Write user and tty to wtmp file (used by programs like F<last>) at
		2300	start of rxvt execution and write logout when rxvt exits. This
		2301	option requires --enable-utmp to also be specified.
		2302
		2303	=item --enable-lastlog
		2304
		2305	Write user and tty to lastlog file (used by programs like
		2306	F<lastlogin>) at start of rxvt execution. This option requires
		2307	--enable-utmp to also be specified.
		2308
		2309	=item --enable-xpm-background
		2310
		2311	Add support for XPM background pixmaps.
		2312
		2313	=item --enable-transparency
		2314
		2315	Add support for inheriting parent backgrounds thus giving a fake
		2316	transparency to the term.
		2317
		2318	=item --enable-fading
		2319
		2320	Add support for fading the text when focus is lost.
		2321
		2322	=item --enable-tinting
		2323
		2324	Add support for tinting of transparent backgrounds.
		2325
		2326	=item --enable-menubar
		2327
		2328	Add support for our menu bar system (this interacts badly with
		2329	dynamic locale switching currently).
		2330
		2331	=item --enable-rxvt-scroll
		2332
		2333	Add support for the original rxvt scrollbar.
		2334
		2335	=item --enable-next-scroll
		2336
		2337	Add support for a NeXT-like scrollbar.
		2338
		2339	=item --enable-xterm-scroll
		2340
		2341	Add support for an Xterm-like scrollbar.
		2342
		2343	=item --enable-plain-scroll
		2344
		2345	Add support for a very unobtrusive, plain-looking scrollbar that
		2346	is the favourite of the rxvt-unicode author, having used it for
		2347	many years.
		2348
		2349	=item --enable-half-shadow
		2350
		2351	Make shadows on the scrollbar only half the normal width & height.
		2352	only applicable to rxvt scrollbars.
		2353
		2354	=item --enable-ttygid
		2355
		2356	Change tty device setting to group "tty" - only use this if
		2357	your system uses this type of security.
		2358
		2359	=item --disable-backspace-key
		2360
		2361	Disable any handling of the backspace key by us - let the X server
		2362	do it.
		2363
		2364	=item --disable-delete-key
		2365
		2366	Disable any handling of the delete key by us - let the X server
		2367	do it.
		2368
		2369	=item --disable-resources
		2370
		2371	Remove all resources checking.
		2372
		2373	=item --enable-xgetdefault
		2374
		2375	Make resources checking via XGetDefault() instead of our small
		2376	version which only checks ~/.Xdefaults, or if that doesn't exist then
		2377	~/.Xresources.
		2378
		2379	Please note that nowadays, things like XIM will automatically pull in and
		2380	use the full X resource manager, so the overhead of using it might be very
		2381	small, if nonexistant.
		2382
		2383	=item --enable-strings
		2384
		2385	Add support for our possibly faster memset() function and other
		2386	various routines, overriding your system's versions which may
		2387	have been hand-crafted in assembly or may require extra libraries
		2388	to link in. (this breaks ANSI-C rules and has problems on many
		2389	GNU/Linux systems).
		2390
		2391	=item --disable-swapscreen
		2392
		2393	Remove support for swap screen.
		2394
		2395	=item --enable-frills
		2396
		2397	Add support for many small features that are not essential but nice to
		2398	have. Normally you want this, but for very small binaries you may want to
		2399	disable this.
		2400
		2401	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
		2402	in combination with other switches) is:
		2403
		2404	MWM-hints
		2405	EWMH-hints (pid, utf8 names) and protocols (ping)
		2406	seperate underline colour
		2407	settable border widths and borderless switch
		2408	settable extra linespacing
		2409	iso-14755-2 and -3, and visual feedback
		2410	backindex and forwardindex escape sequence
		2411	window op and some xterm/OSC escape sequences
		2412	tripleclickwords
		2413	settable insecure mode
		2414	keysym remapping support
		2415	cursor blinking and underline cursor
		2416	-embed and -pty-fd options
		2417
		2418	=item --enable-iso14755
		2419
		2420	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
		2421	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
		2422	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
		2423	this switch.
		2424
		2425	=item --enable-keepscrolling
		2426
		2427	Add support for continual scrolling of the display when you hold
		2428	the mouse button down on a scrollbar arrow.
		2429
		2430	=item --enable-mousewheel
		2431
		2432	Add support for scrolling via mouse wheel or buttons 4 & 5.
		2433
		2434	=item --enable-slipwheeling
		2435
		2436	Add support for continual scrolling (using the mouse wheel as an
		2437	accelerator) while the control key is held down. This option
		2438	requires --enable-mousewheel to also be specified.
		2439
		2440	=item --disable-new-selection
		2441
		2442	Remove support for mouse selection style like that of xterm.
		2443
		2444	=item --enable-dmalloc
		2445
		2446	Use Gray Watson's malloc - which is good for debugging See
		2447	http://www.letters.com/dmalloc/ for details If you use either this or the
		2448	next option, you may need to edit src/Makefile after compiling to point
		2449	DINCLUDE and DLIB to the right places.
		2450
		2451	You can only use either this option and the following (should
		2452	you use either) .
		2453
		2454	=item --enable-dlmalloc
		2455
		2456	Use Doug Lea's malloc - which is good for a production version
		2457	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
		2458
		2459	=item --enable-smart-resize
		2460
		2461	Add smart growth/shrink behaviour when changing font size via from hot
		2462	keys. This should keep in a fixed position the rxvt corner which is
		2463	closest to a corner of the screen.
		2464
		2465	=item --enable-pointer-blank
		2466
		2467	Add support to have the pointer disappear when typing or inactive.
		2468
		2469	=item --with-name=NAME
		2470
		2471	Set the basename for the installed binaries (default: C<urxvt>, resulting
		2472	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
		2473	C<rxvt>.
		2474
		2475	=item --with-term=NAME
		2476
		2477	Change the environmental variable for the terminal to NAME (default
		2478	C<rxvt-unicode>)
		2479
		2480	=item --with-terminfo=PATH
		2481
		2482	Change the environmental variable for the path to the terminfo tree to
		2483	PATH.
		2484
		2485	=item --with-x
		2486
		2487	Use the X Window System (pretty much default, eh?).
		2488
		2489	=item --with-xpm-includes=DIR
		2490
		2491	Look for the XPM includes in DIR.
		2492
		2493	=item --with-xpm-library=DIR
		2494
		2495	Look for the XPM library in DIR.
		2496
		2497	=item --with-xpm
		2498
		2499	Not needed - define via --enable-xpm-background.
		2500
		2501	=back
		2502
		2503	=head1 AUTHORS
		2504
		2505	Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
		2506	reworked it from the original Rxvt documentation, which was done by Geoff
		2507	Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
		2508	sources.
		2509

Diff Legend

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