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.60 by root, Fri Jul 29 03:12:10 2005 UTC vs.
Revision 1.148 by ayin, Wed Oct 24 10:39:56 2007 UTC

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

Diff Legend

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