rxvt-unicode/doc/rxvt.7.pod

=head1 NAME

RXVT REFERENCE - FAQ, command sequences and other background information

=head1 FREQUENTLY ASKED QUESTIONS

=over 4

=item How do I know which rxvt-unicode version I'm using?

The version number is displayed with the usage (-h). Also the escape
sequence C<ESC[8n> sets the window title to the version number.

=item When I log-in to another system it tells me about missing terminfo data?

The terminal description used by rxvt-unicode is not as widely available
as that for xterm, or even rxvt (for which the same problem often arises).

The correct solution for this problem is to install the terminfo, this can
be done like this (with ncurses' infocmp):

   REMOTE=remotesystem.domain
   infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"

... or by installing rxvt-unicode normally on the remote system,

If you cannot or do not want to do this, then you can simply set
C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
problems arising, which includes wrong keymapping, less and different
colours and some refresh errors in fullscreen applications. It's a nice
quick-and-dirty workaround for rare cases, though.

If you always want to do this you can either recompile rxvt-unicode with
the desired TERM value or use a resource to set it:

   URxvt.termName: rxvt

If you don't plan to use B<rxvt> (quite common...) you could also replace
the rxvt terminfo file with the rxvt-unicode one.

=item I need a termcap file entry.

You could use rxvt's termcap entry with resonable results in many cases.
You can also create a termcap entry by using terminfo's infocmp program
like this:

   infocmp -C rxvt-unicode

OR you could this termcap entry:

   rxvt-unicode|rxvt-unicode terminal (X Window System):\
           :am:bw:eo:km:mi:ms:xn:xo:\
           :co#80:it#8:li#24:\
           :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
           :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
           :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
           :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
           :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
           :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
           :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
           :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
           :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
           :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
           :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
           :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
           :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
           :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
           :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
           :vs=\E[?25h:

=item Why does C<ls> no longer have coloured output?

The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
decide wether a terminal has colour, but uses it's own configuration
file. Needless to say, C<rxvt-unicode> is not in it's default file (among
with most other terminals supporting colour). Either add:

   TERM rxvt-unicode

to C</etc/DIR_COLORS> or simply add:

   alias ls='ls --color=auto'

to your C<.profile> or C<.bashrc>.

=item Why doesn't vim/emacs etc. use the 88 colour mode?

=item Why doesn't vim/emacs etc. make use of italic?

=item Why are the secondary screen-related options not working properly?

Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
distributions (most notably Debian GNU/Linux) break rxvt-unicode
by setting C<TERM> to C<rxvt>, which doesn't have these extra
features. Unfortunately, some of these (most notably, again, Debian
GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
file, so you will need to install it on your own (See the question B<When
I log-in to another system it tells me about missing terminfo data?> on
how to do this).

=item Rxvt-unicode does not seem to understand the selected encoding?

=item Unicode does not seem to work?

If you encounter strange problems like typing an accented character but
getting two unrelated other characters or similar, or if program output is
subtly garbled, then you should check your locale settings.

Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
programs. Often rxvt-unicode is started in the C<C> locale, while the
login script running within the rxvt-unicode window changes the locale to
sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.

The best thing is to fix your startup environment, as you will likely run
into other problems. If nothing works you can try this in your .profile.

  printf '\e]701;%s\007' "$LC_CTYPE"

If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
supported on your systems. Some systems have a C<locale> command which
displays this. If it displays sth. like:

  locale: Cannot set LC_CTYPE to default locale: ...

Then the locale you specified is not supported on your system.

If nothing works and you are sure that everything is set correctly then
you will need to remember a little known fact: Some programs just don't
support locales :(

=item Why do some characters look so much different than others?

=item How does rxvt-unicode choose fonts?

Most fonts do not contain the full range of Unicode, which is
fine. Chances are that the font you (or the admin/package maintainer of
your system/os) have specified does not cover all the characters you want
to display.

B<rxvt-unicode> makes a best-effort try at finding a replacement
font. Often the result is fine, but sometimes the chosen font looks
bad. Many fonts have totally strange characters that don't resemble the
correct glyph at all, and rxvt-unicode lacks the artificial intelligence
to detect that a specific glyph is wrong: it has to believe the font that
the characters it contains indeed look correct.

In that case, select a font of your taste and add it to the font list,
e.g.:

   @@RXVT_NAME@@ -fn basefont,font2,font3...

When rxvt-unicode sees a character, it will first look at the base
font. If the base font does not contain the character, it will go to the
next font, and so on. Specifying your own fonts will also speed up this
search and use less resources within rxvt-unicode and the X-server.

The only limitation is that all the fonts must not be larger than the base
font, as the base font defines the principal cell size, which must be the
same due to the way terminals work.

=item Why do some chinese characters look so different than others?

This is because there is a difference between script and language --
rxvt-unicode does not know which language the text that is output
is, as it only knows the unicode character codes. If rxvt-unicode
first sees a japanese character, it might choose a japanese font for
it. Subsequent japanese characters will take that font. Now, many chinese
characters aren't represented in japanese fonts, so when the first
non-japanese character comes up, rxvt-unicode will look for a chinese font
-- unfortunately at this point, it will still use the japanese font for
japanese characters that are also chinese.

The workaround is easy: just tag a chinese font at the end of your font
list (see the previous question). The key is to view the font list as
a preference list: If you expect more japanese, list a japanese font
first. If you expect more chinese, put a chinese font first.

In the future it might be possible to switch preferences at runtime (the
internal data structure has no problem with using different fonts for
the same character at the same time, but no interface for this has been
designed yet).

=item Why does rxvt-unicode sometimes leave pixel droppings?

Most fonts were not designed for terminal use, which means that character
size varies a lot. A font that is otherwise fine for terminal use might
contain some characters that are simply too wide. Rxvt-unicode will avoid
these characters. For characters that are just "a bit" too wide a special
"careful" rendering mode is used that redraws adjacent characters.

All of this requires that fonts do not lie about character sizes,
however: Xft fonts often draw glyphs larger than their acclaimed bounding
box, and rxvt-unicode has no way of detecting this (the correct way is to
ask for the character bounding box, which unfortunately is wrong in these
cases).

It's not clear (to me at least), wether this is a bug in Xft, freetype,
or the respective font. If you encounter this problem you might try using
the C<-lsp> option to give the font more height. If that doesn't work, you
might be forced to use a different font.

All of this is not a problem when using X11 core fonts, as their bounding
box data is correct.

=item My Compose (Multi_key) key is no longer working.

The most common causes for this are that either your locale is not set
correctly, or you specified a B<preeditStyle> that is not supported by
your input method. For example, if you specified B<OverTheSpot> and
your input method (e.g. the default input method handling Compose keys)
does not support this (for instance because it is not visual), then
rxvt-unicode will continue without an input method.

In this case either do not specify a B<preeditStyle> or specify more than
one pre-edit style, such as B<OverTheSpot,Root,None>.

=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755

Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
international keyboards) or simply use ISO 14755 support to your
advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
character and so on.

=item How can I keep rxvt-unicode from using reverse video so much?

First of all, make sure you are running with the right terminfo
(C<urxvt>), which will get rid of most of these effects. Then make sure
you have specified colours for italic and bold, as otherwise rxvt-unicode
might use reverse video to simulate the effect:

   URxvt*colorBD:  white
   URxvt*colorIT:  green

=item Some programs assume totally weird colours (red instead of blue), how can I fix that?

For some unexplainable reason, some programs (i.e. irssi) assume a very
weird colour palette when confronted with a terminal with more than the
standard 8 colours (rxvt-unicode supports 88). The right fix is, of
course, to fix these programs not to assume non-ISO colours without very
good reasons.

In the meantime, you can either edit your C<urxvt> terminfo definition to
only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
but keep you from using other rxvt-unicode features.

=item I am on FreeBSD and rxvt-unicode does not seem to work at all.

Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
in your compile environment, or an implementation that implements it,
wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
B<wchar_t> is represented as unicode.

As you might have guessed, FreeBSD does neither define this symobl nor
does it support it. Instead, it uses it's own internal representation of
B<wchar_t>. This is, of course, completely legal.

However, C<__STDC_ISO_10646__> is the only sane way to support
multi-language apps in an OS, as using a locale-dependent (and
non-standardized) representation of B<wchar_t> makes it impossible to
convert between B<wchar_t> (as used by X11 and your applications) and any
other encoding without implementing OS-specific-wrappers for each and
every locale. There simply are no APIs to convert B<wchar_t> into anything
except the current locale encoding.

Some applications (such as the formidable B<mlterm>) work around this
by carrying their own replacement functions for character set handling
with them, and either implementing OS-dependent hacks or doing multiple
conversions (which is slow and unreliable in case the OS implements
encodings slightly different than the terminal emulator).

The rxvt-unicode author insists that the right way to fix this is in the
system libraries once and for all, instead of forcing every app to carry
complete replacements.

=item How does rxvt-unicode determine the encoding to use?

=item Is there an option to switch encodings?

Unlike some other terminals, rxvt-unicode has no encoding switch, and no
specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
UTF-8 or any other encodings with respect to terminal I/O.

The reasons is that there exists a perfectly fine mechanism for selecting
the encoding, doing I/O and (most important) communicating this to all
applications so everybody agrees on character properties such as width and
code number. This mechanism is the I<locale>.

Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
programs doing the same (that is, most) will automatically agree in the
interpretation of characters.

Unfortunately, there is no system-independent way to select locales, nor
is there a standard on how locale specifiers will look like.

On most systems, the content of the C<LC_CTYPE> environment variable
contains an arbitrary string which corresponds to an already-installed
locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
(i.e. C<de> or C<german>) are also common.

Rxvt-unicode ignores all other locale categories, and except for
the encoding, ignores country or language-specific settings,
i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.

If you want to use a specific encoding you have to make sure you start
rxvt-unicode with the correct C<LC_CTYPE> category.

=item Can I switch locales at runtime?

Yes, using an escape sequence. Try sth. like this, which sets
rxvt-unicode's idea of C<LC_CTYPE>.

  printf '\e]701;%s\007' ja_JP.SJIS

See also the previous question.

Sometimes this capability is rather handy when you want to work in one
locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
example, I use this script to start C<xjdic>, which first switches to a
locale supported by xjdic and back later:

   printf '\e]701;%s\007' ja_JP.SJIS
   xjdic -js
   printf '\e]701;%s\007' de_DE.UTF-8

=item Can I switch the fonts at runtime?

Yes, using an escape sequence. Try sth. like this, which has the same
effect as using the C<-fn> switch, and takes effect immediately:

   printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"

This is useful if you e.g. work primarily with japanese (and prefer a
japanese font), but you have to switch to chinese temporarily, where
japanese fonts would only be in your way.

You can think of this as a kind of manual ISO-2022 switching.

=item Why do italic characters look as if clipped?

Many fonts have difficulties with italic characters and hinting. For
example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
Mono> completely fails in it's italic face. A workaround is to enable
freetype autohinting, i.e. like this:

   URxvt*italicFont:        xft:Bitstream Vera Sans Mono:italic:autohint=true
   URxvt*boldItalicFont:    xft:Bitstream Vera Sans Mono:bold:italic:autohint=true

=item My input method wants <some encoding> but I want UTF-8, what can I do?

You can specify separate locales for the input method and the rest of the
terminal, using the resource C<imlocale>:

   URxvt*imlocale: ja_JP.EUC-JP

Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
use your input method. Please note, however, that you will not be able to
input characters outside C<EUC-JP> in a normal way then, as your input
method limits you.

=item Rxvt-unicode uses gobs of memory, how can I reduce that?

Rxvt-unicode tries to obey the rule of not charging you for sth. you
don't use. One thing you should try is to configure out all settings that
you don't need, for example, Xft support is a resource hog by design,
when used. Compiling it out ensures that no Xft font will be loaded
accidentally when rxvt-unicode tries to find a font for your characters.

Also, many people (me included) like large windows and even larger
scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6 bytes per screen cell. For a 160x?? window this amounts to almost a
kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
rxvt-unicode then uses 8 bytes per screen cell.

=item Can I speed up Xft rendering somehow?

Yes, the most obvious way to speed it up is to avoid Xft entirely, as
it is simply slow. If you still want Xft fonts you might try to disable
antialiasing (by appending C<:antialiasing=false>), which saves lots of
memory and also speeds up rendering considerably.

=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?

Rxvt-unicode will use whatever you specify as a font. If it needs to
fall back to it's default font search list it will prefer X11 core
fonts, because they are small and fast, and then use Xft fonts. It has
antialiasing disabled for most of them, because the author thinks they
look best that way.

If you want antialiasing, you have to specify the fonts manually.

=item Mouse cut/paste suddenly no longer works.

Make sure that mouse reporting is actually turned off since killing
some editors prematurely may leave the mouse in mouse report mode. I've
heard that tcsh may use mouse reporting unless it otherwise specified. A
quick check is to see if cut/paste works when the Alt or Shift keys are
depressed. See @@RXVT_NAME@@(7)

=item What's with this bold/blink stuff?

If no bold colour is set via C<colorBD:>, bold will invert text using the
standard foreground colour.

For the standard background colour, blinking will actually make the
text blink when compiled with C<--enable-blinking>. with standard
colours. Without C<--enable-blinking>, the blink attribute will be
ignored.

On ANSI colours, bold/blink attributes are used to set high-intensity
foreground/background colors.

color0-7 are the low-intensity colors.

color8-15 are the corresponding high-intensity colors.

=item I don't like the screen colors.  How do I change them?

You can change the screen colors at run-time using F<~/.Xdefaults>
resources (or as long-options).

Here are values that are supposed to resemble a VGA screen,
including the murky brown that passes for low-intensity yellow:

   URxvt*color0:   #000000
   URxvt*color1:   #A80000
   URxvt*color2:   #00A800
   URxvt*color3:   #A8A800
   URxvt*color4:   #0000A8
   URxvt*color5:   #A800A8
   URxvt*color6:   #00A8A8
   URxvt*color7:   #A8A8A8

   URxvt*color8:   #000054
   URxvt*color9:   #FF0054
   URxvt*color10:  #00FF54
   URxvt*color11:  #FFFF54
   URxvt*color12:  #0000FF
   URxvt*color13:  #FF00FF
   URxvt*color14:  #00FFFF
   URxvt*color15:  #FFFFFF

And here is a more complete set of non-standard colors described as
"pretty girly":

   URxvt.cursorColor:  #dc74d1
   URxvt.pointerColor: #dc74d1
   URxvt.background:   #0e0e0e
   URxvt.foreground:   #4ad5e1
   URxvt.color0:       #000000
   URxvt.color8:       #8b8f93
   URxvt.color1:       #dc74d1
   URxvt.color9:       #dc74d1
   URxvt.color2:       #0eb8c7
   URxvt.color10:      #0eb8c7
   URxvt.color3:       #dfe37e
   URxvt.color11:      #dfe37e
   URxvt.color5:       #9e88f0
   URxvt.color13:      #9e88f0
   URxvt.color6:       #73f7ff
   URxvt.color14:      #73f7ff
   URxvt.color7:       #e1dddd
   URxvt.color15:      #e1dddd

=item What's with the strange Backspace/Delete key behaviour?

Assuming that the physical Backspace key corresponds to the
BackSpace keysym (not likely for Linux ... see the following
question) there are two standard values that can be used for
Backspace: C<^H> and C<^?>.

Historically, either value is correct, but rxvt-unicode adopts the debian
policy of using C<^?> when unsure, because it's the one only only correct
choice :).

Rxvt-unicode tries to inherit the current stty settings and uses the value
of `erase' to guess the value for backspace.  If rxvt-unicode wasn't
started from a terminal (say, from a menu or by remote shell), then the
system value of `erase', which corresponds to CERASE in <termios.h>, will
be used (which may not be the same as your stty setting).

For starting a new rxvt-unicode:

   # use Backspace = ^H
   $ stty erase ^H
   $ @@RXVT_NAME@@

   # use Backspace = ^?
   $ stty erase ^?
   $ @@RXVT_NAME@@

Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).

For an existing rxvt-unicode:

   # use Backspace = ^H
   $ stty erase ^H
   $ echo -n "^[[36h"

   # use Backspace = ^?
   $ stty erase ^?
   $ echo -n "^[[36l"

This helps satisfy some of the Backspace discrepancies that occur, but
if you use Backspace = C<^H>, make sure that the termcap/terminfo value
properly reflects that.

The Delete key is a another casualty of the ill-defined Backspace problem.
To avoid confusion between the Backspace and Delete keys, the Delete
key has been assigned an escape sequence to match the vt100 for Execute
(ESC[3~) and is in the supplied termcap/terminfo.

Some other Backspace problems:

some editors use termcap/terminfo,
some editors (vim I'm told) expect Backspace = ^H,
GNU Emacs (and Emacs-like editors) use ^H for help.

Perhaps someday this will all be resolved in a consistent manner.

=item I don't like the key-bindings.  How do I change them?

There are some compile-time selections available via configure. Unless
you have run "configure" with the C<--disable-resources> option you can
use the `keysym' resource to alter the keystrings associated with keysyms.

Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt'

        URxvt*keysym.Home:          \e[1~
        URxvt*keysym.End:           \e[4~
        URxvt*keysym.C-apostrophe:  \e<C-'>
        URxvt*keysym.C-slash:       \e<C-/>
        URxvt*keysym.C-semicolon:   \e<C-;>
        URxvt*keysym.C-grave:       \e<C-`>
        URxvt*keysym.C-comma:       \e<C-,>
        URxvt*keysym.C-period:      \e<C-.>
        URxvt*keysym.C-0x60:        \e<C-`>
        URxvt*keysym.C-Tab:         \e<C-Tab>
        URxvt*keysym.C-Return:      \e<C-Return>
        URxvt*keysym.S-Return:      \e<S-Return>
        URxvt*keysym.S-space:       \e<S-Space>
        URxvt*keysym.M-Up:          \e<M-Up>
        URxvt*keysym.M-Down:        \e<M-Down>
        URxvt*keysym.M-Left:        \e<M-Left>
        URxvt*keysym.M-Right:       \e<M-Right>
        URxvt*keysym.M-C-0:         list.0123456789.\e<M-C-.>
        URxvt*keysym.M-C-a:         list.abcdefghijklmnopqrstuvwxyz.\033<M-C-.>
        URxvt*keysym.F12:           proto:\033]701;zh_CN.GBK\007

=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
How do I make use of them?  For example, the Sun Keyboard type 4
has the following mappings that rxvt-unicode doesn't recognize.

   KP_Insert == Insert
   F22 == Print
   F27 == Home
   F29 == Prior
   F33 == End
   F35 == Next

Rather than have rxvt-unicode try to accommodate all the various possible keyboard
mappings, it is better to use `xmodmap' to remap the keys as required for
your particular machine.

=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
I need this to decide about setting colors etc.

rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
check and see if that is set. Note that several programs, JED, slrn,
Midnight Commander automatically check this variable to decide whether or
not to use color.

=item How do I set the correct, full IP address for the DISPLAY variable?

If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
insecure mode then it is possible to use the following shell script
snippets to correctly set the display. If your version of rxvt-unicode
wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
the COLORTERM variable can be used to distinguish rxvt-unicode from a
regular xterm.

Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
snippets:

   # Bourne/Korn/POSIX family of shells:
   [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
   if [ ${TERM:-foo} = xterm ]; then
      stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
      echo -n '^[Z'
      read term_id
      stty icanon echo
      if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
         echo -n '^[[7n'        # query the rxvt we are in for the DISPLAY string
         read DISPLAY           # set it in our local shell
      fi
   fi

=item How do I compile the manual pages for myself?

You need to have a recent version of perl installed as F</usr/bin/perl>,
one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
the doc subdirectory and enter C<make alldoc>.

=item My question isn't answered here, can I ask a human?

Before sending me mail, you could go to IRC: C<irc.freenode.net>,
channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
interested in learning about new and exciting problems (but not FAQs :).

=back

=head1 SYNOPSIS

   # set a new font set
   printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"

   # change the locale and tell rxvt-unicode about it
   export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"

   # set window title
   printf '\33]2;%s\007' "new window title"

=head1 DESCRIPTION

The rest of this document describes various technical aspects of
B<rxvt-unicode>. First the description of supported command sequences,
followed by menu and pixmap support and last by a description of all
features selectable at C<configure> time.

=head1 RXVT TECHNICAL REFERENCE

=head1 Definitions

=over 4

=item B<< C<c> >>

The literal character c.

=item B<< C<C> >>

A single (required) character.

=item B<< C<Ps> >>

A single (usually optional) numeric parameter, composed of one or more
digits.

=item B<< C<Pm> >>

A multiple numeric parameter composed of any number of single numeric
parameters, separated by C<;> character(s).

=item B<< C<Pt> >>

A text parameter composed of printable characters.

=back

=head1 Values

=over 4

=item B<< C<ENQ> >>

Enquiry (Ctrl-E) = Send Device Attributes (DA)
request attributes from terminal. See B<< C<ESC [ Ps c> >>.

=item B<< C<BEL> >>

Bell (Ctrl-G)

=item B<< C<BS> >>

Backspace (Ctrl-H)

=item B<< C<TAB> >>

Horizontal Tab (HT) (Ctrl-I)

=item B<< C<LF> >>

Line Feed or New Line (NL) (Ctrl-J)

=item B<< C<VT> >>

Vertical Tab (Ctrl-K) same as B<< C<LF> >>

=item B<< C<FF> >>

Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>

=item B<< C<CR> >>

Carriage Return (Ctrl-M)

=item B<< C<SO> >>

Shift Out (Ctrl-N), invokes the G1 character set.
Switch to Alternate Character Set

=item B<< C<SI> >>

Shift In (Ctrl-O), invokes the G0 character set (the default).
Switch to Standard Character Set

=item B<< C<SPC> >>

Space Character

=back

=head1 Escape Sequences

=over 4

=item B<< C<ESC # 8> >>

DEC Screen Alignment Test (DECALN)

=item B<< C<ESC 7> >>

Save Cursor (SC)

=item B<< C<ESC 8> >>

Restore Cursor

=item B<< C<ESC => >>

Application Keypad (SMKX). See also next sequence.

=item B<<< C<< ESC >> >>>

Normal Keypad (RMKX)

B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
pressed, numbers or control functions are generated by the numeric keypad
(see Key Codes).

=item B<< C<ESC D> >>

Index (IND)

=item B<< C<ESC E> >>

Next Line (NEL)

=item B<< C<ESC H> >>

Tab Set (HTS)

=item B<< C<ESC M> >>

Reverse Index (RI)

=item B<< C<ESC N> >>

Single Shift Select of G2 Character Set (SS2): affects next character
only I<unimplemented>

=item B<< C<ESC O> >>

Single Shift Select of G3 Character Set (SS3): affects next character
only I<unimplemented>

=item B<< C<ESC Z> >>

Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>

=item B<< C<ESC c> >>

Full reset (RIS)

=item B<< C<ESC n> >>

Invoke the G2 Character Set (LS2)

=item B<< C<ESC o> >>

Invoke the G3 Character Set (LS3)

=item B<< C<ESC> ( C> >>

Designate G0 Character Set (ISO 2022), see below for values of C<C>.

=item B<< C<ESC> ) C> >>

Designate G1 Character Set (ISO 2022), see below for values of C<C>.

=item B<< C<ESC * C> >>

Designate G2 Character Set (ISO 2022), see below for values of C<C>.

=item B<< C<ESC + C> >>

Designate G3 Character Set (ISO 2022), see below for values of C<C>.

=item B<< C<ESC $ C> >>

Designate Kanji Character Set

Where B<< C<C> >> is one of:

=begin table

        C = C<0>        DEC Special Character and Line Drawing Set
        C = C<A>        United Kingdom (UK)
        C = C<B>        United States (USASCII)
        C = C<< < >>    Multinational character set I<unimplemented>
        C = C<5>        Finnish character set I<unimplemented>
        C = C<C>        Finnish character set I<unimplemented>
        C = C<K>        German character set I<unimplemented>

=end table

=back

X<CSI>

=head1 CSI (Command Sequence Introducer) Sequences

=over 4

=item B<< C<ESC [ Ps @> >>

Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>

=item B<< C<ESC [ Ps A> >>

Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)

=item B<< C<ESC [ Ps B> >>

Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>

=item B<< C<ESC [ Ps C> >>

Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)

=item B<< C<ESC [ Ps D> >>

Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)

=item B<< C<ESC [ Ps E> >>

Cursor Down B<< C<Ps> >> Times [default: 1] and to first column

=item B<< C<ESC [ Ps F> >>

Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>

=item B<< C<ESC [ Ps G> >>

Cursor to Column B<< C<Ps> >> (HPA)

=item B<< C<ESC [ Ps;Ps H> >>

Cursor Position [row;column] [default: 1;1] (CUP)

=item B<< C<ESC [ Ps I> >>

Move forward B<< C<Ps> >> tab stops [default: 1]

=item B<< C<ESC [ Ps J> >>

Erase in Display (ED)

=begin table

        B<< C<Ps = 0> >>        Clear Below (default)
        B<< C<Ps = 1> >>        Clear Above
        B<< C<Ps = 2> >>        Clear All

=end table

=item B<< C<ESC [ Ps K> >>

Erase in Line (EL)

=begin table

        B<< C<Ps = 0> >>        Clear to Right (default)
        B<< C<Ps = 1> >>        Clear to Left
        B<< C<Ps = 2> >>        Clear All

=end table

=item B<< C<ESC [ Ps L> >>

Insert B<< C<Ps> >> Line(s) [default: 1] (IL)

=item B<< C<ESC [ Ps M> >>

Delete B<< C<Ps> >> Line(s) [default: 1] (DL)

=item B<< C<ESC [ Ps P> >>

Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)

=item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>

Initiate . I<unimplemented> Parameters are
[func;startx;starty;firstrow;lastrow].

=item B<< C<ESC [ Ps W> >>

Tabulator functions

=begin table

        B<< C<Ps = 0> >>        Tab Set (HTS)
        B<< C<Ps = 2> >>        Tab Clear (TBC), Clear Current Column (default)
        B<< C<Ps = 5> >>        Tab Clear (TBC), Clear All

=end table

=item B<< C<ESC [ Ps X> >>

Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)

=item B<< C<ESC [ Ps Z> >>

Move backward B<< C<Ps> >> [default: 1] tab stops

=item B<< C<ESC [ Ps '> >>

See B<< C<ESC [ Ps G> >>

=item B<< C<ESC [ Ps a> >>

See B<< C<ESC [ Ps C> >>

=item B<< C<ESC [ Ps c> >>

Send Device Attributes (DA)
B<< C<Ps = 0> >> (or omitted): request attributes from terminal
returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video
Option'')

=item B<< C<ESC [ Ps d> >>

Cursor to Line B<< C<Ps> >> (VPA)

=item B<< C<ESC [ Ps e> >>

See B<< C<ESC [ Ps A> >>

=item B<< C<ESC [ Ps;Ps f> >>

Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]

=item B<< C<ESC [ Ps g> >>

Tab Clear (TBC)

=begin table

        B<< C<Ps = 0> >>        Clear Current Column (default)
        B<< C<Ps = 3> >>        Clear All (TBC)

=end table

=item B<< C<ESC [ Pm h> >>

Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.

=item B<< C<ESC [ Ps i> >>

Printing. See also the C<print-pipe> resource.

=begin table

        B<< C<Ps = 0> >>        print screen (MC0)
        B<< C<Ps = 4> >>        disable transparent print mode (MC4)
        B<< C<Ps = 5> >>        enable transparent print mode (MC5)

=end table

=item B<< C<ESC [ Pm l> >>

Reset Mode (RM)

=over 4

=item B<< C<Ps = 4> >>

=begin table

        B<< C<h> >>     Insert Mode (SMIR)
        B<< C<l> >>     Replace Mode (RMIR)

=end table

=item B<< C<Ps = 20> >> (partially implemented)

=begin table

        B<< C<h> >>     Automatic Newline (LNM)
        B<< C<l> >>     Normal Linefeed (LNM)

=end table

=back

=item B<< C<ESC [ Pm m> >>

Character Attributes (SGR)

=begin table

        B<< C<Ps = 0> >>        Normal (default)
        B<< C<Ps = 1 / 21> >>   On / Off Bold (bright fg)
        B<< C<Ps = 3 / 23> >>   On / Off Italic
        B<< C<Ps = 4 / 24> >>   On / Off Underline
        B<< C<Ps = 5 / 25> >>   On / Off Slow Blink (bright bg)
        B<< C<Ps = 6 / 26> >>   On / Off Rapid Blink (bright bg)
        B<< C<Ps = 7 / 27> >>   On / Off Inverse
        B<< C<Ps = 8 / 27> >>   On / Off Invisible (NYI)
        B<< C<Ps = 30 / 40> >>  fg/bg Black
        B<< C<Ps = 31 / 41> >>  fg/bg Red
        B<< C<Ps = 32 / 42> >>  fg/bg Green
        B<< C<Ps = 33 / 43> >>  fg/bg Yellow
        B<< C<Ps = 34 / 44> >>  fg/bg Blue
        B<< C<Ps = 35 / 45> >>  fg/bg Magenta
        B<< C<Ps = 36 / 46> >>  fg/bg Cyan
        B<< C<Ps = 38;5 / 48;5> >>      set fg/bg to color #m (ISO 8613-6)
        B<< C<Ps = 37 / 47> >>  fg/bg White
        B<< C<Ps = 39 / 49> >>  fg/bg Default
        B<< C<Ps = 90 / 100> >> fg/bg Bright Black
        B<< C<Ps = 91 / 101> >> fg/bg Bright Red
        B<< C<Ps = 92 / 102> >> fg/bg Bright Green
        B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
        B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
        B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
        B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
        B<< C<Ps = 97 / 107> >> fg/bg Bright White
        B<< C<Ps = 99 / 109> >> fg/bg Bright Default

=end table

=item B<< C<ESC [ Ps n> >>

Device Status Report (DSR)

=begin table

        B<< C<Ps = 5> >>        Status Report B<< C<ESC [ 0 n> >> (``OK'')
        B<< C<Ps = 6> >>        Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
        B<< C<Ps = 7> >>        Request Display Name
        B<< C<Ps = 8> >>        Request Version Number (place in window title)

=end table

=item B<< C<ESC [ Ps;Ps r> >>

Set Scrolling Region [top;bottom]
[default: full size of window] (CSR)

=item B<< C<ESC [ s> >>

Save Cursor (SC)

=item B<< C<ESC [ Ps x> >>

Request Terminal Parameters (DECREQTPARM)

=item B<< C<ESC [ u> >>

Restore Cursor

=back

X<PrivateModes>

=head1 DEC Private Modes

=over 4

=item B<< C<ESC [ ? Pm h> >>

DEC Private Mode Set (DECSET)

=item B<< C<ESC [ ? Pm l> >>

DEC Private Mode Reset (DECRST)

=item B<< C<ESC [ ? Pm r> >>

Restore previously saved DEC Private Mode Values.

=item B<< C<ESC [ ? Pm s> >>

Save DEC Private Mode Values.

=item B<< C<ESC [ ? Pm t> >>

Toggle DEC Private Mode Values (rxvt extension). I<where>

=over 4

=item B<< C<Ps = 1> >> (DECCKM)

=begin table

        B<< C<h> >>     Application Cursor Keys
        B<< C<l> >>     Normal Cursor Keys

=end table

=item B<< C<Ps = 2> >> (ANSI/VT52 mode)

=begin table

        B<< C<h> >>     Enter VT52 mode
        B<< C<l> >>     Enter VT52 mode

=end table

=item B<< C<Ps = 3> >>

=begin table

        B<< C<h> >>     132 Column Mode (DECCOLM)
        B<< C<l> >>     80 Column Mode (DECCOLM)

=end table

=item B<< C<Ps = 4> >>

=begin table

        B<< C<h> >>     Smooth (Slow) Scroll (DECSCLM)
        B<< C<l> >>     Jump (Fast) Scroll (DECSCLM)

=end table

=item B<< C<Ps = 5> >>

=begin table

        B<< C<h> >>     Reverse Video (DECSCNM)
        B<< C<l> >>     Normal Video (DECSCNM)

=end table

=item B<< C<Ps = 6> >>

=begin table

        B<< C<h> >>     Origin Mode (DECOM)
        B<< C<l> >>     Normal Cursor Mode (DECOM)

=end table

=item B<< C<Ps = 7> >>

=begin table

        B<< C<h> >>     Wraparound Mode (DECAWM)
        B<< C<l> >>     No Wraparound Mode (DECAWM)

=end table

=item B<< C<Ps = 8> >> I<unimplemented>

=begin table

        B<< C<h> >>     Auto-repeat Keys (DECARM)
        B<< C<l> >>     No Auto-repeat Keys (DECARM)

=end table

=item B<< C<Ps = 9> >> X10 XTerm

=begin table

        B<< C<h> >>     Send Mouse X & Y on button press.
        B<< C<l> >>     No mouse reporting.

=end table

=item B<< C<Ps = 10> >> (B<rxvt>)

=begin table

        B<< C<h> >>     menuBar visible
        B<< C<l> >>     menuBar invisible

=end table

=item B<< C<Ps = 25> >>

=begin table

        B<< C<h> >>     Visible cursor {cnorm/cvvis}
        B<< C<l> >>     Invisible cursor {civis}

=end table

=item B<< C<Ps = 30> >>

=begin table

        B<< C<h> >>     scrollBar visisble
        B<< C<l> >>     scrollBar invisisble

=end table

=item B<< C<Ps = 35> >> (B<rxvt>)

=begin table

        B<< C<h> >>     Allow XTerm Shift+key sequences
        B<< C<l> >>     Disallow XTerm Shift+key sequences

=end table

=item B<< C<Ps = 38> >> I<unimplemented>

Enter Tektronix Mode (DECTEK)

=item B<< C<Ps = 40> >>

=begin table

        B<< C<h> >>     Allow 80/132 Mode
        B<< C<l> >>     Disallow 80/132 Mode

=end table

=item B<< C<Ps = 44> >> I<unimplemented>

=begin table

        B<< C<h> >>     Turn On Margin Bell
        B<< C<l> >>     Turn Off Margin Bell

=end table

=item B<< C<Ps = 45> >> I<unimplemented>

=begin table

        B<< C<h> >>     Reverse-wraparound Mode
        B<< C<l> >>     No Reverse-wraparound Mode

=end table

=item B<< C<Ps = 46> >> I<unimplemented>

=item B<< C<Ps = 47> >>

=begin table

        B<< C<h> >>     Use Alternate Screen Buffer
        B<< C<l> >>     Use Normal Screen Buffer

=end table

X<Priv66>

=item B<< C<Ps = 66> >>

=begin table

        B<< C<h> >>     Application Keypad (DECPAM) == C<ESC =>
        B<< C<l> >>     Normal Keypad (DECPNM) == C<< ESC > >>

=end table

=item B<< C<Ps = 67> >>

=begin table

        B<< C<h> >>     Backspace key sends B<< C<BS> (DECBKM) >>
        B<< C<l> >>     Backspace key sends B<< C<DEL> >>

=end table

=item B<< C<Ps = 1000> >> (X11 XTerm)

=begin table

        B<< C<h> >>     Send Mouse X & Y on button press and release.
        B<< C<l> >>     No mouse reporting.

=end table

=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>

=begin table

        B<< C<h> >>     Use Hilite Mouse Tracking.
        B<< C<l> >>     No mouse reporting.

=end table

=item B<< C<Ps = 1010> >> (B<rxvt>)

=begin table

        B<< C<h> >>     Don't scroll to bottom on TTY output
        B<< C<l> >>     Scroll to bottom on TTY output

=end table

=item B<< C<Ps = 1011> >> (B<rxvt>)

=begin table

        B<< C<h> >>     Scroll to bottom when a key is pressed
        B<< C<l> >>     Don't scroll to bottom when a key is pressed

=end table

=item B<< C<Ps = 1047> >>

=begin table

        B<< C<h> >>     Use Alternate Screen Buffer
        B<< C<l> >>     Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it

=end table

=item B<< C<Ps = 1048> >>

=begin table

        B<< C<h> >>     Save cursor position
        B<< C<l> >>     Restore cursor position

=end table

=item B<< C<Ps = 1049> >>

=begin table

        B<< C<h> >>     Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
        B<< C<l> >>     Use Normal Screen Buffer

=end table

=back

=back

X<XTerm>

=head1 XTerm Operating System Commands

=over 4

=item B<< C<ESC ] Ps;Pt ST> >>

Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
B<octet> can be escaped by prefixing it with SYN (0x16, ^V).

=begin table

        B<< C<Ps = 0> >>        Change Icon Name and Window Title to B<< C<Pt> >>
        B<< C<Ps = 1> >>        Change Icon Name to B<< C<Pt> >>
        B<< C<Ps = 2> >>        Change Window Title to B<< C<Pt> >>
        B<< C<Ps = 3> >>        If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
        B<< C<Ps = 4> >>        B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<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
        B<< C<Ps = 10> >>       Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
        B<< C<Ps = 11> >>       Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
        B<< C<Ps = 12> >>       Change colour of text cursor foreground to B<< C<Pt> >>
        B<< C<Ps = 13> >>       Change colour of mouse foreground to B<< C<Pt> >>
        B<< C<Ps = 17> >>       Change colour of highlight characters to B<< C<Pt> >>
        B<< C<Ps = 18> >>       Change colour of bold characters to B<< C<Pt> >>
        B<< C<Ps = 19> >>       Change colour of underlined characters to B<< C<Pt> >>
        B<< C<Ps = 20> >>       Change default background to B<< C<Pt> >>
        B<< C<Ps = 39> >>       Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
        B<< C<Ps = 46> >>       Change Log File to B<< C<Pt> >> I<unimplemented>
        B<< C<Ps = 49> >>       Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
        B<< C<Ps = 50> >>       Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
        B<< C<Ps = 55> >>       Log all scrollback buffer and all of screen to B<< C<Pt> >>
        B<< C<Ps = 701> >>      Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension)
        B<< C<Ps = 703> >>      Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
        B<< C<Ps = 704> >>      Change colour of italic characters to B<< C<Pt> >>
        B<< C<Ps = 705> >>      Change background pixmap tint colour to B<< C<Pt> >>
        B<< C<Ps = 710> >>      Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
        B<< C<Ps = 711> >>      Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
        B<< C<Ps = 712> >>      Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
        B<< C<Ps = 713> >>      Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.

=end table

=back

X<menuBar>

=head1 menuBar

B<< The exact syntax used is I<almost> solidified. >>
In the menus, B<DON'T> try to use menuBar commands that add or remove a
menuBar.

Note that in all of the commands, the B<< I</path/> >> I<cannot> be
omitted: use B<./> to specify a menu relative to the current menu.

=head2 Overview of menuBar operation

For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
of C<Pt> can be used for a variety of tasks:

At the top level is the current menuBar which is a member of a circular
linked-list of other such menuBars.

The menuBar acts as a parent for the various drop-down menus, which in
turn, may have labels, separator lines, menuItems and subMenus.

The menuItems are the useful bits: you can use them to mimic keyboard
input or even to send text or escape sequences back to rxvt.

The menuBar syntax is intended to provide a simple yet robust method of
constructing and manipulating menus and navigating through the
menuBars.

The first step is to use the tag B<< [menu:I<name>] >> which creates
the menuBar called I<name> and allows access. You may now or menus,
subMenus, and menuItems. Finally, use the tag B<[done]> to set the
menuBar access as B<readonly> to prevent accidental corruption of the
menus. To re-access the current menuBar for alterations, use the tag
B<[menu]>, make the alterations and then use B<[done]>

X<menuBarCommands>

=head2 Commands

=over 4

=item B<< [menu:+I<name>] >>

access the named menuBar for creation or alteration. If a new menuBar
is created, it is called I<name> (max of 15 chars) and the current
menuBar is pushed onto the stack

=item B<[menu]>

access the current menuBar for alteration

=item B<< [title:+I<string>] >>

set the current menuBar's title to I<string>, which may contain the
following format specifiers:
B<%%> : literal B<%> character
B<%n> : rxvt name (as per the B<-name> command-line option)
B<%v> : rxvt version

=item B<[done]>

set menuBar access as B<readonly>.
End-of-file tag for B<< [read:+I<file>] >> operations.

=item B<< [read:+I<file>] >>

read menu commands directly from I<file> (extension ".menu" will be
appended if required.) Start reading at a line with B<[menu]> or B<<
[menu:+I<name> >> and continuing until B<[done]> is encountered.

Blank and comment lines (starting with B<#>) are ignored. Actually,
since any invalid menu commands are also ignored, almost anything could
be construed as a comment line, but this may be tightened up in the
future ... so don't count on it!.

=item B<< [read:+I<file>;+I<name>] >>

The same as B<< [read:+I<file>] >>, but start reading at a line with
B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
B<[done]> is encountered.

=item B<[dump]>

dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
later rereading.

=item B<[rm:name]>

remove the named menuBar

=item B<[rm] [rm:]>

remove the current menuBar

=item B<[rm*] [rm:*]>

remove all menuBars

=item B<[swap]>

swap the top two menuBars

=item B<[prev]>

access the previous menuBar

=item B<[next]>

access the next menuBar

=item B<[show]>

Enable display of the menuBar

=item B<[hide]>

Disable display of the menuBar

=item B<< [pixmap:+I<name>] >>

=item B<< [pixmap:+I<name>;I<scaling>] >>

(set the background pixmap globally

B<< A Future implementation I<may> make this local to the menubar >>)

=item B<< [:+I<command>:] >>

ignore the menu readonly status and issue a I<command> to or a menu or
menuitem or change the ; a useful shortcut for setting the quick arrows
from a menuBar.

=back

X<menuBarAdd>

=head2 Adding and accessing menus

The following commands may also be B<+> prefixed.

=over 4

=item B</+>

access menuBar top level

=item B<./+>

access current menu level

=item B<../+>

access parent menu (1 level up)

=item B<../../>

access parent menu (multiple levels up)

=item B<< I</path/>menu >>

add/access menu

=item B<< I</path/>menu/* >>

add/access menu and clear it if it exists

=item B<< I</path/>{-} >>

add separator

=item B<< I</path/>{item} >>

add B<item> as a label

=item B<< I</path/>{item} action >>

add/alter I<menuitem> with an associated I<action>

=item B<< I</path/>{item}{right-text} >>

add/alter I<menuitem> with B<right-text> as the right-justified text
and as the associated I<action>

=item B<< I</path/>{item}{rtext} action >>

add/alter I<menuitem> with an associated I<action> and with B<rtext> as
the right-justified text.

=back

=over 4

=item Special characters in I<action> must be backslash-escaped:

B<\a \b \E \e \n \r \t \octal>

=item or in control-character notation:

B<^@, ^A .. ^Z .. ^_, ^?>

=back

To send a string starting with a B<NUL> (B<^@>) character to the
program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
the first of which will be stripped off and the balance directed to the
program. Otherwise if I<action> begins with B<NUL> followed by
non-+B<NUL> characters, the leading B<NUL> is stripped off and the
balance is sent back to rxvt.

As a convenience for the many Emacs-type editors, I<action> may start
with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
appended if missed from B<M-x> commands.

As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
quick arrow), a B<BEL> (B<^G>) will be appended if needed.

=over 4

=item For example,

B<M-xapropos> is equivalent to B<\Exapropos\r>

=item and

B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>

=back

The option B<< {I<right-rtext>} >> will be right-justified. In the
absence of a specified action, this text will be used as the I<action>
as well.

=over 4

=item For example,

B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>

=back

The left label I<is> necessary, since it's used for matching, but
implicitly hiding the left label (by using same name for both left and
right labels), or explicitly hiding the left label (by preceeding it
with a dot), makes it possible to have right-justified text only.

=over 4

=item For example,

B</File/{Open}{Open} Open-File-Action>

=item or hiding it

B</File/{.anylabel}{Open} Open-File-Action>

=back

X<menuBarRemove>

=head2 Removing menus

=over 4

=item B<< -/*+ >>

remove all menus from the menuBar, the same as B<[clear]>

=item B<< -+I</path>menu+ >>

remove menu

=item B<< -+I</path>{item}+ >>

remove item

=item B<< -+I</path>{-} >>

remove separator)

=item B<-/path/menu/*>

remove all items, separators and submenus from menu

=back

X<menuBarArrows>

=head2 Quick Arrows

The menus also provide a hook for I<quick arrows> to provide easier
user access. If nothing has been explicitly set, the default is to
emulate the curror keys. The syntax permits each arrow to be altered
individually or all four at once without re-entering their common
beginning/end text. For example, to explicitly associate cursor actions
with the arrows, any of the following forms could be used:

=over 4

=item B<< <r>+I<Right> >>

=item B<< <l>+I<Left> >>

=item B<< <u>+I<Up> >>

=item B<< <d>+I<Down> >>

Define actions for the respective arrow buttons

=item B<< <b>+I<Begin> >>

=item B<< <e>+I<End> >>

Define common beginning/end parts for I<quick arrows> which used in
conjunction with the above <r> <l> <u> <d> constructs

=back

=over 4

=item For example, define arrows individually,

 <u>\E[A

 <d>\E[B

 <r>\E[C

 <l>\E[D

=item or all at once

 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D

=item or more compactly (factoring out common parts)

 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D

=back

X<menuBarSummary>

=head2 Command Summary

A short summary of the most I<common> commands:

=over 4

=item [menu:name]

use an existing named menuBar or start a new one

=item [menu]

use the current menuBar

=item [title:string]

set menuBar title

=item [done]

set menu access to readonly and, if reading from a file, signal EOF

=item [done:name]

if reading from a file using [read:file;name] signal EOF

=item [rm:name]

remove named menuBar(s)

=item [rm] [rm:]

remove current menuBar

=item [rm*] [rm:*]

remove all menuBar(s)

=item [swap]

swap top two menuBars

=item [prev]

access the previous menuBar

=item [next]

access the next menuBar

=item [show]

map menuBar

=item [hide]

unmap menuBar

=item [pixmap;file]

=item [pixmap;file;scaling]

set a background pixmap

=item [read:file]

=item [read:file;name]

read in a menu from a file

=item [dump]

dump out all menuBars to /tmp/rxvt-PID

=item /

access menuBar top level

=item ./

=item ../

=item ../../

access current or parent menu level

=item /path/menu

add/access menu

=item /path/{-}

add separator

=item /path/{item}{rtext} action

add/alter menu item

=item -/*

remove all menus from the menuBar

=item -/path/menu

remove menu items, separators and submenus from menu

=item -/path/menu

remove menu

=item -/path/{item}

remove item

=item -/path/{-}

remove separator

=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End

menu quick arrows

=back
X<XPM>

=head1 XPM

For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
of B<< C<Pt> >> can be the name of the background pixmap followed by a
sequence of scaling/positioning commands separated by semi-colons. The
scaling/positioning commands are as follows:

=over 4

=item query scale/position

B<?>

=item change scale and position

B<WxH+X+Y>

B<WxH+X> (== B<WxH+X+X>)

B<WxH> (same as B<WxH+50+50>)

B<W+X+Y> (same as B<WxW+X+Y>)

B<W+X> (same as B<WxW+X+X>)

B<W> (same as B<WxW+50+50>)

=item change position (absolute)

B<=+X+Y>

B<=+X> (same as B<=+X+Y>)

=item change position (relative)

B<+X+Y>

B<+X> (same as B<+X+Y>)

=item rescale (relative)

B<Wx0> -> B<W *= (W/100)>

B<0xH> -> B<H *= (H/100)>

=back

For example:

=over 4

=item B<\E]20;funky\a>

load B<funky.xpm> as a tiled image

=item B<\E]20;mona;100\a>

load B<mona.xpm> with a scaling of 100%

=item B<\E]20;;200;?\a>

rescale the current pixmap to 200% and display the image geometry in
the title

=back
X<Mouse>

=head1 Mouse Reporting

=over 4

=item B<< C<< ESC [ M <b> <x> <y> >> >>

report mouse position

=back

The lower 2 bits of B<< C<< <b> >> >> indicate the button:

=over 4

=item Button = B<< C<< (<b> - SPACE) & 3 >> >>

=begin table

        0       Button1 pressed
        1       Button2 pressed
        2       Button3 pressed
        3       button released (X11 mouse report)

=end table

=back

The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
button was pressed and are added together (X11 mouse report only):

=over 4

=item State = B<< C<< (<b> - SPACE) & 60 >> >>

=begin table

        4       Shift
        8       Meta
        16      Control
        32      Double Click I<(Rxvt extension)>

=end table

Col = B<< C<< <x> - SPACE >> >>

Row = B<< C<< <y> - SPACE >> >>

=back
X<KeyCodes>

=head1 Key Codes

Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>

For the keypad, use B<Shift> to temporarily override Application-Keypad
setting use B<Num_Lock> to toggle Application-Keypad setting if
B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
values of B<Home>, B<End>, B<Delete> may have been compiled differently on
your system.

=begin table

                B<Normal>       B<Shift>        B<Control>      B<Ctrl+Shift>
        Tab     ^I      ESC [ Z ^I      ESC [ Z
        BackSpace       ^H      ^?      ^?      ^?
        Find    ESC [ 1 ~       ESC [ 1 $       ESC [ 1 ^       ESC [ 1 @
        Insert  ESC [ 2 ~       I<paste>        ESC [ 2 ^       ESC [ 2 @
        Execute ESC [ 3 ~       ESC [ 3 $       ESC [ 3 ^       ESC [ 3 @
        Select  ESC [ 4 ~       ESC [ 4 $       ESC [ 4 ^       ESC [ 4 @
        Prior   ESC [ 5 ~       I<scroll-up>    ESC [ 5 ^       ESC [ 5 @
        Next    ESC [ 6 ~       I<scroll-down>  ESC [ 6 ^       ESC [ 6 @
        Home    ESC [ 7 ~       ESC [ 7 $       ESC [ 7 ^       ESC [ 7 @
        End     ESC [ 8 ~       ESC [ 8 $       ESC [ 8 ^       ESC [ 8 @
        Delete  ESC [ 3 ~       ESC [ 3 $       ESC [ 3 ^       ESC [ 3 @
        F1      ESC [ 11 ~      ESC [ 23 ~      ESC [ 11 ^      ESC [ 23 ^
        F2      ESC [ 12 ~      ESC [ 24 ~      ESC [ 12 ^      ESC [ 24 ^
        F3      ESC [ 13 ~      ESC [ 25 ~      ESC [ 13 ^      ESC [ 25 ^
        F4      ESC [ 14 ~      ESC [ 26 ~      ESC [ 14 ^      ESC [ 26 ^
        F5      ESC [ 15 ~      ESC [ 28 ~      ESC [ 15 ^      ESC [ 28 ^
        F6      ESC [ 17 ~      ESC [ 29 ~      ESC [ 17 ^      ESC [ 29 ^
        F7      ESC [ 18 ~      ESC [ 31 ~      ESC [ 18 ^      ESC [ 31 ^
        F8      ESC [ 19 ~      ESC [ 32 ~      ESC [ 19 ^      ESC [ 32 ^
        F9      ESC [ 20 ~      ESC [ 33 ~      ESC [ 20 ^      ESC [ 33 ^
        F10     ESC [ 21 ~      ESC [ 34 ~      ESC [ 21 ^      ESC [ 34 ^
        F11     ESC [ 23 ~      ESC [ 23 $      ESC [ 23 ^      ESC [ 23 @
        F12     ESC [ 24 ~      ESC [ 24 $      ESC [ 24 ^      ESC [ 24 @
        F13     ESC [ 25 ~      ESC [ 25 $      ESC [ 25 ^      ESC [ 25 @
        F14     ESC [ 26 ~      ESC [ 26 $      ESC [ 26 ^      ESC [ 26 @
        F15 (Help)      ESC [ 28 ~      ESC [ 28 $      ESC [ 28 ^      ESC [ 28 @
        F16 (Menu)      ESC [ 29 ~      ESC [ 29 $      ESC [ 29 ^      ESC [ 29 @
        F17     ESC [ 31 ~      ESC [ 31 $      ESC [ 31 ^      ESC [ 31 @
        F18     ESC [ 32 ~      ESC [ 32 $      ESC [ 32 ^      ESC [ 32 @
        F19     ESC [ 33 ~      ESC [ 33 $      ESC [ 33 ^      ESC [ 33 @
        F20     ESC [ 34 ~      ESC [ 34 $      ESC [ 34 ^      ESC [ 34 @
                                        B<Application>
        Up      ESC [ A ESC [ a ESC O a ESC O A
        Down    ESC [ B ESC [ b ESC O b ESC O B
        Right   ESC [ C ESC [ c ESC O c ESC O C
        Left    ESC [ D ESC [ d ESC O d ESC O D
        KP_Enter        ^M                      ESC O M
        KP_F1   ESC O P                 ESC O P
        KP_F2   ESC O Q                 ESC O Q
        KP_F3   ESC O R                 ESC O R
        KP_F4   ESC O S                 ESC O S
        XK_KP_Multiply  *                       ESC O j
        XK_KP_Add       +                       ESC O k
        XK_KP_Separator ,                       ESC O l
        XK_KP_Subtract  -                       ESC O m
        XK_KP_Decimal   .                       ESC O n
        XK_KP_Divide    /                       ESC O o
        XK_KP_0 0                       ESC O p
        XK_KP_1 1                       ESC O q
        XK_KP_2 2                       ESC O r
        XK_KP_3 3                       ESC O s
        XK_KP_4 4                       ESC O t
        XK_KP_5 5                       ESC O u
        XK_KP_6 6                       ESC O v
        XK_KP_7 7                       ESC O w
        XK_KP_8 8                       ESC O x
        XK_KP_9 9                       ESC O y

=end table

=head1 CONFIGURE OPTIONS

General hint: if you get compile errors, then likely your configuration
hasn't been tested well. Either try with --enable-everything or use the
./reconf script as a base for experiments. ./reconf is used by myself,
so it should generally be a working config. Of course, you should always
report when a combination doesn't work, so it can be fixed. Marc Lehmann
<rxvt@schmorp.de>.

=over 4

=item --enable-everything

Add support for all non-multichoice options listed in "./configure
--help". Note that unlike other enable options this is order dependant.
You can specify this and then disable options which this enables by
I<following> this with the appropriate commands.

=item --enable-xft

Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
slower and require lots of memory, but as long as you don't use them, you
don't pay for them.

=item --enable-font-styles

Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
styles. The fonts can be set manually or automatically.

=item --with-codesets=NAME,...

Compile in support for additional codeset (encoding) groups (eu, vn are
always compiled in, which includes most 8-bit character sets). These
codeset tables are currently only used for driving X11 core fonts, they
are not required for Xft fonts. Compiling them in will make your binary
bigger (together about 700kB), but it doesn't increase memory usage unless
you use an X11 font requiring one of these encodings.

=begin table

        all     all available codeset groups
        zh      common chinese encodings
        zh_ext  rarely used but very big chinese encodigs
        jp      common japanese encodings
        jp_ext  rarely used but big japanese encodings
        kr      korean encodings

=end table

=item --enable-xim

Add support for XIM (X Input Method) protocol. This allows using
alternative input methods (e.g. kinput2) and will also correctly
set up the input for people using dead keys or compose keys.

=item --enable-unicode3

Enable direct support for displaying unicode codepoints above
65535 (the basic multilingual page). This increases storage
requirements per character from 2 to 4 bytes. X11 fonts do not yet
support these extra characters, but Xft does.

Please note that rxvt-unicode can store unicode code points >65535
even without this flag, but the number of such characters is
limited to a view thousand (shared with combining characters,
see next switch), and right now rxvt-unicode cannot display them
(input/output and cut&paste still work, though).

=item --enable-combining

Enable automatic composition of combining characters into
composite characters. This is required for proper viewing of text
where accents are encoded as seperate unicode characters. This is
done by using precomposited characters when available or creating
new pseudo-characters when no precomposed form exists.

Without --enable-unicode3, the number of additional precomposed
characters is rather limited (2048, if this is full, rxvt will use the
private use area, extending the number of combinations to 8448). With
--enable-unicode3, no practical limit exists. This will also enable
storage of characters >65535.

The combining table also contains entries for arabic presentation forms,
but these are not currently used. Bug me if you want these to be used.

=item --enable-fallback(=CLASS)

When reading resource settings, also read settings for class CLASS
(default: Rxvt). To disable resource fallback use --disable-fallback.

=item --with-res-name=NAME

Use the given name (default: urxvt) as default application name when
reading resources. Specify --with-res-name=rxvt to replace rxvt.

=item --with-res-class=CLASS

Use the given class (default: URxvt) as default application class
when reading resources.  Specify --with-res-class=Rxvt to replace
rxvt.

=item --enable-utmp

Write user and tty to utmp file (used by programs like F<w>) at
start of rxvt execution and delete information when rxvt exits.

=item --enable-wtmp

Write user and tty to wtmp file (used by programs like F<last>) at
start of rxvt execution and write logout when rxvt exits.  This
option requires --enable-utmp to also be specified.

=item --enable-lastlog

Write user and tty to lastlog file (used by programs like
F<lastlogin>) at start of rxvt execution.  This option requires
--enable-utmp to also be specified.

=item --enable-xpm-background

Add support for XPM background pixmaps.

=item --enable-transparency

Add support for inheriting parent backgrounds thus giving a fake
transparency to the term.

=item --enable-fading

Add support for fading the text when focus is lost.

=item --enable-tinting

Add support for tinting of transparent backgrounds.

=item --enable-menubar

Add support for our menu bar system (this interacts badly with
dynamic locale switching currently).

=item --enable-rxvt-scroll

Add support for the original rxvt scrollbar.

=item --enable-next-scroll

Add support for a NeXT-like scrollbar.

=item --enable-xterm-scroll

Add support for an Xterm-like scrollbar.

=item --enable-plain-scroll

Add support for a very unobtrusive, plain-looking scrollbar that
is the favourite of the rxvt-unicode author, having used it for
many years.

=item --enable-half-shadow

Make shadows on the scrollbar only half the normal width & height.
only applicable to rxvt scrollbars.

=item --enable-ttygid

Change tty device setting to group "tty" - only use this if
your system uses this type of security.

=item --disable-backspace-key

Disable any handling of the backspace key by us - let the X server
do it.

=item --disable-delete-key

Disable any handling of the delete key by us - let the X server
do it.

=item --disable-resources

Remove all resources checking.

=item --enable-xgetdefault

Make resources checking via XGetDefault() instead of our small
version which only checks ~/.Xdefaults, or if that doesn't exist
then ~/.Xresources.

=item --enable-strings

Add support for our possibly faster memset() function and other
various routines, overriding your system's versions which may
have been hand-crafted in assembly or may require extra libraries
to link in. (this breaks ANSI-C rules and has problems on many
GNU/Linux systems).

=item --disable-swapscreen

Remove support for swap screen.

=item --enable-frills

Add support for many small features that are not essential but nice to
have. Normally you want this, but for very small binaries you may want to
disable this.

A non-exhaustive list of features enabled by C<--enable-frills> (possibly
in combination with other switches) is:

  MWM-hints
  seperate underline colour
  settable border widths and borderless switch
  settable extra linespacing
  extra window properties (e.g. UTF-8 window names and PID)
  iso-14755-2 and -3, and visual feedback
  backindex and forwardindex escape sequence
  window op and locale change escape sequences
  tripleclickwords
  settable insecure mode

=item --enable-iso14755

Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
this switch.

=item --enable-keepscrolling

Add support for continual scrolling of the display when you hold
the mouse button down on a scrollbar arrow.

=item --enable-mousewheel

Add support for scrolling via mouse wheel or buttons 4 & 5.

=item --enable-slipwheeling

Add support for continual scrolling (using the mouse wheel as an
accelerator) while the control key is held down.  This option
requires --enable-mousewheel to also be specified.

=item --disable-new-selection

Remove support for mouse selection style like that of xterm.

=item --enable-dmalloc

Use Gray Watson's malloc - which is good for debugging See
http://www.letters.com/dmalloc/ for details If you use either this or the
next option, you may need to edit src/Makefile after compiling to point
DINCLUDE and DLIB to the right places.

You can only use either this option and the following (should
you use either) .

=item --enable-dlmalloc

Use Doug Lea's malloc - which is good for a production version
See L<http://g.oswego.edu/dl/html/malloc.html> for details.

=item --enable-smart-resize

Add smart growth/shrink behaviour when changing font size via from hot
keys. This should keep in a fixed position the rxvt corner which is
closest to a corner of the screen.

=item --enable-cursor-blink

Add support for a blinking cursor.

=item --enable-pointer-blank

Add support to have the pointer disappear when typing or inactive.

=item --with-name=NAME

Set the basename for the installed binaries (default: C<urxvt>, resulting
in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
C<rxvt>.

=item --with-term=NAME

Change the environmental variable for the terminal to NAME (default
C<rxvt-unicode>)

=item --with-terminfo=PATH

Change the environmental variable for the path to the terminfo tree to
PATH.

=item --with-x

Use the X Window System (pretty much default, eh?).

=item --with-xpm-includes=DIR

Look for the XPM includes in DIR.

=item --with-xpm-library=DIR

Look for the XPM library in DIR.

=item --with-xpm

Not needed - define via --enable-xpm-background.

=back

=head1 AUTHORS

Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
reworked it from the original Rxvt documentation, which was done by Geoff
Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
sources.

Revision:	1.33
Committed:	Sun Jan 16 18:48:04 2005 UTC (19 years, 5 months ago) by root
Branch:	MAIN
CVS Tags:	rel-4_8
Changes since 1.29:	+71 -56 lines
Log Message:	* empty log message *