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.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.63 by root, Thu Dec 22 16:44:10 2005 UTC

… …
31The version number is displayed with the usage (-h). Also the escape 31The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 32sequence C<ESC [ 8 n> sets the window title to the version number.
33 33
34=item I am using Debian GNU/Linux and have a problem... 34=item I am using Debian GNU/Linux and have a problem...
35 35
36The Debian GNU/Linux package of rxvt-unicode contains large patches that 36The Debian GNU/Linux package of rxvt-unicode in sarge contains large
37considerably change the behaviour of rxvt-unicode. Before reporting a 37patches that considerably change the behaviour of rxvt-unicode. Before
38bug to the original rxvt-unicode author please download and install the 38reporting a bug to the original rxvt-unicode author please download and
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to 39install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
40reproduce the problem. If you cannot, chances are that the problems are 40and try to reproduce the problem. If you cannot, chances are that the
41specific to Debian GNU/Linux, in which case it should be reported via the 41problems are specific to Debian GNU/Linux, in which case it should be
42Debian Bug Tracking System (use C<reportbug> to report the bug). 42reported via the Debian Bug Tracking System (use C<reportbug> to report
43the bug).
43 44
44For other problems that also affect the Debian package, you can and 45For other problems that also affect the Debian package, you can and
45probably should use the Debian BTS, too, because, after all, it's also a 46probably should use the Debian BTS, too, because, after all, it's also a
46bug in the Debian version and it serves as a reminder for other users that 47bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue. 48might encounter the same issue.
… …
71 72
72 URxvt.termName: rxvt 73 URxvt.termName: rxvt
73 74
74If you don't plan to use B<rxvt> (quite common...) you could also replace 75If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one. 76the rxvt terminfo file with the rxvt-unicode one.
77
78=item C<tic> outputs some error when compiling the terminfo entry.
79
80Most likely it's the empty definition for C<enacs=>. Just replace it by
81C<enacs=\E[0@> and try again.
76 82
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 83=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78 84
79=item I need a termcap file entry. 85=item I need a termcap file entry.
80 86
… …
354single font). I recommend starting the X-server in C<-multiwindow> or 360single font). I recommend starting the X-server in C<-multiwindow> or
355C<-rootless> mode instead, which will result in similar look&feel as the 361C<-rootless> mode instead, which will result in similar look&feel as the
356old libW11 emulation. 362old libW11 emulation.
357 363
358At the time of this writing, cygwin didn't seem to support any multi-byte 364At the time of this writing, cygwin didn't seem to support any multi-byte
359encodings, so you are likely limited to 8-bit encodings. 365encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
366to 8-bit encodings.
360 367
361=item How does rxvt-unicode determine the encoding to use? 368=item How does rxvt-unicode determine the encoding to use?
362 369
363=item Is there an option to switch encodings? 370=item Is there an option to switch encodings?
364 371
… …
480 487
481=item Can I speed up Xft rendering somehow? 488=item Can I speed up Xft rendering somehow?
482 489
483Yes, the most obvious way to speed it up is to avoid Xft entirely, as 490Yes, the most obvious way to speed it up is to avoid Xft entirely, as
484it is simply slow. If you still want Xft fonts you might try to disable 491it is simply slow. If you still want Xft fonts you might try to disable
485antialiasing (by appending C<:antialiasing=false>), which saves lots of 492antialiasing (by appending C<:antialias=false>), which saves lots of
486memory and also speeds up rendering considerably. 493memory and also speeds up rendering considerably.
487 494
488=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 495=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
489 496
490Rxvt-unicode will use whatever you specify as a font. If it needs to 497Rxvt-unicode will use whatever you specify as a font. If it needs to
… …
568 URxvt.color7: #e1dddd 575 URxvt.color7: #e1dddd
569 URxvt.color15: #e1dddd 576 URxvt.color15: #e1dddd
570 577
571=item How can I start @@RXVT_NAME@@d in a race-free way? 578=item How can I start @@RXVT_NAME@@d in a race-free way?
572 579
573Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 580Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
574server that answers @@RXVT_NAME@@c's requests, so it doesn't background 581display, create the listening socket and then fork.
575itself.
576
577To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
578following method to wait for the startup message before continuing:
579
580 { @@RXVT_NAME@@d & } | read
581 582
582=item What's with the strange Backspace/Delete key behaviour? 583=item What's with the strange Backspace/Delete key behaviour?
583 584
584Assuming that the physical Backspace key corresponds to the 585Assuming that the physical Backspace key corresponds to the
585BackSpace keysym (not likely for Linux ... see the following 586BackSpace keysym (not likely for Linux ... see the following
… …
2184=end table 2185=end table
2185 2186
2186=head1 CONFIGURE OPTIONS 2187=head1 CONFIGURE OPTIONS
2187 2188
2188General hint: if you get compile errors, then likely your configuration 2189General hint: if you get compile errors, then likely your configuration
2189hasn't been tested well. Either try with --enable-everything or use the 2190hasn't been tested well. Either try with C<--enable-everything> or use
2190./reconf script as a base for experiments. ./reconf is used by myself, 2191the F<./reconf> script as a base for experiments. F<./reconf> is used by
2191so it should generally be a working config. Of course, you should always 2192myself, so it should generally be a working config. Of course, you should
2192report when a combination doesn't work, so it can be fixed. Marc Lehmann 2193always report when a combination doesn't work, so it can be fixed. Marc
2193<rxvt@schmorp.de>. 2194Lehmann <rxvt@schmorp.de>.
2195
2196All
2194 2197
2195=over 4 2198=over 4
2196 2199
2197=item --enable-everything 2200=item --enable-everything
2198 2201
2199Add support for all non-multichoice options listed in "./configure 2202Add (or remove) support for all non-multichoice options listed in "./configure
2200--help". Note that unlike other enable options this is order dependant. 2203--help".
2204
2201You can specify this and then disable options which this enables by 2205You can specify this and then disable options you do not like by
2202I<following> this with the appropriate commands. 2206I<following> this with the appropriate C<--disable-...> arguments,
2207or you can start with a minimal configuration by specifying
2208C<--disable-everything> and than adding just the C<--enable-...> arguments
2209you want.
2203 2210
2204=item --enable-xft 2211=item --enable-xft (default: enabled)
2205 2212
2206Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2213Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2207slower and require lots of memory, but as long as you don't use them, you 2214slower and require lots of memory, but as long as you don't use them, you
2208don't pay for them. 2215don't pay for them.
2209 2216
2210=item --enable-font-styles 2217=item --enable-font-styles (default: on)
2211 2218
2212Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2219Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2213styles. The fonts can be set manually or automatically. 2220styles. The fonts can be set manually or automatically.
2214 2221
2215=item --with-codesets=NAME,... 2222=item --with-codesets=NAME,... (default: all)
2216 2223
2217Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2224Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2218are always compiled in, which includes most 8-bit character sets). These 2225are always compiled in, which includes most 8-bit character sets). These
2219codeset tables are used for driving X11 core fonts, they are not required 2226codeset tables are used for driving X11 core fonts, they are not required
2220for Xft fonts, although having them compiled in lets rxvt-unicode choose 2227for Xft fonts, although having them compiled in lets rxvt-unicode choose
… …
2231 jp_ext rarely used but big japanese encodings 2238 jp_ext rarely used but big japanese encodings
2232 kr korean encodings 2239 kr korean encodings
2233 2240
2234=end table 2241=end table
2235 2242
2236=item --enable-xim 2243=item --enable-xim (default: on)
2237 2244
2238Add support for XIM (X Input Method) protocol. This allows using 2245Add support for XIM (X Input Method) protocol. This allows using
2239alternative input methods (e.g. kinput2) and will also correctly 2246alternative input methods (e.g. kinput2) and will also correctly
2240set up the input for people using dead keys or compose keys. 2247set up the input for people using dead keys or compose keys.
2241 2248
2242=item --enable-unicode3 2249=item --enable-unicode3 (default: off)
2243 2250
2244Enable direct support for displaying unicode codepoints above 2251Enable direct support for displaying unicode codepoints above
224565535 (the basic multilingual page). This increases storage 225265535 (the basic multilingual page). This increases storage
2246requirements per character from 2 to 4 bytes. X11 fonts do not yet 2253requirements per character from 2 to 4 bytes. X11 fonts do not yet
2247support these extra characters, but Xft does. 2254support these extra characters, but Xft does.
… …
2250even without this flag, but the number of such characters is 2257even without this flag, but the number of such characters is
2251limited to a view thousand (shared with combining characters, 2258limited to a view thousand (shared with combining characters,
2252see next switch), and right now rxvt-unicode cannot display them 2259see next switch), and right now rxvt-unicode cannot display them
2253(input/output and cut&paste still work, though). 2260(input/output and cut&paste still work, though).
2254 2261
2255=item --enable-combining 2262=item --enable-combining (default: on)
2256 2263
2257Enable automatic composition of combining characters into 2264Enable automatic composition of combining characters into
2258composite characters. This is required for proper viewing of text 2265composite characters. This is required for proper viewing of text
2259where accents are encoded as seperate unicode characters. This is 2266where accents are encoded as seperate unicode characters. This is
2260done by using precomposited characters when available or creating 2267done by using precomposited characters when available or creating
… …
2270 2277
2271The combining table also contains entries for arabic presentation forms, 2278The combining table also contains entries for arabic presentation forms,
2272but these are not currently used. Bug me if you want these to be used (and 2279but these are not currently used. Bug me if you want these to be used (and
2273tell me how these are to be used...). 2280tell me how these are to be used...).
2274 2281
2275=item --enable-fallback(=CLASS) 2282=item --enable-fallback(=CLASS) (default: Rxvt)
2276 2283
2277When reading resource settings, also read settings for class CLASS 2284When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2278(default: Rxvt). To disable resource fallback use --disable-fallback.
2279 2285
2280=item --with-res-name=NAME 2286=item --with-res-name=NAME (default: urxvt)
2281 2287
2282Use the given name (default: urxvt) as default application name when 2288Use the given name as default application name when
2283reading resources. Specify --with-res-name=rxvt to replace rxvt. 2289reading resources. Specify --with-res-name=rxvt to replace rxvt.
2284 2290
2285=item --with-res-class=CLASS 2291=item --with-res-class=CLASS /default: URxvt)
2286 2292
2287Use the given class (default: URxvt) as default application class 2293Use the given class as default application class
2288when reading resources. Specify --with-res-class=Rxvt to replace 2294when reading resources. Specify --with-res-class=Rxvt to replace
2289rxvt. 2295rxvt.
2290 2296
2291=item --enable-utmp 2297=item --enable-utmp (default: on)
2292 2298
2293Write user and tty to utmp file (used by programs like F<w>) at 2299Write user and tty to utmp file (used by programs like F<w>) at
2294start of rxvt execution and delete information when rxvt exits. 2300start of rxvt execution and delete information when rxvt exits.
2295 2301
2296=item --enable-wtmp 2302=item --enable-wtmp (default: on)
2297 2303
2298Write user and tty to wtmp file (used by programs like F<last>) at 2304Write user and tty to wtmp file (used by programs like F<last>) at
2299start of rxvt execution and write logout when rxvt exits. This 2305start of rxvt execution and write logout when rxvt exits. This
2300option requires --enable-utmp to also be specified. 2306option requires --enable-utmp to also be specified.
2301 2307
2302=item --enable-lastlog 2308=item --enable-lastlog (default: on)
2303 2309
2304Write user and tty to lastlog file (used by programs like 2310Write user and tty to lastlog file (used by programs like
2305F<lastlogin>) at start of rxvt execution. This option requires 2311F<lastlogin>) at start of rxvt execution. This option requires
2306--enable-utmp to also be specified. 2312--enable-utmp to also be specified.
2307 2313
2308=item --enable-xpm-background 2314=item --enable-xpm-background (default: off)
2309 2315
2310Add support for XPM background pixmaps. 2316Add support for XPM background pixmaps.
2311 2317
2312=item --enable-transparency 2318=item --enable-transparency (default: off)
2313 2319
2314Add support for inheriting parent backgrounds thus giving a fake 2320Add support for inheriting parent backgrounds thus giving a fake
2315transparency to the term. 2321transparency to the term.
2316 2322
2317=item --enable-fading 2323=item --enable-fading (default: on)
2318 2324
2319Add support for fading the text when focus is lost. 2325Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2320 2326
2321=item --enable-tinting 2327=item --enable-tinting (default: on)
2322 2328
2323Add support for tinting of transparent backgrounds. 2329Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2324 2330
2325=item --enable-menubar 2331=item --enable-menubar (default: off)
2326 2332
2327Add support for our menu bar system (this interacts badly with 2333Add support for our menu bar system (this interacts badly with
2328dynamic locale switching currently). 2334dynamic locale switching currently).
2329 2335
2330=item --enable-rxvt-scroll 2336=item --enable-rxvt-scroll (default: on)
2331 2337
2332Add support for the original rxvt scrollbar. 2338Add support for the original rxvt scrollbar.
2333 2339
2334=item --enable-next-scroll 2340=item --enable-next-scroll (default: on)
2335 2341
2336Add support for a NeXT-like scrollbar. 2342Add support for a NeXT-like scrollbar.
2337 2343
2338=item --enable-xterm-scroll 2344=item --enable-xterm-scroll (default: on)
2339 2345
2340Add support for an Xterm-like scrollbar. 2346Add support for an Xterm-like scrollbar.
2341 2347
2342=item --enable-plain-scroll 2348=item --enable-plain-scroll (default: on)
2343 2349
2344Add support for a very unobtrusive, plain-looking scrollbar that 2350Add support for a very unobtrusive, plain-looking scrollbar that
2345is the favourite of the rxvt-unicode author, having used it for 2351is the favourite of the rxvt-unicode author, having used it for
2346many years. 2352many years.
2347 2353
2348=item --enable-half-shadow 2354=item --enable-half-shadow (default: off)
2349 2355
2350Make shadows on the scrollbar only half the normal width & height. 2356Make shadows on the scrollbar only half the normal width & height.
2351only applicable to rxvt scrollbars. 2357only applicable to rxvt scrollbars.
2352 2358
2353=item --enable-ttygid 2359=item --enable-ttygid (default: off)
2354 2360
2355Change tty device setting to group "tty" - only use this if 2361Change tty device setting to group "tty" - only use this if
2356your system uses this type of security. 2362your system uses this type of security.
2357 2363
2358=item --disable-backspace-key 2364=item --disable-backspace-key
2359 2365
2360Disable any handling of the backspace key by us - let the X server 2366Removes any handling of the backspace key by us - let the X server do it.
2367
2368=item --disable-delete-key
2369
2370Removes any handling of the delete key by us - let the X server
2361do it. 2371do it.
2362 2372
2363=item --disable-delete-key
2364
2365Disable any handling of the delete key by us - let the X server
2366do it.
2367
2368=item --disable-resources 2373=item --disable-resources
2369 2374
2370Remove all resources checking. 2375Removes any support for resource checking.
2371 2376
2372=item --enable-xgetdefault 2377=item --enable-xgetdefault
2373 2378
2374Make resources checking via XGetDefault() instead of our small 2379Make resources checking via XGetDefault() instead of our small
2375version which only checks ~/.Xdefaults, or if that doesn't exist then 2380version which only checks ~/.Xdefaults, or if that doesn't exist then
… …
2377 2382
2378Please note that nowadays, things like XIM will automatically pull in and 2383Please note that nowadays, things like XIM will automatically pull in and
2379use the full X resource manager, so the overhead of using it might be very 2384use the full X resource manager, so the overhead of using it might be very
2380small, if nonexistant. 2385small, if nonexistant.
2381 2386
2382=item --enable-strings 2387=item --enable-strings (default: off)
2383 2388
2384Add support for our possibly faster memset() function and other 2389Add support for our possibly faster memset() function and other
2385various routines, overriding your system's versions which may 2390various routines, overriding your system's versions which may
2386have been hand-crafted in assembly or may require extra libraries 2391have been hand-crafted in assembly or may require extra libraries
2387to link in. (this breaks ANSI-C rules and has problems on many 2392to link in. (this breaks ANSI-C rules and has problems on many
2388GNU/Linux systems). 2393GNU/Linux systems).
2389 2394
2390=item --disable-swapscreen 2395=item --disable-swapscreen
2391 2396
2392Remove support for swap screen. 2397Remove support for secondary/swap screen.
2393 2398
2394=item --enable-frills 2399=item --enable-frills (default: on)
2395 2400
2396Add support for many small features that are not essential but nice to 2401Add support for many small features that are not essential but nice to
2397have. Normally you want this, but for very small binaries you may want to 2402have. Normally you want this, but for very small binaries you may want to
2398disable this. 2403disable this.
2399 2404
… …
2410 window op and some xterm/OSC escape sequences 2415 window op and some xterm/OSC escape sequences
2411 tripleclickwords 2416 tripleclickwords
2412 settable insecure mode 2417 settable insecure mode
2413 keysym remapping support 2418 keysym remapping support
2414 cursor blinking and underline cursor 2419 cursor blinking and underline cursor
2415 -embed and -pty-fd options 2420 -embed, -pty-fd and -hold options
2416 2421
2417=item --enable-iso14755 2422=item --enable-iso14755 (default: on)
2418 2423
2419Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2424Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2420F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2425F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2421C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2426C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2422this switch. 2427this switch.
2423 2428
2424=item --enable-keepscrolling 2429=item --enable-keepscrolling (default: on)
2425 2430
2426Add support for continual scrolling of the display when you hold 2431Add support for continual scrolling of the display when you hold
2427the mouse button down on a scrollbar arrow. 2432the mouse button down on a scrollbar arrow.
2428 2433
2429=item --enable-mousewheel 2434=item --enable-mousewheel (default: on)
2430 2435
2431Add support for scrolling via mouse wheel or buttons 4 & 5. 2436Add support for scrolling via mouse wheel or buttons 4 & 5.
2432 2437
2433=item --enable-slipwheeling 2438=item --enable-slipwheeling (default: on)
2434 2439
2435Add support for continual scrolling (using the mouse wheel as an 2440Add support for continual scrolling (using the mouse wheel as an
2436accelerator) while the control key is held down. This option 2441accelerator) while the control key is held down. This option
2437requires --enable-mousewheel to also be specified. 2442requires --enable-mousewheel to also be specified.
2438 2443
2439=item --disable-new-selection 2444=item --disable-new-selection
2440 2445
2441Remove support for mouse selection style like that of xterm. 2446Remove support for mouse selection style like that of xterm.
2442 2447
2443=item --enable-dmalloc 2448=item --enable-dmalloc (default: off)
2444 2449
2445Use Gray Watson's malloc - which is good for debugging See 2450Use Gray Watson's malloc - which is good for debugging See
2446http://www.letters.com/dmalloc/ for details If you use either this or the 2451http://www.letters.com/dmalloc/ for details If you use either this or the
2447next option, you may need to edit src/Makefile after compiling to point 2452next option, you may need to edit src/Makefile after compiling to point
2448DINCLUDE and DLIB to the right places. 2453DINCLUDE and DLIB to the right places.
2449 2454
2450You can only use either this option and the following (should 2455You can only use either this option and the following (should
2451you use either) . 2456you use either) .
2452 2457
2453=item --enable-dlmalloc 2458=item --enable-dlmalloc (default: off)
2454 2459
2455Use Doug Lea's malloc - which is good for a production version 2460Use Doug Lea's malloc - which is good for a production version
2456See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2461See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2457 2462
2458=item --enable-smart-resize 2463=item --enable-smart-resize (default: on)
2459 2464
2460Add smart growth/shrink behaviour when changing font size via from hot 2465Add smart growth/shrink behaviour when changing font size via hot
2461keys. This should keep in a fixed position the rxvt corner which is 2466keys. This should keep the window corner which is closest to a corner of
2462closest to a corner of the screen. 2467the screen in a fixed position.
2463 2468
2464=item --enable-pointer-blank 2469=item --enable-pointer-blank (default: on)
2465 2470
2466Add support to have the pointer disappear when typing or inactive. 2471Add support to have the pointer disappear when typing or inactive.
2467 2472
2468=item --with-name=NAME 2473=item --with-name=NAME (default: urxvt)
2469 2474
2470Set the basename for the installed binaries (default: C<urxvt>, resulting 2475Set the basename for the installed binaries, resulting
2471in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2476in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2472C<rxvt>. 2477C<rxvt>.
2473 2478
2474=item --with-term=NAME 2479=item --with-term=NAME (default: rxvt-unicode)
2475 2480
2476Change the environmental variable for the terminal to NAME (default 2481Change the environmental variable for the terminal to NAME.
2477C<rxvt-unicode>)
2478 2482
2479=item --with-terminfo=PATH 2483=item --with-terminfo=PATH
2480 2484
2481Change the environmental variable for the path to the terminfo tree to 2485Change the environmental variable for the path to the terminfo tree to
2482PATH. 2486PATH.

Diff Legend

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