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

Diff Legend

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