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.12 by root, Mon Aug 16 00:17:27 2004 UTC vs.
Revision 1.135 by ayin, Sun Jun 24 23:30:17 2007 UTC

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

Diff Legend

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