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.3 by root, Thu Aug 12 22:22:30 2004 UTC vs.
Revision 1.177 by root, Sat May 30 08:53:48 2009 UTC

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

Diff Legend

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