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.174 by root, Thu Dec 4 00:23:55 2008 UTC

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

Diff Legend

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