[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.pod

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.45 by root, Sun Feb 13 11:07:57 2005 UTC vs.
Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC

…		…
24		24
25	=head1 FREQUENTLY ASKED QUESTIONS	25	=head1 FREQUENTLY ASKED QUESTIONS
26		26
27	=over 4	27	=over 4
28		28
		29	=item The new selection selects pieces that are too big, how can I select
		30	single words?
		31
		32	Yes. For example, if you want to select alphanumeric words, you can use
		33	the following resource:
		34
		35	URxvt.selection.pattern-0: ([[:word:]]+)
		36
		37	If you click more than twice, the selection will be extended
		38	more and more.
		39
		40	To get a selection that is very similar to the old code, try this pattern:
		41
		42	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)
		43
		44	Please also note that the I<LeftClick Shift-LeftClik> combination also
		45	selects words like the old code.
		46
		47	=item I don't like the new selection/popups/hotkeys/perl, how do I
		48	change/disable it?
		49
		50	You can disable the perl extension completely by setting the
		51	B<perl-ext-common> resource to the empty string, which also keeps
		52	rxvt-unicode from initialising perl, saving memory.
		53
		54	If you only want to disable specific features, you first have to
		55	identify which perl extension is responsible. For this, read the section
		56	B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
		57	example, to disable the B<selection-popup> and B<option-popup>, specify
		58	this B<perl-ext-common> resource:
		59
		60	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		61
		62	This will keep the default extensions, but disable the two popup
		63	extensions. Some extensions can also be configured, for example,
		64	scrollback search mode is triggered by B<M-s>. You can move it to any
		65	other combination either by setting the B<searchable-scrollback> resource:
		66
		67	URxvt.searchable-scrollback: CM-s
		68
		69	=item Isn't rxvt supposed to be small? Don't all those features bloat?
		70
		71	I often get asked about this, and I think, no, they didn't cause extra
		72	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		73	that the urxvt binary is larger (due to some encoding tables always being
		74	compiled in), but it actually uses less memory (RSS) after startup. Even
		75	with C<--disable-everything>, this comparison is a bit unfair, as many
		76	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		77	already in use in this mode.
		78
		79	text data bss drs rss filename
		80	98398 1664 24 15695 1824 rxvt --disable-everything
		81	188985 9048 66616 18222 1788 urxvt --disable-everything
		82
		83	When you C<--enable-everything> (which _is_ unfair, as this involves xft
		84	and full locale/XIM support which are quite bloaty inside libX11 and my
		85	libc), the two diverge, but not unreasnobaly so.
		86
		87	text data bss drs rss filename
		88	163431 2152 24 20123 2060 rxvt --enable-everything
		89	1035683 49680 66648 29096 3680 urxvt --enable-everything
		90
		91	The very large size of the text section is explained by the east-asian
		92	encoding tables, which, if unused, take up disk space but nothing else
		93	and can be compiled out unless you rely on X11 core fonts that use those
		94	encodings. The BSS size comes from the 64k emergency buffer that my c++
		95	compiler allocates (but of course doesn't use unless you are out of
		96	memory). Also, using an xft font instead of a core font immediately adds a
		97	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		98	not used.
		99
		100	Of course, due to every character using two or four bytes instead of one,
		101	a large scrollback buffer will ultimately make rxvt-unicode use more
		102	memory.
		103
		104	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		105	still fares rather well. And compared to some monsters like gnome-terminal
		106	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		107	43180k in daemons that stay around after exit, plus half a minute of
		108	startup time, including the hundreds of warnings it spits out), it fares
		109	extremely well g.
		110
		111	=item Why C++, isn't that unportable/bloated/uncool?
		112
		113	Is this a question? :) It comes up very often. The simple answer is: I had
		114	to write it, and C++ allowed me to write and maintain it in a fraction
		115	of the time and effort (which is a scarce resource for me). Put even
		116	shorter: It simply wouldn't exist without C++.
		117
		118	My personal stance on this is that C++ is less portable than C, but in
		119	the case of rxvt-unicode this hardly matters, as its portability limits
		120	are defined by things like X11, pseudo terminals, locale support and unix
		121	domain sockets, which are all less portable than C++ itself.
		122
		123	Regarding the bloat, see the above question: It's easy to write programs
		124	in C that use gobs of memory, an certainly possible to write programs in
		125	C++ that don't. C++ also often comes with large libraries, but this is
		126	not necessarily the case with GCC. Here is what rxvt links against on my
		127	system with a minimal config:
		128
		129	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		130	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		131	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		132	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		133
		134	And here is rxvt-unicode:
		135
		136	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		137	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		138	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		139	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		140	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		141
		142	No large bloated libraries (of course, none were linked in statically),
		143	except maybe libX11 :)
		144
		145	=item Does it support tabs, can I have a tabbed rxvt-unicode?
		146
		147	rxvt-unicode does not directly support tabs. It will work fine with
		148	tabbing functionality of many window managers or similar tabbing programs,
		149	and its embedding-features allow it to be embedded into other programs,
		150	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
		151	module, which features a tabbed urxvt (murxvt) terminal as an example
		152	embedding application.
		153
