INSTALL revision 5307cd1a
15307cd1aSmrg-- $XTermId: INSTALL,v 1.191 2023/02/12 19:16:32 tom Exp $ 2d522f475Smrg------------------------------------------------------------------------------- 35307cd1aSmrg-- Copyright 1997-2022,2023 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 33e0a2b6dfSmrgimake to generate a Makefile from Imakefile. 34d522f475Smrg 355307cd1aSmrgAn example Imakefile is provided for legacy use (with xmkmf). 36d522f475Smrg 37e0a2b6dfSmrgThe preferred method uses the configure script to generate a Makefile from 38e0a2b6dfSmrgMakefile.in 39d522f475Smrg 40d522f475SmrgOptions: 41d522f475Smrg------- 42d522f475Smrg 43d522f475SmrgAutoconf configure scripts recognize two types of application-defined 44d522f475Smrgoptions, enable/disable and with/without. The latter, by convention, are 45d522f475Smrgused for denoting inclusion of external packages, while the former denote 46d522f475Smrgenabling/disabling of internal features. The configure --help option lists 47d522f475Smrgthe available options. This script uses "enable" and "disable" to indicate 48d522f475Smrgthe sense of the default behavior. 49d522f475Smrg 50d522f475SmrgThe options (in alphabetic order): 51d522f475Smrg 52f2e35a3aSmrg --disable-256-color disable 256-color support 53f2e35a3aSmrg 54f2e35a3aSmrg Do not compile-in code that interprets SGR 38 and 48 for 256-colors. 55f2e35a3aSmrg If this feature is disabled, the 88-color feature will be used. 56f2e35a3aSmrg 57f2e35a3aSmrg --disable-88-color disable 88-color support 58f2e35a3aSmrg 59f2e35a3aSmrg Do not compile-in code that interprets SGR 38 and 48 for 88-colors. 60f2e35a3aSmrg The 256-color option overrides this. 61f2e35a3aSmrg 62d522f475Smrg --disable-16-color disable 16-color support 63d522f475Smrg 64d522f475Smrg Do not compile-in code to recognize aixterm-style control sequences 65d522f475Smrg that support color values 8-15. 66d522f475Smrg 67d522f475Smrg Most color applications know only about 8 ANSI colors, but some 68d522f475Smrg (e.g., ones built with ncurses) do. 69d522f475Smrg 70d522f475Smrg --disable-active-icon disable X11R6.3 active-icon feature 71d522f475Smrg 72d522f475Smrg Do not compile-in code to support the active-icon feature. This is 73d522f475Smrg not configured on systems (e.g., X11R5) which lack the library 74d522f475Smrg support needed. 75d522f475Smrg 76d522f475Smrg Xterms with an active icon continue to respond to input and update 77d522f475Smrg their display when iconified. Not all window managers support 78d522f475Smrg active icons. Those that do include fvwm, olvwm and mwm. 79d522f475Smrg 80d522f475Smrg --disable-ansi-color disable ANSI color 81d522f475Smrg 82d522f475Smrg Do not compile-in code for ANSI colors. 83d522f475Smrg 84d522f475Smrg --disable-blink-cursor disable support for blinking cursor 85d522f475Smrg 86d522f475Smrg Do not compile-in code that implements a blinking cursor. The blinking 87d522f475Smrg cursor is enabled either by resource setting or by popup menu entry. 88d522f475Smrg 89d522f475Smrg --disable-bold-color disable PC-style mapping of bold colors 90d522f475Smrg 91d522f475Smrg Do not compile-in code that maps colors 8-15 to bold versions of 92d522f475Smrg colors 0-7. 93d522f475Smrg 94d522f475Smrg Some applications have hardcoded logic that assumes this. It does 95d522f475Smrg not interfere with the 16-color support. 96d522f475Smrg 97d522f475Smrg --disable-boxchars disable fallback-support for box chars 98d522f475Smrg 99d522f475Smrg Do not compile-in code to generate approximations for box/graphic 100d522f475Smrg characters. 101d522f475Smrg 102d522f475Smrg Most fonts do not contain the vt100-style graphic characters in 103d522f475Smrg positions 0-31. Many applications use the line-drawing characters, 104d522f475Smrg e.g., to make boxes. When xterm loads a font, it checks if those 105d522f475Smrg characters are present, and draws its own if they are missing. 106d522f475Smrg 107f2e35a3aSmrg --disable-broken-st disallow broken string-terminators, 10820d2c4d2Smrg 10920d2c4d2Smrg Do not compile-in code that works around a bug in some ISDN routers 11020d2c4d2Smrg (and possibly other applications written by the same people): they 11120d2c4d2Smrg send an unterminated control string in their banner text, making xterm 11220d2c4d2Smrg freeze. 11320d2c4d2Smrg 11420d2c4d2Smrg The workaround tells xterm to stop processing the control string when 11520d2c4d2Smrg it receives one of the whitespace control characters such as newline. 11620d2c4d2Smrg That was the behavior before patch #171. 11720d2c4d2Smrg 11820d2c4d2Smrg See also --enable-broken-osc 11920d2c4d2Smrg 120f2e35a3aSmrg --disable-c1-print disallow -k8 option for printable 128-159, 121d522f475Smrg 122d522f475Smrg Use this option to suppress support for nonstandard use of codes 123d522f475Smrg 128-159, which normally are considered control characters. Some users 124d522f475Smrg have fonts which use those positions. The default value for the 125d522f475Smrg allowC1Printable resource is false, so this feature does not impact 126d522f475Smrg normal users. 127d522f475Smrg 128d522f475Smrg --disable-color-class disable color class resources 129d522f475Smrg 130d522f475Smrg Use this option to change most of the color resources to use Foreground 131d522f475Smrg as the color class. This is the older (before patch #157) behavior 132d522f475Smrg which has the drawback that setting the Foreground resource on most 133d522f475Smrg platforms prevents use of color since the class is evaluated before 134d522f475Smrg the instance. 135d522f475Smrg 136d522f475Smrg --disable-color-mode disable default colorMode resource 137d522f475Smrg 138d522f475Smrg Do not compile-in code that sets the default value of the colorMode 139d522f475Smrg resource to ``true''. 140d522f475Smrg 141d522f475Smrg --disable-desktop disable install of xterm desktop files 142d522f475Smrg 143d522f475Smrg Do not install the xterm desktop files, used in menus. 144d522f475Smrg These use the icons installed in the --with-icondir option. 145d522f475Smrg Use the environment variable $DESKTOP_FLAGS to supply options 146d522f475Smrg required by desktop-file-install. 147d522f475Smrg 148d522f475Smrg Note: If desktop-utils is not found they will not be installed anyway. 149d522f475Smrg 150f2e35a3aSmrg --disable-direct-color disable direct color support 151f2e35a3aSmrg 152f2e35a3aSmrg Do not compile-in code that interprets SGR 38 and 48 for direct colors. 153f2e35a3aSmrg This feature extends the 256-color feature. 154f2e35a3aSmrg 155d522f475Smrg --disable-doublechars disable support for double-size chars 156d522f475Smrg 157d522f475Smrg Do not compile-in code that supports font-manipulation needed to 158d522f475Smrg implement vt100-style double-sized characters. 159d522f475Smrg 160d522f475Smrg --disable-echo test: display "compiling" commands 161d522f475Smrg 162d522f475Smrg Modify the generated Makefile so that most compiler options are 163d522f475Smrg not shown. This makes it simpler to read a build log and see the 164d522f475Smrg actual warning messages. 165d522f475Smrg 1665307cd1aSmrg --disable-exec-selection disable "exec-formatted" and "exec-selection" actions 1675307cd1aSmrg 1685307cd1aSmrg Do not compile-in code for the "exec-formatted" and "exec-selection" 1695307cd1aSmrg actions, which allow the user to run programs to process the results 1705307cd1aSmrg of selecting text. 1715307cd1aSmrg 172956cc18dSsnj --disable-fifo-lines enable FIFO-storage for saved-lines 173956cc18dSsnj 174a5ae21e4Smrg (this option is deprecrated) 175956cc18dSsnj 176d522f475Smrg --disable-freetype disable freetype library-support 177d522f475Smrg 178f2e35a3aSmrg Do not use freetype libraries if they are found. Normally they will 179d522f475Smrg be used automatically. 180d522f475Smrg 181d522f475Smrg --disable-full-tgetent disable check for termcap library 182d522f475Smrg 183d522f475Smrg Do not look for the tgetent() function specifically in the termcap 184d522f475Smrg library, accept the first library (from termlib, ncurses and curses) 185d522f475Smrg which contains this function rather than continuing to search for 186d522f475Smrg a termcap implementation rather than terminfo. The former would 187d522f475Smrg supply the complete $TERMCAP data needed for some legacy programs. 188d522f475Smrg 189d522f475Smrg --disable-highlighting disable support for color highlighting 190d522f475Smrg 191d522f475Smrg Do not compile-in code that allows the selected region to be a 192d522f475Smrg different color than the reverse of foreground/background colors. 193d522f475Smrg 194d522f475Smrg See the discussion of highlightColor in the manual. 195d522f475Smrg 196d522f475Smrg --disable-i18n disable internationalization 197d522f475Smrg 198d522f475Smrg Do not compile-in code to handle multi-byte characters. This is 199d522f475Smrg related to, but not identical with the input method logic. 200d522f475Smrg 201d522f475Smrg --disable-imake disable use of imake for definitions 202d522f475Smrg 203d522f475Smrg Do not attempt to use imake to determine compiler options. 204d522f475Smrg 205d522f475Smrg The main.c file has many ifdef's which rely on obscure combinations 206d522f475Smrg known only to imake. The configure script implements only a 207d522f475Smrg portion of the tests needed to supplant imake. 208d522f475Smrg 209d522f475Smrg --disable-initial-erase disable setup for stty erase 210d522f475Smrg 211d522f475Smrg Do not compile-in code which aligns the stty erase and the backarrow 212d522f475Smrg key. When compiled-in, xterm will optionally use the pty's sense 213d522f475Smrg of stty erase and apply that to the backarrow mode (sending 8 or 127), 214d522f475Smrg or go the other way, setting stty erase to match xterm's configuration. 215d522f475Smrg 216d522f475Smrg --disable-input-method disable input-method 217d522f475Smrg 218d522f475Smrg Do not compile-in code for "input method". This is an X11R6 219d522f475Smrg feature which deals with translation of composite characters. 220d522f475Smrg 221d522f475Smrg Some users report problems with their configuration, e.g., messages 222d522f475Smrg stating that there is no input method defined for the given preedit 223d522f475Smrg type. If you do not need input method (and are troubled by the 224d522f475Smrg warning messages), it is safe to disable this option. 225d522f475Smrg 2260bd37d32Smrg --disable-leaks test: free permanent memory, analyze leaks 227d522f475Smrg 228d522f475Smrg Compile-in code which frees memory which might confuse a leak-testing 229d522f475Smrg tool. Normally these chunks of memory are retained as long as xterm 230d522f475Smrg is running. 231d522f475Smrg 232e0a2b6dfSmrg --disable-luit disable support for luit filter (Unicode translation) 233e0a2b6dfSmrg 234e0a2b6dfSmrg Luit is a filter that can be run between an arbitrary application and a 235e0a2b6dfSmrg UTF-8 terminal emulator. It will convert application output from the 236e0a2b6dfSmrg locale's encoding into UTF-8, and convert terminal input from UTF-8 237e0a2b6dfSmrg into the locale's encoding. 238e0a2b6dfSmrg 239e0a2b6dfSmrg This is normally enabled, relying upon "--enable-wide-chars". 240e0a2b6dfSmrg 241d522f475Smrg --disable-maximize disable actions for iconify/deiconify/maximize/restore 242d522f475Smrg 243d522f475Smrg Do not compile-in code that implements runtime 'actions' for 244d522f475Smrg iconifying, maximizing, etc. 245d522f475Smrg 246d522f475Smrg Most users will find that the window manager is more suitable for 247d522f475Smrg this sort of manipulation than putting the capabilities into xterm. 248d522f475Smrg 249d522f475Smrg --disable-num-lock disable NumLock keypad support 250d522f475Smrg 251d522f475Smrg Do not compile-in code that looks for the actual NumLock key to 252d522f475Smrg support vt100/vt220 keypad translation. 253d522f475Smrg 254d522f475Smrg This is used in xterm to simplify logic, and to workaround some 255d522f475Smrg quirks of the keyboard tables. Use the ``numLock'' resource to 256d522f475Smrg disable this feature if you must customize xterm in some other way. 257d522f475Smrg 258d522f475Smrg (The same ifdef controls the metaSendsEscape support). 259d522f475Smrg 2600bd37d32Smrg --disable-openpty disable openpty, prefer other interfaces 2610bd37d32Smrg 2620bd37d32Smrg Do not check for, or use openpty(). Instead, use other interfaces such 2630bd37d32Smrg as posix_openpt(). Modern (sic) BSD systems should have a workable 2640bd37d32Smrg openpty() interface. Older systems may not. 2650bd37d32Smrg 2662eaa94a1Schristos --disable-paste64 disable support for bracketed paste mode 2672eaa94a1Schristos 268f2e35a3aSmrg Do not compile-in code to support bracketed paste mode, along with 269f2e35a3aSmrg functions for setting/getting the selection data, termed "paste64". 270f2e35a3aSmrg 271f2e35a3aSmrg (see ctlseqs.ms description of OSC 52, and DECSET 2004). 272f2e35a3aSmrg 273f2e35a3aSmrg --disable-print-graphics disable screen dump to sixel support 2742eaa94a1Schristos 275f2e35a3aSmrg Do not compile-in code to support screen-dumps for ReGIS graphics. 2762eaa94a1Schristos 277d522f475Smrg --disable-pty-handshake disable support for pty handshakes 278d522f475Smrg 279d522f475Smrg This feature is used to ensure that the child process's terminal modes 280d522f475Smrg match the parent's. In particular, it addresses a problem where the 281d522f475Smrg terminal size is not defined in the stty settings. 282d522f475Smrg 283d522f475Smrg --disable-rectangles disable VT420 rectangle support 284d522f475Smrg 285d522f475Smrg Do not compile-in code to support VT420 rectangle control-sequences. 286d522f475Smrg 287d522f475Smrg --disable-regex disable regular-expression selections 288d522f475Smrg 289d522f475Smrg Do not compile-in code to support the "regex" option for multiple 290d522f475Smrg mouse clicks. 291d522f475Smrg 292d522f475Smrg --disable-rightbar disable right-scrollbar support 293d522f475Smrg 294d522f475Smrg Do not compile-in code that supports a scrollbar on the right. 295d522f475Smrg 296d522f475Smrg Left/right scrollbars are a matter of taste. Some older libraries 297d522f475Smrg (e.g., X11R5) do not perform the geometry computation correctly, 298d522f475Smrg leaving the right scrollbar incorrectly positioned after changing 299d522f475Smrg the font size. 300d522f475Smrg 3015307cd1aSmrg --disable-readline-mouse enable support for mouse in readline applications 3025307cd1aSmrg 3035307cd1aSmrg Do not compile-in code to support readline with mouse. 3045307cd1aSmrg 3055307cd1aSmrg (The "paste64" feature, which fits xterm's protocol better, is 3065307cd1aSmrg configured by default). 3075307cd1aSmrg 30820d2c4d2Smrg --disable-rpath-hack don't add rpath options for additional libraries 30920d2c4d2Smrg 31020d2c4d2Smrg By default, the configure script looks for libraries in unusual places 31120d2c4d2Smrg and adds an rpath linker option to help. 31220d2c4d2Smrg 313d522f475Smrg --disable-samename disable check for redundant name-change 314d522f475Smrg 315d522f475Smrg Do not compile-in code that suppresses redundant updates to the 316d522f475Smrg titlebar when the text has not changed. 317d522f475Smrg 318f2e35a3aSmrg --disable-screen-dumps disable XHTML and SVG screen dumps 319f2e35a3aSmrg 320f2e35a3aSmrg Do not compile-in code that provides XHTML and SVG screen dumps. 321f2e35a3aSmrg 3220bd37d32Smrg --disable-selection-ops disable selection operations 3230bd37d32Smrg 3240bd37d32Smrg Do not compile-in code to support the actions which allow users 3250bd37d32Smrg to bind keys that use the selection or extract data from the screen. 3260bd37d32Smrg 327d522f475Smrg --disable-session-mgt enable support for session management 328d522f475Smrg 329d522f475Smrg Do not compile-in code which adds simple session management hooks 330d522f475Smrg which are used when closing an xterm. Normally the code is 331d522f475Smrg compiled-in, except for systems which do not support it. 332d522f475Smrg 333d522f475Smrg --disable-setgid disable setgid 334d522f475Smrg 335d522f475Smrg Do not install xterm using setuid/setgid permissions. Drop setgid 336d522f475Smrg permissions on startup. 337d522f475Smrg 338d522f475Smrg --disable-setuid disable setuid 339d522f475Smrg 340d522f475Smrg Do not install xterm using setuid/setgid permissions. Drop setuid 341d522f475Smrg permissions on startup. 342d522f475Smrg 343f2e35a3aSmrg --disable-sixel-graphics disable support for sixel-graphics 344f2e35a3aSmrg 345f2e35a3aSmrg Do not compile-in code to support sixel-graphics 346f2e35a3aSmrg 347d522f475Smrg --disable-sun-fkeys 348d522f475Smrg 349d522f475Smrg Do not compile-in code to support Sun-style function keys. 350d522f475Smrg 351d522f475Smrg --disable-tcap-fkeys disable termcap function-keys 352d522f475Smrg 3532eaa94a1Schristos Do not compile-in code to support feature which allows xterm to use the 354d522f475Smrg function-key definitions from the termcap/terminfo entry which it used 355d522f475Smrg to set the $TERM variable on startup. 356d522f475Smrg 3572eaa94a1Schristos --disable-tcap-query disable termcap query/report 3582eaa94a1Schristos 3592eaa94a1Schristos Do not compile-in code to support DCS '+' control sequence, which 3602eaa94a1Schristos allows an application to ask xterm what control sequences it would 3612eaa94a1Schristos transmit for specified function keys, given the termcap or terminfo 3622eaa94a1Schristos names. 3632eaa94a1Schristos 364d522f475Smrg --disable-tek4014 disable tek4014 emulation 365d522f475Smrg 366d522f475Smrg Do not compile-in code to support Tektronix 4014 emulation. 367d522f475Smrg 368d522f475Smrg This reduces the executable size by 17% (checked 1999/3/13). 369d522f475Smrg 370d522f475Smrg Some people use the Tektronix emulation (which has been in xterm 371d522f475Smrg for many years) as an example of code bloat, though this is not an 372d522f475Smrg accurate impression. 373d522f475Smrg 374d522f475Smrg --disable-vt52 disable VT52 emulation 375d522f475Smrg 376d522f475Smrg Do not compile-in code to support vt52 emulation. 377d522f475Smrg 378d522f475Smrg A genuine vt100 emulates a vt52. 379d522f475Smrg 380894e0ac8Smrg --disable-wide-attrs disable wide-attribute support 381894e0ac8Smrg 382894e0ac8Smrg Xterm's base attributes include all of those used in DEC terminals. 383894e0ac8Smrg ISO 6429 defines a few more which historically have found little use. 384894e0ac8Smrg Some people find these amusing. 385894e0ac8Smrg 386f2e35a3aSmrg This is normally enabled. The direct-colors feature relies upon it. 387894e0ac8Smrg 388e0a2b6dfSmrg --disable-wide-chars disable wide-character support 389e0a2b6dfSmrg 390e0a2b6dfSmrg The wide-character code supports Unicode and UTF-8. 391e0a2b6dfSmrg 392e0a2b6dfSmrg This is normally enabled. 393e0a2b6dfSmrg 394ad37e533Smrg --disable-xcursor disable cursorTheme resource 395ad37e533Smrg 396ad37e533Smrg Do not compile-in code that sets the XCURSOR_THEME environment variable 397ad37e533Smrg to enable/disable cursor themes. 398ad37e533Smrg 399d522f475Smrg --disable-ziconbeep disable -ziconbeep option 400d522f475Smrg 401d522f475Smrg Do not compile-in code that modifies the icon's title and sounds a 402d522f475Smrg beep when they receive output. 403d522f475Smrg 404956cc18dSsnj --enable-16bit-chars enable 16-bit characters support 405956cc18dSsnj 406956cc18dSsnj Enable wide-character support, but store only 16-bits for each wide 407956cc18dSsnj character. Unicode values can be larger than 16-bits, up to 21-bits. 408956cc18dSsnj This uses less memory, but is less complete. However, most languages 409956cc18dSsnj are covered by the 16-bit encoding. 410956cc18dSsnj 4110bd37d32Smrg --enable-alt-sends-esc set default altSendsEscape resource (default: no) 4120bd37d32Smrg 4130bd37d32Smrg This sets the default resource value, which is shown in the manpage. 4140bd37d32Smrg 4150bd37d32Smrg --enable-backarrow-key set default backarrowKey resource (default: true) 4160bd37d32Smrg 4170bd37d32Smrg This sets the default resource value, which is shown in the manpage. 4180bd37d32Smrg 4190bd37d32Smrg --enable-backarrow-is-erase set default backarrowKeyIsErase resource (default: false) 4200bd37d32Smrg 4210bd37d32Smrg This sets the default resource value, which is shown in the manpage. 4220bd37d32Smrg 4232e4f8982Smrg --enable-broken-osc allow broken Linux OSC-strings 424d522f475Smrg 425d522f475Smrg Compile-in code to accommodate scripts that write Linux's malformed 426d522f475Smrg palette control strings without checking. The result makes xterm 427d522f475Smrg appear to freeze. This workaround makes xterm ignore the strings, 428d522f475Smrg and is compiled-in by default for Linux. 429d522f475Smrg 4302e4f8982Smrg --enable-builtin-xpms compile-in icon data 43101037d57Smrg 43201037d57Smrg Compile-in X pixmap data for these icons: 43301037d57Smrg filled-xterm 43401037d57Smrg mini.xterm 43501037d57Smrg xterm-color 43601037d57Smrg xterm 43701037d57Smrg at these sizes 43801037d57Smrg 16x16 43901037d57Smrg 32x32 44001037d57Smrg 48x48 44101037d57Smrg 442d522f475Smrg --enable-dabbrev enable dynamic-abbreviation support 443d522f475Smrg 444d522f475Smrg Compile-in support for "dabbrev-expand()" action and related key 445d522f475Smrg translation. 446d522f475Smrg 447d522f475Smrg --enable-dec-locator enable DECterm Locator support 448d522f475Smrg Add support for DEC Locator control sequences for xterm: 449d522f475Smrg 450d522f475Smrg DECEFR - Enable Filter Rectangle 451d522f475Smrg DECELR - Enable Locator Reports 452d522f475Smrg DECSLE - Select Locator Events 453d522f475Smrg DECRQLP - Request Locator Position 454d522f475Smrg 455d522f475Smrg This allows the xterm mouse to be used with applications that use the 456d522f475Smrg DEC Locator sequences, such as VAX Tpu, or SMG$ based applications. 457d522f475Smrg 4580bd37d32Smrg --enable-delete-is-del set default deleteIsDEL resource (default: maybe) 4590bd37d32Smrg 4600bd37d32Smrg This sets the default resource value, which is shown in the manpage. 4610bd37d32Smrg 4620bd37d32Smrg --enable-double-buffer enable double-buffering 4630bd37d32Smrg 464f2e35a3aSmrg Set the initial value of the "buffered" resource, which tells 465f2e35a3aSmrg xterm to use double-buffering for display to reduce flicker. 4660bd37d32Smrg 467913cc679Smrg --enable-env-terminfo setenv $TERMINFO if --with-own-terminfo gives value 468913cc679Smrg 469913cc679Smrg Use the custom terminfo directory specified in "--with-own-terminfo" 470913cc679Smrg as the $TERMINFO variable for the shells spawned by xterm. Setting 471913cc679Smrg this variable makes most curses (and termcap) applications look in 472913cc679Smrg that directory for terminal descriptions. 473913cc679Smrg 474d522f475Smrg --enable-exec-xterm enable "spawn-new-terminal" action 475d522f475Smrg 476d522f475Smrg If your platform supports the process filesystem "cwd" link, 477d522f475Smrg compile-in support for the "spawn-new-terminal" action, which 478d522f475Smrg allows you to define a key translation that runs a new xterm 479d522f475Smrg using the same working directory as the current process within 480d522f475Smrg xterm. 481d522f475Smrg 482d522f475Smrg --enable-hp-fkeys enable support for HP-style function keys 483d522f475Smrg 484d522f475Smrg Compile-in code to support HP-style function keys. 485d522f475Smrg 486d522f475Smrg --enable-load-vt-fonts enable load-vt-fonts() action 487d522f475Smrg 488d522f475Smrg Compile-in code that allows user to define load different VT-font 489d522f475Smrg definitions at runtime. 490d522f475Smrg 491d522f475Smrg --enable-logfile-exec enable exec'd logfile filter 492d522f475Smrg 493d522f475Smrg Compile-in code that allows logging piped via an external filter. 494d522f475Smrg 495d522f475Smrg --enable-logging enable logging 496d522f475Smrg 497d522f475Smrg Compile-in code that allows logging. 498d522f475Smrg 499d522f475Smrg Logging was disabled in X11R5 xterm because of security problems. 5002e4f8982Smrg They were addressed in X11R6, but the feature was not reinstated 5012e4f8982Smrg because of concerns (long past) about xterm running as root-setuid. 502d522f475Smrg 5030bd37d32Smrg --enable-meta-sends-esc set default metaSendsEscape resource (default: no) 5040bd37d32Smrg 5050bd37d32Smrg This sets the default resource value, which is shown in the manpage. 5060bd37d32Smrg 507d522f475Smrg --enable-mini-luit enable support for poor man's luit filter (Latin-9) 508d522f475Smrg 509d522f475Smrg Provide built-in support for Latin-9, relying on having specified 510d522f475Smrg Unicode (ISO10646) fonts and setting the locale resource to "checkfont". 511d522f475Smrg 512d522f475Smrg This sets "--enable-luit" as a side-effect. 513d522f475Smrg 514d522f475Smrg --enable-narrowproto enable narrow prototypes for X libraries 515d522f475Smrg 51601037d57Smrg Originally xterm was built using imake rather than a configure script. 517d522f475Smrg One feature of imake that is not possible to guess within the 518d522f475Smrg configure script is the wide-prototype compile-time definition 519d522f475Smrg NARROWPROTO. When this is not set properly, the Athena widget 520d522f475Smrg scrollbars do not work properly. xterm's configure script has a 521d522f475Smrg fallback case which allows disabling imake. However, this is moot 522d522f475Smrg with the X.org "modular" build, whose compiler options are unrelated to 523d522f475Smrg imake or older versions of any libraries that it may distribute. In 524d522f475Smrg this case, the configure script needs some help. Use this option to 525d522f475Smrg enable or disable NARROW proto (and disable imake with the 526d522f475Smrg --disable-imake option) to match the whims of X.org hackers. 527d522f475Smrg 528d522f475Smrg For instance 529d522f475Smrg 530d522f475Smrg configure --disable-imake --disable-narrowproto 531d522f475Smrg 53201037d57Smrg --enable-pty-erase set default ptyInitialErase resource (default: false) 53301037d57Smrg 53401037d57Smrg This sets the default resource value, which is shown in the manpage. 53501037d57Smrg 536ad37e533Smrg --enable-regis-graphics enable support for ReGIS graphics 537ad37e533Smrg 538ad37e533Smrg Compile-in code to support experimental ReGIS graphics 539ad37e533Smrg 540d522f475Smrg --enable-sco-fkeys enable support for SCO-style function keys 541d522f475Smrg 542d522f475Smrg Compile-in code to support SCO-style function keys. 543d522f475Smrg 5444419d26bSmrg --enable-status-line enable support for status-line 5454419d26bSmrg 5464419d26bSmrg Compile-in code to enable VT220-VT525 support for status-line. 5474419d26bSmrg 548ad37e533Smrg --enable-stdnoreturn enable C11 _Noreturn feature for diagnostics 549894e0ac8Smrg 550ad37e533Smrg Use the C11 _Noreturn keyword if the compiler supports it, rather 551ad37e533Smrg than the gcc-specific __attribute__((noreturn)). 552894e0ac8Smrg 553d522f475Smrg --enable-toolbar enable pulldown menus on toolbar 554d522f475Smrg 555d522f475Smrg Compile-in code that builds a toolbar with pulldown menus. The 556d522f475Smrg normal popup menus are still available. 557d522f475Smrg 558d522f475Smrg This is an experimental option. As of patch #206, it is known to 559d522f475Smrg work well with fvwm, but not as well with some other window managers, 560d522f475Smrg e.g., KDE's Kwin and IceWM. 561d522f475Smrg 562d522f475Smrg In addition to isolated layout problems, it is reported that some 563d522f475Smrg flavors of the Athena widget library perform badly with ISO-10646 564d522f475Smrg fonts. You can work around those by setting the menu fonts to 565d522f475Smrg an ISO-8859 variant in your X resources. 566d522f475Smrg 567d522f475Smrg --enable-trace test: set to enable debugging traces 568d522f475Smrg 569d522f475Smrg Compile-in code to trace xterm's internal states. 570d522f475Smrg 571d522f475Smrg This is a debugging feature. It causes xterm to produce two files 572d522f475Smrg (Trace-parent.out and Trace-child.out). 573d522f475Smrg 574d522f475Smrg --enable-warnings test: turn on GCC compiler warnings 575d522f475Smrg 576d522f475Smrg Modify the generate Makefile to turn on gcc compiler warnings. 577d522f475Smrg 578d522f475Smrg I use this option regularly, and correct all but a few (difficult) 579d522f475Smrg problems. 580d522f475Smrg 581d522f475Smrg --enable-xmc-glitch test: enable xmc magic-cookie emulation 582d522f475Smrg 583d522f475Smrg Compile-in code that simulates the terminfo "magic cookie" glitch. 584d522f475Smrg 585d522f475Smrg This is for testing ncurses. 586d522f475Smrg 587d522f475Smrg --with-Xaw3d link with Xaw 3d library 588d522f475Smrg 589d522f475Smrg Look for, compile and link with the Xaw 3d widget library. 590d522f475Smrg 59101037d57Smrg --with-Xaw3dxft link with Xaw 3d xft library 59201037d57Smrg 59301037d57Smrg Look for, compile and link with the Xaw 3d xft widget library. 59401037d57Smrg 595d522f475Smrg --with-XawPlus link with Athena-Plus library 596d522f475Smrg 597d522f475Smrg Look for, compile and link with the Xaw Plus widget library. 598d522f475Smrg 599e39b573cSmrg --with-app-class=XXX X resource class (default: XTerm) 600e39b573cSmrg 601e39b573cSmrg Rename the X resource class, e.g., for packaging a development version 602e39b573cSmrg of xterm with different result names. 603e39b573cSmrg 604d522f475Smrg --with-app-defaults=DIR directory in which to install resource files (default: EPREFIX/lib/X11/app-defaults) 605d522f475Smrg 606d522f475Smrg autoconf scripts assume that all of the files should be installed 607d522f475Smrg under the same top-level directory. But X applications defaults 608d522f475Smrg must be installed into a special directory, e.g., 609d522f475Smrg 610d522f475Smrg /usr/X11/lib/app-defaults 611d522f475Smrg 612d522f475Smrg However, there is no standard for this pathname. The manual page 613d522f475Smrg for X notes that the environment variable $XUSERFILESEARCHPATH can 614d522f475Smrg specify a list of places where X searches for applications defaults. 615d522f475Smrg Also, it may look in $XAPPLRESDIR, but that usually is not related 616d522f475Smrg to where xterm might be installed. To keep it simple, the configure 617d522f475Smrg script uses 618d522f475Smrg 619d522f475Smrg EPREFIX/lib/X11/app-defaults 620d522f475Smrg 621d522f475Smrg as the default (EPREFIX is --prefix). That makes it work normally 622d522f475Smrg for most systems if --prefix is /usr. For other installs, e.g., to 623d522f475Smrg /usr/local, you should use this option to customize the location to 624d522f475Smrg match your system configuration. 625d522f475Smrg 6260bd37d32Smrg Use --with-app-defaults=auto to ask the configure script to look in 6270bd37d32Smrg a list of well-known locations for an existing directory. 6280bd37d32Smrg 629d522f475Smrg Use --without-app-defaults or --with-app-defaults=no to disable the 630d522f475Smrg feature. 631d522f475Smrg 6320bd37d32Smrg --with-dmalloc test: use Gray Watson's dmalloc library 6330bd37d32Smrg 6340bd37d32Smrg Check for and link with dmalloc. 6350bd37d32Smrg 6360bd37d32Smrg --with-dbmalloc test: use Conor Cahill's dbmalloc library 6370bd37d32Smrg 6380bd37d32Smrg Check for and link with dbmalloc. 6390bd37d32Smrg 640f2e35a3aSmrg --with-desktop-category=XXX one or more desktop categories or auto 641e39b573cSmrg This is a list of names. The configure script maps blanks and commas 642f2e35a3aSmrg to semicolons (";") which are used by the desktop utilities as a 643f2e35a3aSmrg separator. 644e39b573cSmrg 645e39b573cSmrg The default value "auto" tells the configure script to look 646e39b573cSmrg at existing ".desktop" files for xterm and common terminal 6470bd37d32Smrg emulators, to use those. If none are found, the script uses this 6480bd37d32Smrg default: 649913cc679Smrg System;TerminalEmulator; 6500bd37d32Smrg 6510bd37d32Smrg --with-freetype-config configure script to use for FreeType 6520bd37d32Smrg 653f2e35a3aSmrg Use a specific option value to tell the configure script to try 6540bd37d32Smrg just one of the variations: 6550bd37d32Smrg 6560bd37d32Smrg "pkg*", e.g., pkg-config or pkgconfig uses whatever pkg-config 65701037d57Smrg script was found. 6580bd37d32Smrg 6590bd37d32Smrg otherwise, the parameter value is used as the name of the script 6600bd37d32Smrg to try, using --cflags and --libs options. 6610bd37d32Smrg 6620bd37d32Smrg Use --without-freetype-config to enable the --with-freetype-cflags 6630bd37d32Smrg and --with-freetype-libs options. 6640bd37d32Smrg 6650bd37d32Smrg The default value "auto" tells the configure script to try the 6660bd37d32Smrg pkg-config script first, then freetype-config and finally xft-config. 667e39b573cSmrg 668d522f475Smrg --with-freetype-cflags -D/-I options for compiling with FreeType library 669d522f475Smrg 670d522f475Smrg Override options provided by xft-config or freetype-config. 671d522f475Smrg 672d522f475Smrg --with-freetype-libs -L/-l options for linking with FreeType library 673d522f475Smrg 674d522f475Smrg Override options provided by xft-config or freetype-config. 675d522f475Smrg 6760bd37d32Smrg --with-icon-name=NAME override icon name (default: xterm-color) 6770bd37d32Smrg 6780bd37d32Smrg xterm comes with a choice of icons: 6790bd37d32Smrg 6800bd37d32Smrg xterm-color: depicts a conventional terminal image, and is the default 6810bd37d32Smrg icon used for icon-themes. 6820bd37d32Smrg 6830bd37d32Smrg mini.xterm: a more iconic choice which is readily identifiable at 6840bd37d32Smrg small sizes. This is used for window decoration, e.g., the 6850bd37d32Smrg icon at the upper left corner in many window managers. 6860bd37d32Smrg 6870bd37d32Smrg --with-icon-symlink=NAME create symbolic links to icon name (default: NONE) 6880bd37d32Smrg 6890bd37d32Smrg This is a workaround for certain systems which translate icon names 6900bd37d32Smrg containing "xterm", e.g., "xterm-color" into the single icon "xterm". 6910bd37d32Smrg The option should also be harmless on a properly configured system. 6920bd37d32Smrg 6930bd37d32Smrg If the option is used, its default value is "xterm". For each icon, 6940bd37d32Smrg the makefile will strip the suffix (e.g., ".png"), as well as the part 6950bd37d32Smrg of the filename which denotes the size (e.g., "_32x32" in an xpm file), 6960bd37d32Smrg and constructs a link with that name to the icon. 6970bd37d32Smrg 6980bd37d32Smrg If the option is unused, its default value is "NONE" (no link is made). 6990bd37d32Smrg 7000bd37d32Smrg --with-icondir=DIR directory in which to install icon files (default: no) 701d522f475Smrg 702d522f475Smrg The X libraries may automatically search these locations: 703d522f475Smrg 704d522f475Smrg $HOME/.icons 705d522f475Smrg $XDG_DATA_DIRS/icons 706d522f475Smrg /usr/share/pixmaps 707d522f475Smrg 7080bd37d32Smrg Alternatively, the last may be actually 7090bd37d32Smrg /usr/X11R6/share/pixmaps 7100bd37d32Smrg 7110bd37d32Smrg Use --with-icondir=auto to tell the configure script to search for 7120bd37d32Smrg an existing directory from its list of well-known system locations. 7130bd37d32Smrg 714d522f475Smrg See also 715d522f475Smrg http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html 7160bd37d32Smrg http://www.freedesktop.org/software/icon-theme/ 7170bd37d32Smrg 7180bd37d32Smrg By default, the option is disabled; it is useful only for the 7190bd37d32Smrg --with-icon-theme option. 7200bd37d32Smrg 7210bd37d32Smrg --with-icon-theme=XXX install icons into desktop theme (hicolor) 722d522f475Smrg 7230bd37d32Smrg Install png and svg icons into the given desktop theme and customize 7240bd37d32Smrg the .desktop files to use that theme. If no theme name is given, 7250bd37d32Smrg the default is "hicolor". If this option is not given, the desktop 7260bd37d32Smrg file will use the pixmap files. 727d522f475Smrg 72801037d57Smrg --with-man2html[=XXX] use XXX rather than groff 72901037d57Smrg 73001037d57Smrg Specify an alternative program to use for converting manpages and 731f2e35a3aSmrg control sequences document to html. The default value for the option 732f2e35a3aSmrg is "man2html". If the "man2html" script is not found, then "groff" is 733f2e35a3aSmrg used with groff's special options. 734f2e35a3aSmrg 735f2e35a3aSmrg The "man2html" script reads formatted nroff output from its standard 736f2e35a3aSmrg input, and writes html to its standard output. Other input/output 737f2e35a3aSmrg conventions are not currently supported. 73801037d57Smrg 73901037d57Smrg See 74001037d57Smrg http://invisible-island.net/scripts 741f2e35a3aSmrg http://invisible-island.net/scripts/man2html.html 742f2e35a3aSmrg 74301037d57Smrg for an up-to-date version of "man2html". 74401037d57Smrg 745d522f475Smrg --with-neXtaw link with neXT Athena library 746d522f475Smrg 747d522f475Smrg Look for, compile and link with the neXT Athena widget library. 748d522f475Smrg 749d522f475Smrg --with-own-terminfo=P set default $TERMINFO (default: from environment) 750d522f475Smrg 751d522f475Smrg Modify the generated Makefile to set the target for the 'install-ti' 752d522f475Smrg rule to point to the given directory. 753d522f475Smrg 754d522f475Smrg If you have the $TERMINFO variable defined in your environment, the 755f2e35a3aSmrg configure script may use that value, if it matches an existing 756f2e35a3aSmrg directory. If no option and no variable are are given, the configure 757f2e35a3aSmrg script uses /usr/lib/terminfo, if it exists. 758d522f475Smrg 759d522f475Smrg You do not have to run "make install-ti", if there is already a 760d522f475Smrg workable terminfo description. Be advised, however, that the 761d522f475Smrg common variety of "xterm-color" is not suited for xterm, but is 762d522f475Smrg directed to other variations (such as nxterm) which do not 763d522f475Smrg support the background-color erase capability. 764d522f475Smrg 765f2e35a3aSmrg --with-pixmapdir=DIR directory in which to install pixmaps (DATADIR/pixmaps) 766f2e35a3aSmrg 767f2e35a3aSmrg Specify directory in which to install ".xpm" files. 768f2e35a3aSmrg 769d522f475Smrg --with-pcre use PCRE for regular-expressions 770d522f475Smrg 771f2e35a3aSmrg If regular expressions are not disabled (--disable-regex), use PCRE 772f2e35a3aSmrg rather than the POSIX regular expressions. 773f2e35a3aSmrg 774f2e35a3aSmrg --with-pcre2 use PCRE2 for regular-expressions 775f2e35a3aSmrg 776f2e35a3aSmrg If regular expressions are not disabled (--disable-regex), use PCRE2 777d522f475Smrg rather than the POSIX regular expressions. 778d522f475Smrg 77920d2c4d2Smrg --with-pkg-config{=path} enable/disable use of pkg-config 78020d2c4d2Smrg 78120d2c4d2Smrg The configure script looks for certain libraries which have well 78220d2c4d2Smrg established pkg-config scripts, and will use those settings if 78320d2c4d2Smrg available. Not all pkg-config scripts work; this option suppresses 78420d2c4d2Smrg the check and relies on normal library search paths. 78520d2c4d2Smrg 786d522f475Smrg --with-reference=XXX program to use as permissions-reference 787d522f475Smrg 788d522f475Smrg To install xterm with setuid permissions, the scripts usually compare 789d522f475Smrg it with a previous install. That works well for individual 790d522f475Smrg maintainers, but can be a problem for packagers who may be 791d522f475Smrg cross-compiling, etc. This option lets the package builder specify 792d522f475Smrg the file used for permissions reference. 793d522f475Smrg 794d522f475Smrg --with-setuid=XXX use the given setuid user 795d522f475Smrg 796d522f475Smrg Install xterm setuid'd to the given user. If no parameter value 797d522f475Smrg is given, assume it is root. 798d522f475Smrg 799d522f475Smrg See also --with-utmp-setgid and --with-utempter, which manipulate 800d522f475Smrg the setgid group. 801d522f475Smrg 802d522f475Smrg --with-tty-group=XXX use XXX for the tty-group 803d522f475Smrg 804d522f475Smrg If xterm is installed setuid'd to root, change the group of the tty 805d522f475Smrg device to the given value on startup. Three cases are possible: 80601037d57Smrg 807d522f475Smrg a) If this option is not given, the configure script will attempt to 808d522f475Smrg find a suitable value (usually "tty"), and verify that it exists in 809d522f475Smrg the group database. 810d522f475Smrg 811d522f475Smrg b) If the option value is given, it will use the value even if it does 812d522f475Smrg not exist in the group database (allowing packagers to work about 813d522f475Smrg deficient environments). 814d522f475Smrg 815d522f475Smrg c) If the option is disabled, e.g., --without-tty-group, the 816d522f475Smrg permissions change will use the group-id of the process. 817d522f475Smrg 818d522f475Smrg If xterm is not installed setuid'd to root, this option is not needed, 819d522f475Smrg since it cannot change the tty device's ownership. 820d522f475Smrg 8210bd37d32Smrg --with-valgrind test: use valgrind 8220bd37d32Smrg 8230bd37d32Smrg Activate the --disable-leaks option, and ensure that "-g" is added to 8240bd37d32Smrg CFLAGS. 8250bd37d32Smrg 8262e4f8982Smrg --without-xinerama do not use Xinerama extension for multiple screens 8272e4f8982Smrg 8282e4f8982Smrg Xinerama is an X server extension that allows multiple physical 8292e4f8982Smrg screens to behave as a single screen. If you do not need the feature 8302e4f8982Smrg (or do not want the extra library dependency), use this option to 8312e4f8982Smrg suppress it. 8322e4f8982Smrg 8330bd37d32Smrg --with-xpm=DIR use Xpm library for colored icon, may specify path 8340bd37d32Smrg 835f2e35a3aSmrg Use Xpm library to show colored icon in window decoration, e.g., 8360bd37d32Smrg title area. 8370bd37d32Smrg 8380bd37d32Smrg Use --without-xpm to suppress this feature. 8390bd37d32Smrg 840d522f475Smrg --with-xterm-symlink=XXX make symbolic link to installed xterm 841d522f475Smrg 842d522f475Smrg If any of the configure options to modify the program name i.e., 843d522f475Smrg --program-prefix, --program-suffix or --program-transform-name 844d522f475Smrg are given, this option allows the makefile to create a symbolic link, 845d522f475Smrg e.g., to "xterm" on install. The option value gives the name for 846d522f475Smrg the link, which defaults to "xterm". 847d522f475Smrg 848d522f475Smrg Use --without-xterm-symlink to disable a link to "xterm" if none 849d522f475Smrg is wanted. 850d522f475Smrg 85101037d57Smrg Corresponding links are also made for "resize", "uxterm" and 85201037d57Smrg "koi8rxterm", as well as the xterm manpage. 85301037d57Smrg 854d522f475Smrg --with-terminal-id[=V] set default decTerminalID (default: vt100) 855d522f475Smrg 856d522f475Smrg Set the default emulation level. 857d522f475Smrg 858d522f475Smrg DEC terminals vt52/vt100/vt220/etc form a series where succeeding 859d522f475Smrg models emulate features of the older terminals. While most 860d522f475Smrg features of these terminals are recognized by xterm at all levels, 861d522f475Smrg a few behave differently according to the emulation level. 862d522f475Smrg 863d522f475Smrg You can always override this with the command-line option "-ti". 864d522f475Smrg 865d522f475Smrg --with-terminal-type=T set default $TERM (default: xterm) 866d522f475Smrg 867d522f475Smrg Set the default value for $TERM. Xterm supports legacy termcap 868d522f475Smrg applications by constructing a modified version of the $TERMCAP 869d522f475Smrg variable at initialization, which supplies the resulting screen 870d522f475Smrg size. It also sets $TERM, if not already set, for use by programs 871d522f475Smrg running within xterm. 872d522f475Smrg 873d522f475Smrg The default value "xterm", can be overridden to avoid conflict 874d522f475Smrg with older versions of xterm, e.g., those that do not implement 875d522f475Smrg vt220 emulation. 876d522f475Smrg 877d522f475Smrg You can always override this with the command-line option "-tn". 878d522f475Smrg 879d522f475Smrg --with-utempter use utempter library for access to utmp 880d522f475Smrg 881d522f475Smrg The utempter library is a set-uid wrapper for the utmp facility. 882d522f475Smrg On systems with Unix98 pty's, xterm can use this library when 883d522f475Smrg available so it need not be installed set-uid. 884d522f475Smrg 885d522f475Smrg --with-utmp-setgid=XXX use setgid for access to utmp 886d522f475Smrg 887d522f475Smrg The option value specifies a group to use when installing. 888d522f475Smrg xterm will be installed with setgid privilege to this group. 889d522f475Smrg At runtime, xterm will drop the setuid privilege immediately 890d522f475Smrg after opening the pseudo-terminal, and will have only the 891d522f475Smrg group privilege needed to access the utmp file. This relies 892d522f475Smrg on having POSIX setuid behavior. 893d522f475Smrg 894d522f475Smrg-- vile:txtmode 895