--- rxvt-unicode/doc/rxvt.7.pod 2006/08/07 15:59:44 1.120 +++ rxvt-unicode/doc/rxvt.7.pod 2007/11/15 18:40:10 1.151 @@ -19,7 +19,7 @@ all escape sequences, and other background information. The newest version of this document is also available on the World Wide Web at -L. +L. =head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS @@ -75,7 +75,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: @@ -127,8 +127,8 @@ =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? @@ -199,9 +199,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 :) @@ -211,18 +211,17 @@ =head3 I can't get transparency working, what am I doing wrong? -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. +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. 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. @@ -231,10 +230,10 @@ 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 AfterImage support, or you are unable to read. 3. Use an ARGB visual: @@ -462,6 +461,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? @@ -564,7 +570,7 @@ 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 @@ -606,7 +612,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. @@ -657,7 +663,6 @@ required for your particular machine. - =head2 Terminal Configuration =head3 Can I see a typical configuration? @@ -840,13 +845,16 @@ 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 like this (with ncurses' infocmp and works as user and admin): 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. + 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 @@ -955,14 +963,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,7 +1075,7 @@ xprop -root XIM_SERVERS -=item +=item =back @@ -1149,14 +1158,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 @@ -1189,11 +1190,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 +1203,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 @@ -1897,6 +1906,24 @@ =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 >> (B) =begin table @@ -1981,7 +2008,7 @@ 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 background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage). 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 >>. @@ -2005,10 +2032,10 @@ =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 +For the BACGROUND IMAGE XTerm escape sequence B<< C >> then 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: @@ -2056,13 +2083,13 @@ =over 4 -=item B<\E]20;funky\a> +=item B<\E]20;funky.jpg\a> -load B as a tiled image +load B as a tiled image -=item B<\E]20;mona;100\a> +=item B<\E]20;mona.jpg;100\a> -load B with a scaling of 100% +load B with a scaling of 100% =item B<\E]20;;200;?\a> @@ -2199,10 +2226,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 @@ -2244,7 +2270,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 +2294,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). @@ -2324,22 +2350,28 @@ F) at start of rxvt execution. This option requires --enable-utmp to also be specified. -=item --enable-xpm-background (default: on) +=item --enable-afterimage (default: on) -Add support for XPM background pixmaps. +Add support for libAfterImage to be used for transparency and 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-transparency (default: on) -Add support for inheriting parent backgrounds thus giving a fake -transparency to the term. +Add support for backgrounds, creating illusion of transparency in 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>). +Add support for fading the text when focus is lost. =item --enable-rxvt-scroll (default: on) @@ -2392,11 +2424,12 @@ MWM-hints EWMH-hints (pid, utf8 names) and protocols (ping) + urgency hint seperate 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 + iso-14755 5.1 (basic) support tripleclickwords (-tcw) settable insecure mode (-insecure) keysym remapping support @@ -2411,10 +2444,10 @@ some round-trip time optimisations nearest color allocation on pseudocolor screens - UTF8_STRING supporr for selection + 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 @@ -2433,6 +2466,11 @@ 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,29 +2481,10 @@ 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 -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. +=item --enable-smart-resize (default: off) -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 +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-pointer-blank (default: on) @@ -2475,10 +2494,17 @@ =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 (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. 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 --with-afterimage-config=DIR + +Look for the libAfterImage config script in DIR. =item --with-name=NAME (default: urxvt) @@ -2499,18 +2525,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