ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.196 by sf-exg, Fri Sep 3 10:16:12 2010 UTC

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

Diff Legend

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