a329b7835381438d36200cc747f83a45a7806ef4
[ncurses.git] / INSTALL
1 -------------------------------------------------------------------------------
2 -- Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.               --
3 --                                                                           --
4 -- Permission is hereby granted, free of charge, to any person obtaining a   --
5 -- copy of this software and associated documentation files (the             --
6 -- "Software"), to deal in the Software without restriction, including       --
7 -- without limitation the rights to use, copy, modify, merge, publish,       --
8 -- distribute, distribute with modifications, sublicense, and/or sell copies --
9 -- of the Software, and to permit persons to whom the Software is furnished  --
10 -- to do so, subject to the following conditions:                            --
11 --                                                                           --
12 -- The above copyright notice and this permission notice shall be included   --
13 -- in all copies or substantial portions of the Software.                    --
14 --                                                                           --
15 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
16 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
17 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
18 -- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
19 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
20 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
21 -- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
22 --                                                                           --
23 -- Except as contained in this notice, the name(s) of the above copyright    --
24 -- holders shall not be used in advertising or otherwise to promote the      --
25 -- sale, use or other dealings in this Software without prior written        --
26 -- authorization.                                                            --
27 -------------------------------------------------------------------------------
28 -- $Id: INSTALL,v 1.116 2007/02/17 21:53:16 tom Exp $
29 ---------------------------------------------------------------------
30              How to install Ncurses/Terminfo on your system
31 ---------------------------------------------------------------------
32
33     ************************************************************
34     * READ ALL OF THIS FILE BEFORE YOU TRY TO INSTALL NCURSES. *
35     ************************************************************
36
37 You should be reading the file INSTALL in a directory called ncurses-d.d, where
38 d.d is the current version number.  There should be several subdirectories,
39 including `c++', `form', `man', `menu', 'misc', `ncurses', `panel', `progs',
40 and `test'.  See the README file for a roadmap to the package.
41
42 If you are a Linux or FreeBSD or NetBSD distribution integrator or packager,
43 please read and act on the section titled IF YOU ARE A SYSTEM INTEGRATOR
44 below.
45
46 If you are converting from BSD curses and do not have root access, be sure
47 to read the BSD CONVERSION NOTES section below.
48
49 If you are trying to build applications using gpm with ncurses,
50 read the USING NCURSES WITH GPM section below.
51
52 If you are running over the Andrew File System see the note below on
53 USING NCURSES WITH AFS.
54
55 If you are cross-compiling, see the note below on BUILDING NCURSES WITH A
56 CROSS-COMPILER.
57
58 If you want to build the Ada95 binding, go to the Ada95 directory and
59 follow the instructions there.  The Ada95 binding is not covered below.
60
61 If you are using anything but (a) Linux, or (b) one of the 4.4BSD-based
62 i386 Unixes, go read the Portability section in the TO-DO file before you
63 do anything else.
64
65
66 REQUIREMENTS:
67 ------------
68
69 You will need the following to build and install ncurses under UNIX:
70
71         * ANSI C compiler  (gcc, for instance)
72         * sh               (bash will do)
73         * awk              (mawk or gawk will do)
74         * sed
75         * BSD or System V style install (a script is enclosed)
76
77 Ncurses has been also built in the OS/2 EMX environment.
78
79
80 INSTALLATION PROCEDURE:
81 ----------------------
82
83 1.  First, decide whether you want ncurses to replace your existing library (in
84     which case you'll need super-user privileges) or be installed in parallel
85     with it.
86
87     The --prefix option to configure changes the root directory for installing
88     ncurses.  The default is normally in subdirectories of /usr/local, except
89     for systems where ncurses is normally installed as a system library, e.g.,
90     Linux, the various BSD systems and Cygwin.  Use --prefix=/usr to replace
91     your default curses distribution.
92
93     The package gets installed beneath the --prefix directory as follows:
94
95     In $(prefix)/bin:          tic, infocmp, captoinfo, tset,
96                                 reset, clear, tput, toe
97     In $(prefix)/lib:          libncurses*.* libcurses.a
98     In $(prefix)/share/terminfo: compiled terminal descriptions
99     In $(prefix)/include:      C header files
100     Under $(prefix)/man:       the manual pages
101
102     Note that the configure script attempts to locate previous installation of
103     ncurses, and will set the default prefix according to where it finds the
104     ncurses headers.
105
106     Do not use commands such as
107
108         make install prefix=XXX
109
110     to change the prefix after configuration, since the prefix value is used
111     for some absolute pathnames such as TERMINFO.  Instead do this
112
113         make install DESTDIR=XXX
114
115     See also the discussion of --with-install-prefix.
116
117 2.  Type `./configure' in the top-level directory of the distribution to
118     configure ncurses for your operating system and create the Makefiles.
119     Besides --prefix, various configuration options are available to customize
120     the installation; use `./configure --help' to list the available options.
121
122     If your operating system is not supported, read the PORTABILITY section in
123     the file ncurses/README for information on how to create a configuration
124     file for your system.
125
126     The `configure' script generates makefile rules for one or more object
127     models and their associated libraries:
128
129         libncurses.a (normal)
130
131         libcurses.a (normal, a link to libncurses.a)
132                 This gets left out if you configure with --disable-overwrite.
133
134         libncurses.so (shared)
135
136         libncurses_g.a (debug)
137
138         libncurses_p.a (profile)
139
140         libncurses.la (libtool)
141
142     If you configure using the --enable-widec option, a "w" is appended to the
143     library names (e.g., libncursesw.a), and the resulting libraries support
144     wide-characters, e.g., via a UTF-8 locale.  The corresponding header files
145     are compatible with the non-wide-character configuration; wide-character
146     features are provided by ifdef's in the header files.  The wide-character
147     library interfaces are not binary-compatible with the non-wide-character
148     version.  Building and running the wide-character code relies on a fairly
149     recent implementation of libiconv.  We have built this configuration on
150     Linux using libiconv, sometimes requiring libutf8.
151
152     If you do not specify any models, the normal and debug libraries will be
153     configured.  Typing `configure' with no arguments is equivalent to:
154
155         ./configure --with-normal --with-debug --enable-overwrite
156
157     Typing
158
159         ./configure --with-shared
160
161     makes the shared libraries the default, resulting in
162
163         ./configure --with-shared --with-normal --with-debug --enable-overwrite
164
165     If you want only shared libraries, type
166
167         ./configure --with-shared --without-normal --without-debug
168
169     Rules for generating shared libraries are highly dependent upon the choice
170     of host system and compiler.  We've been testing shared libraries on Linux
171     and SunOS with gcc, but more work needs to be done to make shared libraries
172     work on other systems.
173
174     If you have libtool installed, you can type
175
176         ./configure --with-libtool
177
178     to generate the appropriate static and/or shared libraries for your
179     platform using libtool.
180
181     You can make curses and terminfo fall back to an existing file of termcap
182     definitions by configuring with --enable-termcap.  If you do this, the
183     library will search /etc/termcap before the terminfo database, and will
184     also interpret the contents of the TERM environment variable.  See the
185     section BSD CONVERSION NOTES below.
186
187 3.  Type `make'.  Ignore any warnings, no error messages should be produced.
188     This should compile the ncurses library, the terminfo compiler tic(1),
189     captoinfo(1), infocmp(1), toe(1), clear(1) tset(1), reset(1), and tput(1)
190     programs (see the manual pages for explanation of what they do), some test
191     programs, and the panels, menus, and forms libraries.
192
193 4.  Run ncurses and several other test programs in the test directory to
194     verify that ncurses functions correctly before doing an install that
195     may overwrite system files.  Read the file test/README for details on
196     the test programs.
197
198     NOTE: You must have installed the terminfo database, or set the
199     environment variable $TERMINFO to point to a SVr4-compatible terminfo
200     database before running the test programs.  Not all vendors' terminfo
201     databases are SVr4-compatible, but most seem to be.  Exceptions include
202     DEC's Digital Unix (formerly known as OSF/1).
203
204     If you run the test programs WITHOUT installing terminfo, ncurses may
205     read the termcap file and cache that in $HOME/.terminfo, which will
206     thereafter be used instead of the terminfo database.  See the comments
207     on "--enable-getcap-cache", to see why this is a Bad Thing.
208
209     It is possible to configure ncurses to use other terminfo database formats.
210     A few are provided as examples in the include-directory (see --with-caps).
211
212     The ncurses program is designed specifically to test the ncurses library.
213     You can use it to verify that the screen highlights work correctly, that
214     cursor addressing and window scrolling works OK, etc.
215
216 5.  Once you've tested, you can type `make install' to install libraries,
217     the programs, the terminfo database and the manual pages.  Alternately, you
218     can type `make install' in each directory you want to install.  In the
219     top-level directory, you can do a partial install using these commands:
220
221         'make install.progs'    installs tic, infocmp, etc...
222         'make install.includes' installs the headers.
223         'make install.libs'     installs the libraries (and the headers).
224         'make install.data'     installs the terminfo data. (Note: `tic' must
225                                 be installed before the terminfo data can be
226                                 compiled).
227         'make install.man'      installs the manual pages.
228
229   ############################################################################
230   #     CAVEAT EMPTOR: `install.data' run as root will NUKE any existing     #
231   #  terminfo database. If you have any custom or unusual entries SAVE them  #
232   #  before you install ncurses.  I have a file called terminfo.custom for   #
233   #  this purpose.  Don't forget to run tic on the file once you're done.    #
234   ############################################################################
235
236     The terminfo(5) manual page must be preprocessed with tbl(1) before
237     being formatted by nroff(1).  Modern man(1) implementations tend to do
238     this by default, but you may want to look at your version's manual page
239     to be sure.  You may also install the manual pages after preprocessing
240     with tbl(1) by specifying the configure option --with-manpage-tbl.
241
242     If the system already has a curses library that you need to keep using
243     you'll need to distinguish between it and ncurses.  See the discussion of
244     --disable-overwrite.  If ncurses is installed outside the standard
245     directories (/usr/include and /usr/lib) then all your users will need to
246     use the -I option to compile programs and -L to link them.
247
248     If you have another curses installed in your system and you accidentally
249     compile using its curses.h you'll end up with a large number of
250     undefined symbols at link time.
251
252     IF YOU DO NOT HAVE ROOT: Change directory to the `progs' subdirectory
253     and run the `capconvert' script.  This script will deduce various things
254     about your environment and use them to build you a private terminfo tree,
255     so you can use ncurses applications.
256
257     If more than one user at your site does this, the space for the duplicate
258     trees is wasted.  Try to get your site administrators to install a system-
259     wide terminfo tree instead.
260
261     See the BSD CONVERSION NOTES section below for a few more details.
262
263 6.  The c++ directory has C++ classes that are built on top of ncurses and
264     panels.  You must have c++ (and its libraries) installed before you can
265     compile and run the demo.
266
267     Use --without-cxx-binding to tell configure to not build the C++ bindings
268     and demo.
269
270     If you do not have C++, you must use the --without-cxx option to tell
271     the configure script to not attempt to determine the type of 'bool'
272     which may be supported by C++.  IF YOU USE THIS OPTION, BE ADVISED THAT
273     YOU MAY NOT BE ABLE TO COMPILE (OR RUN) NCURSES APPLICATIONS WITH C++.
274
275
276 SUMMARY OF CONFIGURE OPTIONS:
277 ----------------------------
278
279     The configure script provides a short list of its options when you type
280
281         ./configure --help
282
283     The --help and several options are common to all configure scripts that are
284     generated with autoconf.  Those are all listed before the line
285
286         --enable and --with options recognized:
287
288     The other options are specific to this package.  We list them in alphabetic
289     order.
290
291     --disable-assumed-color
292         With ncurses 5.1, we introduced a new function, assume_default_colors()
293         which allows applications to specify what the default foreground and
294         background color are assumed to be.  Most color applications use
295         full-screen color; but a few do not color the background.  While the
296         assumed values can be overridden by invoking assume_default_colors(),
297         you may find it useful to set the assumed values to the pre-5.1
298         convention, using this configure option.
299
300     --disable-big-core
301         Assume machine has little memory.  The configure script attempts to
302         determine if your machine has enough memory (about 6Mb) to compile the
303         terminfo database without writing portions to disk.  Some allocators
304         return deceptive results, so you may have to override the configure
305         script.  Or you may be building tic for a smaller machine.
306
307     --disable-database
308         Use only built-in data.  The ncurses libraries normally read terminfo
309         and termcap data from disk.  You can configure ncurses to have a
310         built-in database, aka "fallback" entries.  Embedded applications may
311         have no need for an external database.  Some, but not all of the
312         programs are useful in this configuration, e.g., reset and tput versus
313         infocmp and tic.
314
315     --disable-ext-funcs
316         Disable function-extensions.  Configure ncurses without the functions
317         that are not specified by XSI.  See ncurses/modules for the exact
318         list of library modules that would be suppressed.
319
320     --disable-hashmap
321         Compile without hashmap scrolling-optimization code.  This algorithm is
322         the default.
323
324     --disable-home-terminfo
325         The $HOME/.terminfo directory is normally added to ncurses' search
326         list for reading/writing terminfo entries, since that directory is
327         more likely writable than the system terminfo database.  Use this
328         option to disable the feature altogether.
329
330     --disable-largefile
331         Disable compiler flags needed to use large-file interfaces.
332
333     --disable-leaks
334         For testing, compile-in code that frees memory that normally would not
335         be freed, to simplify analysis of memory-leaks.
336
337     --disable-lp64
338         The header files will ignore use of the _LP64 symbol to make chtype
339         and mmask_t types 32 bits (they may be long on 64-bit hosts, for
340         compatibility with older releases).
341
342         NOTE: this is potentially an ABI change, depending on existing
343         packages.  The default for this option is "disabled" for ncurses
344         ABI 5, and "enabled" for ABI 6.
345
346     --disable-macros
347         For testing, use functions rather than macros.  The program will run
348         more slowly, but it is simpler to debug.  This defines NCURSES_NOMACROS
349         at build time.  See also the --enable-expanded option.
350
351     --disable-overwrite
352         If you are installing ncurses on a system which contains another
353         development version of curses, or which could be confused by the loader
354         for another version, we recommend that you leave out the link to
355         -lcurses.  The ncurses library is always available as -lncurses.
356         Disabling overwrite also causes the ncurses header files to be
357         installed into a subdirectory, e.g., /usr/local/include/ncurses,
358         rather than the include directory.  This makes it simpler to avoid
359         compile-time conflicts with other versions of curses.h
360
361     --disable-relink
362         If --enable-rpath is given, the generated makefiles normally will
363         rebuild the libraries during install.  Use this option to simply
364         copy whatever the linked produced.
365
366         This option is ignored if --enable-rpath is not given.
367
368     --disable-root-environ
369         Compile with environment restriction, so certain environment variables
370         are not available when running as root, or via a setuid/setgid
371         application.  These are (for example $TERMINFO) those that allow the
372         search path for the terminfo or termcap entry to be customized.
373
374     --disable-scroll-hints
375         Compile without scroll-hints code.  This option is ignored when
376         hashmap scrolling is configured, which is the default.
377
378     --disable-tparm-varargs
379         Portable programs should call tparm() using the fixed-length parameter
380         list documented in X/Open.  ncurses provides varargs support for this
381         function.  Use --disable-tparm-varargs to disable this support.
382
383     --enable-assertions
384         For testing, compile-in assertion code.  This is used only for a few
385         places where ncurses cannot easily recover by returning an error code.
386
387     --enable-broken_linker
388         A few platforms have what we consider a broken linker:  it cannot link
389         objects from an archive solely by referring to data objects in those
390         files, but requires a function reference.  This configure option
391         changes several data references to functions to work around this
392         problem.
393
394         NOTE:  With ncurses 5.1, this may not be necessary, since we are
395         told that some linkers interpret uninitialized global data as a
396         different type of reference which behaves as described above.  We have
397         explicitly initialized all of the global data to work around the
398         problem.
399
400     --enable-bsdpad
401         Recognize BSD-style prefix padding.  Some ancient BSD programs (such as
402         nethack) call tputs("50") to implement delays.
403
404     --enable-colorfgbg
405         Compile with experimental $COLORFGBG code.  That environment variable
406         is set by some terminal emulators as a hint to applications, by
407         advertising the default foreground and background colors.  During
408         initialization, ncurses sets color pair 0 to match this.
409
410     --enable-const
411         The curses interface as documented in XSI is rather old, in fact
412         including features that precede ANSI C.  The prototypes generally do
413         not make effective use of "const".  When using stricter compilers (or
414         gcc with appropriate warnings), you may see warnings about the mismatch
415         between const and non-const data.  We provide a configure option which
416         changes the interfaces to use const - quieting these warnings and
417         reflecting the actual use of the parameters more closely.  The ncurses
418         library uses the symbol NCURSES_CONST for these instances of const,
419         and if you have asked for compiler warnings, will add gcc's const-qual
420         warning.  There will still be warnings due to subtle inconsistencies
421         in the interface, but at a lower level.
422
423         NOTE:  configuring ncurses with this option may detract from the
424         portability of your applications by encouraging you to use const in
425         places where the XSI curses interface would not allow them.  Similar
426         issues arise when porting to SVr4 curses, which uses const in even
427         fewer places.
428
429     --enable-echo
430         Use the option --disable-echo to make the build-log less verbose by
431         suppressing the display of the compile and link commands.  This makes
432         it easier to see the compiler warnings.  (You can always use "make -n"
433         to see the options that are used).
434
435     --enable-expanded
436         For testing, generate functions for certain macros to make them visible
437         as such to the debugger.  See also the --disable-macros option.
438
439     --enable-ext-colors
440         Extend the cchar_t structure to allow more than 16 colors to be
441         encoded.  This applies only to the wide-character (--enable-widec)
442         configuration.
443
444         NOTE:  using this option will make libraries which are not binary-
445         compatible with libncursesw 5.4.  None of the interfaces change, but
446         applications which have an array of cchar_t's must be recompiled.
447
448     --enable-ext-mouse
449         Modify the encoding of mouse state to make room for a 5th mouse button.
450         That allows one to use ncurses with a wheel mouse with xterm or
451         similar X terminal emulators.
452
453         NOTE:  using this option will make libraries which are not binary-
454         compatible with libncursesw 5.4.  None of the interfaces change, but
455         applications which have mouse mask mmask_t's must be recompiled.
456
457     --enable-getcap
458         Use the 4.4BSD getcap code if available, or a bundled version of it to
459         fetch termcap entries.  Entries read in this way cannot use (make
460         cross-references to) the terminfo tree, but it is faster than reading
461         /etc/termcap.
462
463         If configured for one of the *BSD systems, this automatically uses
464         the hashed database system produced using cap_mkdb or similar tools.
465         In that case, there is no advantage in using the --enable-getcap-cache
466         option.
467
468         See also the --with-hashed-db option.
469
470     --enable-getcap-cache
471         Cache translated termcaps under the directory $HOME/.terminfo
472
473         NOTE:  this sounds good - it makes ncurses run faster the second time.
474         But look where the data comes from - an /etc/termcap containing lots of
475         entries that are not up to date.  If you configure with this option and
476         forget to install the terminfo database before running an ncurses
477         application, you will end up with a hidden terminfo database that
478         generally does not support color and will miss some function keys.
479
480     --enable-hard-tabs
481         Compile-in cursor-optimization code that uses hard-tabs.  We would make
482         this a standard feature except for the concern that the terminfo entry
483         may not be accurate, or that your stty settings have disabled the use
484         of tabs.
485
486     --enable-no-padding
487         Compile-in support for the $NCURSES_NO_PADDING environment variable,
488         which allows you to suppress the effect of non-mandatory padding in
489         terminfo entries.  This is the default, unless you have disabled the
490         extended functions.
491
492     --enable-rpath
493         Use rpath option when generating shared libraries, and (with some
494         restrictions) when linking the corresponding programs.  This originally
495         (in 1997) applied mainly to systems using the GNU linker (read the
496         manpage).
497
498         More recently it is useful for systems that require special treatment
499         shared libraries in "unusual" locations.  The "system" libraries reside
500         in directories which are on the loader's default search-path.  While
501         you may be able to use workarounds such as the $LD_LIBRARY_PATH
502         environment variable, they do not work with setuid applications since
503         the LD_LIBRARY_PATH variable would be unset in that situation.
504
505         This option does not apply to --with-libtool, since libtool makes
506         extra assumptions about rpath.
507
508     --enable-safe-sprintf
509         Compile with experimental safe-sprintf code.  You may consider using
510         this if you are building ncurses for a system that has neither
511         vsnprintf() or vsprintf().  It is slow, however.
512
513     --enable-sigwinch
514         Compile support for ncurses' SIGWINCH handler.  If your application has
515         its own SIGWINCH handler, ncurses will not use its own.  The ncurses
516         handler causes wgetch() to return KEY_RESIZE when the screen-size
517         changes.  This option is the default, unless you have disabled the
518         extended functions.
519
520     --enable-signed-char
521         The term.h header declares a Booleans[] array typed "char".  But it
522         stores signed values there and "char" is not necessarily signed.
523         Some packagers choose to alter the type of Booleans[] though this
524         is not strictly compatible.  This option allows one to implement this
525         alteration without patching the source code.
526
527     --enable-symlinks
528         If your system supports symbolic links, make tic use symbolic links
529         rather than hard links to save diskspace when writing aliases in the
530         terminfo database.
531
532     --enable-tcap-names
533         Compile-in support for user-definable terminal capabilities.  Use the
534         -x option of tic and infocmp to treat unrecognized terminal
535         capabilities as user-defined strings.  This option is the default,
536         unless you have disabled the extended functions.
537
538     --enable-termcap
539         Compile in support for reading terminal descriptions from termcap if no
540         match is found in the terminfo database.  See also the --enable-getcap
541         and --enable-getcap-cache options.
542
543     --enable-warnings
544         Turn on GCC compiler warnings.  There should be only a few.
545
546     --enable-wgetch-events
547         Compile with experimental wgetch-events code.  See ncurses/README.IZ
548
549     --enable-widec
550         Compile with wide-character code.  This makes a different version of
551         the libraries (e.g., libncursesw.so), which stores characters as
552         wide-characters,
553
554         NOTE: applications compiled with this configuration are not compatible
555         with those built for 8-bit characters.  You cannot simply make a
556         symbolic link to equate libncurses.so with libncursesw.so
557
558         NOTE: the Ada95 binding may be built against either version of the the
559         ncurses library, but you must decide which:  the binding installs the
560         same set of files for either version.  Currently (2002/6/22) it does
561         not use the extended features from the wide-character code, so it is
562         probably better to not install the binding for that configuration.
563
564     --enable-xmc-glitch
565         Compile-in support experimental xmc (magic cookie) code.
566
567     --with-abi-version=NUM
568         Override the ABI version, which is used in shared library filenames.
569         Normally this is the same as the release version; some ports have
570         special requirements for compatibility.
571
572     --with-ada-compiler=CMD
573         Specify the Ada95 compiler command (default "gnatmake")
574
575     --with-ada-include=DIR
576         Tell where to install the Ada includes (default:
577         PREFIX/lib/ada/adainclude)
578
579     --with-ada-objects=DIR
580         Tell where to install the Ada objects (default:  PREFIX/lib/ada/adalib)
581
582     --with-bool=TYPE
583         If --without-cxx is specified, override the type used for the "bool"
584         declared in curses.h (normally the type is automatically chosen to
585         correspond with that in <stdbool.h>, or defaults to platform-specific
586         sizes).
587
588     --with-build-cc=XXX
589         If cross-compiling, specify a host C compiler, which is needed to
590         compile a few utilities which generate source modules for ncurses.
591         If you do not give this option, the configure script checks if the
592         $BUILD_CC variable is set, and otherwise defaults to gcc or cc.
593
594     --with-build-cflags=XXX
595         If cross-compiling, specify the host C compiler-flags.  You might need
596         to do this if the target compiler has unusual flags which confuse the
597         host compiler.
598
599     --with-build-cppflags=XXX
600         If cross-compiling, specify the host C preprocessor-flags.  You might
601         need to do this if the target compiler has unusual flags which confuse
602         the host compiler.
603
604     --with-build-ldflags=XXX
605         If cross-compiling, specify the host linker-flags.  You might need to
606         do this if the target linker has unusual flags which confuse the host
607         compiler.
608
609     --with-build-libs=XXX
610         If cross-compiling, the host libraries.  You might need to do this if
611         the target environment requires unusual libraries.
612
613     --with-caps=XXX
614         Specify an alternate terminfo capabilities file, which makes the
615         configure script look for "include/Caps.XXX".  A few systems, e.g.,
616         AIX 4.x use the same overall file-format as ncurses for terminfo
617         data, but use different alignments within the tables to support
618         legacy applications.  For those systems, you can configure ncurses
619         to use a terminfo database which is compatible with the native
620         applications.
621
622     --with-chtype=TYPE
623         Override type of chtype, which stores the video attributes and (if
624         --enable-widec is not given) a character.  Prior to ncurses 5.5, this
625         was always unsigned long, but with ncurses 5.5, it may be unsigned.
626         Use this option if you need to preserve compatibility with 64-bit
627         executables.
628
629     --with-database=XXX
630         Specify the terminfo source file to install.  Usually you will wish
631         to install ncurses' default (misc/terminfo.src).  Certain systems
632         have special requirements, e.g, OS/2 EMX has a customized terminfo
633         source file.
634
635     --with-dbmalloc
636         For testing, compile and link with Conor Cahill's dbmalloc library.
637         This also sets the --disable-leaks option.
638
639     --with-debug
640         Generate debug-libraries (default).  These are named by adding "_g"
641         to the root, e.g., libncurses_g.a
642
643     --with-default-terminfo-dir=XXX
644         Specify the default terminfo database directory.  This is normally
645         DATADIR/terminfo, e.g., /usr/share/terminfo.
646
647     --with-dmalloc
648         For testing, compile and link with Gray Watson's dmalloc library.
649         This also sets the --disable-leaks option.
650
651     --with-fallbacks=XXX
652         Specify a list of fallback terminal descriptions which will be
653         compiled into the ncurses library.  See CONFIGURING FALLBACK ENTRIES.
654
655     --with-gpm
656         use Alessandro Rubini's GPM library to provide mouse support on the
657         Linux console.  Prior to ncurses 5.5, this introduced a dependency on
658         the GPM library.
659         
660         Currently ncurses uses the dlsym() function to bind to the library at
661         runtime, so it is only necessary that the library be present when
662         ncurses is built, to obtain the filename (or soname) used in the
663         corresponding dlopen() call.  If you give a value for this option,
664         e.g.,
665
666                 --with-gpm=$HOME/tmp/test-gpm.so
667
668         that overrides the configure check for the soname.
669
670         See also --without-dlsym
671
672     --with-hashed-db
673         Use a hashed database for storing terminfo data rather than storing
674         each compiled entry in a separate binary file within a directory
675         tree.
676
677         If you use this option for configuring ncurses, tic will only be able
678         to write entries in the hashed database.  infocmp can still read
679         entries from a directory tree as well as reading entries from the
680         hashed database.  To do this, infocmp determines whether the $TERMINFO
681         variable points to a directory or a file, and reads the directory-tree
682         or hashed database respectively.
683
684         You cannot have a directory containing both hashed-database and
685         filesystem-based terminfo entries.
686
687         See also the --enable-getcap option.
688
689     --with-install-prefix=XXX
690         Allows you to specify an alternate location for installing ncurses
691         after building it.  The value you specify is prepended to the "real"
692         install location.  This simplifies making binary packages.  The
693         makefile variable DESTDIR is set by this option.  It is also possible
694         to use
695                 make install DESTDIR=XXX
696         since the makefiles pass that variable to subordinate makes.
697
698         NOTE:  a few systems build shared libraries with fixed pathnames; this
699         option probably will not work for those configurations.
700
701      --with-libtool[=XXX]
702         Generate libraries with libtool.  If this option is selected, then it
703         overrides all other library model specifications.  Note that libtool
704         must already be installed, uses makefile rules dependent on GNU make,
705         and does not promise to follow the version numbering convention of
706         other shared libraries on your system.  However, if the --with-shared
707         option does not succeed, you may get better results with this option.
708
709         If a parameter value is given, it must be the full pathname of the
710         particular version of libtool, e.g.,
711                 /usr/bin/libtool-1.2.3
712
713         It is possible to rebuild the configure script to use the automake
714         macros for libtool, e.g., AC_PROG_LIBTOOL.  See the comments in
715         aclocal.m4 for CF_PROG_LIBTOOL, and ensure that you build configure
716         using the appropriate patch for autoconf from
717                 http://invisible-island.net/autoconf/
718
719     --with-manpage-aliases
720         Tell the configure script you wish to create entries in the
721         man-directory for aliases to manpages which list them, e.g., the
722         functions in the panel manpage.  This is the default.  You can disable
723         it if your man program does this.  You can also disable
724         --with-manpage-symlinks to install files containing a ".so" command
725         rather than symbolic links.
726
727     --with-manpage-format=XXX
728         Tell the configure script how you would like to install man-pages.  The
729         option value must be one of these:  gzip, compress, BSDI, normal,
730         formatted.  If you do not give this option, the configure script
731         attempts to determine which is the case.
732
733     --with-manpage-renames=XXX
734         Tell the configure script that you wish to rename the manpages while
735         installing.  Currently the only distribution which does this is
736         the Linux Debian.  The option value specifies the name of a file
737         that lists the renamed files, e.g., $srcdir/man/man_db.renames
738
739     --with-manpage-symlinks
740         Tell the configure script that you wish to make symbolic links in the
741         man-directory for aliases to the man-pages.  This is the default, but
742         can be disabled for systems that provide this automatically.  Doing
743         this on systems that do not support symbolic links will result in
744         copying the man-page for each alias.
745
746     --with-manpage-tbl
747         Tell the configure script that you with to preprocess the manpages
748         by running them through tbl to generate tables understandable by
749         nroff.
750
751     --with-mmask-t=TYPE
752         Override type of mmask_t, which stores the mouse mask.  Prior to
753         ncurses 5.5, this was always unsigned long, but with ncurses 5.5, it
754         may be unsigned.  Use this option if you need to preserve compatibility
755         with 64-bit executables.
756
757     --with-ospeed=TYPE
758         Override type of ospeed variable, which is part of the termcap
759         compatibility interface.  In termcap, this is a 'short', which works
760         for a wide range of baudrates because ospeed is not the actual speed
761         but the encoded value, e.g., B9600 would be a small number such as 13.
762         However the encoding scheme originally allowed for values "only" up to
763         38400bd.  A newer set of definitions past 38400bd is not encoded as
764         compactly, and is not guaranteed to fit into a short (see the function
765         cfgetospeed(), which returns a speed_t for this reason).  In practice,
766         applications that required knowledge of the ospeed variable, i.e.,
767         those using termcap, do not use the higher speeds.  Your application
768         (or system, in general) may or may not.
769
770     --with-normal
771         Generate normal (i.e., static) libraries (default).
772
773         Note:  on Linux, the configure script will attempt to use the GPM
774         library via the dlsym() function call.  Use --without-dlsym to disable
775         this feature, or --without-gpm, depending on whether you wish to use
776         GPM.
777
778     --with-profile
779         Generate profile-libraries These are named by adding "_p" to the root,
780         e.g., libncurses_p.a
781
782     --with-rcs-ids
783         Compile-in RCS identifiers.  Most of the C files have an identifier.
784
785     --with-rel-version=NUM
786         Override the release version, which may be used in shared library
787         filenames.  This consists of a major and minor version number separated
788         by ".".  Normally the major version number is the same as the ABI
789         version; some ports have special requirements for compatibility.
790
791     --with-shared
792         Generate shared-libraries.  The names given depend on the system for
793         which you are building, typically using a ".so" suffix, along with
794         symbolic links that refer to the release version.
795
796         NOTE:  Unless you override the configure script by setting the $CFLAGS
797         environment variable, these will not be built with the -g debugging
798         option.
799
800         NOTE: For some configurations, e.g., installing a new version of
801         ncurses shared libraries on a machine which already has ncurses
802         shared libraries, you may encounter problems with the linker.
803         For example, it may prevent you from running  the build tree's
804         copy of tic (for installing the terminfo database) because it
805         loads the system's copy of the ncurses shared libraries.  In that
806         case, using the misc/shlib script may be helpful, since it sets
807         $LD_LIBRARY_PATH to point to the build tree, e.g.,
808                 ./misc/shlib make install       
809
810     --with-shlib-version=XXX
811         Specify whether to use the release or ABI version for shared libraries.
812         This is normally chosen automatically based on the type of system
813         which you are building on.  We use it for testing the configure script.
814
815     --with-sysmouse
816         use FreeBSD sysmouse interface provide mouse support on the console.
817
818     --with-system-type=XXX
819         For testing, override the derived host system-type which is used to
820         decide things such as the linker commands used to build shared
821         libraries.  This is normally chosen automatically based on the type of
822         system which you are building on.  We use it for testing the configure
823         script.
824
825     --with-terminfo-dirs=XXX
826         Specify a search-list of terminfo directories which will be compiled
827         into the ncurses library (default: DATADIR/terminfo)
828
829     --with-termlib[=XXX]
830         When building the ncurses library, organize this as two parts:  the
831         curses library (libncurses) and the low-level terminfo library
832         (libtinfo).  This is done to accommodate applications that use only
833         the latter.  The terminfo library is about half the size of the total.
834
835         If an option value is given, that overrides the name of the terminfo
836         library.  For instance, if the wide-character version is built, the
837         terminfo library would be named libtinfow.  But the libtinfow interface
838         is upward compatible from libtinfo, so it would be possible to overlay
839         libtinfo.so with a "wide" version of libtinfow.so by renaming it with
840         this option.
841
842     --with-termpath=XXX
843         Specify a search-list of termcap files which will be compiled into the
844         ncurses library (default:  /etc/termcap:/usr/share/misc/termcap)
845
846     --with-ticlib[=XXX]
847         When building the ncurses library, build a separate library for
848         the modules that are used only by the utility programs.  Normally
849         those would be bundled with the termlib or ncurses libraries.
850
851         If an option value is given, that overrides the name of the tic
852         library.  As in termlib, there is no ABI difference between the
853         "wide" libticw.so and libtic.so
854
855     --with-trace
856         Configure the trace() function as part of the all models of the ncurses
857         library.  Normally it is part of the debug (libncurses_g) library only.
858
859     --with-valgrind
860         For testing, compile with debug option.
861         This also sets the --disable-leaks option.
862
863     --without-ada
864         Suppress the configure script's check for Ada95, do not build the
865         Ada95 binding and related demo.
866
867     --without-curses-h
868         Don't install the ncurses header with the name "curses.h".  Rather,
869         install as "ncurses.h" and modify the installed headers and manpages
870         accordingly.
871
872     --without-cxx
873         XSI curses declares "bool" as part of the interface.  C++ also declares
874         "bool".  Neither specifies the size and type of booleans, but both
875         insist on the same name.  We chose to accommodate this by making the
876         configure script check for the size and type (e.g., unsigned or signed)
877         that your C++ compiler uses for booleans.  If you do not wish to use
878         ncurses with C++, use this option to tell the configure script to not
879         adjust ncurses bool to match C++.
880
881     --without-cxx-binding
882         Suppress the configure script's check for C++, do not build the
883         C++ binding and related demo.
884
885     --without-develop
886         Disable development options.  This does not include those that change
887         the interface, such as --enable-widec.
888
889     --without-dlsym
890         Do not use dlsym() to load GPM dynamically.
891
892     --without-progs
893         Tell the configure script to suppress the build of ncurses' application
894         programs (e.g., tic).  The test applications will still be built if you
895         type "make", though not if you simply do "make install".
896
897     --without-xterm-new
898         Tell the configure script to use "xterm-old" for the entry used in
899         the terminfo database.  This will work with variations such as
900         X11R5 and X11R6 xterm.
901
902
903 COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
904 --------------------------------------------
905
906     Because ncurses implements the X/Open Curses Specification, its interface
907     is fairly stable.  That does not mean the interface does not change.
908     Changes are made to the documented interfaces when we find differences
909     between ncurses and X/Open or implementations which they certify (such as
910     Solaris).  We add extensions to those interfaces to solve problems not
911     addressed by the original curses design, but those must not conflict with
912     the X/Open documentation.
913
914     Here are some of the major interface changes, and related problems which
915     you may encounter when building a system with different versions of
916     ncurses:
917
918     5.6 (December 17, 2006)
919         Interface changes:
920
921         + generate linkable stubs for some macros:
922
923           getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, getparx,
924           getpary, getpary,
925
926           and (for libncursesw)
927
928           wgetbkgrnd
929
930         Added extensions:
931                 nofilter()
932                 use_legacy_coding()
933
934         Added internal functions:
935                 _nc_first_db
936                 _nc_get_source
937                 _nc_handle_sigwinch
938                 _nc_is_abs_path
939                 _nc_is_dir_path
940                 _nc_is_file_path
941                 _nc_keep_tic_dir
942                 _nc_keep_tic_dir
943                 _nc_last_db
944                 _nc_next_db
945                 _nc_read_termtype
946                 _nc_tic_dir
947
948                 Also (if using the hashed database configuration):
949
950                 _nc_db_close
951                 _nc_db_first
952                 _nc_db_get
953                 _nc_db_have_data
954                 _nc_db_have_index
955                 _nc_db_next
956                 _nc_db_open
957                 _nc_db_put
958
959                 otherwise
960
961                 _nc_hashed_db
962
963         Removed internal functions:
964                 none
965
966         Modified internal functions:
967                 _nc_add_to_try
968                 _nc_do_color
969                 _nc_expand_try
970                 _nc_remove_key
971                 _nc_setupscreen
972
973     5.5 (October 10, 2005)
974         Interface changes:
975
976         + terminfo installs "xterm-new" as "xterm" entry rather than
977           "xterm-old" (aka xterm-r6).
978
979         + terminfo data is installed using the tic -x option (few systems
980           still use ncurses 4.2).
981
982         + modify C++ binding to work with newer C++ compilers by providing
983           initializers and using modern casts.  Old-style header names are
984           still used in this release to allow compiling with not-so-old
985           compilers.
986
987         + form and menu libraries now work with wide-character data. 
988           Applications which bypassed the form library and manipulated the
989           FIELD.buf data directly will not work properly with libformw, since
990           that no longer points to an array of char.  The set_field_buffer()
991           and field_buffer() functions translate to/from the actual field
992           data.
993
994         + change SP->_current_attr to a pointer, adjust ifdef's to ensure that
995           libtinfo.so and libtinfow.so have the same ABI.  The reason for this
996           is that the corresponding data which belongs to the upper-level
997           ncurses library has a different size in each model.
998
999         + winnstr() now returns multibyte character strings for the
1000           wide-character configuration.
1001
1002         + assume_default_colors() no longer requires that use_default_colors()
1003           be called first.
1004
1005         + data_ahead() now works with wide-characters.
1006
1007         + slk_set() and slk_wset() now accept and store multibyte or
1008           multicolumn characters.
1009
1010         + start_color() now returns OK if colors have already been started.
1011           start_color() also returns ERR if it cannot allocate memory.
1012
1013         + pair_content() now returns -1 for consistency with init_pair() if it
1014           corresponds to the default-color.
1015
1016         + unctrl() now returns null if its parameter does not correspond
1017           to an unsigned char.
1018
1019         Added extensions:
1020                 Experimental mouse version 2 supports wheel mice with buttons
1021                 4 and 5.  This requires ABI 6 because it modifies the encoding
1022                 of mouse events.
1023
1024                 Experimental extended colors allows encoding of 256 foreground
1025                 and background colors, e.g., with the xterm-256color or
1026                 xterm-88color terminfo entries.  This requires ABI 6 because
1027                 it changes the size of cchar_t.
1028
1029         Added internal functions:
1030                 _nc_check_termtype2
1031                 _nc_resolve_uses2
1032                 _nc_retrace_cptr
1033                 _nc_retrace_cvoid_ptr
1034                 _nc_retrace_void_ptr
1035                 _nc_setup_term
1036
1037         Removed internal functions:
1038                 none
1039
1040         Modified internal functions:
1041                 _nc_insert_ch
1042                 _nc_save_str
1043                 _nc_trans_string
1044
1045     5.4 (February 8, 2004)
1046         Interface changes:
1047
1048         + add the remaining functions for X/Open curses wide-character support.
1049           These are only available if the library is configured using the
1050           --enable-widec option.
1051                 pecho_wchar()
1052                 slk_wset()
1053
1054         + write getyx() and related 2-return macros in terms of getcury(),
1055           getcurx(), etc.
1056
1057         + simplify ifdef for bool declaration in curses.h
1058
1059         + modify ifdef's in curses.h that disabled use of __attribute__() for
1060           g++, since recent versions implement the cases which ncurses uses.
1061
1062         + change some interfaces to use const:
1063                 define_key()
1064                 mvprintw()
1065                 mvwprintw()
1066                 printw()
1067                 vw_printw()
1068                 winsnstr()
1069                 wprintw()
1070
1071         Added extensions:
1072                 key_defined()
1073
1074         Added internal functions:
1075                 _nc_get_locale()
1076                 _nc_insert_ch()
1077                 _nc_is_charable()       wide
1078                 _nc_locale_breaks_acs()
1079                 _nc_pathlast()
1080                 _nc_to_char()           wide
1081                 _nc_to_widechar()       wide
1082                 _nc_tparm_analyze()
1083                 _nc_trace_bufcat()      debug
1084                 _nc_unicode_locale()
1085
1086         Removed internal functions:
1087                 _nc_outstr()
1088                 _nc_sigaction()
1089
1090         Modified internal functions:
1091                 _nc_remove_string()
1092                 _nc_retrace_chtype()
1093
1094     5.3 (October 12, 2002)
1095         Interface changes:
1096
1097         + change type for bool used in headers to NCURSES_BOOL, which usually
1098           is the same as the compiler's definition for 'bool'.
1099
1100         + add all but two functions for X/Open curses wide-character support.
1101           These are only available if the library is configured using the
1102           --enable-widec option.  Missing functions are
1103                 pecho_wchar()
1104                 slk_wset()
1105
1106         + add environment variable $NCURSES_ASSUMED_COLORS to modify the
1107           assume_default_colors() extension.
1108
1109         Added extensions:
1110                 is_term_resized()
1111                 resize_term()
1112
1113         Added internal functions:
1114                 _nc_altcharset_name()   debug
1115                 _nc_reset_colors()
1116                 _nc_retrace_bool()      debug
1117                 _nc_retrace_unsigned()  debug
1118                 _nc_rootname()
1119                 _nc_trace_ttymode()     debug
1120                 _nc_varargs()           debug
1121                 _nc_visbufn()           debug
1122                 _nc_wgetch()
1123
1124         Removed internal functions:
1125                 _nc_background()
1126
1127         Modified internal functions:
1128                 _nc_freeall()           debug
1129
1130     5.2 (October 21, 2000)
1131         Interface changes:
1132
1133         + revert termcap ospeed variable to 'short' (see discussion of the
1134           --with-ospeed configure option).
1135
1136     5.1 (July 8, 2000)
1137         Interface changes:
1138
1139         + made the extended terminal capabilities
1140           (configure --enable-tcap-names) a standard feature.  This should
1141           be transparent to applications that do not require it.
1142
1143         + removed the trace() function and related trace support from the
1144           production library.
1145
1146         + modified curses.h.in, undef'ing some symbols to avoid conflict
1147           with C++ STL.
1148
1149         Added extensions:  assume_default_colors().
1150
1151     5.0 (October 23, 1999)
1152         Interface changes:
1153
1154         + implemented the wcolor_set() and slk_color() functions.
1155
1156         + move macro winch to a function, to hide details of struct ldat
1157
1158         + corrected prototypes for slk_* functions, using chtype rather than
1159           attr_t.
1160
1161         + the slk_attr_{set,off,on} functions need an additional void*
1162           parameter according to XSI.
1163
1164         + modified several prototypes to correspond with 1997 version of X/Open
1165           Curses:  [w]attr_get(), [w]attr_set(), border_set() have different
1166           parameters.  Some functions were renamed or misspelled:
1167           erase_wchar(), in_wchntr(), mvin_wchntr().  Some developers have used
1168           attr_get().
1169
1170         Added extensions:  keybound(), curses_version().
1171
1172         Terminfo database changes:
1173
1174         + change translation for termcap 'rs' to terminfo 'rs2', which is
1175           the documented equivalent, rather than 'rs1'.
1176
1177         The problems are subtler in recent releases.
1178
1179         a) This release provides users with the ability to define their own
1180            terminal capability extensions, like termcap.  To accomplish this,
1181            we redesigned the TERMTYPE struct (in term.h).  Very few
1182            applications use this struct.  They must be recompiled to work with
1183            the 5.0 library.
1184
1185         a) If you use the extended terminfo names (i.e., you used configure
1186            --enable-tcap-names), the resulting terminfo database can have some
1187            entries which are not readable by older versions of ncurses.  This
1188            is a bug in the older versions:
1189
1190            + the terminfo database stores booleans, numbers and strings in
1191              arrays.  The capabilities that are listed in the arrays are
1192              specified by X/Open.  ncurses recognizes a number of obsolete and
1193              extended names which are stored past the end of the specified
1194              entries.
1195
1196            + a change to read_entry.c in 951001 made the library do an lseek()
1197              call incorrectly skipping data which is already read from the
1198              string array.  This happens when the number of strings in the
1199              terminfo data file is greater than STRCOUNT, the number of
1200              specified and obsolete or extended strings.
1201
1202            + as part of alignment with the X/Open final specification, in the
1203              990109 patch we added two new terminfo capabilities:
1204              set_a_attributes and set_pglen_inch).  This makes the indices for
1205              the obsolete and extended capabilities shift up by 2.
1206
1207            + the last two capabilities in the obsolete/extended list are memu
1208              and meml, which are found in most terminfo descriptions for xterm.
1209
1210              When trying to read this terminfo entry, the spurious lseek()
1211              causes the library to attempt to read the final portion of the
1212              terminfo data (the text of the string capabilities) 4 characters
1213              past its starting point, and reads 4 characters too few.  The
1214              library rejects the data, and applications are unable to
1215              initialize that terminal type.
1216
1217            FIX: remove memu and meml from the xterm description.  They are
1218            obsolete, not used by ncurses.  (It appears that the feature was
1219            added to xterm to make it more like hpterm).
1220
1221            This is not a problem if you do not use the -x option of tic to
1222            create a terminfo database with extended names.  Note that the
1223            user-defined terminal capabilities are not affected by this bug,
1224            since they are stored in a table after the older terminfo data ends,
1225            and are invisible to the older libraries.
1226
1227         c) Some developers did not wish to use the C++ binding, and used the
1228            configure --without-cxx option.  This causes problems if someone
1229            uses the ncurses library from C++ because that configure test
1230            determines the type for C++'s bool and makes ncurses match it, since
1231            both C++ and curses are specified to declare bool.  Calling ncurses
1232            functions with the incorrect type for bool will cause execution
1233            errors.  In 5.0 we added a configure option "--without-cxx-binding"
1234            which controls whether the binding itself is built and installed.
1235
1236     4.2 (March 2, 1998)
1237         Interface changes:
1238
1239         + correct prototype for termattrs() as per XPG4 version 2.
1240
1241         + add placeholder prototypes for color_set(), erasewchar(),
1242           term_attrs(), wcolor_set() as per XPG4 version 2.
1243
1244         + add macros getcur[xy] getbeg[xy] getpar[xy], which are defined in
1245           SVr4 headers.
1246
1247         New extensions: keyok() and define_key().
1248
1249         Terminfo database changes:
1250
1251         + corrected definition in curses.h for ACS_LANTERN, which was 'I'
1252           rather than 'i'.
1253
1254     4.1 (May 15, 1997)
1255
1256         We added these extensions:  use_default_colors().  Also added
1257         configure option --enable-const, to support the use of const where
1258         X/Open should have, but did not, specify.
1259
1260         The terminfo database content changed the representation of color for
1261         most entries that use ANSI colors.  SVr4 curses treats the setaf/setab
1262         and setf/setb capabilities differently, interchanging the red/blue
1263         colors in the latter.
1264
1265     4.0 (December 24, 1996)
1266
1267         We bumped to version 4.0 because the newly released dynamic loader
1268         (ld.so.1.8.5) on Linux did not load shared libraries whose ABI and REL
1269         versions were inconsistent.  At that point, ncurses ABI was 3.4 and the
1270         REL was 1.9.9g, so we made them consistent.
1271
1272     1.9.9g (December 1, 1996)
1273
1274         This fixed most of the problems with 1.9.9e, and made these interface
1275         changes:
1276
1277         + remove tparam(), which had been provided for compatibility with
1278           some termcap.  tparm() is standard, and does not conflict with
1279           application's fallback for missing tparam().
1280
1281         + turn off hardware echo in initscr().  This changes the sense of the
1282           echo() function, which was initialized to echoing rather than
1283           nonechoing (the latter is specified).  There were several other
1284           corrections to the terminal I/O settings which cause applications to
1285           behave differently.
1286
1287         + implemented several functions (such as attr_on()) which were
1288           available only as macros.
1289
1290         + corrected several typos in curses.h.in (i.e., the mvXXXX macros).
1291
1292         + corrected prototypes for delay_output(),
1293           has_color, immedok() and idcok().
1294
1295         + corrected misspelled getbkgd().  Some applications used the
1296           misspelled name.
1297
1298         + added _yoffset to WINDOW.  The size of WINDOW does not impact
1299           applications, since they use only pointers to WINDOW structs.
1300
1301         These changes were made to the terminfo database:
1302
1303         + removed boolean 'getm' which was available as an extended name.
1304
1305         We added these extensions: wresize(), resizeterm(), has_key() and
1306         mcprint().
1307
1308     1.9.9e (March 24, 1996)
1309
1310         not recommended (a last-minute/untested change left the forms and
1311         menus libraries unusable since they do not repaint the screen).
1312         Foreground/background colors are combined incorrectly, working properly
1313         only on a black background.  When this was released, the X/Open
1314         specification was available only in draft form.
1315
1316         Some applications (such as lxdialog) were "fixed" to work with the
1317         incorrect color scheme.
1318
1319
1320 IF YOU ARE A SYSTEM INTEGRATOR:
1321 ------------------------------
1322
1323     Configuration and Installation:
1324
1325         On platforms where ncurses is assumed to be installed in /usr/lib,
1326         the configure script uses "/usr" as a default:
1327
1328                 Linux, FreeBSD, NetBSD, OpenBSD, Cygwin
1329
1330         For other platforms, the default is "/usr/local".  See the discussion
1331         of the "--disable-overwrite" option.
1332
1333         The location of the terminfo is set indirectly by the "--datadir"
1334         configure option, e.g., /usr/share/terminfo, given a datadir of
1335         /usr/share.  You may want to override this if you are installing
1336         ncurses libraries in nonstandard locations, but wish to share the
1337         terminfo database.
1338
1339         Normally the ncurses library is configured in a pure-terminfo mode;
1340         that is, with the --disable-termcap option.  This makes the ncurses
1341         library smaller and faster.  The ncurses library includes a termcap
1342         emulation that queries the terminfo database, so even applications that
1343         use raw termcap to query terminal characteristics will win (providing
1344         you recompile and relink them!).
1345
1346         If you must configure with termcap fallback enabled, you may also wish
1347         to use the --enable-getcap option.  This speeds up termcap-based
1348         startups, at the expense of not allowing personal termcap entries to
1349         reference the terminfo tree.  See comments in
1350         ncurses/tinfo/read_termcap.c for further details.
1351
1352         Note that if you have $TERMCAP set, ncurses will use that value
1353         to locate termcap data.  In particular, running from xterm will
1354         set $TERMCAP to the contents of the xterm's termcap entry.
1355         If ncurses sees that, it will not examine /etc/termcap.
1356
1357     Keyboard Mapping:
1358
1359         The terminfo file assumes that Shift-Tab generates \E[Z (the ECMA-48
1360         reverse-tabulation sequence) rather than ^I.  Here are the loadkeys -d
1361         mappings that will set this up:
1362
1363                 keycode  15 = Tab             Tab
1364                         alt     keycode  15 = Meta_Tab
1365                         shift   keycode  15 = F26
1366                 string F26 ="\033[Z"
1367
1368     Naming the Console Terminal
1369
1370         In various systems there has been a practice of designating the system
1371         console driver type as `console'.  Please do not do this!  It
1372         complicates peoples' lives, because it can mean that several different
1373         terminfo entries from different operating systems all logically want to
1374         be called `console'.
1375
1376         Please pick a name unique to your console driver and set that up
1377         in the /etc/inittab table or local equivalent.  Send the entry to the
1378         terminfo maintainer (listed in the misc/terminfo file) to be included
1379         in the terminfo file, if it's not already there.  See the
1380         term(7) manual page included with this distribution for more on
1381         conventions for choosing type names.
1382
1383         Here are some recommended primary console names:
1384
1385                 linux   -- Linux console driver
1386                 freebsd -- FreeBSD
1387                 netbsd  -- NetBSD
1388                 bsdos   -- BSD/OS
1389
1390         If you are responsible for integrating ncurses for one of these
1391         distribution, please either use the recommended name or get back
1392         to us explaining why you don't want to, so we can work out nomenclature
1393         that will make users' lives easier rather than harder.
1394
1395
1396 RECENT XTERM VERSIONS:
1397 ---------------------
1398
1399         The terminfo database file included with this distribution assumes you
1400         are running a modern xterm based on XFree86 (i.e., xterm-new).  The
1401         earlier X11R6 entry (xterm-r6) and X11R5 entry (xterm-r5) is provided
1402         as well.  See the --without-xterm-new configure script option if you
1403         are unable to update your system.
1404
1405
1406 CONFIGURING FALLBACK ENTRIES:
1407 ----------------------------
1408
1409         In order to support operation of ncurses programs before the terminfo
1410         tree is accessible (that is, in single-user mode or at OS installation
1411         time) the ncurses library can be compiled to include an array of
1412         pre-fetched fallback entries.  This must be done on a machine which
1413         has ncurses' infocmp and terminfo database installed.
1414
1415         These entries are checked by setupterm() only when the conventional
1416         fetches from the terminfo tree and the termcap fallback (if configured)
1417         have been tried and failed.  Thus, the presence of a fallback will not
1418         shadow modifications to the on-disk entry for the same type, when that
1419         entry is accessible.
1420
1421         By default, there are no entries on the fallback list.  After you have
1422         built the ncurses suite for the first time, you can change the list
1423         (the process needs infocmp(1)).  To do so, use the script
1424         ncurses/tinfo/MKfallback.sh.  A configure script option
1425         --with-fallbacks does this (it accepts a comma-separated list of the
1426         names you wish, and does not require a rebuild).
1427
1428         If you wanted (say) to have linux, vt100, and xterm fallbacks, you
1429         would use the commands
1430
1431                 cd ncurses;
1432                 tinfo/MKfallback.sh linux vt100 xterm >fallback.c
1433
1434         Then just rebuild and reinstall the library as you would normally.
1435         You can restore the default empty fallback list with
1436
1437                 tinfo/MKfallback.sh >fallback.c
1438
1439         The overhead for an empty fallback list is one trivial stub function.
1440         Any non-empty fallback list is const-ed and therefore lives in sharable
1441         text space.  You can look at the comment trailing each initializer in
1442         the generated ncurses/fallback.c file to see the core cost of the
1443         fallbacks.  A good rule of thumb for modern vt100-like entries is that
1444         each one will cost about 2.5K of text space.
1445
1446
1447 BSD CONVERSION NOTES:
1448 --------------------
1449
1450         If you need to support really ancient BSD programs, you probably
1451         want to configure with the --enable-bsdpad option.  What this does
1452         is enable code in tputs() that recognizes a numeric prefix on a
1453         capability as a request for that much trailing padding in milliseconds.
1454         There are old BSD programs that do things like tputs("50").
1455
1456         (If you are distributing ncurses as a support-library component of
1457         an application you probably want to put the remainder of this section
1458         in the package README file.)
1459
1460         The following note applies only if you have configured ncurses with
1461         --enable-termcap.
1462
1463 ------------------------------- CUT HERE --------------------------------
1464
1465 If you are installing this application privately (either because you
1466 have no root access or want to experiment with it before doing a root
1467 installation), there are a couple of details you need to be aware of.
1468 They have to do with the ncurses library, which uses terminfo rather
1469 than termcap for describing terminal characteristics.
1470
1471 Though the ncurses library is terminfo-based, it will interpret your
1472 TERMCAP variable (if present), any local termcap files you reference
1473 through it, and the system termcap file.  However, in order to avoid
1474 slowing down your application startup, it will only do this once per
1475 terminal type!
1476
1477 The first time you load a given terminal type from your termcap
1478 database, the library initialization code will automatically write it
1479 in terminfo format to a subdirectory under $HOME/.terminfo.  After
1480 that, the initialization code will find it there and do a (much
1481 faster) terminfo fetch.
1482
1483 Usually, all this means is that your home directory will silently grow
1484 an invisible .terminfo subdirectory which will get filled in with
1485 terminfo descriptions of terminal types as you invoke them.  If anyone
1486 ever installs a global terminfo tree on your system, this will quietly
1487 stop happening and your $HOME/.terminfo will become redundant.
1488
1489 The objective of all this logic is to make converting from BSD termcap
1490 as painless as possible without slowing down your application (termcap
1491 compilation is expensive).
1492
1493 If you don't have a TERMCAP variable or custom personal termcap file,
1494 you can skip the rest of this dissertation.
1495
1496 If you *do* have a TERMCAP variable and/or a custom personal termcap file
1497 that defines a terminal type, that definition will stop being visible
1498 to this application after the first time you run it, because it will
1499 instead see the terminfo entry that it wrote to $HOME/terminfo the
1500 first time around.
1501
1502 Subsequently, editing the TERMCAP variable or personal TERMCAP file
1503 will have no effect unless you explicitly remove the terminfo entry
1504 under $HOME/terminfo.  If you do that, the entry will be recompiled
1505 from your termcap resources the next time it is invoked.
1506
1507 To avoid these complications, use infocmp(1) and tic(1) to edit the
1508 terminfo directory directly.
1509
1510 ------------------------------- CUT HERE --------------------------------
1511
1512 USING NCURSES WITH AFS:
1513         AFS treats each directory as a separate logical filesystem, you
1514         can't hard-link across them.  The --enable-symlinks option copes
1515         with this by making tic use symbolic links.
1516
1517 USING NCURSES WITH GPM:
1518         Ncurses 4.1 and up can be configured to use GPM (General Purpose
1519         Mouse) which is used on Linux console.  Be aware that GPM is commonly
1520         installed as a shared library which contains a wrapper for the curses
1521         wgetch() function (libcurses.o).  Some integrators have simplified
1522         linking applications by combining all or part of libcurses.so into the
1523         libgpm.so file, producing symbol conflicts with ncurses (specifically
1524         the wgetch function).  This was originally the BSD curses, but
1525         generally whatever curses library exists on the system.
1526
1527         You may be able to work around this problem by linking as follows:
1528
1529                 cc -o foo foo.o -lncurses -lgpm -lncurses
1530
1531         but the linker may not cooperate, producing mysterious errors.
1532         See the FAQ, as well as the discussion under the --with-gpm option:
1533
1534         http://invisible-island.net/ncurses/ncurses.faq.html#using_gpm_lib
1535
1536 BUILDING NCURSES WITH A CROSS-COMPILER
1537         Ncurses can be built with a cross-compiler.  Some parts must be built
1538         with the host's compiler since they are used for building programs
1539         (e.g., ncurses/make_hash and ncurses/make_keys) that generate tables
1540         that are compiled into the ncurses library.  The essential thing to do
1541         is set the BUILD_CC environment variable to your host's compiler, and
1542         run the configure script configuring for the cross-compiler.
1543
1544         The configure options --with-build-cc, etc., are provided to make this
1545         simpler.  Since make_hash and make_keys use only ANSI C features, it
1546         is normally not necessary to provide the other options such as
1547         --with-build-libs, but they are provided for completeness.
1548
1549         Note that all of the generated source-files which are part of ncurses
1550         will be made if you use
1551
1552                 make sources
1553
1554         This would be useful in porting to an environment which has little
1555         support for the tools used to generate the sources, e.g., sed, awk and
1556         Bourne-shell.
1557
1558         When ncurses has been successfully cross-compiled, you may want to use
1559         "make install" (with a suitable target directory) to construct an
1560         install tree.  Note that in this case (as with the --with-fallbacks
1561         option), ncurses uses the development platform's tic to do the
1562         "make install.data" portion.
1563
1564 BUGS:
1565         Send any feedback to the ncurses mailing list at
1566         bug-ncurses@gnu.org. To subscribe send mail to
1567         bug-ncurses-request@gnu.org with body that reads:
1568         subscribe ncurses <your-email-address-here>
1569
1570         The Hacker's Guide in the doc directory includes some guidelines
1571         on how to report bugs in ways that will get them fixed most quickly.
1572
1573 -- vile:txtmode