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.23 by root, Wed Aug 10 01:44:35 2005 UTC vs.
Revision 1.54 by root, Tue Jan 31 00:25:16 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>
65</p> 54</p>
66<hr /> 55<hr />
67<h1><a name="description">DESCRIPTION</a></h1> 56<h1><a name="description">DESCRIPTION</a></h1>
68<p>This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 57<p>This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
69all escape sequences, and other background information.</p> 58all escape sequences, and other background information.</p>
70<p>The newest version of this document is 59<p>The newest version of this document is also available on the World Wide Web at
71also available on the World Wide Web at
72<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p> 60<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p>
73<p> 61<p>
74</p> 62</p>
75<hr /> 63<hr />
76<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 64<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
77<dl> 65<dl>
66<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
67single words?</a></strong><br />
68</dt>
69<dd>
70Yes. For example, if you want to select alphanumeric words, you can use
71the following resource:
72</dd>
73<dd>
74<pre>
75 URxvt.selection.pattern-0: ([[:word:]]+)</pre>
76</dd>
77<dd>
78<p>If you click more than twice, the selection will be extended
79more and more.</p>
80</dd>
81<dd>
82<p>To get a selection that is very similar to the old code, try this pattern:</p>
83</dd>
84<dd>
85<pre>
86 URxvt.selection.pattern-0: ([^&quot;&amp;'()*,;&lt;=&gt;?@[\\\\]^`{|})]+)</pre>
87</dd>
88<dd>
89<p>Please also note that the <em>LeftClick Shift-LeftClik</em> combination also
90selects words like the old code.</p>
91</dd>
92<p></p>
93<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
94change/disable it?</a></strong><br />
95</dt>
96<dd>
97You can disable the perl extension completely by setting the
98<strong>perl-ext-common</strong> resource to the empty string, which also keeps
99rxvt-unicode from initialising perl, saving memory.
100</dd>
101<dd>
102<p>If you only want to disable specific features, you first have to
103identify which perl extension is responsible. For this, read the section
104<strong>PREPACKAGED EXTENSIONS</strong> in the <code>rxvtperl(3)</code> manpage. For
105example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
106this <strong>perl-ext-common</strong> resource:</p>
107</dd>
108<dd>
109<pre>
110 URxvt.perl-ext-common: default,-selection-popup,-option-popup</pre>
111</dd>
112<dd>
113<p>This will keep the default extensions, but disable the two popup
114extensions. Some extensions can also be configured, for example,
115scrollback search mode is triggered by <strong>M-s</strong>. You can move it to any
116other combination either by setting the <strong>searchable-scrollback</strong> resource:</p>
117</dd>
118<dd>
119<pre>
120 URxvt.searchable-scrollback: CM-s</pre>
121</dd>
122<p></p>
123<dt><strong><a name="item_why_doesn_27t_rxvt_2dunicode_read_my_resources_3f">Why doesn't rxvt-unicode read my resources?</a></strong><br />
124</dt>
125<dd>
126Well, why, indeed? It does, in a way very similar to other X
127applications. Most importantly, this means that if you or your OS loads
128resources into the X display (the right way to do it), rxvt-unicode will
129ignore any resource files in your home directory. It will only read
130<em>$HOME/.Xdefaults</em> when no resources are attached to the display.
131</dd>
132<dd>
133<p>If you have or use an <em>$HOME/.Xresources</em> file, chances are that
134resources are loaded into your X-server. In this case, you have to
135re-login after every change (or run <em>xrdb -merge $HOME/.Xresources</em>).</p>
136</dd>
137<dd>
138<p>Also consider the form resources have to use:</p>
139</dd>
140<dd>
141<pre>
142 URxvt.resource: value</pre>
143</dd>
144<dd>
145<p>If you want to use another form (there are lots of different ways of
146specifying resources), make sure you understand wether and why it
147works. If unsure, use the form above.</p>
148</dd>
149<p></p>
150<dt><strong><a name="item_i_can_27t_get_transparency_working_2c_what_am_i_do">I can't get transparency working, what am I doing wrong?</a></strong><br />
151</dt>
152<dd>
153First of all, transparency isn't officially supported in rxvt-unicode, so
154you are mostly on your own. Do not bug the author about it (but you may
155bug everybody else). Also, if you can't get it working consider it a rite
156of passage: ... and you failed.
157</dd>
158<dd>
159<p>Here are four ways to get transparency. <strong>Do</strong> read the manpage and option
160descriptions for the programs mentioned and rxvt-unicode. Really, do it!</p>
161</dd>
162<dd>
163<p>1. Use inheritPixmap:</p>
164</dd>
165<dd>
166<pre>
167 Esetroot wallpaper.jpg
168 rxvt -ip -tint red -sh 40</pre>
169</dd>
170<dd>
171<p>That works. If you think it doesn't, you lack transparency and tinting
172support, or you are unable to read.</p>
173</dd>
174<dd>
175<p>2. Use a simple pixmap and emulate pseudo-transparency. This enables you
176to use effects other than tinting and shading: Just shade/tint/whatever
177your picture with gimp:</p>
178</dd>
179<dd>
180<pre>
181 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
182 rxvt -pixmap background.xpm -pe automove-background</pre>
183</dd>
184<dd>
185<p>That works. If you think it doesn't, you lack XPM and Perl support, or you
186are unable to read.</p>
187</dd>
188<dd>
189<p>3. Use an ARGB visual:</p>
190</dd>
191<dd>
192<pre>
193 rxvt -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc</pre>
194</dd>
195<dd>
196<p>This requires XFT support, and the support of your X-server. If that
197doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
198there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
199bugfixes and workarounds for Xft and Xlib to make it work, but that
200doesn't mean that your WM has the required kludges in place.</p>
201</dd>
202<dd>
203<p>4. Use xcompmgr and let it do the job:</p>
204</dd>
205<dd>
206<pre>
207 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
208 -set _NET_WM_WINDOW_OPACITY 0xc0000000</pre>
209</dd>
210<dd>
211<p>Then click on a window you want to make transparent. Replace <code>0xc0000000</code>
212by other values to change the degree of opacity. If it doesn't work and
213your server crashes, you got to keep the pieces.</p>
214</dd>
215<p></p>
216<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 />
217</dt>
218<dd>
219I often get asked about this, and I think, no, they didn't cause extra
220bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
221that the urxvt binary is larger (due to some encoding tables always being
222compiled in), but it actually uses less memory (RSS) after startup. Even
223with <code>--disable-everything</code>, this comparison is a bit unfair, as many
224features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
225already in use in this mode.
226</dd>
227<dd>
228<pre>
229 text data bss drs rss filename
230 98398 1664 24 15695 1824 rxvt --disable-everything
231 188985 9048 66616 18222 1788 urxvt --disable-everything</pre>
232</dd>
233<dd>
234<p>When you <a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (which _is_ unfair, as this involves xft
235and full locale/XIM support which are quite bloaty inside libX11 and my
236libc), the two diverge, but not unreasnobaly so.</p>
237</dd>
238<dd>
239<pre>
240 text data bss drs rss filename
241 163431 2152 24 20123 2060 rxvt --enable-everything
242 1035683 49680 66648 29096 3680 urxvt --enable-everything</pre>
243</dd>
244<dd>
245<p>The very large size of the text section is explained by the east-asian
246encoding tables, which, if unused, take up disk space but nothing else
247and can be compiled out unless you rely on X11 core fonts that use those
248encodings. The BSS size comes from the 64k emergency buffer that my c++
249compiler allocates (but of course doesn't use unless you are out of
250memory). Also, using an xft font instead of a core font immediately adds a
251few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
252not used.</p>
253</dd>
254<dd>
255<p>Of course, due to every character using two or four bytes instead of one,
256a large scrollback buffer will ultimately make rxvt-unicode use more
257memory.</p>
258</dd>
259<dd>
260<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
261still fares rather well. And compared to some monsters like gnome-terminal
262(21152k + extra 4204k in separate processes) or konsole (22200k + extra
26343180k in daemons that stay around after exit, plus half a minute of
264startup time, including the hundreds of warnings it spits out), it fares
265extremely well *g*.</p>
266</dd>
267<p></p>
268<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 />
269</dt>
270<dd>
271Is this a question? :) It comes up very often. The simple answer is: I had
272to write it, and C++ allowed me to write and maintain it in a fraction
273of the time and effort (which is a scarce resource for me). Put even
274shorter: It simply wouldn't exist without C++.
275</dd>
276<dd>
277<p>My personal stance on this is that C++ is less portable than C, but in
278the case of rxvt-unicode this hardly matters, as its portability limits
279are defined by things like X11, pseudo terminals, locale support and unix
280domain sockets, which are all less portable than C++ itself.</p>
281</dd>
282<dd>
283<p>Regarding the bloat, see the above question: It's easy to write programs
284in C that use gobs of memory, an certainly possible to write programs in
285C++ that don't. C++ also often comes with large libraries, but this is
286not necessarily the case with GCC. Here is what rxvt links against on my
287system with a minimal config:</p>
288</dd>
289<dd>
290<pre>
291 libX11.so.6 =&gt; /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
292 libc.so.6 =&gt; /lib/libc.so.6 (0x00002aaaaadde000)
293 libdl.so.2 =&gt; /lib/libdl.so.2 (0x00002aaaab01d000)
294 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)</pre>
295</dd>
296<dd>
297<p>And here is rxvt-unicode:</p>
298</dd>
299<dd>
300<pre>
301 libX11.so.6 =&gt; /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
302 libgcc_s.so.1 =&gt; /lib/libgcc_s.so.1 (0x00002aaaaada2000)
303 libc.so.6 =&gt; /lib/libc.so.6 (0x00002aaaaaeb0000)
304 libdl.so.2 =&gt; /lib/libdl.so.2 (0x00002aaaab0ee000)
305 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)</pre>
306</dd>
307<dd>
308<p>No large bloated libraries (of course, none were linked in statically),
309except maybe libX11 :)</p>
310</dd>
311<p></p>
312<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 />
313</dt>
314<dd>
315Beginning with version 7.3, there is a perl extension that implements a
316simple tabbed terminal. It is installed by default, so any of these should
317give you tabs:
318</dd>
319<dd>
320<pre>
321 rxvt -pe tabbed</pre>
322</dd>
323<dd>
324<pre>
325 URxvt.perl-ext-common: default,tabbed</pre>
326</dd>
327<dd>
328<p>It will also work fine with tabbing functionality of many window managers
329or similar tabbing programs, and its embedding-features allow it to be
330embedded into other programs, as witnessed by <em>doc/rxvt-tabbed</em> or
331the upcoming <code>Gtk2::URxvt</code> perl module, which features a tabbed urxvt
332(murxvt) terminal as an example embedding application.</p>
333</dd>
334<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 /> 335<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> 336</dt>
80<dd> 337<dd>
81The version number is displayed with the usage (-h). Also the escape 338The 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. 339sequence <code>ESC [ 8 n</code> sets the window title to the version number. When
340using the rxvtc client, the version displayed is that of the
341daemon.
83</dd> 342</dd>
84<p></p> 343<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 /> 344<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> 345</dt>
87<dd> 346<dd>
88The Debian GNU/Linux package of rxvt-unicode in sarge contains large 347The Debian GNU/Linux package of rxvt-unicode in sarge contains large
89patches that considerably change the behaviour of rxvt-unicode. Before 348patches that considerably change the behaviour of rxvt-unicode (but
90reporting a bug to the original rxvt-unicode author please download and 349unfortunately this notice has been removed). Before reporting a bug to
350the original rxvt-unicode author please download and install the genuine
91install the genuine version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) 351version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) and try to reproduce
92and try to reproduce the problem. If you cannot, chances are that the 352the problem. If you cannot, chances are that the problems are specific to
93problems are specific to Debian GNU/Linux, in which case it should be 353Debian GNU/Linux, in which case it should be reported via the Debian Bug
94reported via the Debian Bug Tracking System (use <code>reportbug</code> to report 354Tracking System (use <code>reportbug</code> to report the bug).
95the bug).
96</dd> 355</dd>
97<dd> 356<dd>
98<p>For other problems that also affect the Debian package, you can and 357<p>For other problems that also affect the Debian package, you can and
99probably should use the Debian BTS, too, because, after all, it's also a 358probably should use the Debian BTS, too, because, after all, it's also a
100bug in the Debian version and it serves as a reminder for other users that 359bug in the Debian version and it serves as a reminder for other users that
101might encounter the same issue.</p> 360might encounter the same issue.</p>
361</dd>
362<p></p>
363<dt><strong><a name="item_i_am_maintaining_rxvt_2dunicode_for_distribution_2">I am maintaining rxvt-unicode for distribution/OS XXX, any
364recommendation?</a></strong><br />
365</dt>
366<dd>
367You should build one binary with the default options. <em>configure</em>
368now enables most useful options, and the trend goes to making them
369runtime-switchable, too, so there is usually no drawback to enbaling them,
370except higher disk and possibly memory usage. The perl interpreter should
371be enabled, as important functionality (menus, selection, likely more in
372the future) depends on it.
373</dd>
374<dd>
375<p>You should not overwrite the <code>perl-ext-common</code> snd <code>perl-ext</code> resources
376system-wide (except maybe with <code>defaults</code>). This will result in useful
377behaviour. If your distribution aims at low memory, add an empty
378<code>perl-ext-common</code> resource to the app-defaults file. This will keep the
379perl interpreter disabled until the user enables it.</p>
380</dd>
381<dd>
382<p>If you can/want build more binaries, I recommend building a minimal
383one with <code>--disable-everything</code> (very useful) and a maximal one with
384<a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (less useful, it will be very big due to a lot of
385encodings built-in that increase download times and are rarely used).</p>
386</dd>
387<p></p>
388<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 />
389</dt>
390<dd>
391It should be, starting with release 7.1. You are encouraged to properly
392install urxvt with privileges necessary for your OS now.
393</dd>
394<dd>
395<p>When rxvt-unicode detects that it runs setuid or setgid, it will fork
396into a helper process for privileged operations (pty handling on some
397systems, utmp/wtmp/lastlog handling on others) and drop privileges
398immediately. This is much safer than most other terminals that keep
399privileges while running (but is more relevant to urxvt, as it contains
400things as perl interpreters, which might be ``helpful'' to attackers).</p>
401</dd>
402<dd>
403<p>This forking is done as the very first within main(), which is very early
404and reduces possible bugs to initialisation code run before main(), or
405things like the dynamic loader of your system, which should result in very
406little risk.</p>
102</dd> 407</dd>
103<p></p> 408<p></p>
104<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 /> 409<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 />
105</dt> 410</dt>
106<dd> 411<dd>
623You can specify separate locales for the input method and the rest of the 928You can specify separate locales for the input method and the rest of the
624terminal, using the resource <code>imlocale</code>: 929terminal, using the resource <code>imlocale</code>:
625</dd> 930</dd>
626<dd> 931<dd>
627<pre> 932<pre>
628 URxvt*imlocale: ja_JP.EUC-JP</pre> 933 URxvt.imlocale: ja_JP.EUC-JP</pre>
629</dd> 934</dd>
630<dd> 935<dd>
631<p>Now you can start your terminal with <code>LC_CTYPE=ja_JP.UTF-8</code> and still 936<p>Now you can start your terminal with <code>LC_CTYPE=ja_JP.UTF-8</code> and still
632use your input method. Please note, however, that you will not be able to 937use your input method. Please note, however, that you will not be able to
633input characters outside <code>EUC-JP</code> in a normal way then, as your input 938input characters outside <code>EUC-JP</code> in a normal way then, as your input
657when used. Compiling it out ensures that no Xft font will be loaded 962when used. Compiling it out ensures that no Xft font will be loaded
658accidentally when rxvt-unicode tries to find a font for your characters. 963accidentally when rxvt-unicode tries to find a font for your characters.
659</dd> 964</dd>
660<dd> 965<dd>
661<p>Also, many people (me included) like large windows and even larger 966<p>Also, many people (me included) like large windows and even larger
662scrollback buffers: Without <a href="#item__2d_2denable_2dunicode3"><code>--enable-unicode3</code></a>, rxvt-unicode will use 967scrollback buffers: Without <code>--enable-unicode3</code>, rxvt-unicode will use
6636 bytes per screen cell. For a 160x?? window this amounts to almost a 9686 bytes per screen cell. For a 160x?? window this amounts to almost a
664kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 969kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
665use 10 Megabytes of memory. With <a href="#item__2d_2denable_2dunicode3"><code>--enable-unicode3</code></a> it gets worse, as 970use 10 Megabytes of memory. With <code>--enable-unicode3</code> it gets worse, as
666rxvt-unicode then uses 8 bytes per screen cell.</p> 971rxvt-unicode then uses 8 bytes per screen cell.</p>
667</dd> 972</dd>
668<p></p> 973<p></p>
669<dt><strong><a name="item_can_i_speed_up_xft_rendering_somehow_3f">Can I speed up Xft rendering somehow?</a></strong><br /> 974<dt><strong><a name="item_can_i_speed_up_xft_rendering_somehow_3f">Can I speed up Xft rendering somehow?</a></strong><br />
670</dt> 975</dt>
693<dd> 998<dd>
694Make sure that mouse reporting is actually turned off since killing 999Make sure that mouse reporting is actually turned off since killing
695some editors prematurely may leave the mouse in mouse report mode. I've 1000some editors prematurely may leave the mouse in mouse report mode. I've
696heard that tcsh may use mouse reporting unless it otherwise specified. A 1001heard that tcsh may use mouse reporting unless it otherwise specified. A
697quick check is to see if cut/paste works when the Alt or Shift keys are 1002quick check is to see if cut/paste works when the Alt or Shift keys are
698depressed. See <code>rxvt(7)</code> 1003depressed.
699</dd> 1004</dd>
700<p></p> 1005<p></p>
701<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br /> 1006<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br />
702</dt> 1007</dt>
703<dd> 1008<dd>
820 # use Backspace = ^? 1125 # use Backspace = ^?
821 $ stty erase ^? 1126 $ stty erase ^?
822 $ rxvt</pre> 1127 $ rxvt</pre>
823</dd> 1128</dd>
824<dd> 1129<dd>
825<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code> as documented in rxvt(7).</p> 1130<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
826</dd> 1131</dd>
827<dd> 1132<dd>
828<p>For an existing rxvt-unicode:</p> 1133<p>For an existing rxvt-unicode:</p>
829</dd> 1134</dd>
830<dd> 1135<dd>
981</p> 1286</p>
982<hr /> 1287<hr />
983<h1><a name="description">DESCRIPTION</a></h1> 1288<h1><a name="description">DESCRIPTION</a></h1>
984<p>The rest of this document describes various technical aspects of 1289<p>The rest of this document describes various technical aspects of
985<strong>rxvt-unicode</strong>. First the description of supported command sequences, 1290<strong>rxvt-unicode</strong>. First the description of supported command sequences,
986followed by menu and pixmap support and last by a description of all 1291followed by pixmap support and last by a description of all features
987features selectable at <code>configure</code> time.</p> 1292selectable at <code>configure</code> time.</p>
988<p> 1293<p>
989</p> 1294</p>
990<hr /> 1295<hr />
991<h1><a name="definitions">Definitions</a></h1> 1296<h1><a name="definitions">Definitions</a></h1>
992<dl> 1297<dl>
1625</table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>&gt; X10 XTerm</a></strong><br /> 1930</table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>&gt; X10 XTerm</a></strong><br />
1626</dt> 1931</dt>
1627<table> 1932<table>
1628<tr><td>h</td><td>Send Mouse X & Y on button press.</td></tr> 1933<tr><td>h</td><td>Send Mouse X & Y on button press.</td></tr>
1629<tr><td>l</td><td>No mouse reporting.</td></tr> 1934<tr><td>l</td><td>No mouse reporting.</td></tr>
1630</table><dt><strong><a name="item_10"><strong><code>Ps = 10</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1631</dt>
1632<table>
1633<tr><td>h</td><td>menuBar visible</td></tr>
1634<tr><td>l</td><td>menuBar invisible</td></tr>
1635</table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>&gt;</a></strong><br /> 1935</table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>&gt;</a></strong><br />
1636</dt> 1936</dt>
1637<table> 1937<table>
1638<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr> 1938<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr>
1639<tr><td>l</td><td>Invisible cursor {civis}</td></tr> 1939<tr><td>l</td><td>Invisible cursor {civis}</td></tr>
1704</table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br /> 2004</table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1705</dt> 2005</dt>
1706<table> 2006<table>
1707<tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr> 2007<tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr>
1708<tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr> 2008<tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr>
2009</table><dt><strong><a name="item_1021"><strong><code>Ps = 1021</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
2010</dt>
2011<table>
2012<tr><td>h</td><td>Bold/italic implies high intensity (see option -is)</td></tr>
2013<tr><td>l</td><td>Font styles have no effect on intensity (Compile styles)</td></tr>
1709</table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>&gt;</a></strong><br /> 2014</table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>&gt;</a></strong><br />
1710</dt> 2015</dt>
1711<table> 2016<table>
1712<tr><td>h</td><td>Use Alternate Screen Buffer</td></tr> 2017<tr><td>h</td><td>Use Alternate Screen Buffer</td></tr>
1713<tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr> 2018<tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr>
1745<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr> 2050<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr>
1746<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr> 2051<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr>
1747<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr> 2052<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr>
1748<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr> 2053<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr>
1749<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr> 2054<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr>
1750<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt</td></tr> 2055<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr>
1751<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt</td></tr> 2056<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr>
1752<tr><td>Ps = 20</td><td>Change default background to Pt</td></tr> 2057<tr><td>Ps = 20</td><td>Change background pixmap parameters (see section XPM) (Compile XPM).</td></tr>
1753<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr> 2058<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr>
1754<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr> 2059<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr>
1755<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr> 2060<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr>
1756<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> 2061<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>
1757<tr><td>Ps = 55</td><td>Log all scrollback buffer and all of screen to Pt</td></tr> 2062<tr><td>Ps = 55</td><td>Log all scrollback buffer and all of screen to Pt</td></tr>
1758<tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).</td></tr> 2063<tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).</td></tr>
1759<tr><td>Ps = 703</td><td>Menubar command Pt (Compile menubar).</td></tr> 2064<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>
1760<tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr> 2065<tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr>
1761<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr> 2066<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr>
2067<tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr>
2068<tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr>
1762<tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr> 2069<tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr>
1763<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr> 2070<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1764<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr> 2071<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1765<tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr> 2072<tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1766<tr><td>Ps = 720</td><td>Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr> 2073<tr><td>Ps = 720</td><td>Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr>
1767<tr><td>Ps = 721</td><td>Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr> 2074<tr><td>Ps = 721</td><td>Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr>
2075<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>
1768</table><p></p></dl> 2076</table><p></p></dl>
1769<p></p> 2077<p></p>
1770<p>
1771</p>
1772<hr />
1773<h1><a name="menubar">menuBar</a></h1>
1774<p><strong>The exact syntax used is <em>almost</em> solidified. </strong>&gt;
1775In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
1776menuBar.</p>
1777<p>Note that in all of the commands, the <strong><em>/path/</em> </strong>&gt; <em>cannot</em> be
1778omitted: use <strong>./</strong> to specify a menu relative to the current menu.</p>
1779<p>
1780</p>
1781<h2><a name="overview_of_menubar_operation">Overview of menuBar operation</a></h2>
1782<p>For the menuBar XTerm escape sequence <code>ESC ] 703 ; Pt ST</code>, the syntax
1783of <a href="#item_pt"><code>Pt</code></a> can be used for a variety of tasks:</p>
1784<p>At the top level is the current menuBar which is a member of a circular
1785linked-list of other such menuBars.</p>
1786<p>The menuBar acts as a parent for the various drop-down menus, which in
1787turn, may have labels, separator lines, menuItems and subMenus.</p>
1788<p>The menuItems are the useful bits: you can use them to mimic keyboard
1789input or even to send text or escape sequences back to rxvt.</p>
1790<p>The menuBar syntax is intended to provide a simple yet robust method of
1791constructing and manipulating menus and navigating through the
1792menuBars.</p>
1793<p>The first step is to use the tag <strong>[menu:<em>name</em>] </strong>&gt; which creates
1794the menuBar called <em>name</em> and allows access. You may now or menus,
1795subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the
1796menuBar access as <strong>readonly</strong> to prevent accidental corruption of the
1797menus. To re-access the current menuBar for alterations, use the tag
1798<strong>[menu]</strong>, make the alterations and then use <strong>[done]</strong></p>
1799<p></p>
1800<p>
1801</p>
1802<h2><a name="commands">Commands</a></h2>
1803<dl>
1804<dt><strong><a name="item__5bmenu_3a_2bname_5d"><strong>[menu:+<em>name</em>] </strong>&gt;</a></strong><br />
1805</dt>
1806<dd>
1807access the named menuBar for creation or alteration. If a new menuBar
1808is created, it is called <em>name</em> (max of 15 chars) and the current
1809menuBar is pushed onto the stack
1810</dd>
1811<p></p>
1812<dt><strong><a name="item__5bmenu_5d"><strong>[menu]</strong></a></strong><br />
1813</dt>
1814<dd>
1815access the current menuBar for alteration
1816</dd>
1817<p></p>
1818<dt><strong><a name="item__5btitle_3a_2bstring_5d"><strong>[title:+<em>string</em>] </strong>&gt;</a></strong><br />
1819</dt>
1820<dd>
1821set the current menuBar's title to <em>string</em>, which may contain the
1822following format specifiers:
1823</dd>
1824<dd>
1825<pre>
1826 B&lt;%n&gt; rxvt name (as per the B&lt;-name&gt; command-line option)
1827 B&lt;%v&gt; rxvt version
1828 B&lt;%%&gt; literal B&lt;%&gt; character</pre>
1829</dd>
1830<p></p>
1831<dt><strong><a name="item__5bdone_5d"><strong>[done]</strong></a></strong><br />
1832</dt>
1833<dd>
1834set menuBar access as <strong>readonly</strong>.
1835End-of-file tag for <strong>[read:+<em>file</em>] </strong>&gt; operations.
1836</dd>
1837<p></p>
1838<dt><strong><a name="item__5bread_3a_2bfile_5d"><strong>[read:+<em>file</em>] </strong>&gt;</a></strong><br />
1839</dt>
1840<dd>
1841read menu commands directly from <em>file</em> (extension ``.menu'' will be
1842appended if required.) Start reading at a line with <strong>[menu]</strong> or <strong>&lt;
1843[menu:+<em>name</em> </strong>&gt; and continuing until <strong>[done]</strong> is encountered.
1844</dd>
1845<dd>
1846<p>Blank and comment lines (starting with <strong>#</strong>) are ignored. Actually,
1847since any invalid menu commands are also ignored, almost anything could
1848be construed as a comment line, but this may be tightened up in the
1849future ... so don't count on it!.</p>
1850</dd>
1851<p></p>
1852<dt><strong><a name="item__5bread_3a_2bfile_3b_2bname_5d"><strong>[read:+<em>file</em>;+<em>name</em>] </strong>&gt;</a></strong><br />
1853</dt>
1854<dd>
1855The same as <strong>[read:+<em>file</em>] </strong>&gt;, but start reading at a line with
1856<strong>[menu:+<em>name</em>] </strong>&gt; and continuing until <strong>[done:+<em>name</em>] </strong>&gt; or
1857<strong>[done]</strong> is encountered.
1858</dd>
1859<p></p>
1860<dt><strong><a name="item__5bdump_5d"><strong>[dump]</strong></a></strong><br />
1861</dt>
1862<dd>
1863dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable for
1864later rereading.
1865</dd>
1866<p></p>
1867<dt><strong><a name="item__5brm_3aname_5d"><strong>[rm:name]</strong></a></strong><br />
1868</dt>
1869<dd>
1870remove the named menuBar
1871</dd>
1872<p></p>
1873<dt><strong><a name="item__5brm_5d__5brm_3a_5d"><strong>[rm] [rm:]</strong></a></strong><br />
1874</dt>
1875<dd>
1876remove the current menuBar
1877</dd>
1878<p></p>
1879<dt><strong><a name="item__5brm_2a_5d__5brm_3a_2a_5d"><strong>[rm*] [rm:*]</strong></a></strong><br />
1880</dt>
1881<dd>
1882remove all menuBars
1883</dd>
1884<p></p>
1885<dt><strong><a name="item__5bswap_5d"><strong>[swap]</strong></a></strong><br />
1886</dt>
1887<dd>
1888swap the top two menuBars
1889</dd>
1890<p></p>
1891<dt><strong><a name="item__5bprev_5d"><strong>[prev]</strong></a></strong><br />
1892</dt>
1893<dd>
1894access the previous menuBar
1895</dd>
1896<p></p>
1897<dt><strong><a name="item__5bnext_5d"><strong>[next]</strong></a></strong><br />
1898</dt>
1899<dd>
1900access the next menuBar
1901</dd>
1902<p></p>
1903<dt><strong><a name="item__5bshow_5d"><strong>[show]</strong></a></strong><br />
1904</dt>
1905<dd>
1906Enable display of the menuBar
1907</dd>
1908<p></p>
1909<dt><strong><a name="item__5bhide_5d"><strong>[hide]</strong></a></strong><br />
1910</dt>
1911<dd>
1912Disable display of the menuBar
1913</dd>
1914<p></p>
1915<dt><strong><a name="item__5bpixmap_3a_2bname_5d"><strong>[pixmap:+<em>name</em>] </strong>&gt;</a></strong><br />
1916</dt>
1917<dt><strong><a name="item__5bpixmap_3a_2bname_3bscaling_5d"><strong>[pixmap:+<em>name</em>;<em>scaling</em>] </strong>&gt;</a></strong><br />
1918</dt>
1919<dd>
1920(set the background pixmap globally
1921</dd>
1922<dd>
1923<p><strong>A Future implementation <em>may</em> make this local to the menubar </strong>&gt;)</p>
1924</dd>
1925<p></p>
1926<dt><strong><a name="item__5b_3a_2bcommand_3a_5d"><strong>[:+<em>command</em>:] </strong>&gt;</a></strong><br />
1927</dt>
1928<dd>
1929ignore the menu readonly status and issue a <em>command</em> to or a menu or
1930menuitem or change the ; a useful shortcut for setting the quick arrows
1931from a menuBar.
1932</dd>
1933<p></p></dl>
1934<p></p>
1935<p>
1936</p>
1937<h2><a name="adding_and_accessing_menus">Adding and accessing menus</a></h2>
1938<p>The following commands may also be <strong>+</strong> prefixed.</p>
1939<dl>
1940<dt><strong><a name="item__2f_2b"><strong>/+</strong></a></strong><br />
1941</dt>
1942<dd>
1943access menuBar top level
1944</dd>
1945<p></p>
1946<dt><strong><a name="item__2e_2f_2b"><strong>./+</strong></a></strong><br />
1947</dt>
1948<dd>
1949access current menu level
1950</dd>
1951<p></p>
1952<dt><strong><a name="item__2e_2e_2f_2b"><strong>../+</strong></a></strong><br />
1953</dt>
1954<dd>
1955access parent menu (1 level up)
1956</dd>
1957<p></p>
1958<dt><strong><a name="item__2e_2e_2f_2e_2e_2f"><strong>../../</strong></a></strong><br />
1959</dt>
1960<dd>
1961access parent menu (multiple levels up)
1962</dd>
1963<p></p>
1964<dt><strong><a name="item__2fpath_2fmenu"><strong><em>/path/</em>menu </strong>&gt;</a></strong><br />
1965</dt>
1966<dd>
1967add/access menu
1968</dd>
1969<p></p>
1970<dt><strong><a name="item__2fpath_2fmenu_2f_2a"><strong><em>/path/</em>menu/* </strong>&gt;</a></strong><br />
1971</dt>
1972<dd>
1973add/access menu and clear it if it exists
1974</dd>
1975<p></p>
1976<dt><strong><a name="item__2fpath_2f_7b_2d_7d"><strong><em>/path/</em>{-} </strong>&gt;</a></strong><br />
1977</dt>
1978<dd>
1979add separator
1980</dd>
1981<p></p>
1982<dt><strong><a name="item__2fpath_2f_7bitem_7d"><strong><em>/path/</em>{item} </strong>&gt;</a></strong><br />
1983</dt>
1984<dd>
1985add <strong>item</strong> as a label
1986</dd>
1987<p></p>
1988<dt><strong><a name="item__2fpath_2f_7bitem_7d_action"><strong><em>/path/</em>{item} action </strong>&gt;</a></strong><br />
1989</dt>
1990<dd>
1991add/alter <em>menuitem</em> with an associated <em>action</em>
1992</dd>
1993<p></p>
1994<dt><strong><a name="item__2fpath_2f_7bitem_7d_7bright_2dtext_7d"><strong><em>/path/</em>{item}{right-text} </strong>&gt;</a></strong><br />
1995</dt>
1996<dd>
1997add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified text
1998and as the associated <em>action</em>
1999</dd>
2000<p></p>
2001<dt><strong><a name="item__2fpath_2f_7bitem_7d_7brtext_7d_action"><strong><em>/path/</em>{item}{rtext} action </strong>&gt;</a></strong><br />
2002</dt>
2003<dd>
2004add/alter <em>menuitem</em> with an associated <em>action</em> and with <strong>rtext</strong> as
2005the right-justified text.
2006</dd>
2007<p></p></dl>
2008<dl>
2009<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 />
2010</dt>
2011<dd>
2012<strong>\a \b \E \e \n \r \t \octal</strong>
2013</dd>
2014<p></p>
2015<dt><strong><a name="item_or_in_control_2dcharacter_notation_3a">or in control-character notation:</a></strong><br />
2016</dt>
2017<dd>
2018<strong>^@, ^A .. ^Z .. ^_, ^?</strong>
2019</dd>
2020<p></p></dl>
2021<p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the
2022program, start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>),
2023the first of which will be stripped off and the balance directed to the
2024program. Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by
2025non-+<strong>NUL</strong> characters, the leading <strong>NUL</strong> is stripped off and the
2026balance is sent back to rxvt.</p>
2027<p>As a convenience for the many Emacs-type editors, <em>action</em> may start
2028with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
2029appended if missed from <strong>M-x</strong> commands.</p>
2030<p>As a convenience for issuing XTerm <strong>ESC ]</strong> sequences from a menubar (or
2031quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.</p>
2032<dl>
2033<dt><strong><a name="item_for_example_2c">For example,</a></strong><br />
2034</dt>
2035<dd>
2036<strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong>
2037</dd>
2038<p></p>
2039<dt><strong><a name="item_and">and</a></strong><br />
2040</dt>
2041<dd>
2042<strong>\E]703;mona;100</strong> is equivalent to <strong>\E]703;mona;100\a</strong>
2043</dd>
2044<p></p></dl>
2045<p>The option <strong>{<em>right-rtext</em>} </strong>&gt; will be right-justified. In the
2046absence of a specified action, this text will be used as the <em>action</em>
2047as well.</p>
2048<dl>
2049<dt><strong>For example,</strong><br />
2050</dt>
2051<dd>
2052<strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong>
2053</dd>
2054<p></p></dl>
2055<p>The left label <em>is</em> necessary, since it's used for matching, but
2056implicitly hiding the left label (by using same name for both left and
2057right labels), or explicitly hiding the left label (by preceeding it
2058with a dot), makes it possible to have right-justified text only.</p>
2059<dl>
2060<dt><strong>For example,</strong><br />
2061</dt>
2062<dd>
2063<strong>/File/{Open}{Open} Open-File-Action</strong>
2064</dd>
2065<p></p>
2066<dt><strong><a name="item_or_hiding_it">or hiding it</a></strong><br />
2067</dt>
2068<dd>
2069<strong>/File/{.anylabel}{Open} Open-File-Action</strong>
2070</dd>
2071<p></p></dl>
2072<p></p>
2073<p>
2074</p>
2075<h2><a name="removing_menus">Removing menus</a></h2>
2076<dl>
2077<dt><strong><a name="item__2d_2f_2a_2b"><strong>-/*+ </strong>&gt;</a></strong><br />
2078</dt>
2079<dd>
2080remove all menus from the menuBar, the same as <strong>[clear]</strong>
2081</dd>
2082<p></p>
2083<dt><strong><a name="item__2d_2b_2fpathmenu_2b"><strong>-+<em>/path</em>menu+ </strong>&gt;</a></strong><br />
2084</dt>
2085<dd>
2086remove menu
2087</dd>
2088<p></p>
2089<dt><strong><a name="item__2d_2b_2fpath_7bitem_7d_2b"><strong>-+<em>/path</em>{item}+ </strong>&gt;</a></strong><br />
2090</dt>
2091<dd>
2092remove item
2093</dd>
2094<p></p>
2095<dt><strong><a name="item__2d_2b_2fpath_7b_2d_7d"><strong>-+<em>/path</em>{-} </strong>&gt;</a></strong><br />
2096</dt>
2097<dd>
2098remove separator)
2099</dd>
2100<p></p>
2101<dt><strong><a name="item__2d_2fpath_2fmenu_2f_2a"><strong>-/path/menu/*</strong></a></strong><br />
2102</dt>
2103<dd>
2104remove all items, separators and submenus from menu
2105</dd>
2106<p></p></dl>
2107<p></p>
2108<p>
2109</p>
2110<h2><a name="quick_arrows">Quick Arrows</a></h2>
2111<p>The menus also provide a hook for <em>quick arrows</em> to provide easier
2112user access. If nothing has been explicitly set, the default is to
2113emulate the curror keys. The syntax permits each arrow to be altered
2114individually or all four at once without re-entering their common
2115beginning/end text. For example, to explicitly associate cursor actions
2116with the arrows, any of the following forms could be used:</p>
2117<dl>
2118<dt><strong><a name="item__3cr_3e_2bright"><strong>&lt;r</strong>+<em>Right</em> &gt;&gt;</a></strong><br />
2119</dt>
2120<dt><strong><a name="item__3cl_3e_2bleft"><strong>&lt;l</strong>+<em>Left</em> &gt;&gt;</a></strong><br />
2121</dt>
2122<dt><strong><a name="item__3cu_3e_2bup"><strong>&lt;u</strong>+<em>Up</em> &gt;&gt;</a></strong><br />
2123</dt>
2124<dt><strong><a name="item__3cd_3e_2bdown"><strong>&lt;d</strong>+<em>Down</em> &gt;&gt;</a></strong><br />
2125</dt>
2126<dd>
2127Define actions for the respective arrow buttons
2128</dd>
2129<p></p>
2130<dt><strong><a name="item__3cb_3e_2bbegin"><strong>&lt;b</strong>+<em>Begin</em> &gt;&gt;</a></strong><br />
2131</dt>
2132<dt><strong><a name="item__3ce_3e_2bend"><strong>&lt;e</strong>+<em>End</em> &gt;&gt;</a></strong><br />
2133</dt>
2134<dd>
2135Define common beginning/end parts for <em>quick arrows</em> which used in
2136conjunction with the above &lt;r&gt; &lt;l&gt; &lt;u&gt; &lt;d&gt; constructs
2137</dd>
2138<p></p></dl>
2139<dl>
2140<dt><strong><a name="item_for_example_2c_define_arrows_individually_2c">For example, define arrows individually,</a></strong><br />
2141</dt>
2142<dd>
2143<pre>
2144 &lt;u&gt;\E[A</pre>
2145</dd>
2146<dd>
2147<pre>
2148 &lt;d&gt;\E[B</pre>
2149</dd>
2150<dd>
2151<pre>
2152 &lt;r&gt;\E[C</pre>
2153</dd>
2154<dd>
2155<pre>
2156 &lt;l&gt;\E[D</pre>
2157</dd>
2158<dt><strong><a name="item_or_all_at_once">or all at once</a></strong><br />
2159</dt>
2160<dd>
2161<pre>
2162 &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>
2163</dd>
2164<dt><strong><a name="item_compactly">or more compactly (factoring out common parts)</a></strong><br />
2165</dt>
2166<dd>
2167<pre>
2168 &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>
2169</dd>
2170</dl>
2171<p></p>
2172<p>
2173</p>
2174<h2><a name="command_summary">Command Summary</a></h2>
2175<p>A short summary of the most <em>common</em> commands:</p>
2176<dl>
2177<dt><strong><a name="item__5bmenu_3aname_5d">[menu:name]</a></strong><br />
2178</dt>
2179<dd>
2180use an existing named menuBar or start a new one
2181</dd>
2182<p></p>
2183<dt><strong>[menu]</strong><br />
2184</dt>
2185<dd>
2186use the current menuBar
2187</dd>
2188<p></p>
2189<dt><strong><a name="item__5btitle_3astring_5d">[title:string]</a></strong><br />
2190</dt>
2191<dd>
2192set menuBar title
2193</dd>
2194<p></p>
2195<dt><strong>[done]</strong><br />
2196</dt>
2197<dd>
2198set menu access to readonly and, if reading from a file, signal EOF
2199</dd>
2200<p></p>
2201<dt><strong><a name="item__5bdone_3aname_5d">[done:name]</a></strong><br />
2202</dt>
2203<dd>
2204if reading from a file using [read:file;name] signal EOF
2205</dd>
2206<p></p>
2207<dt><strong>[rm:name]</strong><br />
2208</dt>
2209<dd>
2210remove named <code>menuBar(s)</code>
2211</dd>
2212<p></p>
2213<dt><strong>[rm] [rm:]</strong><br />
2214</dt>
2215<dd>
2216remove current menuBar
2217</dd>
2218<p></p>
2219<dt><strong>[rm*] [rm:*]</strong><br />
2220</dt>
2221<dd>
2222remove all <code>menuBar(s)</code>
2223</dd>
2224<p></p>
2225<dt><strong>[swap]</strong><br />
2226</dt>
2227<dd>
2228swap top two menuBars
2229</dd>
2230<p></p>
2231<dt><strong>[prev]</strong><br />
2232</dt>
2233<dd>
2234access the previous menuBar
2235</dd>
2236<p></p>
2237<dt><strong>[next]</strong><br />
2238</dt>
2239<dd>
2240access the next menuBar
2241</dd>
2242<p></p>
2243<dt><strong>[show]</strong><br />
2244</dt>
2245<dd>
2246map menuBar
2247</dd>
2248<p></p>
2249<dt><strong>[hide]</strong><br />
2250</dt>
2251<dd>
2252unmap menuBar
2253</dd>
2254<p></p>
2255<dt><strong><a name="item__5bpixmap_3bfile_5d">[pixmap;file]</a></strong><br />
2256</dt>
2257<dt><strong><a name="item__5bpixmap_3bfile_3bscaling_5d">[pixmap;file;scaling]</a></strong><br />
2258</dt>
2259<dd>
2260set a background pixmap
2261</dd>
2262<p></p>
2263<dt><strong><a name="item__5bread_3afile_5d">[read:file]</a></strong><br />
2264</dt>
2265<dt><strong><a name="item__5bread_3afile_3bname_5d">[read:file;name]</a></strong><br />
2266</dt>
2267<dd>
2268read in a menu from a file
2269</dd>
2270<p></p>
2271<dt><strong>[dump]</strong><br />
2272</dt>
2273<dd>
2274dump out all menuBars to /tmp/rxvt-PID
2275</dd>
2276<p></p>
2277<dt><strong><a name="item__2f">/</a></strong><br />
2278</dt>
2279<dd>
2280access menuBar top level
2281</dd>
2282<p></p>
2283<dt><strong><a name="item__2e_2f">./</a></strong><br />
2284</dt>
2285<dt><strong><a name="item__2e_2e_2f">../</a></strong><br />
2286</dt>
2287<dt><strong>../../</strong><br />
2288</dt>
2289<dd>
2290access current or parent menu level
2291</dd>
2292<p></p>
2293<dt><strong>/path/menu</strong><br />
2294</dt>
2295<dd>
2296add/access menu
2297</dd>
2298<p></p>
2299<dt><strong>/path/{-}</strong><br />
2300</dt>
2301<dd>
2302add separator
2303</dd>
2304<p></p>
2305<dt><strong>/path/{item}{rtext} action</strong><br />
2306</dt>
2307<dd>
2308add/alter menu item
2309</dd>
2310<p></p>
2311<dt><strong><a name="item__2d_2f_2a">-/*</a></strong><br />
2312</dt>
2313<dd>
2314remove all menus from the menuBar
2315</dd>
2316<p></p>
2317<dt><strong><a name="item__2d_2fpath_2fmenu">-/path/menu</a></strong><br />
2318</dt>
2319<dd>
2320remove menu items, separators and submenus from menu
2321</dd>
2322<p></p>
2323<dt><strong>-/path/menu</strong><br />
2324</dt>
2325<dd>
2326remove menu
2327</dd>
2328<p></p>
2329<dt><strong><a name="item__2d_2fpath_2f_7bitem_7d">-/path/{item}</a></strong><br />
2330</dt>
2331<dd>
2332remove item
2333</dd>
2334<p></p>
2335<dt><strong><a name="item__2d_2fpath_2f_7b_2d_7d">-/path/{-}</a></strong><br />
2336</dt>
2337<dd>
2338remove separator
2339</dd>
2340<p></p>
2341<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 />
2342</dt>
2343<dd>
2344menu quick arrows
2345</dd>
2346<p></p></dl>
2347<p> 2078<p>
2348</p> 2079</p>
2349<hr /> 2080<hr />
2350<h1><a name="xpm">XPM</a></h1> 2081<h1><a name="xpm">XPM</a></h1>
2351<p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>&gt; then value 2082<p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>&gt; then value
2534</table><p> 2265</table><p>
2535</p> 2266</p>
2536<hr /> 2267<hr />
2537<h1><a name="configure_options">CONFIGURE OPTIONS</a></h1> 2268<h1><a name="configure_options">CONFIGURE OPTIONS</a></h1>
2538<p>General hint: if you get compile errors, then likely your configuration 2269<p>General hint: if you get compile errors, then likely your configuration
2539hasn't been tested well. Either try with --enable-everything or use the 2270hasn't been tested well. Either try with <a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> or use
2540./reconf script as a base for experiments. ./reconf is used by myself, 2271the <em>./reconf</em> script as a base for experiments. <em>./reconf</em> is used by
2541so it should generally be a working config. Of course, you should always 2272myself, so it should generally be a working config. Of course, you should
2542report when a combination doesn't work, so it can be fixed. Marc Lehmann 2273always report when a combination doesn't work, so it can be fixed. Marc
2543&lt;<a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a>&gt;.</p> 2274Lehmann &lt;<a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a>&gt;.</p>
2275<p>All</p>
2544<dl> 2276<dl>
2545<dt><strong><a name="item__2d_2denable_2deverything">--enable-everything</a></strong><br /> 2277<dt><strong><a name="item__2d_2denable_2deverything">--enable-everything</a></strong><br />
2546</dt> 2278</dt>
2547<dd> 2279<dd>
2548Add support for all non-multichoice options listed in ``./configure 2280Add (or remove) support for all non-multichoice options listed in ``./configure
2549--help''. Note that unlike other enable options this is order dependant. 2281--help''.
2550You can specify this and then disable options which this enables by 2282</dd>
2551<em>following</em> this with the appropriate commands.
2552</dd> 2283<dd>
2284<p>You can specify this and then disable options you do not like by
2285<em>following</em> this with the appropriate <code>--disable-...</code> arguments,
2286or you can start with a minimal configuration by specifying
2287<code>--disable-everything</code> and than adding just the <code>--enable-...</code> arguments
2288you want.</p>
2289</dd>
2553<p></p> 2290<p></p>
2554<dt><strong><a name="item__2d_2denable_2dxft">--enable-xft</a></strong><br /> 2291<dt><strong><a name="item_xft">--enable-xft (default: enabled)</a></strong><br />
2555</dt> 2292</dt>
2556<dd> 2293<dd>
2557Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2294Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2558slower and require lots of memory, but as long as you don't use them, you 2295slower and require lots of memory, but as long as you don't use them, you
2559don't pay for them. 2296don't pay for them.
2560</dd> 2297</dd>
2561<p></p> 2298<p></p>
2562<dt><strong><a name="item__2d_2denable_2dfont_2dstyles">--enable-font-styles</a></strong><br /> 2299<dt><strong><a name="item_styles">--enable-font-styles (default: on)</a></strong><br />
2563</dt> 2300</dt>
2564<dd> 2301<dd>
2565Add support for <strong>bold</strong>, <em>italic</em> and <strong><em>bold italic</em> </strong>&gt; font 2302Add support for <strong>bold</strong>, <em>italic</em> and <strong><em>bold italic</em> </strong>&gt; font
2566styles. The fonts can be set manually or automatically. 2303styles. The fonts can be set manually or automatically.
2567</dd> 2304</dd>
2568<p></p> 2305<p></p>
2569<dt><strong><a name="item__2d_2dwith_2dcodesets_3dname_2c_2e_2e_2e">--with-codesets=NAME,...</a></strong><br /> 2306<dt><strong><a name="item__2d_2dwith_2dcodesets_3dname_2c_2e_2e_2e__28defaul">--with-codesets=NAME,... (default: all)</a></strong><br />
2570</dt> 2307</dt>
2571<dd> 2308<dd>
2572Compile in support for additional codeset (encoding) groups (<code>eu</code>, <code>vn</code> 2309Compile in support for additional codeset (encoding) groups (<code>eu</code>, <code>vn</code>
2573are always compiled in, which includes most 8-bit character sets). These 2310are always compiled in, which includes most 8-bit character sets). These
2574codeset tables are used for driving X11 core fonts, they are not required 2311codeset tables are used for driving X11 core fonts, they are not required
2583<tr><td>zh_ext</td><td>rarely used but very big chinese encodigs</td></tr> 2320<tr><td>zh_ext</td><td>rarely used but very big chinese encodigs</td></tr>
2584<tr><td>jp</td><td>common japanese encodings</td></tr> 2321<tr><td>jp</td><td>common japanese encodings</td></tr>
2585<tr><td>jp_ext</td><td>rarely used but big japanese encodings</td></tr> 2322<tr><td>jp_ext</td><td>rarely used but big japanese encodings</td></tr>
2586<tr><td>kr</td><td>korean encodings</td></tr> 2323<tr><td>kr</td><td>korean encodings</td></tr>
2587</table><p></p> 2324</table><p></p>
2588<dt><strong><a name="item__2d_2denable_2dxim">--enable-xim</a></strong><br /> 2325<dt><strong><a name="item_xim">--enable-xim (default: on)</a></strong><br />
2589</dt> 2326</dt>
2590<dd> 2327<dd>
2591Add support for XIM (X Input Method) protocol. This allows using 2328Add support for XIM (X Input Method) protocol. This allows using
2592alternative input methods (e.g. kinput2) and will also correctly 2329alternative input methods (e.g. kinput2) and will also correctly
2593set up the input for people using dead keys or compose keys. 2330set up the input for people using dead keys or compose keys.
2594</dd> 2331</dd>
2595<p></p> 2332<p></p>
2596<dt><strong><a name="item__2d_2denable_2dunicode3">--enable-unicode3</a></strong><br /> 2333<dt><strong><a name="item_unicode3">--enable-unicode3 (default: off)</a></strong><br />
2597</dt> 2334</dt>
2335<dd>
2336Recommended to stay off unless you really need non-BMP characters.
2598<dd> 2337</dd>
2338<dd>
2599Enable direct support for displaying unicode codepoints above 2339<p>Enable direct support for displaying unicode codepoints above
260065535 (the basic multilingual page). This increases storage 234065535 (the basic multilingual page). This increases storage
2601requirements per character from 2 to 4 bytes. X11 fonts do not yet 2341requirements per character from 2 to 4 bytes. X11 fonts do not yet
2602support these extra characters, but Xft does. 2342support these extra characters, but Xft does.</p>
2603</dd> 2343</dd>
2604<dd> 2344<dd>
2605<p>Please note that rxvt-unicode can store unicode code points &gt;65535 2345<p>Please note that rxvt-unicode can store unicode code points &gt;65535
2606even without this flag, but the number of such characters is 2346even without this flag, but the number of such characters is
2607limited to a view thousand (shared with combining characters, 2347limited to a view thousand (shared with combining characters,
2608see next switch), and right now rxvt-unicode cannot display them 2348see next switch), and right now rxvt-unicode cannot display them
2609(input/output and cut&amp;paste still work, though).</p> 2349(input/output and cut&amp;paste still work, though).</p>
2610</dd> 2350</dd>
2611<p></p> 2351<p></p>
2612<dt><strong><a name="item__2d_2denable_2dcombining">--enable-combining</a></strong><br /> 2352<dt><strong><a name="item_combining">--enable-combining (default: on)</a></strong><br />
2613</dt> 2353</dt>
2614<dd> 2354<dd>
2615Enable automatic composition of combining characters into 2355Enable automatic composition of combining characters into
2616composite characters. This is required for proper viewing of text 2356composite characters. This is required for proper viewing of text
2617where accents are encoded as seperate unicode characters. This is 2357where accents are encoded as seperate unicode characters. This is
2618done by using precomposited characters when available or creating 2358done by using precomposited characters when available or creating
2619new pseudo-characters when no precomposed form exists. 2359new pseudo-characters when no precomposed form exists.
2620</dd> 2360</dd>
2621<dd> 2361<dd>
2622<p>Without --enable-unicode3, the number of additional precomposed characters 2362<p>Without --enable-unicode3, the number of additional precomposed
2623is rather limited (2048, if this is full, rxvt-unicode will use the 2363characters is somewhat limited (the 6400 private use characters will be
2624private use area, extending the number of combinations to 8448). With
2625--enable-unicode3, no practical limit exists.</p> 2364(ab-)used). With --enable-unicode3, no practical limit exists.</p>
2626</dd> 2365</dd>
2627<dd> 2366<dd>
2628<p>This option will also enable storage (but not display) of characters 2367<p>This option will also enable storage (but not display) of characters
2629beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p> 2368beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p>
2630</dd> 2369</dd>
2632<p>The combining table also contains entries for arabic presentation forms, 2371<p>The combining table also contains entries for arabic presentation forms,
2633but these are not currently used. Bug me if you want these to be used (and 2372but these are not currently used. Bug me if you want these to be used (and
2634tell me how these are to be used...).</p> 2373tell me how these are to be used...).</p>
2635</dd> 2374</dd>
2636<p></p> 2375<p></p>
2637<dt><strong><a name="item_fallback">--enable-fallback(=CLASS)</a></strong><br /> 2376<dt><strong><a name="item_fallback">--enable-fallback(=CLASS) (default: Rxvt)</a></strong><br />
2638</dt> 2377</dt>
2639<dd> 2378<dd>
2640When reading resource settings, also read settings for class CLASS 2379When reading resource settings, also read settings for class CLASS. To
2641(default: Rxvt). To disable resource fallback use --disable-fallback. 2380disable resource fallback use --disable-fallback.
2642</dd>
2643<p></p>
2644<dt><strong><a name="item__2d_2dwith_2dres_2dname_3dname">--with-res-name=NAME</a></strong><br />
2645</dt>
2646<dd> 2381</dd>
2382<p></p>
2383<dt><strong><a name="item_name">--with-res-name=NAME (default: urxvt)</a></strong><br />
2384</dt>
2385<dd>
2647Use the given name (default: urxvt) as default application name when 2386Use the given name as default application name when
2648reading resources. Specify --with-res-name=rxvt to replace rxvt. 2387reading resources. Specify --with-res-name=rxvt to replace rxvt.
2649</dd> 2388</dd>
2650<p></p> 2389<p></p>
2651<dt><strong><a name="item__2d_2dwith_2dres_2dclass_3dclass">--with-res-class=CLASS</a></strong><br /> 2390<dt><strong><a name="item__2d_2dwith_2dres_2dclass_3dclass__2fdefault_3a_urx">--with-res-class=CLASS /default: URxvt)</a></strong><br />
2652</dt> 2391</dt>
2653<dd> 2392<dd>
2654Use the given class (default: URxvt) as default application class 2393Use the given class as default application class
2655when reading resources. Specify --with-res-class=Rxvt to replace 2394when reading resources. Specify --with-res-class=Rxvt to replace
2656rxvt. 2395rxvt.
2657</dd> 2396</dd>
2658<p></p> 2397<p></p>
2659<dt><strong><a name="item__2d_2denable_2dutmp">--enable-utmp</a></strong><br /> 2398<dt><strong><a name="item_utmp">--enable-utmp (default: on)</a></strong><br />
2660</dt> 2399</dt>
2661<dd> 2400<dd>
2662Write user and tty to utmp file (used by programs like <em>w</em>) at 2401Write user and tty to utmp file (used by programs like <em>w</em>) at
2663start of rxvt execution and delete information when rxvt exits. 2402start of rxvt execution and delete information when rxvt exits.
2664</dd> 2403</dd>
2665<p></p> 2404<p></p>
2666<dt><strong><a name="item__2d_2denable_2dwtmp">--enable-wtmp</a></strong><br /> 2405<dt><strong><a name="item_wtmp">--enable-wtmp (default: on)</a></strong><br />
2667</dt> 2406</dt>
2668<dd> 2407<dd>
2669Write user and tty to wtmp file (used by programs like <em>last</em>) at 2408Write user and tty to wtmp file (used by programs like <em>last</em>) at
2670start of rxvt execution and write logout when rxvt exits. This 2409start of rxvt execution and write logout when rxvt exits. This
2671option requires --enable-utmp to also be specified. 2410option requires --enable-utmp to also be specified.
2672</dd> 2411</dd>
2673<p></p> 2412<p></p>
2674<dt><strong><a name="item__2d_2denable_2dlastlog">--enable-lastlog</a></strong><br /> 2413<dt><strong><a name="item_lastlog">--enable-lastlog (default: on)</a></strong><br />
2675</dt> 2414</dt>
2676<dd> 2415<dd>
2677Write user and tty to lastlog file (used by programs like 2416Write user and tty to lastlog file (used by programs like
2678<em>lastlogin</em>) at start of rxvt execution. This option requires 2417<em>lastlogin</em>) at start of rxvt execution. This option requires
2679--enable-utmp to also be specified. 2418--enable-utmp to also be specified.
2680</dd> 2419</dd>
2681<p></p> 2420<p></p>
2682<dt><strong><a name="item__2d_2denable_2dxpm_2dbackground">--enable-xpm-background</a></strong><br /> 2421<dt><strong><a name="item_background">--enable-xpm-background (default: on)</a></strong><br />
2683</dt> 2422</dt>
2684<dd> 2423<dd>
2685Add support for XPM background pixmaps. 2424Add support for XPM background pixmaps.
2686</dd> 2425</dd>
2687<p></p> 2426<p></p>
2688<dt><strong><a name="item__2d_2denable_2dtransparency">--enable-transparency</a></strong><br /> 2427<dt><strong><a name="item_transparency">--enable-transparency (default: on)</a></strong><br />
2689</dt> 2428</dt>
2690<dd> 2429<dd>
2691Add support for inheriting parent backgrounds thus giving a fake 2430Add support for inheriting parent backgrounds thus giving a fake
2692transparency to the term. 2431transparency to the term.
2693</dd> 2432</dd>
2694<p></p> 2433<p></p>
2695<dt><strong><a name="item__2d_2denable_2dfading">--enable-fading</a></strong><br /> 2434<dt><strong><a name="item_fading">--enable-fading (default: on)</a></strong><br />
2696</dt> 2435</dt>
2697<dd>
2698Add support for fading the text when focus is lost.
2699</dd> 2436<dd>
2700<p></p> 2437Add support for fading the text when focus is lost (requires <code>--enable-transparency</code>).
2701<dt><strong><a name="item__2d_2denable_2dtinting">--enable-tinting</a></strong><br />
2702</dt>
2703<dd> 2438</dd>
2704Add support for tinting of transparent backgrounds. 2439<p></p>
2440<dt><strong><a name="item_tinting">--enable-tinting (default: on)</a></strong><br />
2441</dt>
2705</dd> 2442<dd>
2706<p></p> 2443Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>).
2707<dt><strong><a name="item__2d_2denable_2dmenubar">--enable-menubar</a></strong><br />
2708</dt>
2709<dd> 2444</dd>
2710Add support for our menu bar system (this interacts badly with
2711dynamic locale switching currently).
2712</dd>
2713<p></p> 2445<p></p>
2714<dt><strong><a name="item__2d_2denable_2drxvt_2dscroll">--enable-rxvt-scroll</a></strong><br /> 2446<dt><strong><a name="item_scroll">--enable-rxvt-scroll (default: on)</a></strong><br />
2715</dt> 2447</dt>
2716<dd> 2448<dd>
2717Add support for the original rxvt scrollbar. 2449Add support for the original rxvt scrollbar.
2718</dd> 2450</dd>
2719<p></p> 2451<p></p>
2720<dt><strong><a name="item__2d_2denable_2dnext_2dscroll">--enable-next-scroll</a></strong><br /> 2452<dt><strong>--enable-next-scroll (default: on)</strong><br />
2721</dt> 2453</dt>
2722<dd> 2454<dd>
2723Add support for a NeXT-like scrollbar. 2455Add support for a NeXT-like scrollbar.
2724</dd> 2456</dd>
2725<p></p> 2457<p></p>
2726<dt><strong><a name="item__2d_2denable_2dxterm_2dscroll">--enable-xterm-scroll</a></strong><br /> 2458<dt><strong>--enable-xterm-scroll (default: on)</strong><br />
2727</dt> 2459</dt>
2728<dd> 2460<dd>
2729Add support for an Xterm-like scrollbar. 2461Add support for an Xterm-like scrollbar.
2730</dd> 2462</dd>
2731<p></p> 2463<p></p>
2732<dt><strong><a name="item__2d_2denable_2dplain_2dscroll">--enable-plain-scroll</a></strong><br /> 2464<dt><strong>--enable-plain-scroll (default: on)</strong><br />
2733</dt> 2465</dt>
2734<dd> 2466<dd>
2735Add support for a very unobtrusive, plain-looking scrollbar that 2467Add support for a very unobtrusive, plain-looking scrollbar that
2736is the favourite of the rxvt-unicode author, having used it for 2468is the favourite of the rxvt-unicode author, having used it for
2737many years. 2469many years.
2738</dd> 2470</dd>
2739<p></p> 2471<p></p>
2740<dt><strong><a name="item__2d_2denable_2dhalf_2dshadow">--enable-half-shadow</a></strong><br />
2741</dt>
2742<dd>
2743Make shadows on the scrollbar only half the normal width &amp; height.
2744only applicable to rxvt scrollbars.
2745</dd>
2746<p></p>
2747<dt><strong><a name="item__2d_2denable_2dttygid">--enable-ttygid</a></strong><br /> 2472<dt><strong><a name="item_ttygid">--enable-ttygid (default: off)</a></strong><br />
2748</dt> 2473</dt>
2749<dd> 2474<dd>
2750Change tty device setting to group ``tty'' - only use this if 2475Change tty device setting to group ``tty'' - only use this if
2751your system uses this type of security. 2476your system uses this type of security.
2752</dd> 2477</dd>
2753<p></p> 2478<p></p>
2754<dt><strong><a name="item__2d_2ddisable_2dbackspace_2dkey">--disable-backspace-key</a></strong><br /> 2479<dt><strong><a name="item__2d_2ddisable_2dbackspace_2dkey">--disable-backspace-key</a></strong><br />
2755</dt> 2480</dt>
2756<dd> 2481<dd>
2757Disable any handling of the backspace key by us - let the X server 2482Removes any handling of the backspace key by us - let the X server do it.
2483</dd>
2484<p></p>
2485<dt><strong><a name="item__2d_2ddisable_2ddelete_2dkey">--disable-delete-key</a></strong><br />
2486</dt>
2487<dd>
2488Removes any handling of the delete key by us - let the X server
2758do it. 2489do it.
2759</dd> 2490</dd>
2760<p></p> 2491<p></p>
2761<dt><strong><a name="item__2d_2ddisable_2ddelete_2dkey">--disable-delete-key</a></strong><br />
2762</dt>
2763<dd>
2764Disable any handling of the delete key by us - let the X server
2765do it.
2766</dd>
2767<p></p>
2768<dt><strong><a name="item__2d_2ddisable_2dresources">--disable-resources</a></strong><br /> 2492<dt><strong><a name="item__2d_2ddisable_2dresources">--disable-resources</a></strong><br />
2769</dt> 2493</dt>
2770<dd> 2494<dd>
2771Remove all resources checking. 2495Removes any support for resource checking.
2772</dd>
2773<p></p>
2774<dt><strong><a name="item__2d_2denable_2dxgetdefault">--enable-xgetdefault</a></strong><br />
2775</dt>
2776<dd>
2777Make resources checking via <code>XGetDefault()</code> instead of our small
2778version which only checks ~/.Xdefaults, or if that doesn't exist then
2779~/.Xresources.
2780</dd>
2781<dd>
2782<p>Please note that nowadays, things like XIM will automatically pull in and
2783use the full X resource manager, so the overhead of using it might be very
2784small, if nonexistant.</p>
2785</dd>
2786<p></p>
2787<dt><strong><a name="item__2d_2denable_2dstrings">--enable-strings</a></strong><br />
2788</dt>
2789<dd>
2790Add support for our possibly faster <code>memset()</code> function and other
2791various routines, overriding your system's versions which may
2792have been hand-crafted in assembly or may require extra libraries
2793to link in. (this breaks ANSI-C rules and has problems on many
2794GNU/Linux systems).
2795</dd> 2496</dd>
2796<p></p> 2497<p></p>
2797<dt><strong><a name="item__2d_2ddisable_2dswapscreen">--disable-swapscreen</a></strong><br /> 2498<dt><strong><a name="item__2d_2ddisable_2dswapscreen">--disable-swapscreen</a></strong><br />
2798</dt> 2499</dt>
2799<dd> 2500<dd>
2800Remove support for swap screen. 2501Remove support for secondary/swap screen.
2801</dd> 2502</dd>
2802<p></p> 2503<p></p>
2803<dt><strong><a name="item__2d_2denable_2dfrills">--enable-frills</a></strong><br /> 2504<dt><strong><a name="item_frills">--enable-frills (default: on)</a></strong><br />
2804</dt> 2505</dt>
2805<dd> 2506<dd>
2806Add support for many small features that are not essential but nice to 2507Add support for many small features that are not essential but nice to
2807have. Normally you want this, but for very small binaries you may want to 2508have. Normally you want this, but for very small binaries you may want to
2808disable this. 2509disable this.
2809</dd> 2510</dd>
2810<dd> 2511<dd>
2811<p>A non-exhaustive list of features enabled by <a href="#item__2d_2denable_2dfrills"><code>--enable-frills</code></a> (possibly 2512<p>A non-exhaustive list of features enabled by <code>--enable-frills</code> (possibly
2812in combination with other switches) is:</p> 2513in combination with other switches) is:</p>
2813</dd> 2514</dd>
2814<dd> 2515<dd>
2815<pre> 2516<pre>
2816 MWM-hints 2517 MWM-hints
2817 EWMH-hints (pid, utf8 names) and protocols (ping) 2518 EWMH-hints (pid, utf8 names) and protocols (ping)
2818 seperate underline colour 2519 seperate underline colour (-underlineColor)
2819 settable border widths and borderless switch 2520 settable border widths and borderless switch (-w, -b, -bl)
2521 visual depth selection (-depth)
2820 settable extra linespacing 2522 settable extra linespacing /-lsp)
2821 iso-14755-2 and -3, and visual feedback 2523 iso-14755-2 and -3, and visual feedback
2524 tripleclickwords (-tcw)
2525 settable insecure mode (-insecure)
2526 keysym remapping support
2527 cursor blinking and underline cursor (-cb, -uc)
2528 XEmbed support (-embed)
2529 user-pty (-pty-fd)
2530 hold on exit (-hold)
2531 skip builtin block graphics (-sbg)</pre>
2532</dd>
2533<dd>
2534<p>It also enabled some non-essential features otherwise disabled, such as:</p>
2535</dd>
2536<dd>
2537<pre>
2538 some round-trip time optimisations
2539 nearest color allocation on pseudocolor screens
2540 UTF8_STRING supporr for selection
2541 sgr modes 90..97 and 100..107
2822 backindex and forwardindex escape sequence 2542 backindex and forwardindex escape sequences
2543 view change/zero scorllback esacpe sequences
2544 locale switching escape sequence
2823 window op and some xterm/OSC escape sequences 2545 window op and some xterm/OSC escape sequences
2824 tripleclickwords 2546 rectangular selections
2825 settable insecure mode 2547 trailing space removal for selections
2826 keysym remapping support 2548 verbose X error handling</pre>
2827 cursor blinking and underline cursor
2828 -embed and -pty-fd options</pre>
2829</dd> 2549</dd>
2830<p></p> 2550<p></p>
2831<dt><strong><a name="item__2d_2denable_2diso14755">--enable-iso14755</a></strong><br /> 2551<dt><strong><a name="item_iso14755">--enable-iso14755 (default: on)</a></strong><br />
2832</dt> 2552</dt>
2833<dd> 2553<dd>
2834Enable extended ISO 14755 support (see rxvt(1), or 2554Enable extended ISO 14755 support (see rxvt(1), or
2835<em>doc/rxvt.1.txt</em>). Basic support (section 5.1) is enabled by 2555<em>doc/rxvt.1.txt</em>). Basic support (section 5.1) is enabled by
2836<a href="#item__2d_2denable_2dfrills"><code>--enable-frills</code></a>, while support for 5.2, 5.3 and 5.4 is enabled with 2556<code>--enable-frills</code>, while support for 5.2, 5.3 and 5.4 is enabled with
2837this switch. 2557this switch.
2838</dd> 2558</dd>
2839<p></p> 2559<p></p>
2840<dt><strong><a name="item__2d_2denable_2dkeepscrolling">--enable-keepscrolling</a></strong><br /> 2560<dt><strong><a name="item_keepscrolling">--enable-keepscrolling (default: on)</a></strong><br />
2841</dt> 2561</dt>
2842<dd> 2562<dd>
2843Add support for continual scrolling of the display when you hold 2563Add support for continual scrolling of the display when you hold
2844the mouse button down on a scrollbar arrow. 2564the mouse button down on a scrollbar arrow.
2845</dd> 2565</dd>
2846<p></p> 2566<p></p>
2847<dt><strong><a name="item__2d_2denable_2dmousewheel">--enable-mousewheel</a></strong><br /> 2567<dt><strong><a name="item_mousewheel">--enable-mousewheel (default: on)</a></strong><br />
2848</dt> 2568</dt>
2849<dd> 2569<dd>
2850Add support for scrolling via mouse wheel or buttons 4 &amp; 5. 2570Add support for scrolling via mouse wheel or buttons 4 &amp; 5.
2851</dd> 2571</dd>
2852<p></p> 2572<p></p>
2853<dt><strong><a name="item__2d_2denable_2dslipwheeling">--enable-slipwheeling</a></strong><br /> 2573<dt><strong><a name="item_slipwheeling">--enable-slipwheeling (default: on)</a></strong><br />
2854</dt> 2574</dt>
2855<dd> 2575<dd>
2856Add support for continual scrolling (using the mouse wheel as an 2576Add support for continual scrolling (using the mouse wheel as an
2857accelerator) while the control key is held down. This option 2577accelerator) while the control key is held down. This option
2858requires --enable-mousewheel to also be specified. 2578requires --enable-mousewheel to also be specified.
2862</dt> 2582</dt>
2863<dd> 2583<dd>
2864Remove support for mouse selection style like that of xterm. 2584Remove support for mouse selection style like that of xterm.
2865</dd> 2585</dd>
2866<p></p> 2586<p></p>
2867<dt><strong><a name="item__2d_2denable_2ddmalloc">--enable-dmalloc</a></strong><br /> 2587<dt><strong><a name="item_dmalloc">--enable-dmalloc (default: off)</a></strong><br />
2868</dt> 2588</dt>
2869<dd> 2589<dd>
2870Use Gray Watson's malloc - which is good for debugging See 2590Use Gray Watson's malloc - which is good for debugging See
2871<a href="http://www.letters.com/dmalloc/">http://www.letters.com/dmalloc/</a> for details If you use either this or the 2591<a href="http://www.letters.com/dmalloc/">http://www.letters.com/dmalloc/</a> for details If you use either this or the
2872next option, you may need to edit src/Makefile after compiling to point 2592next option, you may need to edit src/Makefile after compiling to point
2875<dd> 2595<dd>
2876<p>You can only use either this option and the following (should 2596<p>You can only use either this option and the following (should
2877you use either) .</p> 2597you use either) .</p>
2878</dd> 2598</dd>
2879<p></p> 2599<p></p>
2880<dt><strong><a name="item__2d_2denable_2ddlmalloc">--enable-dlmalloc</a></strong><br /> 2600<dt><strong><a name="item_dlmalloc">--enable-dlmalloc (default: off)</a></strong><br />
2881</dt> 2601</dt>
2882<dd> 2602<dd>
2883Use Doug Lea's malloc - which is good for a production version 2603Use Doug Lea's malloc - which is good for a production version
2884See <a href="http://g.oswego.edu/dl/html/malloc.html">http://g.oswego.edu/dl/html/malloc.html</a> for details. 2604See <a href="http://g.oswego.edu/dl/html/malloc.html">http://g.oswego.edu/dl/html/malloc.html</a> for details.
2885</dd> 2605</dd>
2886<p></p> 2606<p></p>
2887<dt><strong><a name="item__2d_2denable_2dsmart_2dresize">--enable-smart-resize</a></strong><br /> 2607<dt><strong><a name="item_resize">--enable-smart-resize (default: on)</a></strong><br />
2888</dt> 2608</dt>
2889<dd> 2609<dd>
2890Add smart growth/shrink behaviour when changing font size via from hot 2610Add smart growth/shrink behaviour when changing font size via hot
2891keys. This should keep in a fixed position the rxvt corner which is 2611keys. This should keep the window corner which is closest to a corner of
2892closest to a corner of the screen. 2612the screen in a fixed position.
2893</dd> 2613</dd>
2894<p></p> 2614<p></p>
2895<dt><strong><a name="item__2d_2denable_2dpointer_2dblank">--enable-pointer-blank</a></strong><br /> 2615<dt><strong><a name="item_blank">--enable-pointer-blank (default: on)</a></strong><br />
2896</dt> 2616</dt>
2897<dd> 2617<dd>
2898Add support to have the pointer disappear when typing or inactive. 2618Add support to have the pointer disappear when typing or inactive.
2899</dd> 2619</dd>
2900<p></p> 2620<p></p>
2901<dt><strong><a name="item__2d_2dwith_2dname_3dname">--with-name=NAME</a></strong><br /> 2621<dt><strong><a name="item_perl">--enable-perl (default: on)</a></strong><br />
2902</dt> 2622</dt>
2623<dd>
2624Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
2625manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files
2626in <em>src/perl-ext/</em> for the extensions that are installed by default. The
2627perl interpreter that is used can be specified via the <code>PERL</code> environment
2628variable when running configure.
2903<dd> 2629</dd>
2630<p></p>
2631<dt><strong>--with-name=NAME (default: urxvt)</strong><br />
2632</dt>
2633<dd>
2904Set the basename for the installed binaries (default: <code>urxvt</code>, resulting 2634Set the basename for the installed binaries, resulting
2905in <code>urxvt</code>, <code>urxvtd</code> etc.). Specify <code>--with-name=rxvt</code> to replace with 2635in <code>urxvt</code>, <code>urxvtd</code> etc.). Specify <code>--with-name=rxvt</code> to replace with
2906<code>rxvt</code>. 2636<code>rxvt</code>.
2907</dd> 2637</dd>
2908<p></p> 2638<p></p>
2909<dt><strong><a name="item__2d_2dwith_2dterm_3dname">--with-term=NAME</a></strong><br /> 2639<dt><strong>--with-term=NAME (default: rxvt-unicode)</strong><br />
2910</dt> 2640</dt>
2911<dd> 2641<dd>
2912Change the environmental variable for the terminal to NAME (default 2642Change the environmental variable for the terminal to NAME.
2913<code>rxvt-unicode</code>)
2914</dd> 2643</dd>
2915<p></p> 2644<p></p>
2916<dt><strong><a name="item__2d_2dwith_2dterminfo_3dpath">--with-terminfo=PATH</a></strong><br /> 2645<dt><strong><a name="item__2d_2dwith_2dterminfo_3dpath">--with-terminfo=PATH</a></strong><br />
2917</dt> 2646</dt>
2918<dd> 2647<dd>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines