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.5 by root, Thu Aug 12 22:29:28 2004 UTC vs.
Revision 1.145 by root, Sun Sep 9 08:38:40 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	=head3 How can I make mplayer display video correctly?
		466
		467	We are working on it, in the meantime, as a workaround, use something like:
		468
		469	@@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
		470
		471
		472	=head2 Keyboard, Mouse & User Interaction
		473
		474	=head3 The new selection selects pieces that are too big, how can I select single words?
		475
		476	If you want to select e.g. alphanumeric words, you can use the following
		477	setting:
		478
		479	URxvt.selection.pattern-0: ([[:word:]]+)
		480
		481	If you click more than twice, the selection will be extended
		482	more and more.
		483
		484	To get a selection that is very similar to the old code, try this pattern:
		485
		486	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		487
		488	Please also note that the I<LeftClick Shift-LeftClik> combination also
		489	selects words like the old code.
		490
		491	=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
		492
		493	You can disable the perl extension completely by setting the
		494	B<perl-ext-common> resource to the empty string, which also keeps
		495	rxvt-unicode from initialising perl, saving memory.
		496
		497	If you only want to disable specific features, you first have to
		498	identify which perl extension is responsible. For this, read the section
		499	B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
		500	example, to disable the B<selection-popup> and B<option-popup>, specify
		501	this B<perl-ext-common> resource:
		502
		503	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		504
		505	This will keep the default extensions, but disable the two popup
		506	extensions. Some extensions can also be configured, for example,
		507	scrollback search mode is triggered by B<M-s>. You can move it to any
		508	other combination either by setting the B<searchable-scrollback> resource:
		509
		510	URxvt.searchable-scrollback: CM-s
		511
		512	=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
		513
		514	See next entry.
		515
		516	=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
		517
		518	These are caused by the C<readline> perl extension. Under normal
		519	circumstances, it will move your cursor around when you click into the
		520	line that contains it. It tries hard not to do this at the wrong moment,
		521	but when running a program that doesn't parse cursor movements or in some
		522	cases during rlogin sessions, it fails to detect this properly.
		523
		524	You can permanently switch this feature off by disabling the C<readline>
		525	extension:
		526
		527	URxvt.perl-ext-common: default,-readline
		528
		529	=head3 My numerical keypad acts weird and generates differing output?
		530
		531	Some Debian GNUL/Linux users seem to have this problem, although no
		532	specific details were reported so far. It is possible that this is caused
		533	by the wrong C<TERM> setting, although the details of whether and how
		534	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		535	keymap. See the answer to the previous question, and please report if that
		536	helped.
		537
		538	=head3 My Compose (Multi_key) key is no longer working.
		539
		540	The most common causes for this are that either your locale is not set
		541	correctly, or you specified a B<preeditStyle> that is not supported by
		542	your input method. For example, if you specified B<OverTheSpot> and
		543	your input method (e.g. the default input method handling Compose keys)
		544	does not support this (for instance because it is not visual), then
		545	rxvt-unicode will continue without an input method.
		546
		547	In this case either do not specify a B<preeditStyle> or specify more than
		548	one pre-edit style, such as B<OverTheSpot,Root,None>.
		549
		550	=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		551
		552	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		553	international keyboards) or simply use ISO 14755 support to your
		554	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		555	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		556	character and so on.
		557
		558	=head3 Mouse cut/paste suddenly no longer works.
		559
		560	Make sure that mouse reporting is actually turned off since killing
		561	some editors prematurely may leave the mouse in mouse report mode. I've
		562	heard that tcsh may use mouse reporting unless it otherwise specified. A
		563	quick check is to see if cut/paste works when the Alt or Shift keys are
		564	depressed.
		565
		566	=head3 What's with the strange Backspace/Delete key behaviour?
		567
		568	Assuming that the physical Backspace key corresponds to the
		569	Backspace keysym (not likely for Linux ... see the following
		570	question) there are two standard values that can be used for
		571	Backspace: C<^H> and C<^?>.
		572
		573	Historically, either value is correct, but rxvt-unicode adopts the debian
		574	policy of using C<^?> when unsure, because it's the one and only correct
		575	choice :).
		576
		577	Rxvt-unicode tries to inherit the current stty settings and uses the value
		578	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
		579	started from a terminal (say, from a menu or by remote shell), then the
		580	system value of `erase', which corresponds to CERASE in <termios.h>, will
		581	be used (which may not be the same as your stty setting).
		582
		583	For starting a new rxvt-unicode:
		584
		585	# use Backspace = ^H
		586	$ stty erase ^H
		587	$ @@URXVT_NAME@@
		588
		589	# use Backspace = ^?
		590	$ stty erase ^?
		591	$ @@URXVT_NAME@@
		592
		593	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
		594
		595	For an existing rxvt-unicode:
		596
		597	# use Backspace = ^H
		598	$ stty erase ^H
		599	$ echo -n "^[[36h"
		600
		601	# use Backspace = ^?
		602	$ stty erase ^?
		603	$ echo -n "^[[36l"
		604
		605	This helps satisfy some of the Backspace discrepancies that occur, but
		606	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
		607	properly reflects that.
		608
		609	The Delete key is a another casualty of the ill-defined Backspace problem.
		610	To avoid confusion between the Backspace and Delete keys, the Delete
		611	key has been assigned an escape sequence to match the vt100 for Execute
		612	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
		613
		614	Some other Backspace problems:
		615
		616	some editors use termcap/terminfo,
		617	some editors (vim I'm told) expect Backspace = ^H,
		618	GNU Emacs (and Emacs-like editors) use ^H for help.
		619
		620	Perhaps someday this will all be resolved in a consistent manner.
		621
		622	=head3 I don't like the key-bindings. How do I change them?
		623
		624	There are some compile-time selections available via configure. Unless
		625	you have run "configure" with the C<--disable-resources> option you can
		626	use the `keysym' resource to alter the keystrings associated with keysyms.
		627
		628	Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
		629
		630	URxvt.keysym.Home: \033[1~
		631	URxvt.keysym.End: \033[4~
		632	URxvt.keysym.C-apostrophe: \033<C-'>
		633	URxvt.keysym.C-slash: \033<C-/>
		634	URxvt.keysym.C-semicolon: \033<C-;>
		635	URxvt.keysym.C-grave: \033<C-`>
		636	URxvt.keysym.C-comma: \033<C-,>
		637	URxvt.keysym.C-period: \033<C-.>
		638	URxvt.keysym.C-0x60: \033<C-`>
		639	URxvt.keysym.C-Tab: \033<C-Tab>
		640	URxvt.keysym.C-Return: \033<C-Return>
		641	URxvt.keysym.S-Return: \033<S-Return>
		642	URxvt.keysym.S-space: \033<S-Space>
		643	URxvt.keysym.M-Up: \033<M-Up>
		644	URxvt.keysym.M-Down: \033<M-Down>
		645	URxvt.keysym.M-Left: \033<M-Left>
		646	URxvt.keysym.M-Right: \033<M-Right>
		647	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
		648	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
		649	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
		650
		651	See some more examples in the documentation for the B<keysym> resource.
		652
		653	=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
		654
		655	KP_Insert == Insert
		656	F22 == Print
		657	F27 == Home
		658	F29 == Prior
		659	F33 == End
		660	F35 == Next
		661
		662	Rather than have rxvt-unicode try to accommodate all the various possible
		663	keyboard mappings, it is better to use `xmodmap' to remap the keys as
		664	required for your particular machine.
		665
		666
		667	=head2 Terminal Configuration
		668
		669	=head3 Can I see a typical configuration?
		670
		671	The default configuration tries to be xterm-like, which I don't like that
		672	much, but it's least surprise to regular users.
		673
		674	As a rxvt or rxvt-unicode user, you are practically supposed to invest
		675	time into customising your terminal. To get you started, here is the
		676	author's .Xdefaults entries, with comments on what they do. It's certainly
		677	not I<typical>, but what's typical...
		678
		679	URxvt.cutchars: "()*,<>[]{}|'
		680	URxvt.print-pipe: cat >/tmp/xxx
		681
		682	These are just for testing stuff.
		683
		684	URxvt.imLocale: ja_JP.UTF-8
		685	URxvt.preeditType: OnTheSpot,None
		686
		687	This tells rxvt-unicode to use a special locale when communicating with
		688	the X Input Method, and also tells it to only use the OnTheSpot pre-edit
		689	type, which requires the C<xim-onthespot> perl extension but rewards me
		690	with correct-looking fonts.
		691
		692	URxvt.perl-lib: /root/lib/urxvt
		693	URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
		694	URxvt.selection.pattern-0: ( at .*? line \\d+)
		695	URxvt.selection.pattern-1: ^(/[^:]+):\
		696	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		697	URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
		698
		699	This is my perl configuration. The first two set the perl library
		700	directory and also tells urxvt to use a large number of extensions. I
		701	develop for myself mostly, so I actually use most of the extensions I
		702	write.
		703
		704	The selection stuff mainly makes the selection perl-error-message aware
		705	and tells it to convert perl error messages into vi-commands to load the
		706	relevant file and go tot he error line number.
		707
		708	URxvt.scrollstyle: plain
		709	URxvt.secondaryScroll: true
		710
		711	As the documentation says: plain is the preferred scrollbar for the
		712	author. The C<secondaryScroll> configures urxvt to scroll in full-screen
		713	apps, like screen, so lines scrolled out of screen end up in urxvt's
		714	scrollback buffer.
		715
		716	URxvt.background: #000000
		717	URxvt.foreground: gray90
		718	URxvt.color7: gray90
		719	URxvt.colorBD: #ffffff
		720	URxvt.cursorColor: #e0e080
		721	URxvt.throughColor: #8080f0
		722	URxvt.highlightColor: #f0f0f0
		723
		724	Some colours. Not sure which ones are being used or even non-defaults, but
		725	these are in my .Xdefaults. Most notably, they set foreground/background
		726	to light gray/black, and also make sure that the colour 7 matches the
		727	default foreground colour.
		728
		729	URxvt.underlineColor: yellow
		730
		731	Another colour, makes underline lines look different. Sometimes hurts, but
		732	is mostly a nice effect.
		733
		734	URxvt.geometry: 154x36
		735	URxvt.loginShell: false
		736	URxvt.meta: ignore
		737	URxvt.utmpInhibit: true
		738
		739	Uh, well, should be mostly self-explanatory. By specifying some defaults
		740	manually, I can quickly switch them for testing.
		741
		742	URxvt.saveLines: 8192
		743
		744	A large scrollback buffer is essential. Really.
		745
		746	URxvt.mapAlert: true
		747
		748	The only case I use it is for my IRC window, which I like to keep
		749	iconified till people msg me (which beeps).
		750
		751	URxvt.visualBell: true
		752
		753	The audible bell is often annoying, especially when in a crowd.
		754
		755	URxvt.insecure: true
		756
		757	Please don't hack my mutt! Ooops...
		758
		759	URxvt.pastableTabs: false
		760
		761	I once thought this is a great idea.
		762
		763	urxvt.font: 9x15bold,\
		764	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		765	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		766	[codeset=JISX0208]xft:Kochi Gothic, \
		767	xft:Bitstream Vera Sans Mono:autohint=true, \
		768	xft:Code2000:antialias=false
		769	urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
		770	urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		771	urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		772
		773	I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
		774	overwhelmed. A special note: the C<9x15bold> mentioned above is actually
		775	the version from XFree-3.3, as XFree-4 replaced it by a totally different
		776	font (different glyphs for C<;> and many other harmless characters),
		777	while the second font is actually the C<9x15bold> from XFree4/XOrg. The
		778	bold version has less chars than the medium version, so I use it for rare
		779	characters, too. When editing sources with vim, I use italic for comments
		780	and other stuff, which looks quite good with Bitstream Vera anti-aliased.
		781
		782	Terminus is a quite bad font (many very wrong glyphs), but for most of my
		783	purposes, it works, and gives a different look, as my normal (Non-bold)
		784	font is already bold, and I want to see a difference between bold and
		785	normal fonts.
		786
		787	Please note that I used the C<urxvt> instance name and not the C<URxvt>
		788	class name. Thats because I use different configs for different purposes,
		789	for example, my IRC window is started with C<-name IRC>, and uses these
		790	defaults:
		791
		792	IRC*title: IRC
		793	IRC*geometry: 87x12+535+542
		794	IRC*saveLines: 0
		795	IRC*mapAlert: true
		796	IRC*font: suxuseuro
		797	IRC*boldFont: suxuseuro
		798	IRC*colorBD: white
		799	IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		800	IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		801
		802	C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
		803	sizes. C<suxuseuro> allows me to keep an eye (and actually read)
		804	stuff while keeping a very small window. If somebody pastes something
		805	complicated (e.g. japanese), I temporarily switch to a larger font.
		806
		807	The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
		808	C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
		809	file for different hosts, for example, on ym main desktop, I use:
		810
		811	URxvt.keysym.C-M-q: command:\033[3;5;5t
		812	URxvt.keysym.C-M-y: command:\033[3;5;606t
		813	URxvt.keysym.C-M-e: command:\033[3;1605;5t
		814	URxvt.keysym.C-M-c: command:\033[3;1605;606t
		815	URxvt.keysym.C-M-p: perl:test
		816
		817	The first for keysym definitions allow me to quickly bring some windows
		818	in the layout I like most. Ion users might start laughing but will stop
		819	immediately when I tell them that I use my own Fvwm2 module for much the
		820	same effect as Ion provides, and I only very rarely use the above key
		821	combinations :->
		822
		823	=head3 Why doesn't rxvt-unicode read my resources?
		824
		825	Well, why, indeed? It does, in a way very similar to other X
		826	applications. Most importantly, this means that if you or your OS loads
		827	resources into the X display (the right way to do it), rxvt-unicode will
		828	ignore any resource files in your home directory. It will only read
		829	F<$HOME/.Xdefaults> when no resources are attached to the display.
		830
		831	If you have or use an F<$HOME/.Xresources> file, chances are that
		832	resources are loaded into your X-server. In this case, you have to
		833	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		834
		835	Also consider the form resources have to use:
		836
		837	URxvt.resource: value
		838
		839	If you want to use another form (there are lots of different ways of
		840	specifying resources), make sure you understand whether and why it
		841	works. If unsure, use the form above.
		842
		843	=head3 When I log-in to another system it tells me about missing terminfo data?
		844
		845	The terminal description used by rxvt-unicode is not as widely available
		846	as that for xterm, or even rxvt (for which the same problem often arises).
		847
		848	The correct solution for this problem is to install the terminfo, this can
		849	be done like this (with ncurses' infocmp and works as user and admin):
		850
		851	REMOTE=remotesystem.domain
		852	infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
		853
		854	... or by installing rxvt-unicode normally on the remote system,
		855
		856	One some systems you might need to set C<$TERMINFO> to the full path of
		857	F<$HOME/.terminfo> for this to work.
		858
		859	If you cannot or do not want to do this, then you can simply set
		860	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		861	problems arising, which includes wrong keymapping, less and different
		862	colours and some refresh errors in fullscreen applications. It's a nice
		863	quick-and-dirty workaround for rare cases, though.
		864
		865	If you always want to do this (and are fine with the consequences) you
		866	can either recompile rxvt-unicode with the desired TERM value or use a
		867	resource to set it:
		868
		869	URxvt.termName: rxvt
		870
		871	If you don't plan to use B<rxvt> (quite common...) you could also replace
		872	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		873
		874	=head3 C<tic> outputs some error when compiling the terminfo entry.
		875
		876	Most likely it's the empty definition for C<enacs=>. Just replace it by
		877	C<enacs=\E[0@> and try again.
		878
		879	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		880
		881	See next entry.
		882
		883	=head3 I need a termcap file entry.
		884
		885	One reason you might want this is that some distributions or operating
		886	systems still compile some programs using the long-obsoleted termcap
		887	library (Fedora Core's bash is one example) and rely on a termcap entry
		888	for C<rxvt-unicode>.
		889
		890	You could use rxvt's termcap entry with reasonable results in many cases.
		891	You can also create a termcap entry by using terminfo's infocmp program
		892	like this:
		893
		894	infocmp -C rxvt-unicode
		895
		896	Or you could use this termcap entry, generated by the command above:
		897
		898	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		899	:am:bw:eo:km:mi:ms:xn:xo:\
		900	:co#80:it#8:li#24:lm#0:\
		901	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		902	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		903	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		904	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		905	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		906	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		907	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		908	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		909	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		910	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		911	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		912	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		913	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		914	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		915	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		916	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		917	:vs=\E[?25h:
		918
		919	=head3 Why does C<ls> no longer have coloured output?
		920
		921	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		922	decide whether a terminal has colour, but uses its own configuration
		923	file. Needless to say, C<rxvt-unicode> is not in its default file (among
		924	with most other terminals supporting colour). Either add:
		925
		926	TERM rxvt-unicode
		927
		928	to C</etc/DIR_COLORS> or simply add:
		929
		930	alias ls='ls --color=auto'
		931
		932	to your C<.profile> or C<.bashrc>.
		933
		934	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		935
		936	See next entry.
		937
		938	=head3 Why doesn't vim/emacs etc. make use of italic?
		939
		940	See next entry.
		941
		942	=head3 Why are the secondary screen-related options not working properly?
		943
		944	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		945	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		946	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		947	features. Unfortunately, some of these (most notably, again, Debian
		948	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		949	file, so you will need to install it on your own (See the question B<When
		950	I log-in to another system it tells me about missing terminfo data?> on
		951	how to do this).
		952
		953
		954	=head2 Encoding / Locale / Input Method Issues
		955
		956	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		957
		958	See next entry.
		959
		960	=head3 Unicode does not seem to work?
		961
		962	If you encounter strange problems like typing an accented character but
		963	getting two unrelated other characters or similar, or if program output is
		964	subtly garbled, then you should check your locale settings.
		965
		966	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		967	programs running in it. Often rxvt-unicode is started in the C<C> locale,
		968	while the login script running within the rxvt-unicode window changes the
		969	locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
		970	not going to work, and is the most common cause for problems.
		971
		972	The best thing is to fix your startup environment, as you will likely run
		973	into other problems. If nothing works you can try this in your .profile.
		974
		975	printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
		976
		977	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		978	supported on your systems. Some systems have a C<locale> command which
		979	displays this (also, C<perl -e0> can be used to check locale settings, as
		980	it will complain loudly if it cannot set the locale). If it displays something
		981	like:
		982
		983	locale: Cannot set LC_CTYPE to default locale: ...
		984
		985	Then the locale you specified is not supported on your system.
		986
		987	If nothing works and you are sure that everything is set correctly then
		988	you will need to remember a little known fact: Some programs just don't
		989	support locales :(
		990
		991	=head3 How does rxvt-unicode determine the encoding to use?
		992
		993	See next entry.
		994
		995	=head3 Is there an option to switch encodings?
		996
		997	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		998	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		999	UTF-8 or any other encodings with respect to terminal I/O.
		1000
		1001	The reasons is that there exists a perfectly fine mechanism for selecting
		1002	the encoding, doing I/O and (most important) communicating this to all
		1003	applications so everybody agrees on character properties such as width
		1004	and code number. This mechanism is the I<locale>. Applications not using
		1005	that info will have problems (for example, C<xterm> gets the width of
		1006	characters wrong as it uses its own, locale-independent table under all
		1007	locales).
		1008
		1009	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		1010	programs doing the same (that is, most) will automatically agree in the
		1011	interpretation of characters.
		1012
		1013	Unfortunately, there is no system-independent way to select locales, nor
		1014	is there a standard on how locale specifiers will look like.
		1015
		1016	On most systems, the content of the C<LC_CTYPE> environment variable
		1017	contains an arbitrary string which corresponds to an already-installed
		1018	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		1019	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		1020	(i.e. C<de> or C<german>) are also common.
		1021
		1022	Rxvt-unicode ignores all other locale categories, and except for
		1023	the encoding, ignores country or language-specific settings,
		1024	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		1025	rxvt-unicode.
		1026
		1027	If you want to use a specific encoding you have to make sure you start
		1028	rxvt-unicode with the correct C<LC_CTYPE> category.
		1029
		1030	=head3 Can I switch locales at runtime?
		1031
		1032	Yes, using an escape sequence. Try something like this, which sets
		1033	rxvt-unicode's idea of C<LC_CTYPE>.
		1034
		1035	printf '\33]701;%s\007' ja_JP.SJIS
		1036
		1037	See also the previous answer.
		1038
		1039	Sometimes this capability is rather handy when you want to work in
		1040	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		1041	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		1042	first switches to a locale supported by xjdic and back later:
		1043
		1044	printf '\33]701;%s\007' ja_JP.SJIS
		1045	xjdic -js
		1046	printf '\33]701;%s\007' de_DE.UTF-8
		1047
		1048	You can also use xterm's C<luit> program, which usually works fine, except
		1049	for some locales where character width differs between program- and
		1050	rxvt-unicode-locales.
		1051
		1052	=head3 I have problems getting my input method working.
		1053
		1054	Try a search engine, as this is slightly different for every input method server.
		1055
		1056	Here is a checklist:
		1057
		1058	=over 4
		1059
		1060	=item - Make sure your locale I<and> the imLocale are supported on your OS.
		1061
		1062	Try C<locale -a> or check the documentation for your OS.
		1063
		1064	=item - Make sure your locale or imLocale matches a locale supported by your XIM.
		1065
		1066	For example, B<kinput2> does not support UTF-8 locales, you should use
		1067	C<ja_JP.EUC-JP> or equivalent.
		1068
		1069	=item - Make sure your XIM server is actually running.
		1070
		1071	=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
		1072
		1073	When you want to use e.g. B<kinput2>, it must be set to
		1074	C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
		1075	method servers are running with this command:
		1076
		1077	xprop -root XIM_SERVERS
		1078
		1079	=item
		1080
		1081	=back
		1082
		1083	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
		1084
		1085	You can specify separate locales for the input method and the rest of the
		1086	terminal, using the resource C<imlocale>:
		1087
		1088	URxvt.imlocale: ja_JP.EUC-JP
		1089
		1090	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		1091	use your input method. Please note, however, that, depending on your Xlib
		1092	version, you may not be able to input characters outside C<EUC-JP> in a
		1093	normal way then, as your input method limits you.
		1094
		1095	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		1096
		1097	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		1098	design. Applications can avoid some crashes at the expense of memory
		1099	leaks, and Input Methods can avoid some crashes by careful ordering at
		1100	exit time. B<kinput2> (and derived input methods) generally succeeds,
		1101	while B<SCIM> (or similar input methods) fails. In the end, however,
		1102	crashes cannot be completely avoided even if both sides cooperate.
		1103
		1104	So the only workaround is not to kill your Input Method Servers.
		1105
		1106
		1107	=head2 Operating Systems / Package Maintaining
		1108
		1109	=head3 I am using Debian GNU/Linux and have a problem...
		1110
		1111	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		1112	patches that considerably change the behaviour of rxvt-unicode (but
		1113	unfortunately this notice has been removed). Before reporting a bug to
		1114	the original rxvt-unicode author please download and install the genuine
		1115	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		1116	the problem. If you cannot, chances are that the problems are specific to
		1117	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		1118	Tracking System (use C<reportbug> to report the bug).
		1119
		1120	For other problems that also affect the Debian package, you can and
		1121	probably should use the Debian BTS, too, because, after all, it's also a
		1122	bug in the Debian version and it serves as a reminder for other users that
		1123	might encounter the same issue.
		1124
		1125	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		1126
		1127	You should build one binary with the default options. F<configure>
		1128	now enables most useful options, and the trend goes to making them
		1129	runtime-switchable, too, so there is usually no drawback to enabling them,
		1130	except higher disk and possibly memory usage. The perl interpreter should
		1131	be enabled, as important functionality (menus, selection, likely more in
		1132	the future) depends on it.
		1133
		1134	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		1135	system-wide (except maybe with C<defaults>). This will result in useful
		1136	behaviour. If your distribution aims at low memory, add an empty
		1137	C<perl-ext-common> resource to the app-defaults file. This will keep the
		1138	perl interpreter disabled until the user enables it.
		1139
		1140	If you can/want build more binaries, I recommend building a minimal
		1141	one with C<--disable-everything> (very useful) and a maximal one with
		1142	C<--enable-everything> (less useful, it will be very big due to a lot of
		1143	encodings built-in that increase download times and are rarely used).
		1144
		1145	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		1146
		1147	It should be, starting with release 7.1. You are encouraged to properly
		1148	install urxvt with privileges necessary for your OS now.
		1149
		1150	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		1151	into a helper process for privileged operations (pty handling on some
		1152	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		1153	immediately. This is much safer than most other terminals that keep
		1154	privileges while running (but is more relevant to urxvt, as it contains
		1155	things as perl interpreters, which might be "helpful" to attackers).
		1156
		1157	This forking is done as the very first within main(), which is very early
		1158	and reduces possible bugs to initialisation code run before main(), or
		1159	things like the dynamic loader of your system, which should result in very
		1160	little risk.
		1161
		1162	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		1163
		1164	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		1165	in your compile environment, or an implementation that implements it,
		1166	whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		1167	B<wchar_t> is represented as unicode.
		1168
		1169	As you might have guessed, FreeBSD does neither define this symbol nor
		1170	does it support it. Instead, it uses its own internal representation of
		1171	B<wchar_t>. This is, of course, completely fine with respect to standards.
		1172
		1173	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		1174	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		1175
		1176	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		1177	apps in an OS, as using a locale-dependent (and non-standardized)
		1178	representation of B<wchar_t> makes it impossible to convert between
		1179	B<wchar_t> (as used by X11 and your applications) and any other encoding
		1180	without implementing OS-specific-wrappers for each and every locale. There
		1181	simply are no APIs to convert B<wchar_t> into anything except the current
		1182	locale encoding.
		1183
		1184	Some applications (such as the formidable B<mlterm>) work around this
		1185	by carrying their own replacement functions for character set handling
		1186	with them, and either implementing OS-dependent hacks or doing multiple
		1187	conversions (which is slow and unreliable in case the OS implements
		1188	encodings slightly different than the terminal emulator).
		1189
		1190	The rxvt-unicode author insists that the right way to fix this is in the
		1191	system libraries once and for all, instead of forcing every app to carry
		1192	complete replacements for them :)
		1193
		1194	=head3 How can I use rxvt-unicode under cygwin?
		1195
		1196	rxvt-unicode should compile and run out of the box on cygwin, using
		1197	the X11 libraries that come with cygwin. libW11 emulation is no
		1198	longer supported (and makes no sense, either, as it only supported a
		1199	single font). I recommend starting the X-server in C<-multiwindow> or
		1200	C<-rootless> mode instead, which will result in similar look&feel as the
		1201	old libW11 emulation.
		1202
		1203	At the time of this writing, cygwin didn't seem to support any multi-byte
		1204	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1205	to 8-bit encodings.
		1206
		1207	=head3 Character widths are not correct.
		1208
		1209	urxvt uses the system wcwidth function to know the information about
		1210	the width of characters, so on systems with incorrect locale data you
		1211	will likely get bad results. Two notorious examples are Solaris 9,
		1212	where single-width characters like U+2514 are reported as double-width,
		1213	and Darwin 8, where combining chars are reported having width 1.
		1214
		1215	The solution is to upgrade your system or switch to a better one. A
		1216	possibly working workaround is to use a wcwidth implementation like
		1217
		1218	http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
		1219
1	=head1 RXVT TECHNICAL REFERENCE	1220	=head1 RXVT-UNICODE TECHNICAL REFERENCE
2		1221
		1222	The rest of this document describes various technical aspects of
		1223	B<rxvt-unicode>. First the description of supported command sequences,
		1224	followed by pixmap support and last by a description of all features
		1225	selectable at C<configure> time.
		1226
3	=head1 Definitions	1227	=head2 Definitions
4		1228
5	=over 4	1229	=over 4
6		1230
7	=item B<< C<c> >>	1231	=item B<< C<c> >>
8		1232
…		…
26		1250
27	A text parameter composed of printable characters.	1251	A text parameter composed of printable characters.
28		1252
29	=back	1253	=back
30		1254
31	=head1 Values	1255	=head2 Values
32		1256
33	=over 4	1257	=over 4
34		1258
35	=item B<< C<ENQ> >>	1259	=item B<< C<ENQ> >>
36		1260
…		…
79		1303
80	Space Character	1304	Space Character
81		1305
82	=back	1306	=back
83		1307
84	=head1 Escape Sequences	1308	=head2 Escape Sequences
85		1309
86	=over 4	1310	=over 4
87		1311
88	=item B<< C<ESC # 8> >>	1312	=item B<< C<ESC # 8> >>
89		1313
…		…
135	Single Shift Select of G3 Character Set (SS3): affects next character	1359	Single Shift Select of G3 Character Set (SS3): affects next character
136	only I<unimplemented>	1360	only I<unimplemented>
137		1361
138	=item B<< C<ESC Z> >>	1362	=item B<< C<ESC Z> >>
139		1363
140	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>	1364	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141		1365
142	=item B<< C<ESC c> >>	1366	=item B<< C<ESC c> >>
143		1367
144	Full reset (RIS)	1368	Full reset (RIS)
145		1369
…		…
149		1373
150	=item B<< C<ESC o> >>	1374	=item B<< C<ESC o> >>
151		1375
152	Invoke the G3 Character Set (LS3)	1376	Invoke the G3 Character Set (LS3)
153		1377
154	=item B<< C<ESC>(C<C> >>	1378	=item B<< C<ESC ( C> >>
155		1379
156	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	1380	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157		1381
158	=item B<< C<ESC>)C<C> >>	1382	=item B<< C<ESC ) C> >>
159		1383
160	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	1384	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161		1385
162	=item B<< C<ESC * C> >>	1386	=item B<< C<ESC * C> >>
163		1387
…		…
187		1411
188	=back	1412	=back
189		1413
190	X<CSI>	1414	X<CSI>
191		1415
192	=head1 CSI (Code Sequence Introducer) Sequences	1416	=head2 CSI (Command Sequence Introducer) Sequences
193		1417
194	=over 4	1418	=over 4
195		1419
196	=item B<< C<ESC [ Ps @> >>	1420	=item B<< C<ESC [ Ps @> >>
197		1421
…		…
304		1528
305	=item B<< C<ESC [ Ps c> >>	1529	=item B<< C<ESC [ Ps c> >>
306		1530
307	Send Device Attributes (DA)	1531	Send Device Attributes (DA)
308	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1532	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1533	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310	Option'')	1534	Option'')
311		1535
312	=item B<< C<ESC [ Ps d> >>	1536	=item B<< C<ESC [ Ps d> >>
313		1537
314	Cursor to Line B<< C<Ps> >> (VPA)	1538	Cursor to Line B<< C<Ps> >> (VPA)
…		…
330	B<< C<Ps = 0> >> Clear Current Column (default)	1554	B<< C<Ps = 0> >> Clear Current Column (default)
331	B<< C<Ps = 3> >> Clear All (TBC)	1555	B<< C<Ps = 3> >> Clear All (TBC)
332		1556
333	=end table	1557	=end table
334		1558
		1559	=item B<< C<ESC [ Pm h> >>
		1560
		1561	Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
		1562
335	=item B<< C<ESC [ Ps i> >>	1563	=item B<< C<ESC [ Ps i> >>
336		1564
337	Printing	1565	Printing. See also the C<print-pipe> resource.
338		1566
339	=begin table	1567	=begin table
340		1568
		1569	B<< C<Ps = 0> >> print screen (MC0)
341	B<< C<Ps = 4> >> disable transparent print mode (MC4)	1570	B<< C<Ps = 4> >> disable transparent print mode (MC4)
342	B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented>	1571	B<< C<Ps = 5> >> enable transparent print mode (MC5)
343		1572
344	=end table	1573	=end table
345
346	=item B<< C<ESC [ Pm h> >>
347
348	Set Mode (SM). See next sequence for description of C<Pm>.
349		1574
350	=item B<< C<ESC [ Pm l> >>	1575	=item B<< C<ESC [ Pm l> >>
351		1576
352	Reset Mode (RM)	1577	Reset Mode (RM)
353		1578
…		…
360	B<< C<h> >> Insert Mode (SMIR)	1585	B<< C<h> >> Insert Mode (SMIR)
361	B<< C<l> >> Replace Mode (RMIR)	1586	B<< C<l> >> Replace Mode (RMIR)
362		1587
363	=end table	1588	=end table
364		1589
365	=item B<< C<Ps = 20> >> I<unimplemented>	1590	=item B<< C<Ps = 20> >> (partially implemented)
366		1591
367	=begin table	1592	=begin table
368		1593
369	B<< C<h> >> Automatic Newline (LNM)	1594	B<< C<h> >> Automatic Newline (LNM)
370	B<< C<h> >> Normal Linefeed (LNM)	1595	B<< C<l> >> Normal Linefeed (LNM)
371		1596
372	=end table	1597	=end table
373		1598
374	=back	1599	=back
375		1600
…		…
378	Character Attributes (SGR)	1603	Character Attributes (SGR)
379		1604
380	=begin table	1605	=begin table
381		1606
382	B<< C<Ps = 0> >> Normal (default)	1607	B<< C<Ps = 0> >> Normal (default)
383	B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg)	1608	B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
		1609	B<< C<Ps = 3 / 23> >> On / Off Italic
384	B<< C<Ps = 4 / 24> >> On / Off Underline	1610	B<< C<Ps = 4 / 24> >> On / Off Underline
385	B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg)	1611	B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
		1612	B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386	B<< C<Ps = 7 / 27> >> On / Off Inverse	1613	B<< C<Ps = 7 / 27> >> On / Off Inverse
		1614	B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387	B<< C<Ps = 30 / 40> >> fg/bg Black	1615	B<< C<Ps = 30 / 40> >> fg/bg Black
388	B<< C<Ps = 31 / 41> >> fg/bg Red	1616	B<< C<Ps = 31 / 41> >> fg/bg Red
389	B<< C<Ps = 32 / 42> >> fg/bg Green	1617	B<< C<Ps = 32 / 42> >> fg/bg Green
390	B<< C<Ps = 33 / 43> >> fg/bg Yellow	1618	B<< C<Ps = 33 / 43> >> fg/bg Yellow
391	B<< C<Ps = 34 / 44> >> fg/bg Blue	1619	B<< C<Ps = 34 / 44> >> fg/bg Blue
392	B<< C<Ps = 35 / 45> >> fg/bg Magenta	1620	B<< C<Ps = 35 / 45> >> fg/bg Magenta
393	B<< C<Ps = 36 / 46> >> fg/bg Cyan	1621	B<< C<Ps = 36 / 46> >> fg/bg Cyan
		1622	B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
394	B<< C<Ps = 37 / 47> >> fg/bg White	1623	B<< C<Ps = 37 / 47> >> fg/bg White
395	B<< C<Ps = 39 / 49> >> fg/bg Default	1624	B<< C<Ps = 39 / 49> >> fg/bg Default
		1625	B<< C<Ps = 90 / 100> >> fg/bg Bright Black
		1626	B<< C<Ps = 91 / 101> >> fg/bg Bright Red
		1627	B<< C<Ps = 92 / 102> >> fg/bg Bright Green
		1628	B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
		1629	B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
		1630	B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
		1631	B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
		1632	B<< C<Ps = 97 / 107> >> fg/bg Bright White
		1633	B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396		1634
397	=end table	1635	=end table
398		1636
399	=item B<< C<ESC [ Ps n> >>	1637	=item B<< C<ESC [ Ps n> >>
400		1638
…		…
416		1654
417	=item B<< C<ESC [ s> >>	1655	=item B<< C<ESC [ s> >>
418		1656
419	Save Cursor (SC)	1657	Save Cursor (SC)
420		1658
		1659	=item B<< C<ESC [ Ps;Pt t> >>
		1660
		1661	Window Operations
		1662
		1663	=begin table
		1664
		1665	B<< C<Ps = 1> >> Deiconify (map) window
		1666	B<< C<Ps = 2> >> Iconify window
		1667	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
		1668	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1669	B<< C<Ps = 5> >> Raise window
		1670	B<< C<Ps = 6> >> Lower window
		1671	B<< C<Ps = 7> >> Refresh screen once
		1672	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1673	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1674	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1675	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1676	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1677	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1678	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1679	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1680	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1681
		1682	=end table
		1683
		1684	=item B<< C<ESC [ u> >>
		1685
		1686	Restore Cursor
		1687
421	=item B<< C<ESC [ Ps x> >>	1688	=item B<< C<ESC [ Ps x> >>
422		1689
423	Request Terminal Parameters (DECREQTPARM)	1690	Request Terminal Parameters (DECREQTPARM)
424		1691
425	=item B<< C<ESC [ u> >>
426
427	Restore Cursor
428
429	=back	1692	=back
430		1693
431	X<PrivateModes>	1694	X<PrivateModes>
432		1695
433	=head1 DEC Private Modes	1696	=head2 DEC Private Modes
434		1697
435	=over 4	1698	=over 4
436		1699
437	=item B<< C<ESC [ ? Pm h> >>	1700	=item B<< C<ESC [ ? Pm h> >>
438		1701
…		…
454		1717
455	Toggle DEC Private Mode Values (rxvt extension). I<where>	1718	Toggle DEC Private Mode Values (rxvt extension). I<where>
456		1719
457	=over 4	1720	=over 4
458		1721
459	=item B<< C<Ps = 1> >> (DECCKM)	1722	=item B<< C<Pm = 1> >> (DECCKM)
460		1723
461	=begin table	1724	=begin table
462		1725
463	B<< C<h> >> Application Cursor Keys	1726	B<< C<h> >> Application Cursor Keys
464	B<< C<l> >> Normal Cursor Keys	1727	B<< C<l> >> Normal Cursor Keys
465		1728
466	=end table	1729	=end table
467		1730
468	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1731	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
469		1732
470	=begin table	1733	=begin table
471		1734
472	B<< C<h> >> Enter VT52 mode	1735	B<< C<h> >> Enter VT52 mode
473	B<< C<l> >> Enter VT52 mode	1736	B<< C<l> >> Enter VT52 mode
474		1737
475	=end table	1738	=end table
476		1739
477	=item B<< C<Ps = 3> >>	1740	=item B<< C<Pm = 3> >>
478		1741
479	=begin table	1742	=begin table
480		1743
481	B<< C<h> >> 132 Column Mode (DECCOLM)	1744	B<< C<h> >> 132 Column Mode (DECCOLM)
482	B<< C<l> >> 80 Column Mode (DECCOLM)	1745	B<< C<l> >> 80 Column Mode (DECCOLM)
483		1746
484	=end table	1747	=end table
485		1748
486	=item B<< C<Ps = 4> >>	1749	=item B<< C<Pm = 4> >>
487		1750
488	=begin table	1751	=begin table
489		1752
490	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1753	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
491	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1754	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
492		1755
493	=end table	1756	=end table
494		1757
495	=item B<< C<Ps = 5> >>	1758	=item B<< C<Pm = 5> >>
496		1759
497	=begin table	1760	=begin table
498		1761
499	B<< C<h> >> Reverse Video (DECSCNM)	1762	B<< C<h> >> Reverse Video (DECSCNM)
500	B<< C<l> >> Normal Video (DECSCNM)	1763	B<< C<l> >> Normal Video (DECSCNM)
501		1764
502	=end table	1765	=end table
503		1766
504	=item B<< C<Ps = 6> >>	1767	=item B<< C<Pm = 6> >>
505		1768
506	=begin table	1769	=begin table
507		1770
508	B<< C<h> >> Origin Mode (DECOM)	1771	B<< C<h> >> Origin Mode (DECOM)
509	B<< C<l> >> Normal Cursor Mode (DECOM)	1772	B<< C<l> >> Normal Cursor Mode (DECOM)
510		1773
511	=end table	1774	=end table
512		1775
513	=item B<< C<Ps = 7> >>	1776	=item B<< C<Pm = 7> >>
514		1777
515	=begin table	1778	=begin table
516		1779
517	B<< C<h> >> Wraparound Mode (DECAWM)	1780	B<< C<h> >> Wraparound Mode (DECAWM)
518	B<< C<l> >> No Wraparound Mode (DECAWM)	1781	B<< C<l> >> No Wraparound Mode (DECAWM)
519		1782
520	=end table	1783	=end table
521		1784
522	=item B<< C<Ps = 8> >> I<unimplemented>	1785	=item B<< C<Pm = 8> >> I<unimplemented>
523		1786
524	=begin table	1787	=begin table
525		1788
526	B<< C<h> >> Auto-repeat Keys (DECARM)	1789	B<< C<h> >> Auto-repeat Keys (DECARM)
527	B<< C<l> >> No Auto-repeat Keys (DECARM)	1790	B<< C<l> >> No Auto-repeat Keys (DECARM)
528		1791
529	=end table	1792	=end table
530		1793
531	=item B<< C<Ps = 9> >> X10 XTerm	1794	=item B<< C<Pm = 9> >> X10 XTerm
532		1795
533	=begin table	1796	=begin table
534		1797
535	B<< C<h> >> Send Mouse X & Y on button press.	1798	B<< C<h> >> Send Mouse X & Y on button press.
536	B<< C<l> >> No mouse reporting.	1799	B<< C<l> >> No mouse reporting.
537		1800
538	=end table	1801	=end table
539		1802
540	X<Priv10>
541
542	=item B<< C<Ps = 10> >> (B<rxvt>)
543
544	=begin table
545
546	B<< C<h> >> visible
547	B<< C<l> >> invisible
548
549	=end table
550
551	=item B<< C<Ps = 25> >>	1803	=item B<< C<Pm = 25> >>
552		1804
553	=begin table	1805	=begin table
554		1806
555	B<< C<h> >> Visible cursor {cnorm/cvvis}	1807	B<< C<h> >> Visible cursor {cnorm/cvvis}
556	B<< C<l> >> Invisible cursor {civis}	1808	B<< C<l> >> Invisible cursor {civis}
557		1809
558	=end table	1810	=end table
559		1811
560	=item B<< C<Ps = 30> >>	1812	=item B<< C<Pm = 30> >>
561		1813
562	=begin table	1814	=begin table
563		1815
564	B<< C<h> >> scrollBar visisble	1816	B<< C<h> >> scrollBar visisble
565	B<< C<l> >> scrollBar invisisble	1817	B<< C<l> >> scrollBar invisisble
566		1818
567	=end table	1819	=end table
568		1820
569	=item B<< C<Ps = 35> >> (B<rxvt>)	1821	=item B<< C<Pm = 35> >> (B<rxvt>)
570		1822
571	=begin table	1823	=begin table
572		1824
573	B<< C<h> >> Allow XTerm Shift+key sequences	1825	B<< C<h> >> Allow XTerm Shift+key sequences
574	B<< C<l> >> Disallow XTerm Shift+key sequences	1826	B<< C<l> >> Disallow XTerm Shift+key sequences
575		1827
576	=end table	1828	=end table
577		1829
578	=item B<< C<Ps = 38> >> I<unimplemented>	1830	=item B<< C<Pm = 38> >> I<unimplemented>
579		1831
580	Enter Tektronix Mode (DECTEK)	1832	Enter Tektronix Mode (DECTEK)
581		1833
582	=item B<< C<Ps = 40> >>	1834	=item B<< C<Pm = 40> >>
583		1835
584	=begin table	1836	=begin table
585		1837
586	B<< C<h> >> Allow 80/132 Mode	1838	B<< C<h> >> Allow 80/132 Mode
587	B<< C<l> >> Disallow 80/132 Mode	1839	B<< C<l> >> Disallow 80/132 Mode
588		1840
589	=end table	1841	=end table
590		1842
591	=item B<< C<Ps = 44> >> I<unimplemented>	1843	=item B<< C<Pm = 44> >> I<unimplemented>
592		1844
593	=begin table	1845	=begin table
594		1846
595	B<< C<h> >> Turn On Margin Bell	1847	B<< C<h> >> Turn On Margin Bell
596	B<< C<l> >> Turn Off Margin Bell	1848	B<< C<l> >> Turn Off Margin Bell
597		1849
598	=end table	1850	=end table
599		1851
600	=item B<< C<Ps = 45> >> I<unimplemented>	1852	=item B<< C<Pm = 45> >> I<unimplemented>
601		1853
602	=begin table	1854	=begin table
603		1855
604	B<< C<h> >> Reverse-wraparound Mode	1856	B<< C<h> >> Reverse-wraparound Mode
605	B<< C<l> >> No Reverse-wraparound Mode	1857	B<< C<l> >> No Reverse-wraparound Mode
606		1858
607	=end table	1859	=end table
608		1860
609	=item B<< C<Ps = 46> >> I<unimplemented>	1861	=item B<< C<Pm = 46> >> I<unimplemented>
610		1862
611	=item B<< C<Ps = 47> >>	1863	=item B<< C<Pm = 47> >>
612		1864
613	=begin table	1865	=begin table
614		1866
615	B<< C<h> >> Use Alternate Screen Buffer	1867	B<< C<h> >> Use Alternate Screen Buffer
616	B<< C<l> >> Use Normal Screen Buffer	1868	B<< C<l> >> Use Normal Screen Buffer
617		1869
618	=end table	1870	=end table
619		1871
620	X<Priv66>	1872	X<Priv66>
621		1873
622	=item B<< C<Ps = 66> >>	1874	=item B<< C<Pm = 66> >>
623		1875
624	=begin table	1876	=begin table
625		1877
626	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1878	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
627	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1879	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
628		1880
629	=end table	1881	=end table
630		1882
631	=item B<< C<Ps = 67> >>	1883	=item B<< C<Pm = 67> >>
632		1884
633	=begin table	1885	=begin table
634		1886
635	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1887	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
636	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1888	B<< C<l> >> Backspace key sends B<< C<DEL> >>
637		1889
638	=end table	1890	=end table
639		1891
640	=item B<< C<Ps = 1000> >> (X11 XTerm)	1892	=item B<< C<Pm = 1000> >> (X11 XTerm)
641		1893
642	=begin table	1894	=begin table
643		1895
644	B<< C<h> >> Send Mouse X & Y on button press and release.	1896	B<< C<h> >> Send Mouse X & Y on button press and release.
645	B<< C<l> >> No mouse reporting.	1897	B<< C<l> >> No mouse reporting.
646		1898
647	=end table	1899	=end table
648		1900
649	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1901	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
650		1902
651	=begin table	1903	=begin table
652		1904
653	B<< C<h> >> Use Hilite Mouse Tracking.	1905	B<< C<h> >> Use Hilite Mouse Tracking.
654	B<< C<l> >> No mouse reporting.	1906	B<< C<l> >> No mouse reporting.
655		1907
656	=end table	1908	=end table
657		1909
658	=item B<< C<Ps = 1010> >>	1910	=item B<< C<Pm = 1010> >> (B<rxvt>)
659		1911
660	=begin table	1912	=begin table
661		1913
662	B<< C<h> >> Don't scroll to bottom on TTY output	1914	B<< C<h> >> Don't scroll to bottom on TTY output
663	B<< C<l> >> Scroll to bottom on TTY output	1915	B<< C<l> >> Scroll to bottom on TTY output
664		1916
665	=end table	1917	=end table
666		1918
667	=item B<< C<Ps = 1011> >>	1919	=item B<< C<Pm = 1011> >> (B<rxvt>)
668		1920
669	=begin table	1921	=begin table
670		1922
671	B<< C<h> >> Scroll to bottom when a key is pressed	1923	B<< C<h> >> Scroll to bottom when a key is pressed
672	B<< C<l> >> Don't scroll to bottom when a key is pressed	1924	B<< C<l> >> Don't scroll to bottom when a key is pressed
673		1925
674	=end table	1926	=end table
675		1927
		1928	=item B<< C<Pm = 1021> >> (B<rxvt>)
		1929
		1930	=begin table
		1931
		1932	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1933	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1934
		1935	=end table
		1936
676	=item B<< C<Ps = 1047> >>	1937	=item B<< C<Pm = 1047> >>
677		1938
678	=begin table	1939	=begin table
679		1940
680	B<< C<h> >> Use Alternate Screen Buffer	1941	B<< C<h> >> Use Alternate Screen Buffer
681	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it	1942	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
682		1943
683	=end table	1944	=end table
684		1945
685	=item B<< C<Ps = 1048> >>	1946	=item B<< C<Pm = 1048> >>
686		1947
687	=begin table	1948	=begin table
688		1949
689	B<< C<h> >> Save cursor position	1950	B<< C<h> >> Save cursor position
690	B<< C<l> >> Restore cursor position	1951	B<< C<l> >> Restore cursor position
691		1952
692	=end table	1953	=end table
693		1954
		1955	=item B<< C<Pm = 1049> >>
		1956
		1957	=begin table
		1958
		1959	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
		1960	B<< C<l> >> Use Normal Screen Buffer
		1961
		1962	=end table
		1963
694	=back	1964	=back
695		1965
696	=back	1966	=back
697		1967
698	X<XTerm>	1968	X<XTerm>
699		1969
700	=head1 XTerm Operating System Commands	1970	=head2 XTerm Operating System Commands
701		1971
702	=over 4	1972	=over 4
703		1973
704	=item B<< C<ESC ] Ps;Pt ST> >>	1974	=item B<< C<ESC ] Ps;Pt ST> >>
705		1975
…		…
717	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1987	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
718	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1988	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
719	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1989	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
720	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1990	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
721	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1991	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
722	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1992	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
723	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1993	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		1994	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
724	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1995	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
725	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
726	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1996	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
727	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	1997	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
728	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>	1998	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
729	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1999	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
730	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)	2000	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
731	B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension)	2001	B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
732	B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension)	2002	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
		2003	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		2004	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		2005	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
		2006	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
		2007	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		2008	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		2009	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		2010	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2011	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2012	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
733		2013
734	=end table	2014	=end table
735		2015
736	=back	2016	=back
737
738	X<menuBar>
739
740	=head1 menuBar
741
742	B<< The exact syntax used is I<almost> solidified. >>
743	In the menus, B<DON'T> try to use menuBar commands that add or remove a
744	menuBar.
745
746	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
747	omitted: use B<./> to specify a menu relative to the current menu.
748
749	=head2 Overview of menuBar operation
750
751	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
752	of C<Pt> can be used for a variety of tasks:
753
754	At the top level is the current menuBar which is a member of a circular
755	linked-list of other such menuBars.
756
757	The menuBar acts as a parent for the various drop-down menus, which in
758	turn, may have labels, separator lines, menuItems and subMenus.
759
760	The menuItems are the useful bits: you can use them to mimic keyboard
761	input or even to send text or escape sequences back to rxvt.
762
763	The menuBar syntax is intended to provide a simple yet robust method of
764	constructing and manipulating menus and navigating through the
765	menuBars.
766
767	The first step is to use the tag B<< [menu:I<name>] >> which creates
768	the menuBar called I<name> and allows access. You may now or menus,
769	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
770	menuBar access as B<readonly> to prevent accidental corruption of the
771	menus. To re-access the current menuBar for alterations, use the tag
772	B<[menu]>, make the alterations and then use B<[done]>
773
774	X<menuBarCommands>
775
776	=head2 Commands
777
778	=over 4
779
780	=item B<< [menu:+I<name>] >>
781
782	access the named menuBar for creation or alteration. If a new menuBar
783	is created, it is called I<name> (max of 15 chars) and the current
784	menuBar is pushed onto the stack
785
786	=item B<[menu]>
787
788	access the current menuBar for alteration
789
790	=item B<< [title:+I<string>] >>
791
792	set the current menuBar's title to I<string>, which may contain the
793	following format specifiers:
794	B<%%> : literal B<%> character
795	B<%n> : rxvt name (as per the B<-name> command-line option)
796	B<%v> : rxvt version
797
798	=item B<[done]>
799
800	set menuBar access as B<readonly>.
801	End-of-file tag for B<< [read:+I<file>] >> operations.
802
803	=item B<< [read:+I<file>] >>
804
805	read menu commands directly from I<file> (extension ".menu" will be
806	appended if required.) Start reading at a line with B<[menu]> or B<<
807	[menu:+I<name> >> and continuing until B<[done]> is encountered.
808
809	Blank and comment lines (starting with B<#>) are ignored. Actually,
810	since any invalid menu commands are also ignored, almost anything could
811	be construed as a comment line, but this may be tightened up in the
812	future ... so don't count on it!.
813
814	=item B<< [read:+I<file>;+I<name>] >>
815
816	The same as B<< [read:+I<file>] >>, but start reading at a line with
817	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
818	B<[done]> is encountered.
819
820	=item B<[dump]>
821
822	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
823	later rereading.
824
825	=item B<[rm:name]>
826
827	remove the named menuBar
828
829	=item B<[rm] [rm:]>
830
831	remove the current menuBar
832
833	=item B<[rm*] [rm:*]>
834
835	remove all menuBars
836
837	=item B<[swap]>
838
839	swap the top two menuBars
840
841	=item B<[prev]>
842
843	access the previous menuBar
844
845	=item B<[next]>
846
847	access the next menuBar
848
849	=item B<[show]>
850
851	Enable display of the menuBar
852
853	=item B<[hide]>
854
855	Disable display of the menuBar
856
857	=item B<< [pixmap:+I<name>] >>
858
859	=item B<< [pixmap:+I<name>;I<scaling>] >>
860
861	(set the background pixmap globally
862
863	B<< A Future implementation I<may> make this local to the menubar >>)
864
865	=item B<< [:+I<command>:] >>
866
867	ignore the menu readonly status and issue a I<command> to or a menu or
868	menuitem or change the ; a useful shortcut for setting the quick arrows
869	from a menuBar.
870
871	=back
872
873	X<menuBarAdd>
874
875	=head2 Adding and accessing menus
876
877	The following commands may also be B<+> prefixed.
878
879	=over 4
880
881	=item B</+>
882
883	access menuBar top level
884
885	=item B<./+>
886
887	access current menu level
888
889	=item B<../+>
890
891	access parent menu (1 level up)
892
893	=item B<../../>
894
895	access parent menu (multiple levels up)
896
897	=item B<< I</path/>menu >>
898
899	add/access menu
900
901	=item B<< I</path/>menu/* >>
902
903	add/access menu and clear it if it exists
904
905	=item B<< I</path/>{-} >>
906
907	add separator
908
909	=item B<< I</path/>{item} >>
910
911	add B<item> as a label
912
913	=item B<< I</path/>{item} action >>
914
915	add/alter I<menuitem> with an associated I<action>
916
917	=item B<< I</path/>{item}{right-text} >>
918
919	add/alter I<menuitem> with B<right-text> as the right-justified text
920	and as the associated I<action>
921
922	=item B<< I</path/>{item}{rtext} action >>
923
924	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
925	the right-justified text.
926
927	=back
928
929	=over 4
930
931	=item Special characters in I<action> must be backslash-escaped:
932
933	B<\a \b \E \e \n \r \t \octal>
934
935	=item or in control-character notation:
936
937	B<^@, ^A .. ^Z .. ^_, ^?>
938
939	=back
940
941	To send a string starting with a B<NUL> (B<^@>) character to the
942	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
943	the first of which will be stripped off and the balance directed to the
944	program. Otherwise if I<action> begins with B<NUL> followed by
945	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
946	balance is sent back to rxvt.
947
948	As a convenience for the many Emacs-type editors, I<action> may start
949	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
950	appended if missed from B<M-x> commands.
951
952	As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
953	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
954
955	=over 4
956
957	=item For example,
958
959	B<M-xapropos> is equivalent to B<\Exapropos\r>
960
961	=item and
962
963	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
964
965	=back
966
967	The option B<< {I<right-rtext>} >> will be right-justified. In the
968	absence of a specified action, this text will be used as the I<action>
969	as well.
970
971	=over 4
972
973	=item For example,
974
975	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
976
977	=back
978
979	The left label I<is> necessary, since it's used for matching, but
980	implicitly hiding the left label (by using same name for both left and
981	right labels), or explicitly hiding the left label (by preceeding it
982	with a dot), makes it possible to have right-justified text only.
983
984	=over 4
985
986	=item For example,
987
988	B</File/{Open}{Open} Open-File-Action>
989
990	=item or hiding it
991
992	B</File/{.anylabel}{Open} Open-File-Action>
993
994	=back
995
996	X<menuBarRemove>
997
998	=head2 Removing menus
999
1000	=over 4
1001
1002	=item B<< -/*+ >>
1003
1004	remove all menus from the menuBar, the same as B<[clear]>
1005
1006	=item B<< -+I</path>menu+ >>
1007
1008	remove menu
1009
1010	=item B<< -+I</path>{item}+ >>
1011
1012	remove item
1013
1014	=item B<< -+I</path>{-} >>
1015
1016	remove separator)
1017
1018	=item B<-/path/menu/*>
1019
1020	remove all items, separators and submenus from menu
1021
1022	=back
1023
1024	X<menuBarArrows>
1025
1026	=head2 Quick Arrows
1027
1028	The menus also provide a hook for I<quick arrows> to provide easier
1029	user access. If nothing has been explicitly set, the default is to
1030	emulate the curror keys. The syntax permits each arrow to be altered
1031	individually or all four at once without re-entering their common
1032	beginning/end text. For example, to explicitly associate cursor actions
1033	with the arrows, any of the following forms could be used:
1034
1035	=over 4
1036
1037	=item B<< <r>+I<Right> >>
1038
1039	=item B<< <l>+I<Left> >>
1040
1041	=item B<< <u>+I<Up> >>
1042
1043	=item B<< <d>+I<Down> >>
1044
1045	Define actions for the respective arrow buttons
1046
1047	=item B<< <b>+I<Begin> >>
1048
1049	=item B<< <e>+I<End> >>
1050
1051	Define common beginning/end parts for I<quick arrows> which used in
1052	conjunction with the above <r> <l> <u> <d> constructs
1053
1054	=back
1055
1056	=over 4
1057
1058	=item For example, define arrows individually,
1059
1060	<u>\E[A
1061
1062	<d>\E[B
1063
1064	<r>\E[C
1065
1066	<l>\E[D
1067
1068	=item or all at once
1069
1070	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1071
1072	=item or more compactly (factoring out common parts)
1073
1074	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1075
1076	=back
1077
1078	X<menuBarSummary>
1079
1080	=head2 Command Summary
1081
1082	A short summary of the most I<common> commands:
1083
1084	=over 4
1085
1086	=item [menu:name]
1087
1088	use an existing named menuBar or start a new one
1089
1090	=item [menu]
1091
1092	use the current menuBar
1093
1094	=item [title:string]
1095
1096	set menuBar title
1097
1098	=item [done]
1099
1100	set menu access to readonly and, if reading from a file, signal EOF
1101
1102	=item [done:name]
1103
1104	if reading from a file using [read:file;name] signal EOF
1105
1106	=item [rm:name]
1107
1108	remove named menuBar(s)
1109
1110	=item [rm] [rm:]
1111
1112	remove current menuBar
1113
1114	=item [rm*] [rm:*]
1115
1116	remove all menuBar(s)
1117
1118	=item [swap]
1119
1120	swap top two menuBars
1121
1122	=item [prev]
1123
1124	access the previous menuBar
1125
1126	=item [next]
1127
1128	access the next menuBar
1129
1130	=item [show]
1131
1132	map menuBar
1133
1134	=item [hide]
1135
1136	unmap menuBar
1137
1138	=item [pixmap;file]
1139
1140	=item [pixmap;file;scaling]
1141
1142	set a background pixmap
1143
1144	=item [read:file]
1145
1146	=item [read:file;name]
1147
1148	read in a menu from a file
1149
1150	=item [dump]
1151
1152	dump out all menuBars to /tmp/rxvt-PID
1153
1154	=item /
1155
1156	access menuBar top level
1157
1158	=item ./
1159
1160	=item ../
1161
1162	=item ../../
1163
1164	access current or parent menu level
1165
1166	=item /path/menu
1167
1168	add/access menu
1169
1170	=item /path/{-}
1171
1172	add separator
1173
1174	=item /path/{item}{rtext} action
1175
1176	add/alter menu item
1177
1178	=item -/*
1179
1180	remove all menus from the menuBar
1181
1182	=item -/path/menu
1183
1184	remove menu items, separators and submenus from menu
1185
1186	=item -/path/menu
1187
1188	remove menu
1189
1190	=item -/path/{item}
1191
1192	remove item
1193
1194	=item -/path/{-}
1195
1196	remove separator
1197
1198	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1199
1200	menu quick arrows
1201
1202	=back
1203	X<XPM>
1204		2017
1205	=head1 XPM	2018	=head1 XPM
1206		2019
1207	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	2020	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1208	of B<< C<Pt> >> can be the name of the background pixmap followed by a	2021	of B<< C<Pt> >> can be the name of the background pixmap followed by a
…		…
1306	=begin table	2119	=begin table
1307		2120
1308	4 Shift	2121	4 Shift
1309	8 Meta	2122	8 Meta
1310	16 Control	2123	16 Control
1311	32 Double Click I<(Rxvt extension)>	2124	32 Double Click I<(rxvt extension)>
1312		2125
1313	=end table	2126	=end table
1314		2127
1315	Col = B<< C<< <x> - SPACE >> >>	2128	Col = B<< C<< <x> - SPACE >> >>
1316		2129
…		…
1390	XK_KP_8 8 ESC O x	2203	XK_KP_8 8 ESC O x
1391	XK_KP_9 9 ESC O y	2204	XK_KP_9 9 ESC O y
1392		2205
1393	=end table	2206	=end table
1394		2207
		2208	=head1 CONFIGURE OPTIONS
		2209
		2210	General hint: if you get compile errors, then likely your configuration
		2211	hasn't been tested well. Either try with C<--enable-everything> or use
		2212	the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of
		2213	course, you should always report when a combination doesn't work, so it
		2214	can be fixed. Marc Lehmann <rxvt@schmorp.de>.
		2215
		2216	All
		2217
		2218	=over 4
		2219
		2220	=item --enable-everything
		2221
		2222	Add (or remove) support for all non-multichoice options listed in "./configure
		2223	--help".
		2224
		2225	You can specify this and then disable options you do not like by
		2226	I<following> this with the appropriate C<--disable-...> arguments,
		2227	or you can start with a minimal configuration by specifying
		2228	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2229	you want.
		2230
		2231	=item --enable-xft (default: enabled)
		2232
		2233	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
		2234	slower and require lots of memory, but as long as you don't use them, you
		2235	don't pay for them.
		2236
		2237	=item --enable-font-styles (default: on)
		2238
		2239	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
		2240	styles. The fonts can be set manually or automatically.
		2241
		2242	=item --with-codesets=NAME,... (default: all)
		2243
		2244	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
		2245	are always compiled in, which includes most 8-bit character sets). These
		2246	codeset tables are used for driving X11 core fonts, they are not required
		2247	for Xft fonts, although having them compiled in lets rxvt-unicode choose
		2248	replacement fonts more intelligently. Compiling them in will make your
		2249	binary bigger (all of together cost about 700kB), but it doesn't increase
		2250	memory usage unless you use a font requiring one of these encodings.
		2251
		2252	=begin table
		2253
		2254	all all available codeset groups
		2255	zh common chinese encodings
		2256	zh_ext rarely used but very big chinese encodings
		2257	jp common japanese encodings
		2258	jp_ext rarely used but big japanese encodings
		2259	kr korean encodings
		2260
		2261	=end table
		2262
		2263	=item --enable-xim (default: on)
		2264
		2265	Add support for XIM (X Input Method) protocol. This allows using
		2266	alternative input methods (e.g. kinput2) and will also correctly
		2267	set up the input for people using dead keys or compose keys.
		2268
		2269	=item --enable-unicode3 (default: off)
		2270
		2271	Recommended to stay off unless you really need non-BMP characters.
		2272
		2273	Enable direct support for displaying unicode codepoints above
		2274	65535 (the basic multilingual page). This increases storage
		2275	requirements per character from 2 to 4 bytes. X11 fonts do not yet
		2276	support these extra characters, but Xft does.
		2277
		2278	Please note that rxvt-unicode can store unicode code points >65535
		2279	even without this flag, but the number of such characters is
		2280	limited to a few thousand (shared with combining characters,
		2281	see next switch), and right now rxvt-unicode cannot display them
		2282	(input/output and cut&paste still work, though).
		2283
		2284	=item --enable-combining (default: on)
		2285
		2286	Enable automatic composition of combining characters into
		2287	composite characters. This is required for proper viewing of text
		2288	where accents are encoded as seperate unicode characters. This is
		2289	done by using precomposited characters when available or creating
		2290	new pseudo-characters when no precomposed form exists.
		2291
		2292	Without --enable-unicode3, the number of additional precomposed
		2293	characters is somewhat limited (the 6400 private use characters will be
		2294	(ab-)used). With --enable-unicode3, no practical limit exists.
		2295
		2296	This option will also enable storage (but not display) of characters
		2297	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
		2298
		2299	The combining table also contains entries for arabic presentation forms,
		2300	but these are not currently used. Bug me if you want these to be used (and
		2301	tell me how these are to be used...).
		2302
		2303	=item --enable-fallback(=CLASS) (default: Rxvt)
		2304
		2305	When reading resource settings, also read settings for class CLASS. To
		2306	disable resource fallback use --disable-fallback.
		2307
		2308	=item --with-res-name=NAME (default: urxvt)
		2309
		2310	Use the given name as default application name when
		2311	reading resources. Specify --with-res-name=rxvt to replace rxvt.
		2312
		2313	=item --with-res-class=CLASS /default: URxvt)
		2314
		2315	Use the given class as default application class
		2316	when reading resources. Specify --with-res-class=Rxvt to replace
		2317	rxvt.
		2318
		2319	=item --enable-utmp (default: on)
		2320
		2321	Write user and tty to utmp file (used by programs like F<w>) at
		2322	start of rxvt execution and delete information when rxvt exits.
		2323
		2324	=item --enable-wtmp (default: on)
		2325
		2326	Write user and tty to wtmp file (used by programs like F<last>) at
		2327	start of rxvt execution and write logout when rxvt exits. This
		2328	option requires --enable-utmp to also be specified.
		2329
		2330	=item --enable-lastlog (default: on)
		2331
		2332	Write user and tty to lastlog file (used by programs like
		2333	F<lastlogin>) at start of rxvt execution. This option requires
		2334	--enable-utmp to also be specified.
		2335
		2336	=item --enable-afterimage (default: on)
		2337
		2338	Add support for libAfterImage to be used for transparency and background
		2339	images. It adds support for many file formats including JPG, PNG,
		2340	SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
		2341	(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
		2342
		2343	This option also adds such eye candy as blending an image over the root
		2344	background, as well as dynamic scaling and bluring of background images.
		2345
		2346	Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
		2347	increase by a few megabytes even if no extra features are used (mostly due
		2348	to third-party libraries used by libAI). Memory footprint may somewhat be
		2349	lowered if libAfterImage is configured without support for SVG.
		2350
		2351	=item --enable-transparency (default: on)
		2352
		2353	Add support for inheriting parent backgrounds thus giving a fake
		2354	transparency to the term.
		2355
		2356	=item --enable-fading (default: on)
		2357
		2358	Add support for fading the text when focus is lost.
		2359
		2360	=item --enable-rxvt-scroll (default: on)
		2361
		2362	Add support for the original rxvt scrollbar.
		2363
		2364	=item --enable-next-scroll (default: on)
		2365
		2366	Add support for a NeXT-like scrollbar.
		2367
		2368	=item --enable-xterm-scroll (default: on)
		2369
		2370	Add support for an Xterm-like scrollbar.
		2371
		2372	=item --enable-plain-scroll (default: on)
		2373
		2374	Add support for a very unobtrusive, plain-looking scrollbar that
		2375	is the favourite of the rxvt-unicode author, having used it for
		2376	many years.
		2377
		2378	=item --enable-ttygid (default: off)
		2379
		2380	Change tty device setting to group "tty" - only use this if
		2381	your system uses this type of security.
		2382
		2383	=item --disable-backspace-key
		2384
		2385	Removes any handling of the backspace key by us - let the X server do it.
		2386
		2387	=item --disable-delete-key
		2388
		2389	Removes any handling of the delete key by us - let the X server
		2390	do it.
		2391
		2392	=item --disable-resources
		2393
		2394	Removes any support for resource checking.
		2395
		2396	=item --disable-swapscreen
		2397
		2398	Remove support for secondary/swap screen.
		2399
		2400	=item --enable-frills (default: on)
		2401
		2402	Add support for many small features that are not essential but nice to
		2403	have. Normally you want this, but for very small binaries you may want to
		2404	disable this.
		2405
		2406	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
		2407	in combination with other switches) is:
		2408
		2409	MWM-hints
		2410	EWMH-hints (pid, utf8 names) and protocols (ping)
		2411	urgency hint
		2412	seperate underline colour (-underlineColor)
		2413	settable border widths and borderless switch (-w, -b, -bl)
		2414	visual depth selection (-depth)
		2415	settable extra linespacing /-lsp)
		2416	iso-14755 5.1 (basic) support
		2417	tripleclickwords (-tcw)
		2418	settable insecure mode (-insecure)
		2419	keysym remapping support
		2420	cursor blinking and underline cursor (-cb, -uc)
		2421	XEmbed support (-embed)
		2422	user-pty (-pty-fd)
		2423	hold on exit (-hold)
		2424	skip builtin block graphics (-sbg)
		2425	separate highlightcolor support (-hc)
		2426
		2427	It also enables some non-essential features otherwise disabled, such as:
		2428
		2429	some round-trip time optimisations
		2430	nearest color allocation on pseudocolor screens
		2431	UTF8_STRING support for selection
		2432	sgr modes 90..97 and 100..107
		2433	backindex and forwardindex escape sequences
		2434	view change/zero scrollback escape sequences
		2435	locale switching escape sequence
		2436	window op and some xterm/OSC escape sequences
		2437	rectangular selections
		2438	trailing space removal for selections
		2439	verbose X error handling
		2440
		2441	=item --enable-iso14755 (default: on)
		2442
		2443	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
		2444	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
		2445	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
		2446	this switch.
		2447
		2448	=item --enable-keepscrolling (default: on)
		2449
		2450	Add support for continual scrolling of the display when you hold
		2451	the mouse button down on a scrollbar arrow.
		2452
		2453	=item --enable-selectionscrolling (default: on)
		2454
		2455	Add support for scrolling when the selection moves to the top or
		2456	bottom of the screen.
		2457
		2458	=item --enable-mousewheel (default: on)
		2459
		2460	Add support for scrolling via mouse wheel or buttons 4 & 5.
		2461
		2462	=item --enable-slipwheeling (default: on)
		2463
		2464	Add support for continual scrolling (using the mouse wheel as an
		2465	accelerator) while the control key is held down. This option
		2466	requires --enable-mousewheel to also be specified.
		2467
		2468	=item --enable-smart-resize (default: off)
		2469
		2470	Add smart growth/shrink behaviour when resizing.
		2471	This should keep the window corner which is closest to a corner of
		2472	the screen in a fixed position.
		2473
		2474	=item --enable-pointer-blank (default: on)
		2475
		2476	Add support to have the pointer disappear when typing or inactive.
		2477
		2478	=item --enable-perl (default: on)
		2479
		2480	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2481	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
		2482	files in F<src/perl-ext/> for the extensions that are installed by
		2483	default. The perl interpreter that is used can be specified via the
		2484	C<PERL> environment variable when running configure. Even when compiled
		2485	in, perl will I<not> be initialised when all extensions have been disabled
		2486	C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
		2487	resource standpoint.
		2488
		2489	=item --with-afterimage-config=DIR
		2490
		2491	Look for the libAfterImage config script in DIR.
		2492
		2493	=item --with-name=NAME (default: urxvt)
		2494
		2495	Set the basename for the installed binaries, resulting
		2496	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
		2497	C<rxvt>.
		2498
		2499	=item --with-term=NAME (default: rxvt-unicode)
		2500
		2501	Change the environmental variable for the terminal to NAME.
		2502
		2503	=item --with-terminfo=PATH
		2504
		2505	Change the environmental variable for the path to the terminfo tree to
		2506	PATH.
		2507
		2508	=item --with-x
		2509
		2510	Use the X Window System (pretty much default, eh?).
		2511
		2512	=back
		2513
1395	=head1 AUTHORS	2514	=head1 AUTHORS
1396		2515
1397	Marc Lehmann <rxvt@schmorp.de> converted this document to pod and	2516	Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398	reworked it from the original Rxvt documentation, which was done by Geoff	2517	reworked it from the original Rxvt documentation, which was done by Geoff
1399	Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other	2518	Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

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