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.54 by root, Tue Jun 21 18:25:09 2005 UTC vs.
Revision 1.155 by ayin, Sun Dec 9 12:15:39 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 contains large patches that	60	Rxvt-unicode tries to obey the rule of not charging you for something you
37	considerably change the behaviour of rxvt-unicode. Before reporting a	61	don't use. One thing you should try is to configure out all settings that
38	bug to the original rxvt-unicode author please download and install the	62	you don't need, for example, Xft support is a resource hog by design,
39	genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to	63	when used. Compiling it out ensures that no Xft font will be loaded
40	reproduce the problem. If you cannot, chances are that the problems are	64	accidentally when rxvt-unicode tries to find a font for your characters.
41	specific to Debian GNU/Linux, in which case it should be reported via the
42	Debian Bug Tracking System (use C<reportbug> to report the bug).
43		65
44	For other problems that also affect the Debian package, you can and	66	Also, many people (me included) like large windows and even larger
45	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
46	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
47	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.
48		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
49	=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?
50		842
51	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
52	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).
53		845
54	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
55	be done like this (with ncurses' infocmp):	847	be done like this (with ncurses' infocmp and works as user and admin):
56		848
57	REMOTE=remotesystem.domain	849	REMOTE=remotesystem.domain
58	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"
59		851
60	... 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.
61		856
62	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
63	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
64	problems arising, which includes wrong keymapping, less and different	859	problems arising, which includes wrong keymapping, less and different
65	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
…		…
70	resource to set it:	865	resource to set it:
71		866
72	URxvt.termName: rxvt	867	URxvt.termName: rxvt
73		868
74	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
75	the rxvt terminfo file with the rxvt-unicode one.	870	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
76		871
		872	=head3 C<tic> outputs some error when compiling the terminfo entry.
		873
		874	Most likely it's the empty definition for C<enacs=>. Just replace it by
		875	C<enacs=\E[0@> and try again.
		876
77	=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@@.
78		878
		879	See next entry.
		880
79	=item I need a termcap file entry.	881	=head3 I need a termcap file entry.
80		882
81	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
82	systems still compile some programs using the long-obsoleted termcap	884	systems still compile some programs using the long-obsoleted termcap
83	library (Fedora Core's bash is one example) and rely on a termcap entry	885	library (Fedora Core's bash is one example) and rely on a termcap entry
84	for C<rxvt-unicode>.	886	for C<rxvt-unicode>.
85		887
86	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.
87	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
88	like this:	890	like this:
89		891
90	infocmp -C rxvt-unicode	892	infocmp -C rxvt-unicode
91		893
…		…
110	: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:\
111	: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:\
112	: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:\
113	:vs=\E[?25h:	915	:vs=\E[?25h:
114		916
115	=item Why does C<ls> no longer have coloured output?	917	=head3 Why does C<ls> no longer have coloured output?
116		918
117	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
118	decide wether a terminal has colour, but uses it's own configuration	920	decide whether a terminal has colour, but uses its own configuration
119	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
120	with most other terminals supporting colour). Either add:	922	with most other terminals supporting colour). Either add:
121		923
122	TERM rxvt-unicode	924	TERM rxvt-unicode
123		925
124	to C</etc/DIR_COLORS> or simply add:	926	to C</etc/DIR_COLORS> or simply add:
125		927
126	alias ls='ls --color=auto'	928	alias ls='ls --color=auto'
127		929
128	to your C<.profile> or C<.bashrc>.	930	to your C<.profile> or C<.bashrc>.
129		931
130	=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?
131		933
		934	See next entry.
		935
132	=item Why doesn't vim/emacs etc. make use of italic?	936	=head3 Why doesn't vim/emacs etc. make use of italic?
133		937
		938	See next entry.
		939
134	=item Why are the secondary screen-related options not working properly?	940	=head3 Why are the secondary screen-related options not working properly?
135		941
136	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
137	distributions (most notably Debian GNU/Linux) break rxvt-unicode	943	distributions (most notably Debian GNU/Linux) break rxvt-unicode
138	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
139	features. Unfortunately, some of these (most notably, again, Debian	945	features. Unfortunately, some of these (most notably, again, Debian
140	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
141	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
142	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
143	how to do this).	949	how to do this).
144		950
145	=item My numerical keypad acts weird and generates differing output?
146		951
147	Some Debian GNUL/Linux users seem to have this problem, although no	952	=head2 Encoding / Locale / Input Method Issues
148	specific details were reported so far. It is possible that this is caused
149	by the wrong C<TERM> setting, although the details of wether and how
150	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
151	keymap. See the answer to the previous question, and please report if that
152	helped.
153		953
154	=item Rxvt-unicode does not seem to understand the selected encoding?	954	=head3 Rxvt-unicode does not seem to understand the selected encoding?
155		955
		956	See next entry.
		957
156	=item Unicode does not seem to work?	958	=head3 Unicode does not seem to work?
157		959
158	If you encounter strange problems like typing an accented character but	960	If you encounter strange problems like typing an accented character but
159	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
160	subtly garbled, then you should check your locale settings.	962	subtly garbled, then you should check your locale settings.
161		963
162	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
163	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,
164	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
165	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.
166		969
167	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
168	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.
169		972
170	printf '\e]701;%s\007' "$LC_CTYPE"	973	printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
171		974
172	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
173	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
174	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
175	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
…		…
181		984
182	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
183	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
184	support locales :(	987	support locales :(
185		988
186	=item Why do some characters look so much different than others?	989	=head3 How does rxvt-unicode determine the encoding to use?
187		990
188	=item How does rxvt-unicode choose fonts?	991	See next entry.
189		992
190	Most fonts do not contain the full range of Unicode, which is	993	=head3 Is there an option to switch encodings?
191	fine. Chances are that the font you (or the admin/package maintainer of
192	your system/os) have specified does not cover all the characters you want
193	to display.
194		994
195	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
196	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
197	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.
198	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
199	intelligence to detect that a specific glyph is wrong: it has to believe
200	the font that the characters it claims to contain indeed look correct.
201		998
202	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
203	e.g.:	1000	the encoding, doing I/O and (most important) communicating this to all
204		1001	applications so everybody agrees on character properties such as width
205	@@RXVT_NAME@@ -fn basefont,font2,font3...	1002	and code number. This mechanism is the I<locale>. Applications not using
206		1003	that info will have problems (for example, C<xterm> gets the width of
207	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
208	font. If the base font does not contain the character, it will go to the
209	next font, and so on. Specifying your own fonts will also speed up this
210	search and use less resources within rxvt-unicode and the X-server.
211
212	The only limitation is that none of the fonts may be larger than the base
213	font, as the base font defines the terminal character cell size, which
214	must be the same due to the way terminals work.
215
216	=item Why do some chinese characters look so different than others?
217
218	This is because there is a difference between script and language --
219	rxvt-unicode does not know which language the text that is output is,
220	as it only knows the unicode character codes. If rxvt-unicode first
221	sees a japanese/chinese character, it might choose a japanese font for
222	display. Subsequent japanese characters will use that font. Now, many
223	chinese characters aren't represented in japanese fonts, so when the first
224	non-japanese character comes up, rxvt-unicode will look for a chinese font
225	-- unfortunately at this point, it will still use the japanese font for
226	chinese characters that are also in the japanese font.
227
228	The workaround is easy: just tag a chinese font at the end of your font
229	list (see the previous question). The key is to view the font list as
230	a preference list: If you expect more japanese, list a japanese font
231	first. If you expect more chinese, put a chinese font first.
232
233	In the future it might be possible to switch language preferences at
234	runtime (the internal data structure has no problem with using different
235	fonts for the same character at the same time, but no interface for this
236	has been designed yet).
237
238	Until then, you might get away with switching fonts at runtime (see L<Can
239	I switch the fonts at runtime?> later in this document).
240
241	=item Why does rxvt-unicode sometimes leave pixel droppings?
242
243	Most fonts were not designed for terminal use, which means that character
244	size varies a lot. A font that is otherwise fine for terminal use might
245	contain some characters that are simply too wide. Rxvt-unicode will avoid
246	these characters. For characters that are just "a bit" too wide a special
247	"careful" rendering mode is used that redraws adjacent characters.
248
249	All of this requires that fonts do not lie about character sizes,
250	however: Xft fonts often draw glyphs larger than their acclaimed bounding
251	box, and rxvt-unicode has no way of detecting this (the correct way is to
252	ask for the character bounding box, which unfortunately is wrong in these
253	cases).	1005	locales).
254		1006
255	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
256	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
257	the C<-lsp> option to give the font more height. If that doesn't work, you	1009	interpretation of characters.
258	might be forced to use a different font.
259		1010
260	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
261	box data is correct.	1012	is there a standard on how locale specifiers will look like.
262		1013
263	=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.
264		1019
265	Seems to be a known bug, read	1020	Rxvt-unicode ignores all other locale categories, and except for
266	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the	1021	the encoding, ignores country or language-specific settings,
267	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.
268		1024
269	#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.
270		1027
271	=item My Compose (Multi_key) key is no longer working.	1028	=head3 Can I switch locales at runtime?
272		1029
273	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
274	correctly, or you specified a B<preeditStyle> that is not supported by	1031	rxvt-unicode's idea of C<LC_CTYPE>.
275	your input method. For example, if you specified B<OverTheSpot> and
276	your input method (e.g. the default input method handling Compose keys)
277	does not support this (for instance because it is not visual), then
278	rxvt-unicode will continue without an input method.
279		1032
280	In this case either do not specify a B<preeditStyle> or specify more than	1033	printf '\33]701;%s\007' ja_JP.SJIS
281	one pre-edit style, such as B<OverTheSpot,Root,None>.
282		1034
283	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755	1035	See also the previous answer.
284		1036
285	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
286	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
287	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
288	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:
289	character and so on.
290		1041
291	=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
292		1045
293	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
294	(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
295	make sure you have specified colours for italic and bold, as otherwise	1048	rxvt-unicode-locales.
296	rxvt-unicode might use reverse video to simulate the effect:
297		1049
298	URxvt.colorBD: white	1050	=head3 I have problems getting my input method working.
299	URxvt.colorIT: green
300		1051
301	=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.
302		1053
303	For some unexplainable reason, some rare programs assume a very weird	1054	Here is a checklist:
304	colour palette when confronted with a terminal with more than the standard
305	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
306	these programs not to assume non-ISO colours without very good reasons.
307		1055
308	In the meantime, you can either edit your C<rxvt-unicode> terminfo	1056	=over 4
309	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
310	fix colours but keep you from using other rxvt-unicode features.
311		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
312	=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.
313		1161
314	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
315	in your compile environment, or an implementation that implements it,	1163	in your compile environment, or an implementation that implements it,
316	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
317	B<wchar_t> is represented as unicode.	1165	B<wchar_t> is represented as unicode.
318		1166
319	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
320	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
321	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.
322		1170
323	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
324	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>.
325		1173
…		…
339		1187
340	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
341	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
342	complete replacements for them :)	1190	complete replacements for them :)
343		1191
344	=item How does rxvt-unicode determine the encoding to use?	1192	=head3 How can I use rxvt-unicode under cygwin?
345		1193
346	=item Is there an option to switch encodings?	1194	rxvt-unicode should compile and run out of the box on cygwin, using
		1195	the X11 libraries that come with cygwin. libW11 emulation is no
		1196	longer supported (and makes no sense, either, as it only supported a
		1197	single font). I recommend starting the X-server in C<-multiwindow> or
		1198	C<-rootless> mode instead, which will result in similar look&feel as the
		1199	old libW11 emulation.
347		1200
348	Unlike some other terminals, rxvt-unicode has no encoding switch, and no	1201	At the time of this writing, cygwin didn't seem to support any multi-byte
349	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about	1202	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
350	UTF-8 or any other encodings with respect to terminal I/O.	1203	to 8-bit encodings.
351		1204
352	The reasons is that there exists a perfectly fine mechanism for selecting	1205	=head3 Character widths are not correct.
353	the encoding, doing I/O and (most important) communicating this to all
354	applications so everybody agrees on character properties such as width
355	and code number. This mechanism is the I<locale>. Applications not using
356	that info will have problems (for example, C<xterm> gets the width of
357	characters wrong as it uses it's own, locale-independent table under all
358	locales).
359		1206
360	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All	1207	urxvt uses the system wcwidth function to know the information about
361	programs doing the same (that is, most) will automatically agree in the	1208	the width of characters, so on systems with incorrect locale data you
362	interpretation of characters.	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.
363		1212
364	Unfortunately, there is no system-independent way to select locales, nor	1213	The solution is to upgrade your system or switch to a better one. A
365	is there a standard on how locale specifiers will look like.	1214	possibly working workaround is to use a wcwidth implementation like
366		1215
367	On most systems, the content of the C<LC_CTYPE> environment variable	1216	http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
368	contains an arbitrary string which corresponds to an already-installed
369	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
370	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
371	(i.e. C<de> or C<german>) are also common.
372		1217
373	Rxvt-unicode ignores all other locale categories, and except for
374	the encoding, ignores country or language-specific settings,
375	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
376	rxvt-unicode.
377
378	If you want to use a specific encoding you have to make sure you start
379	rxvt-unicode with the correct C<LC_CTYPE> category.
380
381	=item Can I switch locales at runtime?
382
383	Yes, using an escape sequence. Try something like this, which sets
384	rxvt-unicode's idea of C<LC_CTYPE>.
385
386	printf '\e]701;%s\007' ja_JP.SJIS
387
388	See also the previous answer.
389
390	Sometimes this capability is rather handy when you want to work in
391	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
392	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
393	first switches to a locale supported by xjdic and back later:
394
395	printf '\e]701;%s\007' ja_JP.SJIS
396	xjdic -js
397	printf '\e]701;%s\007' de_DE.UTF-8
398
399	You can also use xterm's C<luit> program, which usually works fine, except
400	for some locales where character width differs between program- and
401	rxvt-unicode-locales.
402
403	=item Can I switch the fonts at runtime?
404
405	Yes, using an escape sequence. Try something like this, which has the same
406	effect as using the C<-fn> switch, and takes effect immediately:
407
408	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
409
410	This is useful if you e.g. work primarily with japanese (and prefer a
411	japanese font), but you have to switch to chinese temporarily, where
412	japanese fonts would only be in your way.
413
414	You can think of this as a kind of manual ISO-2022 switching.
415
416	=item Why do italic characters look as if clipped?
417
418	Many fonts have difficulties with italic characters and hinting. For
419	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
420	Mono> completely fails in it's italic face. A workaround might be to
421	enable freetype autohinting, i.e. like this:
422
423	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
424	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
425
426	=item My input method wants <some encoding> but I want UTF-8, what can I do?
427
428	You can specify separate locales for the input method and the rest of the
429	terminal, using the resource C<imlocale>:
430
431	URxvt*imlocale: ja_JP.EUC-JP
432
433	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
434	use your input method. Please note, however, that you will not be able to
435	input characters outside C<EUC-JP> in a normal way then, as your input
436	method limits you.
437
438	=item Rxvt-unicode crashes when the X Input Method changes or exits.
439
440	Unfortunately, this is unavoidable, as the XIM protocol is racy by
441	design. Applications can avoid some crashes at the expense of memory
442	leaks, and Input Methods can avoid some crashes by careful ordering at
443	exit time. B<kinput2> (and derived input methods) generally succeeds,
444	while B<SCIM> (or similar input methods) fails. In the end, however,
445	crashes cannot be completely avoided even if both sides cooperate.
446
447	So the only workaround is not to kill your Input Method Servers.
448
449	=item Rxvt-unicode uses gobs of memory, how can I reduce that?
450
451	Rxvt-unicode tries to obey the rule of not charging you for something you
452	don't use. One thing you should try is to configure out all settings that
453	you don't need, for example, Xft support is a resource hog by design,
454	when used. Compiling it out ensures that no Xft font will be loaded
455	accidentally when rxvt-unicode tries to find a font for your characters.
456
457	Also, many people (me included) like large windows and even larger
458	scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
459	6 bytes per screen cell. For a 160x?? window this amounts to almost a
460	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
461	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
462	rxvt-unicode then uses 8 bytes per screen cell.
463
464	=item Can I speed up Xft rendering somehow?
465
466	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
467	it is simply slow. If you still want Xft fonts you might try to disable
468	antialiasing (by appending C<:antialiasing=false>), which saves lots of
469	memory and also speeds up rendering considerably.
470
471	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
472
473	Rxvt-unicode will use whatever you specify as a font. If it needs to
474	fall back to it's default font search list it will prefer X11 core
475	fonts, because they are small and fast, and then use Xft fonts. It has
476	antialiasing disabled for most of them, because the author thinks they
477	look best that way.
478
479	If you want antialiasing, you have to specify the fonts manually.
480
481	=item Mouse cut/paste suddenly no longer works.
482
483	Make sure that mouse reporting is actually turned off since killing
484	some editors prematurely may leave the mouse in mouse report mode. I've
485	heard that tcsh may use mouse reporting unless it otherwise specified. A
486	quick check is to see if cut/paste works when the Alt or Shift keys are
487	depressed. See @@RXVT_NAME@@(7)
488
489	=item What's with this bold/blink stuff?
490
491	If no bold colour is set via C<colorBD:>, bold will invert text using the
492	standard foreground colour.
493
494	For the standard background colour, blinking will actually make the
495	text blink when compiled with C<--enable-blinking>. with standard
496	colours. Without C<--enable-blinking>, the blink attribute will be
497	ignored.
498
499	On ANSI colours, bold/blink attributes are used to set high-intensity
500	foreground/background colors.
501
502	color0-7 are the low-intensity colors.
503
504	color8-15 are the corresponding high-intensity colors.
505
506	=item I don't like the screen colors. How do I change them?
507
508	You can change the screen colors at run-time using F<~/.Xdefaults>
509	resources (or as long-options).
510
511	Here are values that are supposed to resemble a VGA screen,
512	including the murky brown that passes for low-intensity yellow:
513
514	URxvt.color0: #000000
515	URxvt.color1: #A80000
516	URxvt.color2: #00A800
517	URxvt.color3: #A8A800
518	URxvt.color4: #0000A8
519	URxvt.color5: #A800A8
520	URxvt.color6: #00A8A8
521	URxvt.color7: #A8A8A8
522
523	URxvt.color8: #000054
524	URxvt.color9: #FF0054
525	URxvt.color10: #00FF54
526	URxvt.color11: #FFFF54
527	URxvt.color12: #0000FF
528	URxvt.color13: #FF00FF
529	URxvt.color14: #00FFFF
530	URxvt.color15: #FFFFFF
531
532	And here is a more complete set of non-standard colors described (not by
533	me) as "pretty girly".
534
535	URxvt.cursorColor: #dc74d1
536	URxvt.pointerColor: #dc74d1
537	URxvt.background: #0e0e0e
538	URxvt.foreground: #4ad5e1
539	URxvt.color0: #000000
540	URxvt.color8: #8b8f93
541	URxvt.color1: #dc74d1
542	URxvt.color9: #dc74d1
543	URxvt.color2: #0eb8c7
544	URxvt.color10: #0eb8c7
545	URxvt.color3: #dfe37e
546	URxvt.color11: #dfe37e
547	URxvt.color5: #9e88f0
548	URxvt.color13: #9e88f0
549	URxvt.color6: #73f7ff
550	URxvt.color14: #73f7ff
551	URxvt.color7: #e1dddd
552	URxvt.color15: #e1dddd
553
554	=item How can I start @@RXVT_NAME@@d in a race-free way?
555
556	Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
557	server that answers @@RXVT_NAME@@c's requests, so it doesn't background
558	itself.
559
560	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
561	following method to wait for the startup message before continuing:
562
563	{ @@RXVT_NAME@@d & } | read
564
565	=item What's with the strange Backspace/Delete key behaviour?
566
567	Assuming that the physical Backspace key corresponds to the
568	BackSpace keysym (not likely for Linux ... see the following
569	question) there are two standard values that can be used for
570	Backspace: C<^H> and C<^?>.
571
572	Historically, either value is correct, but rxvt-unicode adopts the debian
573	policy of using C<^?> when unsure, because it's the one only only correct
574	choice :).
575
576	Rxvt-unicode tries to inherit the current stty settings and uses the value
577	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
578	started from a terminal (say, from a menu or by remote shell), then the
579	system value of `erase', which corresponds to CERASE in <termios.h>, will
580	be used (which may not be the same as your stty setting).
581
582	For starting a new rxvt-unicode:
583
584	# use Backspace = ^H
585	$ stty erase ^H
586	$ @@RXVT_NAME@@
587
588	# use Backspace = ^?
589	$ stty erase ^?
590	$ @@RXVT_NAME@@
591
592	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
593
594	For an existing rxvt-unicode:
595
596	# use Backspace = ^H
597	$ stty erase ^H
598	$ echo -n "^[[36h"
599
600	# use Backspace = ^?
601	$ stty erase ^?
602	$ echo -n "^[[36l"
603
604	This helps satisfy some of the Backspace discrepancies that occur, but
605	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
606	properly reflects that.
607
608	The Delete key is a another casualty of the ill-defined Backspace problem.
609	To avoid confusion between the Backspace and Delete keys, the Delete
610	key has been assigned an escape sequence to match the vt100 for Execute
611	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
612
613	Some other Backspace problems:
614
615	some editors use termcap/terminfo,
616	some editors (vim I'm told) expect Backspace = ^H,
617	GNU Emacs (and Emacs-like editors) use ^H for help.
618
619	Perhaps someday this will all be resolved in a consistent manner.
620
621	=item I don't like the key-bindings. How do I change them?
622
623	There are some compile-time selections available via configure. Unless
624	you have run "configure" with the C<--disable-resources> option you can
625	use the `keysym' resource to alter the keystrings associated with keysyms.
626
627	Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
628
629	URxvt.keysym.Home: \033[1~
630	URxvt.keysym.End: \033[4~
631	URxvt.keysym.C-apostrophe: \033<C-'>
632	URxvt.keysym.C-slash: \033<C-/>
633	URxvt.keysym.C-semicolon: \033<C-;>
634	URxvt.keysym.C-grave: \033<C-`>
635	URxvt.keysym.C-comma: \033<C-,>
636	URxvt.keysym.C-period: \033<C-.>
637	URxvt.keysym.C-0x60: \033<C-`>
638	URxvt.keysym.C-Tab: \033<C-Tab>
639	URxvt.keysym.C-Return: \033<C-Return>
640	URxvt.keysym.S-Return: \033<S-Return>
641	URxvt.keysym.S-space: \033<S-Space>
642	URxvt.keysym.M-Up: \033<M-Up>
643	URxvt.keysym.M-Down: \033<M-Down>
644	URxvt.keysym.M-Left: \033<M-Left>
645	URxvt.keysym.M-Right: \033<M-Right>
646	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
647	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
648	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
649
650	See some more examples in the documentation for the B<keysym> resource.
651
652	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
653	How do I make use of them? For example, the Sun Keyboard type 4
654	has the following mappings that rxvt-unicode doesn't recognize.
655
656	KP_Insert == Insert
657	F22 == Print
658	F27 == Home
659	F29 == Prior
660	F33 == End
661	F35 == Next
662
663	Rather than have rxvt-unicode try to accommodate all the various possible
664	keyboard mappings, it is better to use `xmodmap' to remap the keys as
665	required for your particular machine.
666
667	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
668	I need this to decide about setting colors etc.
669
670	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
671	check and see if that is set. Note that several programs, JED, slrn,
672	Midnight Commander automatically check this variable to decide whether or
673	not to use color.
674
675	=item How do I set the correct, full IP address for the DISPLAY variable?
676
677	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
678	insecure mode then it is possible to use the following shell script
679	snippets to correctly set the display. If your version of rxvt-unicode
680	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
681	the COLORTERM variable can be used to distinguish rxvt-unicode from a
682	regular xterm.
683
684	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
685	snippets:
686
687	# Bourne/Korn/POSIX family of shells:
688	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
689	if [ ${TERM:-foo} = xterm ]; then
690	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
691	echo -n '^[Z'
692	read term_id
693	stty icanon echo
694	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
695	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
696	read DISPLAY # set it in our local shell
697	fi
698	fi
699
700	=item How do I compile the manual pages for myself?
701
702	You need to have a recent version of perl installed as F</usr/bin/perl>,
703	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
704	the doc subdirectory and enter C<make alldoc>.
705
706	=item My question isn't answered here, can I ask a human?
707
708	Before sending me mail, you could go to IRC: C<irc.freenode.net>,
709	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
710	interested in learning about new and exciting problems (but not FAQs :).
711
712	=back
713
714	=head1 RXVT TECHNICAL REFERENCE	1218	=head1 RXVT-UNICODE TECHNICAL REFERENCE
715
716	=head1 DESCRIPTION
717		1219
718	The rest of this document describes various technical aspects of	1220	The rest of this document describes various technical aspects of
719	B<rxvt-unicode>. First the description of supported command sequences,	1221	B<rxvt-unicode>. First the description of supported command sequences,
720	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
721	features selectable at C<configure> time.	1223	selectable at C<configure> time.
722		1224
723	=head1 Definitions	1225	=head2 Definitions
724		1226
725	=over 4	1227	=over 4
726		1228
727	=item B<< C<c> >>	1229	=item B<< C<c> >>
728		1230
…		…
746		1248
747	A text parameter composed of printable characters.	1249	A text parameter composed of printable characters.
748		1250
749	=back	1251	=back
750		1252
751	=head1 Values	1253	=head2 Values
752		1254
753	=over 4	1255	=over 4
754		1256
755	=item B<< C<ENQ> >>	1257	=item B<< C<ENQ> >>
756		1258
…		…
799		1301
800	Space Character	1302	Space Character
801		1303
802	=back	1304	=back
803		1305
804	=head1 Escape Sequences	1306	=head2 Escape Sequences
805		1307
806	=over 4	1308	=over 4
807		1309
808	=item B<< C<ESC # 8> >>	1310	=item B<< C<ESC # 8> >>
809		1311
…		…
907		1409
908	=back	1410	=back
909		1411
910	X<CSI>	1412	X<CSI>
911		1413
912	=head1 CSI (Command Sequence Introducer) Sequences	1414	=head2 CSI (Command Sequence Introducer) Sequences
913		1415
914	=over 4	1416	=over 4
915		1417
916	=item B<< C<ESC [ Ps @> >>	1418	=item B<< C<ESC [ Ps @> >>
917		1419
…		…
1187		1689
1188	=back	1690	=back
1189		1691
1190	X<PrivateModes>	1692	X<PrivateModes>
1191		1693
1192	=head1 DEC Private Modes	1694	=head2 DEC Private Modes
1193		1695
1194	=over 4	1696	=over 4
1195		1697
1196	=item B<< C<ESC [ ? Pm h> >>	1698	=item B<< C<ESC [ ? Pm h> >>
1197		1699
…		…
1213		1715
1214	Toggle DEC Private Mode Values (rxvt extension). I<where>	1716	Toggle DEC Private Mode Values (rxvt extension). I<where>
1215		1717
1216	=over 4	1718	=over 4
1217		1719
1218	=item B<< C<Ps = 1> >> (DECCKM)	1720	=item B<< C<Pm = 1> >> (DECCKM)
1219		1721
1220	=begin table	1722	=begin table
1221		1723
1222	B<< C<h> >> Application Cursor Keys	1724	B<< C<h> >> Application Cursor Keys
1223	B<< C<l> >> Normal Cursor Keys	1725	B<< C<l> >> Normal Cursor Keys
1224		1726
1225	=end table	1727	=end table
1226		1728
1227	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1729	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1228		1730
1229	=begin table	1731	=begin table
1230		1732
1231	B<< C<h> >> Enter VT52 mode	1733	B<< C<h> >> Enter VT52 mode
1232	B<< C<l> >> Enter VT52 mode	1734	B<< C<l> >> Enter VT52 mode
1233		1735
1234	=end table	1736	=end table
1235		1737
1236	=item B<< C<Ps = 3> >>	1738	=item B<< C<Pm = 3> >>
1237		1739
1238	=begin table	1740	=begin table
1239		1741
1240	B<< C<h> >> 132 Column Mode (DECCOLM)	1742	B<< C<h> >> 132 Column Mode (DECCOLM)
1241	B<< C<l> >> 80 Column Mode (DECCOLM)	1743	B<< C<l> >> 80 Column Mode (DECCOLM)
1242		1744
1243	=end table	1745	=end table
1244		1746
1245	=item B<< C<Ps = 4> >>	1747	=item B<< C<Pm = 4> >>
1246		1748
1247	=begin table	1749	=begin table
1248		1750
1249	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1751	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1250	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1752	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1251		1753
1252	=end table	1754	=end table
1253		1755
1254	=item B<< C<Ps = 5> >>	1756	=item B<< C<Pm = 5> >>
1255		1757
1256	=begin table	1758	=begin table
1257		1759
1258	B<< C<h> >> Reverse Video (DECSCNM)	1760	B<< C<h> >> Reverse Video (DECSCNM)
1259	B<< C<l> >> Normal Video (DECSCNM)	1761	B<< C<l> >> Normal Video (DECSCNM)
1260		1762
1261	=end table	1763	=end table
1262		1764
1263	=item B<< C<Ps = 6> >>	1765	=item B<< C<Pm = 6> >>
1264		1766
1265	=begin table	1767	=begin table
1266		1768
1267	B<< C<h> >> Origin Mode (DECOM)	1769	B<< C<h> >> Origin Mode (DECOM)
1268	B<< C<l> >> Normal Cursor Mode (DECOM)	1770	B<< C<l> >> Normal Cursor Mode (DECOM)
1269		1771
1270	=end table	1772	=end table
1271		1773
1272	=item B<< C<Ps = 7> >>	1774	=item B<< C<Pm = 7> >>
1273		1775
1274	=begin table	1776	=begin table
1275		1777
1276	B<< C<h> >> Wraparound Mode (DECAWM)	1778	B<< C<h> >> Wraparound Mode (DECAWM)
1277	B<< C<l> >> No Wraparound Mode (DECAWM)	1779	B<< C<l> >> No Wraparound Mode (DECAWM)
1278		1780
1279	=end table	1781	=end table
1280		1782
1281	=item B<< C<Ps = 8> >> I<unimplemented>	1783	=item B<< C<Pm = 8> >> I<unimplemented>
1282		1784
1283	=begin table	1785	=begin table
1284		1786
1285	B<< C<h> >> Auto-repeat Keys (DECARM)	1787	B<< C<h> >> Auto-repeat Keys (DECARM)
1286	B<< C<l> >> No Auto-repeat Keys (DECARM)	1788	B<< C<l> >> No Auto-repeat Keys (DECARM)
1287		1789
1288	=end table	1790	=end table
1289		1791
1290	=item B<< C<Ps = 9> >> X10 XTerm	1792	=item B<< C<Pm = 9> >> X10 XTerm
1291		1793
1292	=begin table	1794	=begin table
1293		1795
1294	B<< C<h> >> Send Mouse X & Y on button press.	1796	B<< C<h> >> Send Mouse X & Y on button press.
1295	B<< C<l> >> No mouse reporting.	1797	B<< C<l> >> No mouse reporting.
1296		1798
1297	=end table	1799	=end table
1298		1800
1299	=item B<< C<Ps = 10> >> (B<rxvt>)
1300
1301	=begin table
1302
1303	B<< C<h> >> menuBar visible
1304	B<< C<l> >> menuBar invisible
1305
1306	=end table
1307
1308	=item B<< C<Ps = 25> >>	1801	=item B<< C<Pm = 25> >>
1309		1802
1310	=begin table	1803	=begin table
1311		1804
1312	B<< C<h> >> Visible cursor {cnorm/cvvis}	1805	B<< C<h> >> Visible cursor {cnorm/cvvis}
1313	B<< C<l> >> Invisible cursor {civis}	1806	B<< C<l> >> Invisible cursor {civis}
1314		1807
1315	=end table	1808	=end table
1316		1809
1317	=item B<< C<Ps = 30> >>	1810	=item B<< C<Pm = 30> >>
1318		1811
1319	=begin table	1812	=begin table
1320		1813
1321	B<< C<h> >> scrollBar visisble	1814	B<< C<h> >> scrollBar visisble
1322	B<< C<l> >> scrollBar invisisble	1815	B<< C<l> >> scrollBar invisisble
1323		1816
1324	=end table	1817	=end table
1325		1818
1326	=item B<< C<Ps = 35> >> (B<rxvt>)	1819	=item B<< C<Pm = 35> >> (B<rxvt>)
1327		1820
1328	=begin table	1821	=begin table
1329		1822
1330	B<< C<h> >> Allow XTerm Shift+key sequences	1823	B<< C<h> >> Allow XTerm Shift+key sequences
1331	B<< C<l> >> Disallow XTerm Shift+key sequences	1824	B<< C<l> >> Disallow XTerm Shift+key sequences
1332		1825
1333	=end table	1826	=end table
1334		1827
1335	=item B<< C<Ps = 38> >> I<unimplemented>	1828	=item B<< C<Pm = 38> >> I<unimplemented>
1336		1829
1337	Enter Tektronix Mode (DECTEK)	1830	Enter Tektronix Mode (DECTEK)
1338		1831
1339	=item B<< C<Ps = 40> >>	1832	=item B<< C<Pm = 40> >>
1340		1833
1341	=begin table	1834	=begin table
1342		1835
1343	B<< C<h> >> Allow 80/132 Mode	1836	B<< C<h> >> Allow 80/132 Mode
1344	B<< C<l> >> Disallow 80/132 Mode	1837	B<< C<l> >> Disallow 80/132 Mode
1345		1838
1346	=end table	1839	=end table
1347		1840
1348	=item B<< C<Ps = 44> >> I<unimplemented>	1841	=item B<< C<Pm = 44> >> I<unimplemented>
1349		1842
1350	=begin table	1843	=begin table
1351		1844
1352	B<< C<h> >> Turn On Margin Bell	1845	B<< C<h> >> Turn On Margin Bell
1353	B<< C<l> >> Turn Off Margin Bell	1846	B<< C<l> >> Turn Off Margin Bell
1354		1847
1355	=end table	1848	=end table
1356		1849
1357	=item B<< C<Ps = 45> >> I<unimplemented>	1850	=item B<< C<Pm = 45> >> I<unimplemented>
1358		1851
1359	=begin table	1852	=begin table
1360		1853
1361	B<< C<h> >> Reverse-wraparound Mode	1854	B<< C<h> >> Reverse-wraparound Mode
1362	B<< C<l> >> No Reverse-wraparound Mode	1855	B<< C<l> >> No Reverse-wraparound Mode
1363		1856
1364	=end table	1857	=end table
1365		1858
1366	=item B<< C<Ps = 46> >> I<unimplemented>	1859	=item B<< C<Pm = 46> >> I<unimplemented>
1367		1860
1368	=item B<< C<Ps = 47> >>	1861	=item B<< C<Pm = 47> >>
1369		1862
1370	=begin table	1863	=begin table
1371		1864
1372	B<< C<h> >> Use Alternate Screen Buffer	1865	B<< C<h> >> Use Alternate Screen Buffer
1373	B<< C<l> >> Use Normal Screen Buffer	1866	B<< C<l> >> Use Normal Screen Buffer
1374		1867
1375	=end table	1868	=end table
1376		1869
1377	X<Priv66>	1870	X<Priv66>
1378		1871
1379	=item B<< C<Ps = 66> >>	1872	=item B<< C<Pm = 66> >>
1380		1873
1381	=begin table	1874	=begin table
1382		1875
1383	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1876	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1384	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1877	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1385		1878
1386	=end table	1879	=end table
1387		1880
1388	=item B<< C<Ps = 67> >>	1881	=item B<< C<Pm = 67> >>
1389		1882
1390	=begin table	1883	=begin table
1391		1884
1392	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1885	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1393	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1886	B<< C<l> >> Backspace key sends B<< C<DEL> >>
1394		1887
1395	=end table	1888	=end table
1396		1889
1397	=item B<< C<Ps = 1000> >> (X11 XTerm)	1890	=item B<< C<Pm = 1000> >> (X11 XTerm)
1398		1891
1399	=begin table	1892	=begin table
1400		1893
1401	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.
1402	B<< C<l> >> No mouse reporting.	1895	B<< C<l> >> No mouse reporting.
1403		1896
1404	=end table	1897	=end table
1405		1898
1406	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1899	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1407		1900
1408	=begin table	1901	=begin table
1409		1902
1410	B<< C<h> >> Use Hilite Mouse Tracking.	1903	B<< C<h> >> Use Hilite Mouse Tracking.
1411	B<< C<l> >> No mouse reporting.	1904	B<< C<l> >> No mouse reporting.
1412		1905
1413	=end table	1906	=end table
1414		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
1415	=item B<< C<Ps = 1010> >> (B<rxvt>)	1926	=item B<< C<Pm = 1010> >> (B<rxvt>)
1416		1927
1417	=begin table	1928	=begin table
1418		1929
1419	B<< C<h> >> Don't scroll to bottom on TTY output	1930	B<< C<h> >> Don't scroll to bottom on TTY output
1420	B<< C<l> >> Scroll to bottom on TTY output	1931	B<< C<l> >> Scroll to bottom on TTY output
1421		1932
1422	=end table	1933	=end table
1423		1934
1424	=item B<< C<Ps = 1011> >> (B<rxvt>)	1935	=item B<< C<Pm = 1011> >> (B<rxvt>)
1425		1936
1426	=begin table	1937	=begin table
1427		1938
1428	B<< C<h> >> Scroll to bottom when a key is pressed	1939	B<< C<h> >> Scroll to bottom when a key is pressed
1429	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
1430		1941
1431	=end table	1942	=end table
1432		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
1433	=item B<< C<Ps = 1047> >>	1953	=item B<< C<Pm = 1047> >>
1434		1954
1435	=begin table	1955	=begin table
1436		1956
1437	B<< C<h> >> Use Alternate Screen Buffer	1957	B<< C<h> >> Use Alternate Screen Buffer
1438	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
1439		1959
1440	=end table	1960	=end table
1441		1961
1442	=item B<< C<Ps = 1048> >>	1962	=item B<< C<Pm = 1048> >>
1443		1963
1444	=begin table	1964	=begin table
1445		1965
1446	B<< C<h> >> Save cursor position	1966	B<< C<h> >> Save cursor position
1447	B<< C<l> >> Restore cursor position	1967	B<< C<l> >> Restore cursor position
1448		1968
1449	=end table	1969	=end table
1450		1970
1451	=item B<< C<Ps = 1049> >>	1971	=item B<< C<Pm = 1049> >>
1452		1972
1453	=begin table	1973	=begin table
1454		1974
1455	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
1456	B<< C<l> >> Use Normal Screen Buffer	1976	B<< C<l> >> Use Normal Screen Buffer
…		…
1461		1981
1462	=back	1982	=back
1463		1983
1464	X<XTerm>	1984	X<XTerm>
1465		1985
1466	=head1 XTerm Operating System Commands	1986	=head2 XTerm Operating System Commands
1467		1987
1468	=over 4	1988	=over 4
1469		1989
1470	=item B<< C<ESC ] Ps;Pt ST> >>	1990	=item B<< C<ESC ] Ps;Pt ST> >>
1471		1991
…		…
1483	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)>
1484	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)>
1485	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> >>
1486	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> >>
1487	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> >>
1488	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]
1489	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]
1490	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).
1491	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> >>.
1492	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>
1493	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> >>.
1494	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> >>
1495	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> >>
1496	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).
1497	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>.
1498	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> >>
1499	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> >>
1500	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>.
1501	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).
1502	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).
1503	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).
1504	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).
1505	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).
1506		2029
1507	=end table	2030	=end table
1508		2031
1509	=back	2032	=back
1510		2033
1511	X<menuBar>	2034	=head1 BACKGROUND IMAGE
1512		2035
1513	=head1 menuBar
1514
1515	B<< The exact syntax used is I<almost> solidified. >>
1516	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1517	menuBar.
1518
1519	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1520	omitted: use B<./> to specify a menu relative to the current menu.
1521
1522	=head2 Overview of menuBar operation
1523
1524	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1525	of C<Pt> can be used for a variety of tasks:
1526
1527	At the top level is the current menuBar which is a member of a circular
1528	linked-list of other such menuBars.
1529
1530	The menuBar acts as a parent for the various drop-down menus, which in
1531	turn, may have labels, separator lines, menuItems and subMenus.
1532
1533	The menuItems are the useful bits: you can use them to mimic keyboard
1534	input or even to send text or escape sequences back to rxvt.
1535
1536	The menuBar syntax is intended to provide a simple yet robust method of
1537	constructing and manipulating menus and navigating through the
1538	menuBars.
1539
1540	The first step is to use the tag B<< [menu:I<name>] >> which creates
1541	the menuBar called I<name> and allows access. You may now or menus,
1542	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1543	menuBar access as B<readonly> to prevent accidental corruption of the
1544	menus. To re-access the current menuBar for alterations, use the tag
1545	B<[menu]>, make the alterations and then use B<[done]>
1546
1547	X<menuBarCommands>
1548
1549	=head2 Commands
1550
1551	=over 4
1552
1553	=item B<< [menu:+I<name>] >>
1554
1555	access the named menuBar for creation or alteration. If a new menuBar
1556	is created, it is called I<name> (max of 15 chars) and the current
1557	menuBar is pushed onto the stack
1558
1559	=item B<[menu]>
1560
1561	access the current menuBar for alteration
1562
1563	=item B<< [title:+I<string>] >>
1564
1565	set the current menuBar's title to I<string>, which may contain the
1566	following format specifiers:
1567
1568	B<%n> rxvt name (as per the B<-name> command-line option)
1569	B<%v> rxvt version
1570	B<%%> literal B<%> character
1571
1572	=item B<[done]>
1573
1574	set menuBar access as B<readonly>.
1575	End-of-file tag for B<< [read:+I<file>] >> operations.
1576
1577	=item B<< [read:+I<file>] >>
1578
1579	read menu commands directly from I<file> (extension ".menu" will be
1580	appended if required.) Start reading at a line with B<[menu]> or B<<
1581	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1582
1583	Blank and comment lines (starting with B<#>) are ignored. Actually,
1584	since any invalid menu commands are also ignored, almost anything could
1585	be construed as a comment line, but this may be tightened up in the
1586	future ... so don't count on it!.
1587
1588	=item B<< [read:+I<file>;+I<name>] >>
1589
1590	The same as B<< [read:+I<file>] >>, but start reading at a line with
1591	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1592	B<[done]> is encountered.
1593
1594	=item B<[dump]>
1595
1596	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1597	later rereading.
1598
1599	=item B<[rm:name]>
1600
1601	remove the named menuBar
1602
1603	=item B<[rm] [rm:]>
1604
1605	remove the current menuBar
1606
1607	=item B<[rm*] [rm:*]>
1608
1609	remove all menuBars
1610
1611	=item B<[swap]>
1612
1613	swap the top two menuBars
1614
1615	=item B<[prev]>
1616
1617	access the previous menuBar
1618
1619	=item B<[next]>
1620
1621	access the next menuBar
1622
1623	=item B<[show]>
1624
1625	Enable display of the menuBar
1626
1627	=item B<[hide]>
1628
1629	Disable display of the menuBar
1630
1631	=item B<< [pixmap:+I<name>] >>
1632
1633	=item B<< [pixmap:+I<name>;I<scaling>] >>
1634
1635	(set the background pixmap globally
1636
1637	B<< A Future implementation I<may> make this local to the menubar >>)
1638
1639	=item B<< [:+I<command>:] >>
1640
1641	ignore the menu readonly status and issue a I<command> to or a menu or
1642	menuitem or change the ; a useful shortcut for setting the quick arrows
1643	from a menuBar.
1644
1645	=back
1646
1647	X<menuBarAdd>
1648
1649	=head2 Adding and accessing menus
1650
1651	The following commands may also be B<+> prefixed.
1652
1653	=over 4
1654
1655	=item B</+>
1656
1657	access menuBar top level
1658
1659	=item B<./+>
1660
1661	access current menu level
1662
1663	=item B<../+>
1664
1665	access parent menu (1 level up)
1666
1667	=item B<../../>
1668
1669	access parent menu (multiple levels up)
1670
1671	=item B<< I</path/>menu >>
1672
1673	add/access menu
1674
1675	=item B<< I</path/>menu/* >>
1676
1677	add/access menu and clear it if it exists
1678
1679	=item B<< I</path/>{-} >>
1680
1681	add separator
1682
1683	=item B<< I</path/>{item} >>
1684
1685	add B<item> as a label
1686
1687	=item B<< I</path/>{item} action >>
1688
1689	add/alter I<menuitem> with an associated I<action>
1690
1691	=item B<< I</path/>{item}{right-text} >>
1692
1693	add/alter I<menuitem> with B<right-text> as the right-justified text
1694	and as the associated I<action>
1695
1696	=item B<< I</path/>{item}{rtext} action >>
1697
1698	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1699	the right-justified text.
1700
1701	=back
1702
1703	=over 4
1704
1705	=item Special characters in I<action> must be backslash-escaped:
1706
1707	B<\a \b \E \e \n \r \t \octal>
1708
1709	=item or in control-character notation:
1710
1711	B<^@, ^A .. ^Z .. ^_, ^?>
1712
1713	=back
1714
1715	To send a string starting with a B<NUL> (B<^@>) character to the
1716	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1717	the first of which will be stripped off and the balance directed to the
1718	program. Otherwise if I<action> begins with B<NUL> followed by
1719	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1720	balance is sent back to rxvt.
1721
1722	As a convenience for the many Emacs-type editors, I<action> may start
1723	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1724	appended if missed from B<M-x> commands.
1725
1726	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1727	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1728
1729	=over 4
1730
1731	=item For example,
1732
1733	B<M-xapropos> is equivalent to B<\Exapropos\r>
1734
1735	=item and
1736
1737	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1738
1739	=back
1740
1741	The option B<< {I<right-rtext>} >> will be right-justified. In the
1742	absence of a specified action, this text will be used as the I<action>
1743	as well.
1744
1745	=over 4
1746
1747	=item For example,
1748
1749	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1750
1751	=back
1752
1753	The left label I<is> necessary, since it's used for matching, but
1754	implicitly hiding the left label (by using same name for both left and
1755	right labels), or explicitly hiding the left label (by preceeding it
1756	with a dot), makes it possible to have right-justified text only.
1757
1758	=over 4
1759
1760	=item For example,
1761
1762	B</File/{Open}{Open} Open-File-Action>
1763
1764	=item or hiding it
1765
1766	B</File/{.anylabel}{Open} Open-File-Action>
1767
1768	=back
1769
1770	X<menuBarRemove>
1771
1772	=head2 Removing menus
1773
1774	=over 4
1775
1776	=item B<< -/*+ >>
1777
1778	remove all menus from the menuBar, the same as B<[clear]>
1779
1780	=item B<< -+I</path>menu+ >>
1781
1782	remove menu
1783
1784	=item B<< -+I</path>{item}+ >>
1785
1786	remove item
1787
1788	=item B<< -+I</path>{-} >>
1789
1790	remove separator)
1791
1792	=item B<-/path/menu/*>
1793
1794	remove all items, separators and submenus from menu
1795
1796	=back
1797
1798	X<menuBarArrows>
1799
1800	=head2 Quick Arrows
1801
1802	The menus also provide a hook for I<quick arrows> to provide easier
1803	user access. If nothing has been explicitly set, the default is to
1804	emulate the curror keys. The syntax permits each arrow to be altered
1805	individually or all four at once without re-entering their common
1806	beginning/end text. For example, to explicitly associate cursor actions
1807	with the arrows, any of the following forms could be used:
1808
1809	=over 4
1810
1811	=item B<< <r>+I<Right> >>
1812
1813	=item B<< <l>+I<Left> >>
1814
1815	=item B<< <u>+I<Up> >>
1816
1817	=item B<< <d>+I<Down> >>
1818
1819	Define actions for the respective arrow buttons
1820
1821	=item B<< <b>+I<Begin> >>
1822
1823	=item B<< <e>+I<End> >>
1824
1825	Define common beginning/end parts for I<quick arrows> which used in
1826	conjunction with the above <r> <l> <u> <d> constructs
1827
1828	=back
1829
1830	=over 4
1831
1832	=item For example, define arrows individually,
1833
1834	<u>\E[A
1835
1836	<d>\E[B
1837
1838	<r>\E[C
1839
1840	<l>\E[D
1841
1842	=item or all at once
1843
1844	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1845
1846	=item or more compactly (factoring out common parts)
1847
1848	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1849
1850	=back
1851
1852	X<menuBarSummary>
1853
1854	=head2 Command Summary
1855
1856	A short summary of the most I<common> commands:
1857
1858	=over 4
1859
1860	=item [menu:name]
1861
1862	use an existing named menuBar or start a new one
1863
1864	=item [menu]
1865
1866	use the current menuBar
1867
1868	=item [title:string]
1869
1870	set menuBar title
1871
1872	=item [done]
1873
1874	set menu access to readonly and, if reading from a file, signal EOF
1875
1876	=item [done:name]
1877
1878	if reading from a file using [read:file;name] signal EOF
1879
1880	=item [rm:name]
1881
1882	remove named menuBar(s)
1883
1884	=item [rm] [rm:]
1885
1886	remove current menuBar
1887
1888	=item [rm*] [rm:*]
1889
1890	remove all menuBar(s)
1891
1892	=item [swap]
1893
1894	swap top two menuBars
1895
1896	=item [prev]
1897
1898	access the previous menuBar
1899
1900	=item [next]
1901
1902	access the next menuBar
1903
1904	=item [show]
1905
1906	map menuBar
1907
1908	=item [hide]
1909
1910	unmap menuBar
1911
1912	=item [pixmap;file]
1913
1914	=item [pixmap;file;scaling]
1915
1916	set a background pixmap
1917
1918	=item [read:file]
1919
1920	=item [read:file;name]
1921
1922	read in a menu from a file
1923
1924	=item [dump]
1925
1926	dump out all menuBars to /tmp/rxvt-PID
1927
1928	=item /
1929
1930	access menuBar top level
1931
1932	=item ./
1933
1934	=item ../
1935
1936	=item ../../
1937
1938	access current or parent menu level
1939
1940	=item /path/menu
1941
1942	add/access menu
1943
1944	=item /path/{-}
1945
1946	add separator
1947
1948	=item /path/{item}{rtext} action
1949
1950	add/alter menu item
1951
1952	=item -/*
1953
1954	remove all menus from the menuBar
1955
1956	=item -/path/menu
1957
1958	remove menu items, separators and submenus from menu
1959
1960	=item -/path/menu
1961
1962	remove menu
1963
1964	=item -/path/{item}
1965
1966	remove item
1967
1968	=item -/path/{-}
1969
1970	remove separator
1971
1972	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1973
1974	menu quick arrows
1975
1976	=back
1977	X<XPM>
1978
1979	=head1 XPM
1980
1981	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
1982	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
1983	sequence of scaling/positioning commands separated by semi-colons. The	2038	sequence of scaling/positioning commands separated by semi-colons. The
1984	scaling/positioning commands are as follows:	2039	scaling/positioning commands are as follows:
1985		2040
1986	=over 4	2041	=over 4
1987		2042
…		…
2025		2080
2026	For example:	2081	For example:
2027		2082
2028	=over 4	2083	=over 4
2029		2084
2030	=item B<\E]20;funky\a>	2085	=item B<\E]20;funky.jpg\a>
2031		2086
2032	load B<funky.xpm> as a tiled image	2087	load B<funky.jpg> as a tiled image
2033		2088
2034	=item B<\E]20;mona;100\a>	2089	=item B<\E]20;mona.jpg;100\a>
2035		2090
2036	load B<mona.xpm> with a scaling of 100%	2091	load B<mona.jpg> with a scaling of 100%
2037		2092
2038	=item B<\E]20;;200;?\a>	2093	=item B<\E]20;;200;?\a>
2039		2094
2040	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
2041	the title	2096	the title
…		…
2080	=begin table	2135	=begin table
2081		2136
2082	4 Shift	2137	4 Shift
2083	8 Meta	2138	8 Meta
2084	16 Control	2139	16 Control
2085	32 Double Click I<(Rxvt extension)>	2140	32 Double Click I<(rxvt extension)>
2086		2141
2087	=end table	2142	=end table
2088		2143
2089	Col = B<< C<< <x> - SPACE >> >>	2144	Col = B<< C<< <x> - SPACE >> >>
2090		2145
…		…
2167	=end table	2222	=end table
2168		2223
2169	=head1 CONFIGURE OPTIONS	2224	=head1 CONFIGURE OPTIONS
2170		2225
2171	General hint: if you get compile errors, then likely your configuration	2226	General hint: if you get compile errors, then likely your configuration
2172	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
2173	./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>
2174	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
2175	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>.
2176	<rxvt@schmorp.de>.	2231
		2232	All
2177		2233
2178	=over 4	2234	=over 4
2179		2235
2180	=item --enable-everything	2236	=item --enable-everything
2181		2237
2182	Add support for all non-multichoice options listed in "./configure	2238	Add (or remove) support for all non-multichoice options listed in "./configure
2183	--help". Note that unlike other enable options this is order dependant.	2239	--help".
		2240
2184	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
2185	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.
2186		2246
2187	=item --enable-xft	2247	=item --enable-xft (default: enabled)
2188		2248
2189	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
2190	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
2191	don't pay for them.	2251	don't pay for them.
2192		2252
2193	=item --enable-font-styles	2253	=item --enable-font-styles (default: on)
2194		2254
2195	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
2196	styles. The fonts can be set manually or automatically.	2256	styles. The fonts can be set manually or automatically.
2197		2257
2198	=item --with-codesets=NAME,...	2258	=item --with-codesets=NAME,... (default: all)
2199		2259
2200	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>
2201	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
2202	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
2203	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
…		…
2207		2267
2208	=begin table	2268	=begin table
2209		2269
2210	all all available codeset groups	2270	all all available codeset groups
2211	zh common chinese encodings	2271	zh common chinese encodings
2212	zh_ext rarely used but very big chinese encodigs	2272	zh_ext rarely used but very big chinese encodings
2213	jp common japanese encodings	2273	jp common japanese encodings
2214	jp_ext rarely used but big japanese encodings	2274	jp_ext rarely used but big japanese encodings
2215	kr korean encodings	2275	kr korean encodings
2216		2276
2217	=end table	2277	=end table
2218		2278
2219	=item --enable-xim	2279	=item --enable-xim (default: on)
2220		2280
2221	Add support for XIM (X Input Method) protocol. This allows using	2281	Add support for XIM (X Input Method) protocol. This allows using
2222	alternative input methods (e.g. kinput2) and will also correctly	2282	alternative input methods (e.g. kinput2) and will also correctly
2223	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.
2224		2284
2225	=item --enable-unicode3	2285	=item --enable-unicode3 (default: off)
		2286
		2287	Recommended to stay off unless you really need non-BMP characters.
2226		2288
2227	Enable direct support for displaying unicode codepoints above	2289	Enable direct support for displaying unicode codepoints above
2228	65535 (the basic multilingual page). This increases storage	2290	65535 (the basic multilingual page). This increases storage
2229	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
2230	support these extra characters, but Xft does.	2292	support these extra characters, but Xft does.
2231		2293
2232	Please note that rxvt-unicode can store unicode code points >65535	2294	Please note that rxvt-unicode can store unicode code points >65535
2233	even without this flag, but the number of such characters is	2295	even without this flag, but the number of such characters is
2234	limited to a view thousand (shared with combining characters,	2296	limited to a few thousand (shared with combining characters,
2235	see next switch), and right now rxvt-unicode cannot display them	2297	see next switch), and right now rxvt-unicode cannot display them
2236	(input/output and cut&paste still work, though).	2298	(input/output and cut&paste still work, though).
2237		2299
2238	=item --enable-combining	2300	=item --enable-combining (default: on)
2239		2301
2240	Enable automatic composition of combining characters into	2302	Enable automatic composition of combining characters into
2241	composite characters. This is required for proper viewing of text	2303	composite characters. This is required for proper viewing of text
2242	where accents are encoded as seperate unicode characters. This is	2304	where accents are encoded as seperate unicode characters. This is
2243	done by using precomposited characters when available or creating	2305	done by using precomposited characters when available or creating
2244	new pseudo-characters when no precomposed form exists.	2306	new pseudo-characters when no precomposed form exists.
2245		2307
2246	Without --enable-unicode3, the number of additional precomposed characters	2308	Without --enable-unicode3, the number of additional precomposed
2247	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
2248	private use area, extending the number of combinations to 8448). With
2249	--enable-unicode3, no practical limit exists.	2310	(ab-)used). With --enable-unicode3, no practical limit exists.
2250		2311
2251	This option will also enable storage (but not display) of characters	2312	This option will also enable storage (but not display) of characters
2252	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2313	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2253		2314
2254	The combining table also contains entries for arabic presentation forms,	2315	The combining table also contains entries for arabic presentation forms,
2255	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
2256	tell me how these are to be used...).	2317	tell me how these are to be used...).
2257		2318
2258	=item --enable-fallback(=CLASS)	2319	=item --enable-fallback(=CLASS) (default: Rxvt)
2259		2320
2260	When reading resource settings, also read settings for class CLASS	2321	When reading resource settings, also read settings for class CLASS. To
2261	(default: Rxvt). To disable resource fallback use --disable-fallback.	2322	disable resource fallback use --disable-fallback.
2262		2323
2263	=item --with-res-name=NAME	2324	=item --with-res-name=NAME (default: urxvt)
2264		2325
2265	Use the given name (default: urxvt) as default application name when	2326	Use the given name as default application name when
2266	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2327	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2267		2328
2268	=item --with-res-class=CLASS	2329	=item --with-res-class=CLASS (default: URxvt)
2269		2330
2270	Use the given class (default: URxvt) as default application class	2331	Use the given class as default application class
2271	when reading resources. Specify --with-res-class=Rxvt to replace	2332	when reading resources. Specify --with-res-class=Rxvt to replace
2272	rxvt.	2333	rxvt.
2273		2334
2274	=item --enable-utmp	2335	=item --enable-utmp (default: on)
2275		2336
2276	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
2277	start of rxvt execution and delete information when rxvt exits.	2338	start of rxvt execution and delete information when rxvt exits.
2278		2339
2279	=item --enable-wtmp	2340	=item --enable-wtmp (default: on)
2280		2341
2281	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
2282	start of rxvt execution and write logout when rxvt exits. This	2343	start of rxvt execution and write logout when rxvt exits. This
2283	option requires --enable-utmp to also be specified.	2344	option requires --enable-utmp to also be specified.
2284		2345
2285	=item --enable-lastlog	2346	=item --enable-lastlog (default: on)
2286		2347
2287	Write user and tty to lastlog file (used by programs like	2348	Write user and tty to lastlog file (used by programs like
2288	F<lastlogin>) at start of rxvt execution. This option requires	2349	F<lastlogin>) at start of rxvt execution. This option requires
2289	--enable-utmp to also be specified.	2350	--enable-utmp to also be specified.
2290		2351
2291	=item --enable-xpm-background	2352	=item --enable-afterimage (default: on)
2292		2353
2293	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>).
2294		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
2295	=item --enable-transparency	2367	=item --enable-transparency (default: on)
2296		2368
2297	Add support for inheriting parent backgrounds thus giving a fake	2369	Add support for backgrounds, creating illusion of transparency in the term.
2298	transparency to the term.
2299		2370
2300	=item --enable-fading	2371	=item --enable-fading (default: on)
2301		2372
2302	Add support for fading the text when focus is lost.	2373	Add support for fading the text when focus is lost.
2303		2374
2304	=item --enable-tinting
2305
2306	Add support for tinting of transparent backgrounds.
2307
2308	=item --enable-menubar
2309
2310	Add support for our menu bar system (this interacts badly with
2311	dynamic locale switching currently).
2312
2313	=item --enable-rxvt-scroll	2375	=item --enable-rxvt-scroll (default: on)
2314		2376
2315	Add support for the original rxvt scrollbar.	2377	Add support for the original rxvt scrollbar.
2316		2378
2317	=item --enable-next-scroll	2379	=item --enable-next-scroll (default: on)
2318		2380
2319	Add support for a NeXT-like scrollbar.	2381	Add support for a NeXT-like scrollbar.
2320		2382
2321	=item --enable-xterm-scroll	2383	=item --enable-xterm-scroll (default: on)
2322		2384
2323	Add support for an Xterm-like scrollbar.	2385	Add support for an Xterm-like scrollbar.
2324		2386
2325	=item --enable-plain-scroll	2387	=item --enable-plain-scroll (default: on)
2326		2388
2327	Add support for a very unobtrusive, plain-looking scrollbar that	2389	Add support for a very unobtrusive, plain-looking scrollbar that
2328	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
2329	many years.	2391	many years.
2330		2392
2331	=item --enable-half-shadow	2393	=item --enable-ttygid (default: off)
2332
2333	Make shadows on the scrollbar only half the normal width & height.
2334	only applicable to rxvt scrollbars.
2335
2336	=item --enable-ttygid
2337		2394
2338	Change tty device setting to group "tty" - only use this if	2395	Change tty device setting to group "tty" - only use this if
2339	your system uses this type of security.	2396	your system uses this type of security.
2340		2397
2341	=item --disable-backspace-key	2398	=item --disable-backspace-key
2342		2399
2343	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
2344	do it.	2405	do it.
2345		2406
2346	=item --disable-delete-key
2347
2348	Disable any handling of the delete key by us - let the X server
2349	do it.
2350
2351	=item --disable-resources	2407	=item --disable-resources
2352		2408
2353	Remove all resources checking.	2409	Removes any support for resource checking.
2354
2355	=item --enable-xgetdefault
2356
2357	Make resources checking via XGetDefault() instead of our small
2358	version which only checks ~/.Xdefaults, or if that doesn't exist then
2359	~/.Xresources.
2360
2361	Please note that nowadays, things like XIM will automatically pull in and
2362	use the full X resource manager, so the overhead of using it might be very
2363	small, if nonexistant.
2364
2365	=item --enable-strings
2366
2367	Add support for our possibly faster memset() function and other
2368	various routines, overriding your system's versions which may
2369	have been hand-crafted in assembly or may require extra libraries
2370	to link in. (this breaks ANSI-C rules and has problems on many
2371	GNU/Linux systems).
2372		2410
2373	=item --disable-swapscreen	2411	=item --disable-swapscreen
2374		2412
2375	Remove support for swap screen.	2413	Remove support for secondary/swap screen.
2376		2414
2377	=item --enable-frills	2415	=item --enable-frills (default: on)
2378		2416
2379	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
2380	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
2381	disable this.	2419	disable this.
2382		2420
2383	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
2384	in combination with other switches) is:	2422	in combination with other switches) is:
2385		2423
2386	MWM-hints	2424	MWM-hints
2387	EWMH-hints (pid, utf8 names) and protocols (ping)	2425	EWMH-hints (pid, utf8 names) and protocols (ping)
		2426	urgency hint
2388	seperate underline colour	2427	seperate underline colour (-underlineColor)
2389	settable border widths and borderless switch	2428	settable border widths and borderless switch (-w, -b, -bl)
		2429	visual depth selection (-depth)
2390	settable extra linespacing	2430	settable extra linespacing /-lsp)
2391	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	compile in built-in block graphics
		2440	skip builtin block graphics (-sbg)
		2441	separate highlightcolor support (-hc)
		2442
		2443	It also enables some non-essential features otherwise disabled, such as:
		2444
		2445	some round-trip time optimisations
		2446	nearest color allocation on pseudocolor screens
		2447	UTF8_STRING support for selection
		2448	sgr modes 90..97 and 100..107
2392	backindex and forwardindex escape sequence	2449	backindex and forwardindex escape sequences
		2450	view change/zero scrollback escape sequences
		2451	locale switching escape sequence
2393	window op and some xterm/OSC escape sequences	2452	window op and some xterm/OSC escape sequences
2394	tripleclickwords	2453	rectangular selections
2395	settable insecure mode	2454	trailing space removal for selections
2396	keysym remapping support	2455	verbose X error handling
2397	cursor blinking and underline cursor
2398	-embed and -pty-fd options
2399		2456
2400	=item --enable-iso14755	2457	=item --enable-iso14755 (default: on)
2401		2458
2402	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2459	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2403	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2460	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2404	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2461	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2405	this switch.	2462	this switch.
2406		2463
2407	=item --enable-keepscrolling	2464	=item --enable-keepscrolling (default: on)
2408		2465
2409	Add support for continual scrolling of the display when you hold	2466	Add support for continual scrolling of the display when you hold
2410	the mouse button down on a scrollbar arrow.	2467	the mouse button down on a scrollbar arrow.
2411		2468
		2469	=item --enable-selectionscrolling (default: on)
		2470
		2471	Add support for scrolling when the selection moves to the top or
		2472	bottom of the screen.
		2473
2412	=item --enable-mousewheel	2474	=item --enable-mousewheel (default: on)
2413		2475
2414	Add support for scrolling via mouse wheel or buttons 4 & 5.	2476	Add support for scrolling via mouse wheel or buttons 4 & 5.
2415		2477
2416	=item --enable-slipwheeling	2478	=item --enable-slipwheeling (default: on)
2417		2479
2418	Add support for continual scrolling (using the mouse wheel as an	2480	Add support for continual scrolling (using the mouse wheel as an
2419	accelerator) while the control key is held down. This option	2481	accelerator) while the control key is held down. This option
2420	requires --enable-mousewheel to also be specified.	2482	requires --enable-mousewheel to also be specified.
2421		2483
2422	=item --disable-new-selection
2423
2424	Remove support for mouse selection style like that of xterm.
2425
2426	=item --enable-dmalloc
2427
2428	Use Gray Watson's malloc - which is good for debugging See
2429	http://www.letters.com/dmalloc/ for details If you use either this or the
2430	next option, you may need to edit src/Makefile after compiling to point
2431	DINCLUDE and DLIB to the right places.
2432
2433	You can only use either this option and the following (should
2434	you use either) .
2435
2436	=item --enable-dlmalloc
2437
2438	Use Doug Lea's malloc - which is good for a production version
2439	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2440
2441	=item --enable-smart-resize	2484	=item --enable-smart-resize (default: off)
2442		2485
2443	Add smart growth/shrink behaviour when changing font size via from hot	2486	Add smart growth/shrink behaviour when resizing.
2444	keys. This should keep in a fixed position the rxvt corner which is	2487	This should keep the window corner which is closest to a corner of
2445	closest to a corner of the screen.	2488	the screen in a fixed position.
2446		2489
2447	=item --enable-pointer-blank	2490	=item --enable-pointer-blank (default: on)
2448		2491
2449	Add support to have the pointer disappear when typing or inactive.	2492	Add support to have the pointer disappear when typing or inactive.
2450		2493
2451	=item --with-name=NAME	2494	=item --enable-perl (default: on)
2452		2495
		2496	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2497	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
		2498	files in F<src/perl-ext/> for the extensions that are installed by
		2499	default. The perl interpreter that is used can be specified via the
		2500	C<PERL> environment variable when running configure. Even when compiled
		2501	in, perl will I<not> be initialised when all extensions have been disabled
		2502	C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
		2503	resource standpoint.
		2504
		2505	=item --with-afterimage-config=DIR
		2506
		2507	Look for the libAfterImage config script in DIR.
		2508
		2509	=item --with-name=NAME (default: urxvt)
		2510
2453	Set the basename for the installed binaries (default: C<urxvt>, resulting	2511	Set the basename for the installed binaries, resulting
2454	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2512	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2455	C<rxvt>.	2513	C<rxvt>.
2456		2514
2457	=item --with-term=NAME	2515	=item --with-term=NAME (default: rxvt-unicode)
2458		2516
2459	Change the environmental variable for the terminal to NAME (default	2517	Change the environmental variable for the terminal to NAME.
2460	C<rxvt-unicode>)
2461		2518
2462	=item --with-terminfo=PATH	2519	=item --with-terminfo=PATH
2463		2520
2464	Change the environmental variable for the path to the terminfo tree to	2521	Change the environmental variable for the path to the terminfo tree to
2465	PATH.	2522	PATH.
2466		2523
2467	=item --with-x	2524	=item --with-x
2468		2525
2469	Use the X Window System (pretty much default, eh?).	2526	Use the X Window System (pretty much default, eh?).
2470
2471	=item --with-xpm-includes=DIR
2472
2473	Look for the XPM includes in DIR.
2474
2475	=item --with-xpm-library=DIR
2476
2477	Look for the XPM library in DIR.
2478
2479	=item --with-xpm
2480
2481	Not needed - define via --enable-xpm-background.
2482		2527
2483	=back	2528	=back
2484		2529
2485	=head1 AUTHORS	2530	=head1 AUTHORS
2486		2531

Diff Legend

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