29	=item How do I know which rxvt-unicode version I'm using?	154	=item How do I know which rxvt-unicode version I'm using?
30		155
31	The version number is displayed with the usage (-h). Also the escape	156	The version number is displayed with the usage (-h). Also the escape
32	sequence C<ESC [ 8 n> sets the window title to the version number.	157	sequence C<ESC [ 8 n> sets the window title to the version number. When
		158	using the @@RXVT_NAME@@c client, the version displayed is that of the
		159	daemon.
33		160
34	=item I am using Debian GNU/Linux and have a problem...	161	=item I am using Debian GNU/Linux and have a problem...
35		162
36	The Debian GNU/Linux package of rxvt-unicode contains large patches that	163	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37	considerably change the behaviour of rxvt-unicode. Before reporting a	164	patches that considerably change the behaviour of rxvt-unicode. Before
38	bug to the original rxvt-unicode author please download and install the	165	reporting a bug to the original rxvt-unicode author please download and
39	genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to	166	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
40	reproduce the problem. If you cannot, chances are that the problems are	167	and try to reproduce the problem. If you cannot, chances are that the
41	specific to Debian GNU/Linux, in which case it should be reported via the	168	problems are specific to Debian GNU/Linux, in which case it should be
42	Debian Bug Tracking System (use C<reportbug> to report the bug).	169	reported via the Debian Bug Tracking System (use C<reportbug> to report
		170	the bug).
43		171
44	For other problems that also affect the Debian package, you can and	172	For other problems that also affect the Debian package, you can and
45	probably should use the Debian BTS, too, because, after all, it's also a	173	probably should use the Debian BTS, too, because, after all, it's also a
46	bug in the Debian version and it serves as a reminder for other users that	174	bug in the Debian version and it serves as a reminder for other users that
47	might encounter the same issue.	175	might encounter the same issue.
		176
		177	=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		178
		179	You should build one binary with the default options. F<configure>
		180	now enables most useful options, and the trend goes to making them
		181	runtime-switchable, too, so there is usually no drawback to enbaling them,
		182	except higher disk and possibly memory usage. The perl interpreter should
		183	be enabled, as important functionality (menus, selection, likely more in
		184	the future) depends on it.
		185
		186	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		187	system-wide (except maybe with C<defaults>). This will result in useful
		188	behaviour. If your distribution aims at low memory, add an empty
		189	C<perl-ext-common> resource to the app-defaults file. This will keep the
		190	perl interpreter disabled until the user enables it.
		191
		192	If you can/want build more binaries, I recommend building a minimal
		193	one with C<--disable-everything> (very useful) and a maximal one with
		194	C<--enable-everything> (less useful, it will be very big due to a lot of
		195	encodings built-in that increase download times and are rarely used).
		196
		197	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		198
		199	Likely not. While I honestly try to make it secure, and am probably not
		200	bad at it, I think it is simply unreasonable to expect all of freetype
		201	+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
		202	secure. Also, rxvt-unicode disables some options when it detects that it
		203	runs setuid or setgid, which is not nice. Besides, with the embedded perl
		204	interpreter the possibility for security problems easily multiplies.
		205
		206	Elevated privileges are only required for utmp and pty operations on some
		207	systems (for example, GNU/Linux doesn't need any extra privileges for
		208	ptys, but some need it for utmp support). It is planned to mvoe this into
		209	a forked handler process, but this is not yet done.
		210
		211	So, while setuid/setgid operation is supported and not a problem on your
		212	typical single-user-no-other-logins unix desktop, always remember that
		213	its an awful lot of code, most of which isn't checked for security issues
		214	regularly.
48		215
49	=item When I log-in to another system it tells me about missing terminfo data?	216	=item When I log-in to another system it tells me about missing terminfo data?
50		217
51	The terminal description used by rxvt-unicode is not as widely available	218	The terminal description used by rxvt-unicode is not as widely available
52	as that for xterm, or even rxvt (for which the same problem often arises).	219	as that for xterm, or even rxvt (for which the same problem often arises).
…		…
72	URxvt.termName: rxvt	239	URxvt.termName: rxvt
73		240
74	If you don't plan to use B<rxvt> (quite common...) you could also replace	241	If you don't plan to use B<rxvt> (quite common...) you could also replace
75	the rxvt terminfo file with the rxvt-unicode one.	242	the rxvt terminfo file with the rxvt-unicode one.
76		243
		244	=item C<tic> outputs some error when compiling the terminfo entry.
		245
		246	Most likely it's the empty definition for C<enacs=>. Just replace it by
		247	C<enacs=\E[0@> and try again.
		248
77	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.	249	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78		250
79	=item I need a termcap file entry.	251	=item I need a termcap file entry.
80		252
81	One reason you might want this is that some distributions or operating	253	One reason you might want this is that some distributions or operating
82	systems still compile some programs using the long-obsoleted termcap	254	systems still compile some programs using the long-obsoleted termcap
83	(Fedora Core's bash is one example) and rely on a termcap entry for	255	library (Fedora Core's bash is one example) and rely on a termcap entry
84	C<rxvt-unicode>.	256	for C<rxvt-unicode>.
85		257
86	You could use rxvt's termcap entry with resonable results in many cases.	258	You could use rxvt's termcap entry with resonable results in many cases.
87	You can also create a termcap entry by using terminfo's infocmp program	259	You can also create a termcap entry by using terminfo's infocmp program
88	like this:	260	like this:
89		261
…		…
91		263
92	Or you could use this termcap entry, generated by the command above:	264	Or you could use this termcap entry, generated by the command above:
93		265
94	rxvt-unicode\|rxvt-unicode terminal (X Window System):\	266	rxvt-unicode\|rxvt-unicode terminal (X Window System):\
95	:am:bw:eo:km:mi:ms:xn:xo:\	267	:am:bw:eo:km:mi:ms:xn:xo:\
96	:co#80:it#8:li#24:\	268	:co#80:it#8:li#24:lm#0:\
97	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\	269	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\	270	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\	271	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100	:as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\	272	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101	:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\	273	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102	:ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\	274	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		275	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
103	:im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\	276	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104	:k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\	277	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
105	:k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\	278	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
106	:kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\	279	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
107	:ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\	280	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
108	:ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\	281	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
109	:nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\	282	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
110	:st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\	283	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
111	:up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\	284	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
112	:vs=\E[?25h:	285	:vs=\E[?25h:
113		286
114	=item Why does C<ls> no longer have coloured output?	287	=item Why does C<ls> no longer have coloured output?
115		288
116	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to	289	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
…		…
257	might be forced to use a different font.	430	might be forced to use a different font.
258		431
259	All of this is not a problem when using X11 core fonts, as their bounding	432	All of this is not a problem when using X11 core fonts, as their bounding
260	box data is correct.	433	box data is correct.
261		434
		435	=item On Solaris 9, many line-drawing characters are too wide.
		436
		437	Seems to be a known bug, read
		438	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		439	following ugly workaround to get non-double-wide-characters working:
		440
		441	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
		442
262	=item My Compose (Multi_key) key is no longer working.	443	=item My Compose (Multi_key) key is no longer working.
263		444
264	The most common causes for this are that either your locale is not set	445	The most common causes for this are that either your locale is not set
265	correctly, or you specified a B<preeditStyle> that is not supported by	446	correctly, or you specified a B<preeditStyle> that is not supported by
266	your input method. For example, if you specified B<OverTheSpot> and	447	your input method. For example, if you specified B<OverTheSpot> and
…		…
309		490
310	As you might have guessed, FreeBSD does neither define this symobl nor	491	As you might have guessed, FreeBSD does neither define this symobl nor
311	does it support it. Instead, it uses it's own internal representation of	492	does it support it. Instead, it uses it's own internal representation of
312	B<wchar_t>. This is, of course, completely fine with respect to standards.	493	B<wchar_t>. This is, of course, completely fine with respect to standards.
313		494
		495	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		496	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		497
314	However, C<__STDC_ISO_10646__> is the only sane way to support	498	C<__STDC_ISO_10646__> is the only sane way to support multi-language
315	multi-language apps in an OS, as using a locale-dependent (and	499	apps in an OS, as using a locale-dependent (and non-standardized)
316	non-standardized) representation of B<wchar_t> makes it impossible to	500	representation of B<wchar_t> makes it impossible to convert between
317	convert between B<wchar_t> (as used by X11 and your applications) and any	501	B<wchar_t> (as used by X11 and your applications) and any other encoding
318	other encoding without implementing OS-specific-wrappers for each and	502	without implementing OS-specific-wrappers for each and every locale. There
319	every locale. There simply are no APIs to convert B<wchar_t> into anything	503	simply are no APIs to convert B<wchar_t> into anything except the current
320	except the current locale encoding.	504	locale encoding.
321		505
322	Some applications (such as the formidable B<mlterm>) work around this	506	Some applications (such as the formidable B<mlterm>) work around this
323	by carrying their own replacement functions for character set handling	507	by carrying their own replacement functions for character set handling
324	with them, and either implementing OS-dependent hacks or doing multiple	508	with them, and either implementing OS-dependent hacks or doing multiple
325	conversions (which is slow and unreliable in case the OS implements	509	conversions (which is slow and unreliable in case the OS implements
326	encodings slightly different than the terminal emulator).	510	encodings slightly different than the terminal emulator).
327		511
328	The rxvt-unicode author insists that the right way to fix this is in the	512	The rxvt-unicode author insists that the right way to fix this is in the
329	system libraries once and for all, instead of forcing every app to carry	513	system libraries once and for all, instead of forcing every app to carry
330	complete replacements for them :)	514	complete replacements for them :)
		515
		516	=item I use Solaris 9 and it doesn't compile/work/etc.
		517
		518	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		519	problems with C<wcwidth> and a compile problem.
		520
		521	=item How can I use rxvt-unicode under cygwin?
		522
		523	rxvt-unicode should compile and run out of the box on cygwin, using
		524	the X11 libraries that come with cygwin. libW11 emulation is no
		525	longer supported (and makes no sense, either, as it only supported a
		526	single font). I recommend starting the X-server in C<-multiwindow> or
		527	C<-rootless> mode instead, which will result in similar look&feel as the
		528	old libW11 emulation.
		529
		530	At the time of this writing, cygwin didn't seem to support any multi-byte
		531	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		532	to 8-bit encodings.
331		533
332	=item How does rxvt-unicode determine the encoding to use?	534	=item How does rxvt-unicode determine the encoding to use?
333		535
334	=item Is there an option to switch encodings?	536	=item Is there an option to switch encodings?
335		537
…		…
414	=item My input method wants <some encoding> but I want UTF-8, what can I do?	616	=item My input method wants <some encoding> but I want UTF-8, what can I do?
415		617
416	You can specify separate locales for the input method and the rest of the	618	You can specify separate locales for the input method and the rest of the
417	terminal, using the resource C<imlocale>:	619	terminal, using the resource C<imlocale>:
418		620
419	URxvt*imlocale: ja_JP.EUC-JP	621	URxvt.imlocale: ja_JP.EUC-JP
420		622
421	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	623	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
422	use your input method. Please note, however, that you will not be able to	624	use your input method. Please note, however, that you will not be able to
423	input characters outside C<EUC-JP> in a normal way then, as your input	625	input characters outside C<EUC-JP> in a normal way then, as your input
424	method limits you.	626	method limits you.
…		…
451		653
452	=item Can I speed up Xft rendering somehow?	654	=item Can I speed up Xft rendering somehow?
453		655
454	Yes, the most obvious way to speed it up is to avoid Xft entirely, as	656	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455	it is simply slow. If you still want Xft fonts you might try to disable	657	it is simply slow. If you still want Xft fonts you might try to disable
456	antialiasing (by appending C<:antialiasing=false>), which saves lots of	658	antialiasing (by appending C<:antialias=false>), which saves lots of
457	memory and also speeds up rendering considerably.	659	memory and also speeds up rendering considerably.
458		660
459	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?	661	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460		662
461	Rxvt-unicode will use whatever you specify as a font. If it needs to	663	Rxvt-unicode will use whatever you specify as a font. If it needs to
…		…
470		672
471	Make sure that mouse reporting is actually turned off since killing	673	Make sure that mouse reporting is actually turned off since killing
472	some editors prematurely may leave the mouse in mouse report mode. I've	674	some editors prematurely may leave the mouse in mouse report mode. I've
473	heard that tcsh may use mouse reporting unless it otherwise specified. A	675	heard that tcsh may use mouse reporting unless it otherwise specified. A
474	quick check is to see if cut/paste works when the Alt or Shift keys are	676	quick check is to see if cut/paste works when the Alt or Shift keys are
475	depressed. See @@RXVT_NAME@@(7)	677	depressed.
476		678
477	=item What's with this bold/blink stuff?	679	=item What's with this bold/blink stuff?
478		680
479	If no bold colour is set via C<colorBD:>, bold will invert text using the	681	If no bold colour is set via C<colorBD:>, bold will invert text using the
480	standard foreground colour.	682	standard foreground colour.
…		…
539	URxvt.color7: #e1dddd	741	URxvt.color7: #e1dddd
540	URxvt.color15: #e1dddd	742	URxvt.color15: #e1dddd
541		743
542	=item How can I start @@RXVT_NAME@@d in a race-free way?	744	=item How can I start @@RXVT_NAME@@d in a race-free way?
543		745
544	Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a	746	Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
545	server that answers @@RXVT_NAME@@c's requests, so it doesn't background	747	display, create the listening socket and then fork.
546	itself.
547
548	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
549	following method to wait for the startup message before continuing:
550
551	{ @@RXVT_NAME@@d & } \| read
552		748
553	=item What's with the strange Backspace/Delete key behaviour?	749	=item What's with the strange Backspace/Delete key behaviour?
554		750
555	Assuming that the physical Backspace key corresponds to the	751	Assuming that the physical Backspace key corresponds to the
556	BackSpace keysym (not likely for Linux ... see the following	752	BackSpace keysym (not likely for Linux ... see the following
…		…
575		771
576	# use Backspace = ^?	772	# use Backspace = ^?
577	$ stty erase ^?	773	$ stty erase ^?
578	$ @@RXVT_NAME@@	774	$ @@RXVT_NAME@@
579		775
580	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	776	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
581		777
582	For an existing rxvt-unicode:	778	For an existing rxvt-unicode:
583		779
584	# use Backspace = ^H	780	# use Backspace = ^H
585	$ stty erase ^H	781	$ stty erase ^H
…		…
703		899
704	=head1 DESCRIPTION	900	=head1 DESCRIPTION
705		901
706	The rest of this document describes various technical aspects of	902	The rest of this document describes various technical aspects of
707	B<rxvt-unicode>. First the description of supported command sequences,	903	B<rxvt-unicode>. First the description of supported command sequences,
708	followed by menu and pixmap support and last by a description of all	904	followed by pixmap support and last by a description of all features
709	features selectable at C<configure> time.	905	selectable at C<configure> time.
710		906
711	=head1 Definitions	907	=head1 Definitions
712		908
713	=over 4	909	=over 4
714		910
…		…
1282	B<< C<h> >> Send Mouse X & Y on button press.	1478	B<< C<h> >> Send Mouse X & Y on button press.
1283	B<< C<l> >> No mouse reporting.	1479	B<< C<l> >> No mouse reporting.
1284		1480
1285	=end table	1481	=end table
1286		1482
1287	=item B<< C<Ps = 10> >> (B<rxvt>)
1288
1289	=begin table
1290
1291	B<< C<h> >> menuBar visible
1292	B<< C<l> >> menuBar invisible
1293
1294	=end table
1295
1296	=item B<< C<Ps = 25> >>	1483	=item B<< C<Ps = 25> >>
1297		1484
1298	=begin table	1485	=begin table
1299		1486
1300	B<< C<h> >> Visible cursor {cnorm/cvvis}	1487	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1413		1600
1414	=begin table	1601	=begin table
1415		1602
1416	B<< C<h> >> Scroll to bottom when a key is pressed	1603	B<< C<h> >> Scroll to bottom when a key is pressed
1417	B<< C<l> >> Don't scroll to bottom when a key is pressed	1604	B<< C<l> >> Don't scroll to bottom when a key is pressed
		1605
		1606	=end table
		1607
		1608	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1609
		1610	=begin table
		1611
		1612	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1613	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1418		1614
1419	=end table	1615	=end table
1420		1616
1421	=item B<< C<Ps = 1047> >>	1617	=item B<< C<Ps = 1047> >>
1422		1618
…		…
1471	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1667	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1472	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1668	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1473	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1669	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1474	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1670	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1475	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1671	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1476	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1672	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1477	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1673	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1478	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1674	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1479	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>	1675	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1480	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1676	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1481	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	1677	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1482	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> >>	1678	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> >>
1483	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1679	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1484	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)	1680	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).
1485	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1486	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1681	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>	1682	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1683	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1684	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1488	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	1685	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1686	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1490	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1687	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1491	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1688	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1689	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1690	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1691	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1492		1692
1493	=end table	1693	=end table
1494		1694
1495	=back	1695	=back
1496		1696
1497	X<menuBar>
1498
1499	=head1 menuBar
1500
1501	B<< The exact syntax used is I<almost> solidified. >>
1502	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1503	menuBar.
1504
1505	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1506	omitted: use B<./> to specify a menu relative to the current menu.
1507
1508	=head2 Overview of menuBar operation
1509
1510	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1511	of C<Pt> can be used for a variety of tasks:
1512
1513	At the top level is the current menuBar which is a member of a circular
1514	linked-list of other such menuBars.
1515
1516	The menuBar acts as a parent for the various drop-down menus, which in
1517	turn, may have labels, separator lines, menuItems and subMenus.
1518
1519	The menuItems are the useful bits: you can use them to mimic keyboard
1520	input or even to send text or escape sequences back to rxvt.
1521
1522	The menuBar syntax is intended to provide a simple yet robust method of
1523	constructing and manipulating menus and navigating through the
1524	menuBars.
1525
1526	The first step is to use the tag B<< [menu:I<name>] >> which creates
1527	the menuBar called I<name> and allows access. You may now or menus,
1528	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1529	menuBar access as B<readonly> to prevent accidental corruption of the
1530	menus. To re-access the current menuBar for alterations, use the tag
1531	B<[menu]>, make the alterations and then use B<[done]>
1532
1533	X<menuBarCommands>
1534
1535	=head2 Commands
1536
1537	=over 4
1538
1539	=item B<< [menu:+I<name>] >>
1540
1541	access the named menuBar for creation or alteration. If a new menuBar
1542	is created, it is called I<name> (max of 15 chars) and the current
1543	menuBar is pushed onto the stack
1544
1545	=item B<[menu]>
1546
1547	access the current menuBar for alteration
1548
1549	=item B<< [title:+I<string>] >>
1550
1551	set the current menuBar's title to I<string>, which may contain the
1552	following format specifiers:
1553	B<%%> : literal B<%> character
1554	B<%n> : rxvt name (as per the B<-name> command-line option)
1555	B<%v> : rxvt version
1556
1557	=item B<[done]>
1558
1559	set menuBar access as B<readonly>.
1560	End-of-file tag for B<< [read:+I<file>] >> operations.
1561
1562	=item B<< [read:+I<file>] >>
1563
1564	read menu commands directly from I<file> (extension ".menu" will be
1565	appended if required.) Start reading at a line with B<[menu]> or B<<
1566	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1567
1568	Blank and comment lines (starting with B<#>) are ignored. Actually,
1569	since any invalid menu commands are also ignored, almost anything could
1570	be construed as a comment line, but this may be tightened up in the
1571	future ... so don't count on it!.
1572
1573	=item B<< [read:+I<file>;+I<name>] >>
1574
1575	The same as B<< [read:+I<file>] >>, but start reading at a line with
1576	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1577	B<[done]> is encountered.
1578
1579	=item B<[dump]>
1580
1581	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1582	later rereading.
1583
1584	=item B<[rm:name]>
1585
1586	remove the named menuBar
1587
1588	=item B<[rm] [rm:]>
1589
1590	remove the current menuBar
1591
1592	=item B<[rm] [rm:]>
1593
1594	remove all menuBars
1595
1596	=item B<[swap]>
1597
1598	swap the top two menuBars
1599
1600	=item B<[prev]>
1601
1602	access the previous menuBar
1603
1604	=item B<[next]>
1605
1606	access the next menuBar
1607
1608	=item B<[show]>
1609
1610	Enable display of the menuBar
1611
1612	=item B<[hide]>
1613
1614	Disable display of the menuBar
1615
1616	=item B<< [pixmap:+I<name>] >>
1617
1618	=item B<< [pixmap:+I<name>;I<scaling>] >>
1619
1620	(set the background pixmap globally
1621
1622	B<< A Future implementation I<may> make this local to the menubar >>)
1623
1624	=item B<< [:+I<command>:] >>
1625
1626	ignore the menu readonly status and issue a I<command> to or a menu or
1627	menuitem or change the ; a useful shortcut for setting the quick arrows
1628	from a menuBar.
1629
1630	=back
1631
1632	X<menuBarAdd>
1633
1634	=head2 Adding and accessing menus
1635
1636	The following commands may also be B<+> prefixed.
1637
1638	=over 4
1639
1640	=item B</+>
1641
1642	access menuBar top level
1643
1644	=item B<./+>
1645
1646	access current menu level
1647
1648	=item B<../+>
1649
1650	access parent menu (1 level up)
1651
1652	=item B<../../>
1653
1654	access parent menu (multiple levels up)
1655
1656	=item B<< I</path/>menu >>
1657
1658	add/access menu
1659
1660	=item B<< I</path/>menu/* >>
1661
1662	add/access menu and clear it if it exists
1663
1664	=item B<< I</path/>{-} >>
1665
1666	add separator
1667
1668	=item B<< I</path/>{item} >>
1669
1670	add B<item> as a label
1671
1672	=item B<< I</path/>{item} action >>
1673
1674	add/alter I<menuitem> with an associated I<action>
1675
1676	=item B<< I</path/>{item}{right-text} >>
1677
1678	add/alter I<menuitem> with B<right-text> as the right-justified text
1679	and as the associated I<action>
1680
1681	=item B<< I</path/>{item}{rtext} action >>
1682
1683	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1684	the right-justified text.
1685
1686	=back
1687
1688	=over 4
1689
1690	=item Special characters in I<action> must be backslash-escaped:
1691
1692	B<\a \b \E \e \n \r \t \octal>
1693
1694	=item or in control-character notation:
1695
1696	B<^@, ^A .. ^Z .. ^_, ^?>
1697
1698	=back
1699
1700	To send a string starting with a B<NUL> (B<^@>) character to the
1701	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1702	the first of which will be stripped off and the balance directed to the
1703	program. Otherwise if I<action> begins with B<NUL> followed by
1704	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1705	balance is sent back to rxvt.
1706
1707	As a convenience for the many Emacs-type editors, I<action> may start
1708	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1709	appended if missed from B<M-x> commands.
1710
1711	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1712	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1713
1714	=over 4
1715
1716	=item For example,
1717
1718	B<M-xapropos> is equivalent to B<\Exapropos\r>
1719
1720	=item and
1721
1722	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1723
1724	=back
1725
1726	The option B<< {I<right-rtext>} >> will be right-justified. In the
1727	absence of a specified action, this text will be used as the I<action>
1728	as well.
1729
1730	=over 4
1731
1732	=item For example,
1733
1734	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1735
1736	=back
1737
1738	The left label I<is> necessary, since it's used for matching, but
1739	implicitly hiding the left label (by using same name for both left and
1740	right labels), or explicitly hiding the left label (by preceeding it
1741	with a dot), makes it possible to have right-justified text only.
1742
1743	=over 4
1744
1745	=item For example,
1746
1747	B</File/{Open}{Open} Open-File-Action>
1748
1749	=item or hiding it
1750
1751	B</File/{.anylabel}{Open} Open-File-Action>
1752
1753	=back
1754
1755	X<menuBarRemove>
1756
1757	=head2 Removing menus
1758
1759	=over 4
1760
1761	=item B<< -/*+ >>
1762
1763	remove all menus from the menuBar, the same as B<[clear]>
1764
1765	=item B<< -+I</path>menu+ >>
1766
1767	remove menu
1768
1769	=item B<< -+I</path>{item}+ >>
1770
1771	remove item
1772
1773	=item B<< -+I</path>{-} >>
1774
1775	remove separator)
1776
1777	=item B<-/path/menu/*>
1778
1779	remove all items, separators and submenus from menu
1780
1781	=back
1782
1783	X<menuBarArrows>
1784
1785	=head2 Quick Arrows
1786
1787	The menus also provide a hook for I<quick arrows> to provide easier
1788	user access. If nothing has been explicitly set, the default is to
1789	emulate the curror keys. The syntax permits each arrow to be altered
1790	individually or all four at once without re-entering their common
1791	beginning/end text. For example, to explicitly associate cursor actions
1792	with the arrows, any of the following forms could be used:
1793
1794	=over 4
1795
1796	=item B<< <r>+I<Right> >>
1797
1798	=item B<< <l>+I<Left> >>
1799
1800	=item B<< <u>+I<Up> >>
1801
1802	=item B<< <d>+I<Down> >>
1803
1804	Define actions for the respective arrow buttons
1805
1806	=item B<< <b>+I<Begin> >>
1807
1808	=item B<< <e>+I<End> >>
1809
1810	Define common beginning/end parts for I<quick arrows> which used in
1811	conjunction with the above <r> <l> <u> <d> constructs
1812
1813	=back
1814
1815	=over 4
1816
1817	=item For example, define arrows individually,
1818
1819	<u>\E[A
1820
1821	<d>\E[B
1822
1823	<r>\E[C
1824
1825	<l>\E[D
1826
1827	=item or all at once
1828
1829	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1830
1831	=item or more compactly (factoring out common parts)
1832
1833	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1834
1835	=back
1836
1837	X<menuBarSummary>
1838
1839	=head2 Command Summary
1840
1841	A short summary of the most I<common> commands:
1842
1843	=over 4
1844
1845	=item [menu:name]
1846
1847	use an existing named menuBar or start a new one
1848
1849	=item [menu]
1850
1851	use the current menuBar
1852
1853	=item [title:string]
1854
1855	set menuBar title
1856
1857	=item [done]
1858
1859	set menu access to readonly and, if reading from a file, signal EOF
1860
1861	=item [done:name]
1862
1863	if reading from a file using [read:file;name] signal EOF
1864
1865	=item [rm:name]
1866
1867	remove named menuBar(s)
1868
1869	=item [rm] [rm:]
1870
1871	remove current menuBar
1872
1873	=item [rm] [rm:]
1874
1875	remove all menuBar(s)
1876
1877	=item [swap]
1878
1879	swap top two menuBars
1880
1881	=item [prev]
1882
1883	access the previous menuBar
1884
1885	=item [next]
1886
1887	access the next menuBar
1888
1889	=item [show]
1890
1891	map menuBar
1892
1893	=item [hide]
1894
1895	unmap menuBar
1896
1897	=item [pixmap;file]
1898
1899	=item [pixmap;file;scaling]
1900
1901	set a background pixmap
1902
1903	=item [read:file]
1904
1905	=item [read:file;name]
1906
1907	read in a menu from a file
1908
1909	=item [dump]
1910
1911	dump out all menuBars to /tmp/rxvt-PID
1912
1913	=item /
1914
1915	access menuBar top level
1916
1917	=item ./
1918
1919	=item ../
1920
1921	=item ../../
1922
1923	access current or parent menu level
1924
1925	=item /path/menu
1926
1927	add/access menu
1928
1929	=item /path/{-}
1930
1931	add separator
1932
1933	=item /path/{item}{rtext} action
1934
1935	add/alter menu item
1936
1937	=item -/*
1938
1939	remove all menus from the menuBar
1940
1941	=item -/path/menu
1942
1943	remove menu items, separators and submenus from menu
1944
1945	=item -/path/menu
1946
1947	remove menu
1948
1949	=item -/path/{item}
1950
1951	remove item
1952
1953	=item -/path/{-}
1954
1955	remove separator
1956
1957	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1958
1959	menu quick arrows
1960
1961	=back
1962	X<XPM>	1697	X<XPM>
1963		1698
1964	=head1 XPM	1699	=head1 XPM
1965		1700
1966	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1701	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2152	=end table	1887	=end table
2153		1888
2154	=head1 CONFIGURE OPTIONS	1889	=head1 CONFIGURE OPTIONS
2155		1890
2156	General hint: if you get compile errors, then likely your configuration	1891	General hint: if you get compile errors, then likely your configuration
2157	hasn't been tested well. Either try with --enable-everything or use the	1892	hasn't been tested well. Either try with C<--enable-everything> or use
2158	./reconf script as a base for experiments. ./reconf is used by myself,	1893	the F<./reconf> script as a base for experiments. F<./reconf> is used by
2159	so it should generally be a working config. Of course, you should always	1894	myself, so it should generally be a working config. Of course, you should
2160	report when a combination doesn't work, so it can be fixed. Marc Lehmann	1895	always report when a combination doesn't work, so it can be fixed. Marc
2161	<rxvt@schmorp.de>.	1896	Lehmann <rxvt@schmorp.de>.
		1897
		1898	All
2162		1899
2163	=over 4	1900	=over 4
2164		1901
2165	=item --enable-everything	1902	=item --enable-everything
2166		1903
2167	Add support for all non-multichoice options listed in "./configure	1904	Add (or remove) support for all non-multichoice options listed in "./configure
2168	--help". Note that unlike other enable options this is order dependant.	1905	--help".
		1906
2169	You can specify this and then disable options which this enables by	1907	You can specify this and then disable options you do not like by
2170	I<following> this with the appropriate commands.	1908	I<following> this with the appropriate C<--disable-...> arguments,
		1909	or you can start with a minimal configuration by specifying
		1910	C<--disable-everything> and than adding just the C<--enable-...> arguments
		1911	you want.
2171		1912
2172	=item --enable-xft	1913	=item --enable-xft (default: enabled)
2173		1914
2174	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	1915	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2175	slower and require lots of memory, but as long as you don't use them, you	1916	slower and require lots of memory, but as long as you don't use them, you
2176	don't pay for them.	1917	don't pay for them.
2177		1918
2178	=item --enable-font-styles	1919	=item --enable-font-styles (default: on)
2179		1920
2180	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	1921	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2181	styles. The fonts can be set manually or automatically.	1922	styles. The fonts can be set manually or automatically.
2182		1923
2183	=item --with-codesets=NAME,...	1924	=item --with-codesets=NAME,... (default: all)
2184		1925
2185	Compile in support for additional codeset (encoding) groups (eu, vn are	1926	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2186	always compiled in, which includes most 8-bit character sets). These	1927	are always compiled in, which includes most 8-bit character sets). These
2187	codeset tables are currently only used for driving X11 core fonts, they	1928	codeset tables are used for driving X11 core fonts, they are not required
2188	are not required for Xft fonts. Compiling them in will make your binary	1929	for Xft fonts, although having them compiled in lets rxvt-unicode choose
2189	bigger (together about 700kB), but it doesn't increase memory usage unless	1930	replacement fonts more intelligently. Compiling them in will make your
		1931	binary bigger (all of together cost about 700kB), but it doesn't increase
2190	you use an X11 font requiring one of these encodings.	1932	memory usage unless you use a font requiring one of these encodings.
2191		1933
2192	=begin table	1934	=begin table
2193		1935
2194	all all available codeset groups	1936	all all available codeset groups
2195	zh common chinese encodings	1937	zh common chinese encodings
…		…
2198	jp_ext rarely used but big japanese encodings	1940	jp_ext rarely used but big japanese encodings
2199	kr korean encodings	1941	kr korean encodings
2200		1942
2201	=end table	1943	=end table
2202		1944
2203	=item --enable-xim	1945	=item --enable-xim (default: on)
2204		1946
2205	Add support for XIM (X Input Method) protocol. This allows using	1947	Add support for XIM (X Input Method) protocol. This allows using
2206	alternative input methods (e.g. kinput2) and will also correctly	1948	alternative input methods (e.g. kinput2) and will also correctly
2207	set up the input for people using dead keys or compose keys.	1949	set up the input for people using dead keys or compose keys.
2208		1950
2209	=item --enable-unicode3	1951	=item --enable-unicode3 (default: off)
2210		1952
2211	Enable direct support for displaying unicode codepoints above	1953	Enable direct support for displaying unicode codepoints above
2212	65535 (the basic multilingual page). This increases storage	1954	65535 (the basic multilingual page). This increases storage
2213	requirements per character from 2 to 4 bytes. X11 fonts do not yet	1955	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2214	support these extra characters, but Xft does.	1956	support these extra characters, but Xft does.
…		…
2217	even without this flag, but the number of such characters is	1959	even without this flag, but the number of such characters is
2218	limited to a view thousand (shared with combining characters,	1960	limited to a view thousand (shared with combining characters,
2219	see next switch), and right now rxvt-unicode cannot display them	1961	see next switch), and right now rxvt-unicode cannot display them
2220	(input/output and cut&paste still work, though).	1962	(input/output and cut&paste still work, though).
2221		1963
2222	=item --enable-combining	1964	=item --enable-combining (default: on)
2223		1965
2224	Enable automatic composition of combining characters into	1966	Enable automatic composition of combining characters into
2225	composite characters. This is required for proper viewing of text	1967	composite characters. This is required for proper viewing of text
2226	where accents are encoded as seperate unicode characters. This is	1968	where accents are encoded as seperate unicode characters. This is
2227	done by using precomposited characters when available or creating	1969	done by using precomposited characters when available or creating
2228	new pseudo-characters when no precomposed form exists.	1970	new pseudo-characters when no precomposed form exists.
2229		1971
2230	Without --enable-unicode3, the number of additional precomposed	1972	Without --enable-unicode3, the number of additional precomposed characters
2231	characters is rather limited (2048, if this is full, rxvt will use the	1973	is rather limited (2048, if this is full, rxvt-unicode will use the
2232	private use area, extending the number of combinations to 8448). With	1974	private use area, extending the number of combinations to 8448). With
2233	--enable-unicode3, no practical limit exists. This will also enable	1975	--enable-unicode3, no practical limit exists.
2234	storage of characters >65535.	1976
		1977	This option will also enable storage (but not display) of characters
		1978	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2235		1979
2236	The combining table also contains entries for arabic presentation forms,	1980	The combining table also contains entries for arabic presentation forms,
2237	but these are not currently used. Bug me if you want these to be used.	1981	but these are not currently used. Bug me if you want these to be used (and
		1982	tell me how these are to be used...).
2238		1983
2239	=item --enable-fallback(=CLASS)	1984	=item --enable-fallback(=CLASS) (default: Rxvt)
2240		1985
2241	When reading resource settings, also read settings for class CLASS	1986	When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2242	(default: Rxvt). To disable resource fallback use --disable-fallback.
2243		1987
2244	=item --with-res-name=NAME	1988	=item --with-res-name=NAME (default: urxvt)
2245		1989
2246	Use the given name (default: urxvt) as default application name when	1990	Use the given name as default application name when
2247	reading resources. Specify --with-res-name=rxvt to replace rxvt.	1991	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2248		1992
2249	=item --with-res-class=CLASS	1993	=item --with-res-class=CLASS /default: URxvt)
2250		1994
2251	Use the given class (default: URxvt) as default application class	1995	Use the given class as default application class
2252	when reading resources. Specify --with-res-class=Rxvt to replace	1996	when reading resources. Specify --with-res-class=Rxvt to replace
2253	rxvt.	1997	rxvt.
2254		1998
2255	=item --enable-utmp	1999	=item --enable-utmp (default: on)
2256		2000
2257	Write user and tty to utmp file (used by programs like F<w>) at	2001	Write user and tty to utmp file (used by programs like F<w>) at
2258	start of rxvt execution and delete information when rxvt exits.	2002	start of rxvt execution and delete information when rxvt exits.
2259		2003
2260	=item --enable-wtmp	2004	=item --enable-wtmp (default: on)
2261		2005
2262	Write user and tty to wtmp file (used by programs like F<last>) at	2006	Write user and tty to wtmp file (used by programs like F<last>) at
2263	start of rxvt execution and write logout when rxvt exits. This	2007	start of rxvt execution and write logout when rxvt exits. This
2264	option requires --enable-utmp to also be specified.	2008	option requires --enable-utmp to also be specified.
2265		2009
2266	=item --enable-lastlog	2010	=item --enable-lastlog (default: on)
2267		2011
2268	Write user and tty to lastlog file (used by programs like	2012	Write user and tty to lastlog file (used by programs like
2269	F<lastlogin>) at start of rxvt execution. This option requires	2013	F<lastlogin>) at start of rxvt execution. This option requires
2270	--enable-utmp to also be specified.	2014	--enable-utmp to also be specified.
2271		2015
2272	=item --enable-xpm-background	2016	=item --enable-xpm-background (default: on)
2273		2017
2274	Add support for XPM background pixmaps.	2018	Add support for XPM background pixmaps.
2275		2019
2276	=item --enable-transparency	2020	=item --enable-transparency (default: on)
2277		2021
2278	Add support for inheriting parent backgrounds thus giving a fake	2022	Add support for inheriting parent backgrounds thus giving a fake
2279	transparency to the term.	2023	transparency to the term.
2280		2024
2281	=item --enable-fading	2025	=item --enable-fading (default: on)
2282		2026
2283	Add support for fading the text when focus is lost.	2027	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2284		2028
2285	=item --enable-tinting	2029	=item --enable-tinting (default: on)
2286		2030
2287	Add support for tinting of transparent backgrounds.	2031	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2288		2032
2289	=item --enable-menubar
2290
2291	Add support for our menu bar system (this interacts badly with
2292	dynamic locale switching currently).
2293
2294	=item --enable-rxvt-scroll	2033	=item --enable-rxvt-scroll (default: on)
2295		2034
2296	Add support for the original rxvt scrollbar.	2035	Add support for the original rxvt scrollbar.
2297		2036
2298	=item --enable-next-scroll	2037	=item --enable-next-scroll (default: on)
2299		2038
2300	Add support for a NeXT-like scrollbar.	2039	Add support for a NeXT-like scrollbar.
2301		2040
2302	=item --enable-xterm-scroll	2041	=item --enable-xterm-scroll (default: on)
2303		2042
2304	Add support for an Xterm-like scrollbar.	2043	Add support for an Xterm-like scrollbar.
2305		2044
2306	=item --enable-plain-scroll	2045	=item --enable-plain-scroll (default: on)
2307		2046
2308	Add support for a very unobtrusive, plain-looking scrollbar that	2047	Add support for a very unobtrusive, plain-looking scrollbar that
2309	is the favourite of the rxvt-unicode author, having used it for	2048	is the favourite of the rxvt-unicode author, having used it for
2310	many years.	2049	many years.
2311		2050
2312	=item --enable-half-shadow	2051	=item --enable-ttygid (default: off)
2313
2314	Make shadows on the scrollbar only half the normal width & height.
2315	only applicable to rxvt scrollbars.
2316
2317	=item --enable-ttygid
2318		2052
2319	Change tty device setting to group "tty" - only use this if	2053	Change tty device setting to group "tty" - only use this if
2320	your system uses this type of security.	2054	your system uses this type of security.
2321		2055
2322	=item --disable-backspace-key	2056	=item --disable-backspace-key
2323		2057
2324	Disable any handling of the backspace key by us - let the X server	2058	Removes any handling of the backspace key by us - let the X server do it.
		2059
		2060	=item --disable-delete-key
		2061
		2062	Removes any handling of the delete key by us - let the X server
2325	do it.	2063	do it.
2326		2064
2327	=item --disable-delete-key
2328
2329	Disable any handling of the delete key by us - let the X server
2330	do it.
2331
2332	=item --disable-resources	2065	=item --disable-resources
2333		2066
2334	Remove all resources checking.	2067	Removes any support for resource checking.
2335
2336	=item --enable-xgetdefault
2337
2338	Make resources checking via XGetDefault() instead of our small
2339	version which only checks ~/.Xdefaults, or if that doesn't exist then
2340	~/.Xresources.
2341
2342	Please note that nowadays, things like XIM will automatically pull in and
2343	use the full X resource manager, so the overhead of using it might be very
2344	small, if nonexistant.
2345
2346	=item --enable-strings
2347
2348	Add support for our possibly faster memset() function and other
2349	various routines, overriding your system's versions which may
2350	have been hand-crafted in assembly or may require extra libraries
2351	to link in. (this breaks ANSI-C rules and has problems on many
2352	GNU/Linux systems).
2353		2068
2354	=item --disable-swapscreen	2069	=item --disable-swapscreen
2355		2070
2356	Remove support for swap screen.	2071	Remove support for secondary/swap screen.
2357		2072
2358	=item --enable-frills	2073	=item --enable-frills (default: on)
2359		2074
2360	Add support for many small features that are not essential but nice to	2075	Add support for many small features that are not essential but nice to
2361	have. Normally you want this, but for very small binaries you may want to	2076	have. Normally you want this, but for very small binaries you may want to
2362	disable this.	2077	disable this.
2363		2078
2364	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2079	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2365	in combination with other switches) is:	2080	in combination with other switches) is:
2366		2081
2367	MWM-hints	2082	MWM-hints
		2083	EWMH-hints (pid, utf8 names) and protocols (ping)
2368	seperate underline colour	2084	seperate underline colour (-underlineColor)
2369	settable border widths and borderless switch	2085	settable border widths and borderless switch (-w, -b, -bl)
2370	settable extra linespacing	2086	settable extra linespacing /-lsp)
2371	extra window properties (e.g. UTF-8 window names and PID)
2372	iso-14755-2 and -3, and visual feedback	2087	iso-14755-2 and -3, and visual feedback
2373	backindex and forwardindex escape sequence	2088	backindex and forwardindex escape sequence
2374	window op and locale change escape sequences	2089	window op and some xterm/OSC escape sequences
2375	tripleclickwords	2090	tripleclickwords (-tcw)
2376	settable insecure mode	2091	settable insecure mode (-insecure)
2377	keysym remapping support	2092	keysym remapping support
		2093	cursor blinking and underline cursor (-cb, -uc)
		2094	XEmbed support (-embed)
		2095	user-pty (-pty-fd)
		2096	hold on exit (-hold)
		2097	skip builtin block graphics (-sbg)
		2098	sgr modes 90..97 and 100..107
2378		2099
2379	=item --enable-iso14755	2100	=item --enable-iso14755 (default: on)
2380		2101
2381	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2102	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2382	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2103	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2383	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2104	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2384	this switch.	2105	this switch.
2385		2106
2386	=item --enable-keepscrolling	2107	=item --enable-keepscrolling (default: on)
2387		2108
2388	Add support for continual scrolling of the display when you hold	2109	Add support for continual scrolling of the display when you hold
2389	the mouse button down on a scrollbar arrow.	2110	the mouse button down on a scrollbar arrow.
2390		2111
2391	=item --enable-mousewheel	2112	=item --enable-mousewheel (default: on)
2392		2113
2393	Add support for scrolling via mouse wheel or buttons 4 & 5.	2114	Add support for scrolling via mouse wheel or buttons 4 & 5.
2394		2115
2395	=item --enable-slipwheeling	2116	=item --enable-slipwheeling (default: on)
2396		2117
2397	Add support for continual scrolling (using the mouse wheel as an	2118	Add support for continual scrolling (using the mouse wheel as an
2398	accelerator) while the control key is held down. This option	2119	accelerator) while the control key is held down. This option
2399	requires --enable-mousewheel to also be specified.	2120	requires --enable-mousewheel to also be specified.
2400		2121
2401	=item --disable-new-selection	2122	=item --disable-new-selection
2402		2123
2403	Remove support for mouse selection style like that of xterm.	2124	Remove support for mouse selection style like that of xterm.
2404		2125
2405	=item --enable-dmalloc	2126	=item --enable-dmalloc (default: off)
2406		2127
2407	Use Gray Watson's malloc - which is good for debugging See	2128	Use Gray Watson's malloc - which is good for debugging See
2408	http://www.letters.com/dmalloc/ for details If you use either this or the	2129	http://www.letters.com/dmalloc/ for details If you use either this or the
2409	next option, you may need to edit src/Makefile after compiling to point	2130	next option, you may need to edit src/Makefile after compiling to point
2410	DINCLUDE and DLIB to the right places.	2131	DINCLUDE and DLIB to the right places.
2411		2132
2412	You can only use either this option and the following (should	2133	You can only use either this option and the following (should
2413	you use either) .	2134	you use either) .
2414		2135
2415	=item --enable-dlmalloc	2136	=item --enable-dlmalloc (default: off)
2416		2137
2417	Use Doug Lea's malloc - which is good for a production version	2138	Use Doug Lea's malloc - which is good for a production version
2418	See L<http://g.oswego.edu/dl/html/malloc.html> for details.	2139	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2419		2140
2420	=item --enable-smart-resize	2141	=item --enable-smart-resize (default: on)
2421		2142
2422	Add smart growth/shrink behaviour when changing font size via from hot	2143	Add smart growth/shrink behaviour when changing font size via hot
2423	keys. This should keep in a fixed position the rxvt corner which is	2144	keys. This should keep the window corner which is closest to a corner of
2424	closest to a corner of the screen.	2145	the screen in a fixed position.
2425		2146
2426	=item --enable-cursor-blink
2427
2428	Add support for a blinking cursor.
2429
2430	=item --enable-pointer-blank	2147	=item --enable-pointer-blank (default: on)
2431		2148
2432	Add support to have the pointer disappear when typing or inactive.	2149	Add support to have the pointer disappear when typing or inactive.
2433		2150
2434	=item --with-name=NAME	2151	=item --enable-perl (default: off)
2435		2152
		2153	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2154	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2155	in F<src/perl-ext/> for the extensions that are installed by default. The
		2156	perl interpreter that is used can be specified via the C<PERL> environment
		2157	variable when running configure.
		2158
		2159	=item --with-name=NAME (default: urxvt)
		2160
2436	Set the basename for the installed binaries (default: C<urxvt>, resulting	2161	Set the basename for the installed binaries, resulting
2437	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2162	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2438	C<rxvt>.	2163	C<rxvt>.
2439		2164
2440	=item --with-term=NAME	2165	=item --with-term=NAME (default: rxvt-unicode)
2441		2166
2442	Change the environmental variable for the terminal to NAME (default	2167	Change the environmental variable for the terminal to NAME.
2443	C<rxvt-unicode>)
2444		2168
2445	=item --with-terminfo=PATH	2169	=item --with-terminfo=PATH
2446		2170
2447	Change the environmental variable for the path to the terminfo tree to	2171	Change the environmental variable for the path to the terminfo tree to
2448	PATH.	2172	PATH.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.45 by root, Sun Feb 13 11:07:57 2005 UTC vs. Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.45 by root, Sun Feb 13 11:07:57 2005 UTC vs.
Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC