--- rxvt-unicode/doc/rxvt.7.pod 2009/05/30 08:53:48 1.177 +++ rxvt-unicode/doc/rxvt.7.pod 2010/11/23 18:52:13 1.201 @@ -107,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? @@ -226,9 +227,10 @@ =head3 I can't get transparency working, what am I doing wrong? -First of all, please address all transparency related issues to Sasha Vasko at -sasha@aftercode.net and do not bug the author about it. Also, if you can't -get it working consider it a rite of passage: ... and you failed. +First of all, transparency isn't officially supported in rxvt-unicode, so +you are mostly on your own. Do not bug the author about it (but you may +bug everybody else). Also, if you can't get it working consider it a rite +of passage: ... and you failed. Here are four ways to get transparency. B read the manpage and option descriptions for the programs mentioned and rxvt-unicode. Really, do it! @@ -240,6 +242,9 @@ 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 @@ -248,7 +253,7 @@ 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 AfterImage support, or you +That works. If you think it doesn't, you lack libAfterImage or GDK-PixBuf support, or you are unable to read. 3. Use an ARGB visual: @@ -363,15 +368,15 @@ 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, @@ -395,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 @@ -560,6 +565,10 @@ 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 @@ -587,33 +596,16 @@ 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@@ + $ echo -n "^[[?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" + $ echo -n "^[[?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 @@ -716,7 +708,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 @@ -798,7 +790,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: @@ -819,7 +811,7 @@ 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 @@ -1131,7 +1123,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 @@ -1217,12 +1209,6 @@ http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c -=head3 I want 256 colors - -Are you sure you need 256 colors? 88 colors should be enough for most -purposes. If you really need more, there is an unsupported patch for -it in the doc directory, but please do not ask for it to be applied. - =head1 RXVT-UNICODE TECHNICAL REFERENCE The rest of this document describes various technical aspects of @@ -1331,7 +1317,7 @@ Application Keypad (SMKX). See also next sequence. -=item B<<< C<< ESC >> >>> +=item B<<< C<< ESC > >> >>> Normal Keypad (RMKX) @@ -1627,7 +1613,7 @@ 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 >> set fg/bg to colour #m (ISO 8613-6) B<< C >> fg/bg White B<< C >> fg/bg Default B<< C >> fg/bg Bright Black @@ -1883,8 +1869,8 @@ =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 @@ -2023,10 +2009,9 @@ 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 BACKGROUND IMAGE) (Compile AfterImage). + 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 afterimage or 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 >>. [deprecated, use 11] @@ -2054,66 +2039,21 @@ =head1 BACKGROUND IMAGE For the BACKGROUND IMAGE XTerm escape sequence B<< C >> the value -of B<< C >> can be the name of the background image file followed by a -sequence of scaling/positioning commands separated by semi-colons. The -scaling/positioning commands are as follows: - -=over 4 - -=item query scale/position - -B - -=item change scale and position - -B - -B (== B) - -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 - -=back - -For example: +of B<< C >> can be one of the following commands: =over 4 -=item B<\E]20;funky.jpg\a> +=item B<< C >> -load B as a tiled image +display scale and position in the title -=item B<\E]20;mona.jpg;100\a> +=item B<< C<;WxH+X+Y> >> -load B with a scaling of 100% +change scale and/or position -=item B<\E]20;;200;?\a> +=item B<< C >> -rescale the current pixmap to 200% and display the image geometry in -the title +change background image =back @@ -2177,7 +2117,7 @@ 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 @@ -2257,8 +2197,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, @@ -2323,7 +2264,7 @@ 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 +where accents are encoded as separate unicode characters. This is done by using precomposited characters when available or creating new pseudo-characters when no precomposed form exists. @@ -2373,22 +2314,28 @@ =item --enable-afterimage (default: on) -Add support for libAfterImage to be used for transparency and background +Add support for libAfterImage to be used for background images. It adds support for many file formats including JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML (L). -This option also adds such eye candy as blending an image over the root -background, as well as dynamic scaling and bluring of background images. - Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might increase by a few megabytes even if no extra features are used (mostly due to third-party libraries used by libAI). Memory footprint may somewhat be lowered if libAfterImage is configured without support for SVG. +=item --enable-pixbuf (default: off) + +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) -Add support for backgrounds, creating illusion of transparency in the term. +Add support for using the root pixmap as background to simulate transparency. +Note that tint, blur and blend effects depend on libAfterImage or on +libXrender and on the availability of the RENDER extension in the X +server. =item --enable-fading (default: on) @@ -2435,10 +2382,10 @@ MWM-hints EWMH-hints (pid, utf8 names) and protocols (ping) urgency hint - seperate underline colour (-underlineColor) + separate underline colour (-underlineColor) settable border widths and borderless switch (-w, -b, -bl) visual depth selection (-depth) - settable extra linespacing /-lsp) + settable extra linespacing (-lsp) iso-14755 5.1 (basic) support tripleclickwords (-tcw) settable insecure mode (-insecure) @@ -2449,12 +2396,12 @@ hold on exit (-hold) compile in built-in block graphics skip builtin block graphics (-sbg) - separate highlightcolor support (-hc) + separate highlight colour (-highlightColor, -highlightTextColor) It also enables some non-essential features otherwise disabled, such as: some round-trip time optimisations - nearest color allocation on pseudocolor screens + nearest colour allocation on pseudocolor screens UTF8_STRING support for selection sgr modes 90..97 and 100..107 backindex and forwardindex escape sequences @@ -2516,6 +2463,24 @@ 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-afterimage-config=DIR Look for the libAfterImage config script in DIR.