ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.7.pod

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

Diff Legend

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