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.107 by root, Tue Jan 31 21:04:14 2006 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	4
5	the XTerm documentation and other sources.	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/*checkout*/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 do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
		79
		80	The original rxvt and rxvt-unicode always export the variable "COLORTERM",
		81	so you can check and see if that is set. Note that several programs, JED,
		82	slrn, Midnight Commander automatically check this variable to decide
		83	whether or not to use color.
		84
		85	=head3 How do I set the correct, full IP address for the DISPLAY variable?
		86
		87	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
		88	insecure mode then it is possible to use the following shell script
		89	snippets to correctly set the display. If your version of rxvt-unicode
		90	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
		91	the COLORTERM variable can be used to distinguish rxvt-unicode from a
		92	regular xterm.
		93
		94	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
		95	snippets:
		96
		97	# Bourne/Korn/POSIX family of shells:
		98	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
		99	if [ ${TERM:-foo} = xterm ]; then
		100	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
		101	echo -n '^[Z'
		102	read term_id
		103	stty icanon echo
		104	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
		105	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
		106	read DISPLAY # set it in our local shell
		107	fi
		108	fi
		109
		110	=head3 How do I compile the manual pages on my own?
		111
		112	You need to have a recent version of perl installed as F</usr/bin/perl>,
		113	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
		114	the doc subdirectory and enter C<make alldoc>.
		115
		116	=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
		117
		118	I often get asked about this, and I think, no, they didn't cause extra
		119	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		120	that the urxvt binary is larger (due to some encoding tables always being
		121	compiled in), but it actually uses less memory (RSS) after startup. Even
		122	with C<--disable-everything>, this comparison is a bit unfair, as many
		123	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		124	already in use in this mode.
		125
		126	text data bss drs rss filename
		127	98398 1664 24 15695 1824 rxvt --disable-everything
		128	188985 9048 66616 18222 1788 urxvt --disable-everything
		129
		130	When you C<--enable-everything> (which I<is> unfair, as this involves xft
		131	and full locale/XIM support which are quite bloaty inside libX11 and my
		132	libc), the two diverge, but not unreasnobaly so.
		133
		134	text data bss drs rss filename
		135	163431 2152 24 20123 2060 rxvt --enable-everything
		136	1035683 49680 66648 29096 3680 urxvt --enable-everything
		137
		138	The very large size of the text section is explained by the east-asian
		139	encoding tables, which, if unused, take up disk space but nothing else
		140	and can be compiled out unless you rely on X11 core fonts that use those
		141	encodings. The BSS size comes from the 64k emergency buffer that my c++
		142	compiler allocates (but of course doesn't use unless you are out of
		143	memory). Also, using an xft font instead of a core font immediately adds a
		144	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		145	not used.
		146
		147	Of course, due to every character using two or four bytes instead of one,
		148	a large scrollback buffer will ultimately make rxvt-unicode use more
		149	memory.
		150
		151	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		152	still fares rather well. And compared to some monsters like gnome-terminal
		153	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		154	43180k in daemons that stay around after exit, plus half a minute of
		155	startup time, including the hundreds of warnings it spits out), it fares
		156	extremely well *g*.
		157
		158	=head3 Why C++, isn't that unportable/bloated/uncool?
		159
		160	Is this a question? :) It comes up very often. The simple answer is: I had
		161	to write it, and C++ allowed me to write and maintain it in a fraction
		162	of the time and effort (which is a scarce resource for me). Put even
		163	shorter: It simply wouldn't exist without C++.
		164
		165	My personal stance on this is that C++ is less portable than C, but in
		166	the case of rxvt-unicode this hardly matters, as its portability limits
		167	are defined by things like X11, pseudo terminals, locale support and unix
		168	domain sockets, which are all less portable than C++ itself.
		169
		170	Regarding the bloat, see the above question: It's easy to write programs
		171	in C that use gobs of memory, an certainly possible to write programs in
		172	C++ that don't. C++ also often comes with large libraries, but this is
		173	not necessarily the case with GCC. Here is what rxvt links against on my
		174	system with a minimal config:
		175
		176	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		177	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		178	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		179	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		180
		181	And here is rxvt-unicode:
		182
		183	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		184	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		185	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		186	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		187	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		188
		189	No large bloated libraries (of course, none were linked in statically),
		190	except maybe libX11 :)
		191
		192
		193	=head2 Rendering, Font & Look and Feel Issues
		194
		195	=head3 I can't get transparency working, what am I doing wrong?
		196
		197	First of all, transparency isn't officially supported in rxvt-unicode, so
		198	you are mostly on your own. Do not bug the author about it (but you may
		199	bug everybody else). Also, if you can't get it working consider it a rite
		200	of passage: ... and you failed.
		201
		202	Here are four ways to get transparency. B<Do> read the manpage and option
		203	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		204
		205	1. Use inheritPixmap:
		206
		207	Esetroot wallpaper.jpg
		208	@@URXVT_NAME@@ -ip -tint red -sh 40
		209
		210	That works. If you think it doesn't, you lack transparency and tinting
		211	support, or you are unable to read.
		212
		213	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		214	to use effects other than tinting and shading: Just shade/tint/whatever
		215	your picture with gimp or any other tool:
		216
		217	convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
		218	@@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
		219
		220	That works. If you think it doesn't, you lack XPM and Perl support, or you
		221	are unable to read.
		222
		223	3. Use an ARGB visual:
		224
		225	@@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		226
		227	This requires XFT support, and the support of your X-server. If that
		228	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		229	there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
		230	bugfixes and workarounds for Xft and Xlib to make it work, but that
		231	doesn't mean that your WM has the required kludges in place.
		232
		233	4. Use xcompmgr and let it do the job:
		234
		235	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		236	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		237
		238	Then click on a window you want to make transparent. Replace C<0xc0000000>
		239	by other values to change the degree of opacity. If it doesn't work and
		240	your server crashes, you got to keep the pieces.
		241
		242	=head3 Why do some chinese characters look so different than others?
		243
		244	This is because there is a difference between script and language --
		245	rxvt-unicode does not know which language the text that is output is,
		246	as it only knows the unicode character codes. If rxvt-unicode first
		247	sees a japanese/chinese character, it might choose a japanese font for
		248	display. Subsequent japanese characters will use that font. Now, many
		249	chinese characters aren't represented in japanese fonts, so when the first
		250	non-japanese character comes up, rxvt-unicode will look for a chinese font
		251	-- unfortunately at this point, it will still use the japanese font for
		252	chinese characters that are also in the japanese font.
		253
		254	The workaround is easy: just tag a chinese font at the end of your font
		255	list (see the previous question). The key is to view the font list as
		256	a preference list: If you expect more japanese, list a japanese font
		257	first. If you expect more chinese, put a chinese font first.
		258
		259	In the future it might be possible to switch language preferences at
		260	runtime (the internal data structure has no problem with using different
		261	fonts for the same character at the same time, but no interface for this
		262	has been designed yet).
		263
		264	Until then, you might get away with switching fonts at runtime (see L<Can
		265	I switch the fonts at runtime?> later in this document).
		266
		267	=head3 Why does rxvt-unicode sometimes leave pixel droppings?
		268
		269	Most fonts were not designed for terminal use, which means that character
		270	size varies a lot. A font that is otherwise fine for terminal use might
		271	contain some characters that are simply too wide. Rxvt-unicode will avoid
		272	these characters. For characters that are just "a bit" too wide a special
		273	"careful" rendering mode is used that redraws adjacent characters.
		274
		275	All of this requires that fonts do not lie about character sizes,
		276	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		277	box, and rxvt-unicode has no way of detecting this (the correct way is to
		278	ask for the character bounding box, which unfortunately is wrong in these
		279	cases).
		280
		281	It's not clear (to me at least), wether this is a bug in Xft, freetype,
		282	or the respective font. If you encounter this problem you might try using
		283	the C<-lsp> option to give the font more height. If that doesn't work, you
		284	might be forced to use a different font.
		285
		286	All of this is not a problem when using X11 core fonts, as their bounding
		287	box data is correct.
		288
		289	=head3 How can I keep rxvt-unicode from using reverse video so much?
		290
		291	First of all, make sure you are running with the right terminal settings
		292	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		293	make sure you have specified colours for italic and bold, as otherwise
		294	rxvt-unicode might use reverse video to simulate the effect:
		295
		296	URxvt.colorBD: white
		297	URxvt.colorIT: green
		298
		299	=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
		300
		301	For some unexplainable reason, some rare programs assume a very weird
		302	colour palette when confronted with a terminal with more than the standard
		303	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		304	these programs not to assume non-ISO colours without very good reasons.
		305
		306	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		307	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		308	fix colours but keep you from using other rxvt-unicode features.
		309
		310	=head3 Can I switch the fonts at runtime?
		311
		312	Yes, using an escape sequence. Try something like this, which has the same
		313	effect as using the C<-fn> switch, and takes effect immediately:
		314
		315	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
		316
		317	This is useful if you e.g. work primarily with japanese (and prefer a
		318	japanese font), but you have to switch to chinese temporarily, where
		319	japanese fonts would only be in your way.
		320
		321	You can think of this as a kind of manual ISO-2022 switching.
		322
		323	=head3 Why do italic characters look as if clipped?
		324
		325	Many fonts have difficulties with italic characters and hinting. For
		326	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		327	Mono> completely fails in it's italic face. A workaround might be to
		328	enable freetype autohinting, i.e. like this:
		329
		330	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		331	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		332
		333	=head3 Can I speed up Xft rendering somehow?
		334
		335	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
		336	it is simply slow. If you still want Xft fonts you might try to disable
		337	antialiasing (by appending C<:antialias=false>), which saves lots of
		338	memory and also speeds up rendering considerably.
		339
		340	=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
		341
		342	Rxvt-unicode will use whatever you specify as a font. If it needs to
		343	fall back to it's default font search list it will prefer X11 core
		344	fonts, because they are small and fast, and then use Xft fonts. It has
		345	antialiasing disabled for most of them, because the author thinks they
		346	look best that way.
		347
		348	If you want antialiasing, you have to specify the fonts manually.
		349
		350	=head3 What's with this bold/blink stuff?
		351
		352	If no bold colour is set via C<colorBD:>, bold will invert text using the
		353	standard foreground colour.
		354
		355	For the standard background colour, blinking will actually make the
		356	text blink when compiled with C<--enable-blinking>. with standard
		357	colours. Without C<--enable-blinking>, the blink attribute will be
		358	ignored.
		359
		360	On ANSI colours, bold/blink attributes are used to set high-intensity
		361	foreground/background colors.
		362
		363	color0-7 are the low-intensity colors.
		364
		365	color8-15 are the corresponding high-intensity colors.
		366
		367	=head3 I don't like the screen colors. How do I change them?
		368
		369	You can change the screen colors at run-time using F<~/.Xdefaults>
		370	resources (or as long-options).
		371
		372	Here are values that are supposed to resemble a VGA screen,
		373	including the murky brown that passes for low-intensity yellow:
		374
		375	URxvt.color0: #000000
		376	URxvt.color1: #A80000
		377	URxvt.color2: #00A800
		378	URxvt.color3: #A8A800
		379	URxvt.color4: #0000A8
		380	URxvt.color5: #A800A8
		381	URxvt.color6: #00A8A8
		382	URxvt.color7: #A8A8A8
		383
		384	URxvt.color8: #000054
		385	URxvt.color9: #FF0054
		386	URxvt.color10: #00FF54
		387	URxvt.color11: #FFFF54
		388	URxvt.color12: #0000FF
		389	URxvt.color13: #FF00FF
		390	URxvt.color14: #00FFFF
		391	URxvt.color15: #FFFFFF
		392
		393	And here is a more complete set of non-standard colors.
		394
		395	URxvt.cursorColor: #dc74d1
		396	URxvt.pointerColor: #dc74d1
		397	URxvt.background: #0e0e0e
		398	URxvt.foreground: #4ad5e1
		399	URxvt.color0: #000000
		400	URxvt.color8: #8b8f93
		401	URxvt.color1: #dc74d1
		402	URxvt.color9: #dc74d1
		403	URxvt.color2: #0eb8c7
		404	URxvt.color10: #0eb8c7
		405	URxvt.color3: #dfe37e
		406	URxvt.color11: #dfe37e
		407	URxvt.color5: #9e88f0
		408	URxvt.color13: #9e88f0
		409	URxvt.color6: #73f7ff
		410	URxvt.color14: #73f7ff
		411	URxvt.color7: #e1dddd
		412	URxvt.color15: #e1dddd
		413
		414	(They were described (not by me) as "pretty girly").
		415
		416	=head3 Why do some characters look so much different than others?
		417
		418	See next entry.
		419
		420	=head3 How does rxvt-unicode choose fonts?
		421
		422	Most fonts do not contain the full range of Unicode, which is
		423	fine. Chances are that the font you (or the admin/package maintainer of
		424	your system/os) have specified does not cover all the characters you want
		425	to display.
		426
		427	B<rxvt-unicode> makes a best-effort try at finding a replacement
		428	font. Often the result is fine, but sometimes the chosen font looks
		429	bad/ugly/wrong. Some fonts have totally strange characters that don't
		430	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		431	intelligence to detect that a specific glyph is wrong: it has to believe
		432	the font that the characters it claims to contain indeed look correct.
		433
		434	In that case, select a font of your taste and add it to the font list,
		435	e.g.:
		436
		437	@@URXVT_NAME@@ -fn basefont,font2,font3...
		438
		439	When rxvt-unicode sees a character, it will first look at the base
		440	font. If the base font does not contain the character, it will go to the
		441	next font, and so on. Specifying your own fonts will also speed up this
		442	search and use less resources within rxvt-unicode and the X-server.
		443
		444	The only limitation is that none of the fonts may be larger than the base
		445	font, as the base font defines the terminal character cell size, which
		446	must be the same due to the way terminals work.
		447
		448
		449	=head2 Keyboard, Mouse & User Interaction
		450
		451	=head3 The new selection selects pieces that are too big, how can I select single words?
		452
		453	If you want to select e.g. alphanumeric words, you can use the following
		454	setting:
		455
		456	URxvt.selection.pattern-0: ([[:word:]]+)
		457
		458	If you click more than twice, the selection will be extended
		459	more and more.
		460
		461	To get a selection that is very similar to the old code, try this pattern:
		462
		463	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		464
		465	Please also note that the I<LeftClick Shift-LeftClik> combination also
		466	selects words like the old code.
		467
		468	=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
		469
		470	You can disable the perl extension completely by setting the
		471	B<perl-ext-common> resource to the empty string, which also keeps
		472	rxvt-unicode from initialising perl, saving memory.
		473
		474	If you only want to disable specific features, you first have to
		475	identify which perl extension is responsible. For this, read the section
		476	B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
		477	example, to disable the B<selection-popup> and B<option-popup>, specify
		478	this B<perl-ext-common> resource:
		479
		480	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		481
		482	This will keep the default extensions, but disable the two popup
		483	extensions. Some extensions can also be configured, for example,
		484	scrollback search mode is triggered by B<M-s>. You can move it to any
		485	other combination either by setting the B<searchable-scrollback> resource:
		486
		487	URxvt.searchable-scrollback: CM-s
		488
		489	=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
		490
		491	See next entry.
		492
		493	=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
		494
		495	These are caused by the C<readline> perl extension. Under normal
		496	circumstances, it will move your cursor around when you click into the
		497	line that contains it. It tries hard not to do this at the wrong moment,
		498	but when running a program that doesn't parse cursor movements or in some
		499	cases during rlogin sessions, it fails to detect this properly.
		500
		501	You can permamently switch this feature off by disabling the C<readline>
		502	extension:
		503
		504	URxvt.perl-ext-common: default,-readline
		505
		506	=head3 My numerical keypad acts weird and generates differing output?
		507
		508	Some Debian GNUL/Linux users seem to have this problem, although no
		509	specific details were reported so far. It is possible that this is caused
		510	by the wrong C<TERM> setting, although the details of wether and how
		511	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		512	keymap. See the answer to the previous question, and please report if that
		513	helped.
		514
		515	=head3 My Compose (Multi_key) key is no longer working.
		516
		517	The most common causes for this are that either your locale is not set
		518	correctly, or you specified a B<preeditStyle> that is not supported by
		519	your input method. For example, if you specified B<OverTheSpot> and
		520	your input method (e.g. the default input method handling Compose keys)
		521	does not support this (for instance because it is not visual), then
		522	rxvt-unicode will continue without an input method.
		523
		524	In this case either do not specify a B<preeditStyle> or specify more than
		525	one pre-edit style, such as B<OverTheSpot,Root,None>.
		526
		527	=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		528
		529	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		530	international keyboards) or simply use ISO 14755 support to your
		531	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		532	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		533	character and so on.
		534
		535	=head3 Mouse cut/paste suddenly no longer works.
		536
		537	Make sure that mouse reporting is actually turned off since killing
		538	some editors prematurely may leave the mouse in mouse report mode. I've
		539	heard that tcsh may use mouse reporting unless it otherwise specified. A
		540	quick check is to see if cut/paste works when the Alt or Shift keys are
		541	depressed.
		542
		543	=head3 What's with the strange Backspace/Delete key behaviour?
		544
		545	Assuming that the physical Backspace key corresponds to the
		546	BackSpace keysym (not likely for Linux ... see the following
		547	question) there are two standard values that can be used for
		548	Backspace: C<^H> and C<^?>.
		549
		550	Historically, either value is correct, but rxvt-unicode adopts the debian
		551	policy of using C<^?> when unsure, because it's the one only only correct
		552	choice :).
		553
		554	Rxvt-unicode tries to inherit the current stty settings and uses the value
		555	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
		556	started from a terminal (say, from a menu or by remote shell), then the
		557	system value of `erase', which corresponds to CERASE in <termios.h>, will
		558	be used (which may not be the same as your stty setting).
		559
		560	For starting a new rxvt-unicode:
		561
		562	# use Backspace = ^H
		563	$ stty erase ^H
		564	$ @@URXVT_NAME@@
		565
		566	# use Backspace = ^?
		567	$ stty erase ^?
		568	$ @@URXVT_NAME@@
		569
		570	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
		571
		572	For an existing rxvt-unicode:
		573
		574	# use Backspace = ^H
		575	$ stty erase ^H
		576	$ echo -n "^[[36h"
		577
		578	# use Backspace = ^?
		579	$ stty erase ^?
		580	$ echo -n "^[[36l"
		581
		582	This helps satisfy some of the Backspace discrepancies that occur, but
		583	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
		584	properly reflects that.
		585
		586	The Delete key is a another casualty of the ill-defined Backspace problem.
		587	To avoid confusion between the Backspace and Delete keys, the Delete
		588	key has been assigned an escape sequence to match the vt100 for Execute
		589	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
		590
		591	Some other Backspace problems:
		592
		593	some editors use termcap/terminfo,
		594	some editors (vim I'm told) expect Backspace = ^H,
		595	GNU Emacs (and Emacs-like editors) use ^H for help.
		596
		597	Perhaps someday this will all be resolved in a consistent manner.
		598
		599	=head3 I don't like the key-bindings. How do I change them?
		600
		601	There are some compile-time selections available via configure. Unless
		602	you have run "configure" with the C<--disable-resources> option you can
		603	use the `keysym' resource to alter the keystrings associated with keysyms.
		604
		605	Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
		606
		607	URxvt.keysym.Home: \033[1~
		608	URxvt.keysym.End: \033[4~
		609	URxvt.keysym.C-apostrophe: \033<C-'>
		610	URxvt.keysym.C-slash: \033<C-/>
		611	URxvt.keysym.C-semicolon: \033<C-;>
		612	URxvt.keysym.C-grave: \033<C-`>
		613	URxvt.keysym.C-comma: \033<C-,>
		614	URxvt.keysym.C-period: \033<C-.>
		615	URxvt.keysym.C-0x60: \033<C-`>
		616	URxvt.keysym.C-Tab: \033<C-Tab>
		617	URxvt.keysym.C-Return: \033<C-Return>
		618	URxvt.keysym.S-Return: \033<S-Return>
		619	URxvt.keysym.S-space: \033<S-Space>
		620	URxvt.keysym.M-Up: \033<M-Up>
		621	URxvt.keysym.M-Down: \033<M-Down>
		622	URxvt.keysym.M-Left: \033<M-Left>
		623	URxvt.keysym.M-Right: \033<M-Right>
		624	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
		625	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
		626	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
		627
		628	See some more examples in the documentation for the B<keysym> resource.
		629
		630	=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
		631
		632	KP_Insert == Insert
		633	F22 == Print
		634	F27 == Home
		635	F29 == Prior
		636	F33 == End
		637	F35 == Next
		638
		639	Rather than have rxvt-unicode try to accommodate all the various possible
		640	keyboard mappings, it is better to use `xmodmap' to remap the keys as
		641	required for your particular machine.
		642
		643
		644
		645	=head2 Terminal Configuration
		646
		647	=head3 Why doesn't rxvt-unicode read my resources?
		648
		649	Well, why, indeed? It does, in a way very similar to other X
		650	applications. Most importantly, this means that if you or your OS loads
		651	resources into the X display (the right way to do it), rxvt-unicode will
		652	ignore any resource files in your home directory. It will only read
		653	F<$HOME/.Xdefaults> when no resources are attached to the display.
		654
		655	If you have or use an F<$HOME/.Xresources> file, chances are that
		656	resources are loaded into your X-server. In this case, you have to
		657	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		658
		659	Also consider the form resources have to use:
		660
		661	URxvt.resource: value
		662
		663	If you want to use another form (there are lots of different ways of
		664	specifying resources), make sure you understand wether and why it
		665	works. If unsure, use the form above.
		666
		667	=head3 When I log-in to another system it tells me about missing terminfo data?
		668
		669	The terminal description used by rxvt-unicode is not as widely available
		670	as that for xterm, or even rxvt (for which the same problem often arises).
		671
		672	The correct solution for this problem is to install the terminfo, this can
		673	be done like this (with ncurses' infocmp):
		674
		675	REMOTE=remotesystem.domain
		676	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
		677
		678	... or by installing rxvt-unicode normally on the remote system,
		679
		680	If you cannot or do not want to do this, then you can simply set
		681	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		682	problems arising, which includes wrong keymapping, less and different
		683	colours and some refresh errors in fullscreen applications. It's a nice
		684	quick-and-dirty workaround for rare cases, though.
		685
		686	If you always want to do this (and are fine with the consequences) you
		687	can either recompile rxvt-unicode with the desired TERM value or use a
		688	resource to set it:
		689
		690	URxvt.termName: rxvt
		691
		692	If you don't plan to use B<rxvt> (quite common...) you could also replace
		693	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		694
		695	=head3 C<tic> outputs some error when compiling the terminfo entry.
		696
		697	Most likely it's the empty definition for C<enacs=>. Just replace it by
		698	C<enacs=\E[0@> and try again.
		699
		700	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		701
		702	See next entry.
		703
		704	=head3 I need a termcap file entry.
		705
		706	One reason you might want this is that some distributions or operating
		707	systems still compile some programs using the long-obsoleted termcap
		708	library (Fedora Core's bash is one example) and rely on a termcap entry
		709	for C<rxvt-unicode>.
		710
		711	You could use rxvt's termcap entry with resonable results in many cases.
		712	You can also create a termcap entry by using terminfo's infocmp program
		713	like this:
		714
		715	infocmp -C rxvt-unicode
		716
		717	Or you could use this termcap entry, generated by the command above:
		718
		719	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		720	:am:bw:eo:km:mi:ms:xn:xo:\
		721	:co#80:it#8:li#24:lm#0:\
		722	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		723	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		724	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		725	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		726	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		727	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		728	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		729	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		730	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		731	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		732	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		733	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		734	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		735	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		736	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		737	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		738	:vs=\E[?25h:
		739
		740	=head3 Why does C<ls> no longer have coloured output?
		741
		742	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		743	decide wether a terminal has colour, but uses it's own configuration
		744	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
		745	with most other terminals supporting colour). Either add:
		746
		747	TERM rxvt-unicode
		748
		749	to C</etc/DIR_COLORS> or simply add:
		750
		751	alias ls='ls --color=auto'
		752
		753	to your C<.profile> or C<.bashrc>.
		754
		755	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		756
		757	See next entry.
		758
		759	=head3 Why doesn't vim/emacs etc. make use of italic?
		760
		761	See next entry.
		762
		763	=head3 Why are the secondary screen-related options not working properly?
		764
		765	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		766	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		767	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		768	features. Unfortunately, some of these (most notably, again, Debian
		769	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		770	file, so you will need to install it on your own (See the question B<When
		771	I log-in to another system it tells me about missing terminfo data?> on
		772	how to do this).
		773
		774
		775	=head2 Encoding / Locale / Input Method Issues
		776
		777	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		778
		779	See next entry.
		780
		781	=head3 Unicode does not seem to work?
		782
		783	If you encounter strange problems like typing an accented character but
		784	getting two unrelated other characters or similar, or if program output is
		785	subtly garbled, then you should check your locale settings.
		786
		787	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		788	programs. Often rxvt-unicode is started in the C<C> locale, while the
		789	login script running within the rxvt-unicode window changes the locale to
		790	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
		791
		792	The best thing is to fix your startup environment, as you will likely run
		793	into other problems. If nothing works you can try this in your .profile.
		794
		795	printf '\e]701;%s\007' "$LC_CTYPE"
		796
		797	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		798	supported on your systems. Some systems have a C<locale> command which
		799	displays this (also, C<perl -e0> can be used to check locale settings, as
		800	it will complain loudly if it cannot set the locale). If it displays something
		801	like:
		802
		803	locale: Cannot set LC_CTYPE to default locale: ...
		804
		805	Then the locale you specified is not supported on your system.
		806
		807	If nothing works and you are sure that everything is set correctly then
		808	you will need to remember a little known fact: Some programs just don't
		809	support locales :(
		810
		811	=head3 How does rxvt-unicode determine the encoding to use?
		812
		813	See next entry.
		814
		815	=head3 Is there an option to switch encodings?
		816
		817	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		818	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		819	UTF-8 or any other encodings with respect to terminal I/O.
		820
		821	The reasons is that there exists a perfectly fine mechanism for selecting
		822	the encoding, doing I/O and (most important) communicating this to all
		823	applications so everybody agrees on character properties such as width
		824	and code number. This mechanism is the I<locale>. Applications not using
		825	that info will have problems (for example, C<xterm> gets the width of
		826	characters wrong as it uses it's own, locale-independent table under all
		827	locales).
		828
		829	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		830	programs doing the same (that is, most) will automatically agree in the
		831	interpretation of characters.
		832
		833	Unfortunately, there is no system-independent way to select locales, nor
		834	is there a standard on how locale specifiers will look like.
		835
		836	On most systems, the content of the C<LC_CTYPE> environment variable
		837	contains an arbitrary string which corresponds to an already-installed
		838	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		839	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		840	(i.e. C<de> or C<german>) are also common.
		841
		842	Rxvt-unicode ignores all other locale categories, and except for
		843	the encoding, ignores country or language-specific settings,
		844	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		845	rxvt-unicode.
		846
		847	If you want to use a specific encoding you have to make sure you start
		848	rxvt-unicode with the correct C<LC_CTYPE> category.
		849
		850	=head3 Can I switch locales at runtime?
		851
		852	Yes, using an escape sequence. Try something like this, which sets
		853	rxvt-unicode's idea of C<LC_CTYPE>.
		854
		855	printf '\e]701;%s\007' ja_JP.SJIS
		856
		857	See also the previous answer.
		858
		859	Sometimes this capability is rather handy when you want to work in
		860	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		861	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		862	first switches to a locale supported by xjdic and back later:
		863
		864	printf '\e]701;%s\007' ja_JP.SJIS
		865	xjdic -js
		866	printf '\e]701;%s\007' de_DE.UTF-8
		867
		868	You can also use xterm's C<luit> program, which usually works fine, except
		869	for some locales where character width differs between program- and
		870	rxvt-unicode-locales.
		871
		872	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
		873
		874	You can specify separate locales for the input method and the rest of the
		875	terminal, using the resource C<imlocale>:
		876
		877	URxvt.imlocale: ja_JP.EUC-JP
		878
		879	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		880	use your input method. Please note, however, that you will not be able to
		881	input characters outside C<EUC-JP> in a normal way then, as your input
		882	method limits you.
		883
		884	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		885
		886	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		887	design. Applications can avoid some crashes at the expense of memory
		888	leaks, and Input Methods can avoid some crashes by careful ordering at
		889	exit time. B<kinput2> (and derived input methods) generally succeeds,
		890	while B<SCIM> (or similar input methods) fails. In the end, however,
		891	crashes cannot be completely avoided even if both sides cooperate.
		892
		893	So the only workaround is not to kill your Input Method Servers.
		894
		895
		896	=head2 Operating Systems / Package Maintaining
		897
		898	=head3 I am using Debian GNU/Linux and have a problem...
		899
		900	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		901	patches that considerably change the behaviour of rxvt-unicode (but
		902	unfortunately this notice has been removed). Before reporting a bug to
		903	the original rxvt-unicode author please download and install the genuine
		904	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		905	the problem. If you cannot, chances are that the problems are specific to
		906	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		907	Tracking System (use C<reportbug> to report the bug).
		908
		909	For other problems that also affect the Debian package, you can and
		910	probably should use the Debian BTS, too, because, after all, it's also a
		911	bug in the Debian version and it serves as a reminder for other users that
		912	might encounter the same issue.
		913
		914	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		915
		916	You should build one binary with the default options. F<configure>
		917	now enables most useful options, and the trend goes to making them
		918	runtime-switchable, too, so there is usually no drawback to enbaling them,
		919	except higher disk and possibly memory usage. The perl interpreter should
		920	be enabled, as important functionality (menus, selection, likely more in
		921	the future) depends on it.
		922
		923	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		924	system-wide (except maybe with C<defaults>). This will result in useful
		925	behaviour. If your distribution aims at low memory, add an empty
		926	C<perl-ext-common> resource to the app-defaults file. This will keep the
		927	perl interpreter disabled until the user enables it.
		928
		929	If you can/want build more binaries, I recommend building a minimal
		930	one with C<--disable-everything> (very useful) and a maximal one with
		931	C<--enable-everything> (less useful, it will be very big due to a lot of
		932	encodings built-in that increase download times and are rarely used).
		933
		934	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		935
		936	It should be, starting with release 7.1. You are encouraged to properly
		937	install urxvt with privileges necessary for your OS now.
		938
		939	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		940	into a helper process for privileged operations (pty handling on some
		941	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		942	immediately. This is much safer than most other terminals that keep
		943	privileges while running (but is more relevant to urxvt, as it contains
		944	things as perl interpreters, which might be "helpful" to attackers).
		945
		946	This forking is done as the very first within main(), which is very early
		947	and reduces possible bugs to initialisation code run before main(), or
		948	things like the dynamic loader of your system, which should result in very
		949	little risk.
		950
		951	=head3 On Solaris 9, many line-drawing characters are too wide.
		952
		953	Seems to be a known bug, read
		954	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		955	following ugly workaround to get non-double-wide-characters working:
		956
		957	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
		958
		959	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		960
		961	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		962	in your compile environment, or an implementation that implements it,
		963	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		964	B<wchar_t> is represented as unicode.
		965
		966	As you might have guessed, FreeBSD does neither define this symobl nor
		967	does it support it. Instead, it uses it's own internal representation of
		968	B<wchar_t>. This is, of course, completely fine with respect to standards.
		969
		970	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		971	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		972
		973	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		974	apps in an OS, as using a locale-dependent (and non-standardized)
		975	representation of B<wchar_t> makes it impossible to convert between
		976	B<wchar_t> (as used by X11 and your applications) and any other encoding
		977	without implementing OS-specific-wrappers for each and every locale. There
		978	simply are no APIs to convert B<wchar_t> into anything except the current
		979	locale encoding.
		980
		981	Some applications (such as the formidable B<mlterm>) work around this
		982	by carrying their own replacement functions for character set handling
		983	with them, and either implementing OS-dependent hacks or doing multiple
		984	conversions (which is slow and unreliable in case the OS implements
		985	encodings slightly different than the terminal emulator).
		986
		987	The rxvt-unicode author insists that the right way to fix this is in the
		988	system libraries once and for all, instead of forcing every app to carry
		989	complete replacements for them :)
		990
		991	=head3 I use Solaris 9 and it doesn't compile/work/etc.
		992
		993	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		994	problems with C<wcwidth> and a compile problem.
		995
		996	=head3 How can I use rxvt-unicode under cygwin?
		997
		998	rxvt-unicode should compile and run out of the box on cygwin, using
		999	the X11 libraries that come with cygwin. libW11 emulation is no
		1000	longer supported (and makes no sense, either, as it only supported a
		1001	single font). I recommend starting the X-server in C<-multiwindow> or
		1002	C<-rootless> mode instead, which will result in similar look&feel as the
		1003	old libW11 emulation.
		1004
		1005	At the time of this writing, cygwin didn't seem to support any multi-byte
		1006	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1007	to 8-bit encodings.
		1008
		1009	=head1 RXVT-UNICODE TECHNICAL REFERENCE
		1010
		1011	=head1 DESCRIPTION
		1012
		1013	The rest of this document describes various technical aspects of
		1014	B<rxvt-unicode>. First the description of supported command sequences,
		1015	followed by pixmap support and last by a description of all features
		1016	selectable at C<configure> time.
6		1017
7	=head1 Definitions	1018	=head1 Definitions
8		1019
9	=over 4	1020	=over 4
10		1021
…		…
37	=over 4	1048	=over 4
38		1049
39	=item B<< C<ENQ> >>	1050	=item B<< C<ENQ> >>
40		1051
41	Enquiry (Ctrl-E) = Send Device Attributes (DA)	1052	Enquiry (Ctrl-E) = Send Device Attributes (DA)
42	request attributes from terminal ==	1053	request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43		1054
44	=item B<< C<BEL> >>	1055	=item B<< C<BEL> >>
45		1056
46	Bell (Ctrl-G)	1057	Bell (Ctrl-G)
47		1058
…		…
139	Single Shift Select of G3 Character Set (SS3): affects next character	1150	Single Shift Select of G3 Character Set (SS3): affects next character
140	only I<unimplemented>	1151	only I<unimplemented>
141		1152
142	=item B<< C<ESC Z> >>	1153	=item B<< C<ESC Z> >>
143		1154
144	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option>	1155	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145		1156
146	=item B<< C<ESC c> >>	1157	=item B<< C<ESC c> >>
147		1158
148	Full reset (RIS)	1159	Full reset (RIS)
149		1160
…		…
153		1164
154	=item B<< C<ESC o> >>	1165	=item B<< C<ESC o> >>
155		1166
156	Invoke the G3 Character Set (LS3)	1167	Invoke the G3 Character Set (LS3)
157		1168
158	=item B<< C<ESC>(C<C> >>	1169	=item B<< C<ESC ( C> >>
159		1170
160	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	1171	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161		1172
162	=item B<< C<ESC>)C<C> >>	1173	=item B<< C<ESC ) C> >>
163		1174
164	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	1175	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165		1176
166	=item B<< C<ESC * C> >>	1177	=item B<< C<ESC * C> >>
167		1178
…		…
191		1202
192	=back	1203	=back
193		1204
194	X<CSI>	1205	X<CSI>
195		1206
196	=head1 CSI (Code Sequence Introducer) Sequences	1207	=head1 CSI (Command Sequence Introducer) Sequences
197		1208
198	=over 4	1209	=over 4
199		1210
200	=item B<< C<ESC [ Ps @> >>	1211	=item B<< C<ESC [ Ps @> >>
201		1212
…		…
298		1309
299	Move backward B<< C<Ps> >> [default: 1] tab stops	1310	Move backward B<< C<Ps> >> [default: 1] tab stops
300		1311
301	=item B<< C<ESC [ Ps '> >>	1312	=item B<< C<ESC [ Ps '> >>
302		1313
303	==	1314	See B<< C<ESC [ Ps G> >>
304		1315
305	=item B<< C<ESC [ Ps a> >>	1316	=item B<< C<ESC [ Ps a> >>
306		1317
307	==X<ESCOBPsc>	1318	See B<< C<ESC [ Ps C> >>
308		1319
309	=item B<< C<ESC [ Ps c> >>	1320	=item B<< C<ESC [ Ps c> >>
310		1321
311	Send Device Attributes (DA)	1322	Send Device Attributes (DA)
312	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1323	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1324	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314	Option'')	1325	Option'')
315		1326
316	=item B<< C<ESC [ Ps d> >>	1327	=item B<< C<ESC [ Ps d> >>
317		1328
318	Cursor to Line B<< C<Ps> >> (VPA)	1329	Cursor to Line B<< C<Ps> >> (VPA)
319		1330
320	=item B<< C<ESC [ Ps e> >>	1331	=item B<< C<ESC [ Ps e> >>
321		1332
322	==	1333	See B<< C<ESC [ Ps A> >>
323		1334
324	=item B<< C<ESC [ Ps;Ps f> >>	1335	=item B<< C<ESC [ Ps;Ps f> >>
325		1336
326	Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]	1337	Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327		1338
…		…
334	B<< C<Ps = 0> >> Clear Current Column (default)	1345	B<< C<Ps = 0> >> Clear Current Column (default)
335	B<< C<Ps = 3> >> Clear All (TBC)	1346	B<< C<Ps = 3> >> Clear All (TBC)
336		1347
337	=end table	1348	=end table
338		1349
		1350	=item B<< C<ESC [ Pm h> >>
		1351
		1352	Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
		1353
339	=item B<< C<ESC [ Ps i> >>	1354	=item B<< C<ESC [ Ps i> >>
340		1355
341	Printing	1356	Printing. See also the C<print-pipe> resource.
342		1357
343	=begin table	1358	=begin table
344		1359
		1360	B<< C<Ps = 0> >> print screen (MC0)
345	B<< C<Ps = 4> >> disable transparent print mode (MC4)	1361	B<< C<Ps = 4> >> disable transparent print mode (MC4)
346	B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented>	1362	B<< C<Ps = 5> >> enable transparent print mode (MC5)
347		1363
348	=end table	1364	=end table
349
350	=item B<< C<ESC [ Pm h> >>
351
352	Set Mode (SM). See next sequence for description of C<Pm>.
353		1365
354	=item B<< C<ESC [ Pm l> >>	1366	=item B<< C<ESC [ Pm l> >>
355		1367
356	Reset Mode (RM)	1368	Reset Mode (RM)
357		1369
…		…
364	B<< C<h> >> Insert Mode (SMIR)	1376	B<< C<h> >> Insert Mode (SMIR)
365	B<< C<l> >> Replace Mode (RMIR)	1377	B<< C<l> >> Replace Mode (RMIR)
366		1378
367	=end table	1379	=end table
368		1380
369	=item B<< C<Ps = 20> >> I<unimplemented>	1381	=item B<< C<Ps = 20> >> (partially implemented)
370		1382
371	=begin table	1383	=begin table
372		1384
373	B<< C<h> >> Automatic Newline (LNM)	1385	B<< C<h> >> Automatic Newline (LNM)
374	B<< C<h> >> Normal Linefeed (LNM)	1386	B<< C<l> >> Normal Linefeed (LNM)
375		1387
376	=end table	1388	=end table
377		1389
378	=back	1390	=back
379		1391
…		…
382	Character Attributes (SGR)	1394	Character Attributes (SGR)
383		1395
384	=begin table	1396	=begin table
385		1397
386	B<< C<Ps = 0> >> Normal (default)	1398	B<< C<Ps = 0> >> Normal (default)
387	B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg)	1399	B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
		1400	B<< C<Ps = 3 / 23> >> On / Off Italic
388	B<< C<Ps = 4 / 24> >> On / Off Underline	1401	B<< C<Ps = 4 / 24> >> On / Off Underline
389	B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg)	1402	B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
		1403	B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390	B<< C<Ps = 7 / 27> >> On / Off Inverse	1404	B<< C<Ps = 7 / 27> >> On / Off Inverse
		1405	B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391	B<< C<Ps = 30 / 40> >> fg/bg Black	1406	B<< C<Ps = 30 / 40> >> fg/bg Black
392	B<< C<Ps = 31 / 41> >> fg/bg Red	1407	B<< C<Ps = 31 / 41> >> fg/bg Red
393	B<< C<Ps = 32 / 42> >> fg/bg Green	1408	B<< C<Ps = 32 / 42> >> fg/bg Green
394	B<< C<Ps = 33 / 43> >> fg/bg Yellow	1409	B<< C<Ps = 33 / 43> >> fg/bg Yellow
395	B<< C<Ps = 34 / 44> >> fg/bg Blue	1410	B<< C<Ps = 34 / 44> >> fg/bg Blue
396	B<< C<Ps = 35 / 45> >> fg/bg Magenta	1411	B<< C<Ps = 35 / 45> >> fg/bg Magenta
397	B<< C<Ps = 36 / 46> >> fg/bg Cyan	1412	B<< C<Ps = 36 / 46> >> fg/bg Cyan
		1413	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	1414	B<< C<Ps = 37 / 47> >> fg/bg White
399	B<< C<Ps = 39 / 49> >> fg/bg Default	1415	B<< C<Ps = 39 / 49> >> fg/bg Default
		1416	B<< C<Ps = 90 / 100> >> fg/bg Bright Black
		1417	B<< C<Ps = 91 / 101> >> fg/bg Bright Red
		1418	B<< C<Ps = 92 / 102> >> fg/bg Bright Green
		1419	B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
		1420	B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
		1421	B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
		1422	B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
		1423	B<< C<Ps = 97 / 107> >> fg/bg Bright White
		1424	B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400		1425
401	=end table	1426	=end table
402		1427
403	=item B<< C<ESC [ Ps n> >>	1428	=item B<< C<ESC [ Ps n> >>
404		1429
…		…
420		1445
421	=item B<< C<ESC [ s> >>	1446	=item B<< C<ESC [ s> >>
422		1447
423	Save Cursor (SC)	1448	Save Cursor (SC)
424		1449
		1450	=item B<< C<ESC [ Ps;Pt t> >>
		1451
		1452	Window Operations
		1453
		1454	=begin table
		1455
		1456	B<< C<Ps = 1> >> Deiconify (map) window
		1457	B<< C<Ps = 2> >> Iconify window
		1458	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
		1459	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1460	B<< C<Ps = 5> >> Raise window
		1461	B<< C<Ps = 6> >> Lower window
		1462	B<< C<Ps = 7> >> Refresh screen once
		1463	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1464	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1465	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1466	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1467	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1468	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1469	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1470	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1471	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1472
		1473	=end table
		1474
		1475	=item B<< C<ESC [ u> >>
		1476
		1477	Restore Cursor
		1478
425	=item B<< C<ESC [ Ps x> >>	1479	=item B<< C<ESC [ Ps x> >>
426		1480
427	Request Terminal Parameters (DECREQTPARM)	1481	Request Terminal Parameters (DECREQTPARM)
428
429	=item B<< C<ESC [ u> >>
430
431	Restore Cursor
432		1482
433	=back	1483	=back
434		1484
435	X<PrivateModes>	1485	X<PrivateModes>
436		1486
…		…
539	B<< C<h> >> Send Mouse X & Y on button press.	1589	B<< C<h> >> Send Mouse X & Y on button press.
540	B<< C<l> >> No mouse reporting.	1590	B<< C<l> >> No mouse reporting.
541		1591
542	=end table	1592	=end table
543		1593
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> >>	1594	=item B<< C<Ps = 25> >>
556		1595
557	=begin table	1596	=begin table
558		1597
559	B<< C<h> >> Visible cursor {cnorm/cvvis}	1598	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
625		1664
626	=item B<< C<Ps = 66> >>	1665	=item B<< C<Ps = 66> >>
627		1666
628	=begin table	1667	=begin table
629		1668
630	B<< C<h> >> Application Keypad (DECPAM) ==	1669	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631	B<< C<l> >> Normal Keypad (DECPNM) ==	1670	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632		1671
633	=end table	1672	=end table
634		1673
635	=item B<< C<Ps = 67> >>	1674	=item B<< C<Ps = 67> >>
636		1675
…		…
657	B<< C<h> >> Use Hilite Mouse Tracking.	1696	B<< C<h> >> Use Hilite Mouse Tracking.
658	B<< C<l> >> No mouse reporting.	1697	B<< C<l> >> No mouse reporting.
659		1698
660	=end table	1699	=end table
661		1700
662	=item B<< C<Ps = 1010> >>	1701	=item B<< C<Ps = 1010> >> (B<rxvt>)
663		1702
664	=begin table	1703	=begin table
665		1704
666	B<< C<h> >> Don't scroll to bottom on TTY output	1705	B<< C<h> >> Don't scroll to bottom on TTY output
667	B<< C<l> >> Scroll to bottom on TTY output	1706	B<< C<l> >> Scroll to bottom on TTY output
668		1707
669	=end table	1708	=end table
670		1709
671	=item B<< C<Ps = 1011> >>	1710	=item B<< C<Ps = 1011> >> (B<rxvt>)
672		1711
673	=begin table	1712	=begin table
674		1713
675	B<< C<h> >> Scroll to bottom when a key is pressed	1714	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	1715	B<< C<l> >> Don't scroll to bottom when a key is pressed
677		1716
678	=end table	1717	=end table
679		1718
		1719	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1720
		1721	=begin table
		1722
		1723	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1724	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1725
		1726	=end table
		1727
680	=item B<< C<Ps = 1047> >>	1728	=item B<< C<Ps = 1047> >>
681		1729
682	=begin table	1730	=begin table
683		1731
684	B<< C<h> >> Use Alternate Screen Buffer	1732	B<< C<h> >> Use Alternate Screen Buffer
…		…
690		1738
691	=begin table	1739	=begin table
692		1740
693	B<< C<h> >> Save cursor position	1741	B<< C<h> >> Save cursor position
694	B<< C<l> >> Restore cursor position	1742	B<< C<l> >> Restore cursor position
		1743
		1744	=end table
		1745
		1746	=item B<< C<Ps = 1049> >>
		1747
		1748	=begin table
		1749
		1750	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
		1751	B<< C<l> >> Use Normal Screen Buffer
695		1752
696	=end table	1753	=end table
697		1754
698	=back	1755	=back
699		1756
…		…
721	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1778	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)>	1779	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> >>	1780	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> >>	1781	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> >>	1782	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> >>	1783	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> >>	1784	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		1785	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
728	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1786	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>	1787	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>	1788	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> >>	1789	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> >>	1790	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)	1791	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)	1792	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)	1793	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
		1794	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1795	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1796	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
		1797	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
		1798	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1799	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1800	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1801	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1802	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1803	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737		1804
738	=end table	1805	=end table
739		1806
740	=back	1807	=back
741		1808
742	X<menuBar>
743
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>	1809	X<XPM>
1208		1810
1209	=head1 XPM	1811	=head1 XPM
1210		1812
1211	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1813	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
1310	=begin table	1912	=begin table
1311		1913
1312	4 Shift	1914	4 Shift
1313	8 Meta	1915	8 Meta
1314	16 Control	1916	16 Control
1315	32 Double Click I<(Rxvt extension)>	1917	32 Double Click I<(rxvt extension)>
1316		1918
1317	=end table	1919	=end table
1318		1920
1319	Col = B<< C<< <x> - SPACE >> >>	1921	Col = B<< C<< <x> - SPACE >> >>
1320		1922
1321	Row = B<< C<< <y> - SPACE >> >>	1923	Row = B<< C<< <y> - SPACE >> >>
1322		1924
1323	=back	1925	=back
1324	X<KeyCodes>	1926	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		1927
1340	=head1 Key Codes	1928	=head1 Key Codes
1341		1929
1342	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>	1930	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343		1931
…		…
1408	XK_KP_8 8 ESC O x	1996	XK_KP_8 8 ESC O x
1409	XK_KP_9 9 ESC O y	1997	XK_KP_9 9 ESC O y
1410		1998
1411	=end table	1999	=end table
1412		2000
		2001	=head1 CONFIGURE OPTIONS
		2002
		2003	General hint: if you get compile errors, then likely your configuration
		2004	hasn't been tested well. Either try with C<--enable-everything> or use
		2005	the F<./reconf> script as a base for experiments. F<./reconf> is used by
		2006	myself, so it should generally be a working config. Of course, you should
		2007	always report when a combination doesn't work, so it can be fixed. Marc
		2008	Lehmann <rxvt@schmorp.de>.
		2009
		2010	All
		2011
		2012	=over 4
		2013
		2014	=item --enable-everything
		2015
		2016	Add (or remove) support for all non-multichoice options listed in "./configure
		2017	--help".
		2018
		2019	You can specify this and then disable options you do not like by
		2020	I<following> this with the appropriate C<--disable-...> arguments,
		2021	or you can start with a minimal configuration by specifying
		2022	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2023	you want.
		2024
		2025	=item --enable-xft (default: enabled)
		2026
		2027	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
		2028	slower and require lots of memory, but as long as you don't use them, you
		2029	don't pay for them.
		2030
		2031	=item --enable-font-styles (default: on)
		2032
		2033	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
		2034	styles. The fonts can be set manually or automatically.
		2035
		2036	=item --with-codesets=NAME,... (default: all)
		2037
		2038	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
		2039	are always compiled in, which includes most 8-bit character sets). These
		2040	codeset tables are used for driving X11 core fonts, they are not required
		2041	for Xft fonts, although having them compiled in lets rxvt-unicode choose
		2042	replacement fonts more intelligently. Compiling them in will make your
		2043	binary bigger (all of together cost about 700kB), but it doesn't increase
		2044	memory usage unless you use a font requiring one of these encodings.
		2045
		2046	=begin table
		2047
		2048	all all available codeset groups
		2049	zh common chinese encodings
		2050	zh_ext rarely used but very big chinese encodigs
		2051	jp common japanese encodings
		2052	jp_ext rarely used but big japanese encodings
		2053	kr korean encodings
		2054
		2055	=end table
		2056
		2057	=item --enable-xim (default: on)
		2058
		2059	Add support for XIM (X Input Method) protocol. This allows using
		2060	alternative input methods (e.g. kinput2) and will also correctly
		2061	set up the input for people using dead keys or compose keys.
		2062
		2063	=item --enable-unicode3 (default: off)
		2064
		2065	Recommended to stay off unless you really need non-BMP characters.
		2066
		2067	Enable direct support for displaying unicode codepoints above
		2068	65535 (the basic multilingual page). This increases storage
		2069	requirements per character from 2 to 4 bytes. X11 fonts do not yet
		2070	support these extra characters, but Xft does.
		2071
		2072	Please note that rxvt-unicode can store unicode code points >65535
		2073	even without this flag, but the number of such characters is
		2074	limited to a view thousand (shared with combining characters,
		2075	see next switch), and right now rxvt-unicode cannot display them
		2076	(input/output and cut&paste still work, though).
		2077
		2078	=item --enable-combining (default: on)
		2079
		2080	Enable automatic composition of combining characters into
		2081	composite characters. This is required for proper viewing of text
		2082	where accents are encoded as seperate unicode characters. This is
		2083	done by using precomposited characters when available or creating
		2084	new pseudo-characters when no precomposed form exists.
		2085
		2086	Without --enable-unicode3, the number of additional precomposed
		2087	characters is somewhat limited (the 6400 private use characters will be
		2088	(ab-)used). With --enable-unicode3, no practical limit exists.
		2089
		2090	This option will also enable storage (but not display) of characters
		2091	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
		2092
		2093	The combining table also contains entries for arabic presentation forms,
		2094	but these are not currently used. Bug me if you want these to be used (and
		2095	tell me how these are to be used...).
		2096
		2097	=item --enable-fallback(=CLASS) (default: Rxvt)
		2098
		2099	When reading resource settings, also read settings for class CLASS. To
		2100	disable resource fallback use --disable-fallback.
		2101
		2102	=item --with-res-name=NAME (default: urxvt)
		2103
		2104	Use the given name as default application name when
		2105	reading resources. Specify --with-res-name=rxvt to replace rxvt.
		2106
		2107	=item --with-res-class=CLASS /default: URxvt)
		2108
		2109	Use the given class as default application class
		2110	when reading resources. Specify --with-res-class=Rxvt to replace
		2111	rxvt.
		2112
		2113	=item --enable-utmp (default: on)
		2114
		2115	Write user and tty to utmp file (used by programs like F<w>) at
		2116	start of rxvt execution and delete information when rxvt exits.
		2117
		2118	=item --enable-wtmp (default: on)
		2119
		2120	Write user and tty to wtmp file (used by programs like F<last>) at
		2121	start of rxvt execution and write logout when rxvt exits. This
		2122	option requires --enable-utmp to also be specified.
		2123
		2124	=item --enable-lastlog (default: on)
		2125
		2126	Write user and tty to lastlog file (used by programs like
		2127	F<lastlogin>) at start of rxvt execution. This option requires
		2128	--enable-utmp to also be specified.
		2129
		2130	=item --enable-xpm-background (default: on)
		2131
		2132	Add support for XPM background pixmaps.
		2133
		2134	=item --enable-transparency (default: on)
		2135
		2136	Add support for inheriting parent backgrounds thus giving a fake
		2137	transparency to the term.
		2138
		2139	=item --enable-fading (default: on)
		2140
		2141	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
		2142
		2143	=item --enable-tinting (default: on)
		2144
		2145	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
		2146
		2147	=item --enable-rxvt-scroll (default: on)
		2148
		2149	Add support for the original rxvt scrollbar.
		2150
		2151	=item --enable-next-scroll (default: on)
		2152
		2153	Add support for a NeXT-like scrollbar.
		2154
		2155	=item --enable-xterm-scroll (default: on)
		2156
		2157	Add support for an Xterm-like scrollbar.
		2158
		2159	=item --enable-plain-scroll (default: on)
		2160
		2161	Add support for a very unobtrusive, plain-looking scrollbar that
		2162	is the favourite of the rxvt-unicode author, having used it for
		2163	many years.
		2164
		2165	=item --enable-ttygid (default: off)
		2166
		2167	Change tty device setting to group "tty" - only use this if
		2168	your system uses this type of security.
		2169
		2170	=item --disable-backspace-key
		2171
		2172	Removes any handling of the backspace key by us - let the X server do it.
		2173
		2174	=item --disable-delete-key
		2175
		2176	Removes any handling of the delete key by us - let the X server
		2177	do it.
		2178
		2179	=item --disable-resources
		2180
		2181	Removes any support for resource checking.
		2182
		2183	=item --disable-swapscreen
		2184
		2185	Remove support for secondary/swap screen.
		2186
		2187	=item --enable-frills (default: on)
		2188
		2189	Add support for many small features that are not essential but nice to
		2190	have. Normally you want this, but for very small binaries you may want to
		2191	disable this.
		2192
		2193	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
		2194	in combination with other switches) is:
		2195
		2196	MWM-hints
		2197	EWMH-hints (pid, utf8 names) and protocols (ping)
		2198	seperate underline colour (-underlineColor)
		2199	settable border widths and borderless switch (-w, -b, -bl)
		2200	visual depth selection (-depth)
		2201	settable extra linespacing /-lsp)
		2202	iso-14755-2 and -3, and visual feedback
		2203	tripleclickwords (-tcw)
		2204	settable insecure mode (-insecure)
		2205	keysym remapping support
		2206	cursor blinking and underline cursor (-cb, -uc)
		2207	XEmbed support (-embed)
		2208	user-pty (-pty-fd)
		2209	hold on exit (-hold)
		2210	skip builtin block graphics (-sbg)
		2211
		2212	It also enabled some non-essential features otherwise disabled, such as:
		2213
		2214	some round-trip time optimisations
		2215	nearest color allocation on pseudocolor screens
		2216	UTF8_STRING supporr for selection
		2217	sgr modes 90..97 and 100..107
		2218	backindex and forwardindex escape sequences
		2219	view change/zero scorllback esacpe sequences
		2220	locale switching escape sequence
		2221	window op and some xterm/OSC escape sequences
		2222	rectangular selections
		2223	trailing space removal for selections
		2224	verbose X error handling
		2225
		2226	=item --enable-iso14755 (default: on)
		2227
		2228	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
		2229	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
		2230	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
		2231	this switch.
		2232
		2233	=item --enable-keepscrolling (default: on)
		2234
		2235	Add support for continual scrolling of the display when you hold
		2236	the mouse button down on a scrollbar arrow.
		2237
		2238	=item --enable-mousewheel (default: on)
		2239
		2240	Add support for scrolling via mouse wheel or buttons 4 & 5.
		2241
		2242	=item --enable-slipwheeling (default: on)
		2243
		2244	Add support for continual scrolling (using the mouse wheel as an
		2245	accelerator) while the control key is held down. This option
		2246	requires --enable-mousewheel to also be specified.
		2247
		2248	=item --disable-new-selection
		2249
		2250	Remove support for mouse selection style like that of xterm.
		2251
		2252	=item --enable-dmalloc (default: off)
		2253
		2254	Use Gray Watson's malloc - which is good for debugging See
		2255	http://www.letters.com/dmalloc/ for details If you use either this or the
		2256	next option, you may need to edit src/Makefile after compiling to point
		2257	DINCLUDE and DLIB to the right places.
		2258
		2259	You can only use either this option and the following (should
		2260	you use either) .
		2261
		2262	=item --enable-dlmalloc (default: off)
		2263
		2264	Use Doug Lea's malloc - which is good for a production version
		2265	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
		2266
		2267	=item --enable-smart-resize (default: on)
		2268
		2269	Add smart growth/shrink behaviour when changing font size via hot
		2270	keys. This should keep the window corner which is closest to a corner of
		2271	the screen in a fixed position.
		2272
		2273	=item --enable-pointer-blank (default: on)
		2274
		2275	Add support to have the pointer disappear when typing or inactive.
		2276
		2277	=item --enable-perl (default: on)
		2278
		2279	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2280	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2281	in F<src/perl-ext/> for the extensions that are installed by default. The
		2282	perl interpreter that is used can be specified via the C<PERL> environment
		2283	variable when running configure.
		2284
		2285	=item --with-name=NAME (default: urxvt)
		2286
		2287	Set the basename for the installed binaries, resulting
		2288	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
		2289	C<rxvt>.
		2290
		2291	=item --with-term=NAME (default: rxvt-unicode)
		2292
		2293	Change the environmental variable for the terminal to NAME.
		2294
		2295	=item --with-terminfo=PATH
		2296
		2297	Change the environmental variable for the path to the terminfo tree to
		2298	PATH.
		2299
		2300	=item --with-x
		2301
		2302	Use the X Window System (pretty much default, eh?).
		2303
		2304	=item --with-xpm-includes=DIR
		2305
		2306	Look for the XPM includes in DIR.
		2307
		2308	=item --with-xpm-library=DIR
		2309
		2310	Look for the XPM library in DIR.
		2311
		2312	=item --with-xpm
		2313
		2314	Not needed - define via --enable-xpm-background.
		2315
		2316	=back
		2317
		2318	=head1 AUTHORS
		2319
		2320	Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
		2321	reworked it from the original Rxvt documentation, which was done by Geoff
		2322	Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
		2323	sources.
		2324

Diff Legend

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