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.25 by root, Tue Nov 8 17:35:28 2005 UTC vs.
Revision 1.52 by root, Sat Jan 28 22:16:58 2006 UTC

22 <li><a href="#values">Values</a></li> 22 <li><a href="#values">Values</a></li>
23 <li><a href="#escape_sequences">Escape Sequences</a></li> 23 <li><a href="#escape_sequences">Escape Sequences</a></li>
24 <li><a href="#csi__command_sequence_introducer__sequences">CSI (Command Sequence Introducer) Sequences</a></li> 24 <li><a href="#csi__command_sequence_introducer__sequences">CSI (Command Sequence Introducer) Sequences</a></li>
25 <li><a href="#dec_private_modes">DEC Private Modes</a></li> 25 <li><a href="#dec_private_modes">DEC Private Modes</a></li>
26 <li><a href="#xterm_operating_system_commands">XTerm Operating System Commands</a></li> 26 <li><a href="#xterm_operating_system_commands">XTerm Operating System Commands</a></li>
27 <li><a href="#menubar">menuBar</a></li>
28 <ul>
29
30 <li><a href="#overview_of_menubar_operation">Overview of menuBar operation</a></li>
31 <li><a href="#commands">Commands</a></li>
32 <li><a href="#adding_and_accessing_menus">Adding and accessing menus</a></li>
33 <li><a href="#removing_menus">Removing menus</a></li>
34 <li><a href="#quick_arrows">Quick Arrows</a></li>
35 <li><a href="#command_summary">Command Summary</a></li>
36 </ul>
37
38 <li><a href="#xpm">XPM</a></li> 27 <li><a href="#xpm">XPM</a></li>
39 <li><a href="#mouse_reporting">Mouse Reporting</a></li> 28 <li><a href="#mouse_reporting">Mouse Reporting</a></li>
40 <li><a href="#key_codes">Key Codes</a></li> 29 <li><a href="#key_codes">Key Codes</a></li>
41 <li><a href="#configure_options">CONFIGURE OPTIONS</a></li> 30 <li><a href="#configure_options">CONFIGURE OPTIONS</a></li>
42 <li><a href="#authors">AUTHORS</a></li> 31 <li><a href="#authors">AUTHORS</a></li>
73<p> 62<p>
74</p> 63</p>
75<hr /> 64<hr />
76<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 65<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
77<dl> 66<dl>
67<dt><strong><a name="item_the_new_selection_selects_pieces_that_are_too_big_">The new selection selects pieces that are too big, how can I select
68single words?</a></strong><br />
69</dt>
70<dd>
71Yes. For example, if you want to select alphanumeric words, you can use
72the following resource:
73</dd>
74<dd>
75<pre>
76 URxvt.selection.pattern-0: ([[:word:]]+)</pre>
77</dd>
78<dd>
79<p>If you click more than twice, the selection will be extended
80more and more.</p>
81</dd>
82<dd>
83<p>To get a selection that is very similar to the old code, try this pattern:</p>
84</dd>
85<dd>
86<pre>
87 URxvt.selection.pattern-0: ([^&quot;&amp;'()*,;&lt;=&gt;?@[\\\\]^`{|})]+)</pre>
88</dd>
89<dd>
90<p>Please also note that the <em>LeftClick Shift-LeftClik</em> combination also
91selects words like the old code.</p>
92</dd>
93<p></p>
94<dt><strong><a name="item_i_don_27t_like_the_new_selection_2fpopups_2fhotkey">I don't like the new selection/popups/hotkeys/perl, how do I
95change/disable it?</a></strong><br />
96</dt>
97<dd>
98You can disable the perl extension completely by setting the
99<strong>perl-ext-common</strong> resource to the empty string, which also keeps
100rxvt-unicode from initialising perl, saving memory.
101</dd>
102<dd>
103<p>If you only want to disable specific features, you first have to
104identify which perl extension is responsible. For this, read the section
105<strong>PREPACKAGED EXTENSIONS</strong> in the <code>rxvtperl(3)</code> manpage. For
106example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
107this <strong>perl-ext-common</strong> resource:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.perl-ext-common: default,-selection-popup,-option-popup</pre>
112</dd>
113<dd>
114<p>This will keep the default extensions, but disable the two popup
115extensions. Some extensions can also be configured, for example,
116scrollback search mode is triggered by <strong>M-s</strong>. You can move it to any
117other combination either by setting the <strong>searchable-scrollback</strong> resource:</p>
118</dd>
119<dd>
120<pre>
121 URxvt.searchable-scrollback: CM-s</pre>
122</dd>
123<p></p>
124<dt><strong><a name="item_isn_27t_rxvt_supposed_to_be_small_3f_don_27t_all_t">Isn't rxvt supposed to be small? Don't all those features bloat?</a></strong><br />
125</dt>
126<dd>
127I often get asked about this, and I think, no, they didn't cause extra
128bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
129that the urxvt binary is larger (due to some encoding tables always being
130compiled in), but it actually uses less memory (RSS) after startup. Even
131with <code>--disable-everything</code>, this comparison is a bit unfair, as many
132features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
133already in use in this mode.
134</dd>
135<dd>
136<pre>
137 text data bss drs rss filename
138 98398 1664 24 15695 1824 rxvt --disable-everything
139 188985 9048 66616 18222 1788 urxvt --disable-everything</pre>
140</dd>
141<dd>
142<p>When you <a href="#item__2d_2denable_2deverything"><code>--enable-everything</code></a> (which _is_ unfair, as this involves xft
143and full locale/XIM support which are quite bloaty inside libX11 and my
144libc), the two diverge, but not unreasnobaly so.</p>
145</dd>
146<dd>
147<pre>
148 text data bss drs rss filename
149 163431 2152 24 20123 2060 rxvt --enable-everything
150 1035683 49680 66648 29096 3680 urxvt --enable-everything</pre>
151</dd>
152<dd>
153<p>The very large size of the text section is explained by the east-asian
154encoding tables, which, if unused, take up disk space but nothing else
155and can be compiled out unless you rely on X11 core fonts that use those
156encodings. The BSS size comes from the 64k emergency buffer that my c++
157compiler allocates (but of course doesn't use unless you are out of
158memory). Also, using an xft font instead of a core font immediately adds a
159few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
160not used.</p>
161</dd>
162<dd>
163<p>Of course, due to every character using two or four bytes instead of one,
164a large scrollback buffer will ultimately make rxvt-unicode use more
165memory.</p>
166</dd>
167<dd>
168<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
169still fares rather well. And compared to some monsters like gnome-terminal
170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17143180k in daemons that stay around after exit, plus half a minute of
172startup time, including the hundreds of warnings it spits out), it fares
173extremely well *g*.</p>
174</dd>
175<p></p>
176<dt><strong><a name="item_why_c_2b_2b_2c_isn_27t_that_unportable_2fbloated_2">Why C++, isn't that unportable/bloated/uncool?</a></strong><br />
177</dt>
178<dd>
179Is this a question? :) It comes up very often. The simple answer is: I had
180to write it, and C++ allowed me to write and maintain it in a fraction
181of the time and effort (which is a scarce resource for me). Put even
182shorter: It simply wouldn't exist without C++.
183</dd>
184<dd>
185<p>My personal stance on this is that C++ is less portable than C, but in
186the case of rxvt-unicode this hardly matters, as its portability limits
187are defined by things like X11, pseudo terminals, locale support and unix
188domain sockets, which are all less portable than C++ itself.</p>
189</dd>
190<dd>
191<p>Regarding the bloat, see the above question: It's easy to write programs
192in C that use gobs of memory, an certainly possible to write programs in
193C++ that don't. C++ also often comes with large libraries, but this is
194not necessarily the case with GCC. Here is what rxvt links against on my
195system with a minimal config:</p>
196</dd>
197<dd>
198<pre>
199 libX11.so.6 =&gt; /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
200 libc.so.6 =&gt; /lib/libc.so.6 (0x00002aaaaadde000)
201 libdl.so.2 =&gt; /lib/libdl.so.2 (0x00002aaaab01d000)
202 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)</pre>
203</dd>
204<dd>
205<p>And here is rxvt-unicode:</p>
206</dd>
207<dd>
208<pre>
209 libX11.so.6 =&gt; /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
210 libgcc_s.so.1 =&gt; /lib/libgcc_s.so.1 (0x00002aaaaada2000)
211 libc.so.6 =&gt; /lib/libc.so.6 (0x00002aaaaaeb0000)
212 libdl.so.2 =&gt; /lib/libdl.so.2 (0x00002aaaab0ee000)
213 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)</pre>
214</dd>
215<dd>
216<p>No large bloated libraries (of course, none were linked in statically),
217except maybe libX11 :)</p>
218</dd>
219<p></p>
220<dt><strong><a name="item_does_it_support_tabs_2c_can_i_have_a_tabbed_rxvt_2">Does it support tabs, can I have a tabbed rxvt-unicode?</a></strong><br />
221</dt>
222<dd>
223Beginning with version 7.3, there is a perl extension that implements a
224simple tabbed terminal. It is installed by default, so any of these should
225give you tabs:
226</dd>
227<dd>
228<pre>
229 rxvt -pe tabbed</pre>
230</dd>
231<dd>
232<pre>
233 URxvt.perl-ext-common: default,tabbed</pre>
234</dd>
235<dd>
236<p>It will also work fine with tabbing functionality of many window managers
237or similar tabbing programs, and its embedding-features allow it to be
238embedded into other programs, as witnessed by <em>doc/rxvt-tabbed</em> or
239the upcoming <code>Gtk2::URxvt</code> perl module, which features a tabbed urxvt
240(murxvt) terminal as an example embedding application.</p>
241</dd>
242<p></p>
78<dt><strong><a name="item_how_do_i_know_which_rxvt_2dunicode_version_i_27m_u">How do I know which rxvt-unicode version I'm using?</a></strong><br /> 243<dt><strong><a name="item_how_do_i_know_which_rxvt_2dunicode_version_i_27m_u">How do I know which rxvt-unicode version I'm using?</a></strong><br />
79</dt> 244</dt>
80<dd> 245<dd>
81The version number is displayed with the usage (-h). Also the escape 246The version number is displayed with the usage (-h). Also the escape
82sequence <code>ESC [ 8 n</code> sets the window title to the version number. 247sequence <code>ESC [ 8 n</code> sets the window title to the version number. When
248using the rxvtc client, the version displayed is that of the
249daemon.
83</dd> 250</dd>
84<p></p> 251<p></p>
85<dt><strong><a name="item_i_am_using_debian_gnu_2flinux_and_have_a_problem_2">I am using Debian GNU/Linux and have a problem...</a></strong><br /> 252<dt><strong><a name="item_i_am_using_debian_gnu_2flinux_and_have_a_problem_2">I am using Debian GNU/Linux and have a problem...</a></strong><br />
86</dt> 253</dt>
87<dd> 254<dd>
88The Debian GNU/Linux package of rxvt-unicode in sarge contains large 255The Debian GNU/Linux package of rxvt-unicode in sarge contains large
89patches that considerably change the behaviour of rxvt-unicode. Before 256patches that considerably change the behaviour of rxvt-unicode (but
90reporting 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
91install 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
92and 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
93problems 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
94reported via the Debian Bug Tracking System (use <code>reportbug</code> to report 262Tracking System (use <code>reportbug</code> to report the bug).
95the bug).
96</dd> 263</dd>
97<dd> 264<dd>
98<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
99probably 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
100bug 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
101might 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>
102</dd> 315</dd>
103<p></p> 316<p></p>
104<dt><strong><a name="item_when_i_log_2din_to_another_system_it_tells_me_abou">When I log-in to another system it tells me about missing terminfo data?</a></strong><br /> 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 />
105</dt> 318</dt>
106<dd> 319<dd>
145<dd> 358<dd>
146Most 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
147<code>enacs=\E[0@</code> and try again. 360<code>enacs=\E[0@</code> and try again.
148</dd> 361</dd>
149<p></p> 362<p></p>
150<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 />
151</dt> 364</dt>
152<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 />
153</dt> 366</dt>
154<dd> 367<dd>
155One reason you might want this is that some distributions or operating 368One reason you might want this is that some distributions or operating
309<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,
310e.g.:</p> 523e.g.:</p>
311</dd> 524</dd>
312<dd> 525<dd>
313<pre> 526<pre>
314 urxvt -fn basefont,font2,font3...</pre> 527 rxvt -fn basefont,font2,font3...</pre>
315</dd> 528</dd>
316<dd> 529<dd>
317<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
318font. 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
319next 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
623You 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
624terminal, using the resource <code>imlocale</code>: 837terminal, using the resource <code>imlocale</code>:
625</dd> 838</dd>
626<dd> 839<dd>
627<pre> 840<pre>
628 URxvt*imlocale: ja_JP.EUC-JP</pre> 841 URxvt.imlocale: ja_JP.EUC-JP</pre>
629</dd> 842</dd>
630<dd> 843<dd>
631<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
632use 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
633input 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
693<dd> 906<dd>
694Make sure that mouse reporting is actually turned off since killing 907Make sure that mouse reporting is actually turned off since killing
695some 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
696heard that tcsh may use mouse reporting unless it otherwise specified. A 909heard that tcsh may use mouse reporting unless it otherwise specified. A
697quick check is to see if cut/paste works when the Alt or Shift keys are 910quick check is to see if cut/paste works when the Alt or Shift keys are
698depressed. See <code>urxvt(7)</code> 911depressed.
699</dd> 912</dd>
700<p></p> 913<p></p>
701<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br /> 914<dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br />
702</dt> 915</dt>
703<dd> 916<dd>
777 URxvt.color14: #73f7ff 990 URxvt.color14: #73f7ff
778 URxvt.color7: #e1dddd 991 URxvt.color7: #e1dddd
779 URxvt.color15: #e1dddd</pre> 992 URxvt.color15: #e1dddd</pre>
780</dd> 993</dd>
781<p></p> 994<p></p>
782<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 />
783</dt> 996</dt>
784<dd> 997<dd>
785Try <code>urxvtd -f -o</code>, which tells urxvtd to open the 998Try <code>rxvtd -f -o</code>, which tells rxvtd to open the
786display, create the listening socket and then fork. 999display, create the listening socket and then fork.
787</dd> 1000</dd>
788<p></p> 1001<p></p>
789<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 />
790</dt> 1003</dt>
811</dd> 1024</dd>
812<dd> 1025<dd>
813<pre> 1026<pre>
814 # use Backspace = ^H 1027 # use Backspace = ^H
815 $ stty erase ^H 1028 $ stty erase ^H
816 $ urxvt</pre> 1029 $ rxvt</pre>
817</dd> 1030</dd>
818<dd> 1031<dd>
819<pre> 1032<pre>
820 # use Backspace = ^? 1033 # use Backspace = ^?
821 $ stty erase ^? 1034 $ stty erase ^?
822 $ urxvt</pre> 1035 $ rxvt</pre>
823</dd>
824<dd> 1036</dd>
1037<dd>
825<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code> as documented in urxvt(7).</p> 1038<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
826</dd> 1039</dd>
827<dd> 1040<dd>
828<p>For an existing rxvt-unicode:</p> 1041<p>For an existing rxvt-unicode:</p>
829</dd> 1042</dd>
830<dd> 1043<dd>
868There are some compile-time selections available via configure. Unless 1081There are some compile-time selections available via configure. Unless
869you 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
870use the `keysym' resource to alter the keystrings associated with keysyms. 1083use the `keysym' resource to alter the keystrings associated with keysyms.
871</dd> 1084</dd>
872<dd> 1085<dd>
873<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>
874</dd> 1087</dd>
875<dd> 1088<dd>
876<pre> 1089<pre>
877 URxvt.keysym.Home: \033[1~ 1090 URxvt.keysym.Home: \033[1~
878 URxvt.keysym.End: \033[4~ 1091 URxvt.keysym.End: \033[4~
981</p> 1194</p>
982<hr /> 1195<hr />
983<h1><a name="description">DESCRIPTION</a></h1> 1196<h1><a name="description">DESCRIPTION</a></h1>
984<p>The rest of this document describes various technical aspects of 1197<p>The rest of this document describes various technical aspects of
985<strong>rxvt-unicode</strong>. First the description of supported command sequences, 1198<strong>rxvt-unicode</strong>. First the description of supported command sequences,
986followed by menu and pixmap support and last by a description of all 1199followed by pixmap support and last by a description of all features
987features selectable at <code>configure</code> time.</p> 1200selectable at <code>configure</code> time.</p>
988<p> 1201<p>
989</p> 1202</p>
990<hr /> 1203<hr />
991<h1><a name="definitions">Definitions</a></h1> 1204<h1><a name="definitions">Definitions</a></h1>
992<dl> 1205<dl>
1625</table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>&gt; X10 XTerm</a></strong><br /> 1838</table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>&gt; X10 XTerm</a></strong><br />
1626</dt> 1839</dt>
1627<table> 1840<table>
1628<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>
1629<tr><td>l</td><td>No mouse reporting.</td></tr> 1842<tr><td>l</td><td>No mouse reporting.</td></tr>
1630</table><dt><strong><a name="item_10"><strong><code>Ps = 10</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1631</dt>
1632<table>
1633<tr><td>h</td><td>menuBar visible</td></tr>
1634<tr><td>l</td><td>menuBar invisible</td></tr>
1635</table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>&gt;</a></strong><br /> 1843</table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>&gt;</a></strong><br />
1636</dt> 1844</dt>
1637<table> 1845<table>
1638<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr> 1846<tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr>
1639<tr><td>l</td><td>Invisible cursor {civis}</td></tr> 1847<tr><td>l</td><td>Invisible cursor {civis}</td></tr>
1704</table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br /> 1912</table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1705</dt> 1913</dt>
1706<table> 1914<table>
1707<tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr> 1915<tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr>
1708<tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr> 1916<tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr>
1917</table><dt><strong><a name="item_1021"><strong><code>Ps = 1021</code> </strong>&gt; (<strong>rxvt</strong>)</a></strong><br />
1918</dt>
1919<table>
1920<tr><td>h</td><td>Bold/italic implies high intensity (see option -is)</td></tr>
1921<tr><td>l</td><td>Font styles have no effect on intensity (Compile styles)</td></tr>
1709</table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>&gt;</a></strong><br /> 1922</table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>&gt;</a></strong><br />
1710</dt> 1923</dt>
1711<table> 1924<table>
1712<tr><td>h</td><td>Use Alternate Screen Buffer</td></tr> 1925<tr><td>h</td><td>Use Alternate Screen Buffer</td></tr>
1713<tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr> 1926<tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr>
1745<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr> 1958<tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr>
1746<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr> 1959<tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr>
1747<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr> 1960<tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr>
1748<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr> 1961<tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr>
1749<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr> 1962<tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr>
1750<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt</td></tr> 1963<tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr>
1751<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt</td></tr> 1964<tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr>
1752<tr><td>Ps = 20</td><td>Change default background to Pt</td></tr> 1965<tr><td>Ps = 20</td><td>Change background pixmap parameters (see section XPM) (Compile XPM).</td></tr>
1753<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr> 1966<tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr>
1754<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr> 1967<tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr>
1755<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr> 1968<tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr>
1756<tr><td>Ps = 50</td><td>Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n</td></tr> 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>
1757<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>
1758<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>
1759<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>
1760<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>
1761<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>
1762<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>
1763<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>
1764<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>
1765<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>
1766<tr><td>Ps = 720</td><td>Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr> 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>
1767<tr><td>Ps = 721</td><td>Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr> 1982<tr><td>Ps = 721</td><td>Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr>
1983<tr><td>Ps = 777</td><td>Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).</td></tr>
1768</table><p></p></dl> 1984</table><p></p></dl>
1769<p></p> 1985<p></p>
1770<p>
1771</p>
1772<hr />
1773<h1><a name="menubar">menuBar</a></h1>
1774<p><strong>The exact syntax used is <em>almost</em> solidified. </strong>&gt;
1775In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
1776menuBar.</p>
1777<p>Note that in all of the commands, the <strong><em>/path/</em> </strong>&gt; <em>cannot</em> be
1778omitted: use <strong>./</strong> to specify a menu relative to the current menu.</p>
1779<p>
1780</p>
1781<h2><a name="overview_of_menubar_operation">Overview of menuBar operation</a></h2>
1782<p>For the menuBar XTerm escape sequence <code>ESC ] 703 ; Pt ST</code>, the syntax
1783of <a href="#item_pt"><code>Pt</code></a> can be used for a variety of tasks:</p>
1784<p>At the top level is the current menuBar which is a member of a circular
1785linked-list of other such menuBars.</p>
1786<p>The menuBar acts as a parent for the various drop-down menus, which in
1787turn, may have labels, separator lines, menuItems and subMenus.</p>
1788<p>The menuItems are the useful bits: you can use them to mimic keyboard
1789input or even to send text or escape sequences back to rxvt.</p>
1790<p>The menuBar syntax is intended to provide a simple yet robust method of
1791constructing and manipulating menus and navigating through the
1792menuBars.</p>
1793<p>The first step is to use the tag <strong>[menu:<em>name</em>] </strong>&gt; which creates
1794the menuBar called <em>name</em> and allows access. You may now or menus,
1795subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the
1796menuBar access as <strong>readonly</strong> to prevent accidental corruption of the
1797menus. To re-access the current menuBar for alterations, use the tag
1798<strong>[menu]</strong>, make the alterations and then use <strong>[done]</strong></p>
1799<p></p>
1800<p>
1801</p>
1802<h2><a name="commands">Commands</a></h2>
1803<dl>
1804<dt><strong><a name="item__5bmenu_3a_2bname_5d"><strong>[menu:+<em>name</em>] </strong>&gt;</a></strong><br />
1805</dt>
1806<dd>
1807access the named menuBar for creation or alteration. If a new menuBar
1808is created, it is called <em>name</em> (max of 15 chars) and the current
1809menuBar is pushed onto the stack
1810</dd>
1811<p></p>
1812<dt><strong><a name="item__5bmenu_5d"><strong>[menu]</strong></a></strong><br />
1813</dt>
1814<dd>
1815access the current menuBar for alteration
1816</dd>
1817<p></p>
1818<dt><strong><a name="item__5btitle_3a_2bstring_5d"><strong>[title:+<em>string</em>] </strong>&gt;</a></strong><br />
1819</dt>
1820<dd>
1821set the current menuBar's title to <em>string</em>, which may contain the
1822following format specifiers:
1823</dd>
1824<dd>
1825<pre>
1826 B&lt;%n&gt; rxvt name (as per the B&lt;-name&gt; command-line option)
1827 B&lt;%v&gt; rxvt version
1828 B&lt;%%&gt; literal B&lt;%&gt; character</pre>
1829</dd>
1830<p></p>
1831<dt><strong><a name="item__5bdone_5d"><strong>[done]</strong></a></strong><br />
1832</dt>
1833<dd>
1834set menuBar access as <strong>readonly</strong>.
1835End-of-file tag for <strong>[read:+<em>file</em>] </strong>&gt; operations.
1836</dd>
1837<p></p>
1838<dt><strong><a name="item__5bread_3a_2bfile_5d"><strong>[read:+<em>file</em>] </strong>&gt;</a></strong><br />
1839</dt>
1840<dd>
1841read menu commands directly from <em>file</em> (extension ``.menu'' will be
1842appended if required.) Start reading at a line with <strong>[menu]</strong> or <strong>&lt;
1843[menu:+<em>name</em> </strong>&gt; and continuing until <strong>[done]</strong> is encountered.
1844</dd>
1845<dd>
1846<p>Blank and comment lines (starting with <strong>#</strong>) are ignored. Actually,
1847since any invalid menu commands are also ignored, almost anything could
1848be construed as a comment line, but this may be tightened up in the
1849future ... so don't count on it!.</p>
1850</dd>
1851<p></p>
1852<dt><strong><a name="item__5bread_3a_2bfile_3b_2bname_5d"><strong>[read:+<em>file</em>;+<em>name</em>] </strong>&gt;</a></strong><br />
1853</dt>
1854<dd>
1855The same as <strong>[read:+<em>file</em>] </strong>&gt;, but start reading at a line with
1856<strong>[menu:+<em>name</em>] </strong>&gt; and continuing until <strong>[done:+<em>name</em>] </strong>&gt; or
1857<strong>[done]</strong> is encountered.
1858</dd>
1859<p></p>
1860<dt><strong><a name="item__5bdump_5d"><strong>[dump]</strong></a></strong><br />
1861</dt>
1862<dd>
1863dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable for
1864later rereading.
1865</dd>
1866<p></p>
1867<dt><strong><a name="item__5brm_3aname_5d"><strong>[rm:name]</strong></a></strong><br />
1868</dt>
1869<dd>
1870remove the named menuBar
1871</dd>
1872<p></p>
1873<dt><strong><a name="item__5brm_5d__5brm_3a_5d"><strong>[rm] [rm:]</strong></a></strong><br />
1874</dt>
1875<dd>
1876remove the current menuBar
1877</dd>
1878<p></p>
1879<dt><strong><a name="item__5brm_2a_5d__5brm_3a_2a_5d"><strong>[rm*] [rm:*]</strong></a></strong><br />
1880</dt>
1881<dd>
1882remove all menuBars
1883</dd>
1884<p></p>
1885<dt><strong><a name="item__5bswap_5d"><strong>[swap]</strong></a></strong><br />
1886</dt>
1887<dd>
1888swap the top two menuBars
1889</dd>
1890<p></p>
1891<dt><strong><a name="item__5bprev_5d"><strong>[prev]</strong></a></strong><br />
1892</dt>
1893<dd>
1894access the previous menuBar
1895</dd>
1896<p></p>
1897<dt><strong><a name="item__5bnext_5d"><strong>[next]</strong></a></strong><br />
1898</dt>
1899<dd>
1900access the next menuBar
1901</dd>
1902<p></p>
1903<dt><strong><a name="item__5bshow_5d"><strong>[show]</strong></a></strong><br />
1904</dt>
1905<dd>
1906Enable display of the menuBar
1907</dd>
1908<p></p>
1909<dt><strong><a name="item__5bhide_5d"><strong>[hide]</strong></a></strong><br />
1910</dt>
1911<dd>
1912Disable display of the menuBar
1913</dd>
1914<p></p>
1915<dt><strong><a name="item__5bpixmap_3a_2bname_5d"><strong>[pixmap:+<em>name</em>] </strong>&gt;</a></strong><br />
1916</dt>
1917<dt><strong><a name="item__5bpixmap_3a_2bname_3bscaling_5d"><strong>[pixmap:+<em>name</em>;<em>scaling</em>] </strong>&gt;</a></strong><br />
1918</dt>
1919<dd>
1920(set the background pixmap globally
1921</dd>
1922<dd>
1923<p><strong>A Future implementation <em>may</em> make this local to the menubar </strong>&gt;)</p>
1924</dd>
1925<p></p>
1926<dt><strong><a name="item__5b_3a_2bcommand_3a_5d"><strong>[:+<em>command</em>:] </strong>&gt;</a></strong><br />
1927</dt>
1928<dd>
1929ignore the menu readonly status and issue a <em>command</em> to or a menu or
1930menuitem or change the ; a useful shortcut for setting the quick arrows
1931from a menuBar.
1932</dd>
1933<p></p></dl>
1934<p></p>
1935<p>
1936</p>
1937<h2><a name="adding_and_accessing_menus">Adding and accessing menus</a></h2>
1938<p>The following commands may also be <strong>+</strong> prefixed.</p>
1939<dl>
1940<dt><strong><a name="item__2f_2b"><strong>/+</strong></a></strong><br />
1941</dt>
1942<dd>
1943access menuBar top level
1944</dd>
1945<p></p>
1946<dt><strong><a name="item__2e_2f_2b"><strong>./+</strong></a></strong><br />
1947</dt>
1948<dd>
1949access current menu level
1950</dd>
1951<p></p>
1952<dt><strong><a name="item__2e_2e_2f_2b"><strong>../+</strong></a></strong><br />
1953</dt>
1954<dd>
1955access parent menu (1 level up)
1956</dd>
1957<p></p>
1958<dt><strong><a name="item__2e_2e_2f_2e_2e_2f"><strong>../../</strong></a></strong><br />
1959</dt>
1960<dd>
1961access parent menu (multiple levels up)
1962</dd>
1963<p></p>
1964<dt><strong><a name="item__2fpath_2fmenu"><strong><em>/path/</em>menu </strong>&gt;</a></strong><br />
1965</dt>
1966<dd>
1967add/access menu
1968</dd>
1969<p></p>
1970<dt><strong><a name="item__2fpath_2fmenu_2f_2a"><strong><em>/path/</em>menu/* </strong>&gt;</a></strong><br />
1971</dt>
1972<dd>
1973add/access menu and clear it if it exists
1974</dd>
1975<p></p>
1976<dt><strong><a name="item__2fpath_2f_7b_2d_7d"><strong><em>/path/</em>{-} </strong>&gt;</a></strong><br />
1977</dt>
1978<dd>
1979add separator
1980</dd>
1981<p></p>
1982<dt><strong><a name="item__2fpath_2f_7bitem_7d"><strong><em>/path/</em>{item} </strong>&gt;</a></strong><br />
1983</dt>
1984<dd>
1985add <strong>item</strong> as a label
1986</dd>
1987<p></p>
1988<dt><strong><a name="item__2fpath_2f_7bitem_7d_action"><strong><em>/path/</em>{item} action </strong>&gt;</a></strong><br />
1989</dt>
1990<dd>
1991add/alter <em>menuitem</em> with an associated <em>action</em>
1992</dd>
1993<p></p>
1994<dt><strong><a name="item__2fpath_2f_7bitem_7d_7bright_2dtext_7d"><strong><em>/path/</em>{item}{right-text} </strong>&gt;</a></strong><br />
1995</dt>
1996<dd>
1997add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified text
1998and as the associated <em>action</em>
1999</dd>
2000<p></p>
2001<dt><strong><a name="item__2fpath_2f_7bitem_7d_7brtext_7d_action"><strong><em>/path/</em>{item}{rtext} action </strong>&gt;</a></strong><br />
2002</dt>
2003<dd>
2004add/alter <em>menuitem</em> with an associated <em>action</em> and with <strong>rtext</strong> as
2005the right-justified text.
2006</dd>
2007<p></p></dl>
2008<dl>
2009<dt><strong><a name="item_special_characters_in_action_must_be_backslash_2de">Special characters in <em>action</em> must be backslash-escaped:</a></strong><br />
2010</dt>
2011<dd>
2012<strong>\a \b \E \e \n \r \t \octal</strong>
2013</dd>
2014<p></p>
2015<dt><strong><a name="item_or_in_control_2dcharacter_notation_3a">or in control-character notation:</a></strong><br />
2016</dt>
2017<dd>
2018<strong>^@, ^A .. ^Z .. ^_, ^?</strong>
2019</dd>
2020<p></p></dl>
2021<p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the
2022program, start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>),
2023the first of which will be stripped off and the balance directed to the
2024program. Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by
2025non-+<strong>NUL</strong> characters, the leading <strong>NUL</strong> is stripped off and the
2026balance is sent back to rxvt.</p>
2027<p>As a convenience for the many Emacs-type editors, <em>action</em> may start
2028with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
2029appended if missed from <strong>M-x</strong> commands.</p>
2030<p>As a convenience for issuing XTerm <strong>ESC ]</strong> sequences from a menubar (or
2031quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.</p>
2032<dl>
2033<dt><strong><a name="item_for_example_2c">For example,</a></strong><br />
2034</dt>
2035<dd>
2036<strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong>
2037</dd>
2038<p></p>
2039<dt><strong><a name="item_and">and</a></strong><br />
2040</dt>
2041<dd>
2042<strong>\E]703;mona;100</strong> is equivalent to <strong>\E]703;mona;100\a</strong>
2043</dd>
2044<p></p></dl>
2045<p>The option <strong>{<em>right-rtext</em>} </strong>&gt; will be right-justified. In the
2046absence of a specified action, this text will be used as the <em>action</em>
2047as well.</p>
2048<dl>
2049<dt><strong>For example,</strong><br />
2050</dt>
2051<dd>
2052<strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong>
2053</dd>
2054<p></p></dl>
2055<p>The left label <em>is</em> necessary, since it's used for matching, but
2056implicitly hiding the left label (by using same name for both left and
2057right labels), or explicitly hiding the left label (by preceeding it
2058with a dot), makes it possible to have right-justified text only.</p>
2059<dl>
2060<dt><strong>For example,</strong><br />
2061</dt>
2062<dd>
2063<strong>/File/{Open}{Open} Open-File-Action</strong>
2064</dd>
2065<p></p>
2066<dt><strong><a name="item_or_hiding_it">or hiding it</a></strong><br />
2067</dt>
2068<dd>
2069<strong>/File/{.anylabel}{Open} Open-File-Action</strong>
2070</dd>
2071<p></p></dl>
2072<p></p>
2073<p>
2074</p>
2075<h2><a name="removing_menus">Removing menus</a></h2>
2076<dl>
2077<dt><strong><a name="item__2d_2f_2a_2b"><strong>-/*+ </strong>&gt;</a></strong><br />
2078</dt>
2079<dd>
2080remove all menus from the menuBar, the same as <strong>[clear]</strong>
2081</dd>
2082<p></p>
2083<dt><strong><a name="item__2d_2b_2fpathmenu_2b"><strong>-+<em>/path</em>menu+ </strong>&gt;</a></strong><br />
2084</dt>
2085<dd>
2086remove menu
2087</dd>
2088<p></p>
2089<dt><strong><a name="item__2d_2b_2fpath_7bitem_7d_2b"><strong>-+<em>/path</em>{item}+ </strong>&gt;</a></strong><br />
2090</dt>
2091<dd>
2092remove item
2093</dd>
2094<p></p>
2095<dt><strong><a name="item__2d_2b_2fpath_7b_2d_7d"><strong>-+<em>/path</em>{-} </strong>&gt;</a></strong><br />
2096</dt>
2097<dd>
2098remove separator)
2099</dd>
2100<p></p>
2101<dt><strong><a name="item__2d_2fpath_2fmenu_2f_2a"><strong>-/path/menu/*</strong></a></strong><br />
2102</dt>
2103<dd>
2104remove all items, separators and submenus from menu
2105</dd>
2106<p></p></dl>
2107<p></p>
2108<p>
2109</p>
2110<h2><a name="quick_arrows">Quick Arrows</a></h2>
2111<p>The menus also provide a hook for <em>quick arrows</em> to provide easier
2112user access. If nothing has been explicitly set, the default is to
2113emulate the curror keys. The syntax permits each arrow to be altered
2114individually or all four at once without re-entering their common
2115beginning/end text. For example, to explicitly associate cursor actions
2116with the arrows, any of the following forms could be used:</p>
2117<dl>
2118<dt><strong><a name="item__3cr_3e_2bright"><strong>&lt;r</strong>+<em>Right</em> &gt;&gt;</a></strong><br />
2119</dt>
2120<dt><strong><a name="item__3cl_3e_2bleft"><strong>&lt;l</strong>+<em>Left</em> &gt;&gt;</a></strong><br />
2121</dt>
2122<dt><strong><a name="item__3cu_3e_2bup"><strong>&lt;u</strong>+<em>Up</em> &gt;&gt;</a></strong><br />
2123</dt>
2124<dt><strong><a name="item__3cd_3e_2bdown"><strong>&lt;d</strong>+<em>Down</em> &gt;&gt;</a></strong><br />
2125</dt>
2126<dd>
2127Define actions for the respective arrow buttons
2128</dd>
2129<p></p>
2130<dt><strong><a name="item__3cb_3e_2bbegin"><strong>&lt;b</strong>+<em>Begin</em> &gt;&gt;</a></strong><br />
2131</dt>
2132<dt><strong><a name="item__3ce_3e_2bend"><strong>&lt;e</strong>+<em>End</em> &gt;&gt;</a></strong><br />
2133</dt>
2134<dd>
2135Define common beginning/end parts for <em>quick arrows</em> which used in
2136conjunction with the above &lt;r&gt; &lt;l&gt; &lt;u&gt; &lt;d&gt; constructs
2137</dd>
2138<p></p></dl>
2139<dl>
2140<dt><strong><a name="item_for_example_2c_define_arrows_individually_2c">For example, define arrows individually,</a></strong><br />
2141</dt>
2142<dd>
2143<pre>
2144 &lt;u&gt;\E[A</pre>
2145</dd>
2146<dd>
2147<pre>
2148 &lt;d&gt;\E[B</pre>
2149</dd>
2150<dd>
2151<pre>
2152 &lt;r&gt;\E[C</pre>
2153</dd>
2154<dd>
2155<pre>
2156 &lt;l&gt;\E[D</pre>
2157</dd>
2158<dt><strong><a name="item_or_all_at_once">or all at once</a></strong><br />
2159</dt>
2160<dd>
2161<pre>
2162 &lt;u&gt;\E[AZ&lt;&gt;&lt;d&gt;\E[BZ&lt;&gt;&lt;r&gt;\E[CZ&lt;&gt;&lt;l&gt;\E[D</pre>
2163</dd>
2164<dt><strong><a name="item_compactly">or more compactly (factoring out common parts)</a></strong><br />
2165</dt>
2166<dd>
2167<pre>
2168 &lt;b&gt;\E[&lt;u&gt;AZ&lt;&gt;&lt;d&gt;BZ&lt;&gt;&lt;r&gt;CZ&lt;&gt;&lt;l&gt;D</pre>
2169</dd>
2170</dl>
2171<p></p>
2172<p>
2173</p>
2174<h2><a name="command_summary">Command Summary</a></h2>
2175<p>A short summary of the most <em>common</em> commands:</p>
2176<dl>
2177<dt><strong><a name="item__5bmenu_3aname_5d">[menu:name]</a></strong><br />
2178</dt>
2179<dd>
2180use an existing named menuBar or start a new one
2181</dd>
2182<p></p>
2183<dt><strong>[menu]</strong><br />
2184</dt>
2185<dd>
2186use the current menuBar
2187</dd>
2188<p></p>
2189<dt><strong><a name="item__5btitle_3astring_5d">[title:string]</a></strong><br />
2190</dt>
2191<dd>
2192set menuBar title
2193</dd>
2194<p></p>
2195<dt><strong>[done]</strong><br />
2196</dt>
2197<dd>
2198set menu access to readonly and, if reading from a file, signal EOF
2199</dd>
2200<p></p>
2201<dt><strong><a name="item__5bdone_3aname_5d">[done:name]</a></strong><br />
2202</dt>
2203<dd>
2204if reading from a file using [read:file;name] signal EOF
2205</dd>
2206<p></p>
2207<dt><strong>[rm:name]</strong><br />
2208</dt>
2209<dd>
2210remove named <code>menuBar(s)</code>
2211</dd>
2212<p></p>
2213<dt><strong>[rm] [rm:]</strong><br />
2214</dt>
2215<dd>
2216remove current menuBar
2217</dd>
2218<p></p>
2219<dt><strong>[rm*] [rm:*]</strong><br />
2220</dt>
2221<dd>
2222remove all <code>menuBar(s)</code>
2223</dd>
2224<p></p>
2225<dt><strong>[swap]</strong><br />
2226</dt>
2227<dd>
2228swap top two menuBars
2229</dd>
2230<p></p>
2231<dt><strong>[prev]</strong><br />
2232</dt>
2233<dd>
2234access the previous menuBar
2235</dd>
2236<p></p>
2237<dt><strong>[next]</strong><br />
2238</dt>
2239<dd>
2240access the next menuBar
2241</dd>
2242<p></p>
2243<dt><strong>[show]</strong><br />
2244</dt>
2245<dd>
2246map menuBar
2247</dd>
2248<p></p>
2249<dt><strong>[hide]</strong><br />
2250</dt>
2251<dd>
2252unmap menuBar
2253</dd>
2254<p></p>
2255<dt><strong><a name="item__5bpixmap_3bfile_5d">[pixmap;file]</a></strong><br />
2256</dt>
2257<dt><strong><a name="item__5bpixmap_3bfile_3bscaling_5d">[pixmap;file;scaling]</a></strong><br />
2258</dt>
2259<dd>
2260set a background pixmap
2261</dd>
2262<p></p>
2263<dt><strong><a name="item__5bread_3afile_5d">[read:file]</a></strong><br />
2264</dt>
2265<dt><strong><a name="item__5bread_3afile_3bname_5d">[read:file;name]</a></strong><br />
2266</dt>
2267<dd>
2268read in a menu from a file
2269</dd>
2270<p></p>
2271<dt><strong>[dump]</strong><br />
2272</dt>
2273<dd>
2274dump out all menuBars to /tmp/rxvt-PID
2275</dd>
2276<p></p>
2277<dt><strong><a name="item__2f">/</a></strong><br />
2278</dt>
2279<dd>
2280access menuBar top level
2281</dd>
2282<p></p>
2283<dt><strong><a name="item__2e_2f">./</a></strong><br />
2284</dt>
2285<dt><strong><a name="item__2e_2e_2f">../</a></strong><br />
2286</dt>
2287<dt><strong>../../</strong><br />
2288</dt>
2289<dd>
2290access current or parent menu level
2291</dd>
2292<p></p>
2293<dt><strong>/path/menu</strong><br />
2294</dt>
2295<dd>
2296add/access menu
2297</dd>
2298<p></p>
2299<dt><strong>/path/{-}</strong><br />
2300</dt>
2301<dd>
2302add separator
2303</dd>
2304<p></p>
2305<dt><strong>/path/{item}{rtext} action</strong><br />
2306</dt>
2307<dd>
2308add/alter menu item
2309</dd>
2310<p></p>
2311<dt><strong><a name="item__2d_2f_2a">-/*</a></strong><br />
2312</dt>
2313<dd>
2314remove all menus from the menuBar
2315</dd>
2316<p></p>
2317<dt><strong><a name="item__2d_2fpath_2fmenu">-/path/menu</a></strong><br />
2318</dt>
2319<dd>
2320remove menu items, separators and submenus from menu
2321</dd>
2322<p></p>
2323<dt><strong>-/path/menu</strong><br />
2324</dt>
2325<dd>
2326remove menu
2327</dd>
2328<p></p>
2329<dt><strong><a name="item__2d_2fpath_2f_7bitem_7d">-/path/{item}</a></strong><br />
2330</dt>
2331<dd>
2332remove item
2333</dd>
2334<p></p>
2335<dt><strong><a name="item__2d_2fpath_2f_7b_2d_7d">-/path/{-}</a></strong><br />
2336</dt>
2337<dd>
2338remove separator
2339</dd>
2340<p></p>
2341<dt><strong><a name="item__3cb_3ebegin_3cr_3eright_3cl_3eleft_3cu_3eup_3cd_3">&lt;b&gt;Begin&lt;r&gt;Right&lt;l&gt;Left&lt;u&gt;Up&lt;d&gt;Down&lt;e&gt;End</a></strong><br />
2342</dt>
2343<dd>
2344menu quick arrows
2345</dd>
2346<p></p></dl>
2347<p> 1986<p>
2348</p> 1987</p>
2349<hr /> 1988<hr />
2350<h1><a name="xpm">XPM</a></h1> 1989<h1><a name="xpm">XPM</a></h1>
2351<p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>&gt; then value 1990<p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>&gt; then value
2600</dd> 2239</dd>
2601<p></p> 2240<p></p>
2602<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 />
2603</dt> 2242</dt>
2604<dd> 2243<dd>
2244Recommended to stay off unless you really need non-BMP characters.
2245</dd>
2246<dd>
2605Enable direct support for displaying unicode codepoints above 2247<p>Enable direct support for displaying unicode codepoints above
260665535 (the basic multilingual page). This increases storage 224865535 (the basic multilingual page). This increases storage
2607requirements 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
2608support these extra characters, but Xft does. 2250support these extra characters, but Xft does.</p>
2609</dd> 2251</dd>
2610<dd> 2252<dd>
2611<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
2612even without this flag, but the number of such characters is 2254even without this flag, but the number of such characters is
2613limited to a view thousand (shared with combining characters, 2255limited to a view thousand (shared with combining characters,
2623where accents are encoded as seperate unicode characters. This is 2265where accents are encoded as seperate unicode characters. This is
2624done by using precomposited characters when available or creating 2266done by using precomposited characters when available or creating
2625new pseudo-characters when no precomposed form exists. 2267new pseudo-characters when no precomposed form exists.
2626</dd> 2268</dd>
2627<dd> 2269<dd>
2628<p>Without --enable-unicode3, the number of additional precomposed characters 2270<p>Without --enable-unicode3, the number of additional precomposed
2629is rather limited (2048, if this is full, rxvt-unicode will use the 2271characters is somewhat limited (the 6400 private use characters will be
2630private use area, extending the number of combinations to 8448). With
2631--enable-unicode3, no practical limit exists.</p> 2272(ab-)used). With --enable-unicode3, no practical limit exists.</p>
2632</dd> 2273</dd>
2633<dd> 2274<dd>
2634<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
2635beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p> 2276beyond plane 0 (&gt;65535) when --enable-unicode3 was not specified.</p>
2636</dd> 2277</dd>
2641</dd> 2282</dd>
2642<p></p> 2283<p></p>
2643<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 />
2644</dt> 2285</dt>
2645<dd> 2286<dd>
2646When 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.
2647</dd> 2289</dd>
2648<p></p> 2290<p></p>
2649<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 />
2650</dt> 2292</dt>
2651<dd> 2293<dd>
2682Write user and tty to lastlog file (used by programs like 2324Write user and tty to lastlog file (used by programs like
2683<em>lastlogin</em>) at start of rxvt execution. This option requires 2325<em>lastlogin</em>) at start of rxvt execution. This option requires
2684--enable-utmp to also be specified. 2326--enable-utmp to also be specified.
2685</dd> 2327</dd>
2686<p></p> 2328<p></p>
2687<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 />
2688</dt> 2330</dt>
2689<dd> 2331<dd>
2690Add support for XPM background pixmaps. 2332Add support for XPM background pixmaps.
2691</dd> 2333</dd>
2692<p></p> 2334<p></p>
2693<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 />
2694</dt> 2336</dt>
2695<dd> 2337<dd>
2696Add support for inheriting parent backgrounds thus giving a fake 2338Add support for inheriting parent backgrounds thus giving a fake
2697transparency to the term. 2339transparency to the term.
2698</dd> 2340</dd>
2705<p></p> 2347<p></p>
2706<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 />
2707</dt> 2349</dt>
2708<dd> 2350<dd>
2709Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>). 2351Add support for tinting of transparent backgrounds (requires <code>--enable-transparency</code>).
2710</dd>
2711<p></p>
2712<dt><strong><a name="item_menubar">--enable-menubar (default: off)</a></strong><br />
2713</dt>
2714<dd>
2715Add support for our menu bar system (this interacts badly with
2716dynamic locale switching currently).
2717</dd> 2352</dd>
2718<p></p> 2353<p></p>
2719<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 />
2720</dt> 2355</dt>
2721<dd> 2356<dd>
2740Add support for a very unobtrusive, plain-looking scrollbar that 2375Add support for a very unobtrusive, plain-looking scrollbar that
2741is the favourite of the rxvt-unicode author, having used it for 2376is the favourite of the rxvt-unicode author, having used it for
2742many years. 2377many years.
2743</dd> 2378</dd>
2744<p></p> 2379<p></p>
2745<dt><strong><a name="item_shadow">--enable-half-shadow (default: off)</a></strong><br />
2746</dt>
2747<dd>
2748Make shadows on the scrollbar only half the normal width &amp; height.
2749only applicable to rxvt scrollbars.
2750</dd>
2751<p></p>
2752<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 />
2753</dt> 2381</dt>
2754<dd> 2382<dd>
2755Change tty device setting to group ``tty'' - only use this if 2383Change tty device setting to group ``tty'' - only use this if
2756your system uses this type of security. 2384your system uses this type of security.
2771<p></p> 2399<p></p>
2772<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 />
2773</dt> 2401</dt>
2774<dd> 2402<dd>
2775Removes any support for resource checking. 2403Removes any support for resource checking.
2776</dd>
2777<p></p>
2778<dt><strong><a name="item__2d_2denable_2dxgetdefault">--enable-xgetdefault</a></strong><br />
2779</dt>
2780<dd>
2781Make resources checking via <code>XGetDefault()</code> instead of our small
2782version which only checks ~/.Xdefaults, or if that doesn't exist then
2783~/.Xresources.
2784</dd>
2785<dd>
2786<p>Please note that nowadays, things like XIM will automatically pull in and
2787use the full X resource manager, so the overhead of using it might be very
2788small, if nonexistant.</p>
2789</dd>
2790<p></p>
2791<dt><strong><a name="item_strings">--enable-strings (default: off)</a></strong><br />
2792</dt>
2793<dd>
2794Add support for our possibly faster <code>memset()</code> function and other
2795various routines, overriding your system's versions which may
2796have been hand-crafted in assembly or may require extra libraries
2797to link in. (this breaks ANSI-C rules and has problems on many
2798GNU/Linux systems).
2799</dd> 2404</dd>
2800<p></p> 2405<p></p>
2801<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 />
2802</dt> 2407</dt>
2803<dd> 2408<dd>
2817</dd> 2422</dd>
2818<dd> 2423<dd>
2819<pre> 2424<pre>
2820 MWM-hints 2425 MWM-hints
2821 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2822 seperate underline colour 2427 seperate underline colour (-underlineColor)
2823 settable border widths and borderless switch 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual selection (-depth)
2824 settable extra linespacing 2430 settable extra linespacing /-lsp)
2825 iso-14755-2 and -3, and visual feedback 2431 iso-14755-2 and -3, and visual feedback
2826 backindex and forwardindex escape sequence 2432 backindex and forwardindex escape sequence
2827 window op and some xterm/OSC escape sequences 2433 window op and some xterm/OSC escape sequences
2828 tripleclickwords 2434 tripleclickwords (-tcw)
2829 settable insecure mode 2435 settable insecure mode (-insecure)
2830 keysym remapping support 2436 keysym remapping support
2831 cursor blinking and underline cursor 2437 cursor blinking and underline cursor (-cb, -uc)
2832 -embed and -pty-fd options</pre> 2438 XEmbed support (-embed)
2439 user-pty (-pty-fd)
2440 hold on exit (-hold)
2441 skip builtin block graphics (-sbg)
2442 sgr modes 90..97 and 100..107</pre>
2833</dd> 2443</dd>
2834<p></p> 2444<p></p>
2835<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 />
2836</dt> 2446</dt>
2837<dd> 2447<dd>
2838Enable extended ISO 14755 support (see urxvt(1), or 2448Enable extended ISO 14755 support (see rxvt(1), or
2839<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
2840<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
2841this switch. 2451this switch.
2842</dd> 2452</dd>
2843<p></p> 2453<p></p>
2890<p></p> 2500<p></p>
2891<dt><strong><a name="item_resize">--enable-smart-resize (default: on)</a></strong><br /> 2501<dt><strong><a name="item_resize">--enable-smart-resize (default: on)</a></strong><br />
2892</dt> 2502</dt>
2893<dd> 2503<dd>
2894Add smart growth/shrink behaviour when changing font size via hot 2504Add smart growth/shrink behaviour when changing font size via hot
2895keys. This should keep in a fixed position the urxvt corner which is 2505keys. This should keep the window corner which is closest to a corner of
2896closest to a corner of the screen. 2506the screen in a fixed position.
2897</dd> 2507</dd>
2898<p></p> 2508<p></p>
2899<dt><strong><a name="item_blank">--enable-pointer-blank (default: on)</a></strong><br /> 2509<dt><strong><a name="item_blank">--enable-pointer-blank (default: on)</a></strong><br />
2900</dt> 2510</dt>
2901<dd> 2511<dd>
2902Add support to have the pointer disappear when typing or inactive. 2512Add support to have the pointer disappear when typing or inactive.
2513</dd>
2514<p></p>
2515<dt><strong><a name="item_perl">--enable-perl (default: on)</a></strong><br />
2516</dt>
2517<dd>
2518Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
2519manpage (<em>doc/rxvtperl.txt</em>) for more info on this feature, or the files
2520in <em>src/perl-ext/</em> for the extensions that are installed by default. The
2521perl interpreter that is used can be specified via the <code>PERL</code> environment
2522variable when running configure.
2903</dd> 2523</dd>
2904<p></p> 2524<p></p>
2905<dt><strong>--with-name=NAME (default: urxvt)</strong><br /> 2525<dt><strong>--with-name=NAME (default: urxvt)</strong><br />
2906</dt> 2526</dt>
2907<dd> 2527<dd>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines