ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.123 by root, Sat Dec 16 03:48:49 2006 UTC vs.
Revision 1.144 by ayin, Fri Aug 3 23:32:14 2007 UTC

… …
125 fi 125 fi
126 126
127=head3 How do I compile the manual pages on my own? 127=head3 How do I compile the manual pages on my own?
128 128
129You need to have a recent version of perl installed as F</usr/bin/perl>, 129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131the doc subdirectory and enter C<make alldoc>. 131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134 134
135I often get asked about this, and I think, no, they didn't cause extra 135I often get asked about this, and I think, no, they didn't cause extra
136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
562Backspace keysym (not likely for Linux ... see the following 562Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 563question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 564Backspace: C<^H> and C<^?>.
565 565
566Historically, either value is correct, but rxvt-unicode adopts the debian 566Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 567policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 568choice :).
569 569
570Rxvt-unicode tries to inherit the current stty settings and uses the value 570Rxvt-unicode tries to inherit the current stty settings and uses the value
571of `erase' to guess the value for backspace. If rxvt-unicode wasn't 571of `erase' to guess the value for backspace. If rxvt-unicode wasn't
572started from a terminal (say, from a menu or by remote shell), then the 572started from a terminal (say, from a menu or by remote shell), then the
… …
956If you encounter strange problems like typing an accented character but 956If you encounter strange problems like typing an accented character but
957getting two unrelated other characters or similar, or if program output is 957getting two unrelated other characters or similar, or if program output is
958subtly garbled, then you should check your locale settings. 958subtly garbled, then you should check your locale settings.
959 959
960Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 960Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
961programs. Often rxvt-unicode is started in the C<C> locale, while the 961programs running in it. Often rxvt-unicode is started in the C<C> locale,
962login script running within the rxvt-unicode window changes the locale to 962while the login script running within the rxvt-unicode window changes the
963something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 963locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
964not going to work, and is the most common cause for problems.
964 965
965The best thing is to fix your startup environment, as you will likely run 966The best thing is to fix your startup environment, as you will likely run
966into other problems. If nothing works you can try this in your .profile. 967into other problems. If nothing works you can try this in your .profile.
967 968
968 printf '\33]701;%s\007' "$LC_CTYPE" 969 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
969 970
970If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 971If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
971supported on your systems. Some systems have a C<locale> command which 972supported on your systems. Some systems have a C<locale> command which
972displays this (also, C<perl -e0> can be used to check locale settings, as 973displays this (also, C<perl -e0> can be used to check locale settings, as
973it will complain loudly if it cannot set the locale). If it displays something 974it will complain loudly if it cannot set the locale). If it displays something
… …
1150This forking is done as the very first within main(), which is very early 1151This forking is done as the very first within main(), which is very early
1151and reduces possible bugs to initialisation code run before main(), or 1152and reduces possible bugs to initialisation code run before main(), or
1152things like the dynamic loader of your system, which should result in very 1153things like the dynamic loader of your system, which should result in very
1153little risk. 1154little risk.
1154 1155
1155=head3 On Solaris 9, many line-drawing characters are too wide.
1156
1157Seems to be a known bug, read
1158L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1159following ugly workaround to get non-double-wide-characters working:
1160
1161 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1162
1163=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1156=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1164 1157
1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1158Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1166in your compile environment, or an implementation that implements it, 1159in your compile environment, or an implementation that implements it,
1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1160whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
… …
1190 1183
1191The rxvt-unicode author insists that the right way to fix this is in the 1184The rxvt-unicode author insists that the right way to fix this is in the
1192system libraries once and for all, instead of forcing every app to carry 1185system libraries once and for all, instead of forcing every app to carry
1193complete replacements for them :) 1186complete replacements for them :)
1194 1187
1195=head3 I use Solaris 9 and it doesn't compile/work/etc.
1196
1197Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1198problems with C<wcwidth> and a compile problem.
1199
1200=head3 How can I use rxvt-unicode under cygwin? 1188=head3 How can I use rxvt-unicode under cygwin?
1201 1189
1202rxvt-unicode should compile and run out of the box on cygwin, using 1190rxvt-unicode should compile and run out of the box on cygwin, using
1203the X11 libraries that come with cygwin. libW11 emulation is no 1191the X11 libraries that come with cygwin. libW11 emulation is no
1204longer supported (and makes no sense, either, as it only supported a 1192longer supported (and makes no sense, either, as it only supported a
… …
1207old libW11 emulation. 1195old libW11 emulation.
1208 1196
1209At the time of this writing, cygwin didn't seem to support any multi-byte 1197At the time of this writing, cygwin didn't seem to support any multi-byte
1210encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1198encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1211to 8-bit encodings. 1199to 8-bit encodings.
1200
1201=head3 Character widths are not correct.
1202
1203urxvt uses the system wcwidth function to know the information about
1204the width of characters, so on systems with incorrect locale data you
1205will likely get bad results. Two notorious examples are Solaris 9,
1206where single-width characters like U+2514 are reported as double-width,
1207and Darwin 8, where combining chars are reported having width 1.
1208
1209The solution is to upgrade your system or switch to a better one. A
1210possibly working workaround is to use a wcwidth implementation like
1211
1212http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1212 1213
1213=head1 RXVT-UNICODE TECHNICAL REFERENCE 1214=head1 RXVT-UNICODE TECHNICAL REFERENCE
1214 1215
1215The rest of this document describes various technical aspects of 1216The rest of this document describes various technical aspects of
1216B<rxvt-unicode>. First the description of supported command sequences, 1217B<rxvt-unicode>. First the description of supported command sequences,
… …
2200 2201
2201=head1 CONFIGURE OPTIONS 2202=head1 CONFIGURE OPTIONS
2202 2203
2203General hint: if you get compile errors, then likely your configuration 2204General hint: if you get compile errors, then likely your configuration
2204hasn't been tested well. Either try with C<--enable-everything> or use 2205hasn't been tested well. Either try with C<--enable-everything> or use
2205the F<./reconf> script as a base for experiments. F<./reconf> is used by 2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of
2206myself, so it should generally be a working config. Of course, you should 2207course, you should always report when a combination doesn't work, so it
2207always report when a combination doesn't work, so it can be fixed. Marc 2208can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2208Lehmann <rxvt@schmorp.de>.
2209 2209
2210All 2210All
2211 2211
2212=over 4 2212=over 4
2213 2213
… …
2245 2245
2246=begin table 2246=begin table
2247 2247
2248 all all available codeset groups 2248 all all available codeset groups
2249 zh common chinese encodings 2249 zh common chinese encodings
2250 zh_ext rarely used but very big chinese encodigs 2250 zh_ext rarely used but very big chinese encodings
2251 jp common japanese encodings 2251 jp common japanese encodings
2252 jp_ext rarely used but big japanese encodings 2252 jp_ext rarely used but big japanese encodings
2253 kr korean encodings 2253 kr korean encodings
2254 2254
2255=end table 2255=end table
… …
2269requirements per character from 2 to 4 bytes. X11 fonts do not yet 2269requirements per character from 2 to 4 bytes. X11 fonts do not yet
2270support these extra characters, but Xft does. 2270support these extra characters, but Xft does.
2271 2271
2272Please note that rxvt-unicode can store unicode code points >65535 2272Please note that rxvt-unicode can store unicode code points >65535
2273even without this flag, but the number of such characters is 2273even without this flag, but the number of such characters is
2274limited to a view thousand (shared with combining characters, 2274limited to a few thousand (shared with combining characters,
2275see next switch), and right now rxvt-unicode cannot display them 2275see next switch), and right now rxvt-unicode cannot display them
2276(input/output and cut&paste still work, though). 2276(input/output and cut&paste still work, though).
2277 2277
2278=item --enable-combining (default: on) 2278=item --enable-combining (default: on)
2279 2279
… …
2325 2325
2326Write user and tty to lastlog file (used by programs like 2326Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires 2327F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified. 2328--enable-utmp to also be specified.
2329 2329
2330=item --enable-xpm-background (default: on) 2330=item --enable-afterimage (default: on)
2331 2331
2332Add support for XPM background pixmaps. 2332Add support for libAfterImage to be used for transparency and background
2333images. It adds support for many file formats including JPG, PNG,
2334SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2335(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2336
2337This option also adds such eye candy as blending an image over the root
2338background, as well as dynamic scaling and bluring of background images.
2339
2340Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2341increase by a few megabytes even if no extra features are used (mostly due
2342to third-party libraries used by libAI). Memory footprint may somewhat be
2343lowered if libAfterImage is configured without support for SVG.
2333 2344
2334=item --enable-transparency (default: on) 2345=item --enable-transparency (default: on)
2335 2346
2336Add support for inheriting parent backgrounds thus giving a fake 2347Add support for inheriting parent backgrounds thus giving a fake
2337transparency to the term. 2348transparency to the term.
2338 2349
2339=item --enable-fading (default: on) 2350=item --enable-fading (default: on)
2340 2351
2341Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2352Add support for fading the text when focus is lost.
2342
2343=item --enable-tinting (default: on)
2344
2345Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2346 2353
2347=item --enable-rxvt-scroll (default: on) 2354=item --enable-rxvt-scroll (default: on)
2348 2355
2349Add support for the original rxvt scrollbar. 2356Add support for the original rxvt scrollbar.
2350 2357
… …
2393A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2400A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2394in combination with other switches) is: 2401in combination with other switches) is:
2395 2402
2396 MWM-hints 2403 MWM-hints
2397 EWMH-hints (pid, utf8 names) and protocols (ping) 2404 EWMH-hints (pid, utf8 names) and protocols (ping)
2405 urgency hint
2398 seperate underline colour (-underlineColor) 2406 seperate underline colour (-underlineColor)
2399 settable border widths and borderless switch (-w, -b, -bl) 2407 settable border widths and borderless switch (-w, -b, -bl)
2400 visual depth selection (-depth) 2408 visual depth selection (-depth)
2401 settable extra linespacing /-lsp) 2409 settable extra linespacing /-lsp)
2402 iso-14755-2 and -3, and visual feedback 2410 iso-14755 5.1 (basic) support
2403 tripleclickwords (-tcw) 2411 tripleclickwords (-tcw)
2404 settable insecure mode (-insecure) 2412 settable insecure mode (-insecure)
2405 keysym remapping support 2413 keysym remapping support
2406 cursor blinking and underline cursor (-cb, -uc) 2414 cursor blinking and underline cursor (-cb, -uc)
2407 XEmbed support (-embed) 2415 XEmbed support (-embed)
… …
2412 2420
2413It also enables some non-essential features otherwise disabled, such as: 2421It also enables some non-essential features otherwise disabled, such as:
2414 2422
2415 some round-trip time optimisations 2423 some round-trip time optimisations
2416 nearest color allocation on pseudocolor screens 2424 nearest color allocation on pseudocolor screens
2417 UTF8_STRING supporr for selection 2425 UTF8_STRING support for selection
2418 sgr modes 90..97 and 100..107 2426 sgr modes 90..97 and 100..107
2419 backindex and forwardindex escape sequences 2427 backindex and forwardindex escape sequences
2420 view change/zero scorllback esacpe sequences 2428 view change/zero scrollback escape sequences
2421 locale switching escape sequence 2429 locale switching escape sequence
2422 window op and some xterm/OSC escape sequences 2430 window op and some xterm/OSC escape sequences
2423 rectangular selections 2431 rectangular selections
2424 trailing space removal for selections 2432 trailing space removal for selections
2425 verbose X error handling 2433 verbose X error handling
… …
2434=item --enable-keepscrolling (default: on) 2442=item --enable-keepscrolling (default: on)
2435 2443
2436Add support for continual scrolling of the display when you hold 2444Add support for continual scrolling of the display when you hold
2437the mouse button down on a scrollbar arrow. 2445the mouse button down on a scrollbar arrow.
2438 2446
2447=item --enable-selectionscrolling (default: on)
2448
2449Add support for scrolling when the selection moves to the top or
2450bottom of the screen.
2451
2439=item --enable-mousewheel (default: on) 2452=item --enable-mousewheel (default: on)
2440 2453
2441Add support for scrolling via mouse wheel or buttons 4 & 5. 2454Add support for scrolling via mouse wheel or buttons 4 & 5.
2442 2455
2443=item --enable-slipwheeling (default: on) 2456=item --enable-slipwheeling (default: on)
2444 2457
2445Add support for continual scrolling (using the mouse wheel as an 2458Add support for continual scrolling (using the mouse wheel as an
2446accelerator) while the control key is held down. This option 2459accelerator) while the control key is held down. This option
2447requires --enable-mousewheel to also be specified. 2460requires --enable-mousewheel to also be specified.
2448 2461
2449=item --disable-new-selection
2450
2451Remove support for mouse selection style like that of xterm.
2452
2453=item --enable-dmalloc (default: off)
2454
2455Use Gray Watson's malloc - which is good for debugging See
2456L<http://www.letters.com/dmalloc/> for details If you use either this or the
2457next option, you may need to edit src/Makefile after compiling to point
2458DINCLUDE and DLIB to the right places.
2459
2460You can only use either this option and the following (should
2461you use either) .
2462
2463=item --enable-dlmalloc (default: off)
2464
2465Use Doug Lea's malloc - which is good for a production version
2466See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2467
2468=item --enable-smart-resize (default: on) 2462=item --enable-smart-resize (default: off)
2469 2463
2470Add smart growth/shrink behaviour when changing font size via hot 2464Add smart growth/shrink behaviour when resizing.
2471keys. This should keep the window corner which is closest to a corner of 2465This should keep the window corner which is closest to a corner of
2472the screen in a fixed position. 2466the screen in a fixed position.
2473 2467
2474=item --enable-pointer-blank (default: on) 2468=item --enable-pointer-blank (default: on)
2475 2469
2476Add support to have the pointer disappear when typing or inactive. 2470Add support to have the pointer disappear when typing or inactive.
2477 2471
2478=item --enable-perl (default: on) 2472=item --enable-perl (default: on)
2479 2473
2480Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2474Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2481manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2475manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2482in F<src/perl-ext/> for the extensions that are installed by default. The 2476files in F<src/perl-ext/> for the extensions that are installed by
2483perl interpreter that is used can be specified via the C<PERL> environment 2477default. The perl interpreter that is used can be specified via the
2484variable when running configure. 2478C<PERL> environment variable when running configure. Even when compiled
2479in, perl will I<not> be initialised when all extensions have been disabled
2480C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2481resource standpoint.
2482
2483=item --with-afterimage-config=DIR
2484
2485Look for the libAfterImage config script in DIR.
2485 2486
2486=item --with-name=NAME (default: urxvt) 2487=item --with-name=NAME (default: urxvt)
2487 2488
2488Set the basename for the installed binaries, resulting 2489Set the basename for the installed binaries, resulting
2489in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2490in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2499PATH. 2500PATH.
2500 2501
2501=item --with-x 2502=item --with-x
2502 2503
2503Use the X Window System (pretty much default, eh?). 2504Use the X Window System (pretty much default, eh?).
2504
2505=item --with-xpm-includes=DIR
2506
2507Look for the XPM includes in DIR.
2508
2509=item --with-xpm-library=DIR
2510
2511Look for the XPM library in DIR.
2512
2513=item --with-xpm
2514
2515Not needed - define via --enable-xpm-background.
2516 2505
2517=back 2506=back
2518 2507
2519=head1 AUTHORS 2508=head1 AUTHORS
2520 2509

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines