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.58 by root, Wed Jul 13 02:24:02 2005 UTC vs.
Revision 1.153 by root, Sat Nov 24 16:36:43 2007 UTC

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

Diff Legend

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