ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.147 by sasha, Thu Sep 20 15:56:41 2007 UTC

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

Diff Legend

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