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.127 by root, Mon Apr 30 20:06:23 2007 UTC vs.
Revision 1.143 by ayin, Thu Aug 2 00:09:54 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
… …
1151This 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
1152and reduces possible bugs to initialisation code run before main(), or 1152and reduces possible bugs to initialisation code run before main(), or
1153things 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
1154little risk. 1154little risk.
1155 1155
1156=head3 On Solaris 9, many line-drawing characters are too wide.
1157
1158Seems to be a known bug, read
1159L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1160following ugly workaround to get non-double-wide-characters working:
1161
1162 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1163
1164=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.
1165 1157
1166Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1158Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1167in your compile environment, or an implementation that implements it, 1159in your compile environment, or an implementation that implements it,
1168whether 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
… …
1191 1183
1192The 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
1193system 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
1194complete replacements for them :) 1186complete replacements for them :)
1195 1187
1196=head3 I use Solaris 9 and it doesn't compile/work/etc.
1197
1198Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1199problems with C<wcwidth> and a compile problem.
1200
1201=head3 How can I use rxvt-unicode under cygwin? 1188=head3 How can I use rxvt-unicode under cygwin?
1202 1189
1203rxvt-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
1204the X11 libraries that come with cygwin. libW11 emulation is no 1191the X11 libraries that come with cygwin. libW11 emulation is no
1205longer supported (and makes no sense, either, as it only supported a 1192longer supported (and makes no sense, either, as it only supported a
… …
1208old libW11 emulation. 1195old libW11 emulation.
1209 1196
1210At 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
1211encodings (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
1212to 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
1213 1213
1214=head1 RXVT-UNICODE TECHNICAL REFERENCE 1214=head1 RXVT-UNICODE TECHNICAL REFERENCE
1215 1215
1216The rest of this document describes various technical aspects of 1216The rest of this document describes various technical aspects of
1217B<rxvt-unicode>. First the description of supported command sequences, 1217B<rxvt-unicode>. First the description of supported command sequences,
… …
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 2353
2343=item --enable-tinting (default: on) 2354=item --enable-tinting (default: on)
2344 2355
2345Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2346 2357
… …
2393A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2404A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2394in combination with other switches) is: 2405in combination with other switches) is:
2395 2406
2396 MWM-hints 2407 MWM-hints
2397 EWMH-hints (pid, utf8 names) and protocols (ping) 2408 EWMH-hints (pid, utf8 names) and protocols (ping)
2409 urgency hint
2398 seperate underline colour (-underlineColor) 2410 seperate underline colour (-underlineColor)
2399 settable border widths and borderless switch (-w, -b, -bl) 2411 settable border widths and borderless switch (-w, -b, -bl)
2400 visual depth selection (-depth) 2412 visual depth selection (-depth)
2401 settable extra linespacing /-lsp) 2413 settable extra linespacing /-lsp)
2402 iso-14755-2 and -3, and visual feedback 2414 iso-14755 5.1 (basic) support
2403 tripleclickwords (-tcw) 2415 tripleclickwords (-tcw)
2404 settable insecure mode (-insecure) 2416 settable insecure mode (-insecure)
2405 keysym remapping support 2417 keysym remapping support
2406 cursor blinking and underline cursor (-cb, -uc) 2418 cursor blinking and underline cursor (-cb, -uc)
2407 XEmbed support (-embed) 2419 XEmbed support (-embed)
… …
2434=item --enable-keepscrolling (default: on) 2446=item --enable-keepscrolling (default: on)
2435 2447
2436Add support for continual scrolling of the display when you hold 2448Add support for continual scrolling of the display when you hold
2437the mouse button down on a scrollbar arrow. 2449the mouse button down on a scrollbar arrow.
2438 2450
2451=item --enable-selectionscrolling (default: on)
2452
2453Add support for scrolling when the selection moves to the top or
2454bottom of the screen.
2455
2439=item --enable-mousewheel (default: on) 2456=item --enable-mousewheel (default: on)
2440 2457
2441Add support for scrolling via mouse wheel or buttons 4 & 5. 2458Add support for scrolling via mouse wheel or buttons 4 & 5.
2442 2459
2443=item --enable-slipwheeling (default: on) 2460=item --enable-slipwheeling (default: on)
2444 2461
2445Add support for continual scrolling (using the mouse wheel as an 2462Add support for continual scrolling (using the mouse wheel as an
2446accelerator) while the control key is held down. This option 2463accelerator) while the control key is held down. This option
2447requires --enable-mousewheel to also be specified. 2464requires --enable-mousewheel to also be specified.
2448 2465
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) 2466=item --enable-smart-resize (default: off)
2469 2467
2470Add smart growth/shrink behaviour when changing font size via hot 2468Add smart growth/shrink behaviour when resizing.
2471keys. This should keep the window corner which is closest to a corner of 2469This should keep the window corner which is closest to a corner of
2472the screen in a fixed position. 2470the screen in a fixed position.
2473 2471
2474=item --enable-pointer-blank (default: on) 2472=item --enable-pointer-blank (default: on)
2475 2473
2476Add support to have the pointer disappear when typing or inactive. 2474Add support to have the pointer disappear when typing or inactive.
2477 2475
2478=item --enable-perl (default: on) 2476=item --enable-perl (default: on)
2479 2477
2480Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2478Enable 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 2479manpage (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 2480files 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 2481default. The perl interpreter that is used can be specified via the
2484variable when running configure. 2482C<PERL> environment variable when running configure. Even when compiled
2483in, perl will I<not> be initialised when all extensions have been disabled
2484C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2485resource standpoint.
2486
2487=item --with-afterimage-config=DIR
2488
2489Look for the libAfterImage config script in DIR.
2485 2490
2486=item --with-name=NAME (default: urxvt) 2491=item --with-name=NAME (default: urxvt)
2487 2492
2488Set the basename for the installed binaries, resulting 2493Set the basename for the installed binaries, resulting
2489in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2494in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2499PATH. 2504PATH.
2500 2505
2501=item --with-x 2506=item --with-x
2502 2507
2503Use the X Window System (pretty much default, eh?). 2508Use 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 2509
2517=back 2510=back
2518 2511
2519=head1 AUTHORS 2512=head1 AUTHORS
2520 2513

Diff Legend

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