ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.166 by root, Sat Feb 2 14:59:48 2008 UTC

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

Diff Legend

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