--- rxvt-unicode/doc/rxvt.7.pod 2004/08/12 21:30:14 1.2 +++ rxvt-unicode/doc/rxvt.7.pod 2006/01/16 15:12:48 1.85 @@ -1,5 +1,909 @@ +=head1 NAME + +RXVT REFERENCE - FAQ, command sequences and other background information + +=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 + +This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting +all escape sequences, and other background information. + +The newest version of this document is +also available on the World Wide Web at +L. + +=head1 FREQUENTLY ASKED QUESTIONS + +=over 4 + +=item The new selection selects pieces that are too big, how can I select +single words? + +Yes. For example, if you want to select alphanumeric words, you can use +the following resource: + + URxvt.selection.pattern-0: ([[:word:]]+) + +If you click more than twice, the selection will be extended +more and more. + +To get a selection that is very similar to the old code, try this pattern: + + URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) + +Please also note that the I combination also +selects words like the old code. + +=item I don't like the new selection/popups/hotkeys/perl, how do I +change/disable it? + +You can disable the perl extension completely by setting the +B resource to the empty string, which also keeps +rxvt-unicode from initialising perl, saving memory. + +If you only want to disable specific features, you first have to +identify which perl extension is responsible. For this, read the section +B in the @@RXVT_NAME@@perl(3) manpage. For +example, to disable the B and B, specify +this B resource: + + URxvt.perl-ext-common: default,-selection-popup,-option-popup + +This will keep the default extensions, but disable the two popup +extensions. Some extensions can also be configured, for example, +scrollback search mode is triggered by B. You can move it to any +other combination either by setting the B resource: + + URxvt.searchable-scrollback: CM-s + +=item Isn't rxvt supposed to be small? Don't all those features bloat? + +I often get asked about this, and I think, no, they didn't cause extra +bloat. If you compare a minimal rxvt and a minimal urxvt, you can see +that the urxvt binary is larger (due to some encoding tables always being +compiled in), but it actually uses less memory (RSS) after startup. Even +with C<--disable-everything>, this comparison is a bit unfair, as many +features unique to urxvt (locale, encoding conversion, iso14755 etc.) are +already in use in this mode. + + text data bss drs rss filename + 98398 1664 24 15695 1824 rxvt --disable-everything + 188985 9048 66616 18222 1788 urxvt --disable-everything + +When you C<--enable-everything> (which _is_ unfair, as this involves xft +and full locale/XIM support which are quite bloaty inside libX11 and my +libc), the two diverge, but not unreasnobaly so. + + text data bss drs rss filename + 163431 2152 24 20123 2060 rxvt --enable-everything + 1035683 49680 66648 29096 3680 urxvt --enable-everything + +The very large size of the text section is explained by the east-asian +encoding tables, which, if unused, take up disk space but nothing else +and can be compiled out unless you rely on X11 core fonts that use those +encodings. The BSS size comes from the 64k emergency buffer that my c++ +compiler allocates (but of course doesn't use unless you are out of +memory). Also, using an xft font instead of a core font immediately adds a +few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when +not used. + +Of course, due to every character using two or four bytes instead of one, +a large scrollback buffer will ultimately make rxvt-unicode use more +memory. + +Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this +still fares rather well. And compared to some monsters like gnome-terminal +(21152k + extra 4204k in separate processes) or konsole (22200k + extra +43180k in daemons that stay around after exit, plus half a minute of +startup time, including the hundreds of warnings it spits out), it fares +extremely well *g*. + +=item Why C++, isn't that unportable/bloated/uncool? + +Is this a question? :) It comes up very often. The simple answer is: I had +to write it, and C++ allowed me to write and maintain it in a fraction +of the time and effort (which is a scarce resource for me). Put even +shorter: It simply wouldn't exist without C++. + +My personal stance on this is that C++ is less portable than C, but in +the case of rxvt-unicode this hardly matters, as its portability limits +are defined by things like X11, pseudo terminals, locale support and unix +domain sockets, which are all less portable than C++ itself. + +Regarding the bloat, see the above question: It's easy to write programs +in C that use gobs of memory, an certainly possible to write programs in +C++ that don't. C++ also often comes with large libraries, but this is +not necessarily the case with GCC. Here is what rxvt links against on my +system with a minimal config: + + libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) + libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) + libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) + /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) + +And here is rxvt-unicode: + + libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) + libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) + libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) + libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) + /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) + +No large bloated libraries (of course, none were linked in statically), +except maybe libX11 :) + +=item Does it support tabs, can I have a tabbed rxvt-unicode? + +rxvt-unicode does not directly support tabs. It will work fine with +tabbing functionality of many window managers or similar tabbing programs, +and its embedding-features allow it to be embedded into other programs, +as witnessed by F or the upcoming C perl +module, which features a tabbed urxvt (murxvt) terminal as an example +embedding application. + +=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 sets the window title to the version number. When +using the @@RXVT_NAME@@c client, the version displayed is that of the +daemon. + +=item I am using Debian GNU/Linux and have a problem... + +The Debian GNU/Linux package of rxvt-unicode in sarge 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 (L) +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 C 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. + +=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? + +You should build one binary with the default options. F +now enables most useful options, and the trend goes to making them +runtime-switchable, too, so there is usually no drawback to enbaling them, +except higher disk and possibly memory usage. The perl interpreter should +be enabled, as important functionality (menus, selection, likely more in +the future) depends on it. + +You should not overwrite the C snd C resources +system-wide (except maybe with C). This will result in useful +behaviour. If your distribution aims at low memory, add an empty +C resource to the app-defaults file. This will keep the +perl interpreter disabled until the user enables it. + +If you can/want build more binaries, I recommend building a minimal +one with C<--disable-everything> (very useful) and a maximal one with +C<--enable-everything> (less useful, it will be very big due to a lot of +encodings built-in that increase download times and are rarely used). + +=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? + +Likely not. While I honestly try to make it secure, and am probably not +bad at it, I think it is simply unreasonable to expect all of freetype ++ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be +secure. Also, rxvt-unicode disables some options when it detects that it +runs setuid or setgid, which is not nice. Besides, with the embedded perl +interpreter the possibility for security problems easily multiplies. + +Elevated privileges are only required for utmp and pty operations on some +systems (for example, GNU/Linux doesn't need any extra privileges for +ptys, but some need it for utmp support). It is planned to mvoe this into +a forked handler process, but this is not yet done. + +So, while setuid/setgid operation is supported and not a problem on your +typical single-user-no-other-logins unix desktop, always remember that +its an awful lot of code, most of which isn't checked for security issues +regularly. + +=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 or even C, 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 (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 B (quite common...) you could also replace +the rxvt terminfo file with the rxvt-unicode one. + +=item C outputs some error when compiling the terminfo entry. + +Most likely it's the empty definition for C. Just replace it by +C and try again. + +=item C's readline does not work correctly under @@RXVT_NAME@@. + +=item 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 +library (Fedora Core's bash is one example) and rely on a termcap entry +for C. + +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 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:\ + :co#80:it#8:li#24:lm#0:\ + :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=\E(B:al=\E[L:\ + :as=\E(0: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:\ + :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 no longer have coloured output? + +The C 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 is not in it's default file (among +with most other terminals supporting colour). Either add: + + TERM rxvt-unicode + +to C 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. Some pre-packaged +distributions (most notably Debian GNU/Linux) break rxvt-unicode +by setting C to C, which doesn't have these extra +features. Unfortunately, some of these (most notably, again, Debian +GNU/Linux) furthermore fail to even install the C terminfo +file, so you will need to install it on your own (See the question B on +how to do this). + +=item 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 C setting, although the details of wether and how +this can happen are unknown, as C should offer a compatible +keymap. See the answer to the previous question, and please report if that +helped. + +=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 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 +something else, e.g. C. 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 specification not +supported on your systems. Some systems have a C command which +displays this (also, C 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: ... + +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 makes a best-effort try at finding a replacement +font. 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.: + + @@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 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. + +=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/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 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 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 L later in this document). + +=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 On Solaris 9, many line-drawing characters are too wide. + +Seems to be a known bug, read +L. Some people use the +following ugly workaround to get non-double-wide-characters working: + + #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) + +=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 that is not supported by +your input method. For example, if you specified B 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 or specify more than +one pre-edit style, such as B. + +=item I cannot type C to get an ASCII NUL character due to ISO 14755 + +Either try C alone (it often is mapped to ASCII NUL even on +international keyboards) or simply use ISO 14755 support to your +advantage, typing to get a ASCII NUL. This works for other +codes, too, such as C 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 terminal settings +(C), 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 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 C terminfo +definition to only claim 8 colour support or use C, 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 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. This is, of course, completely fine with respect to standards. + +However, that means rxvt-unicode only works in C, C and +C locales under FreeBSD (which all use Unicode as B. + +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 makes it impossible to convert between +B (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 into anything except the current +locale encoding. + +Some applications (such as the formidable B) 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 for them :) + +=item I use Solaris 9 and it doesn't compile/work/etc. + +Try the diff in F as a base. It fixes the worst +problems with C and a compile problem. + +=item How can I use rxvt-unicode under cygwin? + +rxvt-unicode should compile and run out of the box on cygwin, using +the X11 libraries that come with cygwin. libW11 emulation is no +longer supported (and makes no sense, either, as it only supported a +single font). I recommend starting the X-server in C<-multiwindow> or +C<-rootless> mode instead, which will result in similar look&feel as the +old libW11 emulation. + +At the time of this writing, cygwin didn't seem to support any multi-byte +encodings (you might try C), so you are likely limited +to 8-bit encodings. + +=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. Applications not using +that info will have problems (for example, C gets the width of +characters wrong as it uses it's own, locale-independent table under all +locales). + +Rxvt-unicode uses the C 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 environment variable +contains an arbitrary string which corresponds to an already-installed +locale. Common names for locales are C, C, +C, i.e. C, but other forms +(i.e. C or C) are also common. + +Rxvt-unicode ignores all other locale categories, and except for +the encoding, ignores country or language-specific settings, +i.e. C and C 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 C category. + +=item Can I switch locales at runtime? + +Yes, using an escape sequence. Try something like this, which sets +rxvt-unicode's idea of C. + + printf '\e]701;%s\007' ja_JP.SJIS + +See also the previous answer. + +Sometimes this capability is rather handy when you want to work in +one locale (e.g. C) but some programs don't support it +(e.g. UTF-8). For example, I use this script to start C, 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 C program, which usually works fine, except +for some locales where character width differs between program- and +rxvt-unicode-locales. + +=item Can I switch the fonts at runtime? + +Yes, using an escape sequence. Try something 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 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 + +=item My input method wants 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: + + URxvt.imlocale: ja_JP.EUC-JP + +Now you can start your terminal with C and still +use your input method. Please note, however, that you will not be able to +input characters outside C in a normal way then, as your input +method limits you. + +=item Rxvt-unicode crashes when the X Input Method changes or exits. + +Unfortunately, this is unavoidable, as the XIM protocol is racy by +design. Applications can avoid some crashes at the expense of memory +leaks, and Input Methods can avoid some crashes by careful ordering at +exit time. B (and derived input methods) generally succeeds, +while B (or similar input methods) fails. In the end, however, +crashes cannot be completely avoided even if both sides cooperate. + +So the only workaround is not to kill your Input Method Servers. + +=item Rxvt-unicode uses gobs of memory, how can I reduce that? + +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 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<:antialias=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. + +=item What's with this bold/blink stuff? + +If no bold colour is set via C, 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 (not by +me) 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 How can I start @@RXVT_NAME@@d in a race-free way? + +Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the +display, create the listening socket and then fork. + +=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 , 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 C / C. + +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 +(C) 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 C<@@RXVT_NAME@@ -name URxvt> + + URxvt.keysym.Home: \033[1~ + URxvt.keysym.End: \033[4~ + URxvt.keysym.C-apostrophe: \033 + URxvt.keysym.C-slash: \033 + URxvt.keysym.C-semicolon: \033 + URxvt.keysym.C-grave: \033 + URxvt.keysym.C-comma: \033 + URxvt.keysym.C-period: \033 + URxvt.keysym.C-0x60: \033 + URxvt.keysym.C-Tab: \033 + URxvt.keysym.C-Return: \033 + URxvt.keysym.S-Return: \033 + URxvt.keysym.S-space: \033 + URxvt.keysym.M-Up: \033 + URxvt.keysym.M-Down: \033 + URxvt.keysym.M-Left: \033 + URxvt.keysym.M-Right: \033 + URxvt.keysym.M-C-0: list \033 + URxvt.keysym.M-C-a: list \033 + URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 + +See some more examples in the documentation for the B resource. + +=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 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 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 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, +one that comes with F, F and F. Then go to +the doc subdirectory and enter C. + +=item My question isn't answered here, can I ask a human? + +Before sending me mail, you could go to IRC: C, +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 RXVT TECHNICAL REFERENCE +=head1 DESCRIPTION + +The rest of this document describes various technical aspects of +B. First the description of supported command sequences, +followed by pixmap support and last by a description of all features +selectable at C time. + =head1 Definitions =over 4 @@ -137,7 +1041,7 @@ =item B<< C >> -Obsolete form of returns: B<< C >> I +Obsolete form of returns: B<< C >> I =item B<< C >> @@ -151,11 +1055,11 @@ Invoke the G3 Character Set (LS3) -=item B<< C(C >> +=item B<< C >> Designate G0 Character Set (ISO 2022), see below for values of C. -=item B<< C)C >> +=item B<< C >> Designate G1 Character Set (ISO 2022), see below for values of C. @@ -189,7 +1093,7 @@ X -=head1 CSI (Code Sequence Introducer) Sequences +=head1 CSI (Command Sequence Introducer) Sequences =over 4 @@ -306,7 +1210,7 @@ Send Device Attributes (DA) B<< C >> (or omitted): request attributes from terminal -returns: B<< C >> (``I am a VT100 with Advanced Video +returns: B<< C >> (``I am a VT100 with Advanced Video Option'') =item B<< C >> @@ -332,21 +1236,22 @@ =end table +=item B<< C >> + +Set Mode (SM). See B<< C >> sequence for description of C. + =item B<< C >> -Printing +Printing. See also the C resource. =begin table + B<< C >> print screen (MC0) B<< C >> disable transparent print mode (MC4) - B<< C >> enable transparent print mode (MC5) I + B<< C >> enable transparent print mode (MC5) =end table -=item B<< C >> - -Set Mode (SM). See next sequence for description of C. - =item B<< C >> Reset Mode (RM) @@ -362,12 +1267,12 @@ =end table -=item B<< C >> I +=item B<< C >> (partially implemented) =begin table B<< C >> Automatic Newline (LNM) - B<< C >> Normal Linefeed (LNM) + B<< C >> Normal Linefeed (LNM) =end table @@ -380,10 +1285,13 @@ =begin table B<< C >> Normal (default) - B<< C >> On / Off Bold (bright fg) + B<< C >> On / Off Bold (bright fg) + B<< C >> On / Off Italic B<< C >> On / Off Underline - B<< C >> On / Off Blink (bright bg) + B<< C >> On / Off Slow Blink (bright bg) + B<< C >> On / Off Rapid Blink (bright bg) B<< C >> On / Off Inverse + B<< C >> On / Off Invisible (NYI) B<< C >> fg/bg Black B<< C >> fg/bg Red B<< C >> fg/bg Green @@ -391,8 +1299,18 @@ B<< C >> fg/bg Blue B<< C >> fg/bg Magenta B<< C >> fg/bg Cyan + B<< C >> set fg/bg to color #m (ISO 8613-6) B<< C >> fg/bg White B<< C >> fg/bg Default + B<< C >> fg/bg Bright Black + B<< C >> fg/bg Bright Red + B<< C >> fg/bg Bright Green + B<< C >> fg/bg Bright Yellow + B<< C >> fg/bg Bright Blue + B<< C >> fg/bg Bright Magenta + B<< C >> fg/bg Bright Cyan + B<< C >> fg/bg Bright White + B<< C >> fg/bg Bright Default =end table @@ -418,14 +1336,39 @@ Save Cursor (SC) -=item B<< C >> +=item B<< C >> -Request Terminal Parameters (DECREQTPARM) +Window Operations + +=begin table + + B<< C >> Deiconify (map) window + B<< C >> Iconify window + B<< C >> B<< C >> Move window to (X|Y) + B<< C >> B<< C >> Resize to WxH pixels + B<< C >> Raise window + B<< C >> Lower window + B<< C >> Refresh screen once + B<< C >> B<< C >> Resize to R rows and C columns + B<< C >> Report window state (responds with C or C) + B<< C >> Report window position (responds with C) + B<< C >> Report window pixel size (responds with C) + B<< C >> Report window text size (responds with C) + B<< C >> Currently the same as C, but responds with C + B<< C >> Reports icon label (B<< C >>) + B<< C >> Reports window title (B<< C >>) + B<< C >> Set window height to C rows + +=end table =item B<< C >> Restore Cursor +=item B<< C >> + +Request Terminal Parameters (DECREQTPARM) + =back X @@ -537,17 +1480,6 @@ =end table -)X - -=item B<< C >> (B) - -=begin table - - B<< C >> visible - B<< C >> invisible - -=end table - =item B<< C >> =begin table @@ -655,7 +1587,7 @@ =end table -=item B<< C >> +=item B<< C >> (B) =begin table @@ -664,7 +1596,7 @@ =end table -=item B<< C >> +=item B<< C >> (B) =begin table @@ -673,6 +1605,15 @@ =end table +=item B<< C >> (B) + +=begin table + + B<< C >> Bold/italic implies high intensity (see option B<-is>) + B<< C >> Font styles have no effect on intensity (Compile styles) + +=end table + =item B<< C >> =begin table @@ -691,6 +1632,15 @@ =end table +=item B<< C >> + +=begin table + + B<< C >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it + B<< C >> Use Normal Screen Buffer + +=end table + =back =back @@ -719,487 +1669,31 @@ B<< C >> Change colour of text cursor foreground to B<< C >> B<< C >> Change colour of mouse foreground to B<< C >> B<< C >> Change colour of highlight characters to B<< C >> - B<< C >> Change colour of bold characters to B<< C >> - B<< C >> Change colour of underlined characters to B<< C >> + B<< C >> Change colour of bold characters to B<< C >> [deprecated, see 706] + B<< C >> Change colour of underlined characters to B<< C >> [deprecated, see 707] B<< C >> Change default background to B<< C >> - B<< C >> Change default foreground colour to B<< C >> I + B<< C >> Change default foreground colour to B<< C >>. B<< C >> Change Log File to B<< C >> I - B<< C >> Change default background colour to B<< C >> I + B<< C >> Change default background colour to B<< C >>. B<< C >> Set fontset to B<< C >>, with the following special values of B<< C >> (B) B<< C<#+n> >> change up B<< C >> B<< C<#-n> >> change down B<< C >> if B<< C >> is missing of 0, a value of 1 is used I change to font0 B<< C >> change to font B<< C >> B<< C >> Log all scrollback buffer and all of screen to B<< C >> - B<< C >> Change current locale to B<< C >>, or, if B<< C >> is B<< C >>, return the current locale (@@RXVT_NAME@@ extension) - B<< C >> find font for character, used for debugging (@@RXVT_NAME@@ extension) - B<< C >> command B<< C >> I (@@RXVT_NAME@@ extension) + B<< C >> Change current locale to B<< C >>, or, if B<< C >> is B<< C >>, return the current locale (Compile frills). + B<< C >> Change colour of italic characters to B<< C >> + B<< C >> Change background pixmap tint colour to B<< C >> (Compile transparency). + B<< C >> Change colour of bold characters to B<< C >> + B<< C >> Change colour of underlined characters to B<< C >> + B<< C >> Set normal fontset to B<< C >>. Same as C. + B<< C >> Set bold fontset to B<< C >>. Similar to C (Compile styles). + B<< C >> Set italic fontset to B<< C >>. Similar to C (Compile styles). + B<< C >> Set bold-italic fontset to B<< C >>. Similar to C (Compile styles). + B<< C >> Move viewing window up by B<< C >> lines, or clear scrollback buffer if C (Compile frills). + B<< C >> Move viewing window down by B<< C >> lines, or clear scrollback buffer if C (Compile frills). + B<< C >> Call the perl extension with the given string, which should be of the form C (Compile perl). =end table =back -X - -=head1 menuBar - -B<< The exact syntax used is I solidified. >> -In the menus, B try to use menuBar commands that add or remove a -menuBar. - -Note that in all of the commands, the B<< I >> I 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, the syntax -of C 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] >> which creates -the menuBar called I and allows access. You may now or menus, -subMenus, and menuItems. Finally, use the tag B<[done]> to set the -menuBar access as B 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 - -=head2 Commands - -=over 4 - -=item B<< [menu:+I] >> - -access the named menuBar for creation or alteration. If a new menuBar -is created, it is called I (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] >> - -set the current menuBar's title to I, 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. -End-of-file tag for B<< [read:+I] >> operations. - -=item B<< [read:+I] >> - -read menu commands directly from I (extension ".menu" will be -appended if required.) Start reading at a line with B<[menu]> or B<< -[menu:+I >> 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;+I] >> - -The same as B<< [read:+I] >>, but start reading at a line with -B<< [menu:+I] >> and continuing until B<< [done:+I] >> or -B<[done]> is encountered. - -=item B<[dump]> - -dump all menuBars to the file B 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] >> - -=item B<< [pixmap:+I;I] >> - -(set the background pixmap globally - -B<< A Future implementation I make this local to the menubar >>) - -=item B<< [:+I:] >> - -ignore the menu readonly status and issue a I to or a menu or -menuitem or change the ; a useful shortcut for setting the quick arrows -from a menuBar. - -=back - -X - -=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<< Imenu >> - -add/access menu - -=item B<< Imenu/* >> - -add/access menu and clear it if it exists - -=item B<< I{-} >> - -add separator - -=item B<< I{item} >> - -add B as a label - -=item B<< I{item} action >> - -add/alter I with an associated I - -=item B<< I{item}{right-text} >> - -add/alter I with B as the right-justified text -and as the associated I - -=item B<< I{item}{rtext} action >> - -add/alter I with an associated I and with B as -the right-justified text. - -=back - -=over 4 - -=item Special characters in I 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 (B<^@>) character to the -program, start I with a pair of B characters (B<^@^@>), -the first of which will be stripped off and the balance directed to the -program. Otherwise if I begins with B followed by -non-+B characters, the leading B is stripped off and the -balance is sent back to rxvt. - -As a convenience for the many Emacs-type editors, I may start -with B (eg, B is equivalent to B<\E$>) and a B will be -appended if missed from B commands. - -As a convenience for issuing XTerm B sequences from a menubar (or -quick arrow), a B (B<^G>) will be appended if needed. - -=over 4 - -=item For example, - -B 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} >> will be right-justified. In the -absence of a specified action, this text will be used as the I -as well. - -=over 4 - -=item For example, - -B is equivalent to B - -=back - -The left label I 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 - -=item or hiding it - -B - -=back - -X - -=head2 Removing menus - -=over 4 - -=item B<< -/*+ >> - -remove all menus from the menuBar, the same as B<[clear]> - -=item B<< -+Imenu+ >> - -remove menu - -=item B<< -+I{item}+ >> - -remove item - -=item B<< -+I{-} >> - -remove separator) - -=item B<-/path/menu/*> - -remove all items, separators and submenus from menu - -=back - -X - -=head2 Quick Arrows - -The menus also provide a hook for I 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<< +I >> - -=item B<< +I >> - -=item B<< +I >> - -=item B<< +I >> - -Define actions for the respective arrow buttons - -=item B<< +I >> - -=item B<< +I >> - -Define common beginning/end parts for I which used in -conjunction with the above constructs - -=back - -=over 4 - -=item For example, define arrows individually, - - \E[A - - \E[B - - \E[C - - \E[D - -=item or all at once - - \E[AZ<>\E[BZ<>\E[CZ<>\E[D - -=item or more compactly (factoring out common parts) - - \E[AZ<>BZ<>CZ<>D - -=back - -X - -=head2 Command Summary - -A short summary of the most I 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 BeginRightLeftUpDownEnd - -menu quick arrows - -=back X =head1 XPM @@ -1392,9 +1886,317 @@ =end table +=head1 CONFIGURE OPTIONS + +General hint: if you get compile errors, then likely your configuration +hasn't been tested well. Either try with C<--enable-everything> or use +the F<./reconf> script as a base for experiments. F<./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 . + +All + +=over 4 + +=item --enable-everything + +Add (or remove) support for all non-multichoice options listed in "./configure +--help". + +You can specify this and then disable options you do not like by +I this with the appropriate C<--disable-...> arguments, +or you can start with a minimal configuration by specifying +C<--disable-everything> and than adding just the C<--enable-...> arguments +you want. + +=item --enable-xft (default: enabled) + +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 (default: on) + +Add support for B, I and B<< I >> font +styles. The fonts can be set manually or automatically. + +=item --with-codesets=NAME,... (default: all) + +Compile in support for additional codeset (encoding) groups (C, C +are always compiled in, which includes most 8-bit character sets). These +codeset tables are used for driving X11 core fonts, they are not required +for Xft fonts, although having them compiled in lets rxvt-unicode choose +replacement fonts more intelligently. Compiling them in will make your +binary bigger (all of together cost about 700kB), but it doesn't increase +memory usage unless you use a 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 (default: on) + +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 (default: off) + +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 (default: on) + +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-unicode will use the +private use area, extending the number of combinations to 8448). With +--enable-unicode3, no practical limit exists. + +This option will also enable storage (but not display) of characters +beyond plane 0 (>65535) when --enable-unicode3 was not specified. + +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 (and +tell me how these are to be used...). + +=item --enable-fallback(=CLASS) (default: Rxvt) + +When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. + +=item --with-res-name=NAME (default: urxvt) + +Use the given name as default application name when +reading resources. Specify --with-res-name=rxvt to replace rxvt. + +=item --with-res-class=CLASS /default: URxvt) + +Use the given class as default application class +when reading resources. Specify --with-res-class=Rxvt to replace +rxvt. + +=item --enable-utmp (default: on) + +Write user and tty to utmp file (used by programs like F) at +start of rxvt execution and delete information when rxvt exits. + +=item --enable-wtmp (default: on) + +Write user and tty to wtmp file (used by programs like F) at +start of rxvt execution and write logout when rxvt exits. This +option requires --enable-utmp to also be specified. + +=item --enable-lastlog (default: on) + +Write user and tty to lastlog file (used by programs like +F) at start of rxvt execution. This option requires +--enable-utmp to also be specified. + +=item --enable-xpm-background (default: on) + +Add support for XPM background pixmaps. + +=item --enable-transparency (default: on) + +Add support for inheriting parent backgrounds thus giving a fake +transparency to the term. + +=item --enable-fading (default: on) + +Add support for fading the text when focus is lost (requires C<--enable-transparency>). + +=item --enable-tinting (default: on) + +Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). + +=item --enable-rxvt-scroll (default: on) + +Add support for the original rxvt scrollbar. + +=item --enable-next-scroll (default: on) + +Add support for a NeXT-like scrollbar. + +=item --enable-xterm-scroll (default: on) + +Add support for an Xterm-like scrollbar. + +=item --enable-plain-scroll (default: on) + +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 (default: off) + +Make shadows on the scrollbar only half the normal width & height. +only applicable to rxvt scrollbars. + +=item --enable-ttygid (default: off) + +Change tty device setting to group "tty" - only use this if +your system uses this type of security. + +=item --disable-backspace-key + +Removes any handling of the backspace key by us - let the X server do it. + +=item --disable-delete-key + +Removes any handling of the delete key by us - let the X server +do it. + +=item --disable-resources + +Removes any support for resource checking. + +=item --disable-swapscreen + +Remove support for secondary/swap screen. + +=item --enable-frills (default: on) + +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 + EWMH-hints (pid, utf8 names) and protocols (ping) + seperate underline colour (-underlineColor) + settable border widths and borderless switch (-w, -b, -bl) + settable extra linespacing /-lsp) + iso-14755-2 and -3, and visual feedback + backindex and forwardindex escape sequence + window op and some xterm/OSC escape sequences + tripleclickwords (-tcw) + settable insecure mode (-insecure) + keysym remapping support + cursor blinking and underline cursor (-cb, -uc) + XEmbed support (-embed) + user-pty (-pty-fd) + hold on exit (-hold) + skip builtin block graphics (-sbg) + sgr modes 90..97 and 100..107 + +=item --enable-iso14755 (default: on) + +Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or +F). 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 (default: on) + +Add support for continual scrolling of the display when you hold +the mouse button down on a scrollbar arrow. + +=item --enable-mousewheel (default: on) + +Add support for scrolling via mouse wheel or buttons 4 & 5. + +=item --enable-slipwheeling (default: on) + +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 (default: off) + +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 (default: off) + +Use Doug Lea's malloc - which is good for a production version +See L for details. + +=item --enable-smart-resize (default: on) + +Add smart growth/shrink behaviour when changing font size via hot +keys. This should keep the window corner which is closest to a corner of +the screen in a fixed position. + +=item --enable-pointer-blank (default: on) + +Add support to have the pointer disappear when typing or inactive. + +=item --enable-perl (default: off) + +Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> +manpage (F) for more info on this feature, or the files +in F for the extensions that are installed by default. The +perl interpreter that is used can be specified via the C environment +variable when running configure. + +=item --with-name=NAME (default: urxvt) + +Set the basename for the installed binaries, resulting +in C, C etc.). Specify C<--with-name=rxvt> to replace with +C. + +=item --with-term=NAME (default: rxvt-unicode) + +Change the environmental variable for the terminal to NAME. + +=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 , converted this document to pod and +Marc Lehmann converted this document to pod and reworked it from the original Rxvt documentation, which was done by Geoff Wing , who in turn used the XTerm documentation and other sources.