INSTALL revision 0bd37d32
10bd37d32Smrg-- $XTermId: INSTALL,v 1.147 2013/05/27 22:19:09 tom Exp $ 2d522f475Smrg------------------------------------------------------------------------------- 30bd37d32Smrg-- Copyright 1997-2012,2013 by Thomas E. Dickey 4d522f475Smrg-- 5d522f475Smrg-- All Rights Reserved 6d522f475Smrg-- 7d522f475Smrg-- Permission is hereby granted, free of charge, to any person obtaining a 8d522f475Smrg-- copy of this software and associated documentation files (the 9d522f475Smrg-- "Software"), to deal in the Software without restriction, including 10d522f475Smrg-- without limitation the rights to use, copy, modify, merge, publish, 11d522f475Smrg-- distribute, sublicense, and/or sell copies of the Software, and to 12d522f475Smrg-- permit persons to whom the Software is furnished to do so, subject to 13d522f475Smrg-- the following conditions: 14d522f475Smrg-- 15d522f475Smrg-- The above copyright notice and this permission notice shall be included 16d522f475Smrg-- in all copies or substantial portions of the Software. 17d522f475Smrg-- 18d522f475Smrg-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19d522f475Smrg-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20d522f475Smrg-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 21d522f475Smrg-- IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 22d522f475Smrg-- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23d522f475Smrg-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24d522f475Smrg-- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25d522f475Smrg-- 26d522f475Smrg-- Except as contained in this notice, the name(s) of the above copyright 27d522f475Smrg-- holders shall not be used in advertising or otherwise to promote the 28d522f475Smrg-- sale, use or other dealings in this Software without prior written 29d522f475Smrg-- authorization. 30d522f475Smrg------------------------------------------------------------------------------- 31d522f475Smrg 32e39b573cSmrgXterm was originally built as part of the X Window System source tree, using 33e39b573cSmrgimake to generate a Makefile from Imakefile. You can also use the configure 34e39b573cSmrgscript to generate a Makefile from Makefile.in: 35d522f475Smrg 36d522f475Smrg + If you have imake (or xmkmf), then you can use those directly, 37d522f475Smrg or use the configure script, which normally uses those tools 38d522f475Smrg to obtain the special definitions needed to build xterm. 39d522f475Smrg 40d522f475Smrg Ultimately, imake will not be necessary, since it is possible 41d522f475Smrg to add configure tests that derive the information that imake 42d522f475Smrg would supply. 43d522f475Smrg 44d522f475Smrg + You need the Athena widgets (or a clone, such as Xaw3d or 45d522f475Smrg neXtaw), to provide the popup menus. 46d522f475Smrg 47d522f475SmrgEven if you have imake, the configure script is still convenient because 48d522f475Smrgit allows you to build different configurations more easily than with 49d522f475Smrgimake, simply by specifying options to the configure script. 50d522f475Smrg 51d522f475SmrgOptions: 52d522f475Smrg------- 53d522f475Smrg 54d522f475SmrgAutoconf configure scripts recognize two types of application-defined 55d522f475Smrgoptions, enable/disable and with/without. The latter, by convention, are 56d522f475Smrgused for denoting inclusion of external packages, while the former denote 57d522f475Smrgenabling/disabling of internal features. The configure --help option lists 58d522f475Smrgthe available options. This script uses "enable" and "disable" to indicate 59d522f475Smrgthe sense of the default behavior. 60d522f475Smrg 61d522f475SmrgThe options (in alphabetic order): 62d522f475Smrg 63d522f475Smrg --disable-16-color disable 16-color support 64d522f475Smrg 65d522f475Smrg Do not compile-in code to recognize aixterm-style control sequences 66d522f475Smrg that support color values 8-15. 67d522f475Smrg 68d522f475Smrg Most color applications know only about 8 ANSI colors, but some 69d522f475Smrg (e.g., ones built with ncurses) do. 70d522f475Smrg 71d522f475Smrg --disable-active-icon disable X11R6.3 active-icon feature 72d522f475Smrg 73d522f475Smrg Do not compile-in code to support the active-icon feature. This is 74d522f475Smrg not configured on systems (e.g., X11R5) which lack the library 75d522f475Smrg support needed. 76d522f475Smrg 77d522f475Smrg Xterms with an active icon continue to respond to input and update 78d522f475Smrg their display when iconified. Not all window managers support 79d522f475Smrg active icons. Those that do include fvwm, olvwm and mwm. 80d522f475Smrg 81d522f475Smrg --disable-ansi-color disable ANSI color 82d522f475Smrg 83d522f475Smrg Do not compile-in code for ANSI colors. 84d522f475Smrg 85d522f475Smrg --disable-blink-cursor disable support for blinking cursor 86d522f475Smrg 87d522f475Smrg Do not compile-in code that implements a blinking cursor. The blinking 88d522f475Smrg cursor is enabled either by resource setting or by popup menu entry. 89d522f475Smrg 90d522f475Smrg --disable-bold-color disable PC-style mapping of bold colors 91d522f475Smrg 92d522f475Smrg Do not compile-in code that maps colors 8-15 to bold versions of 93d522f475Smrg colors 0-7. 94d522f475Smrg 95d522f475Smrg Some applications have hardcoded logic that assumes this. It does 96d522f475Smrg not interfere with the 16-color support. 97d522f475Smrg 98d522f475Smrg --disable-boxchars disable fallback-support for box chars 99d522f475Smrg 100d522f475Smrg Do not compile-in code to generate approximations for box/graphic 101d522f475Smrg characters. 102d522f475Smrg 103d522f475Smrg Most fonts do not contain the vt100-style graphic characters in 104d522f475Smrg positions 0-31. Many applications use the line-drawing characters, 105d522f475Smrg e.g., to make boxes. When xterm loads a font, it checks if those 106d522f475Smrg characters are present, and draws its own if they are missing. 107d522f475Smrg 10820d2c4d2Smrg --disable-broken-st disallow broken string-terminators], 10920d2c4d2Smrg 11020d2c4d2Smrg Do not compile-in code that works around a bug in some ISDN routers 11120d2c4d2Smrg (and possibly other applications written by the same people): they 11220d2c4d2Smrg send an unterminated control string in their banner text, making xterm 11320d2c4d2Smrg freeze. 11420d2c4d2Smrg 11520d2c4d2Smrg The workaround tells xterm to stop processing the control string when 11620d2c4d2Smrg it receives one of the whitespace control characters such as newline. 11720d2c4d2Smrg That was the behavior before patch #171. 11820d2c4d2Smrg 11920d2c4d2Smrg See also --enable-broken-osc 12020d2c4d2Smrg 121d522f475Smrg --disable-c1-print disallow -k8 option for printable 128-159], 122d522f475Smrg 123d522f475Smrg Use this option to suppress support for nonstandard use of codes 124d522f475Smrg 128-159, which normally are considered control characters. Some users 125d522f475Smrg have fonts which use those positions. The default value for the 126d522f475Smrg allowC1Printable resource is false, so this feature does not impact 127d522f475Smrg normal users. 128d522f475Smrg 129d522f475Smrg --disable-color-class disable color class resources 130d522f475Smrg 131d522f475Smrg Use this option to change most of the color resources to use Foreground 132d522f475Smrg as the color class. This is the older (before patch #157) behavior 133d522f475Smrg which has the drawback that setting the Foreground resource on most 134d522f475Smrg platforms prevents use of color since the class is evaluated before 135d522f475Smrg the instance. 136d522f475Smrg 137d522f475Smrg --disable-color-mode disable default colorMode resource 138d522f475Smrg 139d522f475Smrg Do not compile-in code that sets the default value of the colorMode 140d522f475Smrg resource to ``true''. 141d522f475Smrg 142d522f475Smrg --disable-desktop disable install of xterm desktop files 143d522f475Smrg 144d522f475Smrg Do not install the xterm desktop files, used in menus. 145d522f475Smrg These use the icons installed in the --with-icondir option. 146d522f475Smrg Use the environment variable $DESKTOP_FLAGS to supply options 147d522f475Smrg required by desktop-file-install. 148d522f475Smrg 149d522f475Smrg Note: If desktop-utils is not found they will not be installed anyway. 150d522f475Smrg 151d522f475Smrg --disable-doublechars disable support for double-size chars 152d522f475Smrg 153d522f475Smrg Do not compile-in code that supports font-manipulation needed to 154d522f475Smrg implement vt100-style double-sized characters. 155d522f475Smrg 156d522f475Smrg --disable-echo test: display "compiling" commands 157d522f475Smrg 158d522f475Smrg Modify the generated Makefile so that most compiler options are 159d522f475Smrg not shown. This makes it simpler to read a build log and see the 160d522f475Smrg actual warning messages. 161d522f475Smrg 162956cc18dSsnj --disable-fifo-lines enable FIFO-storage for saved-lines 163956cc18dSsnj 164956cc18dSsnj With patch #244, xterm by default stores saved-lines in a FIFO 165956cc18dSsnj (circular buffer), which improves performance when the number of saved 166956cc18dSsnj lines is large. Disable this option to revert to the pre-244 layout. 167956cc18dSsnj 168d522f475Smrg --disable-freetype disable freetype library-support 169d522f475Smrg 170d522f475Smrg Do not use freetype libraries if they are found. Normally they will 171d522f475Smrg be used automatically. 172d522f475Smrg 173d522f475Smrg --disable-full-tgetent disable check for termcap library 174d522f475Smrg 175d522f475Smrg Do not look for the tgetent() function specifically in the termcap 176d522f475Smrg library, accept the first library (from termlib, ncurses and curses) 177d522f475Smrg which contains this function rather than continuing to search for 178d522f475Smrg a termcap implementation rather than terminfo. The former would 179d522f475Smrg supply the complete $TERMCAP data needed for some legacy programs. 180d522f475Smrg 181d522f475Smrg --disable-highlighting disable support for color highlighting 182d522f475Smrg 183d522f475Smrg Do not compile-in code that allows the selected region to be a 184d522f475Smrg different color than the reverse of foreground/background colors. 185d522f475Smrg 186d522f475Smrg See the discussion of highlightColor in the manual. 187d522f475Smrg 188d522f475Smrg --disable-i18n disable internationalization 189d522f475Smrg 190d522f475Smrg Do not compile-in code to handle multi-byte characters. This is 191d522f475Smrg related to, but not identical with the input method logic. 192d522f475Smrg 193d522f475Smrg --disable-imake disable use of imake for definitions 194d522f475Smrg 195d522f475Smrg Do not attempt to use imake to determine compiler options. 196d522f475Smrg 197d522f475Smrg The main.c file has many ifdef's which rely on obscure combinations 198d522f475Smrg known only to imake. The configure script implements only a 199d522f475Smrg portion of the tests needed to supplant imake. 200d522f475Smrg 201d522f475Smrg --disable-initial-erase disable setup for stty erase 202d522f475Smrg 203d522f475Smrg Do not compile-in code which aligns the stty erase and the backarrow 204d522f475Smrg key. When compiled-in, xterm will optionally use the pty's sense 205d522f475Smrg of stty erase and apply that to the backarrow mode (sending 8 or 127), 206d522f475Smrg or go the other way, setting stty erase to match xterm's configuration. 207d522f475Smrg 208d522f475Smrg --disable-input-method disable input-method 209d522f475Smrg 210d522f475Smrg Do not compile-in code for "input method". This is an X11R6 211d522f475Smrg feature which deals with translation of composite characters. 212d522f475Smrg 213d522f475Smrg Some users report problems with their configuration, e.g., messages 214d522f475Smrg stating that there is no input method defined for the given preedit 215d522f475Smrg type. If you do not need input method (and are troubled by the 216d522f475Smrg warning messages), it is safe to disable this option. 217d522f475Smrg 2180bd37d32Smrg --disable-leaks test: free permanent memory, analyze leaks 219d522f475Smrg 220d522f475Smrg Compile-in code which frees memory which might confuse a leak-testing 221d522f475Smrg tool. Normally these chunks of memory are retained as long as xterm 222d522f475Smrg is running. 223d522f475Smrg 224d522f475Smrg --disable-maximize disable actions for iconify/deiconify/maximize/restore 225d522f475Smrg 226d522f475Smrg Do not compile-in code that implements runtime 'actions' for 227d522f475Smrg iconifying, maximizing, etc. 228d522f475Smrg 229d522f475Smrg Most users will find that the window manager is more suitable for 230d522f475Smrg this sort of manipulation than putting the capabilities into xterm. 231d522f475Smrg 232d522f475Smrg --disable-num-lock disable NumLock keypad support 233d522f475Smrg 234d522f475Smrg Do not compile-in code that looks for the actual NumLock key to 235d522f475Smrg support vt100/vt220 keypad translation. 236d522f475Smrg 237d522f475Smrg This is used in xterm to simplify logic, and to workaround some 238d522f475Smrg quirks of the keyboard tables. Use the ``numLock'' resource to 239d522f475Smrg disable this feature if you must customize xterm in some other way. 240d522f475Smrg 241d522f475Smrg (The same ifdef controls the metaSendsEscape support). 242d522f475Smrg 2430bd37d32Smrg --disable-openpty disable openpty, prefer other interfaces 2440bd37d32Smrg 2450bd37d32Smrg Do not check for, or use openpty(). Instead, use other interfaces such 2460bd37d32Smrg as posix_openpt(). Modern (sic) BSD systems should have a workable 2470bd37d32Smrg openpty() interface. Older systems may not. 2480bd37d32Smrg 2492eaa94a1Schristos --disable-paste64 disable support for bracketed paste mode 2502eaa94a1Schristos 2512eaa94a1Schristos Do not compile-in code to support experimental bracketed paste mode, 2522eaa94a1Schristos i.e., provide functions for setting/getting the selection data. 2532eaa94a1Schristos 2542eaa94a1Schristos (see ctlseqs.ms description of OSC 52). 2552eaa94a1Schristos 256d522f475Smrg --disable-pty-handshake disable support for pty handshakes 257d522f475Smrg 258d522f475Smrg This feature is used to ensure that the child process's terminal modes 259d522f475Smrg match the parent's. In particular, it addresses a problem where the 260d522f475Smrg terminal size is not defined in the stty settings. 261d522f475Smrg 262d522f475Smrg --disable-rectangles disable VT420 rectangle support 263d522f475Smrg 264d522f475Smrg Do not compile-in code to support VT420 rectangle control-sequences. 265d522f475Smrg 266d522f475Smrg --disable-regex disable regular-expression selections 267d522f475Smrg 268d522f475Smrg Do not compile-in code to support the "regex" option for multiple 269d522f475Smrg mouse clicks. 270d522f475Smrg 271d522f475Smrg --disable-rightbar disable right-scrollbar support 272d522f475Smrg 273d522f475Smrg Do not compile-in code that supports a scrollbar on the right. 274d522f475Smrg 275d522f475Smrg Left/right scrollbars are a matter of taste. Some older libraries 276d522f475Smrg (e.g., X11R5) do not perform the geometry computation correctly, 277d522f475Smrg leaving the right scrollbar incorrectly positioned after changing 278d522f475Smrg the font size. 279d522f475Smrg 28020d2c4d2Smrg --disable-rpath-hack don't add rpath options for additional libraries 28120d2c4d2Smrg 28220d2c4d2Smrg By default, the configure script looks for libraries in unusual places 28320d2c4d2Smrg and adds an rpath linker option to help. 28420d2c4d2Smrg 285d522f475Smrg --disable-samename disable check for redundant name-change 286d522f475Smrg 287d522f475Smrg Do not compile-in code that suppresses redundant updates to the 288d522f475Smrg titlebar when the text has not changed. 289d522f475Smrg 2900bd37d32Smrg --disable-selection-ops disable selection operations 2910bd37d32Smrg 2920bd37d32Smrg Do not compile-in code to support the actions which allow users 2930bd37d32Smrg to bind keys that use the selection or extract data from the screen. 2940bd37d32Smrg 295d522f475Smrg --disable-session-mgt enable support for session management 296d522f475Smrg 297d522f475Smrg Do not compile-in code which adds simple session management hooks 298d522f475Smrg which are used when closing an xterm. Normally the code is 299d522f475Smrg compiled-in, except for systems which do not support it. 300d522f475Smrg 301d522f475Smrg --disable-setgid disable setgid 302d522f475Smrg 303d522f475Smrg Do not install xterm using setuid/setgid permissions. Drop setgid 304d522f475Smrg permissions on startup. 305d522f475Smrg 306d522f475Smrg --disable-setuid disable setuid 307d522f475Smrg 308d522f475Smrg Do not install xterm using setuid/setgid permissions. Drop setuid 309d522f475Smrg permissions on startup. 310d522f475Smrg 311d522f475Smrg --disable-sun-fkeys 312d522f475Smrg 313d522f475Smrg Do not compile-in code to support Sun-style function keys. 314d522f475Smrg 315d522f475Smrg --disable-tcap-fkeys disable termcap function-keys 316d522f475Smrg 3172eaa94a1Schristos Do not compile-in code to support feature which allows xterm to use the 318d522f475Smrg function-key definitions from the termcap/terminfo entry which it used 319d522f475Smrg to set the $TERM variable on startup. 320d522f475Smrg 3212eaa94a1Schristos --disable-tcap-query disable termcap query/report 3222eaa94a1Schristos 3232eaa94a1Schristos Do not compile-in code to support DCS '+' control sequence, which 3242eaa94a1Schristos allows an application to ask xterm what control sequences it would 3252eaa94a1Schristos transmit for specified function keys, given the termcap or terminfo 3262eaa94a1Schristos names. 3272eaa94a1Schristos 328d522f475Smrg --disable-tek4014 disable tek4014 emulation 329d522f475Smrg 330d522f475Smrg Do not compile-in code to support Tektronix 4014 emulation. 331d522f475Smrg 332d522f475Smrg This reduces the executable size by 17% (checked 1999/3/13). 333d522f475Smrg 334d522f475Smrg Some people use the Tektronix emulation (which has been in xterm 335d522f475Smrg for many years) as an example of code bloat, though this is not an 336d522f475Smrg accurate impression. 337d522f475Smrg 338d522f475Smrg --disable-vt52 disable VT52 emulation 339d522f475Smrg 340d522f475Smrg Do not compile-in code to support vt52 emulation. 341d522f475Smrg 342d522f475Smrg A genuine vt100 emulates a vt52. 343d522f475Smrg 344d522f475Smrg --disable-ziconbeep disable -ziconbeep option 345d522f475Smrg 346d522f475Smrg Do not compile-in code that modifies the icon's title and sounds a 347d522f475Smrg beep when they receive output. 348d522f475Smrg 349956cc18dSsnj --enable-16bit-chars enable 16-bit characters support 350956cc18dSsnj 351956cc18dSsnj Enable wide-character support, but store only 16-bits for each wide 352956cc18dSsnj character. Unicode values can be larger than 16-bits, up to 21-bits. 353956cc18dSsnj This uses less memory, but is less complete. However, most languages 354956cc18dSsnj are covered by the 16-bit encoding. 355956cc18dSsnj 356d522f475Smrg --enable-256-color enable 256-color support 357d522f475Smrg 358d522f475Smrg Compile-in code that interprets SGR 38 and 48 for 256-colors. 359d522f475Smrg 360d522f475Smrg --enable-88-color enable 88-color support 361d522f475Smrg 362d522f475Smrg Compile-in code that interprets SGR 38 and 48 for 88-colors. 363d522f475Smrg 3640bd37d32Smrg --enable-alt-sends-esc set default altSendsEscape resource (default: no) 3650bd37d32Smrg 3660bd37d32Smrg This sets the default resource value, which is shown in the manpage. 3670bd37d32Smrg 3680bd37d32Smrg --enable-backarrow-key set default backarrowKey resource (default: true) 3690bd37d32Smrg 3700bd37d32Smrg This sets the default resource value, which is shown in the manpage. 3710bd37d32Smrg 3720bd37d32Smrg --enable-backarrow-is-erase set default backarrowKeyIsErase resource (default: false) 3730bd37d32Smrg 3740bd37d32Smrg This sets the default resource value, which is shown in the manpage. 3750bd37d32Smrg 376d522f475Smrg --enable-broken-osc allow broken Linux OSC-strings], 377d522f475Smrg 378d522f475Smrg Compile-in code to accommodate scripts that write Linux's malformed 379d522f475Smrg palette control strings without checking. The result makes xterm 380d522f475Smrg appear to freeze. This workaround makes xterm ignore the strings, 381d522f475Smrg and is compiled-in by default for Linux. 382d522f475Smrg 383d522f475Smrg --enable-dabbrev enable dynamic-abbreviation support 384d522f475Smrg 385d522f475Smrg Compile-in support for "dabbrev-expand()" action and related key 386d522f475Smrg translation. 387d522f475Smrg 388d522f475Smrg --enable-dec-locator enable DECterm Locator support 389d522f475Smrg Add support for DEC Locator control sequences for xterm: 390d522f475Smrg 391d522f475Smrg DECEFR - Enable Filter Rectangle 392d522f475Smrg DECELR - Enable Locator Reports 393d522f475Smrg DECSLE - Select Locator Events 394d522f475Smrg DECRQLP - Request Locator Position 395d522f475Smrg 396d522f475Smrg This allows the xterm mouse to be used with applications that use the 397d522f475Smrg DEC Locator sequences, such as VAX Tpu, or SMG$ based applications. 398d522f475Smrg 3990bd37d32Smrg --enable-delete-is-del set default deleteIsDEL resource (default: maybe) 4000bd37d32Smrg 4010bd37d32Smrg This sets the default resource value, which is shown in the manpage. 4020bd37d32Smrg 4030bd37d32Smrg --enable-double-buffer enable double-buffering 4040bd37d32Smrg 4050bd37d32Smrg Use experimental double-buffering for display to reduce flicker. 4060bd37d32Smrg 4070bd37d32Smrg This option was introduced in patch #282; at that point it needs 4080bd37d32Smrg further work because colors used for clearing the screen do not 4090bd37d32Smrg match the expected behavior (see vttest for instance). 4100bd37d32Smrg 411d522f475Smrg --enable-exec-xterm enable "spawn-new-terminal" action 412d522f475Smrg 413d522f475Smrg If your platform supports the process filesystem "cwd" link, 414d522f475Smrg compile-in support for the "spawn-new-terminal" action, which 415d522f475Smrg allows you to define a key translation that runs a new xterm 416d522f475Smrg using the same working directory as the current process within 417d522f475Smrg xterm. 418d522f475Smrg 419d522f475Smrg --enable-hp-fkeys enable support for HP-style function keys 420d522f475Smrg 421d522f475Smrg Compile-in code to support HP-style function keys. 422d522f475Smrg 423d522f475Smrg --enable-load-vt-fonts enable load-vt-fonts() action 424d522f475Smrg 425d522f475Smrg Compile-in code that allows user to define load different VT-font 426d522f475Smrg definitions at runtime. 427d522f475Smrg 428d522f475Smrg --enable-logfile-exec enable exec'd logfile filter 429d522f475Smrg 430d522f475Smrg Compile-in code that allows logging piped via an external filter. 431d522f475Smrg 432d522f475Smrg --enable-logging enable logging 433d522f475Smrg 434d522f475Smrg Compile-in code that allows logging. 435d522f475Smrg 436d522f475Smrg Logging was disabled in X11R5 xterm because of security problems. 437d522f475Smrg They were addressed in X11R6, but the feature was not reinstated. 438d522f475Smrg 439d522f475Smrg --enable-luit enable support for luit filter (Unicode translation) 440d522f475Smrg 441d522f475Smrg Luit is a filter that can be run between an arbitrary application and a 442d522f475Smrg UTF-8 terminal emulator. It will convert application output from the 443d522f475Smrg locale's encoding into UTF-8, and convert terminal input from UTF-8 444d522f475Smrg into the locale's encoding. 445d522f475Smrg 446d522f475Smrg This sets "--enable-wide-chars" as a side-effect. 447d522f475Smrg 4480bd37d32Smrg --enable-meta-sends-esc set default metaSendsEscape resource (default: no) 4490bd37d32Smrg 4500bd37d32Smrg This sets the default resource value, which is shown in the manpage. 4510bd37d32Smrg 452d522f475Smrg --enable-mini-luit enable support for poor man's luit filter (Latin-9) 453d522f475Smrg 454d522f475Smrg Provide built-in support for Latin-9, relying on having specified 455d522f475Smrg Unicode (ISO10646) fonts and setting the locale resource to "checkfont". 456d522f475Smrg 457d522f475Smrg This sets "--enable-luit" as a side-effect. 458d522f475Smrg 459d522f475Smrg --enable-narrowproto enable narrow prototypes for X libraries 460d522f475Smrg 461d522f475Smrg Originally xterm was built using imake rather than a configure script. 462d522f475Smrg One feature of imake that is not possible to guess within the 463d522f475Smrg configure script is the wide-prototype compile-time definition 464d522f475Smrg NARROWPROTO. When this is not set properly, the Athena widget 465d522f475Smrg scrollbars do not work properly. xterm's configure script has a 466d522f475Smrg fallback case which allows disabling imake. However, this is moot 467d522f475Smrg with the X.org "modular" build, whose compiler options are unrelated to 468d522f475Smrg imake or older versions of any libraries that it may distribute. In 469d522f475Smrg this case, the configure script needs some help. Use this option to 470d522f475Smrg enable or disable NARROW proto (and disable imake with the 471d522f475Smrg --disable-imake option) to match the whims of X.org hackers. 472d522f475Smrg 473d522f475Smrg For instance 474d522f475Smrg 475d522f475Smrg configure --disable-imake --disable-narrowproto 476d522f475Smrg 477d522f475Smrg --enable-readline-mouse enable support for mouse in readline applications 478d522f475Smrg 479d522f475Smrg Compile-in code to support experimental bracketed paste mode, i.e., 480d522f475Smrg provide functions for setting/getting the selection data. Essentially 481d522f475Smrg this puts xterm into a mode that sends special function-key strings to 482d522f475Smrg bracket the data. 483d522f475Smrg 484d522f475Smrg (See --enable-paste64, which fits xterm's protocol better). 485d522f475Smrg 486d522f475Smrg --enable-sco-fkeys enable support for SCO-style function keys 487d522f475Smrg 488d522f475Smrg Compile-in code to support SCO-style function keys. 489d522f475Smrg 490d522f475Smrg --enable-sun-fkeys enable support for Sun-style function keys 491d522f475Smrg 492d522f475Smrg Compile-in code to support Sun-style function keys. 493d522f475Smrg 494d522f475Smrg --enable-toolbar enable pulldown menus on toolbar 495d522f475Smrg 496d522f475Smrg Compile-in code that builds a toolbar with pulldown menus. The 497d522f475Smrg normal popup menus are still available. 498d522f475Smrg 499d522f475Smrg This is an experimental option. As of patch #206, it is known to 500d522f475Smrg work well with fvwm, but not as well with some other window managers, 501d522f475Smrg e.g., KDE's Kwin and IceWM. 502d522f475Smrg 503d522f475Smrg In addition to isolated layout problems, it is reported that some 504d522f475Smrg flavors of the Athena widget library perform badly with ISO-10646 505d522f475Smrg fonts. You can work around those by setting the menu fonts to 506d522f475Smrg an ISO-8859 variant in your X resources. 507d522f475Smrg 508d522f475Smrg --enable-trace test: set to enable debugging traces 509d522f475Smrg 510d522f475Smrg Compile-in code to trace xterm's internal states. 511d522f475Smrg 512d522f475Smrg This is a debugging feature. It causes xterm to produce two files 513d522f475Smrg (Trace-parent.out and Trace-child.out). 514d522f475Smrg 515d522f475Smrg --enable-warnings test: turn on GCC compiler warnings 516d522f475Smrg 517d522f475Smrg Modify the generate Makefile to turn on gcc compiler warnings. 518d522f475Smrg 519d522f475Smrg I use this option regularly, and correct all but a few (difficult) 520d522f475Smrg problems. 521d522f475Smrg 522d522f475Smrg --enable-wide-chars enable wide-character support 523d522f475Smrg 524d522f475Smrg Compile-in code that supports 16-bit characters. Includes support 525d522f475Smrg for UTF-8. 526d522f475Smrg 527d522f475Smrg --enable-xmc-glitch test: enable xmc magic-cookie emulation 528d522f475Smrg 529d522f475Smrg Compile-in code that simulates the terminfo "magic cookie" glitch. 530d522f475Smrg 531d522f475Smrg This is for testing ncurses. 532d522f475Smrg 533d522f475Smrg --with-Xaw3d link with Xaw 3d library 534d522f475Smrg 535d522f475Smrg Look for, compile and link with the Xaw 3d widget library. 536d522f475Smrg 537d522f475Smrg --with-XawPlus link with Athena-Plus library 538d522f475Smrg 539d522f475Smrg Look for, compile and link with the Xaw Plus widget library. 540d522f475Smrg 541e39b573cSmrg --with-app-class=XXX X resource class (default: XTerm) 542e39b573cSmrg 543e39b573cSmrg Rename the X resource class, e.g., for packaging a development version 544e39b573cSmrg of xterm with different result names. 545e39b573cSmrg 546d522f475Smrg --with-app-defaults=DIR directory in which to install resource files (default: EPREFIX/lib/X11/app-defaults) 547d522f475Smrg 548d522f475Smrg autoconf scripts assume that all of the files should be installed 549d522f475Smrg under the same top-level directory. But X applications defaults 550d522f475Smrg must be installed into a special directory, e.g., 551d522f475Smrg 552d522f475Smrg /usr/X11/lib/app-defaults 553d522f475Smrg 554d522f475Smrg However, there is no standard for this pathname. The manual page 555d522f475Smrg for X notes that the environment variable $XUSERFILESEARCHPATH can 556d522f475Smrg specify a list of places where X searches for applications defaults. 557d522f475Smrg Also, it may look in $XAPPLRESDIR, but that usually is not related 558d522f475Smrg to where xterm might be installed. To keep it simple, the configure 559d522f475Smrg script uses 560d522f475Smrg 561d522f475Smrg EPREFIX/lib/X11/app-defaults 562d522f475Smrg 563d522f475Smrg as the default (EPREFIX is --prefix). That makes it work normally 564d522f475Smrg for most systems if --prefix is /usr. For other installs, e.g., to 565d522f475Smrg /usr/local, you should use this option to customize the location to 566d522f475Smrg match your system configuration. 567d522f475Smrg 5680bd37d32Smrg Use --with-app-defaults=auto to ask the configure script to look in 5690bd37d32Smrg a list of well-known locations for an existing directory. 5700bd37d32Smrg 571d522f475Smrg Use --without-app-defaults or --with-app-defaults=no to disable the 572d522f475Smrg feature. 573d522f475Smrg 5740bd37d32Smrg --with-dmalloc test: use Gray Watson's dmalloc library 5750bd37d32Smrg 5760bd37d32Smrg Check for and link with dmalloc. 5770bd37d32Smrg 5780bd37d32Smrg --with-dbmalloc test: use Conor Cahill's dbmalloc library 5790bd37d32Smrg 5800bd37d32Smrg Check for and link with dbmalloc. 5810bd37d32Smrg 582e39b573cSmrg --with-desktop-category=XXX one or more desktop catgories or auto 583e39b573cSmrg This is a list of names. The configure script maps blanks and commas 584e39b573cSmrg to semicolons (";") which are used by the desktop utils as a separator. 585e39b573cSmrg 586e39b573cSmrg The default value "auto" tells the configure script to look 587e39b573cSmrg at existing ".desktop" files for xterm and common terminal 5880bd37d32Smrg emulators, to use those. If none are found, the script uses this 5890bd37d32Smrg default: 5900bd37d32Smrg System;TerminalEmulator;Utility; 5910bd37d32Smrg 5920bd37d32Smrg --with-freetype-config configure script to use for FreeType 5930bd37d32Smrg 5940bd37d32Smrg Use a specific option value to tell the configure script to try 5950bd37d32Smrg just one of the variations: 5960bd37d32Smrg 5970bd37d32Smrg "pkg*", e.g., pkg-config or pkgconfig uses whatever pkg-config 5980bd37d32Smrg script was found. 5990bd37d32Smrg 6000bd37d32Smrg otherwise, the parameter value is used as the name of the script 6010bd37d32Smrg to try, using --cflags and --libs options. 6020bd37d32Smrg 6030bd37d32Smrg Use --without-freetype-config to enable the --with-freetype-cflags 6040bd37d32Smrg and --with-freetype-libs options. 6050bd37d32Smrg 6060bd37d32Smrg The default value "auto" tells the configure script to try the 6070bd37d32Smrg pkg-config script first, then freetype-config and finally xft-config. 608e39b573cSmrg 609d522f475Smrg --with-freetype-cflags -D/-I options for compiling with FreeType library 610d522f475Smrg 611d522f475Smrg Override options provided by xft-config or freetype-config. 612d522f475Smrg 613d522f475Smrg --with-freetype-libs -L/-l options for linking with FreeType library 614d522f475Smrg 615d522f475Smrg Override options provided by xft-config or freetype-config. 616d522f475Smrg 6170bd37d32Smrg --with-icon-name=NAME override icon name (default: xterm-color) 6180bd37d32Smrg 6190bd37d32Smrg xterm comes with a choice of icons: 6200bd37d32Smrg 6210bd37d32Smrg xterm-color: depicts a conventional terminal image, and is the default 6220bd37d32Smrg icon used for icon-themes. 6230bd37d32Smrg 6240bd37d32Smrg mini.xterm: a more iconic choice which is readily identifiable at 6250bd37d32Smrg small sizes. This is used for window decoration, e.g., the 6260bd37d32Smrg icon at the upper left corner in many window managers. 6270bd37d32Smrg 6280bd37d32Smrg --with-icon-symlink=NAME create symbolic links to icon name (default: NONE) 6290bd37d32Smrg 6300bd37d32Smrg This is a workaround for certain systems which translate icon names 6310bd37d32Smrg containing "xterm", e.g., "xterm-color" into the single icon "xterm". 6320bd37d32Smrg The option should also be harmless on a properly configured system. 6330bd37d32Smrg 6340bd37d32Smrg If the option is used, its default value is "xterm". For each icon, 6350bd37d32Smrg the makefile will strip the suffix (e.g., ".png"), as well as the part 6360bd37d32Smrg of the filename which denotes the size (e.g., "_32x32" in an xpm file), 6370bd37d32Smrg and constructs a link with that name to the icon. 6380bd37d32Smrg 6390bd37d32Smrg If the option is unused, its default value is "NONE" (no link is made). 6400bd37d32Smrg 6410bd37d32Smrg --with-icondir=DIR directory in which to install icon files (default: no) 642d522f475Smrg 643d522f475Smrg The X libraries may automatically search these locations: 644d522f475Smrg 645d522f475Smrg $HOME/.icons 646d522f475Smrg $XDG_DATA_DIRS/icons 647d522f475Smrg /usr/share/pixmaps 648d522f475Smrg 6490bd37d32Smrg Alternatively, the last may be actually 6500bd37d32Smrg /usr/X11R6/share/pixmaps 6510bd37d32Smrg 6520bd37d32Smrg Use --with-icondir=auto to tell the configure script to search for 6530bd37d32Smrg an existing directory from its list of well-known system locations. 6540bd37d32Smrg 655d522f475Smrg See also 656d522f475Smrg http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html 6570bd37d32Smrg http://www.freedesktop.org/software/icon-theme/ 6580bd37d32Smrg 6590bd37d32Smrg By default, the option is disabled; it is useful only for the 6600bd37d32Smrg --with-icon-theme option. 6610bd37d32Smrg 6620bd37d32Smrg --with-icon-theme=XXX install icons into desktop theme (hicolor) 663d522f475Smrg 6640bd37d32Smrg Install png and svg icons into the given desktop theme and customize 6650bd37d32Smrg the .desktop files to use that theme. If no theme name is given, 6660bd37d32Smrg the default is "hicolor". If this option is not given, the desktop 6670bd37d32Smrg file will use the pixmap files. 668d522f475Smrg 669d522f475Smrg --with-neXtaw link with neXT Athena library 670d522f475Smrg 671d522f475Smrg Look for, compile and link with the neXT Athena widget library. 672d522f475Smrg 673d522f475Smrg --with-own-terminfo=P set default $TERMINFO (default: from environment) 674d522f475Smrg 675d522f475Smrg Modify the generated Makefile to set the target for the 'install-ti' 676d522f475Smrg rule to point to the given directory. 677d522f475Smrg 678d522f475Smrg If you have the $TERMINFO variable defined in your environment, the 679d522f475Smrg configure script will use that value. If no option and no variable 680d522f475Smrg are are given, the configure script uses /usr/lib/terminfo, if it 681d522f475Smrg exists. 682d522f475Smrg 683d522f475Smrg You do not have to run "make install-ti", if there is already a 684d522f475Smrg workable terminfo description. Be advised, however, that the 685d522f475Smrg common variety of "xterm-color" is not suited for xterm, but is 686d522f475Smrg directed to other variations (such as nxterm) which do not 687d522f475Smrg support the background-color erase capability. 688d522f475Smrg 689d522f475Smrg --with-pcre use PCRE for regular-expressions 690d522f475Smrg 691d522f475Smrg If regular expressions are not disable (--disable-regex), use PCRE 692d522f475Smrg rather than the POSIX regular expressions. 693d522f475Smrg 69420d2c4d2Smrg --with-pkg-config{=path} enable/disable use of pkg-config 69520d2c4d2Smrg 69620d2c4d2Smrg The configure script looks for certain libraries which have well 69720d2c4d2Smrg established pkg-config scripts, and will use those settings if 69820d2c4d2Smrg available. Not all pkg-config scripts work; this option suppresses 69920d2c4d2Smrg the check and relies on normal library search paths. 70020d2c4d2Smrg 701d522f475Smrg --with-reference=XXX program to use as permissions-reference 702d522f475Smrg 703d522f475Smrg To install xterm with setuid permissions, the scripts usually compare 704d522f475Smrg it with a previous install. That works well for individual 705d522f475Smrg maintainers, but can be a problem for packagers who may be 706d522f475Smrg cross-compiling, etc. This option lets the package builder specify 707d522f475Smrg the file used for permissions reference. 708d522f475Smrg 709d522f475Smrg --with-setuid=XXX use the given setuid user 710d522f475Smrg 711d522f475Smrg Install xterm setuid'd to the given user. If no parameter value 712d522f475Smrg is given, assume it is root. 713d522f475Smrg 714d522f475Smrg See also --with-utmp-setgid and --with-utempter, which manipulate 715d522f475Smrg the setgid group. 716d522f475Smrg 717d522f475Smrg --with-tty-group=XXX use XXX for the tty-group 718d522f475Smrg 719d522f475Smrg If xterm is installed setuid'd to root, change the group of the tty 720d522f475Smrg device to the given value on startup. Three cases are possible: 721d522f475Smrg 722d522f475Smrg a) If this option is not given, the configure script will attempt to 723d522f475Smrg find a suitable value (usually "tty"), and verify that it exists in 724d522f475Smrg the group database. 725d522f475Smrg 726d522f475Smrg b) If the option value is given, it will use the value even if it does 727d522f475Smrg not exist in the group database (allowing packagers to work about 728d522f475Smrg deficient environments). 729d522f475Smrg 730d522f475Smrg c) If the option is disabled, e.g., --without-tty-group, the 731d522f475Smrg permissions change will use the group-id of the process. 732d522f475Smrg 733d522f475Smrg If xterm is not installed setuid'd to root, this option is not needed, 734d522f475Smrg since it cannot change the tty device's ownership. 735d522f475Smrg 7360bd37d32Smrg --with-valgrind test: use valgrind 7370bd37d32Smrg 7380bd37d32Smrg Activate the --disable-leaks option, and ensure that "-g" is added to 7390bd37d32Smrg CFLAGS. 7400bd37d32Smrg 7410bd37d32Smrg --with-xpm=DIR use Xpm library for colored icon, may specify path 7420bd37d32Smrg 7430bd37d32Smrg Use Xpm library to show colored icon in window decoration, e.g., 7440bd37d32Smrg title area. 7450bd37d32Smrg 7460bd37d32Smrg Use --without-xpm to suppress this feature. 7470bd37d32Smrg 748d522f475Smrg --with-xterm-symlink=XXX make symbolic link to installed xterm 749d522f475Smrg 750d522f475Smrg If any of the configure options to modify the program name i.e., 751d522f475Smrg --program-prefix, --program-suffix or --program-transform-name 752d522f475Smrg are given, this option allows the makefile to create a symbolic link, 753d522f475Smrg e.g., to "xterm" on install. The option value gives the name for 754d522f475Smrg the link, which defaults to "xterm". 755d522f475Smrg 756d522f475Smrg Use --without-xterm-symlink to disable a link to "xterm" if none 757d522f475Smrg is wanted. 758d522f475Smrg 759d522f475Smrg --with-terminal-id[=V] set default decTerminalID (default: vt100) 760d522f475Smrg 761d522f475Smrg Set the default emulation level. 762d522f475Smrg 763d522f475Smrg DEC terminals vt52/vt100/vt220/etc form a series where succeeding 764d522f475Smrg models emulate features of the older terminals. While most 765d522f475Smrg features of these terminals are recognized by xterm at all levels, 766d522f475Smrg a few behave differently according to the emulation level. 767d522f475Smrg 768d522f475Smrg You can always override this with the command-line option "-ti". 769d522f475Smrg 770d522f475Smrg --with-terminal-type=T set default $TERM (default: xterm) 771d522f475Smrg 772d522f475Smrg Set the default value for $TERM. Xterm supports legacy termcap 773d522f475Smrg applications by constructing a modified version of the $TERMCAP 774d522f475Smrg variable at initialization, which supplies the resulting screen 775d522f475Smrg size. It also sets $TERM, if not already set, for use by programs 776d522f475Smrg running within xterm. 777d522f475Smrg 778d522f475Smrg The default value "xterm", can be overridden to avoid conflict 779d522f475Smrg with older versions of xterm, e.g., those that do not implement 780d522f475Smrg vt220 emulation. 781d522f475Smrg 782d522f475Smrg You can always override this with the command-line option "-tn". 783d522f475Smrg 784d522f475Smrg --with-utempter use utempter library for access to utmp 785d522f475Smrg 786d522f475Smrg The utempter library is a set-uid wrapper for the utmp facility. 787d522f475Smrg On systems with Unix98 pty's, xterm can use this library when 788d522f475Smrg available so it need not be installed set-uid. 789d522f475Smrg 790d522f475Smrg --with-utmp-setgid=XXX use setgid for access to utmp 791d522f475Smrg 792d522f475Smrg The option value specifies a group to use when installing. 793d522f475Smrg xterm will be installed with setgid privilege to this group. 794d522f475Smrg At runtime, xterm will drop the setuid privilege immediately 795d522f475Smrg after opening the pseudo-terminal, and will have only the 796d522f475Smrg group privilege needed to access the utmp file. This relies 797d522f475Smrg on having POSIX setuid behavior. 798d522f475Smrg 799d522f475Smrg-- vile:txtmode 800