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.145 by root, Sun Sep 9 08:38:40 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
… …
460has been designed yet). 460has been designed yet).
461 461
462Until then, you might get away with switching fonts at runtime (see L<Can 462Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 463I switch the fonts at runtime?> later in this document).
464 464
465=head3 How can I make mplayer display video correctly?
466
467We are working on it, in the meantime, as a workaround, use something like:
468
469 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
470
471
465=head2 Keyboard, Mouse & User Interaction 472=head2 Keyboard, Mouse & User Interaction
466 473
467=head3 The new selection selects pieces that are too big, how can I select single words? 474=head3 The new selection selects pieces that are too big, how can I select single words?
468 475
469If you want to select e.g. alphanumeric words, you can use the following 476If you want to select e.g. alphanumeric words, you can use the following
… …
562Backspace keysym (not likely for Linux ... see the following 569Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 570question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 571Backspace: C<^H> and C<^?>.
565 572
566Historically, either value is correct, but rxvt-unicode adopts the debian 573Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 574policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 575choice :).
569 576
570Rxvt-unicode tries to inherit the current stty settings and uses the value 577Rxvt-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 578of `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 579started from a terminal (say, from a menu or by remote shell), then the
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 662Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 663keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 664required for your particular machine.
658 665
659 666
660
661=head2 Terminal Configuration 667=head2 Terminal Configuration
662 668
663=head3 Can I see a typical configuration? 669=head3 Can I see a typical configuration?
664 670
665The default configuration tries to be xterm-like, which I don't like that 671The default configuration tries to be xterm-like, which I don't like that
… …
956If you encounter strange problems like typing an accented character but 962If you encounter strange problems like typing an accented character but
957getting two unrelated other characters or similar, or if program output is 963getting two unrelated other characters or similar, or if program output is
958subtly garbled, then you should check your locale settings. 964subtly garbled, then you should check your locale settings.
959 965
960Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 966Rxvt-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 967programs 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 968while 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. 969locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
970not going to work, and is the most common cause for problems.
964 971
965The best thing is to fix your startup environment, as you will likely run 972The 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. 973into other problems. If nothing works you can try this in your .profile.
967 974
968 printf '\33]701;%s\007' "$LC_CTYPE" 975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
969 976
970If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 977If 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 978supported 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 979displays 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 980it 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 1157This forking is done as the very first within main(), which is very early
1151and reduces possible bugs to initialisation code run before main(), or 1158and reduces possible bugs to initialisation code run before main(), or
1152things like the dynamic loader of your system, which should result in very 1159things like the dynamic loader of your system, which should result in very
1153little risk. 1160little risk.
1154 1161
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. 1162=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1164 1163
1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1164Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1166in your compile environment, or an implementation that implements it, 1165in your compile environment, or an implementation that implements it,
1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1166whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
… …
1190 1189
1191The rxvt-unicode author insists that the right way to fix this is in the 1190The 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 1191system libraries once and for all, instead of forcing every app to carry
1193complete replacements for them :) 1192complete replacements for them :)
1194 1193
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? 1194=head3 How can I use rxvt-unicode under cygwin?
1201 1195
1202rxvt-unicode should compile and run out of the box on cygwin, using 1196rxvt-unicode should compile and run out of the box on cygwin, using
1203the X11 libraries that come with cygwin. libW11 emulation is no 1197the X11 libraries that come with cygwin. libW11 emulation is no
1204longer supported (and makes no sense, either, as it only supported a 1198longer supported (and makes no sense, either, as it only supported a
… …
1207old libW11 emulation. 1201old libW11 emulation.
1208 1202
1209At the time of this writing, cygwin didn't seem to support any multi-byte 1203At 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 1204encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1211to 8-bit encodings. 1205to 8-bit encodings.
1206
1207=head3 Character widths are not correct.
1208
1209urxvt uses the system wcwidth function to know the information about
1210the width of characters, so on systems with incorrect locale data you
1211will likely get bad results. Two notorious examples are Solaris 9,
1212where single-width characters like U+2514 are reported as double-width,
1213and Darwin 8, where combining chars are reported having width 1.
1214
1215The solution is to upgrade your system or switch to a better one. A
1216possibly working workaround is to use a wcwidth implementation like
1217
1218http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1212 1219
1213=head1 RXVT-UNICODE TECHNICAL REFERENCE 1220=head1 RXVT-UNICODE TECHNICAL REFERENCE
1214 1221
1215The rest of this document describes various technical aspects of 1222The rest of this document describes various technical aspects of
1216B<rxvt-unicode>. First the description of supported command sequences, 1223B<rxvt-unicode>. First the description of supported command sequences,
… …
2200 2207
2201=head1 CONFIGURE OPTIONS 2208=head1 CONFIGURE OPTIONS
2202 2209
2203General hint: if you get compile errors, then likely your configuration 2210General hint: if you get compile errors, then likely your configuration
2204hasn't been tested well. Either try with C<--enable-everything> or use 2211hasn'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 2212the 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 2213course, 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 2214can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2208Lehmann <rxvt@schmorp.de>.
2209 2215
2210All 2216All
2211 2217
2212=over 4 2218=over 4
2213 2219
… …
2245 2251
2246=begin table 2252=begin table
2247 2253
2248 all all available codeset groups 2254 all all available codeset groups
2249 zh common chinese encodings 2255 zh common chinese encodings
2250 zh_ext rarely used but very big chinese encodigs 2256 zh_ext rarely used but very big chinese encodings
2251 jp common japanese encodings 2257 jp common japanese encodings
2252 jp_ext rarely used but big japanese encodings 2258 jp_ext rarely used but big japanese encodings
2253 kr korean encodings 2259 kr korean encodings
2254 2260
2255=end table 2261=end table
… …
2269requirements per character from 2 to 4 bytes. X11 fonts do not yet 2275requirements per character from 2 to 4 bytes. X11 fonts do not yet
2270support these extra characters, but Xft does. 2276support these extra characters, but Xft does.
2271 2277
2272Please note that rxvt-unicode can store unicode code points >65535 2278Please note that rxvt-unicode can store unicode code points >65535
2273even without this flag, but the number of such characters is 2279even without this flag, but the number of such characters is
2274limited to a view thousand (shared with combining characters, 2280limited to a few thousand (shared with combining characters,
2275see next switch), and right now rxvt-unicode cannot display them 2281see next switch), and right now rxvt-unicode cannot display them
2276(input/output and cut&paste still work, though). 2282(input/output and cut&paste still work, though).
2277 2283
2278=item --enable-combining (default: on) 2284=item --enable-combining (default: on)
2279 2285
… …
2325 2331
2326Write user and tty to lastlog file (used by programs like 2332Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires 2333F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified. 2334--enable-utmp to also be specified.
2329 2335
2330=item --enable-xpm-background (default: on) 2336=item --enable-afterimage (default: on)
2331 2337
2332Add support for XPM background pixmaps. 2338Add support for libAfterImage to be used for transparency and background
2339images. It adds support for many file formats including JPG, PNG,
2340SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2341(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2342
2343This option also adds such eye candy as blending an image over the root
2344background, as well as dynamic scaling and bluring of background images.
2345
2346Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2347increase by a few megabytes even if no extra features are used (mostly due
2348to third-party libraries used by libAI). Memory footprint may somewhat be
2349lowered if libAfterImage is configured without support for SVG.
2333 2350
2334=item --enable-transparency (default: on) 2351=item --enable-transparency (default: on)
2335 2352
2336Add support for inheriting parent backgrounds thus giving a fake 2353Add support for inheriting parent backgrounds thus giving a fake
2337transparency to the term. 2354transparency to the term.
2338 2355
2339=item --enable-fading (default: on) 2356=item --enable-fading (default: on)
2340 2357
2341Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2358Add 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 2359
2347=item --enable-rxvt-scroll (default: on) 2360=item --enable-rxvt-scroll (default: on)
2348 2361
2349Add support for the original rxvt scrollbar. 2362Add support for the original rxvt scrollbar.
2350 2363
… …
2393A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2406A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2394in combination with other switches) is: 2407in combination with other switches) is:
2395 2408
2396 MWM-hints 2409 MWM-hints
2397 EWMH-hints (pid, utf8 names) and protocols (ping) 2410 EWMH-hints (pid, utf8 names) and protocols (ping)
2411 urgency hint
2398 seperate underline colour (-underlineColor) 2412 seperate underline colour (-underlineColor)
2399 settable border widths and borderless switch (-w, -b, -bl) 2413 settable border widths and borderless switch (-w, -b, -bl)
2400 visual depth selection (-depth) 2414 visual depth selection (-depth)
2401 settable extra linespacing /-lsp) 2415 settable extra linespacing /-lsp)
2402 iso-14755-2 and -3, and visual feedback 2416 iso-14755 5.1 (basic) support
2403 tripleclickwords (-tcw) 2417 tripleclickwords (-tcw)
2404 settable insecure mode (-insecure) 2418 settable insecure mode (-insecure)
2405 keysym remapping support 2419 keysym remapping support
2406 cursor blinking and underline cursor (-cb, -uc) 2420 cursor blinking and underline cursor (-cb, -uc)
2407 XEmbed support (-embed) 2421 XEmbed support (-embed)
… …
2412 2426
2413It also enables some non-essential features otherwise disabled, such as: 2427It also enables some non-essential features otherwise disabled, such as:
2414 2428
2415 some round-trip time optimisations 2429 some round-trip time optimisations
2416 nearest color allocation on pseudocolor screens 2430 nearest color allocation on pseudocolor screens
2417 UTF8_STRING supporr for selection 2431 UTF8_STRING support for selection
2418 sgr modes 90..97 and 100..107 2432 sgr modes 90..97 and 100..107
2419 backindex and forwardindex escape sequences 2433 backindex and forwardindex escape sequences
2420 view change/zero scorllback esacpe sequences 2434 view change/zero scrollback escape sequences
2421 locale switching escape sequence 2435 locale switching escape sequence
2422 window op and some xterm/OSC escape sequences 2436 window op and some xterm/OSC escape sequences
2423 rectangular selections 2437 rectangular selections
2424 trailing space removal for selections 2438 trailing space removal for selections
2425 verbose X error handling 2439 verbose X error handling
… …
2434=item --enable-keepscrolling (default: on) 2448=item --enable-keepscrolling (default: on)
2435 2449
2436Add support for continual scrolling of the display when you hold 2450Add support for continual scrolling of the display when you hold
2437the mouse button down on a scrollbar arrow. 2451the mouse button down on a scrollbar arrow.
2438 2452
2453=item --enable-selectionscrolling (default: on)
2454
2455Add support for scrolling when the selection moves to the top or
2456bottom of the screen.
2457
2439=item --enable-mousewheel (default: on) 2458=item --enable-mousewheel (default: on)
2440 2459
2441Add support for scrolling via mouse wheel or buttons 4 & 5. 2460Add support for scrolling via mouse wheel or buttons 4 & 5.
2442 2461
2443=item --enable-slipwheeling (default: on) 2462=item --enable-slipwheeling (default: on)
2444 2463
2445Add support for continual scrolling (using the mouse wheel as an 2464Add support for continual scrolling (using the mouse wheel as an
2446accelerator) while the control key is held down. This option 2465accelerator) while the control key is held down. This option
2447requires --enable-mousewheel to also be specified. 2466requires --enable-mousewheel to also be specified.
2448 2467
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) 2468=item --enable-smart-resize (default: off)
2469 2469
2470Add smart growth/shrink behaviour when changing font size via hot 2470Add smart growth/shrink behaviour when resizing.
2471keys. This should keep the window corner which is closest to a corner of 2471This should keep the window corner which is closest to a corner of
2472the screen in a fixed position. 2472the screen in a fixed position.
2473 2473
2474=item --enable-pointer-blank (default: on) 2474=item --enable-pointer-blank (default: on)
2475 2475
2476Add support to have the pointer disappear when typing or inactive. 2476Add support to have the pointer disappear when typing or inactive.
2477 2477
2478=item --enable-perl (default: on) 2478=item --enable-perl (default: on)
2479 2479
2480Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2480Enable 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 2481manpage (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 2482files 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 2483default. The perl interpreter that is used can be specified via the
2484variable when running configure. 2484C<PERL> environment variable when running configure. Even when compiled
2485in, perl will I<not> be initialised when all extensions have been disabled
2486C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2487resource standpoint.
2488
2489=item --with-afterimage-config=DIR
2490
2491Look for the libAfterImage config script in DIR.
2485 2492
2486=item --with-name=NAME (default: urxvt) 2493=item --with-name=NAME (default: urxvt)
2487 2494
2488Set the basename for the installed binaries, resulting 2495Set the basename for the installed binaries, resulting
2489in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2496in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2499PATH. 2506PATH.
2500 2507
2501=item --with-x 2508=item --with-x
2502 2509
2503Use the X Window System (pretty much default, eh?). 2510Use 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 2511
2517=back 2512=back
2518 2513
2519=head1 AUTHORS 2514=head1 AUTHORS
2520 2515

Diff Legend

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