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.60 by root, Fri Jul 29 03:12:10 2005 UTC vs.
Revision 1.62 by root, Tue Nov 8 17:35:28 2005 UTC

2185=end table 2185=end table
2186 2186
2187=head1 CONFIGURE OPTIONS 2187=head1 CONFIGURE OPTIONS
2188 2188
2189General hint: if you get compile errors, then likely your configuration 2189General hint: if you get compile errors, then likely your configuration
2190hasn'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
2191./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
2192so 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
2193report 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
2194<rxvt@schmorp.de>. 2194Lehmann <rxvt@schmorp.de>.
2195
2196All
2195 2197
2196=over 4 2198=over 4
2197 2199
2198=item --enable-everything 2200=item --enable-everything
2199 2201
2200Add support for all non-multichoice options listed in "./configure 2202Add (or remove) support for all non-multichoice options listed in "./configure
2201--help". Note that unlike other enable options this is order dependant. 2203--help".
2204
2202You can specify this and then disable options which this enables by 2205You can specify this and then disable options you do not like by
2203I<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.
2204 2210
2205=item --enable-xft 2211=item --enable-xft (default: enabled)
2206 2212
2207Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2213Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2208slower 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
2209don't pay for them. 2215don't pay for them.
2210 2216
2211=item --enable-font-styles 2217=item --enable-font-styles (default: on)
2212 2218
2213Add 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
2214styles. The fonts can be set manually or automatically. 2220styles. The fonts can be set manually or automatically.
2215 2221
2216=item --with-codesets=NAME,... 2222=item --with-codesets=NAME,... (default: all)
2217 2223
2218Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2224Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2219are always compiled in, which includes most 8-bit character sets). These 2225are always compiled in, which includes most 8-bit character sets). These
2220codeset 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
2221for Xft fonts, although having them compiled in lets rxvt-unicode choose 2227for Xft fonts, although having them compiled in lets rxvt-unicode choose
2232 jp_ext rarely used but big japanese encodings 2238 jp_ext rarely used but big japanese encodings
2233 kr korean encodings 2239 kr korean encodings
2234 2240
2235=end table 2241=end table
2236 2242
2237=item --enable-xim 2243=item --enable-xim (default: on)
2238 2244
2239Add support for XIM (X Input Method) protocol. This allows using 2245Add support for XIM (X Input Method) protocol. This allows using
2240alternative input methods (e.g. kinput2) and will also correctly 2246alternative input methods (e.g. kinput2) and will also correctly
2241set up the input for people using dead keys or compose keys. 2247set up the input for people using dead keys or compose keys.
2242 2248
2243=item --enable-unicode3 2249=item --enable-unicode3 (default: off)
2244 2250
2245Enable direct support for displaying unicode codepoints above 2251Enable direct support for displaying unicode codepoints above
224665535 (the basic multilingual page). This increases storage 225265535 (the basic multilingual page). This increases storage
2247requirements 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
2248support these extra characters, but Xft does. 2254support these extra characters, but Xft does.
2251even without this flag, but the number of such characters is 2257even without this flag, but the number of such characters is
2252limited to a view thousand (shared with combining characters, 2258limited to a view thousand (shared with combining characters,
2253see next switch), and right now rxvt-unicode cannot display them 2259see next switch), and right now rxvt-unicode cannot display them
2254(input/output and cut&paste still work, though). 2260(input/output and cut&paste still work, though).
2255 2261
2256=item --enable-combining 2262=item --enable-combining (default: on)
2257 2263
2258Enable automatic composition of combining characters into 2264Enable automatic composition of combining characters into
2259composite characters. This is required for proper viewing of text 2265composite characters. This is required for proper viewing of text
2260where accents are encoded as seperate unicode characters. This is 2266where accents are encoded as seperate unicode characters. This is
2261done by using precomposited characters when available or creating 2267done by using precomposited characters when available or creating
2271 2277
2272The combining table also contains entries for arabic presentation forms, 2278The combining table also contains entries for arabic presentation forms,
2273but 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
2274tell me how these are to be used...). 2280tell me how these are to be used...).
2275 2281
2276=item --enable-fallback(=CLASS) 2282=item --enable-fallback(=CLASS) (default: Rxvt)
2277 2283
2278When 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.
2279(default: Rxvt). To disable resource fallback use --disable-fallback.
2280 2285
2281=item --with-res-name=NAME 2286=item --with-res-name=NAME (default: urxvt)
2282 2287
2283Use the given name (default: urxvt) as default application name when 2288Use the given name as default application name when
2284reading resources. Specify --with-res-name=rxvt to replace rxvt. 2289reading resources. Specify --with-res-name=rxvt to replace rxvt.
2285 2290
2286=item --with-res-class=CLASS 2291=item --with-res-class=CLASS /default: URxvt)
2287 2292
2288Use the given class (default: URxvt) as default application class 2293Use the given class as default application class
2289when reading resources. Specify --with-res-class=Rxvt to replace 2294when reading resources. Specify --with-res-class=Rxvt to replace
2290rxvt. 2295rxvt.
2291 2296
2292=item --enable-utmp 2297=item --enable-utmp (default: on)
2293 2298
2294Write 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
2295start of rxvt execution and delete information when rxvt exits. 2300start of rxvt execution and delete information when rxvt exits.
2296 2301
2297=item --enable-wtmp 2302=item --enable-wtmp (default: on)
2298 2303
2299Write 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
2300start of rxvt execution and write logout when rxvt exits. This 2305start of rxvt execution and write logout when rxvt exits. This
2301option requires --enable-utmp to also be specified. 2306option requires --enable-utmp to also be specified.
2302 2307
2303=item --enable-lastlog 2308=item --enable-lastlog (default: on)
2304 2309
2305Write user and tty to lastlog file (used by programs like 2310Write user and tty to lastlog file (used by programs like
2306F<lastlogin>) at start of rxvt execution. This option requires 2311F<lastlogin>) at start of rxvt execution. This option requires
2307--enable-utmp to also be specified. 2312--enable-utmp to also be specified.
2308 2313
2309=item --enable-xpm-background 2314=item --enable-xpm-background (default: off)
2310 2315
2311Add support for XPM background pixmaps. 2316Add support for XPM background pixmaps.
2312 2317
2313=item --enable-transparency 2318=item --enable-transparency (default: off)
2314 2319
2315Add support for inheriting parent backgrounds thus giving a fake 2320Add support for inheriting parent backgrounds thus giving a fake
2316transparency to the term. 2321transparency to the term.
2317 2322
2318=item --enable-fading 2323=item --enable-fading (default: on)
2319 2324
2320Add support for fading the text when focus is lost. 2325Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2321 2326
2322=item --enable-tinting 2327=item --enable-tinting (default: on)
2323 2328
2324Add support for tinting of transparent backgrounds. 2329Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2325 2330
2326=item --enable-menubar 2331=item --enable-menubar (default: off)
2327 2332
2328Add support for our menu bar system (this interacts badly with 2333Add support for our menu bar system (this interacts badly with
2329dynamic locale switching currently). 2334dynamic locale switching currently).
2330 2335
2331=item --enable-rxvt-scroll 2336=item --enable-rxvt-scroll (default: on)
2332 2337
2333Add support for the original rxvt scrollbar. 2338Add support for the original rxvt scrollbar.
2334 2339
2335=item --enable-next-scroll 2340=item --enable-next-scroll (default: on)
2336 2341
2337Add support for a NeXT-like scrollbar. 2342Add support for a NeXT-like scrollbar.
2338 2343
2339=item --enable-xterm-scroll 2344=item --enable-xterm-scroll (default: on)
2340 2345
2341Add support for an Xterm-like scrollbar. 2346Add support for an Xterm-like scrollbar.
2342 2347
2343=item --enable-plain-scroll 2348=item --enable-plain-scroll (default: on)
2344 2349
2345Add support for a very unobtrusive, plain-looking scrollbar that 2350Add support for a very unobtrusive, plain-looking scrollbar that
2346is the favourite of the rxvt-unicode author, having used it for 2351is the favourite of the rxvt-unicode author, having used it for
2347many years. 2352many years.
2348 2353
2349=item --enable-half-shadow 2354=item --enable-half-shadow (default: off)
2350 2355
2351Make shadows on the scrollbar only half the normal width & height. 2356Make shadows on the scrollbar only half the normal width & height.
2352only applicable to rxvt scrollbars. 2357only applicable to rxvt scrollbars.
2353 2358
2354=item --enable-ttygid 2359=item --enable-ttygid (default: off)
2355 2360
2356Change tty device setting to group "tty" - only use this if 2361Change tty device setting to group "tty" - only use this if
2357your system uses this type of security. 2362your system uses this type of security.
2358 2363
2359=item --disable-backspace-key 2364=item --disable-backspace-key
2360 2365
2361Disable 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
2362do it. 2371do it.
2363 2372
2364=item --disable-delete-key
2365
2366Disable any handling of the delete key by us - let the X server
2367do it.
2368
2369=item --disable-resources 2373=item --disable-resources
2370 2374
2371Remove all resources checking. 2375Removes any support for resource checking.
2372 2376
2373=item --enable-xgetdefault 2377=item --enable-xgetdefault
2374 2378
2375Make resources checking via XGetDefault() instead of our small 2379Make resources checking via XGetDefault() instead of our small
2376version which only checks ~/.Xdefaults, or if that doesn't exist then 2380version which only checks ~/.Xdefaults, or if that doesn't exist then
2378 2382
2379Please note that nowadays, things like XIM will automatically pull in and 2383Please note that nowadays, things like XIM will automatically pull in and
2380use 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
2381small, if nonexistant. 2385small, if nonexistant.
2382 2386
2383=item --enable-strings 2387=item --enable-strings (default: off)
2384 2388
2385Add support for our possibly faster memset() function and other 2389Add support for our possibly faster memset() function and other
2386various routines, overriding your system's versions which may 2390various routines, overriding your system's versions which may
2387have been hand-crafted in assembly or may require extra libraries 2391have been hand-crafted in assembly or may require extra libraries
2388to 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
2389GNU/Linux systems). 2393GNU/Linux systems).
2390 2394
2391=item --disable-swapscreen 2395=item --disable-swapscreen
2392 2396
2393Remove support for swap screen. 2397Remove support for secondary/swap screen.
2394 2398
2395=item --enable-frills 2399=item --enable-frills (default: on)
2396 2400
2397Add 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
2398have. 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
2399disable this. 2403disable this.
2400 2404
2413 settable insecure mode 2417 settable insecure mode
2414 keysym remapping support 2418 keysym remapping support
2415 cursor blinking and underline cursor 2419 cursor blinking and underline cursor
2416 -embed and -pty-fd options 2420 -embed and -pty-fd options
2417 2421
2418=item --enable-iso14755 2422=item --enable-iso14755 (default: on)
2419 2423
2420Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2424Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2421F<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
2422C<--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
2423this switch. 2427this switch.
2424 2428
2425=item --enable-keepscrolling 2429=item --enable-keepscrolling (default: on)
2426 2430
2427Add support for continual scrolling of the display when you hold 2431Add support for continual scrolling of the display when you hold
2428the mouse button down on a scrollbar arrow. 2432the mouse button down on a scrollbar arrow.
2429 2433
2430=item --enable-mousewheel 2434=item --enable-mousewheel (default: on)
2431 2435
2432Add support for scrolling via mouse wheel or buttons 4 & 5. 2436Add support for scrolling via mouse wheel or buttons 4 & 5.
2433 2437
2434=item --enable-slipwheeling 2438=item --enable-slipwheeling (default: on)
2435 2439
2436Add support for continual scrolling (using the mouse wheel as an 2440Add support for continual scrolling (using the mouse wheel as an
2437accelerator) while the control key is held down. This option 2441accelerator) while the control key is held down. This option
2438requires --enable-mousewheel to also be specified. 2442requires --enable-mousewheel to also be specified.
2439 2443
2440=item --disable-new-selection 2444=item --disable-new-selection
2441 2445
2442Remove support for mouse selection style like that of xterm. 2446Remove support for mouse selection style like that of xterm.
2443 2447
2444=item --enable-dmalloc 2448=item --enable-dmalloc (default: off)
2445 2449
2446Use Gray Watson's malloc - which is good for debugging See 2450Use Gray Watson's malloc - which is good for debugging See
2447http://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
2448next 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
2449DINCLUDE and DLIB to the right places. 2453DINCLUDE and DLIB to the right places.
2450 2454
2451You can only use either this option and the following (should 2455You can only use either this option and the following (should
2452you use either) . 2456you use either) .
2453 2457
2454=item --enable-dlmalloc 2458=item --enable-dlmalloc (default: off)
2455 2459
2456Use Doug Lea's malloc - which is good for a production version 2460Use Doug Lea's malloc - which is good for a production version
2457See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2461See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2458 2462
2459=item --enable-smart-resize 2463=item --enable-smart-resize (default: on)
2460 2464
2461Add smart growth/shrink behaviour when changing font size via from hot 2465Add smart growth/shrink behaviour when changing font size via hot
2462keys. 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
2463closest to a corner of the screen. 2467the screen in a fixed position.
2464 2468
2465=item --enable-pointer-blank 2469=item --enable-pointer-blank (default: on)
2466 2470
2467Add support to have the pointer disappear when typing or inactive. 2471Add support to have the pointer disappear when typing or inactive.
2468 2472
2469=item --with-name=NAME 2473=item --with-name=NAME (default: urxvt)
2470 2474
2471Set the basename for the installed binaries (default: C<urxvt>, resulting 2475Set the basename for the installed binaries, resulting
2472in 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
2473C<rxvt>. 2477C<rxvt>.
2474 2478
2475=item --with-term=NAME 2479=item --with-term=NAME (default: rxvt-unicode)
2476 2480
2477Change the environmental variable for the terminal to NAME (default 2481Change the environmental variable for the terminal to NAME.
2478C<rxvt-unicode>)
2479 2482
2480=item --with-terminfo=PATH 2483=item --with-terminfo=PATH
2481 2484
2482Change the environmental variable for the path to the terminfo tree to 2485Change the environmental variable for the path to the terminfo tree to
2483PATH. 2486PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines