ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.html (file contents):
Revision 1.17 by root, Sun Feb 20 19:45:30 2005 UTC vs.
Revision 1.52 by root, Sat Jan 28 22:16:58 2006 UTC

22 <li><a href="#values">Values</a></li> 22 <li><a href="#values">Values</a></li>
23 <li><a href="#escape_sequences">Escape Sequences</a></li> 23 <li><a href="#escape_sequences">Escape Sequences</a></li>
24 <li><a href="#csi__command_sequence_introducer__sequences">CSI (Command Sequence Introducer) Sequences</a></li> 24 <li><a href="#csi__command_sequence_introducer__sequences">CSI (Command Sequence Introducer) Sequences</a></li>
25 <li><a href="#dec_private_modes">DEC Private Modes</a></li> 25 <li><a href="#dec_private_modes">DEC Private Modes</a></li>
26 <li><a href="#xterm_operating_system_commands">XTerm Operating System Commands</a></li> 26 <li><a href="#xterm_operating_system_commands">XTerm Operating System Commands</a></li>
27 <li><a href="#menubar">menuBar</a></li>
28 <ul>
29
30 <li><a href="#overview_of_menubar_operation">Overview of menuBar operation</a></li>
31 <li><a href="#commands">Commands</a></li>
32 <li><a href="#adding_and_accessing_menus">Adding and accessing menus</a></li>
33 <li><a href="#removing_menus">Removing menus</a></li>
34 <li><a href="#quick_arrows">Quick Arrows</a></li>
35 <li><a href="#command_summary">Command Summary</a></li>
36 </ul>
37
38 <li><a href="#xpm">XPM</a></li> 27 <li><a href="#xpm">XPM</a></li>
39 <li><a href="#mouse_reporting">Mouse Reporting</a></li> 28 <li><a href="#mouse_reporting">Mouse Reporting</a></li>
40 <li><a href="#key_codes">Key Codes</a></li> 29 <li><a href="#key_codes">Key Codes</a></li>
41 <li><a href="#configure_options">CONFIGURE OPTIONS</a></li> 30 <li><a href="#configure_options">CONFIGURE OPTIONS</a></li>
42 <li><a href="#authors">AUTHORS</a></li> 31 <li><a href="#authors">AUTHORS</a></li>
73<p> 62<p>
74</p> 63</p>
75<hr /> 64<hr />
76<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 65<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
77<dl> 66<dl>
67<dt><strong><a name="item_the_new_selection_selects_pieces_that_are_too_big_">The new selection selects pieces that are too big, how can I select
68single words?</a></strong><br />
69</dt>
70<dd>
71Yes. For example, if you want to select alphanumeric words, you can use
72the following resource:
73</dd>
74<dd>
75<pre>
76 URxvt.selection.pattern-0: ([[:word:]]+)</pre>
77</dd>
78<dd>
79<p>If you click more than twice, the selection will be extended
80more and more.</p>
81</dd>
82<dd>
83<p>To get a selection that is very similar to the old code, try this pattern:</p>
84</dd>
85<dd>
86<pre>
87 URxvt.selection.pattern-0: ([^&quot;&amp;'()*,;&lt;=&gt;?@[\\\\]^`{|})]+)</pre>
88</dd>
89<dd>
90<p>Please also note that the <em>LeftClick Shift-LeftClik</em> combination also
91selects words like the old code.</p>
92</dd>
93<p></p>
94<dt><strong><a name="item_i_don_27t_like_the_new_selection_2fpopups_2fhotkey">I don't like the new selection/popups/hotkeys/perl, how do I
95change/disable it?</a></strong><br />
96</dt>
97<dd>
98You can disable the perl extension completely by setting the
99<strong>perl-ext-common</strong> resource to the empty string, which also keeps
100rxvt-unicode from initialising perl, saving memory.
101</dd>
102<dd>
103<p>If you only want to disable specific features, you first have to
104identify which perl extension is responsible. For this, read the section
105<strong>PREPACKAGED EXTENSIONS</strong> in the <code>rxvtperl(3)</code> manpage. For
106example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
107this <strong>perl-ext-common</strong> resource:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.perl-ext-common: default,-selection-popup,-option-popup</pre>
112</dd>
113<dd>
114<p>This will keep the default extensions, but disable the two popup
115extensions. Some extensions can also be configured, for example,
116scrollback search mode is triggered by <strong>M-s</strong>. You can move it to any
117other combination either by setting the <strong>searchable-scrollback</strong> resource:</p>
118</dd>
119<dd>
120<pre>
121 URxvt.searchable-scrollback: CM-s</pre>
122</dd>
123<p></p>
124<dt><strong><a name="item_isn_27t_rxvt_supposed_to_be_small_3f_don_27t_all_t">Isn't rxvt supposed to be small? Don't all those features bloat?</a></strong><br />
125</dt>
126<dd>
127I often get asked about this, and I think, no, they didn't cause extra
128bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
129that the urxvt binary is larger (due to some encoding tables always being
130compiled in), but it actually uses less memory (RSS) after startup. Even
131with <code>--disable-everything</code>, this comparison is a bit unfair, as many
132features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
133already in use in this mode.
134</dd>
135<dd>
136<pre>
137 text data bss drs rss filename
138 98398 1664 24 15695 1824 rxvt --disable-everything
139 188985 9048 66616 18222 1788 urxvt --disable-everything</pre>
140</dd>
141<dd>
142<p>When you <a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (which _is_ unfair, as this involves xft
143and full locale/XIM support which are quite bloaty inside libX11 and my
144libc), the two diverge, but not unreasnobaly so.</p>
145</dd>
146<dd>
147<pre>
148 text data bss drs rss filename
149 163431 2152 24 20123 2060 rxvt --enable-everything
150 1035683 49680 66648 29096 3680 urxvt --enable-everything</pre>
151</dd>
152<dd>
153<p>The very large size of the text section is explained by the east-asian
154encoding tables, which, if unused, take up disk space but nothing else
155and can be compiled out unless you rely on X11 core fonts that use those
156encodings. The BSS size comes from the 64k emergency buffer that my c++
157compiler allocates (but of course doesn't use unless you are out of
158memory). Also, using an xft font instead of a core font immediately adds a
159few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
160not used.</p>
161</dd>
162<dd>
163<p>Of course, due to every character using two or four bytes instead of one,
164a large scrollback buffer will ultimately make rxvt-unicode use more
165memory.</p>
166</dd>
167<dd>
168<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
169still fares rather well. And compared to some monsters like gnome-terminal
170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17143180k in daemons that stay around after exit, plus half a minute of
172startup time, including the hundreds of warnings it spits out), it fares
173extremely well *g*.</p>
174</dd>
175<p></p>
176<dt><strong><a name="item_why_c_2b_2b_2c_isn_27t_that_unportable_2fbloated_2">Why C++, isn't that unportable/bloated/uncool?</a></strong><br />
177</dt>
178<dd>
179Is this a question? :) It comes up very often. The simple answer is: I had
180to write it, and C++ allowed me to write and maintain it in a fraction
181of the time and effort (which is a scarce resource for me). Put even
182shorter: It simply wouldn't exist without C++.
183</dd>
184<dd>
185<p>My personal stance on this is that C++ is less portable than C, but in
186the case of rxvt-unicode this hardly matters, as its portability limits
187are defined by things like X11, pseudo terminals, locale support and unix
188domain sockets, which are all less portable than C++ itself.</p>
189</dd>
190<dd>
191<p>Regarding the bloat, see the above question: It's easy to write programs
192in C that use gobs of memory, an certainly possible to write programs in
193C++ that don't. C++ also often comes with large libraries, but this is
194not necessarily the case with GCC. Here is what rxvt links against on my
195system with a minimal config:</p>
196</dd>
197<dd>
198<pre>
199 libX11.so.6 =&gt; /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
200 libc.so.6 =&gt; /lib/libc.so.6 (0x00002aaaaadde000)
201 libdl.so.2 =&gt; /lib/libdl.so.2 (0x00002aaaab01d000)
202 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)</pre>
203</dd>
204<dd>
205<p>And here is rxvt-unicode:</p>
206</dd>
207<dd>
208<pre>
209 libX11.so.6 =&gt; /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
210 libgcc_s.so.1 =&gt; /lib/libgcc_s.so.1 (0x00002aaaaada2000)
211 libc.so.6 =&gt; /lib/libc.so.6 (0x00002aaaaaeb0000)
212 libdl.so.2 =&gt; /lib/libdl.so.2 (0x00002aaaab0ee000)
213 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)</pre>
214</dd>
215<dd>
216<p>No large bloated libraries (of course, none were linked in statically),
217except maybe libX11 :)</p>
218</dd>
219<p></p>
220<dt><strong><a name="item_does_it_support_tabs_2c_can_i_have_a_tabbed_rxvt_2">Does it support tabs, can I have a tabbed rxvt-unicode?</a></strong><br />
221</dt>
222<dd>
223Beginning with version 7.3, there is a perl extension that implements a
224simple tabbed terminal. It is installed by default, so any of these should
225give you tabs:
226</dd>
227<dd>
228<pre>
229 rxvt -pe tabbed</pre>
230</dd>
231<dd>
232<pre>
233 URxvt.perl-ext-common: default,tabbed</pre>
234</dd>
235<dd>
236<p>It will also work fine with tabbing functionality of many window managers
237or similar tabbing programs, and its embedding-features allow it to be
238embedded into other programs, as witnessed by <em>doc/rxvt-tabbed</em> or
239the upcoming <code>Gtk2::URxvt</code> perl module, which features a tabbed urxvt
240(murxvt) terminal as an example embedding application.</p>
241</dd>
242<p></p>
78<dt><strong><a name="item_how_do_i_know_which_rxvt_2dunicode_version_i_27m_u">How do I know which rxvt-unicode version I'm using?</a></strong><br /> 243<dt><strong><a name="item_how_do_i_know_which_rxvt_2dunicode_version_i_27m_u">How do I know which rxvt-unicode version I'm using?</a></strong><br />
79</dt> 244</dt>
80<dd> 245<dd>
81The version number is displayed with the usage (-h). Also the escape 246The version number is displayed with the usage (-h). Also the escape
82sequence <code>ESC [ 8 n</code> sets the window title to the version number. 247sequence <code>ESC [ 8 n</code> sets the window title to the version number. When
248using the rxvtc client, the version displayed is that of the
249daemon.
83</dd> 250</dd>
84<p></p> 251<p></p>
85<dt><strong><a name="item_i_am_using_debian_gnu_2flinux_and_have_a_problem_2">I am using Debian GNU/Linux and have a problem...</a></strong><br /> 252<dt><strong><a name="item_i_am_using_debian_gnu_2flinux_and_have_a_problem_2">I am using Debian GNU/Linux and have a problem...</a></strong><br />
86</dt> 253</dt>
87<dd> 254<dd>
88The Debian GNU/Linux package of rxvt-unicode contains large patches that 255The Debian GNU/Linux package of rxvt-unicode in sarge contains large
89considerably change the behaviour of rxvt-unicode. Before reporting a 256patches that considerably change the behaviour of rxvt-unicode (but
257unfortunately this notice has been removed). Before reporting a bug to
90bug to the original rxvt-unicode author please download and install the 258the original rxvt-unicode author please download and install the genuine
91genuine version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) and try to 259version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) and try to reproduce
92reproduce the problem. If you cannot, chances are that the problems are 260the problem. If you cannot, chances are that the problems are specific to
93specific to Debian GNU/Linux, in which case it should be reported via the 261Debian GNU/Linux, in which case it should be reported via the Debian Bug
94Debian Bug Tracking System (use <code>reportbug</code> to report the bug). 262Tracking System (use <code>reportbug</code> to report the bug).
95</dd> 263</dd>
96<dd> 264<dd>
97<p>For other problems that also affect the Debian package, you can and 265<p>For other problems that also affect the Debian package, you can and
98probably should use the Debian BTS, too, because, after all, it's also a 266probably should use the Debian BTS, too, because, after all, it's also a
99bug in the Debian version and it serves as a reminder for other users that 267bug in the Debian version and it serves as a reminder for other users that
100might encounter the same issue.</p> 268might encounter the same issue.</p>
269</dd>
270<p></p>
271<dt><strong><a name="item_i_am_maintaining_rxvt_2dunicode_for_distribution_2">I am maintaining rxvt-unicode for distribution/OS XXX, any
272recommendation?</a></strong><br />
273</dt>
274<dd>
275You should build one binary with the default options. <em>configure</em>
276now enables most useful options, and the trend goes to making them
277runtime-switchable, too, so there is usually no drawback to enbaling them,
278except higher disk and possibly memory usage. The perl interpreter should
279be enabled, as important functionality (menus, selection, likely more in
280the future) depends on it.
281</dd>
282<dd>
283<p>You should not overwrite the <code>perl-ext-common</code> snd <code>perl-ext</code> resources
284system-wide (except maybe with <code>defaults</code>). This will result in useful
285behaviour. If your distribution aims at low memory, add an empty
286<code>perl-ext-common</code> resource to the app-defaults file. This will keep the
287perl interpreter disabled until the user enables it.</p>
288</dd>
289<dd>
290<p>If you can/want build more binaries, I recommend building a minimal
291one with <code>--disable-everything</code> (very useful) and a maximal one with
292<a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (less useful, it will be very big due to a lot of
293encodings built-in that increase download times and are rarely used).</p>
294</dd>
295<p></p>
296<dt><strong><a name="item_i_need_to_make_it_setuid_2fsetgid_to_support_utmp_">I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?</a></strong><br />
297</dt>
298<dd>
299It should be, starting with release 7.1. You are encouraged to properly
300install urxvt with privileges necessary for your OS now.
301</dd>
302<dd>
303<p>When rxvt-unicode detects that it runs setuid or setgid, it will fork
304into a helper process for privileged operations (pty handling on some
305systems, utmp/wtmp/lastlog handling on others) and drop privileges
306immediately. This is much safer than most other terminals that keep
307privileges while running (but is more relevant to urxvt, as it contains
308things as perl interpreters, which might be ``helpful'' to attackers).</p>
309</dd>
310<dd>
311<p>This forking is done as the very first within main(), which is very early
312and reduces possible bugs to initialisation code run before main(), or
313things like the dynamic loader of your system, which should result in very
314little risk.</p>
101</dd> 315</dd>
102<p></p> 316<p></p>
103<dt><strong><a name="item_when_i_log_2din_to_another_system_it_tells_me_abou">When I log-in to another system it tells me about missing terminfo data?</a></strong><br /> 317<dt><strong><a name="item_when_i_log_2din_to_another_system_it_tells_me_abou">When I log-in to another system it tells me about missing terminfo data?</a></strong><br />
104</dt> 318</dt>
105<dd> 319<dd>
135 URxvt.termName: rxvt</pre> 349 URxvt.termName: rxvt</pre>
136</dd> 350</dd>
137<dd> 351<dd>
138<p>If you don't plan to use <strong>rxvt</strong> (quite common...) you could also replace 352<p>If you don't plan to use <strong>rxvt</strong> (quite common...) you could also replace
139the rxvt terminfo file with the rxvt-unicode one.</p> 353the rxvt terminfo file with the rxvt-unicode one.</p>
354</dd>
355<p></p>
356<dt><strong><a name="item_tic_outputs_some_error_when_compiling_the_terminfo"><code>tic</code> outputs some error when compiling the terminfo entry.</a></strong><br />
357</dt>
358<dd>
359Most likely it's the empty definition for <code>enacs=</code>. Just replace it by
360<code>enacs=\E[0@</code> and try again.
140</dd> 361</dd>
141<p></p> 362<p></p>
142<dt><strong><a name="item_bash_27s_readline_does_not_work_correctly_under_rx"><code>bash</code>'s readline does not work correctly under rxvt.</a></strong><br /> 363<dt><strong><a name="item_bash_27s_readline_does_not_work_correctly_under_rx"><code>bash</code>'s readline does not work correctly under rxvt.</a></strong><br />
143</dt> 364</dt>
144<dt><strong><a name="item_i_need_a_termcap_file_entry_2e">I need a termcap file entry.</a></strong><br /> 365<dt><strong><a name="item_i_need_a_termcap_file_entry_2e">I need a termcap file entry.</a></strong><br />
371<dd> 592<dd>
372<p>All of this is not a problem when using X11 core fonts, as their bounding 593<p>All of this is not a problem when using X11 core fonts, as their bounding
373box data is correct.</p> 594box data is correct.</p>
374</dd> 595</dd>
375<p></p> 596<p></p>
597<dt><strong><a name="item_on_solaris_9_2c_many_line_2ddrawing_characters_are">On Solaris 9, many line-drawing characters are too wide.</a></strong><br />
598</dt>
599<dd>
600Seems to be a known bug, read
601<a href="http://nixdoc.net/files/forum/about34198.html">http://nixdoc.net/files/forum/about34198.html</a>. Some people use the
602following ugly workaround to get non-double-wide-characters working:
603</dd>
604<dd>
605<pre>
606 #define wcwidth(x) wcwidth(x) &gt; 1 ? 1 : wcwidth(x)</pre>
607</dd>
608<p></p>
376<dt><strong><a name="item_compose">My Compose (Multi_key) key is no longer working.</a></strong><br /> 609<dt><strong><a name="item_compose">My Compose (Multi_key) key is no longer working.</a></strong><br />
377</dt> 610</dt>
378<dd> 611<dd>
379The most common causes for this are that either your locale is not set 612The most common causes for this are that either your locale is not set
380correctly, or you specified a <strong>preeditStyle</strong> that is not supported by 613correctly, or you specified a <strong>preeditStyle</strong> that is not supported by
438<p>As you might have guessed, FreeBSD does neither define this symobl nor 671<p>As you might have guessed, FreeBSD does neither define this symobl nor
439does it support it. Instead, it uses it's own internal representation of 672does it support it. Instead, it uses it's own internal representation of
440<strong>wchar_t</strong>. This is, of course, completely fine with respect to standards.</p> 673<strong>wchar_t</strong>. This is, of course, completely fine with respect to standards.</p>
441</dd> 674</dd>
442<dd> 675<dd>
676<p>However, that means rxvt-unicode only works in <code>POSIX</code>, <code>ISO-8859-1</code> and
677<code>UTF-8</code> locales under FreeBSD (which all use Unicode as <strong>wchar_t</strong>.</p>
678</dd>
679<dd>
443<p>However, <code>__STDC_ISO_10646__</code> is the only sane way to support 680<p><code>__STDC_ISO_10646__</code> is the only sane way to support multi-language
444multi-language apps in an OS, as using a locale-dependent (and 681apps in an OS, as using a locale-dependent (and non-standardized)
445non-standardized) representation of <strong>wchar_t</strong> makes it impossible to 682representation of <strong>wchar_t</strong> makes it impossible to convert between
446convert between <strong>wchar_t</strong> (as used by X11 and your applications) and any 683<strong>wchar_t</strong> (as used by X11 and your applications) and any other encoding
447other encoding without implementing OS-specific-wrappers for each and 684without implementing OS-specific-wrappers for each and every locale. There
448every locale. There simply are no APIs to convert <strong>wchar_t</strong> into anything 685simply are no APIs to convert <strong>wchar_t</strong> into anything except the current
449except the current locale encoding.</p> 686locale encoding.</p>
450</dd> 687</dd>
451<dd> 688<dd>
452<p>Some applications (such as the formidable <strong>mlterm</strong>) work around this 689<p>Some applications (such as the formidable <strong>mlterm</strong>) work around this
453by carrying their own replacement functions for character set handling 690by carrying their own replacement functions for character set handling
454with them, and either implementing OS-dependent hacks or doing multiple 691with them, and either implementing OS-dependent hacks or doing multiple
457</dd> 694</dd>
458<dd> 695<dd>
459<p>The rxvt-unicode author insists that the right way to fix this is in the 696<p>The rxvt-unicode author insists that the right way to fix this is in the
460system libraries once and for all, instead of forcing every app to carry 697system libraries once and for all, instead of forcing every app to carry
461complete replacements for them :)</p> 698complete replacements for them :)</p>
699</dd>
700<p></p>
701<dt><strong><a name="item_i_use_solaris_9_and_it_doesn_27t_compile_2fwork_2f">I use Solaris 9 and it doesn't compile/work/etc.</a></strong><br />
702</dt>
703<dd>
704Try the diff in <em>doc/solaris9.patch</em> as a base. It fixes the worst
705problems with <code>wcwidth</code> and a compile problem.
706</dd>
707<p></p>
708<dt><strong><a name="item_how_can_i_use_rxvt_2dunicode_under_cygwin_3f">How can I use rxvt-unicode under cygwin?</a></strong><br />
709</dt>
710<dd>
711rxvt-unicode should compile and run out of the box on cygwin, using
712the X11 libraries that come with cygwin. libW11 emulation is no
713longer supported (and makes no sense, either, as it only supported a
714single font). I recommend starting the X-server in <code>-multiwindow</code> or
715<code>-rootless</code> mode instead, which will result in similar look&amp;feel as the
716old libW11 emulation.
717</dd>
718<dd>
719<p>At the time of this writing, cygwin didn't seem to support any multi-byte
720encodings (you might try <code>LC_CTYPE=C-UTF-8</code>), so you are likely limited
721to 8-bit encodings.</p>
462</dd> 722</dd>
463<p></p> 723<p></p>
464<dt><strong><a name="item_how_does_rxvt_2dunicode_determine_the_encoding_to_">How does rxvt-unicode determine the encoding to use?</a></strong><br /> 724<dt><strong><a name="item_how_does_rxvt_2dunicode_determine_the_encoding_to_">How does rxvt-unicode determine the encoding to use?</a></strong><br />
465</dt> 725</dt>
466<dt><strong><a name="item_is_there_an_option_to_switch_encodings_3f">Is there an option to switch encodings?</a></strong><br /> 726<dt><strong><a name="item_is_there_an_option_to_switch_encodings_3f">Is there an option to switch encodings?</a></strong><br />
576You can specify separate locales for the input method and the rest of the 836You can specify separate locales for the input method and the rest of the
577terminal, using the resource <code>imlocale</code>: 837terminal, using the resource <code>imlocale</code>:
578</dd> 838</dd>
579<dd> 839<dd>
580<pre> 840<pre>
581 URxvt*imlocale: ja_JP.EUC-JP</pre> 841 URxvt.imlocale: ja_JP.EUC-JP</pre>
582</dd> 842</dd>
583<dd> 843<dd>
584<p>Now you can start your terminal with <code>LC_CTYPE=ja_JP.UTF-8</code> and still 844<p>Now you can start your terminal with <code>LC_CTYPE=ja_JP.UTF-8</code> and still
585use your input method. Please note, however, that you will not be able to 845use your input method. Please note, however, that you will not be able to
586input characters outside <code>EUC-JP</code> in a normal way then, as your input 846input characters outside <code>EUC-JP</code> in a normal way then, as your input
610when used. Compiling it out ensures that no Xft font will be loaded 870when used. Compiling it out ensures that no Xft font will be loaded
611accidentally when rxvt-unicode tries to find a font for your characters. 871accidentally when rxvt-unicode tries to find a font for your characters.
612</dd> 872</dd>
613<dd> 873<dd>
614<p>Also, many people (me included) like large windows and even larger 874<p>Also, many people (me included) like large windows and even larger
615scrollback buffers: Without <a href="#item__2d_2denable_2dunicode3"><code>--enable-unicode3</code></a>, rxvt-unicode will use 875scrollback buffers: Without <code>--enable-unicode3</code>, rxvt-unicode will use
6166 bytes per screen cell. For a 160x?? window this amounts to almost a 8766 bytes per screen cell. For a 160x?? window this amounts to almost a
617kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 877kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
618use 10 Megabytes of memory. With <a href="#item__2d_2denable_2dunicode3"><code>--enable-unicode3</code></a> it gets worse, as 878use 10 Megabytes of memory. With <code>--enable-unicode3</code> it gets worse, as
619rxvt-unicode then uses 8 bytes per screen cell.</p> 879rxvt-unicode then uses 8 bytes per screen cell.</p>
620</dd> 880</dd>
621<p></p> 881<p></p>
622<dt><strong><a name="item_can_i_speed_up_xft_rendering_somehow_3f">Can I speed up Xft rendering somehow?</a></strong><br /> 882<dt><strong><a name="item_can_i_speed_up_xft_rendering_somehow_3f">Can I speed up Xft rendering somehow?</a></strong><br />
623</dt> 883</dt>
624<dd> 884<dd>
625Yes, the most obvious way to speed it up is to avoid Xft entirely, as 885Yes, the most obvious way to speed it up is to avoid Xft entirely, as
626it is simply slow. If you still want Xft fonts you might try to disable 886it is simply slow. If you still want Xft fonts you might try to disable
627antialiasing (by appending <code>:antialiasing=false</code>), which saves lots of 887antialiasing (by appending <code>:antialias=false</code>), which saves lots of
628memory and also speeds up rendering considerably. 888memory and also speeds up rendering considerably.
629</dd> 889</dd>
630<p></p> 890<p></p>
631<dt><strong><a name="item_rxvt_2dunicode_doesn_27t_seem_to_anti_2dalias_its_">Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?</a></strong><br /> 891<dt><strong><a name="item_rxvt_2dunicode_doesn_27t_seem_to_anti_2dalias_its_">Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?</a></strong><br />
632</dt> 892</dt>
646<dd> 906<dd>
647Make sure that mouse reporting is actually turned off since killing 907Make sure that mouse reporting is actually turned off since killing
648some editors prematurely may leave the mouse in mouse report mode. I've 908some editors prematurely may leave the mouse in mouse report mode. I've
649heard that tcsh may use mouse reporting unless it otherwise specified. A 909heard that tcsh may use mouse reporting unless it otherwise specified. A
650quick check is to see if cut/paste works when the Alt or Shift keys are 910quick check is to see if cut/paste works when the Alt or Shift keys are
651depressed. See <code>rxvt(7)</code> 911depressed.
652</dd> 912</dd>
653<p></p> 913<p></p>
654<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br /> 914<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br />
655</dt> 915</dt>
656<dd> 916<dd>
733</dd> 993</dd>
734<p></p> 994<p></p>
735<dt><strong><a name="item_how_can_i_start_rxvtd_in_a_race_2dfree_way_3f">How can I start rxvtd in a race-free way?</a></strong><br /> 995<dt><strong><a name="item_how_can_i_start_rxvtd_in_a_race_2dfree_way_3f">How can I start rxvtd in a race-free way?</a></strong><br />
736</dt> 996</dt>
737<dd> 997<dd>
738Despite it's name, rxvtd is not a real daemon, but more like a 998Try <code>rxvtd -f -o</code>, which tells rxvtd to open the
739server that answers rxvtc's requests, so it doesn't background 999display, create the listening socket and then fork.
740itself.
741</dd>
742<dd>
743<p>To ensure rxvtd is listening on it's socket, you can use the
744following method to wait for the startup message before continuing:</p>
745</dd>
746<dd>
747<pre>
748 { rxvtd &amp; } | read</pre>
749</dd> 1000</dd>
750<p></p> 1001<p></p>
751<dt><strong><a name="item_what_27s_with_the_strange_backspace_2fdelete_key_b">What's with the strange Backspace/Delete key behaviour?</a></strong><br /> 1002<dt><strong><a name="item_what_27s_with_the_strange_backspace_2fdelete_key_b">What's with the strange Backspace/Delete key behaviour?</a></strong><br />
752</dt> 1003</dt>
753<dd> 1004<dd>
782 # use Backspace = ^? 1033 # use Backspace = ^?
783 $ stty erase ^? 1034 $ stty erase ^?
784 $ rxvt</pre> 1035 $ rxvt</pre>
785</dd> 1036</dd>
786<dd> 1037<dd>
787<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code> as documented in rxvt(7).</p> 1038<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
788</dd> 1039</dd>
789<dd> 1040<dd>
790<p>For an existing rxvt-unicode:</p> 1041<p>For an existing rxvt-unicode:</p>
791</dd> 1042</dd>
792<dd> 1043<dd>
943</p> 1194</p>
944<hr /> 1195<hr />
945<h1><a name="description">DESCRIPTION</a></h1> 1196<h1><a name="description">DESCRIPTION</a></h1>
946<p>The rest of this document describes various technical aspects of 1197<p>The rest of this document describes various technical aspects of
947<strong>rxvt-unicode</strong>. First the description of supported command sequences, 1198<strong>rxvt-unicode</strong>. First the description of supported command sequences,
948followed by menu and pixmap support and last by a description of all 1199followed by pixmap support and last by a description of all features
949features selectable at <code>configure</code> time.</p> 1200selectable at <code>configure</code> time.</p>
950<p> 1201<p>
951</p> 1202</p>
952<hr /> 1203<hr />
953<h1><a name="definitions">Definitions</a></h1> 1204<h1><a name="definitions">Definitions</a></h1>
954<dl> 1205<dl>
1587</table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>&gt; X10 XTerm</a></strong><br /> 1838</table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>&gt; X10 XTerm</a></strong><br />
1588</dt> 1839</dt>
1589<table> 1840<table>
1590<tr><td>h</td><td>Send Mouse X & Y on button press.</td></tr> 1841<tr><td>h</td><td>Send Mouse X & Y on button press.</td></tr>
1591<tr><td>l</td><td>No mouse reporting.</td></tr> 1842<tr><td>l</td><td>No mouse reporting.</td></tr>
1592</table><dt><strong><a name="item_10"><strong><code>Ps = 10</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1593</dt>
1594<table>
1595<tr><td>h</td><td>menuBar visible</td></tr>
1596<tr><td>l</td><td>menuBar invisible</td></tr>
1597</table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>&gt;</a></strong><br /> 1843</table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>&gt;</a></strong><br />
1598</dt> 1844</dt>
1599<table> 1845<table>
1600<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr> 1846<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr>
1601<tr><td>l</td><td>Invisible cursor {civis}</td></tr> 1847<tr><td>l</td><td>Invisible cursor {civis}</td></tr>
1666</table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br /> 1912</table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1667</dt> 1913</dt>
1668<table> 1914<table>
1669<tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr> 1915<tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr>
1670<tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr> 1916<tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr>
1917</table><dt><strong><a name="item_1021"><strong><code>Ps = 1021</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1918</dt>
1919<table>
1920<tr><td>h</td><td>Bold/italic implies high intensity (see option -is)</td></tr>
1921<tr><td>l</td><td>Font styles have no effect on intensity (Compile styles)</td></tr>
1671</table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>&gt;</a></strong><br /> 1922</table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>&gt;</a></strong><br />
1672</dt> 1923</dt>
1673<table> 1924<table>
1674<tr><td>h</td><td>Use Alternate Screen Buffer</td></tr> 1925<tr><td>h</td><td>Use Alternate Screen Buffer</td></tr>
1675<tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr> 1926<tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr>
1707<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr> 1958<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr>
1708<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr> 1959<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr>
1709<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr> 1960<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr>
1710<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr> 1961<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr>
1711<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr> 1962<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr>
1712<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt</td></tr> 1963<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr>
1713<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt</td></tr> 1964<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr>
1965<tr><td>Ps = 20</td><td>Change background pixmap parameters (see section XPM) (Compile XPM).</td></tr>
1714<tr><td>Ps = 20</td><td>Change default background to Pt</td></tr> 1966<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr>
1715<tr><td>Ps = 39</td><td>Change default foreground colour to Pt rxvt compile-time option</td></tr>
1716<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr> 1967<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr>
1717<tr><td>Ps = 49</td><td>Change default background colour to Pt rxvt compile-time option</td></tr> 1968<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr>
1718<tr><td>Ps = 50</td><td>Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n</td></tr> 1969<tr><td>Ps = 50</td><td>Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n</td></tr>
1719<tr><td>Ps = 55</td><td>Log all scrollback buffer and all of screen to Pt</td></tr> 1970<tr><td>Ps = 55</td><td>Log all scrollback buffer and all of screen to Pt</td></tr>
1720<tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (rxvt extension)</td></tr> 1971<tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).</td></tr>
1721<tr><td>Ps = 703</td><td>Menubar command Pt rxvt compile-time option (rxvt-unicode extension)</td></tr> 1972<tr><td>Ps = 702</td><td>Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.</td></tr>
1722<tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr> 1973<tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr>
1723<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt</td></tr> 1974<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr>
1975<tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr>
1976<tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr>
1724<tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr> 1977<tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr>
1725<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50.</td></tr> 1978<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1726<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50.</td></tr> 1979<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1727<tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50.</td></tr> 1980<tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1981<tr><td>Ps = 720</td><td>Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr>
1982<tr><td>Ps = 721</td><td>Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr>
1983<tr><td>Ps = 777</td><td>Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).</td></tr>
1728</table><p></p></dl> 1984</table><p></p></dl>
1729<p></p> 1985<p></p>
1730<p>
1731</p>
1732<hr />
1733<h1><a name="menubar">menuBar</a></h1>
1734<p><strong>The exact syntax used is <em>almost</em> solidified. </strong>&gt;
1735In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
1736menuBar.</p>
1737<p>Note that in all of the commands, the <strong><em>/path/</em> </strong>&gt; <em>cannot</em> be
1738omitted: use <strong>./</strong> to specify a menu relative to the current menu.</p>
1739<p>
1740</p>
1741<h2><a name="overview_of_menubar_operation">Overview of menuBar operation</a></h2>
1742<p>For the menuBar XTerm escape sequence <code>ESC ] 703 ; Pt ST</code>, the syntax
1743of <a href="#item_pt"><code>Pt</code></a> can be used for a variety of tasks:</p>
1744<p>At the top level is the current menuBar which is a member of a circular
1745linked-list of other such menuBars.</p>
1746<p>The menuBar acts as a parent for the various drop-down menus, which in
1747turn, may have labels, separator lines, menuItems and subMenus.</p>
1748<p>The menuItems are the useful bits: you can use them to mimic keyboard
1749input or even to send text or escape sequences back to rxvt.</p>
1750<p>The menuBar syntax is intended to provide a simple yet robust method of
1751constructing and manipulating menus and navigating through the
1752menuBars.</p>
1753<p>The first step is to use the tag <strong>[menu:<em>name</em>] </strong>&gt; which creates
1754the menuBar called <em>name</em> and allows access. You may now or menus,
1755subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the
1756menuBar access as <strong>readonly</strong> to prevent accidental corruption of the
1757menus. To re-access the current menuBar for alterations, use the tag
1758<strong>[menu]</strong>, make the alterations and then use <strong>[done]</strong></p>
1759<p></p>
1760<p>
1761</p>
1762<h2><a name="commands">Commands</a></h2>
1763<dl>
1764<dt><strong><a name="item__5bmenu_3a_2bname_5d"><strong>[menu:+<em>name</em>] </strong>&gt;</a></strong><br />
1765</dt>
1766<dd>
1767access the named menuBar for creation or alteration. If a new menuBar
1768is created, it is called <em>name</em> (max of 15 chars) and the current
1769menuBar is pushed onto the stack
1770</dd>
1771<p></p>
1772<dt><strong><a name="item__5bmenu_5d"><strong>[menu]</strong></a></strong><br />
1773</dt>
1774<dd>
1775access the current menuBar for alteration
1776</dd>
1777<p></p>
1778<dt><strong><a name="item__5btitle_3a_2bstring_5d"><strong>[title:+<em>string</em>] </strong>&gt;</a></strong><br />
1779</dt>
1780<dd>
1781set the current menuBar's title to <em>string</em>, which may contain the
1782following format specifiers:
1783</dd>
1784<dd>
1785<pre>
1786 B&lt;%n&gt; rxvt name (as per the B&lt;-name&gt; command-line option)
1787 B&lt;%v&gt; rxvt version
1788 B&lt;%%&gt; literal B&lt;%&gt; character</pre>
1789</dd>
1790<p></p>
1791<dt><strong><a name="item__5bdone_5d"><strong>[done]</strong></a></strong><br />
1792</dt>
1793<dd>
1794set menuBar access as <strong>readonly</strong>.
1795End-of-file tag for <strong>[read:+<em>file</em>] </strong>&gt; operations.
1796</dd>
1797<p></p>
1798<dt><strong><a name="item__5bread_3a_2bfile_5d"><strong>[read:+<em>file</em>] </strong>&gt;</a></strong><br />
1799</dt>
1800<dd>
1801read menu commands directly from <em>file</em> (extension ``.menu'' will be
1802appended if required.) Start reading at a line with <strong>[menu]</strong> or <strong>&lt;
1803[menu:+<em>name</em> </strong>&gt; and continuing until <strong>[done]</strong> is encountered.
1804</dd>
1805<dd>
1806<p>Blank and comment lines (starting with <strong>#</strong>) are ignored. Actually,
1807since any invalid menu commands are also ignored, almost anything could
1808be construed as a comment line, but this may be tightened up in the
1809future ... so don't count on it!.</p>
1810</dd>
1811<p></p>
1812<dt><strong><a name="item__5bread_3a_2bfile_3b_2bname_5d"><strong>[read:+<em>file</em>;+<em>name</em>] </strong>&gt;</a></strong><br />
1813</dt>
1814<dd>
1815The same as <strong>[read:+<em>file</em>] </strong>&gt;, but start reading at a line with
1816<strong>[menu:+<em>name</em>] </strong>&gt; and continuing until <strong>[done:+<em>name</em>] </strong>&gt; or
1817<strong>[done]</strong> is encountered.
1818</dd>
1819<p></p>
1820<dt><strong><a name="item__5bdump_5d"><strong>[dump]</strong></a></strong><br />
1821</dt>
1822<dd>
1823dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable for
1824later rereading.
1825</dd>
1826<p></p>
1827<dt><strong><a name="item__5brm_3aname_5d"><strong>[rm:name]</strong></a></strong><br />
1828</dt>
1829<dd>
1830remove the named menuBar
1831</dd>
1832<p></p>
1833<dt><strong><a name="item__5brm_5d__5brm_3a_5d"><strong>[rm] [rm:]</strong></a></strong><br />
1834</dt>
1835<dd>
1836remove the current menuBar
1837</dd>
1838<p></p>
1839<dt><strong><a name="item__5brm_2a_5d__5brm_3a_2a_5d"><strong>[rm*] [rm:*]</strong></a></strong><br />
1840</dt>
1841<dd>
1842remove all menuBars
1843</dd>
1844<p></p>
1845<dt><strong><a name="item__5bswap_5d"><strong>[swap]</strong></a></strong><br />
1846</dt>
1847<dd>
1848swap the top two menuBars
1849</dd>
1850<p></p>
1851<dt><strong><a name="item__5bprev_5d"><strong>[prev]</strong></a></strong><br />
1852</dt>
1853<dd>
1854access the previous menuBar
1855</dd>
1856<p></p>
1857<dt><strong><a name="item__5bnext_5d"><strong>[next]</strong></a></strong><br />
1858</dt>
1859<dd>
1860access the next menuBar
1861</dd>
1862<p></p>
1863<dt><strong><a name="item__5bshow_5d"><strong>[show]</strong></a></strong><br />
1864</dt>
1865<dd>
1866Enable display of the menuBar
1867</dd>
1868<p></p>
1869<dt><strong><a name="item__5bhide_5d"><strong>[hide]</strong></a></strong><br />
1870</dt>
1871<dd>
1872Disable display of the menuBar
1873</dd>
1874<p></p>
1875<dt><strong><a name="item__5bpixmap_3a_2bname_5d"><strong>[pixmap:+<em>name</em>] </strong>&gt;</a></strong><br />
1876</dt>
1877<dt><strong><a name="item__5bpixmap_3a_2bname_3bscaling_5d"><strong>[pixmap:+<em>name</em>;<em>scaling</em>] </strong>&gt;</a></strong><br />
1878</dt>
1879<dd>
1880(set the background pixmap globally
1881</dd>
1882<dd>
1883<p><strong>A Future implementation <em>may</em> make this local to the menubar </strong>&gt;)</p>
1884</dd>
1885<p></p>
1886<dt><strong><a name="item__5b_3a_2bcommand_3a_5d"><strong>[:+<em>command</em>:] </strong>&gt;</a></strong><br />
1887</dt>
1888<dd>
1889ignore the menu readonly status and issue a <em>command</em> to or a menu or
1890menuitem or change the ; a useful shortcut for setting the quick arrows
1891from a menuBar.
1892</dd>
1893<p></p></dl>
1894<p></p>
1895<p>
1896</p>
1897<h2><a name="adding_and_accessing_menus">Adding and accessing menus</a></h2>
1898<p>The following commands may also be <strong>+</strong> prefixed.</p>
1899<dl>
1900<dt><strong><a name="item__2f_2b"><strong>/+</strong></a></strong><br />
1901</dt>
1902<dd>
1903access menuBar top level
1904</dd>
1905<p></p>
1906<dt><strong><a name="item__2e_2f_2b"><strong>./+</strong></a></strong><br />
1907</dt>
1908<dd>
1909access current menu level
1910</dd>
1911<p></p>
1912<dt><strong><a name="item__2e_2e_2f_2b"><strong>../+</strong></a></strong><br />
1913</dt>
1914<dd>
1915access parent menu (1 level up)
1916</dd>
1917<p></p>
1918<dt><strong><a name="item__2e_2e_2f_2e_2e_2f"><strong>../../</strong></a></strong><br />
1919</dt>
1920<dd>
1921access parent menu (multiple levels up)
1922</dd>
1923<p></p>
1924<dt><strong><a name="item__2fpath_2fmenu"><strong><em>/path/</em>menu </strong>&gt;</a></strong><br />
1925</dt>
1926<dd>
1927add/access menu
1928</dd>
1929<p></p>
1930<dt><strong><a name="item__2fpath_2fmenu_2f_2a"><strong><em>/path/</em>menu/* </strong>&gt;</a></strong><br />
1931</dt>
1932<dd>
1933add/access menu and clear it if it exists
1934</dd>
1935<p></p>
1936<dt><strong><a name="item__2fpath_2f_7b_2d_7d"><strong><em>/path/</em>{-} </strong>&gt;</a></strong><br />
1937</dt>
1938<dd>
1939add separator
1940</dd>
1941<p></p>
1942<dt><strong><a name="item__2fpath_2f_7bitem_7d"><strong><em>/path/</em>{item} </strong>&gt;</a></strong><br />
1943</dt>
1944<dd>
1945add <strong>item</strong> as a label
1946</dd>
1947<p></p>
1948<dt><strong><a name="item__2fpath_2f_7bitem_7d_action"><strong><em>/path/</em>{item} action </strong>&gt;</a></strong><br />
1949</dt>
1950<dd>
1951add/alter <em>menuitem</em> with an associated <em>action</em>
1952</dd>
1953<p></p>
1954<dt><strong><a name="item__2fpath_2f_7bitem_7d_7bright_2dtext_7d"><strong><em>/path/</em>{item}{right-text} </strong>&gt;</a></strong><br />
1955</dt>
1956<dd>
1957add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified text
1958and as the associated <em>action</em>
1959</dd>
1960<p></p>
1961<dt><strong><a name="item__2fpath_2f_7bitem_7d_7brtext_7d_action"><strong><em>/path/</em>{item}{rtext} action </strong>&gt;</a></strong><br />
1962</dt>
1963<dd>
1964add/alter <em>menuitem</em> with an associated <em>action</em> and with <strong>rtext</strong> as
1965the right-justified text.
1966</dd>
1967<p></p></dl>
1968<dl>
1969<dt><strong><a name="item_special_characters_in_action_must_be_backslash_2de">Special characters in <em>action</em> must be backslash-escaped:</a></strong><br />
1970</dt>
1971<dd>
1972<strong>\a \b \E \e \n \r \t \octal</strong>
1973</dd>
1974<p></p>
1975<dt><strong><a name="item_or_in_control_2dcharacter_notation_3a">or in control-character notation:</a></strong><br />
1976</dt>
1977<dd>
1978<strong>^@, ^A .. ^Z .. ^_, ^?</strong>
1979</dd>
1980<p></p></dl>
1981<p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the
1982program, start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>),
1983the first of which will be stripped off and the balance directed to the
1984program. Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by
1985non-+<strong>NUL</strong> characters, the leading <strong>NUL</strong> is stripped off and the
1986balance is sent back to rxvt.</p>
1987<p>As a convenience for the many Emacs-type editors, <em>action</em> may start
1988with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
1989appended if missed from <strong>M-x</strong> commands.</p>
1990<p>As a convenience for issuing XTerm <strong>ESC ]</strong> sequences from a menubar (or
1991quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.</p>
1992<dl>
1993<dt><strong><a name="item_for_example_2c">For example,</a></strong><br />
1994</dt>
1995<dd>
1996<strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong>
1997</dd>
1998<p></p>
1999<dt><strong><a name="item_and">and</a></strong><br />
2000</dt>
2001<dd>
2002<strong>\E]703;mona;100</strong> is equivalent to <strong>\E]703;mona;100\a</strong>
2003</dd>
2004<p></p></dl>
2005<p>The option <strong>{<em>right-rtext</em>} </strong>&gt; will be right-justified. In the
2006absence of a specified action, this text will be used as the <em>action</em>
2007as well.</p>
2008<dl>
2009<dt><strong>For example,</strong><br />
2010</dt>
2011<dd>
2012<strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong>
2013</dd>
2014<p></p></dl>
2015<p>The left label <em>is</em> necessary, since it's used for matching, but
2016implicitly hiding the left label (by using same name for both left and
2017right labels), or explicitly hiding the left label (by preceeding it
2018with a dot), makes it possible to have right-justified text only.</p>
2019<dl>
2020<dt><strong>For example,</strong><br />
2021</dt>
2022<dd>
2023<strong>/File/{Open}{Open} Open-File-Action</strong>
2024</dd>
2025<p></p>
2026<dt><strong><a name="item_or_hiding_it">or hiding it</a></strong><br />
2027</dt>
2028<dd>
2029<strong>/File/{.anylabel}{Open} Open-File-Action</strong>
2030</dd>
2031<p></p></dl>
2032<p></p>
2033<p>
2034</p>
2035<h2><a name="removing_menus">Removing menus</a></h2>
2036<dl>
2037<dt><strong><a name="item__2d_2f_2a_2b"><strong>-/*+ </strong>&gt;</a></strong><br />
2038</dt>
2039<dd>
2040remove all menus from the menuBar, the same as <strong>[clear]</strong>
2041</dd>
2042<p></p>
2043<dt><strong><a name="item__2d_2b_2fpathmenu_2b"><strong>-+<em>/path</em>menu+ </strong>&gt;</a></strong><br />
2044</dt>
2045<dd>
2046remove menu
2047</dd>
2048<p></p>
2049<dt><strong><a name="item__2d_2b_2fpath_7bitem_7d_2b"><strong>-+<em>/path</em>{item}+ </strong>&gt;</a></strong><br />
2050</dt>
2051<dd>
2052remove item
2053</dd>
2054<p></p>
2055<dt><strong><a name="item__2d_2b_2fpath_7b_2d_7d"><strong>-+<em>/path</em>{-} </strong>&gt;</a></strong><br />
2056</dt>
2057<dd>
2058remove separator)
2059</dd>
2060<p></p>
2061<dt><strong><a name="item__2d_2fpath_2fmenu_2f_2a"><strong>-/path/menu/*</strong></a></strong><br />
2062</dt>
2063<dd>
2064remove all items, separators and submenus from menu
2065</dd>
2066<p></p></dl>
2067<p></p>
2068<p>
2069</p>
2070<h2><a name="quick_arrows">Quick Arrows</a></h2>
2071<p>The menus also provide a hook for <em>quick arrows</em> to provide easier
2072user access. If nothing has been explicitly set, the default is to
2073emulate the curror keys. The syntax permits each arrow to be altered
2074individually or all four at once without re-entering their common
2075beginning/end text. For example, to explicitly associate cursor actions
2076with the arrows, any of the following forms could be used:</p>
2077<dl>
2078<dt><strong><a name="item__3cr_3e_2bright"><strong>&lt;r</strong>+<em>Right</em> &gt;&gt;</a></strong><br />
2079</dt>
2080<dt><strong><a name="item__3cl_3e_2bleft"><strong>&lt;l</strong>+<em>Left</em> &gt;&gt;</a></strong><br />
2081</dt>
2082<dt><strong><a name="item__3cu_3e_2bup"><strong>&lt;u</strong>+<em>Up</em> &gt;&gt;</a></strong><br />
2083</dt>
2084<dt><strong><a name="item__3cd_3e_2bdown"><strong>&lt;d</strong>+<em>Down</em> &gt;&gt;</a></strong><br />
2085</dt>
2086<dd>
2087Define actions for the respective arrow buttons
2088</dd>
2089<p></p>
2090<dt><strong><a name="item__3cb_3e_2bbegin"><strong>&lt;b</strong>+<em>Begin</em> &gt;&gt;</a></strong><br />
2091</dt>
2092<dt><strong><a name="item__3ce_3e_2bend"><strong>&lt;e</strong>+<em>End</em> &gt;&gt;</a></strong><br />
2093</dt>
2094<dd>
2095Define common beginning/end parts for <em>quick arrows</em> which used in
2096conjunction with the above &lt;r&gt; &lt;l&gt; &lt;u&gt; &lt;d&gt; constructs
2097</dd>
2098<p></p></dl>
2099<dl>
2100<dt><strong><a name="item_for_example_2c_define_arrows_individually_2c">For example, define arrows individually,</a></strong><br />
2101</dt>
2102<dd>
2103<pre>
2104 &lt;u&gt;\E[A</pre>
2105</dd>
2106<dd>
2107<pre>
2108 &lt;d&gt;\E[B</pre>
2109</dd>
2110<dd>
2111<pre>
2112 &lt;r&gt;\E[C</pre>
2113</dd>
2114<dd>
2115<pre>
2116 &lt;l&gt;\E[D</pre>
2117</dd>
2118<dt><strong><a name="item_or_all_at_once">or all at once</a></strong><br />
2119</dt>
2120<dd>
2121<pre>
2122 &lt;u&gt;\E[AZ&lt;&gt;&lt;d&gt;\E[BZ&lt;&gt;&lt;r&gt;\E[CZ&lt;&gt;&lt;l&gt;\E[D</pre>
2123</dd>
2124<dt><strong><a name="item_compactly">or more compactly (factoring out common parts)</a></strong><br />
2125</dt>
2126<dd>
2127<pre>
2128 &lt;b&gt;\E[&lt;u&gt;AZ&lt;&gt;&lt;d&gt;BZ&lt;&gt;&lt;r&gt;CZ&lt;&gt;&lt;l&gt;D</pre>
2129</dd>
2130</dl>
2131<p></p>
2132<p>
2133</p>
2134<h2><a name="command_summary">Command Summary</a></h2>
2135<p>A short summary of the most <em>common</em> commands:</p>
2136<dl>
2137<dt><strong><a name="item__5bmenu_3aname_5d">[menu:name]</a></strong><br />
2138</dt>
2139<dd>
2140use an existing named menuBar or start a new one
2141</dd>
2142<p></p>
2143<dt><strong>[menu]</strong><br />
2144</dt>
2145<dd>
2146use the current menuBar
2147</dd>
2148<p></p>
2149<dt><strong><a name="item__5btitle_3astring_5d">[title:string]</a></strong><br />
2150</dt>
2151<dd>
2152set menuBar title
2153</dd>
2154<p></p>
2155<dt><strong>[done]</strong><br />
2156</dt>
2157<dd>
2158set menu access to readonly and, if reading from a file, signal EOF
2159</dd>
2160<p></p>
2161<dt><strong><a name="item__5bdone_3aname_5d">[done:name]</a></strong><br />
2162</dt>
2163<dd>
2164if reading from a file using [read:file;name] signal EOF
2165</dd>
2166<p></p>
2167<dt><strong>[rm:name]</strong><br />
2168</dt>
2169<dd>
2170remove named <code>menuBar(s)</code>
2171</dd>
2172<p></p>
2173<dt><strong>[rm] [rm:]</strong><br />
2174</dt>
2175<dd>
2176remove current menuBar
2177</dd>
2178<p></p>
2179<dt><strong>[rm*] [rm:*]</strong><br />
2180</dt>
2181<dd>
2182remove all <code>menuBar(s)</code>
2183</dd>
2184<p></p>
2185<dt><strong>[swap]</strong><br />
2186</dt>
2187<dd>
2188swap top two menuBars
2189</dd>
2190<p></p>
2191<dt><strong>[prev]</strong><br />
2192</dt>
2193<dd>
2194access the previous menuBar
2195</dd>
2196<p></p>
2197<dt><strong>[next]</strong><br />
2198</dt>
2199<dd>
2200access the next menuBar
2201</dd>
2202<p></p>
2203<dt><strong>[show]</strong><br />
2204</dt>
2205<dd>
2206map menuBar
2207</dd>
2208<p></p>
2209<dt><strong>[hide]</strong><br />
2210</dt>
2211<dd>
2212unmap menuBar
2213</dd>
2214<p></p>
2215<dt><strong><a name="item__5bpixmap_3bfile_5d">[pixmap;file]</a></strong><br />
2216</dt>
2217<dt><strong><a name="item__5bpixmap_3bfile_3bscaling_5d">[pixmap;file;scaling]</a></strong><br />
2218</dt>
2219<dd>
2220set a background pixmap
2221</dd>
2222<p></p>
2223<dt><strong><a name="item__5bread_3afile_5d">[read:file]</a></strong><br />
2224</dt>
2225<dt><strong><a name="item__5bread_3afile_3bname_5d">[read:file;name]</a></strong><br />
2226</dt>
2227<dd>
2228read in a menu from a file
2229</dd>
2230<p></p>
2231<dt><strong>[dump]</strong><br />
2232</dt>
2233<dd>
2234dump out all menuBars to /tmp/rxvt-PID
2235</dd>
2236<p></p>
2237<dt><strong><a name="item__2f">/</a></strong><br />
2238</dt>
2239<dd>
2240access menuBar top level
2241</dd>
2242<p></p>
2243<dt><strong><a name="item__2e_2f">./</a></strong><br />
2244</dt>
2245<dt><strong><a name="item__2e_2e_2f">../</a></strong><br />
2246</dt>
2247<dt><strong>../../</strong><br />
2248</dt>
2249<dd>
2250access current or parent menu level
2251</dd>
2252<p></p>
2253<dt><strong>/path/menu</strong><br />
2254</dt>
2255<dd>
2256add/access menu
2257</dd>
2258<p></p>
2259<dt><strong>/path/{-}</strong><br />
2260</dt>
2261<dd>
2262add separator
2263</dd>
2264<p></p>
2265<dt><strong>/path/{item}{rtext} action</strong><br />
2266</dt>
2267<dd>
2268add/alter menu item
2269</dd>
2270<p></p>
2271<dt><strong><a name="item__2d_2f_2a">-/*</a></strong><br />
2272</dt>
2273<dd>
2274remove all menus from the menuBar
2275</dd>
2276<p></p>
2277<dt><strong><a name="item__2d_2fpath_2fmenu">-/path/menu</a></strong><br />
2278</dt>
2279<dd>
2280remove menu items, separators and submenus from menu
2281</dd>
2282<p></p>
2283<dt><strong>-/path/menu</strong><br />
2284</dt>
2285<dd>
2286remove menu
2287</dd>
2288<p></p>
2289<dt><strong><a name="item__2d_2fpath_2f_7bitem_7d">-/path/{item}</a></strong><br />
2290</dt>
2291<dd>
2292remove item
2293</dd>
2294<p></p>
2295<dt><strong><a name="item__2d_2fpath_2f_7b_2d_7d">-/path/{-}</a></strong><br />
2296</dt>
2297<dd>
2298remove separator
2299</dd>
2300<p></p>
2301<dt><strong><a name="item__3cb_3ebegin_3cr_3eright_3cl_3eleft_3cu_3eup_3cd_3">&lt;b&gt;Begin&lt;r&gt;Right&lt;l&gt;Left&lt;u&gt;Up&lt;d&gt;Down&lt;e&gt;End</a></strong><br />
2302</dt>
2303<dd>
2304menu quick arrows
2305</dd>
2306<p></p></dl>
2307<p> 1986<p>
2308</p> 1987</p>
2309<hr /> 1988<hr />
2310<h1><a name="xpm">XPM</a></h1> 1989<h1><a name="xpm">XPM</a></h1>
2311<p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>&gt; then value 1990<p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>&gt; then value
2494</table><p> 2173</table><p>
2495</p> 2174</p>
2496<hr /> 2175<hr />
2497<h1><a name="configure_options">CONFIGURE OPTIONS</a></h1> 2176<h1><a name="configure_options">CONFIGURE OPTIONS</a></h1>
2498<p>General hint: if you get compile errors, then likely your configuration 2177<p>General hint: if you get compile errors, then likely your configuration
2499hasn't been tested well. Either try with --enable-everything or use the 2178hasn't been tested well. Either try with <a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> or use
2500./reconf script as a base for experiments. ./reconf is used by myself, 2179the <em>./reconf</em> script as a base for experiments. <em>./reconf</em> is used by
2501so it should generally be a working config. Of course, you should always 2180myself, so it should generally be a working config. Of course, you should
2502report when a combination doesn't work, so it can be fixed. Marc Lehmann 2181always report when a combination doesn't work, so it can be fixed. Marc
2503&lt;<a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a>&gt;.</p> 2182Lehmann &lt;<a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a>&gt;.</p>
2183<p>All</p>
2504<dl> 2184<dl>
2505<dt><strong><a name="item__2d_2denable_2deverything">--enable-everything</a></strong><br /> 2185<dt><strong><a name="item__2d_2denable_2deverything">--enable-everything</a></strong><br />
2506</dt> 2186</dt>
2507<dd> 2187<dd>
2508Add support for all non-multichoice options listed in ``./configure 2188Add (or remove) support for all non-multichoice options listed in ``./configure
2509--help''. Note that unlike other enable options this is order dependant. 2189--help''.
2510You can specify this and then disable options which this enables by 2190</dd>
2511<em>following</em> this with the appropriate commands.
2512</dd> 2191<dd>
2192<p>You can specify this and then disable options you do not like by
2193<em>following</em> this with the appropriate <code>--disable-...</code> arguments,
2194or you can start with a minimal configuration by specifying
2195<code>--disable-everything</code> and than adding just the <code>--enable-...</code> arguments
2196you want.</p>
2197</dd>
2513<p></p> 2198<p></p>
2514<dt><strong><a name="item__2d_2denable_2dxft">--enable-xft</a></strong><br /> 2199<dt><strong><a name="item_xft">--enable-xft (default: enabled)</a></strong><br />
2515</dt> 2200</dt>
2516<dd> 2201<dd>
2517Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2202Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2518slower and require lots of memory, but as long as you don't use them, you 2203slower and require lots of memory, but as long as you don't use them, you
2519don't pay for them. 2204don't pay for them.
2520</dd> 2205</dd>
2521<p></p> 2206<p></p>
2522<dt><strong><a name="item__2d_2denable_2dfont_2dstyles">--enable-font-styles</a></strong><br /> 2207<dt><strong><a name="item_styles">--enable-font-styles (default: on)</a></strong><br />
2523</dt> 2208</dt>
2524<dd> 2209<dd>
2525Add support for <strong>bold</strong>, <em>italic</em> and <strong><em>bold italic</em> </strong>&gt; font 2210Add support for <strong>bold</strong>, <em>italic</em> and <strong><em>bold italic</em> </strong>&gt; font
2526styles. The fonts can be set manually or automatically. 2211styles. The fonts can be set manually or automatically.
2527</dd> 2212</dd>
2528<p></p> 2213<p></p>
2529<dt><strong><a name="item__2d_2dwith_2dcodesets_3dname_2c_2e_2e_2e">--with-codesets=NAME,...</a></strong><br /> 2214<dt><strong><a name="item__2d_2dwith_2dcodesets_3dname_2c_2e_2e_2e__28defaul">--with-codesets=NAME,... (default: all)</a></strong><br />
2530</dt> 2215</dt>
2531<dd> 2216<dd>
2532Compile in support for additional codeset (encoding) groups (eu, vn are 2217Compile in support for additional codeset (encoding) groups (<code>eu</code>, <code>vn</code>
2533always compiled in, which includes most 8-bit character sets). These 2218are always compiled in, which includes most 8-bit character sets). These
2534codeset tables are currently only used for driving X11 core fonts, they 2219codeset tables are used for driving X11 core fonts, they are not required
2535are not required for Xft fonts. Compiling them in will make your binary 2220for Xft fonts, although having them compiled in lets rxvt-unicode choose
2536bigger (together about 700kB), but it doesn't increase memory usage unless 2221replacement fonts more intelligently. Compiling them in will make your
2222binary bigger (all of together cost about 700kB), but it doesn't increase
2537you use an X11 font requiring one of these encodings. 2223memory usage unless you use a font requiring one of these encodings.
2538</dd> 2224</dd>
2539<table> 2225<table>
2540<tr><td>all</td><td>all available codeset groups</td></tr> 2226<tr><td>all</td><td>all available codeset groups</td></tr>
2541<tr><td>zh</td><td>common chinese encodings</td></tr> 2227<tr><td>zh</td><td>common chinese encodings</td></tr>
2542<tr><td>zh_ext</td><td>rarely used but very big chinese encodigs</td></tr> 2228<tr><td>zh_ext</td><td>rarely used but very big chinese encodigs</td></tr>
2543<tr><td>jp</td><td>common japanese encodings</td></tr> 2229<tr><td>jp</td><td>common japanese encodings</td></tr>
2544<tr><td>jp_ext</td><td>rarely used but big japanese encodings</td></tr> 2230<tr><td>jp_ext</td><td>rarely used but big japanese encodings</td></tr>
2545<tr><td>kr</td><td>korean encodings</td></tr> 2231<tr><td>kr</td><td>korean encodings</td></tr>
2546</table><p></p> 2232</table><p></p>
2547<dt><strong><a name="item__2d_2denable_2dxim">--enable-xim</a></strong><br /> 2233<dt><strong><a name="item_xim">--enable-xim (default: on)</a></strong><br />
2548</dt> 2234</dt>
2549<dd> 2235<dd>
2550Add support for XIM (X Input Method) protocol. This allows using 2236Add support for XIM (X Input Method) protocol. This allows using
2551alternative input methods (e.g. kinput2) and will also correctly 2237alternative input methods (e.g. kinput2) and will also correctly
2552set up the input for people using dead keys or compose keys. 2238set up the input for people using dead keys or compose keys.
2553</dd> 2239</dd>
2554<p></p> 2240<p></p>
2555<dt><strong><a name="item__2d_2denable_2dunicode3">--enable-unicode3</a></strong><br /> 2241<dt><strong><a name="item_unicode3">--enable-unicode3 (default: off)</a></strong><br />
2556</dt> 2242</dt>
2243<dd>
2244Recommended to stay off unless you really need non-BMP characters.
2557<dd> 2245</dd>
2246<dd>
2558Enable direct support for displaying unicode codepoints above 2247<p>Enable direct support for displaying unicode codepoints above
255965535 (the basic multilingual page). This increases storage 224865535 (the basic multilingual page). This increases storage
2560requirements per character from 2 to 4 bytes. X11 fonts do not yet 2249requirements per character from 2 to 4 bytes. X11 fonts do not yet
2561support these extra characters, but Xft does. 2250support these extra characters, but Xft does.</p>
2562</dd> 2251</dd>
2563<dd> 2252<dd>
2564<p>Please note that rxvt-unicode can store unicode code points &gt;65535 2253<p>Please note that rxvt-unicode can store unicode code points &gt;65535
2565even without this flag, but the number of such characters is 2254even without this flag, but the number of such characters is
2566limited to a view thousand (shared with combining characters, 2255limited to a view thousand (shared with combining characters,
2567see next switch), and right now rxvt-unicode cannot display them 2256see next switch), and right now rxvt-unicode cannot display them
2568(input/output and cut&amp;paste still work, though).</p> 2257(input/output and cut&amp;paste still work, though).</p>
2569</dd> 2258</dd>
2570<p></p> 2259<p></p>
2571<dt><strong><a name="item__2d_2denable_2dcombining">--enable-combining</a></strong><br /> 2260<dt><strong><a name="item_combining">--enable-combining (default: on)</a></strong><br />
2572</dt> 2261</dt>
2573<dd> 2262<dd>
2574Enable automatic composition of combining characters into 2263Enable automatic composition of combining characters into
2575composite characters. This is required for proper viewing of text 2264composite characters. This is required for proper viewing of text
2576where accents are encoded as seperate unicode characters. This is 2265where accents are encoded as seperate unicode characters. This is
2577done by using precomposited characters when available or creating 2266done by using precomposited characters when available or creating
2578new pseudo-characters when no precomposed form exists. 2267new pseudo-characters when no precomposed form exists.
2579</dd> 2268</dd>
2580<dd> 2269<dd>
2581<p>Without --enable-unicode3, the number of additional precomposed characters 2270<p>Without --enable-unicode3, the number of additional precomposed
2582is rather limited (2048, if this is full, rxvt-unicode will use the 2271characters is somewhat limited (the 6400 private use characters will be
2583private use area, extending the number of combinations to 8448). With
2584--enable-unicode3, no practical limit exists.</p> 2272(ab-)used). With --enable-unicode3, no practical limit exists.</p>
2585</dd> 2273</dd>
2586<dd> 2274<dd>
2587<p>This option will also enable storage (but not display) of characters 2275<p>This option will also enable storage (but not display) of characters
2588beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p> 2276beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p>
2589</dd> 2277</dd>
2591<p>The combining table also contains entries for arabic presentation forms, 2279<p>The combining table also contains entries for arabic presentation forms,
2592but these are not currently used. Bug me if you want these to be used (and 2280but these are not currently used. Bug me if you want these to be used (and
2593tell me how these are to be used...).</p> 2281tell me how these are to be used...).</p>
2594</dd> 2282</dd>
2595<p></p> 2283<p></p>
2596<dt><strong><a name="item_fallback">--enable-fallback(=CLASS)</a></strong><br /> 2284<dt><strong><a name="item_fallback">--enable-fallback(=CLASS) (default: Rxvt)</a></strong><br />
2597</dt> 2285</dt>
2598<dd> 2286<dd>
2599When reading resource settings, also read settings for class CLASS 2287When reading resource settings, also read settings for class CLASS. To
2600(default: Rxvt). To disable resource fallback use --disable-fallback. 2288disable resource fallback use --disable-fallback.
2601</dd>
2602<p></p>
2603<dt><strong><a name="item__2d_2dwith_2dres_2dname_3dname">--with-res-name=NAME</a></strong><br />
2604</dt>
2605<dd> 2289</dd>
2290<p></p>
2291<dt><strong><a name="item_name">--with-res-name=NAME (default: urxvt)</a></strong><br />
2292</dt>
2293<dd>
2606Use the given name (default: urxvt) as default application name when 2294Use the given name as default application name when
2607reading resources. Specify --with-res-name=rxvt to replace rxvt. 2295reading resources. Specify --with-res-name=rxvt to replace rxvt.
2608</dd> 2296</dd>
2609<p></p> 2297<p></p>
2610<dt><strong><a name="item__2d_2dwith_2dres_2dclass_3dclass">--with-res-class=CLASS</a></strong><br /> 2298<dt><strong><a name="item__2d_2dwith_2dres_2dclass_3dclass__2fdefault_3a_urx">--with-res-class=CLASS /default: URxvt)</a></strong><br />
2611</dt> 2299</dt>
2612<dd> 2300<dd>
2613Use the given class (default: URxvt) as default application class 2301Use the given class as default application class
2614when reading resources. Specify --with-res-class=Rxvt to replace 2302when reading resources. Specify --with-res-class=Rxvt to replace
2615rxvt. 2303rxvt.
2616</dd> 2304</dd>
2617<p></p> 2305<p></p>
2618<dt><strong><a name="item__2d_2denable_2dutmp">--enable-utmp</a></strong><br /> 2306<dt><strong><a name="item_utmp">--enable-utmp (default: on)</a></strong><br />
2619</dt> 2307</dt>
2620<dd> 2308<dd>
2621Write user and tty to utmp file (used by programs like <em>w</em>) at 2309Write user and tty to utmp file (used by programs like <em>w</em>) at
2622start of rxvt execution and delete information when rxvt exits. 2310start of rxvt execution and delete information when rxvt exits.
2623</dd> 2311</dd>
2624<p></p> 2312<p></p>
2625<dt><strong><a name="item__2d_2denable_2dwtmp">--enable-wtmp</a></strong><br /> 2313<dt><strong><a name="item_wtmp">--enable-wtmp (default: on)</a></strong><br />
2626</dt> 2314</dt>
2627<dd> 2315<dd>
2628Write user and tty to wtmp file (used by programs like <em>last</em>) at 2316Write user and tty to wtmp file (used by programs like <em>last</em>) at
2629start of rxvt execution and write logout when rxvt exits. This 2317start of rxvt execution and write logout when rxvt exits. This
2630option requires --enable-utmp to also be specified. 2318option requires --enable-utmp to also be specified.
2631</dd> 2319</dd>
2632<p></p> 2320<p></p>
2633<dt><strong><a name="item__2d_2denable_2dlastlog">--enable-lastlog</a></strong><br /> 2321<dt><strong><a name="item_lastlog">--enable-lastlog (default: on)</a></strong><br />
2634</dt> 2322</dt>
2635<dd> 2323<dd>
2636Write user and tty to lastlog file (used by programs like 2324Write user and tty to lastlog file (used by programs like
2637<em>lastlogin</em>) at start of rxvt execution. This option requires 2325<em>lastlogin</em>) at start of rxvt execution. This option requires
2638--enable-utmp to also be specified. 2326--enable-utmp to also be specified.
2639</dd> 2327</dd>
2640<p></p> 2328<p></p>
2641<dt><strong><a name="item__2d_2denable_2dxpm_2dbackground">--enable-xpm-background</a></strong><br /> 2329<dt><strong><a name="item_background">--enable-xpm-background (default: on)</a></strong><br />
2642</dt> 2330</dt>
2643<dd> 2331<dd>
2644Add support for XPM background pixmaps. 2332Add support for XPM background pixmaps.
2645</dd> 2333</dd>
2646<p></p> 2334<p></p>
2647<dt><strong><a name="item__2d_2denable_2dtransparency">--enable-transparency</a></strong><br /> 2335<dt><strong><a name="item_transparency">--enable-transparency (default: on)</a></strong><br />
2648</dt> 2336</dt>
2649<dd> 2337<dd>
2650Add support for inheriting parent backgrounds thus giving a fake 2338Add support for inheriting parent backgrounds thus giving a fake
2651transparency to the term. 2339transparency to the term.
2652</dd> 2340</dd>
2653<p></p> 2341<p></p>
2654<dt><strong><a name="item__2d_2denable_2dfading">--enable-fading</a></strong><br /> 2342<dt><strong><a name="item_fading">--enable-fading (default: on)</a></strong><br />
2655</dt> 2343</dt>
2656<dd>
2657Add support for fading the text when focus is lost.
2658</dd> 2344<dd>
2659<p></p> 2345Add support for fading the text when focus is lost (requires <code>--enable-transparency</code>).
2660<dt><strong><a name="item__2d_2denable_2dtinting">--enable-tinting</a></strong><br />
2661</dt>
2662<dd> 2346</dd>
2663Add support for tinting of transparent backgrounds. 2347<p></p>
2348<dt><strong><a name="item_tinting">--enable-tinting (default: on)</a></strong><br />
2349</dt>
2664</dd> 2350<dd>
2665<p></p> 2351Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>).
2666<dt><strong><a name="item__2d_2denable_2dmenubar">--enable-menubar</a></strong><br />
2667</dt>
2668<dd> 2352</dd>
2669Add support for our menu bar system (this interacts badly with
2670dynamic locale switching currently).
2671</dd>
2672<p></p> 2353<p></p>
2673<dt><strong><a name="item__2d_2denable_2drxvt_2dscroll">--enable-rxvt-scroll</a></strong><br /> 2354<dt><strong><a name="item_scroll">--enable-rxvt-scroll (default: on)</a></strong><br />
2674</dt> 2355</dt>
2675<dd> 2356<dd>
2676Add support for the original rxvt scrollbar. 2357Add support for the original rxvt scrollbar.
2677</dd> 2358</dd>
2678<p></p> 2359<p></p>
2679<dt><strong><a name="item__2d_2denable_2dnext_2dscroll">--enable-next-scroll</a></strong><br /> 2360<dt><strong>--enable-next-scroll (default: on)</strong><br />
2680</dt> 2361</dt>
2681<dd> 2362<dd>
2682Add support for a NeXT-like scrollbar. 2363Add support for a NeXT-like scrollbar.
2683</dd> 2364</dd>
2684<p></p> 2365<p></p>
2685<dt><strong><a name="item__2d_2denable_2dxterm_2dscroll">--enable-xterm-scroll</a></strong><br /> 2366<dt><strong>--enable-xterm-scroll (default: on)</strong><br />
2686</dt> 2367</dt>
2687<dd> 2368<dd>
2688Add support for an Xterm-like scrollbar. 2369Add support for an Xterm-like scrollbar.
2689</dd> 2370</dd>
2690<p></p> 2371<p></p>
2691<dt><strong><a name="item__2d_2denable_2dplain_2dscroll">--enable-plain-scroll</a></strong><br /> 2372<dt><strong>--enable-plain-scroll (default: on)</strong><br />
2692</dt> 2373</dt>
2693<dd> 2374<dd>
2694Add support for a very unobtrusive, plain-looking scrollbar that 2375Add support for a very unobtrusive, plain-looking scrollbar that
2695is the favourite of the rxvt-unicode author, having used it for 2376is the favourite of the rxvt-unicode author, having used it for
2696many years. 2377many years.
2697</dd> 2378</dd>
2698<p></p> 2379<p></p>
2699<dt><strong><a name="item__2d_2denable_2dhalf_2dshadow">--enable-half-shadow</a></strong><br />
2700</dt>
2701<dd>
2702Make shadows on the scrollbar only half the normal width &amp; height.
2703only applicable to rxvt scrollbars.
2704</dd>
2705<p></p>
2706<dt><strong><a name="item__2d_2denable_2dttygid">--enable-ttygid</a></strong><br /> 2380<dt><strong><a name="item_ttygid">--enable-ttygid (default: off)</a></strong><br />
2707</dt> 2381</dt>
2708<dd> 2382<dd>
2709Change tty device setting to group ``tty'' - only use this if 2383Change tty device setting to group ``tty'' - only use this if
2710your system uses this type of security. 2384your system uses this type of security.
2711</dd> 2385</dd>
2712<p></p> 2386<p></p>
2713<dt><strong><a name="item__2d_2ddisable_2dbackspace_2dkey">--disable-backspace-key</a></strong><br /> 2387<dt><strong><a name="item__2d_2ddisable_2dbackspace_2dkey">--disable-backspace-key</a></strong><br />
2714</dt> 2388</dt>
2715<dd> 2389<dd>
2716Disable any handling of the backspace key by us - let the X server 2390Removes any handling of the backspace key by us - let the X server do it.
2391</dd>
2392<p></p>
2393<dt><strong><a name="item__2d_2ddisable_2ddelete_2dkey">--disable-delete-key</a></strong><br />
2394</dt>
2395<dd>
2396Removes any handling of the delete key by us - let the X server
2717do it. 2397do it.
2718</dd> 2398</dd>
2719<p></p> 2399<p></p>
2720<dt><strong><a name="item__2d_2ddisable_2ddelete_2dkey">--disable-delete-key</a></strong><br />
2721</dt>
2722<dd>
2723Disable any handling of the delete key by us - let the X server
2724do it.
2725</dd>
2726<p></p>
2727<dt><strong><a name="item__2d_2ddisable_2dresources">--disable-resources</a></strong><br /> 2400<dt><strong><a name="item__2d_2ddisable_2dresources">--disable-resources</a></strong><br />
2728</dt> 2401</dt>
2729<dd> 2402<dd>
2730Remove all resources checking. 2403Removes any support for resource checking.
2731</dd>
2732<p></p>
2733<dt><strong><a name="item__2d_2denable_2dxgetdefault">--enable-xgetdefault</a></strong><br />
2734</dt>
2735<dd>
2736Make resources checking via <code>XGetDefault()</code> instead of our small
2737version which only checks ~/.Xdefaults, or if that doesn't exist then
2738~/.Xresources.
2739</dd>
2740<dd>
2741<p>Please note that nowadays, things like XIM will automatically pull in and
2742use the full X resource manager, so the overhead of using it might be very
2743small, if nonexistant.</p>
2744</dd>
2745<p></p>
2746<dt><strong><a name="item__2d_2denable_2dstrings">--enable-strings</a></strong><br />
2747</dt>
2748<dd>
2749Add support for our possibly faster <code>memset()</code> function and other
2750various routines, overriding your system's versions which may
2751have been hand-crafted in assembly or may require extra libraries
2752to link in. (this breaks ANSI-C rules and has problems on many
2753GNU/Linux systems).
2754</dd> 2404</dd>
2755<p></p> 2405<p></p>
2756<dt><strong><a name="item__2d_2ddisable_2dswapscreen">--disable-swapscreen</a></strong><br /> 2406<dt><strong><a name="item__2d_2ddisable_2dswapscreen">--disable-swapscreen</a></strong><br />
2757</dt> 2407</dt>
2758<dd> 2408<dd>
2759Remove support for swap screen. 2409Remove support for secondary/swap screen.
2760</dd> 2410</dd>
2761<p></p> 2411<p></p>
2762<dt><strong><a name="item__2d_2denable_2dfrills">--enable-frills</a></strong><br /> 2412<dt><strong><a name="item_frills">--enable-frills (default: on)</a></strong><br />
2763</dt> 2413</dt>
2764<dd> 2414<dd>
2765Add support for many small features that are not essential but nice to 2415Add support for many small features that are not essential but nice to
2766have. Normally you want this, but for very small binaries you may want to 2416have. Normally you want this, but for very small binaries you may want to
2767disable this. 2417disable this.
2768</dd> 2418</dd>
2769<dd> 2419<dd>
2770<p>A non-exhaustive list of features enabled by <a href="#item__2d_2denable_2dfrills"><code>--enable-frills</code></a> (possibly 2420<p>A non-exhaustive list of features enabled by <code>--enable-frills</code> (possibly
2771in combination with other switches) is:</p> 2421in combination with other switches) is:</p>
2772</dd> 2422</dd>
2773<dd> 2423<dd>
2774<pre> 2424<pre>
2775 MWM-hints 2425 MWM-hints
2776 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2777 seperate underline colour 2427 seperate underline colour (-underlineColor)
2778 settable border widths and borderless switch 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual selection (-depth)
2779 settable extra linespacing 2430 settable extra linespacing /-lsp)
2780 iso-14755-2 and -3, and visual feedback 2431 iso-14755-2 and -3, and visual feedback
2781 backindex and forwardindex escape sequence 2432 backindex and forwardindex escape sequence
2782 window op and locale change escape sequences 2433 window op and some xterm/OSC escape sequences
2783 tripleclickwords 2434 tripleclickwords (-tcw)
2784 settable insecure mode 2435 settable insecure mode (-insecure)
2785 keysym remapping support 2436 keysym remapping support
2786 -embed and -pty-fd options</pre> 2437 cursor blinking and underline cursor (-cb, -uc)
2438 XEmbed support (-embed)
2439 user-pty (-pty-fd)
2440 hold on exit (-hold)
2441 skip builtin block graphics (-sbg)
2442 sgr modes 90..97 and 100..107</pre>
2787</dd> 2443</dd>
2788<p></p> 2444<p></p>
2789<dt><strong><a name="item__2d_2denable_2diso14755">--enable-iso14755</a></strong><br /> 2445<dt><strong><a name="item_iso14755">--enable-iso14755 (default: on)</a></strong><br />
2790</dt> 2446</dt>
2791<dd> 2447<dd>
2792Enable extended ISO 14755 support (see rxvt(1), or 2448Enable extended ISO 14755 support (see rxvt(1), or
2793<em>doc/rxvt.1.txt</em>). Basic support (section 5.1) is enabled by 2449<em>doc/rxvt.1.txt</em>). Basic support (section 5.1) is enabled by
2794<a href="#item__2d_2denable_2dfrills"><code>--enable-frills</code></a>, while support for 5.2, 5.3 and 5.4 is enabled with 2450<code>--enable-frills</code>, while support for 5.2, 5.3 and 5.4 is enabled with
2795this switch. 2451this switch.
2796</dd> 2452</dd>
2797<p></p> 2453<p></p>
2798<dt><strong><a name="item__2d_2denable_2dkeepscrolling">--enable-keepscrolling</a></strong><br /> 2454<dt><strong><a name="item_keepscrolling">--enable-keepscrolling (default: on)</a></strong><br />
2799</dt> 2455</dt>
2800<dd> 2456<dd>
2801Add support for continual scrolling of the display when you hold 2457Add support for continual scrolling of the display when you hold
2802the mouse button down on a scrollbar arrow. 2458the mouse button down on a scrollbar arrow.
2803</dd> 2459</dd>
2804<p></p> 2460<p></p>
2805<dt><strong><a name="item__2d_2denable_2dmousewheel">--enable-mousewheel</a></strong><br /> 2461<dt><strong><a name="item_mousewheel">--enable-mousewheel (default: on)</a></strong><br />
2806</dt> 2462</dt>
2807<dd> 2463<dd>
2808Add support for scrolling via mouse wheel or buttons 4 &amp; 5. 2464Add support for scrolling via mouse wheel or buttons 4 &amp; 5.
2809</dd> 2465</dd>
2810<p></p> 2466<p></p>
2811<dt><strong><a name="item__2d_2denable_2dslipwheeling">--enable-slipwheeling</a></strong><br /> 2467<dt><strong><a name="item_slipwheeling">--enable-slipwheeling (default: on)</a></strong><br />
2812</dt> 2468</dt>
2813<dd> 2469<dd>
2814Add support for continual scrolling (using the mouse wheel as an 2470Add support for continual scrolling (using the mouse wheel as an
2815accelerator) while the control key is held down. This option 2471accelerator) while the control key is held down. This option
2816requires --enable-mousewheel to also be specified. 2472requires --enable-mousewheel to also be specified.
2820</dt> 2476</dt>
2821<dd> 2477<dd>
2822Remove support for mouse selection style like that of xterm. 2478Remove support for mouse selection style like that of xterm.
2823</dd> 2479</dd>
2824<p></p> 2480<p></p>
2825<dt><strong><a name="item__2d_2denable_2ddmalloc">--enable-dmalloc</a></strong><br /> 2481<dt><strong><a name="item_dmalloc">--enable-dmalloc (default: off)</a></strong><br />
2826</dt> 2482</dt>
2827<dd> 2483<dd>
2828Use Gray Watson's malloc - which is good for debugging See 2484Use Gray Watson's malloc - which is good for debugging See
2829<a href="http://www.letters.com/dmalloc/">http://www.letters.com/dmalloc/</a> for details If you use either this or the 2485<a href="http://www.letters.com/dmalloc/">http://www.letters.com/dmalloc/</a> for details If you use either this or the
2830next option, you may need to edit src/Makefile after compiling to point 2486next option, you may need to edit src/Makefile after compiling to point
2833<dd> 2489<dd>
2834<p>You can only use either this option and the following (should 2490<p>You can only use either this option and the following (should
2835you use either) .</p> 2491you use either) .</p>
2836</dd> 2492</dd>
2837<p></p> 2493<p></p>
2838<dt><strong><a name="item__2d_2denable_2ddlmalloc">--enable-dlmalloc</a></strong><br /> 2494<dt><strong><a name="item_dlmalloc">--enable-dlmalloc (default: off)</a></strong><br />
2839</dt> 2495</dt>
2840<dd> 2496<dd>
2841Use Doug Lea's malloc - which is good for a production version 2497Use Doug Lea's malloc - which is good for a production version
2842See <a href="http://g.oswego.edu/dl/html/malloc.html">http://g.oswego.edu/dl/html/malloc.html</a> for details. 2498See <a href="http://g.oswego.edu/dl/html/malloc.html">http://g.oswego.edu/dl/html/malloc.html</a> for details.
2843</dd> 2499</dd>
2844<p></p> 2500<p></p>
2845<dt><strong><a name="item__2d_2denable_2dsmart_2dresize">--enable-smart-resize</a></strong><br /> 2501<dt><strong><a name="item_resize">--enable-smart-resize (default: on)</a></strong><br />
2846</dt> 2502</dt>
2847<dd> 2503<dd>
2848Add smart growth/shrink behaviour when changing font size via from hot 2504Add smart growth/shrink behaviour when changing font size via hot
2849keys. This should keep in a fixed position the rxvt corner which is 2505keys. This should keep the window corner which is closest to a corner of
2850closest to a corner of the screen. 2506the screen in a fixed position.
2851</dd>
2852<p></p>
2853<dt><strong><a name="item__2d_2denable_2dcursor_2dblink">--enable-cursor-blink</a></strong><br />
2854</dt>
2855<dd> 2507</dd>
2856Add support for a blinking cursor.
2857</dd>
2858<p></p> 2508<p></p>
2859<dt><strong><a name="item__2d_2denable_2dpointer_2dblank">--enable-pointer-blank</a></strong><br /> 2509<dt><strong><a name="item_blank">--enable-pointer-blank (default: on)</a></strong><br />
2860</dt> 2510</dt>
2861<dd> 2511<dd>
2862Add support to have the pointer disappear when typing or inactive. 2512Add support to have the pointer disappear when typing or inactive.
2863</dd> 2513</dd>
2864<p></p> 2514<p></p>
2865<dt><strong><a name="item__2d_2dwith_2dname_3dname">--with-name=NAME</a></strong><br /> 2515<dt><strong><a name="item_perl">--enable-perl (default: on)</a></strong><br />
2866</dt> 2516</dt>
2517<dd>
2518Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
2519manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files
2520in <em>src/perl-ext/</em> for the extensions that are installed by default. The
2521perl interpreter that is used can be specified via the <code>PERL</code> environment
2522variable when running configure.
2867<dd> 2523</dd>
2524<p></p>
2525<dt><strong>--with-name=NAME (default: urxvt)</strong><br />
2526</dt>
2527<dd>
2868Set the basename for the installed binaries (default: <code>urxvt</code>, resulting 2528Set the basename for the installed binaries, resulting
2869in <code>urxvt</code>, <code>urxvtd</code> etc.). Specify <code>--with-name=rxvt</code> to replace with 2529in <code>urxvt</code>, <code>urxvtd</code> etc.). Specify <code>--with-name=rxvt</code> to replace with
2870<code>rxvt</code>. 2530<code>rxvt</code>.
2871</dd> 2531</dd>
2872<p></p> 2532<p></p>
2873<dt><strong><a name="item__2d_2dwith_2dterm_3dname">--with-term=NAME</a></strong><br /> 2533<dt><strong>--with-term=NAME (default: rxvt-unicode)</strong><br />
2874</dt> 2534</dt>
2875<dd> 2535<dd>
2876Change the environmental variable for the terminal to NAME (default 2536Change the environmental variable for the terminal to NAME.
2877<code>rxvt-unicode</code>)
2878</dd> 2537</dd>
2879<p></p> 2538<p></p>
2880<dt><strong><a name="item__2d_2dwith_2dterminfo_3dpath">--with-terminfo=PATH</a></strong><br /> 2539<dt><strong><a name="item__2d_2dwith_2dterminfo_3dpath">--with-terminfo=PATH</a></strong><br />
2881</dt> 2540</dt>
2882<dd> 2541<dd>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines