or changed rxvt behaviour to make it more compatible to xterm (usually
xfree86's xterm).
+TODO: VERIFY bugfix for keyboard.C changes.
+TODO: maybe just output the error and continue on x errors
+TODO: safer command: keymap processing.
TODO: read property sequence is broken with respect to utf-8 etc.
WISH: keyboard modification via esc-sequences.
WISH: line-rewrapping on resize
WISH: tabbed windows (hey, just use screen...)
WISH: just for fun, do shade and tint with XRender.
+5.0 Fri Feb 11 18:31:48 CET 2005
+ - document a race-free hack to start urxvtd.
+ - document all(?) environment variables used and set by rxvt.
+ - bring xgetdefault-style resource file ordering more in line with
+ Xt, and document it in rxvt(1).
+ - correctly use screen-dependent resources when --enable-xgetdefault,
+ and also fix some memory bugs (thanks to Thierry Reding for
+ his patience and time in tracking this down).
+ - bring own resource parsing more in line with X resource parsing,
+ most notably, don't remove double quotes.
+ - compile fix for freebsd (no ut_id) (Thierry Thomas).
+ - clean up utmp and pty on X I/O errors and signals (idea
+ by Joël Riou).
+ - "un"document -xrm, it never really worked, was only
+ available with --enable-xgetdefault, is not necessary
+ and is surprisingly hard to implement.
+ - shaved off some code segment size.
+ - various code cleanups.
+ - more keysym-mapping fixes.
+
4.9 Thu Feb 3 09:52:03 CET 2005
- nuke out utmp entries completely. Should be fixed in
original rxvt, too. (reported by James Michael Fultz).
- for core fonts, use ascent + descent when a font is loaded,
and PIXEL_SIZE when not. when loading a font, iterate until a
font has been found that _really_ fits the height (reported and
- tested by Roch).
+ tested by Olivier Wittenberg).
- set IUTF8 input flag, when defined (linux-2.6.5+).
- only define _XOPEN_SOURCE on solaris.
- autogenerate src/* dependency list.
FREQUENTLY ASKED QUESTIONS
How do I know which rxvt-unicode version I'm using?
The version number is displayed with the usage (-h). Also the escape
- sequence "ESC[8n" sets the window title to the version number.
+ sequence "ESC [ 8 n" sets the window title to the version number.
+
+ I am using Debian GNU/Linux and have a problem...
+ The Debian GNU/Linux package of rxvt-unicode contains large patches
+ that considerably change the behaviour of rxvt-unicode. Before
+ reporting a bug to the original rxvt-unicode author please download
+ and install the genuine version
+ (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the
+ problem. If you cannot, chances are that the problems are specific
+ to Debian GNU/Linux, in which case it should be reported via the
+ Debian Bug Tracking System (use "reportbug" to report the bug).
+
+ For other problems that also affect the Debian package, you can and
+ probably should use the Debian BTS, too, because, after all, it's
+ also a bug in the Debian version and it serves as a reminder for
+ other users that might encounter the same issue.
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
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:
+ If you always want to do this (and are fine with the consequences)
+ 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 rxvt (quite common...) you could also
replace the rxvt terminfo file with the rxvt-unicode one.
+ "bash"'s readline does not work correctly under rxvt.
I need a termcap file entry.
+ One reason you might want this is that some distributions or
+ operating systems still compile some programs using the
+ long-obsoleted termcap (Fedora Core's bash is one example) and rely
+ on a termcap entry for "rxvt-unicode".
+
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:
+ Or you could use this termcap entry, generated by the command above:
rxvt-unicode|rxvt-unicode terminal (X Window System):\
:am:bw:eo:km:mi:ms:xn:xo:\
log-in to another system it tells me about missing terminfo data? on
how to do this).
+ My numerical keypad acts weird and generates differing output?
+ Some Debian GNUL/Linux users seem to have this problem, although no
+ specific details were reported so far. It is possible that this is
+ caused by the wrong "TERM" setting, although the details of wether
+ and how this can happen are unknown, as "TERM=rxvt" should offer a
+ compatible keymap. See the answer to the previous question, and
+ please report if that helped.
+
Rxvt-unicode does not seem to understand the selected encoding?
Unicode does not seem to work?
If you encounter strange problems like typing an accented character
Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
programs. Often rxvt-unicode is started in the "C" locale, while the
login script running within the rxvt-unicode window changes the
- locale to sth. else, e.h. "en_GB.UTF-8". Needless to say, this is
- not going to work.
+ locale to something else, e.g. "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
If this doesn't work, then maybe you use a "LC_CTYPE" specification
not supported on your systems. Some systems have a "locale" command
- which displays this. If it displays sth. like:
+ which displays this (also, "perl -e0" can be used to check locale
+ settings, as it will complain loudly if it cannot set the locale).
+ If it displays something like:
locale: Cannot set LC_CTYPE to default locale: ...
want to display.
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.
+ Often the result is fine, but sometimes the chosen font looks
+ bad/ugly/wrong. Some 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 claims to contain
+ indeed look correct.
In that case, select a font of your taste and add it to the font
list, e.g.:
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.
+ The only limitation is that none of the fonts may be larger than the
+ base font, as the base font defines the terminal character cell
+ size, which must be the same due to the way terminals work.
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.
+ first sees a japanese/chinese character, it might choose a japanese
+ font for display. Subsequent japanese characters will use 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 chinese characters that are also in
+ the japanese font.
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
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).
+ In the future it might be possible to switch language 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).
+
+ Until then, you might get away with switching fonts at runtime (see
+ "Can I switch the fonts at runtime?" later in this document).
Why does rxvt-unicode sometimes leave pixel droppings?
Most fonts were not designed for terminal use, which means that
telnet escape character and so on.
How can I keep rxvt-unicode from using reverse video so much?
- First of all, make sure you are running with the right terminfo
- ("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:
+ First of all, make sure you are running with the right terminal
+ settings ("TERM=rxvt-unicode"), 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
+ URxvt.colorBD: white
+ URxvt.colorIT: green
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.
+ For some unexplainable reason, some rare programs 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 "urxvt" terminfo
+ In the meantime, you can either edit your "rxvt-unicode" terminfo
definition to only claim 8 colour support or use "TERM=rxvt", which
will fix colours but keep you from using other rxvt-unicode
features.
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 wchar_t. This is, of course, completely legal.
+ representation of wchar_t. This is, of course, completely fine with
+ respect to standards.
However, "__STDC_ISO_10646__" is the only sane way to support
multi-language apps in an OS, as using a locale-dependent (and
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.
+ to carry complete replacements for them :)
How does rxvt-unicode determine the encoding to use?
Is there an option to switch encodings?
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 *locale*.
+ Applications not using that info will have problems (for example,
+ "xterm" gets the width of characters wrong as it uses it's own,
+ locale-independent table under all locales).
Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding.
All programs doing the same (that is, most) will automatically agree
Rxvt-unicode ignores all other locale categories, and except for the
encoding, ignores country or language-specific settings, i.e.
- "de_DE.UTF-8" and "ja_JP.UTF-8" are the same for rxvt-unicode.
+ "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to
+ rxvt-unicode.
If you want to use a specific encoding you have to make sure you
start rxvt-unicode with the correct "LC_CTYPE" category.
Can I switch locales at runtime?
- Yes, using an escape sequence. Try sth. like this, which sets
+ Yes, using an escape sequence. Try something like this, which sets
rxvt-unicode's idea of "LC_CTYPE".
printf '\e]701;%s\007' ja_JP.SJIS
- See also the previous question.
+ See also the previous answer.
Sometimes this capability is rather handy when you want to work in
- one locale (e.g. "de_DE.UTF-8") but some programs don't support
- UTF-8. For example, I use this script to start "xjdic", which first
- switches to a locale supported by xjdic and back later:
+ one locale (e.g. "de_DE.UTF-8") but some programs don't support it
+ (e.g. UTF-8). For example, I use this script to start "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
+ You can also use xterm's "luit" program, which usually works fine,
+ except for some locales where character width differs between
+ program- and rxvt-unicode-locales.
+
Can I switch the fonts at runtime?
- Yes, using an escape sequence. Try sth. like this, which has the
- same effect as using the "-fn" switch, and takes effect immediately:
+ Yes, using an escape sequence. Try something like this, which has
+ the same effect as using the "-fn" switch, and takes effect
+ immediately:
printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
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 "xft:Bitstream Vera
- Sans Mono" completely fails in it's italic face. A workaround is to
- enable freetype autohinting, i.e. like this:
+ Sans Mono" completely fails in it's italic face. A workaround might
+ be 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
+ URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
+ URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
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
as your input method limits you.
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.
+ Rxvt-unicode tries to obey the rule of not charging you for
+ something 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 "--enable-unicode3", rxvt-unicode will
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.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
+ (not by me) as "pretty girly".
URxvt.cursorColor: #dc74d1
URxvt.pointerColor: #dc74d1
URxvt.color7: #e1dddd
URxvt.color15: #e1dddd
+ How can I start rxvtd in a race-free way?
+ Despite it's name, rxvtd is not a real daemon, but more like a
+ server that answers rxvtc's requests, so it doesn't background
+ itself.
+
+ To ensure rxvtd is listening on it's socket, you can use the
+ following method to wait for the startup message before continuing:
+
+ { rxvtd & } | read
+
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
$ stty erase ^?
$ rxvt
- Toggle with "ESC[36h" / "ESC[36l" as documented in rxvt(7).
+ Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7).
For an existing rxvt-unicode:
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.
+ vt100 for Execute ("ESC [ 3 ~") and is in the supplied
+ termcap/terminfo.
Some other Backspace problems:
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
- 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 \e<M-C- 0123456789 >
+ Here's an example for a URxvt session started using "rxvt -name
+ URxvt"
+
+ URxvt.keysym.Home: \033[1~
+ URxvt.keysym.End: \033[4~
+ URxvt.keysym.C-apostrophe: \033<C-'>
+ URxvt.keysym.C-slash: \033<C-/>
+ URxvt.keysym.C-semicolon: \033<C-;>
+ URxvt.keysym.C-grave: \033<C-`>
+ URxvt.keysym.C-comma: \033<C-,>
+ URxvt.keysym.C-period: \033<C-.>
+ URxvt.keysym.C-0x60: \033<C-`>
+ URxvt.keysym.C-Tab: \033<C-Tab>
+ URxvt.keysym.C-Return: \033<C-Return>
+ URxvt.keysym.S-Return: \033<S-Return>
+ URxvt.keysym.S-space: \033<S-Space>
+ URxvt.keysym.M-Up: \033<M-Up>
+ URxvt.keysym.M-Down: \033<M-Down>
+ URxvt.keysym.M-Left: \033<M-Left>
+ URxvt.keysym.M-Right: \033<M-Right>
+ URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
- URxvt.keysym.F12: proto:\033]701;zh_CN.GBK\007
+ URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
See some more examples in the documentation for the keysym resource.
possible keyboard mappings, it is better to use `xmodmap' to remap
the keys as required for your particular machine.
- How do I distinguish if I'm running rxvt-unicode or a regular xterm? I
- need this to decide about setting colors etc.
+ How do I distinguish wether 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
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
-<p><strong>rxvt-unicode</strong>, version <strong>4.9</strong>, is a colour vt102 terminal
+<p><strong>rxvt-unicode</strong>, version <strong>5.0</strong>, is a colour vt102 terminal
emulator intended as an <em>xterm</em>(1) replacement for users who do not
require features such as Tektronix 4014 emulation and toolkit-style
configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
</p>
<hr />
<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
-<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of frequently
-asked questions and answer to them and some common problems.</p>
+<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
+frequently asked questions and answer to them and some common
+problems. That document is also accessible on the World-Wide-Web at
+<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p>
<p>
</p>
<hr />
<strong>secondaryScroll</strong>.
</dd>
<p></p>
+<dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
+</dt>
+<dd>
+Remap a key symbol. See resource <strong>keysym</strong>.
+</dd>
+<p></p>
<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br />
</dt>
<dd>
Xresource data: using the X libraries (Xrm*-functions) or internal
Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
-resources using X11 tools like <strong>xset</strong>. Many distribution do also load
-settings from the <strong>~/.Xresources</strong> file when X starts.</p>
+resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
+settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
+will consult the following files/resources in order, with later settings
+overwriting earlier ones:</p>
+<pre>
+ 1. system-wide app-defaults file, either locale-dependent OR global
+ 2. app-defaults file in $XAPPLRESDIR
+ 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+ 4. SCREEN_RESOURCES for the current screen
+ 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename></pre>
<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
set in XAPPLOADDIR/URxvt (compile-time defined: usually
can start or end with whitespace.</p>
</dd>
<dd>
+<p>Please note that you need to double the <code>\</code> when using
+<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
+use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
+rxvt's own processing).</p>
+</dd>
+<dd>
<p>You can define a range of keysyms in one shot by providing a <em>string</em>
with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
should be a character not used by the strings.</p>
</dd>
<dd>
<pre>
- URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|></pre>
+ URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|></pre>
</dd>
<dd>
<p>The above line is equivalent to the following three lines:</p>
</dd>
<dd>
<pre>
- URxvt.keysym.Meta-Control-0x61: \e<M-C-a>
- URxvt.keysym.Meta-Control-0x62: \e<M-C-b>
- URxvt.keysym.Meta-Control-0x63: \e<M-C-c></pre>
+ URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
+ URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
+ URxvt.keysym.Meta-Control-0x63: \033<M-C-c></pre>
</dd>
<dd>
-<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong>
+<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
is interpreted and executed as rxvt's control sequence. For
example the following means ``change the current locale to <code>zh_CN.GBK</code>
when Control-Meta-c is being pressed'':</p>
</dd>
<dd>
<pre>
- URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre>
+ URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
</dd>
<dd>
<p>The following example will map Control-Meta-1 and Control-Meta-2 to
-the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you cna have some limited
+the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
font-switching at runtime:</p>
</dd>
<dd>
<pre>
- URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007
- URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre>
+ URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
+ URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
+</dd>
+<dd>
+<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
+info):</p>
</dd>
<dd>
-<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to
-<code>zh_CN.GBK</code>.</p>
+<pre>
+ URxvt.keysym.M-C-3: command:\033[8;25;80t
+ URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
</dd>
<p></p></dl>
<p>
(Alt) key while performing the desired mouse action.</p>
<p>If mouse reporting mode is active, the normal scrollbar actions are
disabled -- on the assumption that we are using a fullscreen
-application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong>
-(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the
-up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down),
+application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
+(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
+up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
respectively.</p>
<p>
</p>
</p>
<hr />
<h1><a name="environment">ENVIRONMENT</a></h1>
-<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong>
-and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X
-window id number of the <strong>rxvt</strong> window and it also uses and
-sets the environment variable <strong>DISPLAY</strong> to specify which display
-terminal to use. <strong>rxvt</strong> uses the environment variables
-<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p>
+<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
+<dl>
+<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
+</dt>
+<dd>
+Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
+resources or on the commandline.
+</dd>
+<p></p>
+<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
+</dt>
+<dd>
+Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
+compiled with XPM support, and optionally with the added extension
+<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
+</dd>
+<p></p>
+<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
+</dt>
+<dd>
+Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
+the colour code used as default foreground/text colour (or the string
+<code>default</code> to indicate that the default-colour escape sequence is to be
+used), <code>bg</code> is the colour code used as default background colour (or the
+string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
+was compiled with XPM support. Libraries like <code>slang</code> can (and do) use
+this information to optimize screen output.
+</dd>
+<p></p>
+<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
+</dt>
+<dd>
+Set to the (decimal) X Window ID of the rxvt window (the toplevel
+window, which usually has subwindows for the scrollbar, the terminal
+window and so on).
+</dd>
+<p></p>
+<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
+</dt>
+<dd>
+Set to the terminfo directory iff rxvt was configured with
+<code>--with-terminfo=PATH</code>.
+</dd>
+<p></p>
+<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
+</dt>
+<dd>
+Used by rxvt to connect to the display and set to the correct
+display in it's child processes.
+</dd>
+<p></p>
+<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
+</dt>
+<dd>
+The shell to be used for command execution, defaults to <code>/bin/sh</code>.
+</dd>
+<p></p>
+<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
+</dt>
+<dd>
+The path where rxvt looks for support files such as menu and xpm
+files.
+</dd>
+<p></p>
+<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
+</dt>
+<dd>
+Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
+</dd>
+<p></p>
+<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
+</dt>
+<dd>
+The unix domain socket path used by <code>rxvtc(1)</code> and
+rxvtd(1).
+</dd>
+<dd>
+<p>Default <code>$HOME/.rxvt-unicode-<nodename</code>.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
+</dt>
+<dd>
+Used to locate the default directory for the unix domain socket for
+daemon communications and to locate various resource files (such as
+<code>.Xdefaults</code>)
+</dd>
+<p></p>
+<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
+</dt>
+<dd>
+Directory where various X resource files are being located.
+</dd>
+<p></p>
+<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
+</dt>
+<dd>
+If set and accessible, gives the name of a X resource file to be loaded by
+rxvt.
+</dd>
+<p></p></dl>
<p>
</p>
<hr />
<dd>
Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
</dd>
-<p></p>
-<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
-</dt>
-<dd>
-Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
-</dd>
<dd>
<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p>
</dd>
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
-. ds C`
-. ds C'
+. ds C` ""
+. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
.\" ========================================================================
.\"
.IX Title "rxvt 1"
-.TH rxvt 1 "2005-02-03" "4.9" "RXVT-UNICODE"
+.TH rxvt 1 "2005-02-11" "5.0" "RXVT-UNICODE"
.SH "NAME"
rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
.SH "SYNOPSIS"
a significant advantage on a machine serving many X sessions.
.SH "FREQUENTLY ASKED QUESTIONS"
.IX Header "FREQUENTLY ASKED QUESTIONS"
-See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of frequently
-asked questions and answer to them and some common problems.
+See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
+frequently asked questions and answer to them and some common
+problems. That document is also accessible on the World-Wide-Web at
+<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
.SH "RXVT-UNICODE VS. RXVT"
.IX Header "RXVT-UNICODE VS. RXVT"
Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
.IX Item "-ssr|+ssr"
Turn on/off secondary screen scroll (default enabled); resource
\&\fBsecondaryScroll\fR.
+.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4
+.IX Item "-keysym.sym: string"
+Remap a key symbol. See resource \fBkeysym\fR.
.IP "\fB\-xrm\fR \fIresourcestring\fR" 4
.IX Item "-xrm resourcestring"
No effect on rxvt\-unicode. Simply passes through an argument to be made
Xresource data: using the X libraries (Xrm*\-functions) or internal
Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the
-resources using X11 tools like \fBxset\fR. Many distribution do also load
-settings from the \fB~/.Xresources\fR file when X starts.
+resources using X11 tools like \fBxrdb\fR. Many distribution do also load
+settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
+will consult the following files/resources in order, with later settings
+overwriting earlier ones:
+.PP
+.Vb 5
+\& 1. system-wide app-defaults file, either locale-dependent OR global
+\& 2. app-defaults file in $XAPPLRESDIR
+\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+\& 4. SCREEN_RESOURCES for the current screen
+\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
+.Ve
.PP
If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
can start or end with whitespace.
.Sp
+Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
+\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
+use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
+@@RXVT_NAME@@'s own processing).
+.Sp
You can define a range of keysyms in one shot by providing a \fIstring\fR
with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
should be a character not used by the strings.
Its usage can be demonstrated by an example:
.Sp
.Vb 1
-\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|>
+\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
.Ve
.Sp
The above line is equivalent to the following three lines:
.Sp
.Vb 3
-\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a>
-\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b>
-\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c>
+\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
+\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
+\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
.Ve
.Sp
-If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
+If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
when Control-Meta-c is being pressed":
.Sp
.Vb 1
-\& URxvt.keysym.M-C-c: proto:\e033]701;zh_CN.GBK\e007
+\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
.Ve
.Sp
The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
-the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you cna have some limited
+the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
font-switching at runtime:
.Sp
.Vb 2
-\& URxvt.keysym.M-C-1: proto:\e033]50;suxuseuro\e007
-\& URxvt.keysym.M-C-2: proto:\e033]50;9x15bold\e007
+\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
+\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
.Ve
.Sp
-\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to
-\&\f(CW\*(C`zh_CN.GBK\*(C'\fR.
+Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
+info):
+.Sp
+.Vb 2
+\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
+\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
+.Ve
.SH "THE SCROLLBAR"
.IX Header "THE SCROLLBAR"
Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
.PP
If mouse reporting mode is active, the normal scrollbar actions are
disabled \*(-- on the assumption that we are using a fullscreen
-application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR
-(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the
-up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down),
+application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
+(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
+up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
respectively.
.SH "TEXT SELECTION AND INSERTION"
.IX Header "TEXT SELECTION AND INSERTION"
on White.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
-\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR
-and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X
-window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and
-sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display
-terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables
-\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files.
+\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
+.IP "\fB\s-1TERM\s0\fR" 4
+.IX Item "TERM"
+Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
+resources or on the commandline.
+.IP "\fB\s-1COLORTERM\s0\fR" 4
+.IX Item "COLORTERM"
+Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
+compiled with \s-1XPM\s0 support, and optionally with the added extension
+\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
+.IP "\fB\s-1COLORFGBG\s0\fR" 4
+.IX Item "COLORFGBG"
+Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
+the colour code used as default foreground/text colour (or the string
+\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
+used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
+string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
+was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`slang\*(C'\fR can (and do) use
+this information to optimize screen output.
+.IP "\fB\s-1WINDOWID\s0\fR" 4
+.IX Item "WINDOWID"
+Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
+window, which usually has subwindows for the scrollbar, the terminal
+window and so on).
+.IP "\fB\s-1TERMINFO\s0\fR" 4
+.IX Item "TERMINFO"
+Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
+\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
+.IP "\fB\s-1DISPLAY\s0\fR" 4
+.IX Item "DISPLAY"
+Used by @@RXVT_NAME@@ to connect to the display and set to the correct
+display in it's child processes.
+.IP "\fB\s-1SHELL\s0\fR" 4
+.IX Item "SHELL"
+The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
+.IP "\fB\s-1RXVTPATH\s0\fR" 4
+.IX Item "RXVTPATH"
+The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
+files.
+.IP "\fB\s-1PATH\s0\fR" 4
+.IX Item "PATH"
+Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
+.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
+.IX Item "RXVT_SOCKET"
+The unix domain socket path used by @@RXVT_NAME@@c(1) and
+@@RXVT_NAME@@d(1).
+.Sp
+Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR.
+.IP "\fB\s-1HOME\s0\fR" 4
+.IX Item "HOME"
+Used to locate the default directory for the unix domain socket for
+daemon communications and to locate various resource files (such as
+\&\f(CW\*(C`.Xdefaults\*(C'\fR)
+.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
+.IX Item "XAPPLRESDIR"
+Directory where various X resource files are being located.
+.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
+.IX Item "XENVIRONMENT"
+If set and accessible, gives the name of a X resource file to be loaded by
+@@RXVT_NAME@@.
.SH "FILES"
.IX Header "FILES"
.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
.IP "Project Coordinator" 4
.IX Item "Project Coordinator"
@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@
-.IP "Web page maintainter" 4
-.IX Item "Web page maintainter"
-@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@
.Sp
@@RXVT_WEBPAGE@@
.SH "AUTHORS"
=head1 FREQUENTLY ASKED QUESTIONS
-See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently
-asked questions and answer to them and some common problems.
+See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
+frequently asked questions and answer to them and some common
+problems. That document is also accessible on the World-Wide-Web at
+L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
=head1 RXVT-UNICODE VS. RXVT
Turn on/off secondary screen scroll (default enabled); resource
B<secondaryScroll>.
+=item B<-keysym.>I<sym>: I<string>
+
+Remap a key symbol. See resource B<keysym>.
+
=item B<-xrm> I<resourcestring>
No effect on rxvt-unicode. Simply passes through an argument to be made
Xresource data: using the X libraries (Xrm*-functions) or internal
Xresources reader (B<~/.Xdefaults>). For the first method (ie.
B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
-resources using X11 tools like B<xset>. Many distribution do also load
-settings from the B<~/.Xresources> file when X starts.
+resources using X11 tools like B<xrdb>. Many distribution do also load
+settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
+will consult the following files/resources in order, with later settings
+overwriting earlier ones:
+
+ 1. system-wide app-defaults file, either locale-dependent OR global
+ 2. app-defaults file in $XAPPLRESDIR
+ 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+ 4. SCREEN_RESOURCES for the current screen
+ 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
If mouse reporting mode is active, the normal scrollbar actions are
disabled -- on the assumption that we are using a fullscreen
-application. Instead, pressing Button1 and Button3 sends B<ESC[6~>
-(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the
-up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),
+application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
+(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
+up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
respectively.
=head1 TEXT SELECTION AND INSERTION
=head1 ENVIRONMENT
-B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
-and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
-window id number of the B<@@RXVT_NAME@@> window and it also uses and
-sets the environment variable B<DISPLAY> to specify which display
-terminal to use. B<@@RXVT_NAME@@> uses the environment variables
-B<RXVTPATH> and B<PATH> to find XPM files.
+B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
+
+=over 4
+
+=item B<TERM>
+
+Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
+resources or on the commandline.
+
+=item B<COLORTERM>
+
+Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
+compiled with XPM support, and optionally with the added extension
+C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
+
+=item B<COLORFGBG>
+
+Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
+the colour code used as default foreground/text colour (or the string
+C<default> to indicate that the default-colour escape sequence is to be
+used), C<bg> is the colour code used as default background colour (or the
+string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
+was compiled with XPM support. Libraries like C<slang> can (and do) use
+this information to optimize screen output.
+
+=item B<WINDOWID>
+
+Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
+window, which usually has subwindows for the scrollbar, the terminal
+window and so on).
+
+=item B<TERMINFO>
+
+Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
+C<--with-terminfo=PATH>.
+
+=item B<DISPLAY>
+
+Used by @@RXVT_NAME@@ to connect to the display and set to the correct
+display in it's child processes.
+
+=item B<SHELL>
+
+The shell to be used for command execution, defaults to C</bin/sh>.
+
+=item B<RXVTPATH>
+
+The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
+files.
+
+=item B<PATH>
+
+Used in the same way as C<RXVTPATH>.
+
+=item B<RXVT_SOCKET>
+
+The unix domain socket path used by @@RXVT_NAME@@c(1) and
+@@RXVT_NAME@@d(1).
+
+Default C<< $HOME/.rxvt-unicode-<nodename >>.
+
+=item B<HOME>
+
+Used to locate the default directory for the unix domain socket for
+daemon communications and to locate various resource files (such as
+C<.Xdefaults>)
+
+=item B<XAPPLRESDIR>
+
+Directory where various X resource files are being located.
+
+=item B<XENVIRONMENT>
+
+If set and accessible, gives the name of a X resource file to be loaded by
+@@RXVT_NAME@@.
+
+=back
=head1 FILES
@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
-=item Web page maintainter
-
-@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
-
L<@@RXVT_WEBPAGE@@>
=back
rxvt [options] [-e command [ args ]]
DESCRIPTION
- rxvt-unicode, version 4.9, is a colour vt102 terminal emulator intended
+ rxvt-unicode, version 5.0, is a colour vt102 terminal emulator intended
as an *xterm*(1) replacement for users who do not require features such
as Tektronix 4014 emulation and toolkit-style configurability. As a
result, rxvt-unicode uses much less swap space -- a significant
FREQUENTLY ASKED QUESTIONS
See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
- and answer to them and some common problems.
+ and answer to them and some common problems. That document is also
+ accessible on the World-Wide-Web at
+ <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
RXVT-UNICODE VS. RXVT
Unlike the original rxvt, rxvt-unicode stores all text in Unicode
Turn on/off secondary screen scroll (default enabled); resource
secondaryScroll.
+ -keysym.*sym*: *string*
+ Remap a key symbol. See resource keysym.
+
-xrm *resourcestring*
No effect on rxvt-unicode. Simply passes through an argument to be
made available in the instance's argument list. Appears in
data: using the X libraries (Xrm*-functions) or internal Xresources
reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
XGetDefaults), you can set and change the resources using X11 tools like
- xset. Many distribution do also load settings from the ~/.Xresources
- file when X starts.
+ xrdb. Many distribution do also load settings from the ~/.Xresources
+ file when X starts. rxvt will consult the following files/resources in
+ order, with later settings overwriting earlier ones:
+
+ 1. system-wide app-defaults file, either locale-dependent OR global
+ 2. app-defaults file in $XAPPLRESDIR
+ 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+ 4. SCREEN_RESOURCES for the current screen
+ 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
If compiled with internal Xresources support (i.e. rxvt -h lists
.Xdefaults) then rxvt accepts application defaults set in
"^@": null, "^A" ...) and may be enclosed with double quotes so that
it can start or end with whitespace.
+ Please note that you need to double the "\" when using
+ "--enable-xgetdefault", as X itself does it's own de-escaping (you
+ can use "\033" instead of "\e" (and so on), which will work with
+ both Xt and rxvt's own processing).
+
You can define a range of keysyms in one shot by providing a
*string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
`/' should be a character not used by the strings.
Its usage can be demonstrated by an example:
- URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|>
+ URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
The above line is equivalent to the following three lines:
- URxvt.keysym.Meta-Control-0x61: \e<M-C-a>
- URxvt.keysym.Meta-Control-0x62: \e<M-C-b>
- URxvt.keysym.Meta-Control-0x63: \e<M-C-c>
+ URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
+ URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
+ URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
- If *string* takes the form of "proto:STRING", the specified STRING
+ If *string* takes the form of "command:STRING", the specified STRING
is interpreted and executed as rxvt's control sequence. For example
the following means "change the current locale to "zh_CN.GBK" when
Control-Meta-c is being pressed":
- URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007
+ URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
The following example will map Control-Meta-1 and Control-Meta-2 to
- the fonts "suxuseuro" and "9x15bold", so you cna have some limited
+ the fonts "suxuseuro" and "9x15bold", so you can have some limited
font-switching at runtime:
- URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007
- URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007
+ URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
+ URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
- "proto:\033]701;zh_CN.GBK\007" means: change the current locale to
- "zh_CN.GBK".
+ Other things are possible, e.g. resizing (see rxvt(7) for more
+ info):
+
+ URxvt.keysym.M-C-3: command:\033[8;25;80t
+ URxvt.keysym.M-C-4: command:\033[8;48;110t
THE SCROLLBAR
Lines of text that scroll off the top of the rxvt window (resource:
If mouse reporting mode is active, the normal scrollbar actions are
disabled -- on the assumption that we are using a fullscreen
- application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next)
- and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down
- arrows sends ESC[A (Up) and ESC[B (Down), respectively.
+ application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
+ (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
+ up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
TEXT SELECTION AND INSERTION
The behaviour of text selection and insertion mechanism is similar to
on White.
ENVIRONMENT
- rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The
- environment variable WINDOWID is set to the X window id number of the
- rxvt window and it also uses and sets the environment variable DISPLAY
- to specify which display terminal to use. rxvt uses the environment
- variables RXVTPATH and PATH to find XPM files.
+ rxvt sets and/or uses the following environment variables:
+
+ TERM
+ Normally set to "rxvt-unicode", unless overwritten at configure
+ time, via resources or on the commandline.
+
+ COLORTERM
+ Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
+ with XPM support, and optionally with the added extension "-mono" to
+ indicate that rxvt-unicode runs on a monochrome screen.
+
+ COLORFGBG
+ Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
+ the colour code used as default foreground/text colour (or the
+ string "default" to indicate that the default-colour escape sequence
+ is to be used), "bg" is the colour code used as default background
+ colour (or the string "default"), and "xpm" is the string "default"
+ if rxvt was compiled with XPM support. Libraries like "slang" can
+ (and do) use this information to optimize screen output.
+
+ WINDOWID
+ Set to the (decimal) X Window ID of the rxvt window (the toplevel
+ window, which usually has subwindows for the scrollbar, the terminal
+ window and so on).
+
+ TERMINFO
+ Set to the terminfo directory iff rxvt was configured with
+ "--with-terminfo=PATH".
+
+ DISPLAY
+ Used by rxvt to connect to the display and set to the correct
+ display in it's child processes.
+
+ SHELL
+ The shell to be used for command execution, defaults to "/bin/sh".
+
+ RXVTPATH
+ The path where rxvt looks for support files such as menu and xpm
+ files.
+
+ PATH
+ Used in the same way as "RXVTPATH".
+
+ RXVT_SOCKET
+ The unix domain socket path used by rxvtc(1) and rxvtd(1).
+
+ Default "$HOME/.rxvt-unicode-<nodename".
+
+ HOME
+ Used to locate the default directory for the unix domain socket for
+ daemon communications and to locate various resource files (such as
+ ".Xdefaults")
+
+ XAPPLRESDIR
+ Directory where various X resource files are being located.
+
+ XENVIRONMENT
+ If set and accessible, gives the name of a X resource file to be
+ loaded by rxvt.
FILES
/usr/lib/X11/rgb.txt
Project Coordinator
Marc A. Lehmann rxvt@schmorp.de
- Web page maintainter
- Marc A. Lehmann rxvt@schmorp.de
-
<http://software.schmorp.de/>
AUTHORS
-#define VERSION "4.9"
-#define VSTRING "40900"
-#define DATE "2005-02-03"
-#define LSMDATE "02FEB03"
-#define LIBVERSION "4:9:0"
+#define VERSION "5.0"
+#define VSTRING "50000"
+#define DATE "2005-02-11"
+#define LSMDATE "11FEB03"
+#define LIBVERSION "5:0:0"
projects / dana / urxvt.git / commitdiff