[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.pod

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.162 by ayin, Sat Jan 19 15:00:49 2008 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.56 by root, Wed Jul 13 01:01:41 2005 UTC vs. Revision 1.162 by ayin, Sat Jan 19 15:00:49 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.162 by ayin, Sat Jan 19 15:00:49 2008 UTC