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.34 by root, Wed Jan 4 21:50:12 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>
73<p> 62<p>
74</p> 63</p>
75<hr /> 64<hr />
76<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 65<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
77<dl> 66<dl>
67<dt><strong><a name="item_the_new_selection_selects_pieces_that_are_too_big_">The new selection selects pieces that are too big, how can I select
68single words?</a></strong><br />
69</dt>
70<dd>
71Yes. For example, if you want to select alphanumeric words, you can use
72the following resource:
73</dd>
74<dd>
75<pre>
76 URxvt.selection.pattern-0: ([[:word:]]+)</pre>
77</dd>
78<dd>
79<p>If you click more than twice, the selection will be extended
80more and more.</p>
81</dd>
82<dd>
83<p>To get a selection that is very similar to the old code, try this pattern:</p>
84</dd>
85<dd>
86<pre>
87 URxvt.selection.pattern-0: ([^&quot;&amp;'()*,;&lt;=&gt;?@[\\\\]^`{|})]+)</pre>
88</dd>
89<dd>
90<p>Please also note that the <em>LeftClick Shift-LeftClik</em> combination also
91selects words like the old code.</p>
92</dd>
93<p></p>
94<dt><strong><a name="item_i_don_27t_like_the_new_selection_2fpopups_2fhotkey">I don't like the new selection/popups/hotkeys/perl, how do I
95change/disable it?</a></strong><br />
96</dt>
97<dd>
98You can disable the perl extension completely by setting the
99<strong>perl-ext-common</strong> resource to the empty string, which also keeps
100rxvt-unicode from initialising perl, saving memory.
101</dd>
102<dd>
103<p>If you only want to disable specific features, you first have to
104identify which perl extension is responsible. For this, read the section
105<strong>PREPACKAGED EXTENSIONS</strong> in the <code>rxvtperl(3)</code> manpage. For
106example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
107this <strong>perl-ext-common</strong> resource:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.perl-ext-common: default,-selection-popup,-option-popup</pre>
112</dd>
113<dd>
114<p>This will keep the default extensions, but disable the two popup
115extensions. Some extensions can also be configured, for example,
116scrollback search mode is triggered by <strong>M-s</strong>. You can move it to any
117other combination either by setting the <strong>searchable-scrollback</strong> resource:</p>
118</dd>
119<dd>
120<pre>
121 URxvt.searchable-scrollback: CM-s</pre>
122</dd>
123<p></p>
78<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 /> 124<dt><strong><a name="item_isn_27t_rxvt_supposed_to_be_small_3f_don_27t_all_t">Isn't rxvt supposed to be small? Don't all those features bloat?</a></strong><br />
79</dt> 125</dt>
80<dd> 126<dd>
81I often get asked about this, and I think, no, they didn't cause extra 127I often get asked about this, and I think, no, they didn't cause extra
82bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 128bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
120</dd> 166</dd>
121<dd> 167<dd>
122<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 168<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
123still fares rather well. And compared to some monsters like gnome-terminal 169still fares rather well. And compared to some monsters like gnome-terminal
124(21152k + extra 4204k in separate processes) or konsole (22200k + extra 170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
12543180k in daemons that stay around after exit, plus half aminute of 17143180k in daemons that stay around after exit, plus half a minute of
126startup time, including the hundreds of warnings it spits out), it fares 172startup time, including the hundreds of warnings it spits out), it fares
127extremely well *g*.</p> 173extremely well *g*.</p>
128</dd> 174</dd>
129<p></p> 175<p></p>
130<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 /> 176<dt><strong><a name="item_why_c_2b_2b_2c_isn_27t_that_unportable_2fbloated_2">Why C++, isn't that unportable/bloated/uncool?</a></strong><br />
172</dd> 218</dd>
173<p></p> 219<p></p>
174<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 />
175</dt> 221</dt>
176<dd> 222<dd>
177rxvt-unicode does not directly support tabs. It will work fine with 223Beginning with version 7.3, there is a perl extension that implements a
178tabbing functionality of many window managers or similar tabbing programs, 224simple tabbed terminal. It is installed by default, so any of these should
179and its embedding-features allow it to be embedded into other programs, 225give you tabs:
180as witnessed by <em>doc/rxvt-tabbed</em> or the upcoming <code>Gtk2::URxvt</code> perl 226</dd>
181module, which features a tabbed urxvt (murxvt) terminal as an example 227<dd>
182embedding 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>
183</dd> 241</dd>
184<p></p> 242<p></p>
185<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 />
186</dt> 244</dt>
187<dd> 245<dd>
193<p></p> 251<p></p>
194<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 />
195</dt> 253</dt>
196<dd> 254<dd>
197The Debian GNU/Linux package of rxvt-unicode in sarge contains large 255The Debian GNU/Linux package of rxvt-unicode in sarge contains large
198patches that considerably change the behaviour of rxvt-unicode. Before 256patches that considerably change the behaviour of rxvt-unicode (but
199reporting 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
200install 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
201and 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
202problems 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
203reported via the Debian Bug Tracking System (use <code>reportbug</code> to report 262Tracking System (use <code>reportbug</code> to report the bug).
204the bug).
205</dd> 263</dd>
206<dd> 264<dd>
207<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
208probably 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
209bug 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
210might encounter the same issue.</p> 268might encounter the same issue.</p>
269</dd>
270<p></p>
271<dt><strong><a name="item_i_am_maintaining_rxvt_2dunicode_for_distribution_2">I am maintaining rxvt-unicode for distribution/OS XXX, any
272recommendation?</a></strong><br />
273</dt>
274<dd>
275You should build one binary with the default options. <em>configure</em>
276now enables most useful options, and the trend goes to making them
277runtime-switchable, too, so there is usually no drawback to enbaling them,
278except higher disk and possibly memory usage. The perl interpreter should
279be enabled, as important functionality (menus, selection, likely more in
280the future) depends on it.
281</dd>
282<dd>
283<p>You should not overwrite the <code>perl-ext-common</code> snd <code>perl-ext</code> resources
284system-wide (except maybe with <code>defaults</code>). This will result in useful
285behaviour. If your distribution aims at low memory, add an empty
286<code>perl-ext-common</code> resource to the app-defaults file. This will keep the
287perl interpreter disabled until the user enables it.</p>
288</dd>
289<dd>
290<p>If you can/want build more binaries, I recommend building a minimal
291one with <code>--disable-everything</code> (very useful) and a maximal one with
292<a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (less useful, it will be very big due to a lot of
293encodings built-in that increase download times and are rarely used).</p>
294</dd>
295<p></p>
296<dt><strong><a name="item_i_need_to_make_it_setuid_2fsetgid_to_support_utmp_">I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?</a></strong><br />
297</dt>
298<dd>
299It should be, starting with release 7.1. You are encouraged to properly
300install urxvt with privileges necessary for your OS now.
301</dd>
302<dd>
303<p>When rxvt-unicode detects that it runs setuid or setgid, it will fork
304into a helper process for privileged operations (pty handling on some
305systems, utmp/wtmp/lastlog handling on others) and drop privileges
306immediately. This is much safer than most other terminals that keep
307privileges while running (but is more relevant to urxvt, as it contains
308things as perl interpreters, which might be ``helpful'' to attackers).</p>
309</dd>
310<dd>
311<p>This forking is done as the very first within main(), which is very early
312and reduces possible bugs to initialisation code run before main(), or
313things like the dynamic loader of your system, which should result in very
314little risk.</p>
211</dd> 315</dd>
212<p></p> 316<p></p>
213<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 />
214</dt> 318</dt>
215<dd> 319<dd>
732You 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
733terminal, using the resource <code>imlocale</code>: 837terminal, using the resource <code>imlocale</code>:
734</dd> 838</dd>
735<dd> 839<dd>
736<pre> 840<pre>
737 URxvt*imlocale: ja_JP.EUC-JP</pre> 841 URxvt.imlocale: ja_JP.EUC-JP</pre>
738</dd> 842</dd>
739<dd> 843<dd>
740<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
741use 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
742input 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
802<dd> 906<dd>
803Make sure that mouse reporting is actually turned off since killing 907Make sure that mouse reporting is actually turned off since killing
804some editors prematurely may leave the mouse in mouse report mode. I've 908some editors prematurely may leave the mouse in mouse report mode. I've
805heard that tcsh may use mouse reporting unless it otherwise specified. A 909heard that tcsh may use mouse reporting unless it otherwise specified. A
806quick check is to see if cut/paste works when the Alt or Shift keys are 910quick check is to see if cut/paste works when the Alt or Shift keys are
807depressed. See <code>rxvt(7)</code> 911depressed.
808</dd> 912</dd>
809<p></p> 913<p></p>
810<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br /> 914<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br />
811</dt> 915</dt>
812<dd> 916<dd>
929 # use Backspace = ^? 1033 # use Backspace = ^?
930 $ stty erase ^? 1034 $ stty erase ^?
931 $ rxvt</pre> 1035 $ rxvt</pre>
932</dd> 1036</dd>
933<dd> 1037<dd>
934<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code> as documented in rxvt(7).</p> 1038<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
935</dd> 1039</dd>
936<dd> 1040<dd>
937<p>For an existing rxvt-unicode:</p> 1041<p>For an existing rxvt-unicode:</p>
938</dd> 1042</dd>
939<dd> 1043<dd>
1090</p> 1194</p>
1091<hr /> 1195<hr />
1092<h1><a name="description">DESCRIPTION</a></h1> 1196<h1><a name="description">DESCRIPTION</a></h1>
1093<p>The rest of this document describes various technical aspects of 1197<p>The rest of this document describes various technical aspects of
1094<strong>rxvt-unicode</strong>. First the description of supported command sequences, 1198<strong>rxvt-unicode</strong>. First the description of supported command sequences,
1095followed by menu and pixmap support and last by a description of all 1199followed by pixmap support and last by a description of all features
1096features selectable at <code>configure</code> time.</p> 1200selectable at <code>configure</code> time.</p>
1097<p> 1201<p>
1098</p> 1202</p>
1099<hr /> 1203<hr />
1100<h1><a name="definitions">Definitions</a></h1> 1204<h1><a name="definitions">Definitions</a></h1>
1101<dl> 1205<dl>
1734</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 />
1735</dt> 1839</dt>
1736<table> 1840<table>
1737<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>
1738<tr><td>l</td><td>No mouse reporting.</td></tr> 1842<tr><td>l</td><td>No mouse reporting.</td></tr>
1739</table><dt><strong><a name="item_10"><strong><code>Ps = 10</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1740</dt>
1741<table>
1742<tr><td>h</td><td>menuBar visible</td></tr>
1743<tr><td>l</td><td>menuBar invisible</td></tr>
1744</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 />
1745</dt> 1844</dt>
1746<table> 1845<table>
1747<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr> 1846<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr>
1748<tr><td>l</td><td>Invisible cursor {civis}</td></tr> 1847<tr><td>l</td><td>Invisible cursor {civis}</td></tr>
1859<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr> 1958<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr>
1860<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr> 1959<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr>
1861<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>
1862<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>
1863<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>
1864<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt</td></tr> 1963<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr>
1865<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt</td></tr> 1964<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr>
1866<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>
1867<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>
1868<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>
1869<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>
1870<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>
1871<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>
1872<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>
1873<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>
1874<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>
1875<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>
1975<tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr>
1976<tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr>
1876<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>
1877<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr> 1978<tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1878<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr> 1979<tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1879<tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr> 1980<tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr>
1880<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>
1881<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>
1882<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>
1883</table><p></p></dl> 1984</table><p></p></dl>
1884<p></p> 1985<p></p>
1885<p>
1886</p>
1887<hr />
1888<h1><a name="menubar">menuBar</a></h1>
1889<p><strong>The exact syntax used is <em>almost</em> solidified. </strong>&gt;
1890In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
1891menuBar.</p>
1892<p>Note that in all of the commands, the <strong><em>/path/</em> </strong>&gt; <em>cannot</em> be
1893omitted: use <strong>./</strong> to specify a menu relative to the current menu.</p>
1894<p>
1895</p>
1896<h2><a name="overview_of_menubar_operation">Overview of menuBar operation</a></h2>
1897<p>For the menuBar XTerm escape sequence <code>ESC ] 703 ; Pt ST</code>, the syntax
1898of <a href="#item_pt"><code>Pt</code></a> can be used for a variety of tasks:</p>
1899<p>At the top level is the current menuBar which is a member of a circular
1900linked-list of other such menuBars.</p>
1901<p>The menuBar acts as a parent for the various drop-down menus, which in
1902turn, may have labels, separator lines, menuItems and subMenus.</p>
1903<p>The menuItems are the useful bits: you can use them to mimic keyboard
1904input or even to send text or escape sequences back to rxvt.</p>
1905<p>The menuBar syntax is intended to provide a simple yet robust method of
1906constructing and manipulating menus and navigating through the
1907menuBars.</p>
1908<p>The first step is to use the tag <strong>[menu:<em>name</em>] </strong>&gt; which creates
1909the menuBar called <em>name</em> and allows access. You may now or menus,
1910subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the
1911menuBar access as <strong>readonly</strong> to prevent accidental corruption of the
1912menus. To re-access the current menuBar for alterations, use the tag
1913<strong>[menu]</strong>, make the alterations and then use <strong>[done]</strong></p>
1914<p></p>
1915<p>
1916</p>
1917<h2><a name="commands">Commands</a></h2>
1918<dl>
1919<dt><strong><a name="item__5bmenu_3a_2bname_5d"><strong>[menu:+<em>name</em>] </strong>&gt;</a></strong><br />
1920</dt>
1921<dd>
1922access the named menuBar for creation or alteration. If a new menuBar
1923is created, it is called <em>name</em> (max of 15 chars) and the current
1924menuBar is pushed onto the stack
1925</dd>
1926<p></p>
1927<dt><strong><a name="item__5bmenu_5d"><strong>[menu]</strong></a></strong><br />
1928</dt>
1929<dd>
1930access the current menuBar for alteration
1931</dd>
1932<p></p>
1933<dt><strong><a name="item__5btitle_3a_2bstring_5d"><strong>[title:+<em>string</em>] </strong>&gt;</a></strong><br />
1934</dt>
1935<dd>
1936set the current menuBar's title to <em>string</em>, which may contain the
1937following format specifiers:
1938</dd>
1939<dd>
1940<pre>
1941 B&lt;%n&gt; rxvt name (as per the B&lt;-name&gt; command-line option)
1942 B&lt;%v&gt; rxvt version
1943 B&lt;%%&gt; literal B&lt;%&gt; character</pre>
1944</dd>
1945<p></p>
1946<dt><strong><a name="item__5bdone_5d"><strong>[done]</strong></a></strong><br />
1947</dt>
1948<dd>
1949set menuBar access as <strong>readonly</strong>.
1950End-of-file tag for <strong>[read:+<em>file</em>] </strong>&gt; operations.
1951</dd>
1952<p></p>
1953<dt><strong><a name="item__5bread_3a_2bfile_5d"><strong>[read:+<em>file</em>] </strong>&gt;</a></strong><br />
1954</dt>
1955<dd>
1956read menu commands directly from <em>file</em> (extension ``.menu'' will be
1957appended if required.) Start reading at a line with <strong>[menu]</strong> or <strong>&lt;
1958[menu:+<em>name</em> </strong>&gt; and continuing until <strong>[done]</strong> is encountered.
1959</dd>
1960<dd>
1961<p>Blank and comment lines (starting with <strong>#</strong>) are ignored. Actually,
1962since any invalid menu commands are also ignored, almost anything could
1963be construed as a comment line, but this may be tightened up in the
1964future ... so don't count on it!.</p>
1965</dd>
1966<p></p>
1967<dt><strong><a name="item__5bread_3a_2bfile_3b_2bname_5d"><strong>[read:+<em>file</em>;+<em>name</em>] </strong>&gt;</a></strong><br />
1968</dt>
1969<dd>
1970The same as <strong>[read:+<em>file</em>] </strong>&gt;, but start reading at a line with
1971<strong>[menu:+<em>name</em>] </strong>&gt; and continuing until <strong>[done:+<em>name</em>] </strong>&gt; or
1972<strong>[done]</strong> is encountered.
1973</dd>
1974<p></p>
1975<dt><strong><a name="item__5bdump_5d"><strong>[dump]</strong></a></strong><br />
1976</dt>
1977<dd>
1978dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable for
1979later rereading.
1980</dd>
1981<p></p>
1982<dt><strong><a name="item__5brm_3aname_5d"><strong>[rm:name]</strong></a></strong><br />
1983</dt>
1984<dd>
1985remove the named menuBar
1986</dd>
1987<p></p>
1988<dt><strong><a name="item__5brm_5d__5brm_3a_5d"><strong>[rm] [rm:]</strong></a></strong><br />
1989</dt>
1990<dd>
1991remove the current menuBar
1992</dd>
1993<p></p>
1994<dt><strong><a name="item__5brm_2a_5d__5brm_3a_2a_5d"><strong>[rm*] [rm:*]</strong></a></strong><br />
1995</dt>
1996<dd>
1997remove all menuBars
1998</dd>
1999<p></p>
2000<dt><strong><a name="item__5bswap_5d"><strong>[swap]</strong></a></strong><br />
2001</dt>
2002<dd>
2003swap the top two menuBars
2004</dd>
2005<p></p>
2006<dt><strong><a name="item__5bprev_5d"><strong>[prev]</strong></a></strong><br />
2007</dt>
2008<dd>
2009access the previous menuBar
2010</dd>
2011<p></p>
2012<dt><strong><a name="item__5bnext_5d"><strong>[next]</strong></a></strong><br />
2013</dt>
2014<dd>
2015access the next menuBar
2016</dd>
2017<p></p>
2018<dt><strong><a name="item__5bshow_5d"><strong>[show]</strong></a></strong><br />
2019</dt>
2020<dd>
2021Enable display of the menuBar
2022</dd>
2023<p></p>
2024<dt><strong><a name="item__5bhide_5d"><strong>[hide]</strong></a></strong><br />
2025</dt>
2026<dd>
2027Disable display of the menuBar
2028</dd>
2029<p></p>
2030<dt><strong><a name="item__5bpixmap_3a_2bname_5d"><strong>[pixmap:+<em>name</em>] </strong>&gt;</a></strong><br />
2031</dt>
2032<dt><strong><a name="item__5bpixmap_3a_2bname_3bscaling_5d"><strong>[pixmap:+<em>name</em>;<em>scaling</em>] </strong>&gt;</a></strong><br />
2033</dt>
2034<dd>
2035(set the background pixmap globally
2036</dd>
2037<dd>
2038<p><strong>A Future implementation <em>may</em> make this local to the menubar </strong>&gt;)</p>
2039</dd>
2040<p></p>
2041<dt><strong><a name="item__5b_3a_2bcommand_3a_5d"><strong>[:+<em>command</em>:] </strong>&gt;</a></strong><br />
2042</dt>
2043<dd>
2044ignore the menu readonly status and issue a <em>command</em> to or a menu or
2045menuitem or change the ; a useful shortcut for setting the quick arrows
2046from a menuBar.
2047</dd>
2048<p></p></dl>
2049<p></p>
2050<p>
2051</p>
2052<h2><a name="adding_and_accessing_menus">Adding and accessing menus</a></h2>
2053<p>The following commands may also be <strong>+</strong> prefixed.</p>
2054<dl>
2055<dt><strong><a name="item__2f_2b"><strong>/+</strong></a></strong><br />
2056</dt>
2057<dd>
2058access menuBar top level
2059</dd>
2060<p></p>
2061<dt><strong><a name="item__2e_2f_2b"><strong>./+</strong></a></strong><br />
2062</dt>
2063<dd>
2064access current menu level
2065</dd>
2066<p></p>
2067<dt><strong><a name="item__2e_2e_2f_2b"><strong>../+</strong></a></strong><br />
2068</dt>
2069<dd>
2070access parent menu (1 level up)
2071</dd>
2072<p></p>
2073<dt><strong><a name="item__2e_2e_2f_2e_2e_2f"><strong>../../</strong></a></strong><br />
2074</dt>
2075<dd>
2076access parent menu (multiple levels up)
2077</dd>
2078<p></p>
2079<dt><strong><a name="item__2fpath_2fmenu"><strong><em>/path/</em>menu </strong>&gt;</a></strong><br />
2080</dt>
2081<dd>
2082add/access menu
2083</dd>
2084<p></p>
2085<dt><strong><a name="item__2fpath_2fmenu_2f_2a"><strong><em>/path/</em>menu/* </strong>&gt;</a></strong><br />
2086</dt>
2087<dd>
2088add/access menu and clear it if it exists
2089</dd>
2090<p></p>
2091<dt><strong><a name="item__2fpath_2f_7b_2d_7d"><strong><em>/path/</em>{-} </strong>&gt;</a></strong><br />
2092</dt>
2093<dd>
2094add separator
2095</dd>
2096<p></p>
2097<dt><strong><a name="item__2fpath_2f_7bitem_7d"><strong><em>/path/</em>{item} </strong>&gt;</a></strong><br />
2098</dt>
2099<dd>
2100add <strong>item</strong> as a label
2101</dd>
2102<p></p>
2103<dt><strong><a name="item__2fpath_2f_7bitem_7d_action"><strong><em>/path/</em>{item} action </strong>&gt;</a></strong><br />
2104</dt>
2105<dd>
2106add/alter <em>menuitem</em> with an associated <em>action</em>
2107</dd>
2108<p></p>
2109<dt><strong><a name="item__2fpath_2f_7bitem_7d_7bright_2dtext_7d"><strong><em>/path/</em>{item}{right-text} </strong>&gt;</a></strong><br />
2110</dt>
2111<dd>
2112add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified text
2113and as the associated <em>action</em>
2114</dd>
2115<p></p>
2116<dt><strong><a name="item__2fpath_2f_7bitem_7d_7brtext_7d_action"><strong><em>/path/</em>{item}{rtext} action </strong>&gt;</a></strong><br />
2117</dt>
2118<dd>
2119add/alter <em>menuitem</em> with an associated <em>action</em> and with <strong>rtext</strong> as
2120the right-justified text.
2121</dd>
2122<p></p></dl>
2123<dl>
2124<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 />
2125</dt>
2126<dd>
2127<strong>\a \b \E \e \n \r \t \octal</strong>
2128</dd>
2129<p></p>
2130<dt><strong><a name="item_or_in_control_2dcharacter_notation_3a">or in control-character notation:</a></strong><br />
2131</dt>
2132<dd>
2133<strong>^@, ^A .. ^Z .. ^_, ^?</strong>
2134</dd>
2135<p></p></dl>
2136<p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the
2137program, start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>),
2138the first of which will be stripped off and the balance directed to the
2139program. Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by
2140non-+<strong>NUL</strong> characters, the leading <strong>NUL</strong> is stripped off and the
2141balance is sent back to rxvt.</p>
2142<p>As a convenience for the many Emacs-type editors, <em>action</em> may start
2143with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
2144appended if missed from <strong>M-x</strong> commands.</p>
2145<p>As a convenience for issuing XTerm <strong>ESC ]</strong> sequences from a menubar (or
2146quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.</p>
2147<dl>
2148<dt><strong><a name="item_for_example_2c">For example,</a></strong><br />
2149</dt>
2150<dd>
2151<strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong>
2152</dd>
2153<p></p>
2154<dt><strong><a name="item_and">and</a></strong><br />
2155</dt>
2156<dd>
2157<strong>\E]703;mona;100</strong> is equivalent to <strong>\E]703;mona;100\a</strong>
2158</dd>
2159<p></p></dl>
2160<p>The option <strong>{<em>right-rtext</em>} </strong>&gt; will be right-justified. In the
2161absence of a specified action, this text will be used as the <em>action</em>
2162as well.</p>
2163<dl>
2164<dt><strong>For example,</strong><br />
2165</dt>
2166<dd>
2167<strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong>
2168</dd>
2169<p></p></dl>
2170<p>The left label <em>is</em> necessary, since it's used for matching, but
2171implicitly hiding the left label (by using same name for both left and
2172right labels), or explicitly hiding the left label (by preceeding it
2173with a dot), makes it possible to have right-justified text only.</p>
2174<dl>
2175<dt><strong>For example,</strong><br />
2176</dt>
2177<dd>
2178<strong>/File/{Open}{Open} Open-File-Action</strong>
2179</dd>
2180<p></p>
2181<dt><strong><a name="item_or_hiding_it">or hiding it</a></strong><br />
2182</dt>
2183<dd>
2184<strong>/File/{.anylabel}{Open} Open-File-Action</strong>
2185</dd>
2186<p></p></dl>
2187<p></p>
2188<p>
2189</p>
2190<h2><a name="removing_menus">Removing menus</a></h2>
2191<dl>
2192<dt><strong><a name="item__2d_2f_2a_2b"><strong>-/*+ </strong>&gt;</a></strong><br />
2193</dt>
2194<dd>
2195remove all menus from the menuBar, the same as <strong>[clear]</strong>
2196</dd>
2197<p></p>
2198<dt><strong><a name="item__2d_2b_2fpathmenu_2b"><strong>-+<em>/path</em>menu+ </strong>&gt;</a></strong><br />
2199</dt>
2200<dd>
2201remove menu
2202</dd>
2203<p></p>
2204<dt><strong><a name="item__2d_2b_2fpath_7bitem_7d_2b"><strong>-+<em>/path</em>{item}+ </strong>&gt;</a></strong><br />
2205</dt>
2206<dd>
2207remove item
2208</dd>
2209<p></p>
2210<dt><strong><a name="item__2d_2b_2fpath_7b_2d_7d"><strong>-+<em>/path</em>{-} </strong>&gt;</a></strong><br />
2211</dt>
2212<dd>
2213remove separator)
2214</dd>
2215<p></p>
2216<dt><strong><a name="item__2d_2fpath_2fmenu_2f_2a"><strong>-/path/menu/*</strong></a></strong><br />
2217</dt>
2218<dd>
2219remove all items, separators and submenus from menu
2220</dd>
2221<p></p></dl>
2222<p></p>
2223<p>
2224</p>
2225<h2><a name="quick_arrows">Quick Arrows</a></h2>
2226<p>The menus also provide a hook for <em>quick arrows</em> to provide easier
2227user access. If nothing has been explicitly set, the default is to
2228emulate the curror keys. The syntax permits each arrow to be altered
2229individually or all four at once without re-entering their common
2230beginning/end text. For example, to explicitly associate cursor actions
2231with the arrows, any of the following forms could be used:</p>
2232<dl>
2233<dt><strong><a name="item__3cr_3e_2bright"><strong>&lt;r</strong>+<em>Right</em> &gt;&gt;</a></strong><br />
2234</dt>
2235<dt><strong><a name="item__3cl_3e_2bleft"><strong>&lt;l</strong>+<em>Left</em> &gt;&gt;</a></strong><br />
2236</dt>
2237<dt><strong><a name="item__3cu_3e_2bup"><strong>&lt;u</strong>+<em>Up</em> &gt;&gt;</a></strong><br />
2238</dt>
2239<dt><strong><a name="item__3cd_3e_2bdown"><strong>&lt;d</strong>+<em>Down</em> &gt;&gt;</a></strong><br />
2240</dt>
2241<dd>
2242Define actions for the respective arrow buttons
2243</dd>
2244<p></p>
2245<dt><strong><a name="item__3cb_3e_2bbegin"><strong>&lt;b</strong>+<em>Begin</em> &gt;&gt;</a></strong><br />
2246</dt>
2247<dt><strong><a name="item__3ce_3e_2bend"><strong>&lt;e</strong>+<em>End</em> &gt;&gt;</a></strong><br />
2248</dt>
2249<dd>
2250Define common beginning/end parts for <em>quick arrows</em> which used in
2251conjunction with the above &lt;r&gt; &lt;l&gt; &lt;u&gt; &lt;d&gt; constructs
2252</dd>
2253<p></p></dl>
2254<dl>
2255<dt><strong><a name="item_for_example_2c_define_arrows_individually_2c">For example, define arrows individually,</a></strong><br />
2256</dt>
2257<dd>
2258<pre>
2259 &lt;u&gt;\E[A</pre>
2260</dd>
2261<dd>
2262<pre>
2263 &lt;d&gt;\E[B</pre>
2264</dd>
2265<dd>
2266<pre>
2267 &lt;r&gt;\E[C</pre>
2268</dd>
2269<dd>
2270<pre>
2271 &lt;l&gt;\E[D</pre>
2272</dd>
2273<dt><strong><a name="item_or_all_at_once">or all at once</a></strong><br />
2274</dt>
2275<dd>
2276<pre>
2277 &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>
2278</dd>
2279<dt><strong><a name="item_compactly">or more compactly (factoring out common parts)</a></strong><br />
2280</dt>
2281<dd>
2282<pre>
2283 &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>
2284</dd>
2285</dl>
2286<p></p>
2287<p>
2288</p>
2289<h2><a name="command_summary">Command Summary</a></h2>
2290<p>A short summary of the most <em>common</em> commands:</p>
2291<dl>
2292<dt><strong><a name="item__5bmenu_3aname_5d">[menu:name]</a></strong><br />
2293</dt>
2294<dd>
2295use an existing named menuBar or start a new one
2296</dd>
2297<p></p>
2298<dt><strong>[menu]</strong><br />
2299</dt>
2300<dd>
2301use the current menuBar
2302</dd>
2303<p></p>
2304<dt><strong><a name="item__5btitle_3astring_5d">[title:string]</a></strong><br />
2305</dt>
2306<dd>
2307set menuBar title
2308</dd>
2309<p></p>
2310<dt><strong>[done]</strong><br />
2311</dt>
2312<dd>
2313set menu access to readonly and, if reading from a file, signal EOF
2314</dd>
2315<p></p>
2316<dt><strong><a name="item__5bdone_3aname_5d">[done:name]</a></strong><br />
2317</dt>
2318<dd>
2319if reading from a file using [read:file;name] signal EOF
2320</dd>
2321<p></p>
2322<dt><strong>[rm:name]</strong><br />
2323</dt>
2324<dd>
2325remove named <code>menuBar(s)</code>
2326</dd>
2327<p></p>
2328<dt><strong>[rm] [rm:]</strong><br />
2329</dt>
2330<dd>
2331remove current menuBar
2332</dd>
2333<p></p>
2334<dt><strong>[rm*] [rm:*]</strong><br />
2335</dt>
2336<dd>
2337remove all <code>menuBar(s)</code>
2338</dd>
2339<p></p>
2340<dt><strong>[swap]</strong><br />
2341</dt>
2342<dd>
2343swap top two menuBars
2344</dd>
2345<p></p>
2346<dt><strong>[prev]</strong><br />
2347</dt>
2348<dd>
2349access the previous menuBar
2350</dd>
2351<p></p>
2352<dt><strong>[next]</strong><br />
2353</dt>
2354<dd>
2355access the next menuBar
2356</dd>
2357<p></p>
2358<dt><strong>[show]</strong><br />
2359</dt>
2360<dd>
2361map menuBar
2362</dd>
2363<p></p>
2364<dt><strong>[hide]</strong><br />
2365</dt>
2366<dd>
2367unmap menuBar
2368</dd>
2369<p></p>
2370<dt><strong><a name="item__5bpixmap_3bfile_5d">[pixmap;file]</a></strong><br />
2371</dt>
2372<dt><strong><a name="item__5bpixmap_3bfile_3bscaling_5d">[pixmap;file;scaling]</a></strong><br />
2373</dt>
2374<dd>
2375set a background pixmap
2376</dd>
2377<p></p>
2378<dt><strong><a name="item__5bread_3afile_5d">[read:file]</a></strong><br />
2379</dt>
2380<dt><strong><a name="item__5bread_3afile_3bname_5d">[read:file;name]</a></strong><br />
2381</dt>
2382<dd>
2383read in a menu from a file
2384</dd>
2385<p></p>
2386<dt><strong>[dump]</strong><br />
2387</dt>
2388<dd>
2389dump out all menuBars to /tmp/rxvt-PID
2390</dd>
2391<p></p>
2392<dt><strong><a name="item__2f">/</a></strong><br />
2393</dt>
2394<dd>
2395access menuBar top level
2396</dd>
2397<p></p>
2398<dt><strong><a name="item__2e_2f">./</a></strong><br />
2399</dt>
2400<dt><strong><a name="item__2e_2e_2f">../</a></strong><br />
2401</dt>
2402<dt><strong>../../</strong><br />
2403</dt>
2404<dd>
2405access current or parent menu level
2406</dd>
2407<p></p>
2408<dt><strong>/path/menu</strong><br />
2409</dt>
2410<dd>
2411add/access menu
2412</dd>
2413<p></p>
2414<dt><strong>/path/{-}</strong><br />
2415</dt>
2416<dd>
2417add separator
2418</dd>
2419<p></p>
2420<dt><strong>/path/{item}{rtext} action</strong><br />
2421</dt>
2422<dd>
2423add/alter menu item
2424</dd>
2425<p></p>
2426<dt><strong><a name="item__2d_2f_2a">-/*</a></strong><br />
2427</dt>
2428<dd>
2429remove all menus from the menuBar
2430</dd>
2431<p></p>
2432<dt><strong><a name="item__2d_2fpath_2fmenu">-/path/menu</a></strong><br />
2433</dt>
2434<dd>
2435remove menu items, separators and submenus from menu
2436</dd>
2437<p></p>
2438<dt><strong>-/path/menu</strong><br />
2439</dt>
2440<dd>
2441remove menu
2442</dd>
2443<p></p>
2444<dt><strong><a name="item__2d_2fpath_2f_7bitem_7d">-/path/{item}</a></strong><br />
2445</dt>
2446<dd>
2447remove item
2448</dd>
2449<p></p>
2450<dt><strong><a name="item__2d_2fpath_2f_7b_2d_7d">-/path/{-}</a></strong><br />
2451</dt>
2452<dd>
2453remove separator
2454</dd>
2455<p></p>
2456<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 />
2457</dt>
2458<dd>
2459menu quick arrows
2460</dd>
2461<p></p></dl>
2462<p> 1986<p>
2463</p> 1987</p>
2464<hr /> 1988<hr />
2465<h1><a name="xpm">XPM</a></h1> 1989<h1><a name="xpm">XPM</a></h1>
2466<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
2715</dd> 2239</dd>
2716<p></p> 2240<p></p>
2717<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 />
2718</dt> 2242</dt>
2719<dd> 2243<dd>
2244Recommended to stay off unless you really need non-BMP characters.
2245</dd>
2246<dd>
2720Enable direct support for displaying unicode codepoints above 2247<p>Enable direct support for displaying unicode codepoints above
272165535 (the basic multilingual page). This increases storage 224865535 (the basic multilingual page). This increases storage
2722requirements 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
2723support these extra characters, but Xft does. 2250support these extra characters, but Xft does.</p>
2724</dd> 2251</dd>
2725<dd> 2252<dd>
2726<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
2727even without this flag, but the number of such characters is 2254even without this flag, but the number of such characters is
2728limited to a view thousand (shared with combining characters, 2255limited to a view thousand (shared with combining characters,
2738where accents are encoded as seperate unicode characters. This is 2265where accents are encoded as seperate unicode characters. This is
2739done by using precomposited characters when available or creating 2266done by using precomposited characters when available or creating
2740new pseudo-characters when no precomposed form exists. 2267new pseudo-characters when no precomposed form exists.
2741</dd> 2268</dd>
2742<dd> 2269<dd>
2743<p>Without --enable-unicode3, the number of additional precomposed characters 2270<p>Without --enable-unicode3, the number of additional precomposed
2744is rather limited (2048, if this is full, rxvt-unicode will use the 2271characters is somewhat limited (the 6400 private use characters will be
2745private use area, extending the number of combinations to 8448). With
2746--enable-unicode3, no practical limit exists.</p> 2272(ab-)used). With --enable-unicode3, no practical limit exists.</p>
2747</dd> 2273</dd>
2748<dd> 2274<dd>
2749<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
2750beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p> 2276beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p>
2751</dd> 2277</dd>
2756</dd> 2282</dd>
2757<p></p> 2283<p></p>
2758<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 />
2759</dt> 2285</dt>
2760<dd> 2286<dd>
2761When 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.
2762</dd> 2289</dd>
2763<p></p> 2290<p></p>
2764<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 />
2765</dt> 2292</dt>
2766<dd> 2293<dd>
2797Write user and tty to lastlog file (used by programs like 2324Write user and tty to lastlog file (used by programs like
2798<em>lastlogin</em>) at start of rxvt execution. This option requires 2325<em>lastlogin</em>) at start of rxvt execution. This option requires
2799--enable-utmp to also be specified. 2326--enable-utmp to also be specified.
2800</dd> 2327</dd>
2801<p></p> 2328<p></p>
2802<dt><strong><a name="item_background">--enable-xpm-background (default: off)</a></strong><br /> 2329<dt><strong><a name="item_background">--enable-xpm-background (default: on)</a></strong><br />
2803</dt> 2330</dt>
2804<dd> 2331<dd>
2805Add support for XPM background pixmaps. 2332Add support for XPM background pixmaps.
2806</dd> 2333</dd>
2807<p></p> 2334<p></p>
2808<dt><strong><a name="item_transparency">--enable-transparency (default: off)</a></strong><br /> 2335<dt><strong><a name="item_transparency">--enable-transparency (default: on)</a></strong><br />
2809</dt> 2336</dt>
2810<dd> 2337<dd>
2811Add support for inheriting parent backgrounds thus giving a fake 2338Add support for inheriting parent backgrounds thus giving a fake
2812transparency to the term. 2339transparency to the term.
2813</dd> 2340</dd>
2820<p></p> 2347<p></p>
2821<dt><strong><a name="item_tinting">--enable-tinting (default: on)</a></strong><br /> 2348<dt><strong><a name="item_tinting">--enable-tinting (default: on)</a></strong><br />
2822</dt> 2349</dt>
2823<dd> 2350<dd>
2824Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>). 2351Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>).
2825</dd>
2826<p></p>
2827<dt><strong><a name="item_menubar">--enable-menubar (default: off)</a></strong><br />
2828</dt>
2829<dd>
2830Add support for our menu bar system (this interacts badly with
2831dynamic locale switching currently).
2832</dd> 2352</dd>
2833<p></p> 2353<p></p>
2834<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 />
2835</dt> 2355</dt>
2836<dd> 2356<dd>
2855Add support for a very unobtrusive, plain-looking scrollbar that 2375Add support for a very unobtrusive, plain-looking scrollbar that
2856is the favourite of the rxvt-unicode author, having used it for 2376is the favourite of the rxvt-unicode author, having used it for
2857many years. 2377many years.
2858</dd> 2378</dd>
2859<p></p> 2379<p></p>
2860<dt><strong><a name="item_shadow">--enable-half-shadow (default: off)</a></strong><br />
2861</dt>
2862<dd>
2863Make shadows on the scrollbar only half the normal width &amp; height.
2864only applicable to rxvt scrollbars.
2865</dd>
2866<p></p>
2867<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 />
2868</dt> 2381</dt>
2869<dd> 2382<dd>
2870Change tty device setting to group ``tty'' - only use this if 2383Change tty device setting to group ``tty'' - only use this if
2871your system uses this type of security. 2384your system uses this type of security.
2886<p></p> 2399<p></p>
2887<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 />
2888</dt> 2401</dt>
2889<dd> 2402<dd>
2890Removes any support for resource checking. 2403Removes any support for resource checking.
2891</dd>
2892<p></p>
2893<dt><strong><a name="item__2d_2denable_2dxgetdefault">--enable-xgetdefault</a></strong><br />
2894</dt>
2895<dd>
2896Make resources checking via <code>XGetDefault()</code> instead of our small
2897version which only checks ~/.Xdefaults, or if that doesn't exist then
2898~/.Xresources.
2899</dd>
2900<dd>
2901<p>Please note that nowadays, things like XIM will automatically pull in and
2902use the full X resource manager, so the overhead of using it might be very
2903small, if nonexistant.</p>
2904</dd>
2905<p></p>
2906<dt><strong><a name="item_strings">--enable-strings (default: off)</a></strong><br />
2907</dt>
2908<dd>
2909Add support for our possibly faster <code>memset()</code> function and other
2910various routines, overriding your system's versions which may
2911have been hand-crafted in assembly or may require extra libraries
2912to link in. (this breaks ANSI-C rules and has problems on many
2913GNU/Linux systems).
2914</dd> 2404</dd>
2915<p></p> 2405<p></p>
2916<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 />
2917</dt> 2407</dt>
2918<dd> 2408<dd>
2934<pre> 2424<pre>
2935 MWM-hints 2425 MWM-hints
2936 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2937 seperate underline colour (-underlineColor) 2427 seperate underline colour (-underlineColor)
2938 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual selection (-depth)
2939 settable extra linespacing /-lsp) 2430 settable extra linespacing /-lsp)
2940 iso-14755-2 and -3, and visual feedback 2431 iso-14755-2 and -3, and visual feedback
2941 backindex and forwardindex escape sequence 2432 backindex and forwardindex escape sequence
2942 window op and some xterm/OSC escape sequences 2433 window op and some xterm/OSC escape sequences
2943 tripleclickwords (-tcw) 2434 tripleclickwords (-tcw)
3019</dt> 2510</dt>
3020<dd> 2511<dd>
3021Add support to have the pointer disappear when typing or inactive. 2512Add support to have the pointer disappear when typing or inactive.
3022</dd> 2513</dd>
3023<p></p> 2514<p></p>
3024<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 />
3025</dt> 2516</dt>
3026<dd> 2517<dd>
3027Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong> 2518Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
3028manpage (<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
3029in <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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines