1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
4 <title>REFERENCE - FAQ, command sequences and other background information</title>
5 <link rev="made" href="mailto:perl-binary@plan9.de" />
8 <body style="background-color: white">
10 <p><a name="__index__"></a></p>
15 <li><a href="#name">NAME</a></li>
16 <li><a href="#frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></li>
17 <li><a href="#synopsis">SYNOPSIS</a></li>
18 <li><a href="#description">DESCRIPTION</a></li>
19 <li><a href="#rxvt_technical_reference">RXVT TECHNICAL REFERENCE</a></li>
20 <li><a href="#definitions">Definitions</a></li>
21 <li><a href="#values">Values</a></li>
22 <li><a href="#escape_sequences">Escape Sequences</a></li>
23 <li><a href="#csi__command_sequence_introducer__sequences">CSI (Command Sequence Introducer) Sequences</a></li>
24 <li><a href="#dec_private_modes">DEC Private Modes</a></li>
25 <li><a href="#xterm_operating_system_commands">XTerm Operating System Commands</a></li>
26 <li><a href="#menubar">menuBar</a></li>
29 <li><a href="#overview_of_menubar_operation">Overview of menuBar operation</a></li>
30 <li><a href="#commands">Commands</a></li>
31 <li><a href="#adding_and_accessing_menus">Adding and accessing menus</a></li>
32 <li><a href="#removing_menus">Removing menus</a></li>
33 <li><a href="#quick_arrows">Quick Arrows</a></li>
34 <li><a href="#command_summary">Command Summary</a></li>
37 <li><a href="#xpm">XPM</a></li>
38 <li><a href="#mouse_reporting">Mouse Reporting</a></li>
39 <li><a href="#key_codes">Key Codes</a></li>
40 <li><a href="#configure_options">CONFIGURE OPTIONS</a></li>
41 <li><a href="#authors">AUTHORS</a></li>
48 <h1><a name="name">NAME</a></h1>
49 <p>RXVT REFERENCE - FAQ, command sequences and other background information</p>
53 <h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
55 <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 />
58 The version number is displayed with the usage (-h). Also the escape
59 sequence <code>ESC[8n</code> sets the window title to the version number.
62 <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 />
65 The terminal description used by rxvt-unicode is not as widely available
66 as that for xterm, or even rxvt (for which the same problem often arises).
69 <p>The correct solution for this problem is to install the terminfo, this can
70 be done like this (with ncurses' infocmp):</p>
74 REMOTE=remotesystem.domain
75 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"</pre>
78 <p>... or by installing rxvt-unicode normally on the remote system,</p>
81 <p>If you cannot or do not want to do this, then you can simply set
82 <code>TERM=rxvt</code> or even <code>TERM=xterm</code>, and live with the small number of
83 problems arising, which includes wrong keymapping, less and different
84 colours and some refresh errors in fullscreen applications. It's a nice
85 quick-and-dirty workaround for rare cases, though.</p>
88 <p>If you always want to do this you can either recompile rxvt-unicode with
89 the desired TERM value or use a resource to set it:</p>
93 URxvt.termName: rxvt</pre>
96 <p>If you don't plan to use <strong>rxvt</strong> (quite common...) you could also replace
97 the rxvt terminfo file with the rxvt-unicode one.</p>
100 <dt><strong><a name="item_i_need_a_termcap_file_entry_2e">I need a termcap file entry.</a></strong><br />
103 You could use rxvt's termcap entry with resonable results in many cases.
104 You can also create a termcap entry by using terminfo's infocmp program
109 infocmp -C rxvt-unicode</pre>
112 <p>OR you could this termcap entry:</p>
116 rxvt-unicode|rxvt-unicode terminal (X Window System):\
117 :am:bw:eo:km:mi:ms:xn:xo:\
119 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
120 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
121 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
122 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
123 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
124 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
125 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
126 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
127 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
128 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
129 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
130 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
131 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
132 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
133 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
137 <dt><strong><a name="item_why_does_ls_no_longer_have_coloured_output_3f">Why does <code>ls</code> no longer have coloured output?</a></strong><br />
140 The <code>ls</code> in the GNU coreutils unfortunately doesn't use terminfo to
141 decide wether a terminal has colour, but uses it's own configuration
142 file. Needless to say, <code>rxvt-unicode</code> is not in it's default file (among
143 with most other terminals supporting colour). Either add:
147 TERM rxvt-unicode</pre>
150 <p>to <code>/etc/DIR_COLORS</code> or simply add:</p>
154 alias ls='ls --color=auto'</pre>
157 <p>to your <code>.profile</code> or <code>.bashrc</code>.</p>
160 <dt><strong><a name="item_why_doesn_27t_vim_2femacs_etc_2e_use_the_88_colour">Why doesn't vim/emacs etc. use the 88 colour mode?</a></strong><br />
162 <dt><strong><a name="item_why_doesn_27t_vim_2femacs_etc_2e_make_use_of_itali">Why doesn't vim/emacs etc. make use of italic?</a></strong><br />
164 <dt><strong><a name="item_why_are_the_secondary_screen_2drelated_options_not">Why are the secondary screen-related options not working properly?</a></strong><br />
167 Make sure you are using <code>TERM=rxvt-unicode</code>. Some pre-packaged
168 distributions (most notably Debian GNU/Linux) break rxvt-unicode
169 by setting <code>TERM</code> to <code>rxvt</code>, which doesn't have these extra
170 features. Unfortunately, some of these (most notably, again, Debian
171 GNU/Linux) furthermore fail to even install the <code>rxvt-unicode</code> terminfo
172 file, so you will need to install it on your own (See the question <strong>When
173 I log-in to another system it tells me about missing terminfo data?</strong> on
177 <dt><strong><a name="item_rxvt_2dunicode_does_not_seem_to_understand_the_sel">Rxvt-unicode does not seem to understand the selected encoding?</a></strong><br />
179 <dt><strong><a name="item_unicode_does_not_seem_to_work_3f">Unicode does not seem to work?</a></strong><br />
182 If you encounter strange problems like typing an accented character but
183 getting two unrelated other characters or similar, or if program output is
184 subtly garbled, then you should check your locale settings.
187 <p>Rxvt-unicode must be started with the same <code>LC_CTYPE</code> setting as the
188 programs. Often rxvt-unicode is started in the <a href="#item_c"><code>C</code></a> locale, while the
189 login script running within the rxvt-unicode window changes the locale to
190 sth. else, e.h. <code>en_GB.UTF-8</code>. Needless to say, this is not going to work.</p>
193 <p>The best thing is to fix your startup environment, as you will likely run
194 into other problems. If nothing works you can try this in your .profile.</p>
198 printf '\e]701;%s\007' "$LC_CTYPE"</pre>
201 <p>If this doesn't work, then maybe you use a <code>LC_CTYPE</code> specification not
202 supported on your systems. Some systems have a <code>locale</code> command which
203 displays this. If it displays sth. like:</p>
207 locale: Cannot set LC_CTYPE to default locale: ...</pre>
210 <p>Then the locale you specified is not supported on your system.</p>
213 <p>If nothing works and you are sure that everything is set correctly then
214 you will need to remember a little known fact: Some programs just don't
215 support locales :(</p>
218 <dt><strong><a name="item_why_do_some_characters_look_so_much_different_than">Why do some characters look so much different than others?</a></strong><br />
220 <dt><strong><a name="item_how_does_rxvt_2dunicode_choose_fonts_3f">How does rxvt-unicode choose fonts?</a></strong><br />
223 Most fonts do not contain the full range of Unicode, which is
224 fine. Chances are that the font you (or the admin/package maintainer of
225 your system/os) have specified does not cover all the characters you want
229 <p><strong>rxvt-unicode</strong> makes a best-effort try at finding a replacement
230 font. Often the result is fine, but sometimes the chosen font looks
231 bad. Many fonts have totally strange characters that don't resemble the
232 correct glyph at all, and rxvt-unicode lacks the artificial intelligence
233 to detect that a specific glyph is wrong: it has to believe the font that
234 the characters it contains indeed look correct.</p>
237 <p>In that case, select a font of your taste and add it to the font list,
242 rxvt -fn basefont,font2,font3...</pre>
245 <p>When rxvt-unicode sees a character, it will first look at the base
246 font. If the base font does not contain the character, it will go to the
247 next font, and so on. Specifying your own fonts will also speed up this
248 search and use less resources within rxvt-unicode and the X-server.</p>
251 <p>The only limitation is that all the fonts must not be larger than the base
252 font, as the base font defines the principal cell size, which must be the
253 same due to the way terminals work.</p>
256 <dt><strong><a name="item_why_do_some_chinese_characters_look_so_different_t">Why do some chinese characters look so different than others?</a></strong><br />
259 This is because there is a difference between script and language --
260 rxvt-unicode does not know which language the text that is output
261 is, as it only knows the unicode character codes. If rxvt-unicode
262 first sees a japanese character, it might choose a japanese font for
263 it. Subsequent japanese characters will take that font. Now, many chinese
264 characters aren't represented in japanese fonts, so when the first
265 non-japanese character comes up, rxvt-unicode will look for a chinese font
266 -- unfortunately at this point, it will still use the japanese font for
267 japanese characters that are also chinese.
270 <p>The workaround is easy: just tag a chinese font at the end of your font
271 list (see the previous question). The key is to view the font list as
272 a preference list: If you expect more japanese, list a japanese font
273 first. If you expect more chinese, put a chinese font first.</p>
276 <p>In the future it might be possible to switch preferences at runtime (the
277 internal data structure has no problem with using different fonts for
278 the same character at the same time, but no interface for this has been
282 <dt><strong><a name="item_why_does_rxvt_2dunicode_sometimes_leave_pixel_drop">Why does rxvt-unicode sometimes leave pixel droppings?</a></strong><br />
285 Most fonts were not designed for terminal use, which means that character
286 size varies a lot. A font that is otherwise fine for terminal use might
287 contain some characters that are simply too wide. Rxvt-unicode will avoid
288 these characters. For characters that are just ``a bit'' too wide a special
289 ``careful'' rendering mode is used that redraws adjacent characters.
292 <p>All of this requires that fonts do not lie about character sizes,
293 however: Xft fonts often draw glyphs larger than their acclaimed bounding
294 box, and rxvt-unicode has no way of detecting this (the correct way is to
295 ask for the character bounding box, which unfortunately is wrong in these
299 <p>It's not clear (to me at least), wether this is a bug in Xft, freetype,
300 or the respective font. If you encounter this problem you might try using
301 the <code>-lsp</code> option to give the font more height. If that doesn't work, you
302 might be forced to use a different font.</p>
305 <p>All of this is not a problem when using X11 core fonts, as their bounding
306 box data is correct.</p>
309 <dt><strong><a name="item_compose">My Compose (Multi_key) key is no longer working.</a></strong><br />
312 The most common causes for this are that either your locale is not set
313 correctly, or you specified a <strong>preeditStyle</strong> that is not supported by
314 your input method. For example, if you specified <strong>OverTheSpot</strong> and
315 your input method (e.g. the default input method handling Compose keys)
316 does not support this (for instance because it is not visual), then
317 rxvt-unicode will continue without an input method.
320 <p>In this case either do not specify a <strong>preeditStyle</strong> or specify more than
321 one pre-edit style, such as <strong>OverTheSpot,Root,None</strong>.</p>
324 <dt><strong><a name="item_i_cannot_type_ctrl_2dshift_2d2_to_get_an_ascii_nul">I cannot type <code>Ctrl-Shift-2</code> to get an ASCII NUL character due to ISO 14755</a></strong><br />
327 Either try <code>Ctrl-2</code> alone (it often is mapped to ASCII NUL even on
328 international keyboards) or simply use ISO 14755 support to your
329 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
330 codes, too, such as <code>Ctrl-Shift-1-d</code> to type the default telnet escape
334 <dt><strong><a name="item_how_can_i_keep_rxvt_2dunicode_from_using_reverse_v">How can I keep rxvt-unicode from using reverse video so much?</a></strong><br />
337 First of all, make sure you are running with the right terminfo
338 (<code>urxvt</code>), which will get rid of most of these effects. Then make sure
339 you have specified colours for italic and bold, as otherwise rxvt-unicode
340 might use reverse video to simulate the effect:
345 URxvt*colorIT: green</pre>
348 <dt><strong><a name="item_colours">Some programs assume totally weird colours (red instead of blue), how can I fix that?</a></strong><br />
351 For some unexplainable reason, some programs (i.e. irssi) assume a very
352 weird colour palette when confronted with a terminal with more than the
353 standard 8 colours (rxvt-unicode supports 88). The right fix is, of
354 course, to fix these programs not to assume non-ISO colours without very
358 <p>In the meantime, you can either edit your <code>urxvt</code> terminfo definition to
359 only claim 8 colour support or use <code>TERM=rxvt</code>, which will fix colours
360 but keep you from using other rxvt-unicode features.</p>
363 <dt><strong><a name="item_i_am_on_freebsd_and_rxvt_2dunicode_does_not_seem_t">I am on FreeBSD and rxvt-unicode does not seem to work at all.</a></strong><br />
366 Rxvt-unicode requires the symbol <code>__STDC_ISO_10646__</code> to be defined
367 in your compile environment, or an implementation that implements it,
368 wether it defines the symbol or not. <code>__STDC_ISO_10646__</code> requires that
369 <strong>wchar_t</strong> is represented as unicode.
372 <p>As you might have guessed, FreeBSD does neither define this symobl nor
373 does it support it. Instead, it uses it's own internal representation of
374 <strong>wchar_t</strong>. This is, of course, completely legal.</p>
377 <p>However, <code>__STDC_ISO_10646__</code> is the only sane way to support
378 multi-language apps in an OS, as using a locale-dependent (and
379 non-standardized) representation of <strong>wchar_t</strong> makes it impossible to
380 convert between <strong>wchar_t</strong> (as used by X11 and your applications) and any
381 other encoding without implementing OS-specific-wrappers for each and
382 every locale. There simply are no APIs to convert <strong>wchar_t</strong> into anything
383 except the current locale encoding.</p>
386 <p>Some applications (such as the formidable <strong>mlterm</strong>) work around this
387 by carrying their own replacement functions for character set handling
388 with them, and either implementing OS-dependent hacks or doing multiple
389 conversions (which is slow and unreliable in case the OS implements
390 encodings slightly different than the terminal emulator).</p>
393 <p>The rxvt-unicode author insists that the right way to fix this is in the
394 system libraries once and for all, instead of forcing every app to carry
395 complete replacements.</p>
398 <dt><strong><a name="item_how_does_rxvt_2dunicode_determine_the_encoding_to_">How does rxvt-unicode determine the encoding to use?</a></strong><br />
400 <dt><strong><a name="item_is_there_an_option_to_switch_encodings_3f">Is there an option to switch encodings?</a></strong><br />
403 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
404 specific ``utf-8'' mode, such as xterm. In fact, it doesn't even know about
405 UTF-8 or any other encodings with respect to terminal I/O.
408 <p>The reasons is that there exists a perfectly fine mechanism for selecting
409 the encoding, doing I/O and (most important) communicating this to all
410 applications so everybody agrees on character properties such as width and
411 code number. This mechanism is the <em>locale</em>.</p>
414 <p>Rxvt-unicode uses the <code>LC_CTYPE</code> locale category to select encoding. All
415 programs doing the same (that is, most) will automatically agree in the
416 interpretation of characters.</p>
419 <p>Unfortunately, there is no system-independent way to select locales, nor
420 is there a standard on how locale specifiers will look like.</p>
423 <p>On most systems, the content of the <code>LC_CTYPE</code> environment variable
424 contains an arbitrary string which corresponds to an already-installed
425 locale. Common names for locales are <code>en_US.UTF-8</code>, <code>de_DE.ISO-8859-15</code>,
426 <code>ja_JP.EUC-JP</code>, i.e. <code>language_country.encoding</code>, but other forms
427 (i.e. <code>de</code> or <code>german</code>) are also common.</p>
430 <p>Rxvt-unicode ignores all other locale categories, and except for
431 the encoding, ignores country or language-specific settings,
432 i.e. <code>de_DE.UTF-8</code> and <code>ja_JP.UTF-8</code> are the same for rxvt-unicode.</p>
435 <p>If you want to use a specific encoding you have to make sure you start
436 rxvt-unicode with the correct <code>LC_CTYPE</code> category.</p>
439 <dt><strong><a name="item_can_i_switch_locales_at_runtime_3f">Can I switch locales at runtime?</a></strong><br />
442 Yes, using an escape sequence. Try sth. like this, which sets
443 rxvt-unicode's idea of <code>LC_CTYPE</code>.
447 printf '\e]701;%s\007' ja_JP.SJIS</pre>
450 <p>See also the previous question.</p>
453 <p>Sometimes this capability is rather handy when you want to work in one
454 locale (e.g. <code>de_DE.UTF-8</code>) but some programs don't support UTF-8. For
455 example, I use this script to start <code>xjdic</code>, which first switches to a
456 locale supported by xjdic and back later:</p>
460 printf '\e]701;%s\007' ja_JP.SJIS
462 printf '\e]701;%s\007' de_DE.UTF-8</pre>
465 <dt><strong><a name="item_can_i_switch_the_fonts_at_runtime_3f">Can I switch the fonts at runtime?</a></strong><br />
468 Yes, using an escape sequence. Try sth. like this, which has the same
469 effect as using the <code>-fn</code> switch, and takes effect immediately:
473 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"</pre>
476 <p>This is useful if you e.g. work primarily with japanese (and prefer a
477 japanese font), but you have to switch to chinese temporarily, where
478 japanese fonts would only be in your way.</p>
481 <p>You can think of this as a kind of manual ISO-2022 switching.</p>
484 <dt><strong><a name="item_why_do_italic_characters_look_as_if_clipped_3f">Why do italic characters look as if clipped?</a></strong><br />
487 Many fonts have difficulties with italic characters and hinting. For
488 example, the otherwise very nicely hinted font <code>xft:Bitstream Vera Sans
489 Mono</code> completely fails in it's italic face. A workaround is to enable
490 freetype autohinting, i.e. like this:
494 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
495 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true</pre>
498 <dt><strong><a name="item_my_input_method_wants__3csome_encoding_3e_but_i_wa">My input method wants <some encoding> but I want UTF-8, what can I do?</a></strong><br />
501 You can specify separate locales for the input method and the rest of the
502 terminal, using the resource <code>imlocale</code>:
506 URxvt*imlocale: ja_JP.EUC-JP</pre>
509 <p>Now you can start your terminal with <code>LC_CTYPE=ja_JP.UTF-8</code> and still
510 use your input method. Please note, however, that you will not be able to
511 input characters outside <code>EUC-JP</code> in a normal way then, as your input
512 method limits you.</p>
515 <dt><strong><a name="item_rxvt_2dunicode_uses_gobs_of_memory_2c_how_can_i_re">Rxvt-unicode uses gobs of memory, how can I reduce that?</a></strong><br />
518 Rxvt-unicode tries to obey the rule of not charging you for sth. you
519 don't use. One thing you should try is to configure out all settings that
520 you don't need, for example, Xft support is a resource hog by design,
521 when used. Compiling it out ensures that no Xft font will be loaded
522 accidentally when rxvt-unicode tries to find a font for your characters.
525 <p>Also, many people (me included) like large windows and even larger
526 scrollback buffers: Without <a href="#item__2d_2denable_2dunicode3"><code>--enable-unicode3</code></a>, rxvt-unicode will use
527 6 bytes per screen cell. For a 160x?? window this amounts to almost a
528 kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
529 use 10 Megabytes of memory. With <a href="#item__2d_2denable_2dunicode3"><code>--enable-unicode3</code></a> it gets worse, as
530 rxvt-unicode then uses 8 bytes per screen cell.</p>
533 <dt><strong><a name="item_can_i_speed_up_xft_rendering_somehow_3f">Can I speed up Xft rendering somehow?</a></strong><br />
536 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
537 it is simply slow. If you still want Xft fonts you might try to disable
538 antialiasing (by appending <code>:antialiasing=false</code>), which saves lots of
539 memory and also speeds up rendering considerably.
542 <dt><strong><a name="item_rxvt_2dunicode_doesn_27t_seem_to_anti_2dalias_its_">Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?</a></strong><br />
545 Rxvt-unicode will use whatever you specify as a font. If it needs to
546 fall back to it's default font search list it will prefer X11 core
547 fonts, because they are small and fast, and then use Xft fonts. It has
548 antialiasing disabled for most of them, because the author thinks they
552 <p>If you want antialiasing, you have to specify the fonts manually.</p>
555 <dt><strong><a name="item_mouse_cut_2fpaste_suddenly_no_longer_works_2e">Mouse cut/paste suddenly no longer works.</a></strong><br />
558 Make sure that mouse reporting is actually turned off since killing
559 some editors prematurely may leave the mouse in mouse report mode. I've
560 heard that tcsh may use mouse reporting unless it otherwise specified. A
561 quick check is to see if cut/paste works when the Alt or Shift keys are
562 depressed. See <code>rxvt(7)</code>
565 <dt><strong><a name="item_what_27s_with_this_bold_2fblink_stuff_3f">What's with this bold/blink stuff?</a></strong><br />
568 If no bold colour is set via <code>colorBD:</code>, bold will invert text using the
569 standard foreground colour.
572 <p>For the standard background colour, blinking will actually make the
573 text blink when compiled with <code>--enable-blinking</code>. with standard
574 colours. Without <code>--enable-blinking</code>, the blink attribute will be
578 <p>On ANSI colours, bold/blink attributes are used to set high-intensity
579 foreground/background colors.</p>
582 <p>color0-7 are the low-intensity colors.</p>
585 <p>color8-15 are the corresponding high-intensity colors.</p>
588 <dt><strong><a name="item_i_don_27t_like_the_screen_colors_2e_how_do_i_chang">I don't like the screen colors. How do I change them?</a></strong><br />
591 You can change the screen colors at run-time using <em>~/.Xdefaults</em>
592 resources (or as long-options).
595 <p>Here are values that are supposed to resemble a VGA screen,
596 including the murky brown that passes for low-intensity yellow:</p>
600 URxvt*color0: #000000
601 URxvt*color1: #A80000
602 URxvt*color2: #00A800
603 URxvt*color3: #A8A800
604 URxvt*color4: #0000A8
605 URxvt*color5: #A800A8
606 URxvt*color6: #00A8A8
607 URxvt*color7: #A8A8A8</pre>
611 URxvt*color8: #000054
612 URxvt*color9: #FF0054
613 URxvt*color10: #00FF54
614 URxvt*color11: #FFFF54
615 URxvt*color12: #0000FF
616 URxvt*color13: #FF00FF
617 URxvt*color14: #00FFFF
618 URxvt*color15: #FFFFFF</pre>
621 <p>And here is a more complete set of non-standard colors described as
622 ``pretty girly'':</p>
626 URxvt.cursorColor: #dc74d1
627 URxvt.pointerColor: #dc74d1
628 URxvt.background: #0e0e0e
629 URxvt.foreground: #4ad5e1
630 URxvt.color0: #000000
631 URxvt.color8: #8b8f93
632 URxvt.color1: #dc74d1
633 URxvt.color9: #dc74d1
634 URxvt.color2: #0eb8c7
635 URxvt.color10: #0eb8c7
636 URxvt.color3: #dfe37e
637 URxvt.color11: #dfe37e
638 URxvt.color5: #9e88f0
639 URxvt.color13: #9e88f0
640 URxvt.color6: #73f7ff
641 URxvt.color14: #73f7ff
642 URxvt.color7: #e1dddd
643 URxvt.color15: #e1dddd</pre>
646 <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 />
649 Assuming that the physical Backspace key corresponds to the
650 BackSpace keysym (not likely for Linux ... see the following
651 question) there are two standard values that can be used for
652 Backspace: <code>^H</code> and <code>^?</code>.
655 <p>Historically, either value is correct, but rxvt-unicode adopts the debian
656 policy of using <code>^?</code> when unsure, because it's the one only only correct
660 <p>Rxvt-unicode tries to inherit the current stty settings and uses the value
661 of `erase' to guess the value for backspace. If rxvt-unicode wasn't
662 started from a terminal (say, from a menu or by remote shell), then the
663 system value of `erase', which corresponds to CERASE in <termios.h>, will
664 be used (which may not be the same as your stty setting).</p>
667 <p>For starting a new rxvt-unicode:</p>
682 <p>Toggle with ``ESC[36h'' / ``ESC[36l'' as documented in rxvt(7).</p>
685 <p>For an existing rxvt-unicode:</p>
691 $ echo -n "^[[36h"</pre>
697 $ echo -n "^[[36l"</pre>
700 <p>This helps satisfy some of the Backspace discrepancies that occur, but
701 if you use Backspace = <code>^H</code>, make sure that the termcap/terminfo value
702 properly reflects that.</p>
705 <p>The Delete key is a another casualty of the ill-defined Backspace problem.
706 To avoid confusion between the Backspace and Delete keys, the Delete
707 key has been assigned an escape sequence to match the vt100 for Execute
708 (ESC[3~) and is in the supplied termcap/terminfo.</p>
711 <p>Some other Backspace problems:</p>
714 <p>some editors use termcap/terminfo,
715 some editors (vim I'm told) expect Backspace = ^H,
716 GNU Emacs (and Emacs-like editors) use ^H for help.</p>
719 <p>Perhaps someday this will all be resolved in a consistent manner.</p>
722 <dt><strong><a name="item_i_don_27t_like_the_key_2dbindings_2e_how_do_i_chan">I don't like the key-bindings. How do I change them?</a></strong><br />
725 There are some compile-time selections available via configure. Unless
726 you have run ``configure'' with the <a href="#item__2d_2ddisable_2dresources"><code>--disable-resources</code></a> option you can
727 use the `keysym' resource to alter the keystrings associated with keysyms.
730 <p>Here's an example for a URxvt session started using `rxvt -name URxvt'</p>
734 URxvt*keysym.Home: \e[1~
735 URxvt*keysym.End: \e[4~
736 URxvt*keysym.C-apostrophe: \e<C-'>
737 URxvt*keysym.C-slash: \e<C-/>
738 URxvt*keysym.C-semicolon: \e<C-;>
739 URxvt*keysym.C-grave: \e<C-`>
740 URxvt*keysym.C-comma: \e<C-,>
741 URxvt*keysym.C-period: \e<C-.>
742 URxvt*keysym.C-0x60: \e<C-`>
743 URxvt*keysym.C-Tab: \e<C-Tab>
744 URxvt*keysym.C-Return: \e<C-Return>
745 URxvt*keysym.S-Return: \e<S-Return>
746 URxvt*keysym.S-space: \e<S-Space>
747 URxvt*keysym.M-Up: \e<M-Up>
748 URxvt*keysym.M-Down: \e<M-Down>
749 URxvt*keysym.M-Left: \e<M-Left>
750 URxvt*keysym.M-Right: \e<M-Right>
751 URxvt*keysym.M-C-0: list.0123456789.\e<M-C-.>
752 URxvt*keysym.M-C-a: list.abcdefghijklmnopqrstuvwxyz.\033<M-C-.>
753 URxvt*keysym.F12: proto:\033]701;zh_CN.GBK\007</pre>
756 <dt><strong><a name="item_i_27m_using_keyboard_model_xxx_that_has_extra_prio">I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
757 How do I make use of them? For example, the Sun Keyboard type 4
758 has the following mappings that rxvt-unicode doesn't recognize.</a></strong><br />
770 <p>Rather than have rxvt-unicode try to accommodate all the various possible keyboard
771 mappings, it is better to use `xmodmap' to remap the keys as required for
772 your particular machine.</p>
774 <dt><strong><a name="item_how_do_i_distinguish_if_i_27m_running_rxvt_2dunico">How do I distinguish if I'm running rxvt-unicode or a regular xterm?
775 I need this to decide about setting colors etc.</a></strong><br />
778 rxvt and rxvt-unicode always export the variable ``COLORTERM'', so you can
779 check and see if that is set. Note that several programs, JED, slrn,
780 Midnight Commander automatically check this variable to decide whether or
784 <dt><strong><a name="item_how_do_i_set_the_correct_2c_full_ip_address_for_th">How do I set the correct, full IP address for the DISPLAY variable?</a></strong><br />
787 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
788 insecure mode then it is possible to use the following shell script
789 snippets to correctly set the display. If your version of rxvt-unicode
790 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
791 the COLORTERM variable can be used to distinguish rxvt-unicode from a
795 <p>Courtesy of Chuck Blake <<a href="mailto:cblake@BBN.COM">cblake@BBN.COM</a>> with the following shell script
800 # Bourne/Korn/POSIX family of shells:
801 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
802 if [ ${TERM:-foo} = xterm ]; then
803 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
807 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
808 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
809 read DISPLAY # set it in our local shell
814 <dt><strong><a name="item_how_do_i_compile_the_manual_pages_for_myself_3f">How do I compile the manual pages for myself?</a></strong><br />
817 You need to have a recent version of perl installed as <em>/usr/bin/perl</em>,
818 one that comes with <em>pod2man</em>, <em>pod2text</em> and <em>pod2html</em>. Then go to
819 the doc subdirectory and enter <code>make alldoc</code>.
822 <dt><strong><a name="item_my_question_isn_27t_answered_here_2c_can_i_ask_a_h">My question isn't answered here, can I ask a human?</a></strong><br />
825 Before sending me mail, you could go to IRC: <code>irc.freenode.net</code>,
826 channel <code>#rxvt-unicode</code> has some rxvt-unicode enthusiasts that might be
827 interested in learning about new and exciting problems (but not FAQs :).
833 <h1><a name="synopsis">SYNOPSIS</a></h1>
836 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"</pre>
838 # change the locale and tell rxvt-unicode about it
839 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"</pre>
842 printf '\33]2;%s\007' "new window title"</pre>
846 <h1><a name="description">DESCRIPTION</a></h1>
847 <p>The rest of this document describes various technical aspects of
848 <strong>rxvt-unicode</strong>. First the description of supported command sequences,
849 followed by menu and pixmap support and last by a description of all
850 features selectable at <code>configure</code> time.</p>
854 <h1><a name="rxvt_technical_reference">RXVT TECHNICAL REFERENCE</a></h1>
858 <h1><a name="definitions">Definitions</a></h1>
860 <dt><strong><a name="item_c"><strong><code>c</code> </strong>></a></strong><br />
863 The literal character c.
866 <dt><strong><a name="item_c"><strong><code>C</code> </strong>></a></strong><br />
869 A single (required) character.
872 <dt><strong><a name="item_ps"><strong><code>Ps</code> </strong>></a></strong><br />
875 A single (usually optional) numeric parameter, composed of one or more
879 <dt><strong><a name="item_pm"><strong><code>Pm</code> </strong>></a></strong><br />
882 A multiple numeric parameter composed of any number of single numeric
883 parameters, separated by <code>;</code> character(s).
886 <dt><strong><a name="item_pt"><strong><code>Pt</code> </strong>></a></strong><br />
889 A text parameter composed of printable characters.
895 <h1><a name="values">Values</a></h1>
897 <dt><strong><a name="item_enq"><strong><code>ENQ</code> </strong>></a></strong><br />
900 Enquiry (Ctrl-E) = Send Device Attributes (DA)
901 request attributes from terminal. See <strong><a href="#item_esc__5b_ps_c"><code>ESC [ Ps c</code></a> </strong>>.
904 <dt><strong><a name="item_bel"><strong><code>BEL</code> </strong>></a></strong><br />
910 <dt><strong><a name="item_bs"><strong><code>BS</code> </strong>></a></strong><br />
916 <dt><strong><a name="item_tab"><strong><code>TAB</code> </strong>></a></strong><br />
919 Horizontal Tab (HT) (Ctrl-I)
922 <dt><strong><a name="item_lf"><strong><code>LF</code> </strong>></a></strong><br />
925 Line Feed or New Line (NL) (Ctrl-J)
928 <dt><strong><a name="item_vt"><strong><code>VT</code> </strong>></a></strong><br />
931 Vertical Tab (Ctrl-K) same as <strong><a href="#item_lf"><code>LF</code></a> </strong>>
934 <dt><strong><a name="item_ff"><strong><code>FF</code> </strong>></a></strong><br />
937 Form Feed or New Page (NP) (Ctrl-L) same as <strong><a href="#item_lf"><code>LF</code></a> </strong>>
940 <dt><strong><a name="item_cr"><strong><code>CR</code> </strong>></a></strong><br />
943 Carriage Return (Ctrl-M)
946 <dt><strong><a name="item_so"><strong><code>SO</code> </strong>></a></strong><br />
949 Shift Out (Ctrl-N), invokes the G1 character set.
950 Switch to Alternate Character Set
953 <dt><strong><a name="item_si"><strong><code>SI</code> </strong>></a></strong><br />
956 Shift In (Ctrl-O), invokes the G0 character set (the default).
957 Switch to Standard Character Set
960 <dt><strong><a name="item_spc"><strong><code>SPC</code> </strong>></a></strong><br />
969 <h1><a name="escape_sequences">Escape Sequences</a></h1>
971 <dt><strong><a name="item_esc__23_8"><strong><code>ESC # 8</code> </strong>></a></strong><br />
974 DEC Screen Alignment Test (DECALN)
977 <dt><strong><a name="item_esc_7"><strong><code>ESC 7</code> </strong>></a></strong><br />
983 <dt><strong><a name="item_esc_8"><strong><code>ESC 8</code> </strong>></a></strong><br />
989 <dt><strong><a name="item_esc__3d"><strong><code>ESC =</code> </strong>></a></strong><br />
992 Application Keypad (SMKX). See also next sequence.
995 <dt><strong><a name="item_esc"><strong><code>ESC</code> </strong>>></a></strong><br />
1001 <p><strong>Note:</strong> If the numeric keypad is activated, eg, <strong>Num_Lock</strong> has been
1002 pressed, numbers or control functions are generated by the numeric keypad
1003 (see Key Codes).</p>
1006 <dt><strong><a name="item_esc_d"><strong><code>ESC D</code> </strong>></a></strong><br />
1012 <dt><strong><a name="item_esc_e"><strong><code>ESC E</code> </strong>></a></strong><br />
1018 <dt><strong><a name="item_esc_h"><strong><code>ESC H</code> </strong>></a></strong><br />
1024 <dt><strong><a name="item_esc_m"><strong><code>ESC M</code> </strong>></a></strong><br />
1030 <dt><strong><a name="item_esc_n"><strong><code>ESC N</code> </strong>></a></strong><br />
1033 Single Shift Select of G2 Character Set (SS2): affects next character
1034 only <em>unimplemented</em>
1037 <dt><strong><a name="item_esc_o"><strong><code>ESC O</code> </strong>></a></strong><br />
1040 Single Shift Select of G3 Character Set (SS3): affects next character
1041 only <em>unimplemented</em>
1044 <dt><strong><a name="item_esc_z"><strong><code>ESC Z</code> </strong>></a></strong><br />
1047 Obsolete form of returns: <strong><code>ESC[?1;2C</code> </strong>> <em>rxvt-unicode compile-time option</em>
1050 <dt><strong><a name="item_esc_c"><strong><code>ESC c</code> </strong>></a></strong><br />
1056 <dt><strong><a name="item_esc_n"><strong><code>ESC n</code> </strong>></a></strong><br />
1059 Invoke the G2 Character Set (LS2)
1062 <dt><strong><a name="item_esc_o"><strong><code>ESC o</code> </strong>></a></strong><br />
1065 Invoke the G3 Character Set (LS3)
1068 <dt><strong><strong><code>ESC</code> ( C</strong> >></strong><br />
1071 Designate G0 Character Set (ISO 2022), see below for values of <a href="#item_c"><code>C</code></a>.
1074 <dt><strong><a name="item_esc__29_c_3e"><strong><a href="#item_esc"><code>ESC</code></a> ) C</strong> >></a></strong><br />
1077 Designate G1 Character Set (ISO 2022), see below for values of <a href="#item_c"><code>C</code></a>.
1080 <dt><strong><a name="item_esc__2a_c"><strong><code>ESC * C</code> </strong>></a></strong><br />
1083 Designate G2 Character Set (ISO 2022), see below for values of <a href="#item_c"><code>C</code></a>.
1086 <dt><strong><a name="item_esc__2b_c"><strong><code>ESC + C</code> </strong>></a></strong><br />
1089 Designate G3 Character Set (ISO 2022), see below for values of <a href="#item_c"><code>C</code></a>.
1092 <dt><strong><a name="item_esc__24_c"><strong><code>ESC $ C</code> </strong>></a></strong><br />
1095 Designate Kanji Character Set
1098 <p>Where <strong><a href="#item_c"><code>C</code></a> </strong>> is one of:</p>
1101 <tr><td>C = 0 </td><td>DEC Special Character and Line Drawing Set</td></tr>
1102 <tr><td>C = A </td><td>United Kingdom (UK)</td></tr>
1103 <tr><td>C = B </td><td>United States (USASCII)</td></tr>
1104 <tr><td>C = <</td><td>Multinational character set unimplemented</td></tr>
1105 <tr><td>C = 5 </td><td>Finnish character set unimplemented</td></tr>
1106 <tr><td>C = C </td><td>Finnish character set unimplemented</td></tr>
1107 <tr><td>C = K </td><td>German character set unimplemented</td></tr>
1108 </table><p></p></dl>
1113 <h1><a name="csi__command_sequence_introducer__sequences">CSI (Command Sequence Introducer) Sequences</a></h1>
1115 <dt><strong><a name="item_esc__5b_ps__40"><strong><code>ESC [ Ps @</code> </strong>></a></strong><br />
1118 Insert <strong><a href="#item_ps"><code>Ps</code></a> </strong>> (Blank) <code>Character(s)</code> [default: 1] (ICH)
1121 <dt><strong><a name="item_esc__5b_ps_a"><strong><code>ESC [ Ps A</code> </strong>></a></strong><br />
1124 Cursor Up <strong><a href="#item_ps"><code>Ps</code></a> </strong>> Times [default: 1] (CUU)
1127 <dt><strong><a name="item_esc__5b_ps_b"><strong><code>ESC [ Ps B</code> </strong>></a></strong><br />
1130 Cursor Down <strong><a href="#item_ps"><code>Ps</code></a> </strong>> Times [default: 1] (CUD)
1133 <dt><strong><a name="item_esc__5b_ps_c"><strong><code>ESC [ Ps C</code> </strong>></a></strong><br />
1136 Cursor Forward <strong><a href="#item_ps"><code>Ps</code></a> </strong>> Times [default: 1] (CUF)
1139 <dt><strong><a name="item_esc__5b_ps_d"><strong><code>ESC [ Ps D</code> </strong>></a></strong><br />
1142 Cursor Backward <strong><a href="#item_ps"><code>Ps</code></a> </strong>> Times [default: 1] (CUB)
1145 <dt><strong><a name="item_esc__5b_ps_e"><strong><code>ESC [ Ps E</code> </strong>></a></strong><br />
1148 Cursor Down <strong><a href="#item_ps"><code>Ps</code></a> </strong>> Times [default: 1] and to first column
1151 <dt><strong><a name="item_esc__5b_ps_f"><strong><code>ESC [ Ps F</code> </strong>></a></strong><br />
1154 Cursor Up <strong><a href="#item_ps"><code>Ps</code></a> </strong>> Times [default: 1] and to first column
1157 <dt><strong><a name="item_esc__5b_ps_g"><strong><code>ESC [ Ps G</code> </strong>></a></strong><br />
1160 Cursor to Column <strong><a href="#item_ps"><code>Ps</code></a> </strong>> (HPA)
1163 <dt><strong><a name="item_esc__5b_ps_3bps_h"><strong><code>ESC [ Ps;Ps H</code> </strong>></a></strong><br />
1166 Cursor Position [row;column] [default: 1;1] (CUP)
1169 <dt><strong><a name="item_esc__5b_ps_i"><strong><code>ESC [ Ps I</code> </strong>></a></strong><br />
1172 Move forward <strong><a href="#item_ps"><code>Ps</code></a> </strong>> tab stops [default: 1]
1175 <dt><strong><a name="item_esc__5b_ps_j"><strong><code>ESC [ Ps J</code> </strong>></a></strong><br />
1178 Erase in Display (ED)
1181 <tr><td>Ps = 0</td><td>Clear Below (default)</td></tr>
1182 <tr><td>Ps = 1</td><td>Clear Above</td></tr>
1183 <tr><td>Ps = 2</td><td>Clear All</td></tr>
1185 <dt><strong><a name="item_esc__5b_ps_k"><strong><code>ESC [ Ps K</code> </strong>></a></strong><br />
1191 <tr><td>Ps = 0</td><td>Clear to Right (default)</td></tr>
1192 <tr><td>Ps = 1</td><td>Clear to Left</td></tr>
1193 <tr><td>Ps = 2</td><td>Clear All</td></tr>
1195 <dt><strong><a name="item_esc__5b_ps_l"><strong><code>ESC [ Ps L</code> </strong>></a></strong><br />
1198 Insert <strong><a href="#item_ps"><code>Ps</code></a> </strong>> <code>Line(s)</code> [default: 1] (IL)
1201 <dt><strong><a name="item_esc__5b_ps_m"><strong><code>ESC [ Ps M</code> </strong>></a></strong><br />
1204 Delete <strong><a href="#item_ps"><code>Ps</code></a> </strong>> <code>Line(s)</code> [default: 1] (DL)
1207 <dt><strong><a name="item_esc__5b_ps_p"><strong><code>ESC [ Ps P</code> </strong>></a></strong><br />
1210 Delete <strong><a href="#item_ps"><code>Ps</code></a> </strong>> <code>Character(s)</code> [default: 1] (DCH)
1213 <dt><strong><a name="item_esc__5b_ps_3bps_3bps_3bps_3bps_t"><strong><code>ESC [ Ps;Ps;Ps;Ps;Ps T</code> </strong>></a></strong><br />
1216 Initiate . <em>unimplemented</em> Parameters are
1217 [func;startx;starty;firstrow;lastrow].
1220 <dt><strong><a name="item_esc__5b_ps_w"><strong><code>ESC [ Ps W</code> </strong>></a></strong><br />
1226 <tr><td>Ps = 0</td><td>Tab Set (HTS)</td></tr>
1227 <tr><td>Ps = 2</td><td>Tab Clear (TBC), Clear Current Column (default)</td></tr>
1228 <tr><td>Ps = 5</td><td>Tab Clear (TBC), Clear All</td></tr>
1230 <dt><strong><a name="item_esc__5b_ps_x"><strong><code>ESC [ Ps X</code> </strong>></a></strong><br />
1233 Erase <strong><a href="#item_ps"><code>Ps</code></a> </strong>> <code>Character(s)</code> [default: 1] (ECH)
1236 <dt><strong><a name="item_esc__5b_ps_z"><strong><code>ESC [ Ps Z</code> </strong>></a></strong><br />
1239 Move backward <strong><a href="#item_ps"><code>Ps</code></a> </strong>> [default: 1] tab stops
1242 <dt><strong><a name="item_esc__5b_ps__27"><strong><code>ESC [ Ps '</code> </strong>></a></strong><br />
1245 See <strong><a href="#item_esc__5b_ps_g"><code>ESC [ Ps G</code></a> </strong>>
1248 <dt><strong><a name="item_esc__5b_ps_a"><strong><code>ESC [ Ps a</code> </strong>></a></strong><br />
1251 See <strong><a href="#item_esc__5b_ps_c"><code>ESC [ Ps C</code></a> </strong>>
1254 <dt><strong><a name="item_esc__5b_ps_c"><strong><code>ESC [ Ps c</code> </strong>></a></strong><br />
1257 Send Device Attributes (DA)
1258 <strong><code>Ps = 0</code> </strong>> (or omitted): request attributes from terminal
1259 returns: <strong><code>ESC[?1;2c</code> </strong>> (``I am a VT100 with Advanced Video
1263 <dt><strong><a name="item_esc__5b_ps_d"><strong><code>ESC [ Ps d</code> </strong>></a></strong><br />
1266 Cursor to Line <strong><a href="#item_ps"><code>Ps</code></a> </strong>> (VPA)
1269 <dt><strong><a name="item_esc__5b_ps_e"><strong><code>ESC [ Ps e</code> </strong>></a></strong><br />
1272 See <strong><a href="#item_esc__5b_ps_a"><code>ESC [ Ps A</code></a> </strong>>
1275 <dt><strong><a name="item_esc__5b_ps_3bps_f"><strong><code>ESC [ Ps;Ps f</code> </strong>></a></strong><br />
1278 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1281 <dt><strong><a name="item_esc__5b_ps_g"><strong><code>ESC [ Ps g</code> </strong>></a></strong><br />
1287 <tr><td>Ps = 0</td><td>Clear Current Column (default)</td></tr>
1288 <tr><td>Ps = 3</td><td>Clear All (TBC)</td></tr>
1290 <dt><strong><a name="item_esc__5b_pm_h"><strong><code>ESC [ Pm h</code> </strong>></a></strong><br />
1293 Set Mode (SM). See <strong><a href="#item_esc__5b_pm_l"><code>ESC [ Pm l</code></a> </strong>> sequence for description of <a href="#item_pm"><code>Pm</code></a>.
1296 <dt><strong><a name="item_esc__5b_ps_i"><strong><code>ESC [ Ps i</code> </strong>></a></strong><br />
1299 Printing. See also the <code>print-pipe</code> resource.
1302 <tr><td>Ps = 0</td><td>print screen (MC0)</td></tr>
1303 <tr><td>Ps = 4</td><td>disable transparent print mode (MC4)</td></tr>
1304 <tr><td>Ps = 5</td><td>enable transparent print mode (MC5)</td></tr>
1306 <dt><strong><a name="item_esc__5b_pm_l"><strong><code>ESC [ Pm l</code> </strong>></a></strong><br />
1312 <dt><strong><a name="item_ps__3d_4"><strong><code>Ps = 4</code> </strong>></a></strong><br />
1315 <tr><td>h</td><td>Insert Mode (SMIR)</td></tr>
1316 <tr><td>l</td><td>Replace Mode (RMIR)</td></tr>
1317 </table><dt><strong><a name="item_20"><strong><code>Ps = 20</code> </strong>> (partially implemented)</a></strong><br />
1320 <tr><td>h</td><td>Automatic Newline (LNM)</td></tr>
1321 <tr><td>l</td><td>Normal Linefeed (LNM)</td></tr>
1323 <dt><strong><a name="item_esc__5b_pm_m"><strong><code>ESC [ Pm m</code> </strong>></a></strong><br />
1326 Character Attributes (SGR)
1329 <tr><td>Ps = 0</td><td>Normal (default)</td></tr>
1330 <tr><td>Ps = 1 / 21</td><td>On / Off Bold (bright fg)</td></tr>
1331 <tr><td>Ps = 3 / 23</td><td>On / Off Italic</td></tr>
1332 <tr><td>Ps = 4 / 24</td><td>On / Off Underline</td></tr>
1333 <tr><td>Ps = 5 / 25</td><td>On / Off Slow Blink (bright bg)</td></tr>
1334 <tr><td>Ps = 6 / 26</td><td>On / Off Rapid Blink (bright bg)</td></tr>
1335 <tr><td>Ps = 7 / 27</td><td>On / Off Inverse</td></tr>
1336 <tr><td>Ps = 8 / 27</td><td>On / Off Invisible (NYI)</td></tr>
1337 <tr><td>Ps = 30 / 40</td><td>fg/bg Black</td></tr>
1338 <tr><td>Ps = 31 / 41</td><td>fg/bg Red</td></tr>
1339 <tr><td>Ps = 32 / 42</td><td>fg/bg Green</td></tr>
1340 <tr><td>Ps = 33 / 43</td><td>fg/bg Yellow</td></tr>
1341 <tr><td>Ps = 34 / 44</td><td>fg/bg Blue</td></tr>
1342 <tr><td>Ps = 35 / 45</td><td>fg/bg Magenta</td></tr>
1343 <tr><td>Ps = 36 / 46</td><td>fg/bg Cyan</td></tr>
1344 <tr><td>Ps = 38;5 / 48;5</td><td>set fg/bg to color #m (ISO 8613-6)</td></tr>
1345 <tr><td>Ps = 37 / 47</td><td>fg/bg White</td></tr>
1346 <tr><td>Ps = 39 / 49</td><td>fg/bg Default</td></tr>
1347 <tr><td>Ps = 90 / 100</td><td>fg/bg Bright Black</td></tr>
1348 <tr><td>Ps = 91 / 101</td><td>fg/bg Bright Red</td></tr>
1349 <tr><td>Ps = 92 / 102</td><td>fg/bg Bright Green</td></tr>
1350 <tr><td>Ps = 93 / 103</td><td>fg/bg Bright Yellow</td></tr>
1351 <tr><td>Ps = 94 / 104</td><td>fg/bg Bright Blue</td></tr>
1352 <tr><td>Ps = 95 / 105</td><td>fg/bg Bright Magenta</td></tr>
1353 <tr><td>Ps = 96 / 106</td><td>fg/bg Bright Cyan</td></tr>
1354 <tr><td>Ps = 97 / 107</td><td>fg/bg Bright White</td></tr>
1355 <tr><td>Ps = 99 / 109</td><td>fg/bg Bright Default</td></tr>
1357 <dt><strong><a name="item_esc__5b_ps_n"><strong><code>ESC [ Ps n</code> </strong>></a></strong><br />
1360 Device Status Report (DSR)
1363 <tr><td>Ps = 5</td><td>Status Report ESC [ 0 n (``OK'')</td></tr>
1364 <tr><td>Ps = 6</td><td>Report Cursor Position (CPR) [row;column] as ESC [ r ; c R</td></tr>
1365 <tr><td>Ps = 7</td><td>Request Display Name</td></tr>
1366 <tr><td>Ps = 8</td><td>Request Version Number (place in window title)</td></tr>
1368 <dt><strong><a name="item_esc__5b_ps_3bps_r"><strong><code>ESC [ Ps;Ps r</code> </strong>></a></strong><br />
1371 Set Scrolling Region [top;bottom]
1372 [default: full size of window] (CSR)
1375 <dt><strong><a name="item_esc__5b_s"><strong><code>ESC [ s</code> </strong>></a></strong><br />
1381 <dt><strong><a name="item_esc__5b_ps_x"><strong><code>ESC [ Ps x</code> </strong>></a></strong><br />
1384 Request Terminal Parameters (DECREQTPARM)
1387 <dt><strong><a name="item_esc__5b_u"><strong><code>ESC [ u</code> </strong>></a></strong><br />
1397 <h1><a name="dec_private_modes">DEC Private Modes</a></h1>
1399 <dt><strong><a name="item_esc__5b__3f_pm_h"><strong><code>ESC [ ? Pm h</code> </strong>></a></strong><br />
1402 DEC Private Mode Set (DECSET)
1405 <dt><strong><a name="item_esc__5b__3f_pm_l"><strong><code>ESC [ ? Pm l</code> </strong>></a></strong><br />
1408 DEC Private Mode Reset (DECRST)
1411 <dt><strong><a name="item_esc__5b__3f_pm_r"><strong><code>ESC [ ? Pm r</code> </strong>></a></strong><br />
1414 Restore previously saved DEC Private Mode Values.
1417 <dt><strong><a name="item_esc__5b__3f_pm_s"><strong><code>ESC [ ? Pm s</code> </strong>></a></strong><br />
1420 Save DEC Private Mode Values.
1423 <dt><strong><a name="item_esc__5b__3f_pm_t"><strong><code>ESC [ ? Pm t</code> </strong>></a></strong><br />
1426 Toggle DEC Private Mode Values (rxvt extension). <em>where</em>
1429 <dt><strong><a name="item_1"><strong><code>Ps = 1</code> </strong>> (DECCKM)</a></strong><br />
1432 <tr><td>h</td><td>Application Cursor Keys</td></tr>
1433 <tr><td>l</td><td>Normal Cursor Keys</td></tr>
1434 </table><dt><strong><a name="item_2"><strong><code>Ps = 2</code> </strong>> (ANSI/VT52 mode)</a></strong><br />
1437 <tr><td>h</td><td>Enter VT52 mode</td></tr>
1438 <tr><td>l</td><td>Enter VT52 mode</td></tr>
1439 </table><dt><strong><a name="item_ps__3d_3"><strong><code>Ps = 3</code> </strong>></a></strong><br />
1442 <tr><td>h</td><td>132 Column Mode (DECCOLM)</td></tr>
1443 <tr><td>l</td><td>80 Column Mode (DECCOLM)</td></tr>
1444 </table><dt><strong><strong><code>Ps = 4</code> </strong>></strong><br />
1447 <tr><td>h</td><td>Smooth (Slow) Scroll (DECSCLM)</td></tr>
1448 <tr><td>l</td><td>Jump (Fast) Scroll (DECSCLM)</td></tr>
1449 </table><dt><strong><a name="item_ps__3d_5"><strong><code>Ps = 5</code> </strong>></a></strong><br />
1452 <tr><td>h</td><td>Reverse Video (DECSCNM)</td></tr>
1453 <tr><td>l</td><td>Normal Video (DECSCNM)</td></tr>
1454 </table><dt><strong><a name="item_ps__3d_6"><strong><code>Ps = 6</code> </strong>></a></strong><br />
1457 <tr><td>h</td><td>Origin Mode (DECOM)</td></tr>
1458 <tr><td>l</td><td>Normal Cursor Mode (DECOM)</td></tr>
1459 </table><dt><strong><a name="item_ps__3d_7"><strong><code>Ps = 7</code> </strong>></a></strong><br />
1462 <tr><td>h</td><td>Wraparound Mode (DECAWM)</td></tr>
1463 <tr><td>l</td><td>No Wraparound Mode (DECAWM)</td></tr>
1464 </table><dt><strong><a name="item_ps__3d_8_unimplemented"><strong><code>Ps = 8</code> </strong>> <em>unimplemented</em></a></strong><br />
1467 <tr><td>h</td><td>Auto-repeat Keys (DECARM)</td></tr>
1468 <tr><td>l</td><td>No Auto-repeat Keys (DECARM)</td></tr>
1469 </table><dt><strong><a name="item_ps__3d_9_x10_xterm"><strong><code>Ps = 9</code> </strong>> X10 XTerm</a></strong><br />
1472 <tr><td>h</td><td>Send Mouse X & Y on button press.</td></tr>
1473 <tr><td>l</td><td>No mouse reporting.</td></tr>
1474 </table><dt><strong><a name="item_10"><strong><code>Ps = 10</code> </strong>> (<strong>rxvt</strong>)</a></strong><br />
1477 <tr><td>h</td><td>menuBar visible</td></tr>
1478 <tr><td>l</td><td>menuBar invisible</td></tr>
1479 </table><dt><strong><a name="item_ps__3d_25"><strong><code>Ps = 25</code> </strong>></a></strong><br />
1482 <tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr>
1483 <tr><td>l</td><td>Invisible cursor {civis}</td></tr>
1484 </table><dt><strong><a name="item_ps__3d_30"><strong><code>Ps = 30</code> </strong>></a></strong><br />
1487 <tr><td>h</td><td>scrollBar visisble</td></tr>
1488 <tr><td>l</td><td>scrollBar invisisble</td></tr>
1489 </table><dt><strong><a name="item_35"><strong><code>Ps = 35</code> </strong>> (<strong>rxvt</strong>)</a></strong><br />
1492 <tr><td>h</td><td>Allow XTerm Shift+key sequences</td></tr>
1493 <tr><td>l</td><td>Disallow XTerm Shift+key sequences</td></tr>
1494 </table><dt><strong><a name="item_ps__3d_38_unimplemented"><strong><code>Ps = 38</code> </strong>> <em>unimplemented</em></a></strong><br />
1497 Enter Tektronix Mode (DECTEK)
1500 <dt><strong><a name="item_ps__3d_40"><strong><code>Ps = 40</code> </strong>></a></strong><br />
1503 <tr><td>h</td><td>Allow 80/132 Mode</td></tr>
1504 <tr><td>l</td><td>Disallow 80/132 Mode</td></tr>
1505 </table><dt><strong><a name="item_ps__3d_44_unimplemented"><strong><code>Ps = 44</code> </strong>> <em>unimplemented</em></a></strong><br />
1508 <tr><td>h</td><td>Turn On Margin Bell</td></tr>
1509 <tr><td>l</td><td>Turn Off Margin Bell</td></tr>
1510 </table><dt><strong><a name="item_ps__3d_45_unimplemented"><strong><code>Ps = 45</code> </strong>> <em>unimplemented</em></a></strong><br />
1513 <tr><td>h</td><td>Reverse-wraparound Mode</td></tr>
1514 <tr><td>l</td><td>No Reverse-wraparound Mode</td></tr>
1515 </table><dt><strong><a name="item_ps__3d_46_unimplemented"><strong><code>Ps = 46</code> </strong>> <em>unimplemented</em></a></strong><br />
1517 <dt><strong><a name="item_ps__3d_47"><strong><code>Ps = 47</code> </strong>></a></strong><br />
1520 <tr><td>h</td><td>Use Alternate Screen Buffer</td></tr>
1521 <tr><td>l</td><td>Use Normal Screen Buffer</td></tr>
1523 <dt><strong><a name="item_ps__3d_66"><strong><code>Ps = 66</code> </strong>></a></strong><br />
1526 <tr><td>h</td><td>Application Keypad (DECPAM) == ESC =</td></tr>
1527 <tr><td>l</td><td>Normal Keypad (DECPNM) == ESC ></td></tr>
1528 </table><dt><strong><a name="item_ps__3d_67"><strong><code>Ps = 67</code> </strong>></a></strong><br />
1531 <tr><td>h</td><td>Backspace key sends BS (DECBKM)</td></tr>
1532 <tr><td>l</td><td>Backspace key sends DEL</td></tr>
1533 </table><dt><strong><a name="item_1000"><strong><code>Ps = 1000</code> </strong>> (X11 XTerm)</a></strong><br />
1536 <tr><td>h</td><td>Send Mouse X & Y on button press and release.</td></tr>
1537 <tr><td>l</td><td>No mouse reporting.</td></tr>
1538 </table><dt><strong><a name="item_1001"><strong><code>Ps = 1001</code> </strong>> (X11 XTerm) <em>unimplemented</em></a></strong><br />
1541 <tr><td>h</td><td>Use Hilite Mouse Tracking.</td></tr>
1542 <tr><td>l</td><td>No mouse reporting.</td></tr>
1543 </table><dt><strong><a name="item_1010"><strong><code>Ps = 1010</code> </strong>> (<strong>rxvt</strong>)</a></strong><br />
1546 <tr><td>h</td><td>Don't scroll to bottom on TTY output</td></tr>
1547 <tr><td>l</td><td>Scroll to bottom on TTY output</td></tr>
1548 </table><dt><strong><a name="item_1011"><strong><code>Ps = 1011</code> </strong>> (<strong>rxvt</strong>)</a></strong><br />
1551 <tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr>
1552 <tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr>
1553 </table><dt><strong><a name="item_ps__3d_1047"><strong><code>Ps = 1047</code> </strong>></a></strong><br />
1556 <tr><td>h</td><td>Use Alternate Screen Buffer</td></tr>
1557 <tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr>
1558 </table><dt><strong><a name="item_ps__3d_1048"><strong><code>Ps = 1048</code> </strong>></a></strong><br />
1561 <tr><td>h</td><td>Save cursor position</td></tr>
1562 <tr><td>l</td><td>Restore cursor position</td></tr>
1563 </table><dt><strong><a name="item_ps__3d_1049"><strong><code>Ps = 1049</code> </strong>></a></strong><br />
1566 <tr><td>h</td><td>Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it</td></tr>
1567 <tr><td>l</td><td>Use Normal Screen Buffer</td></tr>
1574 <h1><a name="xterm_operating_system_commands">XTerm Operating System Commands</a></h1>
1576 <dt><strong><a name="item_esc__5d_ps_3bpt_st"><strong><code>ESC ] Ps;Pt ST</code> </strong>></a></strong><br />
1579 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
1580 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1581 <strong>octet</strong> can be escaped by prefixing it with SYN (0x16, ^V).
1584 <tr><td>Ps = 0</td><td>Change Icon Name and Window Title to Pt</td></tr>
1585 <tr><td>Ps = 1</td><td>Change Icon Name to Pt</td></tr>
1586 <tr><td>Ps = 2</td><td>Change Window Title to Pt</td></tr>
1587 <tr><td>Ps = 3</td><td>If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.</td></tr>
1588 <tr><td>Ps = 4</td><td>Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white</td></tr>
1589 <tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr>
1590 <tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr>
1591 <tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr>
1592 <tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr>
1593 <tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr>
1594 <tr><td>Ps = 18</td><td>Change colour of bold characters to Pt</td></tr>
1595 <tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt</td></tr>
1596 <tr><td>Ps = 20</td><td>Change default background to Pt</td></tr>
1597 <tr><td>Ps = 39</td><td>Change default foreground colour to Pt rxvt compile-time option</td></tr>
1598 <tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr>
1599 <tr><td>Ps = 49</td><td>Change default background colour to Pt rxvt compile-time option</td></tr>
1600 <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>
1601 <tr><td>Ps = 55</td><td>Log all scrollback buffer and all of screen to Pt</td></tr>
1602 <tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (rxvt extension)</td></tr>
1603 <tr><td>Ps = 703</td><td>Menubar command Pt rxvt compile-time option (rxvt-unicode extension)</td></tr>
1604 <tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr>
1605 <tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt</td></tr>
1606 <tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr>
1607 <tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50.</td></tr>
1608 <tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50.</td></tr>
1609 <tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50.</td></tr>
1610 </table><p></p></dl>
1615 <h1><a name="menubar">menuBar</a></h1>
1616 <p><strong>The exact syntax used is <em>almost</em> solidified. </strong>>
1617 In the menus, <strong>DON'T</strong> try to use menuBar commands that add or remove a
1619 <p>Note that in all of the commands, the <strong><em>/path/</em> </strong>> <em>cannot</em> be
1620 omitted: use <strong>./</strong> to specify a menu relative to the current menu.</p>
1623 <h2><a name="overview_of_menubar_operation">Overview of menuBar operation</a></h2>
1624 <p>For the menuBar XTerm escape sequence <code>ESC ] 703 ; Pt ST</code>, the syntax
1625 of <a href="#item_pt"><code>Pt</code></a> can be used for a variety of tasks:</p>
1626 <p>At the top level is the current menuBar which is a member of a circular
1627 linked-list of other such menuBars.</p>
1628 <p>The menuBar acts as a parent for the various drop-down menus, which in
1629 turn, may have labels, separator lines, menuItems and subMenus.</p>
1630 <p>The menuItems are the useful bits: you can use them to mimic keyboard
1631 input or even to send text or escape sequences back to rxvt.</p>
1632 <p>The menuBar syntax is intended to provide a simple yet robust method of
1633 constructing and manipulating menus and navigating through the
1635 <p>The first step is to use the tag <strong>[menu:<em>name</em>] </strong>> which creates
1636 the menuBar called <em>name</em> and allows access. You may now or menus,
1637 subMenus, and menuItems. Finally, use the tag <strong>[done]</strong> to set the
1638 menuBar access as <strong>readonly</strong> to prevent accidental corruption of the
1639 menus. To re-access the current menuBar for alterations, use the tag
1640 <strong>[menu]</strong>, make the alterations and then use <strong>[done]</strong></p>
1644 <h2><a name="commands">Commands</a></h2>
1646 <dt><strong><a name="item__5bmenu_3a_2bname_5d"><strong>[menu:+<em>name</em>] </strong>></a></strong><br />
1649 access the named menuBar for creation or alteration. If a new menuBar
1650 is created, it is called <em>name</em> (max of 15 chars) and the current
1651 menuBar is pushed onto the stack
1654 <dt><strong><a name="item__5bmenu_5d"><strong>[menu]</strong></a></strong><br />
1657 access the current menuBar for alteration
1660 <dt><strong><a name="item__5btitle_3a_2bstring_5d"><strong>[title:+<em>string</em>] </strong>></a></strong><br />
1663 set the current menuBar's title to <em>string</em>, which may contain the
1664 following format specifiers:
1665 <strong>%%</strong> : literal <strong>%</strong> character
1666 <strong>%n</strong> : rxvt name (as per the <strong>-name</strong> command-line option)
1667 <strong>%v</strong> : rxvt version
1670 <dt><strong><a name="item__5bdone_5d"><strong>[done]</strong></a></strong><br />
1673 set menuBar access as <strong>readonly</strong>.
1674 End-of-file tag for <strong>[read:+<em>file</em>] </strong>> operations.
1677 <dt><strong><a name="item__5bread_3a_2bfile_5d"><strong>[read:+<em>file</em>] </strong>></a></strong><br />
1680 read menu commands directly from <em>file</em> (extension ``.menu'' will be
1681 appended if required.) Start reading at a line with <strong>[menu]</strong> or <strong><
1682 [menu:+<em>name</em> </strong>> and continuing until <strong>[done]</strong> is encountered.
1685 <p>Blank and comment lines (starting with <strong>#</strong>) are ignored. Actually,
1686 since any invalid menu commands are also ignored, almost anything could
1687 be construed as a comment line, but this may be tightened up in the
1688 future ... so don't count on it!.</p>
1691 <dt><strong><a name="item__5bread_3a_2bfile_3b_2bname_5d"><strong>[read:+<em>file</em>;+<em>name</em>] </strong>></a></strong><br />
1694 The same as <strong>[read:+<em>file</em>] </strong>>, but start reading at a line with
1695 <strong>[menu:+<em>name</em>] </strong>> and continuing until <strong>[done:+<em>name</em>] </strong>> or
1696 <strong>[done]</strong> is encountered.
1699 <dt><strong><a name="item__5bdump_5d"><strong>[dump]</strong></a></strong><br />
1702 dump all menuBars to the file <strong>/tmp/rxvt-PID</strong> in a format suitable for
1706 <dt><strong><a name="item__5brm_3aname_5d"><strong>[rm:name]</strong></a></strong><br />
1709 remove the named menuBar
1712 <dt><strong><a name="item__5brm_5d__5brm_3a_5d"><strong>[rm] [rm:]</strong></a></strong><br />
1715 remove the current menuBar
1718 <dt><strong><a name="item__5brm_2a_5d__5brm_3a_2a_5d"><strong>[rm*] [rm:*]</strong></a></strong><br />
1724 <dt><strong><a name="item__5bswap_5d"><strong>[swap]</strong></a></strong><br />
1727 swap the top two menuBars
1730 <dt><strong><a name="item__5bprev_5d"><strong>[prev]</strong></a></strong><br />
1733 access the previous menuBar
1736 <dt><strong><a name="item__5bnext_5d"><strong>[next]</strong></a></strong><br />
1739 access the next menuBar
1742 <dt><strong><a name="item__5bshow_5d"><strong>[show]</strong></a></strong><br />
1745 Enable display of the menuBar
1748 <dt><strong><a name="item__5bhide_5d"><strong>[hide]</strong></a></strong><br />
1751 Disable display of the menuBar
1754 <dt><strong><a name="item__5bpixmap_3a_2bname_5d"><strong>[pixmap:+<em>name</em>] </strong>></a></strong><br />
1756 <dt><strong><a name="item__5bpixmap_3a_2bname_3bscaling_5d"><strong>[pixmap:+<em>name</em>;<em>scaling</em>] </strong>></a></strong><br />
1759 (set the background pixmap globally
1762 <p><strong>A Future implementation <em>may</em> make this local to the menubar </strong>>)</p>
1765 <dt><strong><a name="item__5b_3a_2bcommand_3a_5d"><strong>[:+<em>command</em>:] </strong>></a></strong><br />
1768 ignore the menu readonly status and issue a <em>command</em> to or a menu or
1769 menuitem or change the ; a useful shortcut for setting the quick arrows
1776 <h2><a name="adding_and_accessing_menus">Adding and accessing menus</a></h2>
1777 <p>The following commands may also be <strong>+</strong> prefixed.</p>
1779 <dt><strong><a name="item__2f_2b"><strong>/+</strong></a></strong><br />
1782 access menuBar top level
1785 <dt><strong><a name="item__2e_2f_2b"><strong>./+</strong></a></strong><br />
1788 access current menu level
1791 <dt><strong><a name="item__2e_2e_2f_2b"><strong>../+</strong></a></strong><br />
1794 access parent menu (1 level up)
1797 <dt><strong><a name="item__2e_2e_2f_2e_2e_2f"><strong>../../</strong></a></strong><br />
1800 access parent menu (multiple levels up)
1803 <dt><strong><a name="item__2fpath_2fmenu"><strong><em>/path/</em>menu </strong>></a></strong><br />
1809 <dt><strong><a name="item__2fpath_2fmenu_2f_2a"><strong><em>/path/</em>menu/* </strong>></a></strong><br />
1812 add/access menu and clear it if it exists
1815 <dt><strong><a name="item__2fpath_2f_7b_2d_7d"><strong><em>/path/</em>{-} </strong>></a></strong><br />
1821 <dt><strong><a name="item__2fpath_2f_7bitem_7d"><strong><em>/path/</em>{item} </strong>></a></strong><br />
1824 add <strong>item</strong> as a label
1827 <dt><strong><a name="item__2fpath_2f_7bitem_7d_action"><strong><em>/path/</em>{item} action </strong>></a></strong><br />
1830 add/alter <em>menuitem</em> with an associated <em>action</em>
1833 <dt><strong><a name="item__2fpath_2f_7bitem_7d_7bright_2dtext_7d"><strong><em>/path/</em>{item}{right-text} </strong>></a></strong><br />
1836 add/alter <em>menuitem</em> with <strong>right-text</strong> as the right-justified text
1837 and as the associated <em>action</em>
1840 <dt><strong><a name="item__2fpath_2f_7bitem_7d_7brtext_7d_action"><strong><em>/path/</em>{item}{rtext} action </strong>></a></strong><br />
1843 add/alter <em>menuitem</em> with an associated <em>action</em> and with <strong>rtext</strong> as
1844 the right-justified text.
1848 <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 />
1851 <strong>\a \b \E \e \n \r \t \octal</strong>
1854 <dt><strong><a name="item_or_in_control_2dcharacter_notation_3a">or in control-character notation:</a></strong><br />
1857 <strong>^@, ^A .. ^Z .. ^_, ^?</strong>
1860 <p>To send a string starting with a <strong>NUL</strong> (<strong>^@</strong>) character to the
1861 program, start <em>action</em> with a pair of <strong>NUL</strong> characters (<strong>^@^@</strong>),
1862 the first of which will be stripped off and the balance directed to the
1863 program. Otherwise if <em>action</em> begins with <strong>NUL</strong> followed by
1864 non-+<strong>NUL</strong> characters, the leading <strong>NUL</strong> is stripped off and the
1865 balance is sent back to rxvt.</p>
1866 <p>As a convenience for the many Emacs-type editors, <em>action</em> may start
1867 with <strong>M-</strong> (eg, <strong>M-$</strong> is equivalent to <strong>\E$</strong>) and a <strong>CR</strong> will be
1868 appended if missed from <strong>M-x</strong> commands.</p>
1869 <p>As a convenience for issuing XTerm <strong>ESC]</strong> sequences from a menubar (or
1870 quick arrow), a <strong>BEL</strong> (<strong>^G</strong>) will be appended if needed.</p>
1872 <dt><strong><a name="item_for_example_2c">For example,</a></strong><br />
1875 <strong>M-xapropos</strong> is equivalent to <strong>\Exapropos\r</strong>
1878 <dt><strong><a name="item_and">and</a></strong><br />
1881 <strong>\E]703;mona;100</strong> is equivalent to <strong>\E]703;mona;100\a</strong>
1884 <p>The option <strong>{<em>right-rtext</em>} </strong>> will be right-justified. In the
1885 absence of a specified action, this text will be used as the <em>action</em>
1888 <dt><strong>For example,</strong><br />
1891 <strong>/File/{Open}{^X^F}</strong> is equivalent to <strong>/File/{Open}{^X^F} ^X^F</strong>
1894 <p>The left label <em>is</em> necessary, since it's used for matching, but
1895 implicitly hiding the left label (by using same name for both left and
1896 right labels), or explicitly hiding the left label (by preceeding it
1897 with a dot), makes it possible to have right-justified text only.</p>
1899 <dt><strong>For example,</strong><br />
1902 <strong>/File/{Open}{Open} Open-File-Action</strong>
1905 <dt><strong><a name="item_or_hiding_it">or hiding it</a></strong><br />
1908 <strong>/File/{.anylabel}{Open} Open-File-Action</strong>
1914 <h2><a name="removing_menus">Removing menus</a></h2>
1916 <dt><strong><a name="item__2d_2f_2a_2b"><strong>-/*+ </strong>></a></strong><br />
1919 remove all menus from the menuBar, the same as <strong>[clear]</strong>
1922 <dt><strong><a name="item__2d_2b_2fpathmenu_2b"><strong>-+<em>/path</em>menu+ </strong>></a></strong><br />
1928 <dt><strong><a name="item__2d_2b_2fpath_7bitem_7d_2b"><strong>-+<em>/path</em>{item}+ </strong>></a></strong><br />
1934 <dt><strong><a name="item__2d_2b_2fpath_7b_2d_7d"><strong>-+<em>/path</em>{-} </strong>></a></strong><br />
1940 <dt><strong><a name="item__2d_2fpath_2fmenu_2f_2a"><strong>-/path/menu/*</strong></a></strong><br />
1943 remove all items, separators and submenus from menu
1949 <h2><a name="quick_arrows">Quick Arrows</a></h2>
1950 <p>The menus also provide a hook for <em>quick arrows</em> to provide easier
1951 user access. If nothing has been explicitly set, the default is to
1952 emulate the curror keys. The syntax permits each arrow to be altered
1953 individually or all four at once without re-entering their common
1954 beginning/end text. For example, to explicitly associate cursor actions
1955 with the arrows, any of the following forms could be used:</p>
1957 <dt><strong><a name="item__3cr_3e_2bright"><strong><r</strong>+<em>Right</em> >></a></strong><br />
1959 <dt><strong><a name="item__3cl_3e_2bleft"><strong><l</strong>+<em>Left</em> >></a></strong><br />
1961 <dt><strong><a name="item__3cu_3e_2bup"><strong><u</strong>+<em>Up</em> >></a></strong><br />
1963 <dt><strong><a name="item__3cd_3e_2bdown"><strong><d</strong>+<em>Down</em> >></a></strong><br />
1966 Define actions for the respective arrow buttons
1969 <dt><strong><a name="item__3cb_3e_2bbegin"><strong><b</strong>+<em>Begin</em> >></a></strong><br />
1971 <dt><strong><a name="item__3ce_3e_2bend"><strong><e</strong>+<em>End</em> >></a></strong><br />
1974 Define common beginning/end parts for <em>quick arrows</em> which used in
1975 conjunction with the above <r> <l> <u> <d> constructs
1979 <dt><strong><a name="item_for_example_2c_define_arrows_individually_2c">For example, define arrows individually,</a></strong><br />
1997 <dt><strong><a name="item_or_all_at_once">or all at once</a></strong><br />
2001 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D</pre>
2003 <dt><strong><a name="item_compactly">or more compactly (factoring out common parts)</a></strong><br />
2007 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D</pre>
2013 <h2><a name="command_summary">Command Summary</a></h2>
2014 <p>A short summary of the most <em>common</em> commands:</p>
2016 <dt><strong><a name="item__5bmenu_3aname_5d">[menu:name]</a></strong><br />
2019 use an existing named menuBar or start a new one
2022 <dt><strong>[menu]</strong><br />
2025 use the current menuBar
2028 <dt><strong><a name="item__5btitle_3astring_5d">[title:string]</a></strong><br />
2034 <dt><strong>[done]</strong><br />
2037 set menu access to readonly and, if reading from a file, signal EOF
2040 <dt><strong><a name="item__5bdone_3aname_5d">[done:name]</a></strong><br />
2043 if reading from a file using [read:file;name] signal EOF
2046 <dt><strong>[rm:name]</strong><br />
2049 remove named <code>menuBar(s)</code>
2052 <dt><strong>[rm] [rm:]</strong><br />
2055 remove current menuBar
2058 <dt><strong>[rm*] [rm:*]</strong><br />
2061 remove all <code>menuBar(s)</code>
2064 <dt><strong>[swap]</strong><br />
2067 swap top two menuBars
2070 <dt><strong>[prev]</strong><br />
2073 access the previous menuBar
2076 <dt><strong>[next]</strong><br />
2079 access the next menuBar
2082 <dt><strong>[show]</strong><br />
2088 <dt><strong>[hide]</strong><br />
2094 <dt><strong><a name="item__5bpixmap_3bfile_5d">[pixmap;file]</a></strong><br />
2096 <dt><strong><a name="item__5bpixmap_3bfile_3bscaling_5d">[pixmap;file;scaling]</a></strong><br />
2099 set a background pixmap
2102 <dt><strong><a name="item__5bread_3afile_5d">[read:file]</a></strong><br />
2104 <dt><strong><a name="item__5bread_3afile_3bname_5d">[read:file;name]</a></strong><br />
2107 read in a menu from a file
2110 <dt><strong>[dump]</strong><br />
2113 dump out all menuBars to /tmp/rxvt-PID
2116 <dt><strong><a name="item__2f">/</a></strong><br />
2119 access menuBar top level
2122 <dt><strong><a name="item__2e_2f">./</a></strong><br />
2124 <dt><strong><a name="item__2e_2e_2f">../</a></strong><br />
2126 <dt><strong>../../</strong><br />
2129 access current or parent menu level
2132 <dt><strong>/path/menu</strong><br />
2138 <dt><strong>/path/{-}</strong><br />
2144 <dt><strong>/path/{item}{rtext} action</strong><br />
2150 <dt><strong><a name="item__2d_2f_2a">-/*</a></strong><br />
2153 remove all menus from the menuBar
2156 <dt><strong><a name="item__2d_2fpath_2fmenu">-/path/menu</a></strong><br />
2159 remove menu items, separators and submenus from menu
2162 <dt><strong>-/path/menu</strong><br />
2168 <dt><strong><a name="item__2d_2fpath_2f_7bitem_7d">-/path/{item}</a></strong><br />
2174 <dt><strong><a name="item__2d_2fpath_2f_7b_2d_7d">-/path/{-}</a></strong><br />
2180 <dt><strong><a name="item__3cb_3ebegin_3cr_3eright_3cl_3eleft_3cu_3eup_3cd_3"><b>Begin<r>Right<l>Left<u>Up<d>Down<e>End</a></strong><br />
2189 <h1><a name="xpm">XPM</a></h1>
2190 <p>For the XPM XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code> </strong>> then value
2191 of <strong><a href="#item_pt"><code>Pt</code></a> </strong>> can be the name of the background pixmap followed by a
2192 sequence of scaling/positioning commands separated by semi-colons. The
2193 scaling/positioning commands are as follows:</p>
2195 <dt><strong><a name="item_query_scale_2fposition">query scale/position</a></strong><br />
2201 <dt><strong><a name="item_change_scale_and_position">change scale and position</a></strong><br />
2204 <strong>WxH+X+Y</strong>
2207 <p><strong>WxH+X</strong> (== <strong>WxH+X+X</strong>)</p>
2210 <p><strong>WxH</strong> (same as <strong>WxH+50+50</strong>)</p>
2213 <p><strong>W+X+Y</strong> (same as <strong>WxW+X+Y</strong>)</p>
2216 <p><strong>W+X</strong> (same as <strong>WxW+X+X</strong>)</p>
2219 <p><strong>W</strong> (same as <strong>WxW+50+50</strong>)</p>
2222 <dt><strong><a name="item_position">change position (absolute)</a></strong><br />
2225 <strong>=+X+Y</strong>
2228 <p><strong>=+X</strong> (same as <strong>=+X+Y</strong>)</p>
2231 <dt><strong>change position (relative)</strong><br />
2234 <strong>+X+Y</strong>
2237 <p><strong>+X</strong> (same as <strong>+X+Y</strong>)</p>
2240 <dt><strong><a name="item_rescale">rescale (relative)</a></strong><br />
2243 <strong>Wx0</strong> -> <strong>W *= (W/100)</strong>
2246 <p><strong>0xH</strong> -> <strong>H *= (H/100)</strong></p>
2251 <dt><strong><a name="item__5ce_5d20_3bfunky_5ca"><strong>\E]20;funky\a</strong></a></strong><br />
2254 load <strong>funky.xpm</strong> as a tiled image
2257 <dt><strong><a name="item__5ce_5d20_3bmona_3b100_5ca"><strong>\E]20;mona;100\a</strong></a></strong><br />
2260 load <strong>mona.xpm</strong> with a scaling of 100%
2263 <dt><strong><a name="item__5ce_5d20_3b_3b200_3b_3f_5ca"><strong>\E]20;;200;?\a</strong></a></strong><br />
2266 rescale the current pixmap to 200% and display the image geometry in
2273 <h1><a name="mouse_reporting">Mouse Reporting</a></h1>
2275 <dt><strong><a name="item_esc__5b_m__3cb_3e__3cx_3e__3cy_3e"><strong><code>ESC [ M <b> <x> <y></code> </strong>></a></strong><br />
2278 report mouse position
2281 <p>The lower 2 bits of <strong><code><b></code> </strong>> indicate the button:</p>
2283 <dt><strong><a name="item_button__3d__28_3cb_3e__2d_space_29__26_3">Button = <strong><code>(<b> - SPACE) & 3</code> </strong>></a></strong><br />
2286 <tr><td>0</td><td>Button1 pressed</td></tr>
2287 <tr><td>1</td><td>Button2 pressed</td></tr>
2288 <tr><td>2</td><td>Button3 pressed</td></tr>
2289 <tr><td>3</td><td>button released (X11 mouse report)</td></tr>
2291 <p>The upper bits of <strong><code><b></code> </strong>> indicate the modifiers when the
2292 button was pressed and are added together (X11 mouse report only):</p>
2294 <dt><strong><a name="item_state__3d__28_3cb_3e__2d_space_29__26_60">State = <strong><code>(<b> - SPACE) & 60</code> </strong>></a></strong><br />
2297 <tr><td>4</td><td>Shift</td></tr>
2298 <tr><td>8</td><td>Meta</td></tr>
2299 <tr><td>16</td><td>Control</td></tr>
2300 <tr><td>32</td><td>Double Click (Rxvt extension)</td></tr>
2301 </table><p>Col = <strong><code><x> - SPACE</code> </strong>></p>
2302 <p>Row = <strong><code><y> - SPACE</code> </strong>></p>
2307 <h1><a name="key_codes">Key Codes</a></h1>
2308 <p>Note: <strong>Shift</strong> + <strong>F1</strong>-<strong>F10</strong> generates <strong>F11</strong>-<strong>F20</strong></p>
2309 <p>For the keypad, use <strong>Shift</strong> to temporarily override Application-Keypad
2310 setting use <strong>Num_Lock</strong> to toggle Application-Keypad setting if
2311 <strong>Num_Lock</strong> is off, toggle Application-Keypad setting. Also note that
2312 values of <strong>Home</strong>, <strong>End</strong>, <strong>Delete</strong> may have been compiled differently on
2315 <tr><td></td><td>Normal</td><td>Shift</td><td>Control</td><td>Ctrl+Shift</td></tr>
2316 <tr><td>Tab</td><td>^I</td><td>ESC [ Z</td><td>^I</td><td>ESC [ Z</td></tr>
2317 <tr><td>BackSpace</td><td>^H</td><td>^?</td><td>^?</td><td>^?</td></tr>
2318 <tr><td>Find</td><td>ESC [ 1 ~</td><td>ESC [ 1 $</td><td>ESC [ 1 ^</td><td>ESC [ 1 @</td></tr>
2319 <tr><td>Insert</td><td>ESC [ 2 ~</td><td>paste</td><td>ESC [ 2 ^</td><td>ESC [ 2 @</td></tr>
2320 <tr><td>Execute</td><td>ESC [ 3 ~</td><td>ESC [ 3 $</td><td>ESC [ 3 ^</td><td>ESC [ 3 @</td></tr>
2321 <tr><td>Select</td><td>ESC [ 4 ~</td><td>ESC [ 4 $</td><td>ESC [ 4 ^</td><td>ESC [ 4 @</td></tr>
2322 <tr><td>Prior</td><td>ESC [ 5 ~</td><td>scroll-up</td><td>ESC [ 5 ^</td><td>ESC [ 5 @</td></tr>
2323 <tr><td>Next</td><td>ESC [ 6 ~</td><td>scroll-down</td><td>ESC [ 6 ^</td><td>ESC [ 6 @</td></tr>
2324 <tr><td>Home</td><td>ESC [ 7 ~</td><td>ESC [ 7 $</td><td>ESC [ 7 ^</td><td>ESC [ 7 @</td></tr>
2325 <tr><td>End</td><td>ESC [ 8 ~</td><td>ESC [ 8 $</td><td>ESC [ 8 ^</td><td>ESC [ 8 @</td></tr>
2326 <tr><td>Delete</td><td>ESC [ 3 ~</td><td>ESC [ 3 $</td><td>ESC [ 3 ^</td><td>ESC [ 3 @</td></tr>
2327 <tr><td>F1</td><td>ESC [ 11 ~</td><td>ESC [ 23 ~</td><td>ESC [ 11 ^</td><td>ESC [ 23 ^</td></tr>
2328 <tr><td>F2</td><td>ESC [ 12 ~</td><td>ESC [ 24 ~</td><td>ESC [ 12 ^</td><td>ESC [ 24 ^</td></tr>
2329 <tr><td>F3</td><td>ESC [ 13 ~</td><td>ESC [ 25 ~</td><td>ESC [ 13 ^</td><td>ESC [ 25 ^</td></tr>
2330 <tr><td>F4</td><td>ESC [ 14 ~</td><td>ESC [ 26 ~</td><td>ESC [ 14 ^</td><td>ESC [ 26 ^</td></tr>
2331 <tr><td>F5</td><td>ESC [ 15 ~</td><td>ESC [ 28 ~</td><td>ESC [ 15 ^</td><td>ESC [ 28 ^</td></tr>
2332 <tr><td>F6</td><td>ESC [ 17 ~</td><td>ESC [ 29 ~</td><td>ESC [ 17 ^</td><td>ESC [ 29 ^</td></tr>
2333 <tr><td>F7</td><td>ESC [ 18 ~</td><td>ESC [ 31 ~</td><td>ESC [ 18 ^</td><td>ESC [ 31 ^</td></tr>
2334 <tr><td>F8</td><td>ESC [ 19 ~</td><td>ESC [ 32 ~</td><td>ESC [ 19 ^</td><td>ESC [ 32 ^</td></tr>
2335 <tr><td>F9</td><td>ESC [ 20 ~</td><td>ESC [ 33 ~</td><td>ESC [ 20 ^</td><td>ESC [ 33 ^</td></tr>
2336 <tr><td>F10</td><td>ESC [ 21 ~</td><td>ESC [ 34 ~</td><td>ESC [ 21 ^</td><td>ESC [ 34 ^</td></tr>
2337 <tr><td>F11</td><td>ESC [ 23 ~</td><td>ESC [ 23 $</td><td>ESC [ 23 ^</td><td>ESC [ 23 @</td></tr>
2338 <tr><td>F12</td><td>ESC [ 24 ~</td><td>ESC [ 24 $</td><td>ESC [ 24 ^</td><td>ESC [ 24 @</td></tr>
2339 <tr><td>F13</td><td>ESC [ 25 ~</td><td>ESC [ 25 $</td><td>ESC [ 25 ^</td><td>ESC [ 25 @</td></tr>
2340 <tr><td>F14</td><td>ESC [ 26 ~</td><td>ESC [ 26 $</td><td>ESC [ 26 ^</td><td>ESC [ 26 @</td></tr>
2341 <tr><td>F15 (Help)</td><td>ESC [ 28 ~</td><td>ESC [ 28 $</td><td>ESC [ 28 ^</td><td>ESC [ 28 @</td></tr>
2342 <tr><td>F16 (Menu)</td><td>ESC [ 29 ~</td><td>ESC [ 29 $</td><td>ESC [ 29 ^</td><td>ESC [ 29 @</td></tr>
2343 <tr><td>F17</td><td>ESC [ 31 ~</td><td>ESC [ 31 $</td><td>ESC [ 31 ^</td><td>ESC [ 31 @</td></tr>
2344 <tr><td>F18</td><td>ESC [ 32 ~</td><td>ESC [ 32 $</td><td>ESC [ 32 ^</td><td>ESC [ 32 @</td></tr>
2345 <tr><td>F19</td><td>ESC [ 33 ~</td><td>ESC [ 33 $</td><td>ESC [ 33 ^</td><td>ESC [ 33 @</td></tr>
2346 <tr><td>F20</td><td>ESC [ 34 ~</td><td>ESC [ 34 $</td><td>ESC [ 34 ^</td><td>ESC [ 34 @</td></tr>
2347 <tr><td></td><td></td><td></td><td></td><td>Application</td></tr>
2348 <tr><td>Up</td><td>ESC [ A</td><td>ESC [ a</td><td>ESC O a</td><td>ESC O A</td></tr>
2349 <tr><td>Down</td><td>ESC [ B</td><td>ESC [ b</td><td>ESC O b</td><td>ESC O B</td></tr>
2350 <tr><td>Right</td><td>ESC [ C</td><td>ESC [ c</td><td>ESC O c</td><td>ESC O C</td></tr>
2351 <tr><td>Left</td><td>ESC [ D</td><td>ESC [ d</td><td>ESC O d</td><td>ESC O D</td></tr>
2352 <tr><td>KP_Enter</td><td>^M</td><td></td><td></td><td>ESC O M</td></tr>
2353 <tr><td>KP_F1</td><td>ESC O P</td><td></td><td></td><td>ESC O P</td></tr>
2354 <tr><td>KP_F2</td><td>ESC O Q</td><td></td><td></td><td>ESC O Q</td></tr>
2355 <tr><td>KP_F3</td><td>ESC O R</td><td></td><td></td><td>ESC O R</td></tr>
2356 <tr><td>KP_F4</td><td>ESC O S</td><td></td><td></td><td>ESC O S</td></tr>
2357 <tr><td>XK_KP_Multiply</td><td>*</td><td></td><td></td><td>ESC O j</td></tr>
2358 <tr><td>XK_KP_Add</td><td>+</td><td></td><td></td><td>ESC O k</td></tr>
2359 <tr><td>XK_KP_Separator</td><td>,</td><td></td><td></td><td>ESC O l</td></tr>
2360 <tr><td>XK_KP_Subtract</td><td>-</td><td></td><td></td><td>ESC O m</td></tr>
2361 <tr><td>XK_KP_Decimal</td><td>.</td><td></td><td></td><td>ESC O n</td></tr>
2362 <tr><td>XK_KP_Divide</td><td>/</td><td></td><td></td><td>ESC O o</td></tr>
2363 <tr><td>XK_KP_0</td><td>0</td><td></td><td></td><td>ESC O p</td></tr>
2364 <tr><td>XK_KP_1</td><td>1</td><td></td><td></td><td>ESC O q</td></tr>
2365 <tr><td>XK_KP_2</td><td>2</td><td></td><td></td><td>ESC O r</td></tr>
2366 <tr><td>XK_KP_3</td><td>3</td><td></td><td></td><td>ESC O s</td></tr>
2367 <tr><td>XK_KP_4</td><td>4</td><td></td><td></td><td>ESC O t</td></tr>
2368 <tr><td>XK_KP_5</td><td>5</td><td></td><td></td><td>ESC O u</td></tr>
2369 <tr><td>XK_KP_6</td><td>6</td><td></td><td></td><td>ESC O v</td></tr>
2370 <tr><td>XK_KP_7</td><td>7</td><td></td><td></td><td>ESC O w</td></tr>
2371 <tr><td>XK_KP_8</td><td>8</td><td></td><td></td><td>ESC O x</td></tr>
2372 <tr><td>XK_KP_9</td><td>9</td><td></td><td></td><td>ESC O y</td></tr>
2376 <h1><a name="configure_options">CONFIGURE OPTIONS</a></h1>
2377 <p>General hint: if you get compile errors, then likely your configuration
2378 hasn't been tested well. Either try with --enable-everything or use the
2379 ./reconf script as a base for experiments. ./reconf is used by myself,
2380 so it should generally be a working config. Of course, you should always
2381 report when a combination doesn't work, so it can be fixed. Marc Lehmann
2382 <<a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a>>.</p>
2384 <dt><strong><a name="item__2d_2denable_2deverything">--enable-everything</a></strong><br />
2387 Add support for all non-multichoice options listed in ``./configure
2388 --help''. Note that unlike other enable options this is order dependant.
2389 You can specify this and then disable options which this enables by
2390 <em>following</em> this with the appropriate commands.
2393 <dt><strong><a name="item__2d_2denable_2dxft">--enable-xft</a></strong><br />
2396 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2397 slower and require lots of memory, but as long as you don't use them, you
2401 <dt><strong><a name="item__2d_2denable_2dfont_2dstyles">--enable-font-styles</a></strong><br />
2404 Add support for <strong>bold</strong>, <em>italic</em> and <strong><em>bold italic</em> </strong>> font
2405 styles. The fonts can be set manually or automatically.
2408 <dt><strong><a name="item__2d_2dwith_2dcodesets_3dname_2c_2e_2e_2e">--with-codesets=NAME,...</a></strong><br />
2411 Compile in support for additional codeset (encoding) groups (eu, vn are
2412 always compiled in, which includes most 8-bit character sets). These
2413 codeset tables are currently only used for driving X11 core fonts, they
2414 are not required for Xft fonts. Compiling them in will make your binary
2415 bigger (together about 700kB), but it doesn't increase memory usage unless
2416 you use an X11 font requiring one of these encodings.
2419 <tr><td>all</td><td>all available codeset groups</td></tr>
2420 <tr><td>zh</td><td>common chinese encodings</td></tr>
2421 <tr><td>zh_ext</td><td>rarely used but very big chinese encodigs</td></tr>
2422 <tr><td>jp</td><td>common japanese encodings</td></tr>
2423 <tr><td>jp_ext</td><td>rarely used but big japanese encodings</td></tr>
2424 <tr><td>kr</td><td>korean encodings</td></tr>
2426 <dt><strong><a name="item__2d_2denable_2dxim">--enable-xim</a></strong><br />
2429 Add support for XIM (X Input Method) protocol. This allows using
2430 alternative input methods (e.g. kinput2) and will also correctly
2431 set up the input for people using dead keys or compose keys.
2434 <dt><strong><a name="item__2d_2denable_2dunicode3">--enable-unicode3</a></strong><br />
2437 Enable direct support for displaying unicode codepoints above
2438 65535 (the basic multilingual page). This increases storage
2439 requirements per character from 2 to 4 bytes. X11 fonts do not yet
2440 support these extra characters, but Xft does.
2443 <p>Please note that rxvt-unicode can store unicode code points >65535
2444 even without this flag, but the number of such characters is
2445 limited to a view thousand (shared with combining characters,
2446 see next switch), and right now rxvt-unicode cannot display them
2447 (input/output and cut&paste still work, though).</p>
2450 <dt><strong><a name="item__2d_2denable_2dcombining">--enable-combining</a></strong><br />
2453 Enable automatic composition of combining characters into
2454 composite characters. This is required for proper viewing of text
2455 where accents are encoded as seperate unicode characters. This is
2456 done by using precomposited characters when available or creating
2457 new pseudo-characters when no precomposed form exists.
2460 <p>Without --enable-unicode3, the number of additional precomposed
2461 characters is rather limited (2048, if this is full, rxvt will use the
2462 private use area, extending the number of combinations to 8448). With
2463 --enable-unicode3, no practical limit exists. This will also enable
2464 storage of characters >65535.</p>
2467 <p>The combining table also contains entries for arabic presentation forms,
2468 but these are not currently used. Bug me if you want these to be used.</p>
2471 <dt><strong><a name="item_fallback">--enable-fallback(=CLASS)</a></strong><br />
2474 When reading resource settings, also read settings for class CLASS
2475 (default: Rxvt). To disable resource fallback use --disable-fallback.
2478 <dt><strong><a name="item__2d_2dwith_2dres_2dname_3dname">--with-res-name=NAME</a></strong><br />
2481 Use the given name (default: urxvt) as default application name when
2482 reading resources. Specify --with-res-name=rxvt to replace rxvt.
2485 <dt><strong><a name="item__2d_2dwith_2dres_2dclass_3dclass">--with-res-class=CLASS</a></strong><br />
2488 Use the given class (default: URxvt) as default application class
2489 when reading resources. Specify --with-res-class=Rxvt to replace
2493 <dt><strong><a name="item__2d_2denable_2dutmp">--enable-utmp</a></strong><br />
2496 Write user and tty to utmp file (used by programs like <em>w</em>) at
2497 start of rxvt execution and delete information when rxvt exits.
2500 <dt><strong><a name="item__2d_2denable_2dwtmp">--enable-wtmp</a></strong><br />
2503 Write user and tty to wtmp file (used by programs like <em>last</em>) at
2504 start of rxvt execution and write logout when rxvt exits. This
2505 option requires --enable-utmp to also be specified.
2508 <dt><strong><a name="item__2d_2denable_2dlastlog">--enable-lastlog</a></strong><br />
2511 Write user and tty to lastlog file (used by programs like
2512 <em>lastlogin</em>) at start of rxvt execution. This option requires
2513 --enable-utmp to also be specified.
2516 <dt><strong><a name="item__2d_2denable_2dxpm_2dbackground">--enable-xpm-background</a></strong><br />
2519 Add support for XPM background pixmaps.
2522 <dt><strong><a name="item__2d_2denable_2dtransparency">--enable-transparency</a></strong><br />
2525 Add support for inheriting parent backgrounds thus giving a fake
2526 transparency to the term.
2529 <dt><strong><a name="item__2d_2denable_2dfading">--enable-fading</a></strong><br />
2532 Add support for fading the text when focus is lost.
2535 <dt><strong><a name="item__2d_2denable_2dtinting">--enable-tinting</a></strong><br />
2538 Add support for tinting of transparent backgrounds.
2541 <dt><strong><a name="item__2d_2denable_2dmenubar">--enable-menubar</a></strong><br />
2544 Add support for our menu bar system (this interacts badly with
2545 dynamic locale switching currently).
2548 <dt><strong><a name="item__2d_2denable_2drxvt_2dscroll">--enable-rxvt-scroll</a></strong><br />
2551 Add support for the original rxvt scrollbar.
2554 <dt><strong><a name="item__2d_2denable_2dnext_2dscroll">--enable-next-scroll</a></strong><br />
2557 Add support for a NeXT-like scrollbar.
2560 <dt><strong><a name="item__2d_2denable_2dxterm_2dscroll">--enable-xterm-scroll</a></strong><br />
2563 Add support for an Xterm-like scrollbar.
2566 <dt><strong><a name="item__2d_2denable_2dplain_2dscroll">--enable-plain-scroll</a></strong><br />
2569 Add support for a very unobtrusive, plain-looking scrollbar that
2570 is the favourite of the rxvt-unicode author, having used it for
2574 <dt><strong><a name="item__2d_2denable_2dhalf_2dshadow">--enable-half-shadow</a></strong><br />
2577 Make shadows on the scrollbar only half the normal width & height.
2578 only applicable to rxvt scrollbars.
2581 <dt><strong><a name="item__2d_2denable_2dttygid">--enable-ttygid</a></strong><br />
2584 Change tty device setting to group ``tty'' - only use this if
2585 your system uses this type of security.
2588 <dt><strong><a name="item__2d_2ddisable_2dbackspace_2dkey">--disable-backspace-key</a></strong><br />
2591 Disable any handling of the backspace key by us - let the X server
2595 <dt><strong><a name="item__2d_2ddisable_2ddelete_2dkey">--disable-delete-key</a></strong><br />
2598 Disable any handling of the delete key by us - let the X server
2602 <dt><strong><a name="item__2d_2ddisable_2dresources">--disable-resources</a></strong><br />
2605 Remove all resources checking.
2608 <dt><strong><a name="item__2d_2denable_2dxgetdefault">--enable-xgetdefault</a></strong><br />
2611 Make resources checking via <code>XGetDefault()</code> instead of our small
2612 version which only checks ~/.Xdefaults, or if that doesn't exist
2616 <dt><strong><a name="item__2d_2denable_2dstrings">--enable-strings</a></strong><br />
2619 Add support for our possibly faster <code>memset()</code> function and other
2620 various routines, overriding your system's versions which may
2621 have been hand-crafted in assembly or may require extra libraries
2622 to link in. (this breaks ANSI-C rules and has problems on many
2626 <dt><strong><a name="item__2d_2ddisable_2dswapscreen">--disable-swapscreen</a></strong><br />
2629 Remove support for swap screen.
2632 <dt><strong><a name="item__2d_2denable_2dfrills">--enable-frills</a></strong><br />
2635 Add support for many small features that are not essential but nice to
2636 have. Normally you want this, but for very small binaries you may want to
2640 <p>A non-exhaustive list of features enabled by <a href="#item__2d_2denable_2dfrills"><code>--enable-frills</code></a> (possibly
2641 in combination with other switches) is:</p>
2646 seperate underline colour
2647 settable border widths and borderless switch
2648 settable extra linespacing
2649 extra window properties (e.g. UTF-8 window names and PID)
2650 iso-14755-2 and -3, and visual feedback
2651 backindex and forwardindex escape sequence
2652 window op and locale change escape sequences
2654 settable insecure mode</pre>
2657 <dt><strong><a name="item__2d_2denable_2diso14755">--enable-iso14755</a></strong><br />
2660 Enable extended ISO 14755 support (see rxvt(1), or
2661 <em>doc/rxvt.1.txt</em>). Basic support (section 5.1) is enabled by
2662 <a href="#item__2d_2denable_2dfrills"><code>--enable-frills</code></a>, while support for 5.2, 5.3 and 5.4 is enabled with
2666 <dt><strong><a name="item__2d_2denable_2dkeepscrolling">--enable-keepscrolling</a></strong><br />
2669 Add support for continual scrolling of the display when you hold
2670 the mouse button down on a scrollbar arrow.
2673 <dt><strong><a name="item__2d_2denable_2dmousewheel">--enable-mousewheel</a></strong><br />
2676 Add support for scrolling via mouse wheel or buttons 4 & 5.
2679 <dt><strong><a name="item__2d_2denable_2dslipwheeling">--enable-slipwheeling</a></strong><br />
2682 Add support for continual scrolling (using the mouse wheel as an
2683 accelerator) while the control key is held down. This option
2684 requires --enable-mousewheel to also be specified.
2687 <dt><strong><a name="item__2d_2ddisable_2dnew_2dselection">--disable-new-selection</a></strong><br />
2690 Remove support for mouse selection style like that of xterm.
2693 <dt><strong><a name="item__2d_2denable_2ddmalloc">--enable-dmalloc</a></strong><br />
2696 Use Gray Watson's malloc - which is good for debugging See
2697 <a href="http://www.letters.com/dmalloc/">http://www.letters.com/dmalloc/</a> for details If you use either this or the
2698 next option, you may need to edit src/Makefile after compiling to point
2699 DINCLUDE and DLIB to the right places.
2702 <p>You can only use either this option and the following (should
2703 you use either) .</p>
2706 <dt><strong><a name="item__2d_2denable_2ddlmalloc">--enable-dlmalloc</a></strong><br />
2709 Use Doug Lea's malloc - which is good for a production version
2710 See <a href="http://g.oswego.edu/dl/html/malloc.html">http://g.oswego.edu/dl/html/malloc.html</a> for details.
2713 <dt><strong><a name="item__2d_2denable_2dsmart_2dresize">--enable-smart-resize</a></strong><br />
2716 Add smart growth/shrink behaviour when changing font size via from hot
2717 keys. This should keep in a fixed position the rxvt corner which is
2718 closest to a corner of the screen.
2721 <dt><strong><a name="item__2d_2denable_2dcursor_2dblink">--enable-cursor-blink</a></strong><br />
2724 Add support for a blinking cursor.
2727 <dt><strong><a name="item__2d_2denable_2dpointer_2dblank">--enable-pointer-blank</a></strong><br />
2730 Add support to have the pointer disappear when typing or inactive.
2733 <dt><strong><a name="item__2d_2dwith_2dname_3dname">--with-name=NAME</a></strong><br />
2736 Set the basename for the installed binaries (default: <code>urxvt</code>, resulting
2737 in <code>urxvt</code>, <code>urxvtd</code> etc.). Specify <code>--with-name=rxvt</code> to replace with
2741 <dt><strong><a name="item__2d_2dwith_2dterm_3dname">--with-term=NAME</a></strong><br />
2744 Change the environmental variable for the terminal to NAME (default
2745 <code>rxvt-unicode</code>)
2748 <dt><strong><a name="item__2d_2dwith_2dterminfo_3dpath">--with-terminfo=PATH</a></strong><br />
2751 Change the environmental variable for the path to the terminfo tree to
2755 <dt><strong><a name="item__2d_2dwith_2dx">--with-x</a></strong><br />
2758 Use the X Window System (pretty much default, eh?).
2761 <dt><strong><a name="item__2d_2dwith_2dxpm_2dincludes_3ddir">--with-xpm-includes=DIR</a></strong><br />
2764 Look for the XPM includes in DIR.
2767 <dt><strong><a name="item__2d_2dwith_2dxpm_2dlibrary_3ddir">--with-xpm-library=DIR</a></strong><br />
2770 Look for the XPM library in DIR.
2773 <dt><strong><a name="item__2d_2dwith_2dxpm">--with-xpm</a></strong><br />
2776 Not needed - define via --enable-xpm-background.
2782 <h1><a name="authors">AUTHORS</a></h1>
2783 <p>Marc Lehmann <<a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a>> converted this document to pod and
2784 reworked it from the original Rxvt documentation, which was done by Geoff
2785 Wing <<a href="mailto:gcw@pobox.com">gcw@pobox.com</a>>, who in turn used the XTerm documentation and other
projects / dana / urxvt.git / blob