[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.pod

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.23 by root, Wed Aug 25 03:47:20 2004 UTC vs.
Revision 1.48 by root, Thu Feb 17 12:00:33 2005 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	RXVT TECHNICAL REFERENCE - command sequences and background information	3	RXVT REFERENCE - FAQ, command sequences and other background information
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	# set a new font set	7	# set a new font set
8	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"	8	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
10	# change the locale and tell rxvt-unicode about it	10	# change the locale and tell rxvt-unicode about it
11	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"	11	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12		12
13	# set window title	13	# set window title
14	printf '\33]2;%s\007' "new 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 contains large patches that
		37	considerably change the behaviour of rxvt-unicode. Before reporting a
		38	bug to the original rxvt-unicode author please download and install the
		39	genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
		40	reproduce the problem. If you cannot, chances are that the problems are
		41	specific to Debian GNU/Linux, in which case it should be reported via the
		42	Debian Bug Tracking System (use C<reportbug> to report the bug).
		43
		44	For other problems that also affect the Debian package, you can and
		45	probably should use the Debian BTS, too, because, after all, it's also a
		46	bug in the Debian version and it serves as a reminder for other users that
		47	might encounter the same issue.
		48
		49	=item When I log-in to another system it tells me about missing terminfo data?
		50
		51	The terminal description used by rxvt-unicode is not as widely available
		52	as that for xterm, or even rxvt (for which the same problem often arises).
		53
		54	The correct solution for this problem is to install the terminfo, this can
		55	be done like this (with ncurses' infocmp):
		56
		57	REMOTE=remotesystem.domain
		58	infocmp rxvt-unicode \| ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
		59
		60	... or by installing rxvt-unicode normally on the remote system,
		61
		62	If you cannot or do not want to do this, then you can simply set
		63	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		64	problems arising, which includes wrong keymapping, less and different
		65	colours and some refresh errors in fullscreen applications. It's a nice
		66	quick-and-dirty workaround for rare cases, though.
		67
		68	If you always want to do this (and are fine with the consequences) you
		69	can either recompile rxvt-unicode with the desired TERM value or use a
		70	resource to set it:
		71
		72	URxvt.termName: rxvt
		73
		74	If you don't plan to use B<rxvt> (quite common...) you could also replace
		75	the rxvt terminfo file with the rxvt-unicode one.
		76
		77	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
		78
		79	=item I need a termcap file entry.
		80
		81	One reason you might want this is that some distributions or operating
		82	systems still compile some programs using the long-obsoleted termcap
		83	library (Fedora Core's bash is one example) and rely on a termcap entry
		84	for C<rxvt-unicode>.
		85
		86	You could use rxvt's termcap entry with resonable results in many cases.
		87	You can also create a termcap entry by using terminfo's infocmp program
		88	like this:
		89
		90	infocmp -C rxvt-unicode
		91
		92	Or you could use this termcap entry, generated by the command above:
		93
		94	rxvt-unicode\|rxvt-unicode terminal (X Window System):\
		95	:am:bw:eo:km:mi:ms:xn:xo:\
		96	:co#80:it#8:li#24:lm#0:\
		97	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		98	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		99	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		100	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		101	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		102	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		103	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		104	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		105	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		106	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		107	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		108	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		109	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		110	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		111	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		112	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		113	:vs=\E[?25h:
		114
		115	=item Why does C<ls> no longer have coloured output?
		116
		117	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		118	decide wether a terminal has colour, but uses it's own configuration
		119	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
		120	with most other terminals supporting colour). Either add:
		121
		122	TERM rxvt-unicode
		123
		124	to C</etc/DIR_COLORS> or simply add:
		125
		126	alias ls='ls --color=auto'
		127
		128	to your C<.profile> or C<.bashrc>.
		129
		130	=item Why doesn't vim/emacs etc. use the 88 colour mode?
		131
		132	=item Why doesn't vim/emacs etc. make use of italic?
		133
		134	=item Why are the secondary screen-related options not working properly?
		135
		136	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		137	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		138	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		139	features. Unfortunately, some of these (most notably, again, Debian
		140	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		141	file, so you will need to install it on your own (See the question B<When
		142	I log-in to another system it tells me about missing terminfo data?> on
		143	how to do this).
		144
		145	=item My numerical keypad acts weird and generates differing output?
		146
		147	Some Debian GNUL/Linux users seem to have this problem, although no
		148	specific details were reported so far. It is possible that this is caused
		149	by the wrong C<TERM> setting, although the details of wether and how
		150	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		151	keymap. See the answer to the previous question, and please report if that
		152	helped.
		153
		154	=item Rxvt-unicode does not seem to understand the selected encoding?
		155
		156	=item Unicode does not seem to work?
		157
		158	If you encounter strange problems like typing an accented character but
		159	getting two unrelated other characters or similar, or if program output is
		160	subtly garbled, then you should check your locale settings.
		161
		162	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		163	programs. Often rxvt-unicode is started in the C<C> locale, while the
		164	login script running within the rxvt-unicode window changes the locale to
		165	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
		166
		167	The best thing is to fix your startup environment, as you will likely run
		168	into other problems. If nothing works you can try this in your .profile.
		169
		170	printf '\e]701;%s\007' "$LC_CTYPE"
		171
		172	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		173	supported on your systems. Some systems have a C<locale> command which
		174	displays this (also, C<perl -e0> can be used to check locale settings, as
		175	it will complain loudly if it cannot set the locale). If it displays something
		176	like:
		177
		178	locale: Cannot set LC_CTYPE to default locale: ...
		179
		180	Then the locale you specified is not supported on your system.
		181
		182	If nothing works and you are sure that everything is set correctly then
		183	you will need to remember a little known fact: Some programs just don't
		184	support locales :(
		185
		186	=item Why do some characters look so much different than others?
		187
		188	=item How does rxvt-unicode choose fonts?
		189
		190	Most fonts do not contain the full range of Unicode, which is
		191	fine. Chances are that the font you (or the admin/package maintainer of
		192	your system/os) have specified does not cover all the characters you want
		193	to display.
		194
		195	B<rxvt-unicode> makes a best-effort try at finding a replacement
		196	font. Often the result is fine, but sometimes the chosen font looks
		197	bad/ugly/wrong. Some fonts have totally strange characters that don't
		198	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		199	intelligence to detect that a specific glyph is wrong: it has to believe
		200	the font that the characters it claims to contain indeed look correct.
		201
		202	In that case, select a font of your taste and add it to the font list,
		203	e.g.:
		204
		205	@@RXVT_NAME@@ -fn basefont,font2,font3...
		206
		207	When rxvt-unicode sees a character, it will first look at the base
		208	font. If the base font does not contain the character, it will go to the
		209	next font, and so on. Specifying your own fonts will also speed up this
		210	search and use less resources within rxvt-unicode and the X-server.
		211
		212	The only limitation is that none of the fonts may be larger than the base
		213	font, as the base font defines the terminal character cell size, which
		214	must be the same due to the way terminals work.
		215
		216	=item Why do some chinese characters look so different than others?
		217
		218	This is because there is a difference between script and language --
		219	rxvt-unicode does not know which language the text that is output is,
		220	as it only knows the unicode character codes. If rxvt-unicode first
		221	sees a japanese/chinese character, it might choose a japanese font for
		222	display. Subsequent japanese characters will use that font. Now, many
		223	chinese characters aren't represented in japanese fonts, so when the first
		224	non-japanese character comes up, rxvt-unicode will look for a chinese font
		225	-- unfortunately at this point, it will still use the japanese font for
		226	chinese characters that are also in the japanese font.
		227
		228	The workaround is easy: just tag a chinese font at the end of your font
		229	list (see the previous question). The key is to view the font list as
		230	a preference list: If you expect more japanese, list a japanese font
		231	first. If you expect more chinese, put a chinese font first.
		232
		233	In the future it might be possible to switch language preferences at
		234	runtime (the internal data structure has no problem with using different
		235	fonts for the same character at the same time, but no interface for this
		236	has been designed yet).
		237
		238	Until then, you might get away with switching fonts at runtime (see L<Can
		239	I switch the fonts at runtime?> later in this document).
		240
		241	=item Why does rxvt-unicode sometimes leave pixel droppings?
		242
		243	Most fonts were not designed for terminal use, which means that character
		244	size varies a lot. A font that is otherwise fine for terminal use might
		245	contain some characters that are simply too wide. Rxvt-unicode will avoid
		246	these characters. For characters that are just "a bit" too wide a special
		247	"careful" rendering mode is used that redraws adjacent characters.
		248
		249	All of this requires that fonts do not lie about character sizes,
		250	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		251	box, and rxvt-unicode has no way of detecting this (the correct way is to
		252	ask for the character bounding box, which unfortunately is wrong in these
		253	cases).
		254
		255	It's not clear (to me at least), wether this is a bug in Xft, freetype,
		256	or the respective font. If you encounter this problem you might try using
		257	the C<-lsp> option to give the font more height. If that doesn't work, you
		258	might be forced to use a different font.
		259
		260	All of this is not a problem when using X11 core fonts, as their bounding
		261	box data is correct.
		262
		263	=item My Compose (Multi_key) key is no longer working.
		264
		265	The most common causes for this are that either your locale is not set
		266	correctly, or you specified a B<preeditStyle> that is not supported by
		267	your input method. For example, if you specified B<OverTheSpot> and
		268	your input method (e.g. the default input method handling Compose keys)
		269	does not support this (for instance because it is not visual), then
		270	rxvt-unicode will continue without an input method.
		271
		272	In this case either do not specify a B<preeditStyle> or specify more than
		273	one pre-edit style, such as B<OverTheSpot,Root,None>.
		274
		275	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		276
		277	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		278	international keyboards) or simply use ISO 14755 support to your
		279	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		280	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		281	character and so on.
		282
		283	=item How can I keep rxvt-unicode from using reverse video so much?
		284
		285	First of all, make sure you are running with the right terminal settings
		286	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		287	make sure you have specified colours for italic and bold, as otherwise
		288	rxvt-unicode might use reverse video to simulate the effect:
		289
		290	URxvt.colorBD: white
		291	URxvt.colorIT: green
		292
		293	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
		294
		295	For some unexplainable reason, some rare programs assume a very weird
		296	colour palette when confronted with a terminal with more than the standard
		297	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		298	these programs not to assume non-ISO colours without very good reasons.
		299
		300	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		301	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		302	fix colours but keep you from using other rxvt-unicode features.
		303
		304	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
		305
		306	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		307	in your compile environment, or an implementation that implements it,
		308	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		309	B<wchar_t> is represented as unicode.
		310
		311	As you might have guessed, FreeBSD does neither define this symobl nor
		312	does it support it. Instead, it uses it's own internal representation of
		313	B<wchar_t>. This is, of course, completely fine with respect to standards.
		314
		315	However, C<__STDC_ISO_10646__> is the only sane way to support
		316	multi-language apps in an OS, as using a locale-dependent (and
		317	non-standardized) representation of B<wchar_t> makes it impossible to
		318	convert between B<wchar_t> (as used by X11 and your applications) and any
		319	other encoding without implementing OS-specific-wrappers for each and
		320	every locale. There simply are no APIs to convert B<wchar_t> into anything
		321	except the current locale encoding.
		322
		323	Some applications (such as the formidable B<mlterm>) work around this
		324	by carrying their own replacement functions for character set handling
		325	with them, and either implementing OS-dependent hacks or doing multiple
		326	conversions (which is slow and unreliable in case the OS implements
		327	encodings slightly different than the terminal emulator).
		328
		329	The rxvt-unicode author insists that the right way to fix this is in the
		330	system libraries once and for all, instead of forcing every app to carry
		331	complete replacements for them :)
		332
		333	=item How does rxvt-unicode determine the encoding to use?
		334
		335	=item Is there an option to switch encodings?
		336
		337	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		338	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		339	UTF-8 or any other encodings with respect to terminal I/O.
		340
		341	The reasons is that there exists a perfectly fine mechanism for selecting
		342	the encoding, doing I/O and (most important) communicating this to all
		343	applications so everybody agrees on character properties such as width
		344	and code number. This mechanism is the I<locale>. Applications not using
		345	that info will have problems (for example, C<xterm> gets the width of
		346	characters wrong as it uses it's own, locale-independent table under all
		347	locales).
		348
		349	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		350	programs doing the same (that is, most) will automatically agree in the
		351	interpretation of characters.
		352
		353	Unfortunately, there is no system-independent way to select locales, nor
		354	is there a standard on how locale specifiers will look like.
		355
		356	On most systems, the content of the C<LC_CTYPE> environment variable
		357	contains an arbitrary string which corresponds to an already-installed
		358	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		359	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		360	(i.e. C<de> or C<german>) are also common.
		361
		362	Rxvt-unicode ignores all other locale categories, and except for
		363	the encoding, ignores country or language-specific settings,
		364	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		365	rxvt-unicode.
		366
		367	If you want to use a specific encoding you have to make sure you start
		368	rxvt-unicode with the correct C<LC_CTYPE> category.
		369
		370	=item Can I switch locales at runtime?
		371
		372	Yes, using an escape sequence. Try something like this, which sets
		373	rxvt-unicode's idea of C<LC_CTYPE>.
		374
		375	printf '\e]701;%s\007' ja_JP.SJIS
		376
		377	See also the previous answer.
		378
		379	Sometimes this capability is rather handy when you want to work in
		380	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		381	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		382	first switches to a locale supported by xjdic and back later:
		383
		384	printf '\e]701;%s\007' ja_JP.SJIS
		385	xjdic -js
		386	printf '\e]701;%s\007' de_DE.UTF-8
		387
		388	You can also use xterm's C<luit> program, which usually works fine, except
		389	for some locales where character width differs between program- and
		390	rxvt-unicode-locales.
		391
		392	=item Can I switch the fonts at runtime?
		393
		394	Yes, using an escape sequence. Try something like this, which has the same
		395	effect as using the C<-fn> switch, and takes effect immediately:
		396
		397	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
		398
		399	This is useful if you e.g. work primarily with japanese (and prefer a
		400	japanese font), but you have to switch to chinese temporarily, where
		401	japanese fonts would only be in your way.
		402
		403	You can think of this as a kind of manual ISO-2022 switching.
		404
		405	=item Why do italic characters look as if clipped?
		406
		407	Many fonts have difficulties with italic characters and hinting. For
		408	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		409	Mono> completely fails in it's italic face. A workaround might be to
		410	enable freetype autohinting, i.e. like this:
		411
		412	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		413	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		414
		415	=item My input method wants <some encoding> but I want UTF-8, what can I do?
		416
		417	You can specify separate locales for the input method and the rest of the
		418	terminal, using the resource C<imlocale>:
		419
		420	URxvt*imlocale: ja_JP.EUC-JP
		421
		422	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		423	use your input method. Please note, however, that you will not be able to
		424	input characters outside C<EUC-JP> in a normal way then, as your input
		425	method limits you.
		426
		427	=item Rxvt-unicode crashes when the X Input Method changes or exits.
		428
		429	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		430	design. Applications can avoid some crashes at the expense of memory
		431	leaks, and Input Methods can avoid some crashes by careful ordering at
		432	exit time. B<kinput2> (and derived input methods) generally succeeds,
		433	while B<SCIM> (or similar input methods) fails. In the end, however,
		434	crashes cannot be completely avoided even if both sides cooperate.
		435
		436	So the only workaround is not to kill your Input Method Servers.
		437
		438	=item Rxvt-unicode uses gobs of memory, how can I reduce that?
		439
		440	Rxvt-unicode tries to obey the rule of not charging you for something you
		441	don't use. One thing you should try is to configure out all settings that
		442	you don't need, for example, Xft support is a resource hog by design,
		443	when used. Compiling it out ensures that no Xft font will be loaded
		444	accidentally when rxvt-unicode tries to find a font for your characters.
		445
		446	Also, many people (me included) like large windows and even larger
		447	scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
		448	6 bytes per screen cell. For a 160x?? window this amounts to almost a
		449	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
		450	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
		451	rxvt-unicode then uses 8 bytes per screen cell.
		452
		453	=item Can I speed up Xft rendering somehow?
		454
		455	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
		456	it is simply slow. If you still want Xft fonts you might try to disable
		457	antialiasing (by appending C<:antialiasing=false>), which saves lots of
		458	memory and also speeds up rendering considerably.
		459
		460	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
		461
		462	Rxvt-unicode will use whatever you specify as a font. If it needs to
		463	fall back to it's default font search list it will prefer X11 core
		464	fonts, because they are small and fast, and then use Xft fonts. It has
		465	antialiasing disabled for most of them, because the author thinks they
		466	look best that way.
		467
		468	If you want antialiasing, you have to specify the fonts manually.
		469
		470	=item Mouse cut/paste suddenly no longer works.
		471
		472	Make sure that mouse reporting is actually turned off since killing
		473	some editors prematurely may leave the mouse in mouse report mode. I've
		474	heard that tcsh may use mouse reporting unless it otherwise specified. A
		475	quick check is to see if cut/paste works when the Alt or Shift keys are
		476	depressed. See @@RXVT_NAME@@(7)
		477
		478	=item What's with this bold/blink stuff?
		479
		480	If no bold colour is set via C<colorBD:>, bold will invert text using the
		481	standard foreground colour.
		482
		483	For the standard background colour, blinking will actually make the
		484	text blink when compiled with C<--enable-blinking>. with standard
		485	colours. Without C<--enable-blinking>, the blink attribute will be
		486	ignored.
		487
		488	On ANSI colours, bold/blink attributes are used to set high-intensity
		489	foreground/background colors.
		490
		491	color0-7 are the low-intensity colors.
		492
		493	color8-15 are the corresponding high-intensity colors.
		494
		495	=item I don't like the screen colors. How do I change them?
		496
		497	You can change the screen colors at run-time using F<~/.Xdefaults>
		498	resources (or as long-options).
		499
		500	Here are values that are supposed to resemble a VGA screen,
		501	including the murky brown that passes for low-intensity yellow:
		502
		503	URxvt.color0: #000000
		504	URxvt.color1: #A80000
		505	URxvt.color2: #00A800
		506	URxvt.color3: #A8A800
		507	URxvt.color4: #0000A8
		508	URxvt.color5: #A800A8
		509	URxvt.color6: #00A8A8
		510	URxvt.color7: #A8A8A8
		511
		512	URxvt.color8: #000054
		513	URxvt.color9: #FF0054
		514	URxvt.color10: #00FF54
		515	URxvt.color11: #FFFF54
		516	URxvt.color12: #0000FF
		517	URxvt.color13: #FF00FF
		518	URxvt.color14: #00FFFF
		519	URxvt.color15: #FFFFFF
		520
		521	And here is a more complete set of non-standard colors described (not by
		522	me) as "pretty girly".
		523
		524	URxvt.cursorColor: #dc74d1
		525	URxvt.pointerColor: #dc74d1
		526	URxvt.background: #0e0e0e
		527	URxvt.foreground: #4ad5e1
		528	URxvt.color0: #000000
		529	URxvt.color8: #8b8f93
		530	URxvt.color1: #dc74d1
		531	URxvt.color9: #dc74d1
		532	URxvt.color2: #0eb8c7
		533	URxvt.color10: #0eb8c7
		534	URxvt.color3: #dfe37e
		535	URxvt.color11: #dfe37e
		536	URxvt.color5: #9e88f0
		537	URxvt.color13: #9e88f0
		538	URxvt.color6: #73f7ff
		539	URxvt.color14: #73f7ff
		540	URxvt.color7: #e1dddd
		541	URxvt.color15: #e1dddd
		542
		543	=item How can I start @@RXVT_NAME@@d in a race-free way?
		544
		545	Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
		546	server that answers @@RXVT_NAME@@c's requests, so it doesn't background
		547	itself.
		548
		549	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
		550	following method to wait for the startup message before continuing:
		551
		552	{ @@RXVT_NAME@@d & } \| read
		553
		554	=item What's with the strange Backspace/Delete key behaviour?
		555
		556	Assuming that the physical Backspace key corresponds to the
		557	BackSpace keysym (not likely for Linux ... see the following
		558	question) there are two standard values that can be used for
		559	Backspace: C<^H> and C<^?>.
		560
		561	Historically, either value is correct, but rxvt-unicode adopts the debian
		562	policy of using C<^?> when unsure, because it's the one only only correct
		563	choice :).
		564
		565	Rxvt-unicode tries to inherit the current stty settings and uses the value
		566	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
		567	started from a terminal (say, from a menu or by remote shell), then the
		568	system value of `erase', which corresponds to CERASE in <termios.h>, will
		569	be used (which may not be the same as your stty setting).
		570
		571	For starting a new rxvt-unicode:
		572
		573	# use Backspace = ^H
		574	$ stty erase ^H
		575	$ @@RXVT_NAME@@
		576
		577	# use Backspace = ^?
		578	$ stty erase ^?
		579	$ @@RXVT_NAME@@
		580
		581	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
		582
		583	For an existing rxvt-unicode:
		584
		585	# use Backspace = ^H
		586	$ stty erase ^H
		587	$ echo -n "^[[36h"
		588
		589	# use Backspace = ^?
		590	$ stty erase ^?
		591	$ echo -n "^[[36l"
		592
		593	This helps satisfy some of the Backspace discrepancies that occur, but
		594	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
		595	properly reflects that.
		596
		597	The Delete key is a another casualty of the ill-defined Backspace problem.
		598	To avoid confusion between the Backspace and Delete keys, the Delete
		599	key has been assigned an escape sequence to match the vt100 for Execute
		600	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
		601
		602	Some other Backspace problems:
		603
		604	some editors use termcap/terminfo,
		605	some editors (vim I'm told) expect Backspace = ^H,
		606	GNU Emacs (and Emacs-like editors) use ^H for help.
		607
		608	Perhaps someday this will all be resolved in a consistent manner.
		609
		610	=item I don't like the key-bindings. How do I change them?
		611
		612	There are some compile-time selections available via configure. Unless
		613	you have run "configure" with the C<--disable-resources> option you can
		614	use the `keysym' resource to alter the keystrings associated with keysyms.
		615
		616	Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
		617
		618	URxvt.keysym.Home: \033[1~
		619	URxvt.keysym.End: \033[4~
		620	URxvt.keysym.C-apostrophe: \033<C-'>
		621	URxvt.keysym.C-slash: \033<C-/>
		622	URxvt.keysym.C-semicolon: \033<C-;>
		623	URxvt.keysym.C-grave: \033<C-`>
		624	URxvt.keysym.C-comma: \033<C-,>
		625	URxvt.keysym.C-period: \033<C-.>
		626	URxvt.keysym.C-0x60: \033<C-`>
		627	URxvt.keysym.C-Tab: \033<C-Tab>
		628	URxvt.keysym.C-Return: \033<C-Return>
		629	URxvt.keysym.S-Return: \033<S-Return>
		630	URxvt.keysym.S-space: \033<S-Space>
		631	URxvt.keysym.M-Up: \033<M-Up>
		632	URxvt.keysym.M-Down: \033<M-Down>
		633	URxvt.keysym.M-Left: \033<M-Left>
		634	URxvt.keysym.M-Right: \033<M-Right>
		635	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
		636	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
		637	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
		638
		639	See some more examples in the documentation for the B<keysym> resource.
		640
		641	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
		642	How do I make use of them? For example, the Sun Keyboard type 4
		643	has the following mappings that rxvt-unicode doesn't recognize.
		644
		645	KP_Insert == Insert
		646	F22 == Print
		647	F27 == Home
		648	F29 == Prior
		649	F33 == End
		650	F35 == Next
		651
		652	Rather than have rxvt-unicode try to accommodate all the various possible
		653	keyboard mappings, it is better to use `xmodmap' to remap the keys as
		654	required for your particular machine.
		655
		656	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
		657	I need this to decide about setting colors etc.
		658
		659	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
		660	check and see if that is set. Note that several programs, JED, slrn,
		661	Midnight Commander automatically check this variable to decide whether or
		662	not to use color.
		663
		664	=item How do I set the correct, full IP address for the DISPLAY variable?
		665
		666	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
		667	insecure mode then it is possible to use the following shell script
		668	snippets to correctly set the display. If your version of rxvt-unicode
		669	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
		670	the COLORTERM variable can be used to distinguish rxvt-unicode from a
		671	regular xterm.
		672
		673	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
		674	snippets:
		675
		676	# Bourne/Korn/POSIX family of shells:
		677	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
		678	if [ ${TERM:-foo} = xterm ]; then
		679	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
		680	echo -n '^[Z'
		681	read term_id
		682	stty icanon echo
		683	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
		684	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
		685	read DISPLAY # set it in our local shell
		686	fi
		687	fi
		688
		689	=item How do I compile the manual pages for myself?
		690
		691	You need to have a recent version of perl installed as F</usr/bin/perl>,
		692	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
		693	the doc subdirectory and enter C<make alldoc>.
		694
		695	=item My question isn't answered here, can I ask a human?
		696
		697	Before sending me mail, you could go to IRC: C<irc.freenode.net>,
		698	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
		699	interested in learning about new and exciting problems (but not FAQs :).
		700
		701	=back
		702
		703	=head1 RXVT TECHNICAL REFERENCE
15		704
16	=head1 DESCRIPTION	705	=head1 DESCRIPTION
17		706
18	The rest of this document describes various technical aspects of	707	The rest of this document describes various technical aspects of
19	B<rxvt-unicode>. First the description of supported command sequences,	708	B<rxvt-unicode>. First the description of supported command sequences,
20	followed by menu and pixmap support and last by a description of all	709	followed by menu and pixmap support and last by a description of all
21	features selectable at C<configure> time.	710	features selectable at C<configure> time.
22		711
23	=head1 RXVT TECHNICAL REFERENCE
24
25	=head1 Definitions	712	=head1 Definitions
26		713
27	=over 4	714	=over 4
28		715
29	=item B<< C<c> >>	716	=item B<< C<c> >>
…		…
157	Single Shift Select of G3 Character Set (SS3): affects next character	844	Single Shift Select of G3 Character Set (SS3): affects next character
158	only I<unimplemented>	845	only I<unimplemented>
159		846
160	=item B<< C<ESC Z> >>	847	=item B<< C<ESC Z> >>
161		848
162	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>	849	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
163		850
164	=item B<< C<ESC c> >>	851	=item B<< C<ESC c> >>
165		852
166	Full reset (RIS)	853	Full reset (RIS)
167		854
…		…
171		858
172	=item B<< C<ESC o> >>	859	=item B<< C<ESC o> >>
173		860
174	Invoke the G3 Character Set (LS3)	861	Invoke the G3 Character Set (LS3)
175		862
176	=item B<< C<ESC> ( C> >>	863	=item B<< C<ESC ( C> >>
177		864
178	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	865	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
179		866
180	=item B<< C<ESC> ) C> >>	867	=item B<< C<ESC ) C> >>
181		868
182	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	869	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
183		870
184	=item B<< C<ESC * C> >>	871	=item B<< C<ESC * C> >>
185		872
…		…
326		1013
327	=item B<< C<ESC [ Ps c> >>	1014	=item B<< C<ESC [ Ps c> >>
328		1015
329	Send Device Attributes (DA)	1016	Send Device Attributes (DA)
330	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1017	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
331	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1018	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
332	Option'')	1019	Option'')
333		1020
334	=item B<< C<ESC [ Ps d> >>	1021	=item B<< C<ESC [ Ps d> >>
335		1022
336	Cursor to Line B<< C<Ps> >> (VPA)	1023	Cursor to Line B<< C<Ps> >> (VPA)
…		…
452		1139
453	=item B<< C<ESC [ s> >>	1140	=item B<< C<ESC [ s> >>
454		1141
455	Save Cursor (SC)	1142	Save Cursor (SC)
456		1143
		1144	=item B<< C<ESC [ Ps;Pt t> >>
		1145
		1146	Window Operations
		1147
		1148	=begin table
		1149
		1150	B<< C<Ps = 1> >> Deiconify (map) window
		1151	B<< C<Ps = 2> >> Iconify window
		1152	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X\|Y)
		1153	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1154	B<< C<Ps = 5> >> Raise window
		1155	B<< C<Ps = 6> >> Lower window
		1156	B<< C<Ps = 7> >> Refresh screen once
		1157	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1158	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1159	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1160	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1161	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1162	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1163	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1164	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1165	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1166
		1167	=end table
		1168
		1169	=item B<< C<ESC [ u> >>
		1170
		1171	Restore Cursor
		1172
457	=item B<< C<ESC [ Ps x> >>	1173	=item B<< C<ESC [ Ps x> >>
458		1174
459	Request Terminal Parameters (DECREQTPARM)	1175	Request Terminal Parameters (DECREQTPARM)
460
461	=item B<< C<ESC [ u> >>
462
463	Restore Cursor
464		1176
465	=back	1177	=back
466		1178
467	X<PrivateModes>	1179	X<PrivateModes>
468		1180
…		…
837		1549
838	=item B<< [title:+I<string>] >>	1550	=item B<< [title:+I<string>] >>
839		1551
840	set the current menuBar's title to I<string>, which may contain the	1552	set the current menuBar's title to I<string>, which may contain the
841	following format specifiers:	1553	following format specifiers:
842	B<%%> : literal B<%> character	1554
843	B<%n> : rxvt name (as per the B<-name> command-line option)	1555	B<%n> rxvt name (as per the B<-name> command-line option)
844	B<%v> : rxvt version	1556	B<%v> rxvt version
		1557	B<%%> literal B<%> character
845		1558
846	=item B<[done]>	1559	=item B<[done]>
847		1560
848	set menuBar access as B<readonly>.	1561	set menuBar access as B<readonly>.
849	End-of-file tag for B<< [read:+I<file>] >> operations.	1562	End-of-file tag for B<< [read:+I<file>] >> operations.
…		…
995		1708
996	As a convenience for the many Emacs-type editors, I<action> may start	1709	As a convenience for the many Emacs-type editors, I<action> may start
997	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be	1710	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
998	appended if missed from B<M-x> commands.	1711	appended if missed from B<M-x> commands.
999		1712
1000	As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or	1713	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1001	quick arrow), a B<BEL> (B<^G>) will be appended if needed.	1714	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1002		1715
1003	=over 4	1716	=over 4
1004		1717
1005	=item For example,	1718	=item For example,
…		…
1479	you use an X11 font requiring one of these encodings.	2192	you use an X11 font requiring one of these encodings.
1480		2193
1481	=begin table	2194	=begin table
1482		2195
1483	all all available codeset groups	2196	all all available codeset groups
1484	cn common chinese encodings	2197	zh common chinese encodings
1485	cn_ext rarely used but very big chinese encodigs	2198	zh_ext rarely used but very big chinese encodigs
1486	jp common japanese encodings	2199	jp common japanese encodings
1487	jp_ext rarely used but big japanese encodings	2200	jp_ext rarely used but big japanese encodings
1488	kr korean encodings	2201	kr korean encodings
1489		2202
1490	=end table	2203	=end table
…		…
1514	composite characters. This is required for proper viewing of text	2227	composite characters. This is required for proper viewing of text
1515	where accents are encoded as seperate unicode characters. This is	2228	where accents are encoded as seperate unicode characters. This is
1516	done by using precomposited characters when available or creating	2229	done by using precomposited characters when available or creating
1517	new pseudo-characters when no precomposed form exists.	2230	new pseudo-characters when no precomposed form exists.
1518		2231
1519	Without --enable-unicode3, the number of additional precomposed	2232	Without --enable-unicode3, the number of additional precomposed characters
1520	characters is rather limited (2048, if this is full, rxvt will use the	2233	is rather limited (2048, if this is full, rxvt-unicode will use the
1521	private use area, extending the number of combinations to 8448). With	2234	private use area, extending the number of combinations to 8448). With
1522	--enable-unicode3, no practical limit exists. This will also enable	2235	--enable-unicode3, no practical limit exists.
1523	storage of characters >65535.	2236
		2237	This option will also enable storage (but not display) of characters
		2238	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1524		2239
1525	The combining table also contains entries for arabic presentation forms,	2240	The combining table also contains entries for arabic presentation forms,
1526	but these are not currently used. Bug me if you want these to be used.	2241	but these are not currently used. Bug me if you want these to be used (and
		2242	tell me how these are to be used...).
1527		2243
1528	=item --enable-fallback(=CLASS)	2244	=item --enable-fallback(=CLASS)
1529		2245
1530	When reading resource settings, also read settings for class CLASS	2246	When reading resource settings, also read settings for class CLASS
1531	(default: Rxvt). To disable resource fallback use --disable-fallback.	2247	(default: Rxvt). To disable resource fallback use --disable-fallback.
…		…
1623	Remove all resources checking.	2339	Remove all resources checking.
1624		2340
1625	=item --enable-xgetdefault	2341	=item --enable-xgetdefault
1626		2342
1627	Make resources checking via XGetDefault() instead of our small	2343	Make resources checking via XGetDefault() instead of our small
1628	version which only checks ~/.Xdefaults, or if that doesn't exist	2344	version which only checks ~/.Xdefaults, or if that doesn't exist then
1629	then ~/.Xresources.	2345	~/.Xresources.
		2346
		2347	Please note that nowadays, things like XIM will automatically pull in and
		2348	use the full X resource manager, so the overhead of using it might be very
		2349	small, if nonexistant.
1630		2350
1631	=item --enable-strings	2351	=item --enable-strings
1632		2352
1633	Add support for our possibly faster memset() function and other	2353	Add support for our possibly faster memset() function and other
1634	various routines, overriding your system's versions which may	2354	various routines, overriding your system's versions which may
…		…
1644		2364
1645	Add support for many small features that are not essential but nice to	2365	Add support for many small features that are not essential but nice to
1646	have. Normally you want this, but for very small binaries you may want to	2366	have. Normally you want this, but for very small binaries you may want to
1647	disable this.	2367	disable this.
1648		2368
		2369	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
		2370	in combination with other switches) is:
		2371
		2372	MWM-hints
		2373	seperate underline colour
		2374	settable border widths and borderless switch
		2375	settable extra linespacing
		2376	extra window properties (e.g. UTF-8 window names and PID)
		2377	iso-14755-2 and -3, and visual feedback
		2378	backindex and forwardindex escape sequence
		2379	window op and locale change escape sequences
		2380	tripleclickwords
		2381	settable insecure mode
		2382	keysym remapping support
		2383
1649	=item --enable-iso14755	2384	=item --enable-iso14755
1650		2385
1651	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2386	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
1652	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2387	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
1653	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2388	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
1654	this switch.	2389	this switch.
1655		2390
1656	=item --enable-linespace
1657
1658	Add support to provide user specified line spacing between text rows.
1659
1660	=item --enable-keepscrolling	2391	=item --enable-keepscrolling
1661		2392
1662	Add support for continual scrolling of the display when you hold	2393	Add support for continual scrolling of the display when you hold
1663	the mouse button down on a scrollbar arrow.	2394	the mouse button down on a scrollbar arrow.
1664		2395
…		…
1705		2436
1706	Add support to have the pointer disappear when typing or inactive.	2437	Add support to have the pointer disappear when typing or inactive.
1707		2438
1708	=item --with-name=NAME	2439	=item --with-name=NAME
1709		2440
1710	Set the basename for the installed binaries (default: urxvt, resulting in	2441	Set the basename for the installed binaries (default: C<urxvt>, resulting
1711	urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.	2442	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
		2443	C<rxvt>.
1712		2444
1713	=item --with-term=NAME	2445	=item --with-term=NAME
1714		2446
1715	Change the environmental variable for the terminal to NAME (default	2447	Change the environmental variable for the terminal to NAME (default
1716	"rxvt")	2448	C<rxvt-unicode>)
1717		2449
1718	=item --with-terminfo=PATH	2450	=item --with-terminfo=PATH
1719		2451
1720	Change the environmental variable for the path to the terminfo tree to	2452	Change the environmental variable for the path to the terminfo tree to
1721	PATH.	2453	PATH.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.23 by root, Wed Aug 25 03:47:20 2004 UTC vs. Revision 1.48 by root, Thu Feb 17 12:00:33 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.23 by root, Wed Aug 25 03:47:20 2004 UTC vs.
Revision 1.48 by root, Thu Feb 17 12:00:33 2005 UTC