--- rxvt-unicode/doc/rxvt.7.pod 2006/08/07 15:59:44 1.120 +++ rxvt-unicode/doc/rxvt.7.pod 2014/06/09 10:08:48 1.230 @@ -19,7 +19,10 @@ all escape sequences, and other background information. The newest version of this document is also available on the World Wide Web at -L. +L. + +The main manual page for @@RXVT_NAME@@ itself is available at +L. =head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS @@ -32,6 +35,18 @@ channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be interested in learning about new and exciting problems (but not FAQs :). +=head3 I use Gentoo, and I have a problem... + +There are three big problems with Gentoo Linux: first of all, most if not +all Gentoo systems are completely broken (missing or mismatched header +files, broken compiler etc. are just the tip of the iceberg); secondly, +the Gentoo maintainer thinks it is a good idea to add broken patches to +the code; and lastly, it should be called Gentoo GNU/Linux. + +For these reasons, it is impossible to support rxvt-unicode on +Gentoo. Problems appearing on Gentoo systems will usually simply be +ignored unless they can be reproduced on non-Gentoo systems. + =head3 Does it support tabs, can I have a tabbed rxvt-unicode? Beginning with version 7.3, there is a perl extension that implements a @@ -75,7 +90,7 @@ Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the display, create the listening socket and then fork. -=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? +=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c? If you want to start @@URXVT_NAME@@d automatically whenever you run @@URXVT_NAME@@c and the daemon isn't running yet, use this script: @@ -92,12 +107,13 @@ re-run the command. Subsequent invocations of the script will re-use the existing daemon. -=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. +=head3 How do I distinguish whether I'm running rxvt-unicode or a regular +xterm? I need this to decide about setting colours etc. The original 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. +whether or not to use colour. =head3 How do I set the correct, full IP address for the DISPLAY variable? @@ -115,20 +131,20 @@ [ ${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' + printf "\eZ" 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 + printf '\e[7n' # query the rxvt we are in for the DISPLAY string + read DISPLAY # set it in our local shell fi fi =head3 How do I compile the manual pages on my own? 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. +one that comes with F, F and F (from +F). Then go to the doc subdirectory and enter C. =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? @@ -185,7 +201,7 @@ 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 +in C that use gobs of memory, and 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: @@ -199,9 +215,9 @@ 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) + 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 :) @@ -219,22 +235,25 @@ Here are four ways to get transparency. B read the manpage and option descriptions for the programs mentioned and rxvt-unicode. Really, do it! -1. Use inheritPixmap: +1. Use transparent mode: Esetroot wallpaper.jpg - @@URXVT_NAME@@ -ip -tint red -sh 40 + @@URXVT_NAME@@ -tr -tint red -sh 40 That works. If you think it doesn't, you lack transparency and tinting support, or you are unable to read. +This method requires that the background-setting program sets the +_XROOTPMAP_ID or ESETROOT_PMAP_ID property. Compatible programs +are Esetroot, hsetroot and feh. 2. Use a simple pixmap and emulate pseudo-transparency. This enables you to use effects other than tinting and shading: Just shade/tint/whatever your picture with gimp or any other tool: - convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm - @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background + convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg + @@URXVT_NAME@@ -pixmap "background.jpg;:root" -That works. If you think it doesn't, you lack XPM and Perl support, or you +That works. If you think it doesn't, you lack GDK-PixBuf support, or you are unable to read. 3. Use an ARGB visual: @@ -344,21 +363,20 @@ 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. +For the standard background colour, blinking will actually make +the text blink when compiled with C<--enable-text-blink>. Without +C<--enable-text-blink>, the blink attribute will be ignored. On ANSI colours, bold/blink attributes are used to set high-intensity -foreground/background colors. +foreground/background colours. -color0-7 are the low-intensity colors. +color0-7 are the low-intensity colours. -color8-15 are the corresponding high-intensity colors. +color8-15 are the corresponding high-intensity colours. -=head3 I don't like the screen colors. How do I change them? +=head3 I don't like the screen colours. How do I change them? -You can change the screen colors at run-time using F<~/.Xdefaults> +You can change the screen colours at run-time using F<~/.Xdefaults> resources (or as long-options). Here are values that are supposed to resemble a VGA screen, @@ -382,7 +400,7 @@ URxvt.color14: #00FFFF URxvt.color15: #FFFFFF -And here is a more complete set of non-standard colors. +And here is a more complete set of non-standard colours. URxvt.cursorColor: #dc74d1 URxvt.pointerColor: #dc74d1 @@ -462,6 +480,13 @@ Until then, you might get away with switching fonts at runtime (see L later in this document). +=head3 How can I make mplayer display video correctly? + +We are working on it, in the meantime, as a workaround, use something like: + + @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...' + + =head2 Keyboard, Mouse & User Interaction =head3 The new selection selects pieces that are too big, how can I select single words? @@ -478,7 +503,7 @@ URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) -Please also note that the I combination also +Please also note that the I combination also selects words like the old code. =head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? @@ -531,15 +556,19 @@ =head3 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 +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 +In this case either do not specify a B or specify more than one pre-edit style, such as B. +If it still doesn't work, then maybe your input method doesn't support +compose sequences - to fall back to the built-in one, make sure you don't +specify an input method via C<-im> or C. + =head3 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 @@ -551,10 +580,10 @@ =head3 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 +some editors prematurely may leave it active. I've +heard that tcsh may use mouse reporting unless it is otherwise specified. A quick check is to see if cut/paste works when the Alt or Shift keys are -depressed. +pressed. =head3 What's with the strange Backspace/Delete key behaviour? @@ -564,36 +593,19 @@ 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 +policy of using C<^?> when unsure, because it's the one and 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: +It is possible to toggle between C<^H> and C<^?> with the DECBKM +private mode: # use Backspace = ^H $ stty erase ^H - $ @@URXVT_NAME@@ + $ printf "\e[?67h" # use Backspace = ^? $ stty erase ^? - $ @@URXVT_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" + $ printf "\e[?67l" This helps satisfy some of the Backspace discrepancies that occur, but if you use Backspace = C<^H>, make sure that the termcap/terminfo value @@ -606,7 +618,7 @@ Some other Backspace problems: -some editors use termcap/terminfo, +some editors use termcap/terminfo, some editors (vim I'm told) expect Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for help. @@ -620,26 +632,14 @@ Here's an example for a URxvt session started using C<@@URXVT_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 + URxvt.keysym.Prior: \033[5~ + URxvt.keysym.Next: \033[6~ + URxvt.keysym.Home: \033[7~ + URxvt.keysym.End: \033[8~ + URxvt.keysym.Up: \033[A + URxvt.keysym.Down: \033[B + URxvt.keysym.Right: \033[C + URxvt.keysym.Left: \033[D See some more examples in the documentation for the B resource. @@ -657,7 +657,6 @@ required for your particular machine. - =head2 Terminal Configuration =head3 Can I see a typical configuration? @@ -697,7 +696,7 @@ The selection stuff mainly makes the selection perl-error-message aware and tells it to convert perl error messages into vi-commands to load the -relevant file and go tot he error line number. +relevant file and go to the error line number. URxvt.scrollstyle: plain URxvt.secondaryScroll: true @@ -779,7 +778,7 @@ normal fonts. Please note that I used the C instance name and not the C -class name. Thats because I use different configs for different purposes, +class name. That is because I use different configs for different purposes, for example, my IRC window is started with C<-name IRC>, and uses these defaults: @@ -793,14 +792,14 @@ IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 -C and C switch between two different font +C and C switch between two different font sizes. C allows me to keep an eye (and actually read) stuff while keeping a very small window. If somebody pastes something complicated (e.g. japanese), I temporarily switch to a larger font. The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor C). I also have some resources in a separate C<.Xdefaults-hostname> -file for different hosts, for example, on ym main desktop, I use: +file for different hosts, for example, on my main desktop, I use: URxvt.keysym.C-M-q: command:\033[3;5;5t URxvt.keysym.C-M-y: command:\033[3;5;606t @@ -840,12 +839,19 @@ 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): +be done by simply installing rxvt-unicode on the remote system as well +(in case you have a nice package manager ready), or you can install the +terminfo database manually like this (with ncurses infocmp. works as +user and root): REMOTE=remotesystem.domain - infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" + infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" -... or by installing rxvt-unicode normally on the remote system, +One some systems you might need to set C<$TERMINFO> to the full path of +F<$HOME/.terminfo> for this to work. Debian systems have a broken tic +which will not be able to overwrite the existing rxvt-unicode terminfo +entry - you might have to manually delete all traces of F +from F. 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 @@ -862,6 +868,12 @@ If you don't plan to use B (quite common...) you could also replace the rxvt terminfo file with the rxvt-unicode one and use C. +=head3 nano fails with "Error opening terminal: rxvt-unicode" + +This exceptionally confusing and useless error message is printed by nano +when it can't find the terminfo database. Nothing is wrong with your +terminal, read the previous answer for a solution. + =head3 C outputs some error when compiling the terminfo entry. Most likely it's the empty definition for C. Just replace it by @@ -884,28 +896,8 @@ 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: +Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap, +generated by the command above. =head3 Why does C no longer have coloured output? @@ -955,14 +947,15 @@ 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. +programs running in it. 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, and is the most common cause for problems. 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 '\33]701;%s\007' "$LC_CTYPE" + printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too If this doesn't work, then maybe you use a C specification not supported on your systems. Some systems have a C command which @@ -1066,8 +1059,6 @@ xprop -root XIM_SERVERS -=item - =back =head3 My input method wants but I want UTF-8, what can I do? @@ -1102,10 +1093,10 @@ patches that considerably change the behaviour of rxvt-unicode (but unfortunately this notice has been removed). 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). +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 @@ -1121,7 +1112,7 @@ be enabled, as important functionality (menus, selection, likely more in the future) depends on it. -You should not overwrite the C snd C resources +You should not overwrite the C and 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 @@ -1149,14 +1140,6 @@ things like the dynamic loader of your system, which should result in very little risk. -=head3 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) - =head3 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 @@ -1169,7 +1152,7 @@ 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 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) @@ -1189,11 +1172,6 @@ system libraries once and for all, instead of forcing every app to carry complete replacements for them :) -=head3 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. - =head3 How can I use rxvt-unicode under cygwin? rxvt-unicode should compile and run out of the box on cygwin, using @@ -1207,6 +1185,19 @@ encodings (you might try C), so you are likely limited to 8-bit encodings. +=head3 Character widths are not correct. + +urxvt uses the system wcwidth function to know the information about +the width of characters, so on systems with incorrect locale data you +will likely get bad results. Two notorious examples are Solaris 9, +where single-width characters like U+2514 are reported as double-width, +and Darwin 8, where combining chars are reported having width 1. + +The solution is to upgrade your system or switch to a better one. A +possibly working workaround is to use a wcwidth implementation like + +http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c + =head1 RXVT-UNICODE TECHNICAL REFERENCE The rest of this document describes various technical aspects of @@ -1220,7 +1211,7 @@ =item B<< C >> -The literal character c. +The literal character c (potentially a multi-byte character). =item B<< C >> @@ -1289,7 +1280,7 @@ Shift In (Ctrl-O), invokes the G0 character set (the default). Switch to Standard Character Set -=item B<< C >> +=item B<< C >> Space Character @@ -1315,7 +1306,7 @@ Application Keypad (SMKX). See also next sequence. -=item B<<< C<< ESC >> >>> +=item B<<< C<< ESC > >> >>> Normal Keypad (RMKX) @@ -1453,8 +1444,8 @@ =begin table - B<< C >> Clear Below (default) - B<< C >> Clear Above + B<< C >> Clear Right and Below (default) + B<< C >> Clear Left and Above B<< C >> Clear All =end table @@ -1468,6 +1459,8 @@ B<< C >> Clear to Right (default) B<< C >> Clear to Left B<< C >> Clear All + B<< C >> Like Ps = 0, but is ignored when wrapped + (@@RXVT_NAME@@ extension) =end table @@ -1594,33 +1587,33 @@ =begin table - B<< C >> Normal (default) - B<< C >> On / Off Bold (bright fg) - B<< C >> On / Off Italic - B<< C >> On / Off Underline - 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 - B<< C >> fg/bg Yellow - 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 + B<< C >> Normal (default) + B<< C >> On / Off Bold (bright fg) + B<< C >> On / Off Italic + B<< C >> On / Off Underline + 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 + B<< C >> fg/bg Yellow + B<< C >> fg/bg Blue + B<< C >> fg/bg Magenta + B<< C >> fg/bg Cyan + B<< C >> fg/bg White + B<< C >> set fg/bg to colour #m (ISO 8613-6) + 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 @@ -1637,6 +1630,20 @@ =end table +=item B<< C >> + +Set Cursor Style (DECSCUSR) + +=begin table + + B<< C >> Blink Block + B<< C >> Blink Block + B<< C >> Steady Block + B<< C >> Blink Underline + B<< C >> Steady Underline + +=end table + =item B<< C >> Set Scrolling Region [top;bottom] @@ -1718,7 +1725,7 @@ =end table -=item B<< C >> (ANSI/VT52 mode) +=item B<< C >> (DECANM) =begin table @@ -1727,57 +1734,57 @@ =end table -=item B<< C >> +=item B<< C >> (DECCOLM) =begin table - B<< C >> 132 Column Mode (DECCOLM) - B<< C >> 80 Column Mode (DECCOLM) + B<< C >> 132 Column Mode + B<< C >> 80 Column Mode =end table -=item B<< C >> +=item B<< C >> (DECSCLM) =begin table - B<< C >> Smooth (Slow) Scroll (DECSCLM) - B<< C >> Jump (Fast) Scroll (DECSCLM) + B<< C >> Smooth (Slow) Scroll + B<< C >> Jump (Fast) Scroll =end table -=item B<< C >> +=item B<< C >> (DECSCNM) =begin table - B<< C >> Reverse Video (DECSCNM) - B<< C >> Normal Video (DECSCNM) + B<< C >> Reverse Video + B<< C >> Normal Video =end table -=item B<< C >> +=item B<< C >> (DECOM) =begin table - B<< C >> Origin Mode (DECOM) - B<< C >> Normal Cursor Mode (DECOM) + B<< C >> Origin Mode + B<< C >> Normal Cursor Mode =end table -=item B<< C >> +=item B<< C >> (DECAWM) =begin table - B<< C >> Wraparound Mode (DECAWM) - B<< C >> No Wraparound Mode (DECAWM) + B<< C >> Wraparound Mode + B<< C >> No Wraparound Mode =end table -=item B<< C >> I +=item B<< C >> (DECARM) I =begin table - B<< C >> Auto-repeat Keys (DECARM) - B<< C >> No Auto-repeat Keys (DECARM) + B<< C >> Auto-repeat Keys + B<< C >> No Auto-repeat Keys =end table @@ -1790,7 +1797,7 @@ =end table -=item B<< C >> +=item B<< C >> (DECTCEM) =begin table @@ -1803,8 +1810,8 @@ =begin table - B<< C >> scrollBar visisble - B<< C >> scrollBar invisisble + B<< C >> scrollBar visible + B<< C >> scrollBar invisible =end table @@ -1861,20 +1868,20 @@ X -=item B<< C >> +=item B<< C >> (DECNKM) =begin table - B<< C >> Application Keypad (DECPAM) == C - B<< C >> Normal Keypad (DECPNM) == C<< ESC > >> + B<< C >> Application Keypad (DECKPAM/DECPAM) == C + B<< C >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >> =end table -=item B<< C >> +=item B<< C >> (DECBKM) =begin table - B<< C >> Backspace key sends B<< C (DECBKM) >> + B<< C >> Backspace key sends B<< C >> B<< C >> Backspace key sends B<< C >> =end table @@ -1897,6 +1904,38 @@ =end table +=item B<< C >> (X11 XTerm) + +=begin table + + B<< C >> Send Mouse X & Y on button press and release, and motion with a button pressed. + B<< C >> No mouse reporting. + +=end table + +=item B<< C >> (X11 XTerm) + +=begin table + + B<< C >> Send Mouse X & Y on button press and release, and motion. + B<< C >> No mouse reporting. + +=end table + +=item B<< C >> (X11 XTerm) (Compile frills) + +Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use +mode C<1015> instead. + +Unlike XTerm, coordinates larger than 2015) will work fine. + +=begin table + + B<< C >> Enable mouse coordinates in locale-specific encoding. + B<< C >> Enable mouse coordinates as binary octets. + +=end table + =item B<< C >> (B) =begin table @@ -1915,6 +1954,46 @@ =end table +=item B<< C >> (B) (Compile frills) + +Changes all mouse reporting codes to use decimal parameters instead of +octets or characters. + +This mode should be enabled I actually enabling mouse reporting, +for semi-obvious reasons. + +The sequences received for various modes are as follows: + + ESC [ M o o o !1005, !1015 (three octets) + ESC [ M c c c 1005, !1015 (three characters) + ESC [ Pm M 1015 (three or more numeric parameters) + +The first three parameters are C, C and C. Code is the numeric +code as for the other modes (but encoded as a decimal number, including +the additional offset of 32, so you have to subtract 32 first), C and +C are the coordinates (1|1 is the upper left corner, just as with +cursor positioning). + +Example: Shift-Button-1 press at top row, column 80. + + ESC [ 37 ; 80 ; 1 M + +One can use this feature by simply enabling it and then looking for +parameters to the C reply - if there are any, this mode is +active, otherwise one of the old reporting styles is used. + +Other (to be implemented) reply sequences will use a similar encoding. + +In the future, more parameters might get added (pixel coordinates for +example - anybody out there who needs this?). + +=begin table + + B<< C >> Enable new mouse coordinate reporting. + B<< C >> Use old-style C encoding. + +=end table + =item B<< C >> (B) =begin table @@ -1951,6 +2030,15 @@ =end table +=item B<< C >> + +=begin table + + B<< C >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C / C + B<< C >> Disable bracketed paste mode + +=end table + =back =back @@ -1974,25 +2062,25 @@ B<< C >> Change Window Title to B<< C >> B<< C >> If B<< C >> starts with a B<< C >>, query the (STRING) property of the window and return it. If B<< C >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. B<< C >> B<< C >> is a semi-colon separated sequence of one or more semi-colon separated B/B pairs, where B is an index to a colour and B is the name of a colour. Each pair causes the Bed colour to be changed to B. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white - B<< C >> Change colour of text foreground to B<< C >> B<(NB: may change in future)> - B<< C >> Change colour of text background to B<< C >> B<(NB: may change in future)> + B<< C >> Change colour of text foreground to B<< C >> + B<< C >> Change colour of text background to B<< C >> 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 >> [deprecated, see 706] - B<< C >> Change colour of underlined characters to B<< C >> [deprecated, see 707] - B<< C >> Change background pixmap parameters (see section XPM) (Compile XPM). - B<< C >> Change default foreground colour to B<< C >>. + B<< C >> Change background colour of highlight characters to B<< C >> + B<< C >> Change foreground colour of highlight characters to B<< C >> + B<< C >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile pixbuf). + B<< C >> Change default foreground colour to B<< C >>. [deprecated, use 10] B<< C >> Change Log File to B<< C >> I - B<< C >> Change default background colour to B<< C >>. + B<< C >> Change default background colour to B<< C >>. [deprecated, use 11] 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 >> Log all scrollback buffer and all of screen to B<< C >> [disabled] B<< C >> Change current locale to B<< C >>, or, if B<< C >> is B<< C >>, return the current locale (Compile frills). B<< C >> Request version if B<< C >> is B<< C >>, returning C, the resource name, the major and minor version numbers, e.g. C. 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 >> Change colour of the border 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). @@ -2005,71 +2093,27 @@ =back -=head1 XPM +=head1 BACKGROUND IMAGE -For the XPM XTerm escape sequence B<< C >> then value -of B<< C >> can be the name of the background pixmap followed by a -sequence of scaling/positioning commands separated by semi-colons. The -scaling/positioning commands are as follows: +For the BACKGROUND IMAGE XTerm escape sequence B<< C >> the value +of B<< C >> can be one of the following commands: =over 4 -=item query scale/position +=item B<< C >> -B +display scale and position in the title -=item change scale and position +=item B<< C<;WxH+X+Y> >> -B +change scale and/or position -B (== B) +=item B<< C >> -B (same as B) - -B (same as B) - -B (same as B) - -B (same as B) - -=item change position (absolute) - -B<=+X+Y> - -B<=+X> (same as B<=+X+Y>) - -=item change position (relative) - -B<+X+Y> - -B<+X> (same as B<+X+Y>) - -=item rescale (relative) - -B -> B - -B<0xH> -> B +change background image =back -For example: - -=over 4 - -=item B<\E]20;funky\a> - -load B as a tiled image - -=item B<\E]20;mona;100\a> - -load B with a scaling of 100% - -=item B<\E]20;;200;?\a> - -rescale the current pixmap to 200% and display the image geometry in -the title - -=back X =head1 Mouse Reporting @@ -2104,14 +2148,16 @@ =over 4 -=item State = B<< C<< ( - SPACE) & 60 >> >> +=item State = B<< C<< ( - SPACE) & ~3 >> >> =begin table 4 Shift 8 Meta 16 Control - 32 Double Click I<(rxvt extension)> + 32 Motion Notify + 32 Double Click I<(rxvt extension)>, disabled by default + 64 Button1 is actually Button4, Button2 is actually Button5 etc. =end table @@ -2120,16 +2166,17 @@ Row = B<< C<< - SPACE >> >> =back -X =head1 Key Codes +X + Note: B + B-B generates B-B For the keypad, use B to temporarily override Application-Keypad setting use B to toggle Application-Keypad setting if B is off, toggle Application-Keypad setting. Also note that -values of B, B, B may have been compiled differently on +values of B, B may have been compiled differently on your system. =begin table @@ -2199,10 +2246,9 @@ 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 . +the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx> +switches). Of course, you should always report when a combination doesn't +work, so it can be fixed. Marc Lehmann . All @@ -2210,8 +2256,9 @@ =item --enable-everything -Add (or remove) support for all non-multichoice options listed in "./configure ---help". +Add (or remove) support for all non-multichoice options listed +in C<./configure --help>, except for C<--enable-assert> and +C<--enable-256-color>. You can specify this and then disable options you do not like by I this with the appropriate C<--disable-...> arguments, @@ -2219,9 +2266,9 @@ C<--disable-everything> and than adding just the C<--enable-...> arguments you want. -=item --enable-xft (default: enabled) +=item --enable-xft (default: on) -Add support for Xft (anti-aliases, among others) fonts. Xft fonts are +Add support for Xft (anti-aliased, 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. @@ -2230,7 +2277,7 @@ Add support for B, I and B<< I >> font styles. The fonts can be set manually or automatically. -=item --with-codesets=NAME,... (default: all) +=item --with-codesets=CS,... (default: all) Compile in support for additional codeset (encoding) groups (C, C are always compiled in, which includes most 8-bit character sets). These @@ -2244,7 +2291,7 @@ all all available codeset groups zh common chinese encodings - zh_ext rarely used but very big chinese encodigs + zh_ext rarely used but very big chinese encodings jp common japanese encodings jp_ext rarely used but big japanese encodings kr korean encodings @@ -2268,7 +2315,7 @@ 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, +limited to a few thousand (shared with combining characters, see next switch), and right now rxvt-unicode cannot display them (input/output and cut&paste still work, though). @@ -2276,8 +2323,8 @@ 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 +where accents are encoded as separate unicode characters. This is +done by using precomposed characters when available or creating new pseudo-characters when no precomposed form exists. Without --enable-unicode3, the number of additional precomposed @@ -2291,7 +2338,7 @@ 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) +=item --enable-fallback[=CLASS] (default: Rxvt) When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. @@ -2301,7 +2348,7 @@ 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) +=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 @@ -2324,22 +2371,26 @@ F) at start of rxvt execution. This option requires --enable-utmp to also be specified. -=item --enable-xpm-background (default: on) +=item --enable-pixbuf (default: on) -Add support for XPM background pixmaps. +Add support for GDK-PixBuf to be used for background images. +It adds support for many file formats including JPG, PNG, +TIFF, GIF, XPM, BMP, ICO and TGA. -=item --enable-transparency (default: on) +=item --enable-startup-notification (default: on) -Add support for inheriting parent backgrounds thus giving a fake -transparency to the term. +Add support for freedesktop startup notifications. This allows window managers +to display some kind of progress indicator during startup. -=item --enable-fading (default: on) +=item --enable-transparency (default: on) -Add support for fading the text when focus is lost (requires C<--enable-transparency>). +Add support for using the root pixmap as background to simulate transparency. +Note that this feature depends on libXrender and on the availability +of the RENDER extension in the X server. -=item --enable-tinting (default: on) +=item --enable-fading (default: on) -Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). +Add support for fading the text when focus is lost. =item --enable-rxvt-scroll (default: on) @@ -2353,17 +2404,6 @@ 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-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. @@ -2392,29 +2432,33 @@ MWM-hints EWMH-hints (pid, utf8 names) and protocols (ping) - seperate underline colour (-underlineColor) + urgency hint + separate underline colour (-underlineColor) settable border widths and borderless switch (-w, -b, -bl) visual depth selection (-depth) - settable extra linespacing /-lsp) - iso-14755-2 and -3, and visual feedback + settable extra linespacing (-lsp) + iso-14755 5.1 (basic) support tripleclickwords (-tcw) settable insecure mode (-insecure) keysym remapping support - cursor blinking and underline cursor (-cb, -uc) + cursor blinking and underline cursor (-bc, -uc) XEmbed support (-embed) user-pty (-pty-fd) hold on exit (-hold) + compile in built-in block graphics skip builtin block graphics (-sbg) - separate highlightcolor support (-hc) + separate highlight colour (-highlightColor, -highlightTextColor) + extended mouse reporting modes (1005 and 1015). + visual selection via -visual and -depth. It also enables some non-essential features otherwise disabled, such as: some round-trip time optimisations - nearest color allocation on pseudocolor screens - UTF8_STRING supporr for selection + nearest colour allocation on pseudocolor screens + UTF8_STRING support for selection sgr modes 90..97 and 100..107 backindex and forwardindex escape sequences - view change/zero scorllback esacpe sequences + view change/zero scrollback escape sequences locale switching escape sequence window op and some xterm/OSC escape sequences rectangular selections @@ -2423,16 +2467,20 @@ =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. +Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)). +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-selectionscrolling (default: on) + +Add support for scrolling when the selection moves to the top or +bottom of the screen. + =item --enable-mousewheel (default: on) Add support for scrolling via mouse wheel or buttons 4 & 5. @@ -2443,30 +2491,15 @@ 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) +=item --enable-smart-resize (default: off) -Use Gray Watson's malloc - which is good for debugging See -L 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. +Add smart growth/shrink behaviour when resizing. +This should keep the window corner which is closest to a corner of +the screen in a fixed position. -=item --enable-smart-resize (default: on) +=item --enable-text-blink (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. +Add support for blinking text. =item --enable-pointer-blank (default: on) @@ -2475,10 +2508,31 @@ =item --enable-perl (default: on) 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. +manpage 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. Even when compiled in, +perl will I be initialised when all extensions have been disabled +C<-pe "" --perl-ext-common "">, so it should be safe to enable from a +resource standpoint. + +=item --enable-assert (default: off) + +Enables the assertions in the code, normally disabled. This switch is only +useful when developing rxvt-unicode. + +=item --enable-256-color (default: off) + +Force use of so-called 256 colour mode, to work around buggy applications +that do not support termcap/terminfo, or simply improve support for +applications hardcoding the xterm 256 colour table. + +This switch breaks termcap/terminfo compatibility to C, +and consequently sets C to C by default +(F contains termcap/terminfo definitions for both). + +It also results in higher memory usage and can slow down @@RXVT_NAME@@ +dramatically when more than six fonts are in use by a terminal instance. =item --with-name=NAME (default: urxvt) @@ -2499,18 +2553,6 @@ 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