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.120 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC

… …
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 25
26 26
27=head2 Meta, Features & Commandline Issues 27=head2 Meta, Features & Commandline Issues
… …
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 74
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 76display, create the listening socket and then fork.
77 77
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 79
80If you want to start @@URXVT_NAME@@d automatically whenever you run 80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script: 81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 82
83 #!/bin/sh 83 #!/bin/sh
… …
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
… …
838 838
839The terminal description used by rxvt-unicode is not as widely available 839The terminal description used by rxvt-unicode is not as widely available
840as that for xterm, or even rxvt (for which the same problem often arises). 840as that for xterm, or even rxvt (for which the same problem often arises).
841 841
842The correct solution for this problem is to install the terminfo, this can 842The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp): 843be done like this (with ncurses' infocmp and works as user and admin):
844 844
845 REMOTE=remotesystem.domain 845 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847 847
848... or by installing rxvt-unicode normally on the remote system, 848... or by installing rxvt-unicode normally on the remote system,
849
850One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work.
849 852
850If you cannot or do not want to do this, then you can simply set 853If you cannot or do not want to do this, then you can simply set
851C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 854C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
852problems arising, which includes wrong keymapping, less and different 855problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 856colours and some refresh errors in fullscreen applications. It's a nice
… …
953If you encounter strange problems like typing an accented character but 956If you encounter strange problems like typing an accented character but
954getting two unrelated other characters or similar, or if program output is 957getting two unrelated other characters or similar, or if program output is
955subtly garbled, then you should check your locale settings. 958subtly garbled, then you should check your locale settings.
956 959
957Rxvt-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
958programs. 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,
959login script running within the rxvt-unicode window changes the locale to 962while the login script running within the rxvt-unicode window changes the
960something 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.
961 965
962The 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
963into 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.
964 968
965 printf '\33]701;%s\007' "$LC_CTYPE" 969 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
966 970
967If 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
968supported on your systems. Some systems have a C<locale> command which 972supported on your systems. Some systems have a C<locale> command which
969displays 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
970it 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
… …
1147This 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
1148and reduces possible bugs to initialisation code run before main(), or 1152and reduces possible bugs to initialisation code run before main(), or
1149things 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
1150little risk. 1154little risk.
1151 1155
1152=head3 On Solaris 9, many line-drawing characters are too wide.
1153
1154Seems to be a known bug, read
1155L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1156following ugly workaround to get non-double-wide-characters working:
1157
1158 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1159
1160=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.
1161 1157
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1158Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1159in your compile environment, or an implementation that implements it,
1164whether 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
… …
1187 1183
1188The 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
1189system 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
1190complete replacements for them :) 1186complete replacements for them :)
1191 1187
1192=head3 I use Solaris 9 and it doesn't compile/work/etc.
1193
1194Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1195problems with C<wcwidth> and a compile problem.
1196
1197=head3 How can I use rxvt-unicode under cygwin? 1188=head3 How can I use rxvt-unicode under cygwin?
1198 1189
1199rxvt-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
1200the X11 libraries that come with cygwin. libW11 emulation is no 1191the X11 libraries that come with cygwin. libW11 emulation is no
1201longer supported (and makes no sense, either, as it only supported a 1192longer supported (and makes no sense, either, as it only supported a
… …
1204old libW11 emulation. 1195old libW11 emulation.
1205 1196
1206At 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
1207encodings (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
1208to 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
1209 1213
1210=head1 RXVT-UNICODE TECHNICAL REFERENCE 1214=head1 RXVT-UNICODE TECHNICAL REFERENCE
1211 1215
1212The rest of this document describes various technical aspects of 1216The rest of this document describes various technical aspects of
1213B<rxvt-unicode>. First the description of supported command sequences, 1217B<rxvt-unicode>. First the description of supported command sequences,
… …
2197 2201
2198=head1 CONFIGURE OPTIONS 2202=head1 CONFIGURE OPTIONS
2199 2203
2200General hint: if you get compile errors, then likely your configuration 2204General hint: if you get compile errors, then likely your configuration
2201hasn'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
2202the 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
2203myself, 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
2204always report when a combination doesn't work, so it can be fixed. Marc 2208can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2205Lehmann <rxvt@schmorp.de>.
2206 2209
2207All 2210All
2208 2211
2209=over 4 2212=over 4
2210 2213
… …
2242 2245
2243=begin table 2246=begin table
2244 2247
2245 all all available codeset groups 2248 all all available codeset groups
2246 zh common chinese encodings 2249 zh common chinese encodings
2247 zh_ext rarely used but very big chinese encodigs 2250 zh_ext rarely used but very big chinese encodings
2248 jp common japanese encodings 2251 jp common japanese encodings
2249 jp_ext rarely used but big japanese encodings 2252 jp_ext rarely used but big japanese encodings
2250 kr korean encodings 2253 kr korean encodings
2251 2254
2252=end table 2255=end table
… …
2266requirements 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
2267support these extra characters, but Xft does. 2270support these extra characters, but Xft does.
2268 2271
2269Please note that rxvt-unicode can store unicode code points >65535 2272Please note that rxvt-unicode can store unicode code points >65535
2270even without this flag, but the number of such characters is 2273even without this flag, but the number of such characters is
2271limited to a view thousand (shared with combining characters, 2274limited to a few thousand (shared with combining characters,
2272see next switch), and right now rxvt-unicode cannot display them 2275see next switch), and right now rxvt-unicode cannot display them
2273(input/output and cut&paste still work, though). 2276(input/output and cut&paste still work, though).
2274 2277
2275=item --enable-combining (default: on) 2278=item --enable-combining (default: on)
2276 2279
… …
2322 2325
2323Write user and tty to lastlog file (used by programs like 2326Write user and tty to lastlog file (used by programs like
2324F<lastlogin>) at start of rxvt execution. This option requires 2327F<lastlogin>) at start of rxvt execution. This option requires
2325--enable-utmp to also be specified. 2328--enable-utmp to also be specified.
2326 2329
2327=item --enable-xpm-background (default: on) 2330=item --enable-afterimage (default: on)
2328 2331
2329Add 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.
2330 2344
2331=item --enable-transparency (default: on) 2345=item --enable-transparency (default: on)
2332 2346
2333Add support for inheriting parent backgrounds thus giving a fake 2347Add support for inheriting parent backgrounds thus giving a fake
2334transparency to the term. 2348transparency to the term.
2335 2349
2336=item --enable-fading (default: on) 2350=item --enable-fading (default: on)
2337 2351
2338Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2352Add support for fading the text when focus is lost.
2339 2353
2340=item --enable-tinting (default: on) 2354=item --enable-tinting (default: on)
2341 2355
2342Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2343 2357
… …
2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2404A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2391in combination with other switches) is: 2405in combination with other switches) is:
2392 2406
2393 MWM-hints 2407 MWM-hints
2394 EWMH-hints (pid, utf8 names) and protocols (ping) 2408 EWMH-hints (pid, utf8 names) and protocols (ping)
2409 urgency hint
2395 seperate underline colour (-underlineColor) 2410 seperate underline colour (-underlineColor)
2396 settable border widths and borderless switch (-w, -b, -bl) 2411 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth) 2412 visual depth selection (-depth)
2398 settable extra linespacing /-lsp) 2413 settable extra linespacing /-lsp)
2399 iso-14755-2 and -3, and visual feedback 2414 iso-14755 5.1 (basic) support
2400 tripleclickwords (-tcw) 2415 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure) 2416 settable insecure mode (-insecure)
2402 keysym remapping support 2417 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc) 2418 cursor blinking and underline cursor (-cb, -uc)
2404 XEmbed support (-embed) 2419 XEmbed support (-embed)
… …
2409 2424
2410It also enables some non-essential features otherwise disabled, such as: 2425It also enables some non-essential features otherwise disabled, such as:
2411 2426
2412 some round-trip time optimisations 2427 some round-trip time optimisations
2413 nearest color allocation on pseudocolor screens 2428 nearest color allocation on pseudocolor screens
2414 UTF8_STRING supporr for selection 2429 UTF8_STRING support for selection
2415 sgr modes 90..97 and 100..107 2430 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequences 2431 backindex and forwardindex escape sequences
2417 view change/zero scorllback esacpe sequences 2432 view change/zero scrollback escape sequences
2418 locale switching escape sequence 2433 locale switching escape sequence
2419 window op and some xterm/OSC escape sequences 2434 window op and some xterm/OSC escape sequences
2420 rectangular selections 2435 rectangular selections
2421 trailing space removal for selections 2436 trailing space removal for selections
2422 verbose X error handling 2437 verbose X error handling
… …
2431=item --enable-keepscrolling (default: on) 2446=item --enable-keepscrolling (default: on)
2432 2447
2433Add support for continual scrolling of the display when you hold 2448Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2449the mouse button down on a scrollbar arrow.
2435 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
2436=item --enable-mousewheel (default: on) 2456=item --enable-mousewheel (default: on)
2437 2457
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2458Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2459
2440=item --enable-slipwheeling (default: on) 2460=item --enable-slipwheeling (default: on)
2441 2461
2442Add support for continual scrolling (using the mouse wheel as an 2462Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2463accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2464requires --enable-mousewheel to also be specified.
2445 2465
2446=item --disable-new-selection
2447
2448Remove support for mouse selection style like that of xterm.
2449
2450=item --enable-dmalloc (default: off)
2451
2452Use Gray Watson's malloc - which is good for debugging See
2453L<http://www.letters.com/dmalloc/> for details If you use either this or the
2454next option, you may need to edit src/Makefile after compiling to point
2455DINCLUDE and DLIB to the right places.
2456
2457You can only use either this option and the following (should
2458you use either) .
2459
2460=item --enable-dlmalloc (default: off)
2461
2462Use Doug Lea's malloc - which is good for a production version
2463See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2464
2465=item --enable-smart-resize (default: on) 2466=item --enable-smart-resize (default: off)
2466 2467
2467Add smart growth/shrink behaviour when changing font size via hot 2468Add smart growth/shrink behaviour when resizing.
2468keys. 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
2469the screen in a fixed position. 2470the screen in a fixed position.
2470 2471
2471=item --enable-pointer-blank (default: on) 2472=item --enable-pointer-blank (default: on)
2472 2473
2473Add support to have the pointer disappear when typing or inactive. 2474Add support to have the pointer disappear when typing or inactive.
2474 2475
2475=item --enable-perl (default: on) 2476=item --enable-perl (default: on)
2476 2477
2477Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2478Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2478manpage (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
2479in 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
2480perl interpreter that is used can be specified via the C<PERL> environment 2481default. The perl interpreter that is used can be specified via the
2481variable 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.
2482 2490
2483=item --with-name=NAME (default: urxvt) 2491=item --with-name=NAME (default: urxvt)
2484 2492
2485Set the basename for the installed binaries, resulting 2493Set the basename for the installed binaries, resulting
2486in 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
… …
2496PATH. 2504PATH.
2497 2505
2498=item --with-x 2506=item --with-x
2499 2507
2500Use the X Window System (pretty much default, eh?). 2508Use the X Window System (pretty much default, eh?).
2501
2502=item --with-xpm-includes=DIR
2503
2504Look for the XPM includes in DIR.
2505
2506=item --with-xpm-library=DIR
2507
2508Look for the XPM library in DIR.
2509
2510=item --with-xpm
2511
2512Not needed - define via --enable-xpm-background.
2513 2509
2514=back 2510=back
2515 2511
2516=head1 AUTHORS 2512=head1 AUTHORS
2517 2513

Diff Legend

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