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.44 by root, Fri Jan 13 12:40:46 2006 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>
111rxvt-unicode from initialising perl, saving memory. 100rxvt-unicode from initialising perl, saving memory.
112</dd> 101</dd>
113<dd> 102<dd>
114<p>If you only want to disable specific features, you first have to 103<p>If you only want to disable specific features, you first have to
115identify which perl extension is responsible. For this, read the section 104identify which perl extension is responsible. For this, read the section
116<strong>PREPACKAGED EXTENSIONS</strong> in the <code>urxvtperl(3)</code> manpage. For 105<strong>PREPACKAGED EXTENSIONS</strong> in the <code>rxvtperl(3)</code> manpage. For
117example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify 106example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
118this <strong>perl-ext-common</strong> resource:</p> 107this <strong>perl-ext-common</strong> resource:</p>
119</dd> 108</dd>
120<dd> 109<dd>
121<pre> 110<pre>
229</dd> 218</dd>
230<p></p> 219<p></p>
231<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 /> 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 />
232</dt> 221</dt>
233<dd> 222<dd>
234rxvt-unicode does not directly support tabs. It will work fine with 223Beginning with version 7.3, there is a perl extension that implements a
235tabbing functionality of many window managers or similar tabbing programs, 224simple tabbed terminal. It is installed by default, so any of these should
236and its embedding-features allow it to be embedded into other programs, 225give you tabs:
237as witnessed by <em>doc/rxvt-tabbed</em> or the upcoming <code>Gtk2::URxvt</code> perl 226</dd>
238module, which features a tabbed urxvt (murxvt) terminal as an example 227<dd>
239embedding application. 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>
240</dd> 241</dd>
241<p></p> 242<p></p>
242<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 />
243</dt> 244</dt>
244<dd> 245<dd>
245The version number is displayed with the usage (-h). Also the escape 246The version number is displayed with the usage (-h). Also the escape
246sequence <code>ESC [ 8 n</code> sets the window title to the version number. When 247sequence <code>ESC [ 8 n</code> sets the window title to the version number. When
247using the urxvtc client, the version displayed is that of the 248using the rxvtc client, the version displayed is that of the
248daemon. 249daemon.
249</dd> 250</dd>
250<p></p> 251<p></p>
251<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 />
252</dt> 253</dt>
253<dd> 254<dd>
254The Debian GNU/Linux package of rxvt-unicode in sarge contains large 255The Debian GNU/Linux package of rxvt-unicode in sarge contains large
255patches that considerably change the behaviour of rxvt-unicode. Before 256patches that considerably change the behaviour of rxvt-unicode (but
256reporting a bug to the original rxvt-unicode author please download and 257unfortunately this notice has been removed). Before reporting a bug to
258the original rxvt-unicode author please download and install the genuine
257install the genuine version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) 259version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) and try to reproduce
258and try to reproduce the problem. If you cannot, chances are that the 260the problem. If you cannot, chances are that the problems are specific to
259problems are specific to Debian GNU/Linux, in which case it should be 261Debian GNU/Linux, in which case it should be reported via the Debian Bug
260reported via the Debian Bug Tracking System (use <code>reportbug</code> to report 262Tracking System (use <code>reportbug</code> to report the bug).
261the bug).
262</dd> 263</dd>
263<dd> 264<dd>
264<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
265probably 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
266bug 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
267might encounter the same issue.</p> 268might encounter the same issue.</p>
268</dd> 269</dd>
269<p></p> 270<p></p>
270<dt><strong><a name="item_i_am_maintaining_rxvt_2dunicode_for_distribution_2">I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?</a></strong><br /> 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 />
271</dt> 273</dt>
272<dd> 274<dd>
273You should build one binary with the default options. <em>configure</em> 275You should build one binary with the default options. <em>configure</em>
274now enables most useful options, and the trend goes to making them 276now enables most useful options, and the trend goes to making them
275runtime-switchable, too, so there is usually no drawback to enbaling them, 277runtime-switchable, too, so there is usually no drawback to enbaling them,
292</dd> 294</dd>
293<p></p> 295<p></p>
294<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 /> 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 />
295</dt> 297</dt>
296<dd> 298<dd>
297Likely not. While I honestly try to make it secure, and am probably not 299It should be, starting with release 7.1. You are encouraged to properly
298bad at it, I think it is simply unreasonable to expect all of freetype 300install urxvt with privileges necessary for your OS now.
299+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
300secure. Also, rxvt-unicode disables some options when it detects that it
301runs setuid or setgid, which is not nice. Besides, with the embedded perl
302interpreter the possibility for security problems easily multiplies.
303</dd>
304<dd> 301</dd>
305<p>Elevated privileges are only required for utmp and pty operations on some
306systems (for example, GNU/Linux doesn't need any extra privileges for
307ptys, but some need it for utmp support). It is planned to mvoe this into
308a forked handler process, but this is not yet done.</p>
309</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>
310<dd> 309</dd>
311<p>So, while setuid/setgid operation is supported and not a problem on your 310<dd>
312typical single-user-no-other-logins unix desktop, always remember that 311<p>This forking is done as the very first within main(), which is very early
313its an awful lot of code, most of which isn't checked for security issues 312and reduces possible bugs to initialisation code run before main(), or
314regularly.</p> 313things like the dynamic loader of your system, which should result in very
314little risk.</p>
315</dd> 315</dd>
316<p></p> 316<p></p>
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 /> 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 />
318</dt> 318</dt>
319<dd> 319<dd>
358<dd> 358<dd>
359Most likely it's the empty definition for <code>enacs=</code>. Just replace it by 359Most likely it's the empty definition for <code>enacs=</code>. Just replace it by
360<code>enacs=\E[0@</code> and try again. 360<code>enacs=\E[0@</code> and try again.
361</dd> 361</dd>
362<p></p> 362<p></p>
363<dt><strong><a name="item_bash_27s_readline_does_not_work_correctly_under_ur"><code>bash</code>'s readline does not work correctly under urxvt.</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 />
364</dt> 364</dt>
365<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 />
366</dt> 366</dt>
367<dd> 367<dd>
368One reason you might want this is that some distributions or operating 368One reason you might want this is that some distributions or operating
522<p>In that case, select a font of your taste and add it to the font list, 522<p>In that case, select a font of your taste and add it to the font list,
523e.g.:</p> 523e.g.:</p>
524</dd> 524</dd>
525<dd> 525<dd>
526<pre> 526<pre>
527 urxvt -fn basefont,font2,font3...</pre> 527 rxvt -fn basefont,font2,font3...</pre>
528</dd> 528</dd>
529<dd> 529<dd>
530<p>When rxvt-unicode sees a character, it will first look at the base 530<p>When rxvt-unicode sees a character, it will first look at the base
531font. If the base font does not contain the character, it will go to the 531font. If the base font does not contain the character, it will go to the
532next font, and so on. Specifying your own fonts will also speed up this 532next font, and so on. Specifying your own fonts will also speed up this
836You 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
837terminal, using the resource <code>imlocale</code>: 837terminal, using the resource <code>imlocale</code>:
838</dd> 838</dd>
839<dd> 839<dd>
840<pre> 840<pre>
841 URxvt*imlocale: ja_JP.EUC-JP</pre> 841 URxvt.imlocale: ja_JP.EUC-JP</pre>
842</dd> 842</dd>
843<dd> 843<dd>
844<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
845use 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
846input 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
990 URxvt.color14: #73f7ff 990 URxvt.color14: #73f7ff
991 URxvt.color7: #e1dddd 991 URxvt.color7: #e1dddd
992 URxvt.color15: #e1dddd</pre> 992 URxvt.color15: #e1dddd</pre>
993</dd> 993</dd>
994<p></p> 994<p></p>
995<dt><strong><a name="item_how_can_i_start_urxvtd_in_a_race_2dfree_way_3f">How can I start urxvtd 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 />
996</dt> 996</dt>
997<dd> 997<dd>
998Try <code>urxvtd -f -o</code>, which tells urxvtd to open the 998Try <code>rxvtd -f -o</code>, which tells rxvtd to open the
999display, create the listening socket and then fork. 999display, create the listening socket and then fork.
1000</dd> 1000</dd>
1001<p></p> 1001<p></p>
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 /> 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 />
1003</dt> 1003</dt>
1024</dd> 1024</dd>
1025<dd> 1025<dd>
1026<pre> 1026<pre>
1027 # use Backspace = ^H 1027 # use Backspace = ^H
1028 $ stty erase ^H 1028 $ stty erase ^H
1029 $ urxvt</pre> 1029 $ rxvt</pre>
1030</dd> 1030</dd>
1031<dd> 1031<dd>
1032<pre> 1032<pre>
1033 # use Backspace = ^? 1033 # use Backspace = ^?
1034 $ stty erase ^? 1034 $ stty erase ^?
1035 $ urxvt</pre> 1035 $ rxvt</pre>
1036</dd> 1036</dd>
1037<dd> 1037<dd>
1038<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p> 1038<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
1039</dd> 1039</dd>
1040<dd> 1040<dd>
1081There are some compile-time selections available via configure. Unless 1081There are some compile-time selections available via configure. Unless
1082you have run ``configure'' with the <a href="#item__2d_2ddisable_2dresources"><code>--disable-resources</code></a> option you can 1082you have run ``configure'' with the <a href="#item__2d_2ddisable_2dresources"><code>--disable-resources</code></a> option you can
1083use the `keysym' resource to alter the keystrings associated with keysyms. 1083use the `keysym' resource to alter the keystrings associated with keysyms.
1084</dd> 1084</dd>
1085<dd> 1085<dd>
1086<p>Here's an example for a URxvt session started using <code>urxvt -name URxvt</code></p> 1086<p>Here's an example for a URxvt session started using <code>rxvt -name URxvt</code></p>
1087</dd> 1087</dd>
1088<dd> 1088<dd>
1089<pre> 1089<pre>
1090 URxvt.keysym.Home: \033[1~ 1090 URxvt.keysym.Home: \033[1~
1091 URxvt.keysym.End: \033[4~ 1091 URxvt.keysym.End: \033[4~
1194</p> 1194</p>
1195<hr /> 1195<hr />
1196<h1><a name="description">DESCRIPTION</a></h1> 1196<h1><a name="description">DESCRIPTION</a></h1>
1197<p>The rest of this document describes various technical aspects of 1197<p>The rest of this document describes various technical aspects of
1198<strong>rxvt-unicode</strong>. First the description of supported command sequences, 1198<strong>rxvt-unicode</strong>. First the description of supported command sequences,
1199followed by menu and pixmap support and last by a description of all 1199followed by pixmap support and last by a description of all features
1200features selectable at <code>configure</code> time.</p> 1200selectable at <code>configure</code> time.</p>
1201<p> 1201<p>
1202</p> 1202</p>
1203<hr /> 1203<hr />
1204<h1><a name="definitions">Definitions</a></h1> 1204<h1><a name="definitions">Definitions</a></h1>
1205<dl> 1205<dl>
1838</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 />
1839</dt> 1839</dt>
1840<table> 1840<table>
1841<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>
1842<tr><td>l</td><td>No mouse reporting.</td></tr> 1842<tr><td>l</td><td>No mouse reporting.</td></tr>
1843</table><dt><strong><a name="item_10"><strong><code>Ps = 10</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1844</dt>
1845<table>
1846<tr><td>h</td><td>menuBar visible</td></tr>
1847<tr><td>l</td><td>menuBar invisible</td></tr>
1848</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 />
1849</dt> 1844</dt>
1850<table> 1845<table>
1851<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr> 1846<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr>
1852<tr><td>l</td><td>Invisible cursor {civis}</td></tr> 1847<tr><td>l</td><td>Invisible cursor {civis}</td></tr>
1965<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>
1966<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>
1967<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>
1968<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr> 1963<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr>
1969<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr> 1964<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr>
1970<tr><td>Ps = 20</td><td>Change default background to Pt</td></tr> 1965<tr><td>Ps = 20</td><td>Change background pixmap parameters (see section XPM) (Compile XPM).</td></tr>
1971<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr> 1966<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr>
1972<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>
1973<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr> 1968<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr>
1974<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>
1975<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>
1976<tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).</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>
1977<tr><td>Ps = 703</td><td>Menubar command Pt (Compile menubar).</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>
1978<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>
1979<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr> 1974<tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr>
1980<tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr> 1975<tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr>
1981<tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr> 1976<tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr>
1982<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>
1986<tr><td>Ps = 720</td><td>Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</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>
1987<tr><td>Ps = 721</td><td>Move viewing window down 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>
1988<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> 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>
1989</table><p></p></dl> 1984</table><p></p></dl>
1990<p></p> 1985<p></p>
1991<p>
1992</p>
1993<hr />
1994<h1><a name="menubar">menuBar</a></h1>
1995<p><strong>The exact syntax used is <em>almost</em> solidified. </strong>&gt;
1996In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
1997menuBar.</p>
1998<p>Note that in all of the commands, the <strong><em>/path/</em> </strong>&gt; <em>cannot</em> be
1999omitted: use <strong>./</strong> to specify a menu relative to the current menu.</p>
2000<p>
2001</p>
2002<h2><a name="overview_of_menubar_operation">Overview of menuBar operation</a></h2>
2003<p>For the menuBar XTerm escape sequence <code>ESC ] 703 ; Pt ST</code>, the syntax
2004of <a href="#item_pt"><code>Pt</code></a> can be used for a variety of tasks:</p>
2005<p>At the top level is the current menuBar which is a member of a circular
2006linked-list of other such menuBars.</p>
2007<p>The menuBar acts as a parent for the various drop-down menus, which in
2008turn, may have labels, separator lines, menuItems and subMenus.</p>
2009<p>The menuItems are the useful bits: you can use them to mimic keyboard
2010input or even to send text or escape sequences back to rxvt.</p>
2011<p>The menuBar syntax is intended to provide a simple yet robust method of
2012constructing and manipulating menus and navigating through the
2013menuBars.</p>
2014<p>The first step is to use the tag <strong>[menu:<em>name</em>] </strong>&gt; which creates
2015the menuBar called <em>name</em> and allows access. You may now or menus,
2016subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the
2017menuBar access as <strong>readonly</strong> to prevent accidental corruption of the
2018menus. To re-access the current menuBar for alterations, use the tag
2019<strong>[menu]</strong>, make the alterations and then use <strong>[done]</strong></p>
2020<p></p>
2021<p>
2022</p>
2023<h2><a name="commands">Commands</a></h2>
2024<dl>
2025<dt><strong><a name="item__5bmenu_3a_2bname_5d"><strong>[menu:+<em>name</em>] </strong>&gt;</a></strong><br />
2026</dt>
2027<dd>
2028access the named menuBar for creation or alteration. If a new menuBar
2029is created, it is called <em>name</em> (max of 15 chars) and the current
2030menuBar is pushed onto the stack
2031</dd>
2032<p></p>
2033<dt><strong><a name="item__5bmenu_5d"><strong>[menu]</strong></a></strong><br />
2034</dt>
2035<dd>
2036access the current menuBar for alteration
2037</dd>
2038<p></p>
2039<dt><strong><a name="item__5btitle_3a_2bstring_5d"><strong>[title:+<em>string</em>] </strong>&gt;</a></strong><br />
2040</dt>
2041<dd>
2042set the current menuBar's title to <em>string</em>, which may contain the
2043following format specifiers:
2044</dd>
2045<dd>
2046<pre>
2047 B&lt;%n&gt; rxvt name (as per the B&lt;-name&gt; command-line option)
2048 B&lt;%v&gt; rxvt version
2049 B&lt;%%&gt; literal B&lt;%&gt; character</pre>
2050</dd>
2051<p></p>
2052<dt><strong><a name="item__5bdone_5d"><strong>[done]</strong></a></strong><br />
2053</dt>
2054<dd>
2055set menuBar access as <strong>readonly</strong>.
2056End-of-file tag for <strong>[read:+<em>file</em>] </strong>&gt; operations.
2057</dd>
2058<p></p>
2059<dt><strong><a name="item__5bread_3a_2bfile_5d"><strong>[read:+<em>file</em>] </strong>&gt;</a></strong><br />
2060</dt>
2061<dd>
2062read menu commands directly from <em>file</em> (extension ``.menu'' will be
2063appended if required.) Start reading at a line with <strong>[menu]</strong> or <strong>&lt;
2064[menu:+<em>name</em> </strong>&gt; and continuing until <strong>[done]</strong> is encountered.
2065</dd>
2066<dd>
2067<p>Blank and comment lines (starting with <strong>#</strong>) are ignored. Actually,
2068since any invalid menu commands are also ignored, almost anything could
2069be construed as a comment line, but this may be tightened up in the
2070future ... so don't count on it!.</p>
2071</dd>
2072<p></p>
2073<dt><strong><a name="item__5bread_3a_2bfile_3b_2bname_5d"><strong>[read:+<em>file</em>;+<em>name</em>] </strong>&gt;</a></strong><br />
2074</dt>
2075<dd>
2076The same as <strong>[read:+<em>file</em>] </strong>&gt;, but start reading at a line with
2077<strong>[menu:+<em>name</em>] </strong>&gt; and continuing until <strong>[done:+<em>name</em>] </strong>&gt; or
2078<strong>[done]</strong> is encountered.
2079</dd>
2080<p></p>
2081<dt><strong><a name="item__5bdump_5d"><strong>[dump]</strong></a></strong><br />
2082</dt>
2083<dd>
2084dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable for
2085later rereading.
2086</dd>
2087<p></p>
2088<dt><strong><a name="item__5brm_3aname_5d"><strong>[rm:name]</strong></a></strong><br />
2089</dt>
2090<dd>
2091remove the named menuBar
2092</dd>
2093<p></p>
2094<dt><strong><a name="item__5brm_5d__5brm_3a_5d"><strong>[rm] [rm:]</strong></a></strong><br />
2095</dt>
2096<dd>
2097remove the current menuBar
2098</dd>
2099<p></p>
2100<dt><strong><a name="item__5brm_2a_5d__5brm_3a_2a_5d"><strong>[rm*] [rm:*]</strong></a></strong><br />
2101</dt>
2102<dd>
2103remove all menuBars
2104</dd>
2105<p></p>
2106<dt><strong><a name="item__5bswap_5d"><strong>[swap]</strong></a></strong><br />
2107</dt>
2108<dd>
2109swap the top two menuBars
2110</dd>
2111<p></p>
2112<dt><strong><a name="item__5bprev_5d"><strong>[prev]</strong></a></strong><br />
2113</dt>
2114<dd>
2115access the previous menuBar
2116</dd>
2117<p></p>
2118<dt><strong><a name="item__5bnext_5d"><strong>[next]</strong></a></strong><br />
2119</dt>
2120<dd>
2121access the next menuBar
2122</dd>
2123<p></p>
2124<dt><strong><a name="item__5bshow_5d"><strong>[show]</strong></a></strong><br />
2125</dt>
2126<dd>
2127Enable display of the menuBar
2128</dd>
2129<p></p>
2130<dt><strong><a name="item__5bhide_5d"><strong>[hide]</strong></a></strong><br />
2131</dt>
2132<dd>
2133Disable display of the menuBar
2134</dd>
2135<p></p>
2136<dt><strong><a name="item__5bpixmap_3a_2bname_5d"><strong>[pixmap:+<em>name</em>] </strong>&gt;</a></strong><br />
2137</dt>
2138<dt><strong><a name="item__5bpixmap_3a_2bname_3bscaling_5d"><strong>[pixmap:+<em>name</em>;<em>scaling</em>] </strong>&gt;</a></strong><br />
2139</dt>
2140<dd>
2141(set the background pixmap globally
2142</dd>
2143<dd>
2144<p><strong>A Future implementation <em>may</em> make this local to the menubar </strong>&gt;)</p>
2145</dd>
2146<p></p>
2147<dt><strong><a name="item__5b_3a_2bcommand_3a_5d"><strong>[:+<em>command</em>:] </strong>&gt;</a></strong><br />
2148</dt>
2149<dd>
2150ignore the menu readonly status and issue a <em>command</em> to or a menu or
2151menuitem or change the ; a useful shortcut for setting the quick arrows
2152from a menuBar.
2153</dd>
2154<p></p></dl>
2155<p></p>
2156<p>
2157</p>
2158<h2><a name="adding_and_accessing_menus">Adding and accessing menus</a></h2>
2159<p>The following commands may also be <strong>+</strong> prefixed.</p>
2160<dl>
2161<dt><strong><a name="item__2f_2b"><strong>/+</strong></a></strong><br />
2162</dt>
2163<dd>
2164access menuBar top level
2165</dd>
2166<p></p>
2167<dt><strong><a name="item__2e_2f_2b"><strong>./+</strong></a></strong><br />
2168</dt>
2169<dd>
2170access current menu level
2171</dd>
2172<p></p>
2173<dt><strong><a name="item__2e_2e_2f_2b"><strong>../+</strong></a></strong><br />
2174</dt>
2175<dd>
2176access parent menu (1 level up)
2177</dd>
2178<p></p>
2179<dt><strong><a name="item__2e_2e_2f_2e_2e_2f"><strong>../../</strong></a></strong><br />
2180</dt>
2181<dd>
2182access parent menu (multiple levels up)
2183</dd>
2184<p></p>
2185<dt><strong><a name="item__2fpath_2fmenu"><strong><em>/path/</em>menu </strong>&gt;</a></strong><br />
2186</dt>
2187<dd>
2188add/access menu
2189</dd>
2190<p></p>
2191<dt><strong><a name="item__2fpath_2fmenu_2f_2a"><strong><em>/path/</em>menu/* </strong>&gt;</a></strong><br />
2192</dt>
2193<dd>
2194add/access menu and clear it if it exists
2195</dd>
2196<p></p>
2197<dt><strong><a name="item__2fpath_2f_7b_2d_7d"><strong><em>/path/</em>{-} </strong>&gt;</a></strong><br />
2198</dt>
2199<dd>
2200add separator
2201</dd>
2202<p></p>
2203<dt><strong><a name="item__2fpath_2f_7bitem_7d"><strong><em>/path/</em>{item} </strong>&gt;</a></strong><br />
2204</dt>
2205<dd>
2206add <strong>item</strong> as a label
2207</dd>
2208<p></p>
2209<dt><strong><a name="item__2fpath_2f_7bitem_7d_action"><strong><em>/path/</em>{item} action </strong>&gt;</a></strong><br />
2210</dt>
2211<dd>
2212add/alter <em>menuitem</em> with an associated <em>action</em>
2213</dd>
2214<p></p>
2215<dt><strong><a name="item__2fpath_2f_7bitem_7d_7bright_2dtext_7d"><strong><em>/path/</em>{item}{right-text} </strong>&gt;</a></strong><br />
2216</dt>
2217<dd>
2218add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified text
2219and as the associated <em>action</em>
2220</dd>
2221<p></p>
2222<dt><strong><a name="item__2fpath_2f_7bitem_7d_7brtext_7d_action"><strong><em>/path/</em>{item}{rtext} action </strong>&gt;</a></strong><br />
2223</dt>
2224<dd>
2225add/alter <em>menuitem</em> with an associated <em>action</em> and with <strong>rtext</strong> as
2226the right-justified text.
2227</dd>
2228<p></p></dl>
2229<dl>
2230<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 />
2231</dt>
2232<dd>
2233<strong>\a \b \E \e \n \r \t \octal</strong>
2234</dd>
2235<p></p>
2236<dt><strong><a name="item_or_in_control_2dcharacter_notation_3a">or in control-character notation:</a></strong><br />
2237</dt>
2238<dd>
2239<strong>^@, ^A .. ^Z .. ^_, ^?</strong>
2240</dd>
2241<p></p></dl>
2242<p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the
2243program, start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>),
2244the first of which will be stripped off and the balance directed to the
2245program. Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by
2246non-+<strong>NUL</strong> characters, the leading <strong>NUL</strong> is stripped off and the
2247balance is sent back to rxvt.</p>
2248<p>As a convenience for the many Emacs-type editors, <em>action</em> may start
2249with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
2250appended if missed from <strong>M-x</strong> commands.</p>
2251<p>As a convenience for issuing XTerm <strong>ESC ]</strong> sequences from a menubar (or
2252quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.</p>
2253<dl>
2254<dt><strong><a name="item_for_example_2c">For example,</a></strong><br />
2255</dt>
2256<dd>
2257<strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong>
2258</dd>
2259<p></p>
2260<dt><strong><a name="item_and">and</a></strong><br />
2261</dt>
2262<dd>
2263<strong>\E]703;mona;100</strong> is equivalent to <strong>\E]703;mona;100\a</strong>
2264</dd>
2265<p></p></dl>
2266<p>The option <strong>{<em>right-rtext</em>} </strong>&gt; will be right-justified. In the
2267absence of a specified action, this text will be used as the <em>action</em>
2268as well.</p>
2269<dl>
2270<dt><strong>For example,</strong><br />
2271</dt>
2272<dd>
2273<strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong>
2274</dd>
2275<p></p></dl>
2276<p>The left label <em>is</em> necessary, since it's used for matching, but
2277implicitly hiding the left label (by using same name for both left and
2278right labels), or explicitly hiding the left label (by preceeding it
2279with a dot), makes it possible to have right-justified text only.</p>
2280<dl>
2281<dt><strong>For example,</strong><br />
2282</dt>
2283<dd>
2284<strong>/File/{Open}{Open} Open-File-Action</strong>
2285</dd>
2286<p></p>
2287<dt><strong><a name="item_or_hiding_it">or hiding it</a></strong><br />
2288</dt>
2289<dd>
2290<strong>/File/{.anylabel}{Open} Open-File-Action</strong>
2291</dd>
2292<p></p></dl>
2293<p></p>
2294<p>
2295</p>
2296<h2><a name="removing_menus">Removing menus</a></h2>
2297<dl>
2298<dt><strong><a name="item__2d_2f_2a_2b"><strong>-/*+ </strong>&gt;</a></strong><br />
2299</dt>
2300<dd>
2301remove all menus from the menuBar, the same as <strong>[clear]</strong>
2302</dd>
2303<p></p>
2304<dt><strong><a name="item__2d_2b_2fpathmenu_2b"><strong>-+<em>/path</em>menu+ </strong>&gt;</a></strong><br />
2305</dt>
2306<dd>
2307remove menu
2308</dd>
2309<p></p>
2310<dt><strong><a name="item__2d_2b_2fpath_7bitem_7d_2b"><strong>-+<em>/path</em>{item}+ </strong>&gt;</a></strong><br />
2311</dt>
2312<dd>
2313remove item
2314</dd>
2315<p></p>
2316<dt><strong><a name="item__2d_2b_2fpath_7b_2d_7d"><strong>-+<em>/path</em>{-} </strong>&gt;</a></strong><br />
2317</dt>
2318<dd>
2319remove separator)
2320</dd>
2321<p></p>
2322<dt><strong><a name="item__2d_2fpath_2fmenu_2f_2a"><strong>-/path/menu/*</strong></a></strong><br />
2323</dt>
2324<dd>
2325remove all items, separators and submenus from menu
2326</dd>
2327<p></p></dl>
2328<p></p>
2329<p>
2330</p>
2331<h2><a name="quick_arrows">Quick Arrows</a></h2>
2332<p>The menus also provide a hook for <em>quick arrows</em> to provide easier
2333user access. If nothing has been explicitly set, the default is to
2334emulate the curror keys. The syntax permits each arrow to be altered
2335individually or all four at once without re-entering their common
2336beginning/end text. For example, to explicitly associate cursor actions
2337with the arrows, any of the following forms could be used:</p>
2338<dl>
2339<dt><strong><a name="item__3cr_3e_2bright"><strong>&lt;r</strong>+<em>Right</em> &gt;&gt;</a></strong><br />
2340</dt>
2341<dt><strong><a name="item__3cl_3e_2bleft"><strong>&lt;l</strong>+<em>Left</em> &gt;&gt;</a></strong><br />
2342</dt>
2343<dt><strong><a name="item__3cu_3e_2bup"><strong>&lt;u</strong>+<em>Up</em> &gt;&gt;</a></strong><br />
2344</dt>
2345<dt><strong><a name="item__3cd_3e_2bdown"><strong>&lt;d</strong>+<em>Down</em> &gt;&gt;</a></strong><br />
2346</dt>
2347<dd>
2348Define actions for the respective arrow buttons
2349</dd>
2350<p></p>
2351<dt><strong><a name="item__3cb_3e_2bbegin"><strong>&lt;b</strong>+<em>Begin</em> &gt;&gt;</a></strong><br />
2352</dt>
2353<dt><strong><a name="item__3ce_3e_2bend"><strong>&lt;e</strong>+<em>End</em> &gt;&gt;</a></strong><br />
2354</dt>
2355<dd>
2356Define common beginning/end parts for <em>quick arrows</em> which used in
2357conjunction with the above &lt;r&gt; &lt;l&gt; &lt;u&gt; &lt;d&gt; constructs
2358</dd>
2359<p></p></dl>
2360<dl>
2361<dt><strong><a name="item_for_example_2c_define_arrows_individually_2c">For example, define arrows individually,</a></strong><br />
2362</dt>
2363<dd>
2364<pre>
2365 &lt;u&gt;\E[A</pre>
2366</dd>
2367<dd>
2368<pre>
2369 &lt;d&gt;\E[B</pre>
2370</dd>
2371<dd>
2372<pre>
2373 &lt;r&gt;\E[C</pre>
2374</dd>
2375<dd>
2376<pre>
2377 &lt;l&gt;\E[D</pre>
2378</dd>
2379<dt><strong><a name="item_or_all_at_once">or all at once</a></strong><br />
2380</dt>
2381<dd>
2382<pre>
2383 &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>
2384</dd>
2385<dt><strong><a name="item_compactly">or more compactly (factoring out common parts)</a></strong><br />
2386</dt>
2387<dd>
2388<pre>
2389 &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>
2390</dd>
2391</dl>
2392<p></p>
2393<p>
2394</p>
2395<h2><a name="command_summary">Command Summary</a></h2>
2396<p>A short summary of the most <em>common</em> commands:</p>
2397<dl>
2398<dt><strong><a name="item__5bmenu_3aname_5d">[menu:name]</a></strong><br />
2399</dt>
2400<dd>
2401use an existing named menuBar or start a new one
2402</dd>
2403<p></p>
2404<dt><strong>[menu]</strong><br />
2405</dt>
2406<dd>
2407use the current menuBar
2408</dd>
2409<p></p>
2410<dt><strong><a name="item__5btitle_3astring_5d">[title:string]</a></strong><br />
2411</dt>
2412<dd>
2413set menuBar title
2414</dd>
2415<p></p>
2416<dt><strong>[done]</strong><br />
2417</dt>
2418<dd>
2419set menu access to readonly and, if reading from a file, signal EOF
2420</dd>
2421<p></p>
2422<dt><strong><a name="item__5bdone_3aname_5d">[done:name]</a></strong><br />
2423</dt>
2424<dd>
2425if reading from a file using [read:file;name] signal EOF
2426</dd>
2427<p></p>
2428<dt><strong>[rm:name]</strong><br />
2429</dt>
2430<dd>
2431remove named <code>menuBar(s)</code>
2432</dd>
2433<p></p>
2434<dt><strong>[rm] [rm:]</strong><br />
2435</dt>
2436<dd>
2437remove current menuBar
2438</dd>
2439<p></p>
2440<dt><strong>[rm*] [rm:*]</strong><br />
2441</dt>
2442<dd>
2443remove all <code>menuBar(s)</code>
2444</dd>
2445<p></p>
2446<dt><strong>[swap]</strong><br />
2447</dt>
2448<dd>
2449swap top two menuBars
2450</dd>
2451<p></p>
2452<dt><strong>[prev]</strong><br />
2453</dt>
2454<dd>
2455access the previous menuBar
2456</dd>
2457<p></p>
2458<dt><strong>[next]</strong><br />
2459</dt>
2460<dd>
2461access the next menuBar
2462</dd>
2463<p></p>
2464<dt><strong>[show]</strong><br />
2465</dt>
2466<dd>
2467map menuBar
2468</dd>
2469<p></p>
2470<dt><strong>[hide]</strong><br />
2471</dt>
2472<dd>
2473unmap menuBar
2474</dd>
2475<p></p>
2476<dt><strong><a name="item__5bpixmap_3bfile_5d">[pixmap;file]</a></strong><br />
2477</dt>
2478<dt><strong><a name="item__5bpixmap_3bfile_3bscaling_5d">[pixmap;file;scaling]</a></strong><br />
2479</dt>
2480<dd>
2481set a background pixmap
2482</dd>
2483<p></p>
2484<dt><strong><a name="item__5bread_3afile_5d">[read:file]</a></strong><br />
2485</dt>
2486<dt><strong><a name="item__5bread_3afile_3bname_5d">[read:file;name]</a></strong><br />
2487</dt>
2488<dd>
2489read in a menu from a file
2490</dd>
2491<p></p>
2492<dt><strong>[dump]</strong><br />
2493</dt>
2494<dd>
2495dump out all menuBars to /tmp/rxvt-PID
2496</dd>
2497<p></p>
2498<dt><strong><a name="item__2f">/</a></strong><br />
2499</dt>
2500<dd>
2501access menuBar top level
2502</dd>
2503<p></p>
2504<dt><strong><a name="item__2e_2f">./</a></strong><br />
2505</dt>
2506<dt><strong><a name="item__2e_2e_2f">../</a></strong><br />
2507</dt>
2508<dt><strong>../../</strong><br />
2509</dt>
2510<dd>
2511access current or parent menu level
2512</dd>
2513<p></p>
2514<dt><strong>/path/menu</strong><br />
2515</dt>
2516<dd>
2517add/access menu
2518</dd>
2519<p></p>
2520<dt><strong>/path/{-}</strong><br />
2521</dt>
2522<dd>
2523add separator
2524</dd>
2525<p></p>
2526<dt><strong>/path/{item}{rtext} action</strong><br />
2527</dt>
2528<dd>
2529add/alter menu item
2530</dd>
2531<p></p>
2532<dt><strong><a name="item__2d_2f_2a">-/*</a></strong><br />
2533</dt>
2534<dd>
2535remove all menus from the menuBar
2536</dd>
2537<p></p>
2538<dt><strong><a name="item__2d_2fpath_2fmenu">-/path/menu</a></strong><br />
2539</dt>
2540<dd>
2541remove menu items, separators and submenus from menu
2542</dd>
2543<p></p>
2544<dt><strong>-/path/menu</strong><br />
2545</dt>
2546<dd>
2547remove menu
2548</dd>
2549<p></p>
2550<dt><strong><a name="item__2d_2fpath_2f_7bitem_7d">-/path/{item}</a></strong><br />
2551</dt>
2552<dd>
2553remove item
2554</dd>
2555<p></p>
2556<dt><strong><a name="item__2d_2fpath_2f_7b_2d_7d">-/path/{-}</a></strong><br />
2557</dt>
2558<dd>
2559remove separator
2560</dd>
2561<p></p>
2562<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 />
2563</dt>
2564<dd>
2565menu quick arrows
2566</dd>
2567<p></p></dl>
2568<p> 1986<p>
2569</p> 1987</p>
2570<hr /> 1988<hr />
2571<h1><a name="xpm">XPM</a></h1> 1989<h1><a name="xpm">XPM</a></h1>
2572<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
2821</dd> 2239</dd>
2822<p></p> 2240<p></p>
2823<dt><strong><a name="item_unicode3">--enable-unicode3 (default: off)</a></strong><br /> 2241<dt><strong><a name="item_unicode3">--enable-unicode3 (default: off)</a></strong><br />
2824</dt> 2242</dt>
2825<dd> 2243<dd>
2244Recommended to stay off unless you really need non-BMP characters.
2245</dd>
2246<dd>
2826Enable direct support for displaying unicode codepoints above 2247<p>Enable direct support for displaying unicode codepoints above
282765535 (the basic multilingual page). This increases storage 224865535 (the basic multilingual page). This increases storage
2828requirements 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
2829support these extra characters, but Xft does. 2250support these extra characters, but Xft does.</p>
2830</dd> 2251</dd>
2831<dd> 2252<dd>
2832<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
2833even without this flag, but the number of such characters is 2254even without this flag, but the number of such characters is
2834limited to a view thousand (shared with combining characters, 2255limited to a view thousand (shared with combining characters,
2844where accents are encoded as seperate unicode characters. This is 2265where accents are encoded as seperate unicode characters. This is
2845done by using precomposited characters when available or creating 2266done by using precomposited characters when available or creating
2846new pseudo-characters when no precomposed form exists. 2267new pseudo-characters when no precomposed form exists.
2847</dd> 2268</dd>
2848<dd> 2269<dd>
2849<p>Without --enable-unicode3, the number of additional precomposed characters 2270<p>Without --enable-unicode3, the number of additional precomposed
2850is rather limited (2048, if this is full, rxvt-unicode will use the 2271characters is somewhat limited (the 6400 private use characters will be
2851private use area, extending the number of combinations to 8448). With
2852--enable-unicode3, no practical limit exists.</p> 2272(ab-)used). With --enable-unicode3, no practical limit exists.</p>
2853</dd> 2273</dd>
2854<dd> 2274<dd>
2855<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
2856beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p> 2276beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p>
2857</dd> 2277</dd>
2862</dd> 2282</dd>
2863<p></p> 2283<p></p>
2864<dt><strong><a name="item_fallback">--enable-fallback(=CLASS) (default: Rxvt)</a></strong><br /> 2284<dt><strong><a name="item_fallback">--enable-fallback(=CLASS) (default: Rxvt)</a></strong><br />
2865</dt> 2285</dt>
2866<dd> 2286<dd>
2867When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2287When reading resource settings, also read settings for class CLASS. To
2288disable resource fallback use --disable-fallback.
2868</dd> 2289</dd>
2869<p></p> 2290<p></p>
2870<dt><strong><a name="item_name">--with-res-name=NAME (default: urxvt)</a></strong><br /> 2291<dt><strong><a name="item_name">--with-res-name=NAME (default: urxvt)</a></strong><br />
2871</dt> 2292</dt>
2872<dd> 2293<dd>
2928</dt> 2349</dt>
2929<dd> 2350<dd>
2930Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>). 2351Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>).
2931</dd> 2352</dd>
2932<p></p> 2353<p></p>
2933<dt><strong><a name="item_menubar">--enable-menubar (default: off) [DEPRECATED]</a></strong><br />
2934</dt>
2935<dd>
2936Add support for our menu bar system (this interacts badly with dynamic
2937locale switching currently). This option is DEPRECATED and will be removed
2938in the future.
2939</dd>
2940<p></p>
2941<dt><strong><a name="item_scroll">--enable-rxvt-scroll (default: on)</a></strong><br /> 2354<dt><strong><a name="item_scroll">--enable-rxvt-scroll (default: on)</a></strong><br />
2942</dt> 2355</dt>
2943<dd> 2356<dd>
2944Add support for the original rxvt scrollbar. 2357Add support for the original rxvt scrollbar.
2945</dd> 2358</dd>
2962Add support for a very unobtrusive, plain-looking scrollbar that 2375Add support for a very unobtrusive, plain-looking scrollbar that
2963is the favourite of the rxvt-unicode author, having used it for 2376is the favourite of the rxvt-unicode author, having used it for
2964many years. 2377many years.
2965</dd> 2378</dd>
2966<p></p> 2379<p></p>
2967<dt><strong><a name="item_shadow">--enable-half-shadow (default: off)</a></strong><br />
2968</dt>
2969<dd>
2970Make shadows on the scrollbar only half the normal width &amp; height.
2971only applicable to rxvt scrollbars.
2972</dd>
2973<p></p>
2974<dt><strong><a name="item_ttygid">--enable-ttygid (default: off)</a></strong><br /> 2380<dt><strong><a name="item_ttygid">--enable-ttygid (default: off)</a></strong><br />
2975</dt> 2381</dt>
2976<dd> 2382<dd>
2977Change tty device setting to group ``tty'' - only use this if 2383Change tty device setting to group ``tty'' - only use this if
2978your system uses this type of security. 2384your system uses this type of security.
2993<p></p> 2399<p></p>
2994<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 />
2995</dt> 2401</dt>
2996<dd> 2402<dd>
2997Removes any support for resource checking. 2403Removes any support for resource checking.
2998</dd>
2999<p></p>
3000<dt><strong><a name="item_strings">--enable-strings (default: off)</a></strong><br />
3001</dt>
3002<dd>
3003Add support for our possibly faster <code>memset()</code> function and other
3004various routines, overriding your system's versions which may
3005have been hand-crafted in assembly or may require extra libraries
3006to link in. (this breaks ANSI-C rules and has problems on many
3007GNU/Linux systems).
3008</dd> 2404</dd>
3009<p></p> 2405<p></p>
3010<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 />
3011</dt> 2407</dt>
3012<dd> 2408<dd>
3028<pre> 2424<pre>
3029 MWM-hints 2425 MWM-hints
3030 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
3031 seperate underline colour (-underlineColor) 2427 seperate underline colour (-underlineColor)
3032 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual selection (-depth)
3033 settable extra linespacing /-lsp) 2430 settable extra linespacing /-lsp)
3034 iso-14755-2 and -3, and visual feedback 2431 iso-14755-2 and -3, and visual feedback
3035 backindex and forwardindex escape sequence 2432 backindex and forwardindex escape sequence
3036 window op and some xterm/OSC escape sequences 2433 window op and some xterm/OSC escape sequences
3037 tripleclickwords (-tcw) 2434 tripleclickwords (-tcw)
3046</dd> 2443</dd>
3047<p></p> 2444<p></p>
3048<dt><strong><a name="item_iso14755">--enable-iso14755 (default: on)</a></strong><br /> 2445<dt><strong><a name="item_iso14755">--enable-iso14755 (default: on)</a></strong><br />
3049</dt> 2446</dt>
3050<dd> 2447<dd>
3051Enable extended ISO 14755 support (see urxvt(1), or 2448Enable extended ISO 14755 support (see rxvt(1), or
3052<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
3053<code>--enable-frills</code>, 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
3054this switch. 2451this switch.
3055</dd> 2452</dd>
3056<p></p> 2453<p></p>
3113</dt> 2510</dt>
3114<dd> 2511<dd>
3115Add support to have the pointer disappear when typing or inactive. 2512Add support to have the pointer disappear when typing or inactive.
3116</dd> 2513</dd>
3117<p></p> 2514<p></p>
3118<dt><strong><a name="item_perl">--enable-perl (default: off)</a></strong><br /> 2515<dt><strong><a name="item_perl">--enable-perl (default: on)</a></strong><br />
3119</dt> 2516</dt>
3120<dd> 2517<dd>
3121Enable an embedded perl interpreter. See the <strong>urxvtperl(3)</strong> 2518Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
3122manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files 2519manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files
3123in <em>src/perl-ext/</em> for the extensions that are installed by default. The 2520in <em>src/perl-ext/</em> for the extensions that are installed by default. The
3124perl interpreter that is used can be specified via the <code>PERL</code> environment 2521perl interpreter that is used can be specified via the <code>PERL</code> environment
3125variable when running configure. 2522variable when running configure.
3126</dd> 2523</dd>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines