ncurses 6.1 - patch 20191005
[ncurses.git] / INSTALL
1 -------------------------------------------------------------------------------
2 -- Copyright (c) 1998-2018,2019 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.214 2019/09/07 22:44:40 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 distribution integrator or packager, please read and act on the
43 section titled IF YOU ARE A SYSTEM INTEGRATOR below.
44
45 If you are converting from BSD curses and do not have root access, be sure
46 to read the BSD CONVERSION NOTES section below.
47
48 If you are trying to build applications using gpm with ncurses,
49 read the USING NCURSES WITH GPM section below.
50
51 If you are running over the Andrew File System see the note below on
52 USING NCURSES WITH AFS.
53
54 If you are cross-compiling, see the note below on BUILDING NCURSES WITH A
55 CROSS-COMPILER.
56
57 If you want to build the Ada95 binding, go to the Ada95 directory and
58 follow the instructions there.  The Ada95 binding is not covered below.
59
60
61 REQUIREMENTS:
62 ------------
63
64 You will need the following to build and install ncurses under UNIX:
65
66         * ANSI C compiler  (gcc, for instance)
67         * sh               (bash will do)
68         * awk              (mawk or gawk will do)
69         * sed
70         * BSD or System V style install (a script is enclosed)
71
72 Ncurses has been also built in the OS/2 EMX environment.
73
74
75 INSTALLATION PROCEDURE:
76 ----------------------
77
78 1.  First, decide whether you want ncurses to replace your existing library (in
79     which case you'll need super-user privileges) or be installed in parallel
80     with it.
81
82     The --prefix option to configure changes the root directory for installing
83     ncurses.  The default is normally in subdirectories of /usr/local, except
84     for systems where ncurses is normally installed as a system library (see
85     "IF YOU ARE A SYSTEM INTEGRATOR").  Use --prefix=/usr to replace your
86     default curses distribution.
87
88     The package gets installed beneath the --prefix directory as follows:
89
90     In $(prefix)/bin:          tic, infocmp, captoinfo, tset,
91                                 reset, clear, tput, toe, tabs
92     In $(prefix)/lib:          libncurses*.* libcurses.a
93     In $(prefix)/share/terminfo: compiled terminal descriptions
94     In $(prefix)/include:      C header files
95     Under $(prefix)/man:       the manual pages
96
97     Note that the configure script attempts to locate previous installation of
98     ncurses, and will set the default prefix according to where it finds the
99     ncurses headers.
100
101     Do not use commands such as
102
103         make install prefix=XXX
104
105     to change the prefix after configuration, since the prefix value is used
106     for some absolute pathnames such as TERMINFO.  Instead do this
107
108         make install DESTDIR=XXX
109
110     See also the discussion of --with-install-prefix.
111
112 2.  Type `./configure' in the top-level directory of the distribution to
113     configure ncurses for your operating system and create the Makefiles.
114     Besides --prefix, various configuration options are available to customize
115     the installation; use `./configure --help' to list the available options.
116
117     If your operating system is not supported, read the PORTABILITY section in
118     the file ncurses/README for information on how to create a configuration
119     file for your system.
120
121     The `configure' script generates makefile rules for one or more object
122     models and their associated libraries:
123
124         libncurses.a (normal)
125
126         libcurses.a (normal, a link to libncurses.a)
127                 This gets left out if you configure with --disable-overwrite.
128
129         libncurses.so (shared)
130
131         libncurses_g.a (debug)
132
133         libncurses_p.a (profile)
134
135         libncurses.la (libtool)
136
137     If you configure using the --enable-widec option, a "w" is appended to the
138     library names (e.g., libncursesw.a), and the resulting libraries support
139     wide-characters, e.g., via a UTF-8 locale.  The corresponding header files
140     are compatible with the non-wide-character configuration; wide-character
141     features are provided by ifdef's in the header files.  The wide-character
142     library interfaces are not binary-compatible with the non-wide-character
143     version.  Building and running the wide-character code relies on a fairly
144     recent implementation of libiconv.  We have built this configuration on
145     various systems using libiconv, sometimes requiring libutf8.
146
147     If you configure using the --with-pthread option, a "t" is appended to
148     the library names (e.g., libncursest.a, libncursestw.a).
149
150     If you do not specify any models, the normal and debug libraries will be
151     configured.  Typing `configure' with no arguments is equivalent to:
152
153         ./configure --with-normal --with-debug --enable-overwrite
154
155     Typing
156
157         ./configure --with-shared
158
159     makes the shared libraries the default, resulting in
160
161         ./configure --with-shared --with-normal --with-debug --enable-overwrite
162
163     If you want only shared libraries, type
164
165         ./configure --with-shared --without-normal --without-debug
166
167     Rules for generating shared libraries are highly dependent upon the choice
168     of host system and compiler.  We've been testing shared libraries on
169     several systems, but more work needs to be done to make shared libraries
170     work on other systems.
171
172     If you have libtool installed, you can type
173
174         ./configure --with-libtool
175
176     to generate the appropriate static and/or shared libraries for your
177     platform using libtool.
178
179     You can make curses and terminfo fall back to an existing file of termcap
180     definitions by configuring with --enable-termcap.  If you do this, the
181     library will search /etc/termcap before the terminfo database, and will
182     also interpret the contents of the TERM environment variable.  See the
183     section BSD CONVERSION NOTES below.
184
185 3.  Type `make'.  Ignore any warnings, no error messages should be produced.
186     This should compile the ncurses library, the terminfo compiler tic(1),
187     captoinfo(1), infocmp(1), toe(1), clear(1) tset(1), reset(1), and tput(1)
188     programs (see the manual pages for explanation of what they do), some test
189     programs, and the panels, menus, and forms libraries.
190
191 4.  Run ncurses and several other test programs in the test directory to
192     verify that ncurses functions correctly before doing an install that
193     may overwrite system files.  Read the file test/README for details on
194     the test programs.
195
196     NOTE: You must have installed the terminfo database, or set the
197     environment variable $TERMINFO to point to a SVr4-compatible terminfo
198     database before running the test programs.  Not all vendors' terminfo
199     databases are SVr4-compatible, but most seem to be.
200
201     It is possible to configure ncurses to use other terminfo database formats.
202     A few are provided as examples in the include-directory (see --with-caps).
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     The ncurses program is designed specifically to test the ncurses library.
210     You can use it to verify that the screen highlights work correctly, that
211     cursor addressing and window scrolling works OK, etc.
212
213 5.  Once you've tested, you can type `make install' to install libraries,
214     the programs, the terminfo database and the manual pages.  Alternately, you
215     can type `make install' in each directory you want to install.  In the
216     top-level directory, you can do a partial install using these commands:
217
218         'make install.progs'    installs tic, infocmp, etc...
219         'make install.includes' installs the headers.
220         'make install.libs'     installs the libraries (and the headers).
221         'make install.data'     installs the terminfo data. (Note: `tic' must
222                                 be installed before the terminfo data can be
223                                 compiled).
224         'make install.man'      installs the manual pages.
225
226   ############################################################################
227   #     CAVEAT EMPTOR: `install.data' run as root will NUKE any existing     #
228   #  terminfo database. If you have any custom or unusual entries SAVE them  #
229   #  before you install ncurses.                                             #
230   ############################################################################
231
232     The terminfo(5) manual page must be preprocessed with tbl(1) before
233     being formatted by nroff(1).  Modern man(1) implementations tend to do
234     this by default, but you may want to look at your version's manual page
235     to be sure.  You may also install the manual pages after preprocessing
236     with tbl(1) by specifying the configure option --with-manpage-tbl.
237
238     If the system already has a curses library that you need to keep using
239     you'll need to distinguish between it and ncurses.  See the discussion of
240     --disable-overwrite.  If ncurses is installed outside the standard
241     directories (/usr/include and /usr/lib) then all your users will need to
242     use the -I option to compile programs and -L to link them.
243
244     If you have another curses installed in your system and you accidentally
245     compile using its curses.h you'll end up with a large number of
246     undefined symbols at link time.
247
248     IF YOU DO NOT HAVE ROOT: Change directory to the `progs' subdirectory
249     and run the `capconvert' script.  This script will deduce various things
250     about your environment and use them to build you a private terminfo tree,
251     so you can use ncurses applications.
252
253     If more than one user at your site does this, the space for the duplicate
254     trees is wasted.  Try to get your site administrators to install a system-
255     wide terminfo tree instead.
256
257     See the BSD CONVERSION NOTES section below for a few more details.
258
259 6.  The c++ directory has C++ classes that are built on top of ncurses and
260     panels.  You must have c++ (and its libraries) installed before you can
261     compile and run the demo.
262
263     Use --without-cxx-binding to tell configure to not build the C++ bindings
264     and demo.
265
266     If you do not have C++, you must use the --without-cxx option to tell
267     the configure script to not attempt to determine the type of 'bool'
268     which may be supported by C++.  IF YOU USE THIS OPTION, BE ADVISED THAT
269     YOU MAY NOT BE ABLE TO COMPILE (OR RUN) NCURSES APPLICATIONS WITH C++.
270
271
272 SUMMARY OF CONFIGURE OPTIONS:
273 ----------------------------
274
275     The configure script provides a short list of its options when you type
276
277         ./configure --help
278
279     The --help and several options are common to all configure scripts that are
280     generated with autoconf.  Those are all listed before the line
281
282         --enable and --with options recognized:
283
284     The other options are specific to this package.  We list them in alphabetic
285     order.
286
287     --disable-assumed-color
288         With ncurses 5.1, we introduced a new function, assume_default_colors()
289         which allows applications to specify what the default foreground and
290         background color are assumed to be.  Most color applications use
291         full-screen color; but a few do not color the background.  While the
292         assumed values can be overridden by invoking assume_default_colors(),
293         you may find it useful to set the assumed values to the pre-5.1
294         convention, using this configure option.
295
296     --disable-big-core
297         Assume machine has little memory.  The configure script attempts to
298         determine if your machine has enough memory (about 6Mb) to compile the
299         terminfo database without writing portions to disk.  Some allocators
300         return deceptive results, so you may have to override the configure
301         script.  Or you may be building tic for a smaller machine.
302
303     --disable-big-strings
304         Disable compile-time optimization of predefined tables which puts
305         all of their strings into a very long string, to reduce relocation
306         overhead.
307
308     --disable-database
309         Use only built-in data.  The ncurses libraries normally read terminfo
310         and termcap data from disk.  You can configure ncurses to have a
311         built-in database, aka "fallback" entries.  Embedded applications may
312         have no need for an external database.  Some, but not all of the
313         programs are useful in this configuration, e.g., tset and tput versus
314         infocmp and tic.
315
316     --disable-db-install
317         Do not install the terminal database.  This is used to omit features
318         for packages, as done with --without-progs.
319
320     --disable-echo
321         Use the option --disable-echo to make the build-log less verbose by
322         suppressing the display of the compile and link commands.  This makes
323         it easier to see the compiler warnings.  (You can always use "make -n"
324         to see the options that are used).
325
326     --disable-ext-funcs
327         Disable function-extensions.  Configure ncurses without the functions
328         that are not specified by XSI.  See ncurses/modules for the exact
329         list of library modules that would be suppressed.
330
331     --disable-gnat-projects
332         Disable GNAT projects even if usable, for testing old makefile rules.
333
334     --disable-hashmap
335         Compile without hashmap scrolling-optimization code.  This algorithm is
336         the default.
337
338     --disable-home-terminfo
339         The $HOME/.terminfo directory is normally added to ncurses' search
340         list for reading/writing terminfo entries, since that directory is
341         more likely writable than the system terminfo database.  Use this
342         option to disable the feature altogether.
343
344     --disable-largefile
345         Disable compiler flags needed to use large-file interfaces.
346
347     --disable-leaks
348         For testing, compile-in code that frees memory that normally would not
349         be freed, to simplify analysis of memory-leaks.
350
351         Any implementation of curses must not free the memory associated with
352         a screen, since (even after calling endwin()), it must be available
353         for use in the next call to refresh().  There are also chunks of
354         memory held for performance reasons.  That makes it hard to analyze
355         curses applications for memory leaks.  To work around this, build a
356         debugging version of the ncurses library which frees those chunks
357         which it can, and provides the _nc_free_and_exit() function to free
358         the remainder and then exit.  The ncurses utility and test programs
359         use this feature, e.g., via the ExitProgram() macro.
360
361         Because this lies outside of the library's intended usage, it is not
362         normally considered part of the ABI.  If there were some (as yet
363         unplanned) extension which frees memory in a manner that would let the
364         library resume and reallocate memory, then that would not use a "_nc_"
365         prefix.
366
367     --disable-lib-suffixes
368         Suppress the "w", "t" or "tw" suffixes which normally would be added
369         to the library names for the --enable-widec and --with-pthread options.
370
371     --disable-libtool-version
372         when using --with-libtool, control how the major/minor version numbers
373         are used for constructing the library name.
374
375         The default uses the -version-number feature of libtool, which makes
376         the library names compatible (though not identical) with the standard
377         build using --with-shared.
378
379         Use --disable-libtool-version to use the libtool -version-info feature.
380         This corresponds to the setting used before patch 20100515.
381
382         Starting with patch 20141115, using this option causes the configure
383         script to apply the top-level VERSION file to the ABI version used
384         for libtool.
385
386     --disable-lp64
387         The header files will ignore use of the _LP64 symbol to make chtype
388         and mmask_t types 32 bits (they may be long on 64-bit hosts, for
389         compatibility with older releases).
390
391         NOTE: this is potentially an ABI change, depending on existing
392         packages.  The default for this option is "disabled" for ncurses
393         ABI 5, and "enabled" for ABI 6.
394
395     --disable-macros
396         For testing, use functions rather than macros.  The program will run
397         more slowly, but it is simpler to debug.  This defines NCURSES_NOMACROS
398         at build time.  See also the --enable-expanded option.
399
400     --disable-overwrite
401         If you are installing ncurses on a system which contains another
402         development version of curses, or which could be confused by the loader
403         for another version, we recommend that you leave out the link to
404         -lcurses.  The ncurses library is always available as -lncurses.
405         Disabling overwrite also causes the ncurses header files to be
406         installed into a subdirectory, e.g., /usr/local/include/ncurses,
407         rather than the include directory.  This makes it simpler to avoid
408         compile-time conflicts with other versions of curses.h
409
410         Putting the header files into a subdirectory assumes that applications
411         will follow the (standard) practice of including the headers with
412         reference to the subdirectory name.  For instance, the normal ncurses
413         header would be included using
414
415                 #include <ncurses/curses.h>
416                 #include <ncurses/term.h>
417
418         while the ncursesw headers would be found this way:
419
420                 #include <ncursesw/curses.h>
421                 #include <ncursesw/term.h>
422
423         In either case (with or without the --disable-overwrite option),
424         almost all applications are designed to include a related set of
425         curses header files from the same directory.
426
427         Manipulating the --includedir configure option to put header files
428         directly in a subdirectory of the normal include-directory defeats
429         this, and breaks builds of portable applications.  Likewise, putting
430         some headers in /usr/include, and others in a subdirectory is a good
431         way to break builds.
432
433         When configured with --disable-overwrite, the installed header files'
434         embedded #include's are adjusted to use the same style of includes
435         noted above.  In particular, the unctrl.h header is included from
436         curses.h, which means that a makefile which tells the compiler to
437         include directly from the subdirectory will fail to compile correctly.
438         Without some special effort, it will either fail to compile at all,
439         or the compiler may find a different unctrl.h file.
440
441     --disable-relink
442         If --enable-rpath is given, the generated makefiles normally will
443         rebuild shared libraries during install.  Use this option to simply
444         copy whatever the linker produced.
445
446         Static libraries cannot simply be copied because tools use timestamps
447         to determine if the library's symbol table is up to date.  If your
448         install program supports the "-p" (preserve timestamp) option, that
449         is used when --disable-relink is given, to avoid rebuilding the symbol
450         table.
451
452         Finally, some tools ignore the subsecond timestamps supported by some
453         filesystems.  This option adds a 1-second sleep to help those tools
454         avoid unnecessary relinking during the install process.
455
456     --disable-root-environ
457         Compile with environment restriction, so certain environment variables
458         are not available when running as root, or via a setuid/setgid
459         application.  These are (for example $TERMINFO) those that allow the
460         search path for the terminfo or termcap entry to be customized.
461
462     --disable-rpath-hack
463         Normally the configure script helps link libraries found in unusual
464         places by adding an rpath option to the link command.  If you are
465         building packages, this feature may be redundant.  Use this option
466         to suppress the feature.
467
468     --disable-scroll-hints
469         Compile without scroll-hints code.  This option is ignored when
470         hashmap scrolling is configured, which is the default.
471
472     --disable-stripping
473         Do not strip installed executables.
474
475     --disable-tic-depends
476         When building shared libraries, normally the tic library is linked to
477         depend upon the ncurses library (or equivalently, on the tinfo-library
478         if the --with-termlib option was given).  The tic- and tinfo-library
479         ABIs do not depend on the --enable-widec option.  Some packagers have
480         used this to reduce the number of library files which are packaged by
481         using only one copy of those libraries.  To make this work properly,
482         the tic library must be built without an explicit dependency on the
483         underlying library (ncurses vs ncursesw, tinfo vs tinfow).  Use this
484         configure option to do that.
485         For example
486                 configure --with-ticlib --with-shared --disable-tic-depends
487
488     --disable-tparm-varargs
489         Portable programs should call tparm() using the fixed-length parameter
490         list documented in X/Open.  ncurses provides varargs support for this
491         function.  Use --disable-tparm-varargs to disable this support.
492
493     --disable-wattr-macros
494         The 6.0 ABI adds support for extended colors and for extended mouse.
495         The former is a noticeable problem when developers inadvertantly
496         compile using the ncurses6 header files and link with an ncurses5
497         library, because the wattr* macros use a new field in the WINDOW
498         structure.  These macros are used in several applications.
499
500         Since ncurses provides an actual function for each of these macros,
501         suppressing them from the curses.h header allows the ncurses5 libraries
502         to be used in most applications.
503
504         NOTE: The extended colors also are used in the cchar_t structure, but
505         fewer applications use that.
506
507         NOTE: This workaround does not help with mismatches in the ncurses
508         mouse version.  The extended mouse feature uses one less fewer bit for
509         each button, so that only the first button will work as expected with
510         a mismatch between header and library.  Again, most applications will
511         work, since most use only the first button.
512
513     --enable-assertions
514         For testing, compile-in assertion code.  This is used only for a few
515         places where ncurses cannot easily recover by returning an error code.
516
517     --enable-broken_linker
518         A few platforms have what we consider a broken linker:  it cannot link
519         objects from an archive solely by referring to data objects in those
520         files, but requires a function reference.  This configure option
521         changes several data references to functions to work around this
522         problem.
523
524         NOTE: With ncurses 5.1, this may not be necessary, since we are
525         told that some linkers interpret uninitialized global data as a
526         different type of reference which behaves as described above.  We have
527         explicitly initialized all of the global data to work around the
528         problem.
529
530     --enable-bsdpad
531         Recognize BSD-style prefix padding.  Some ancient BSD programs (such as
532         nethack) call tputs("50") to implement delays.
533
534     --enable-colorfgbg
535         Compile with experimental $COLORFGBG code.  That environment variable
536         is set by some terminal emulators as a hint to applications, by
537         advertising the default foreground and background colors.  During
538         initialization, ncurses sets color pair 0 to match this.
539
540     --enable-const
541         The curses interface as documented in XSI is rather old, in fact
542         including features that precede ANSI C.  The prototypes generally do
543         not make effective use of "const".  When using stricter compilers (or
544         gcc with appropriate warnings), you may see warnings about the mismatch
545         between const and non-const data.  We provide a configure option which
546         changes the interfaces to use const - quieting these warnings and
547         reflecting the actual use of the parameters more closely.  The ncurses
548         library uses the symbol NCURSES_CONST for these instances of const,
549         and if you have asked for compiler warnings, will add gcc's const-qual
550         warning.  There will still be warnings due to subtle inconsistencies
551         in the interface, but at a lower level.
552
553         NOTE: configuring ncurses with this option may detract from the
554         portability of your applications by encouraging you to use const in
555         places where the XSI curses interface would not allow them.  Similar
556         issues arise when porting to SVr4 curses, which uses const in even
557         fewer places.
558
559     --enable-expanded
560         For testing, generate functions for certain macros to make them visible
561         as such to the debugger.  See also the --disable-macros option.
562
563     --enable-ext-colors
564         Extend the cchar_t structure to allow more than 16 colors to be
565         encoded.  This applies only to the wide-character (--enable-widec)
566         configuration.
567
568         NOTE: using this option will make libraries which are not binary-
569         compatible with libncursesw 5.4.  None of the interfaces change, but
570         applications which have an array of cchar_t's must be recompiled.
571
572     --enable-ext-mouse
573         Modify the encoding of mouse state to make room for a 5th mouse button.
574         That allows one to use ncurses with a wheel mouse with xterm or
575         similar X terminal emulators.
576
577         NOTE: using this option will make libraries which are not binary-
578         compatible with libncursesw 5.4.  None of the interfaces change, but
579         applications which have mouse mask mmask_t's must be recompiled.
580
581     --enable-ext-putwin
582         Modify the file-format written by putwin() to use printable text rather
583         than binary files, allowing getwin() to read screen dumps written by
584         differently-configured ncurses libraries.  The extended getwin() can
585         still read binary screen dumps from the "same" configuration of
586         ncurses.  This does not change the ABI (the binary interface seen by
587         calling applications).
588
589     --enable-getcap
590         Use the 4.4BSD getcap code if available, or a bundled version of it to
591         fetch termcap entries.  Entries read in this way cannot use (make
592         cross-references to) the terminfo tree, but it is faster than reading
593         /etc/termcap.
594
595         If configured for one of the *BSD systems, this automatically uses
596         the hashed database system produced using cap_mkdb or similar tools.
597         In that case, there is no advantage in using the --enable-getcap-cache
598         option.
599
600         See also the --with-hashed-db option.
601
602     --enable-getcap-cache
603         Cache translated termcaps under the directory $HOME/.terminfo
604
605         NOTE: this sounds good - it makes ncurses run faster the second time.
606         But look where the data comes from - an /etc/termcap containing lots of
607         entries that are not up to date.  If you configure with this option and
608         forget to install the terminfo database before running an ncurses
609         application, you will end up with a hidden terminfo database that
610         generally does not support color and will miss some function keys.
611
612     --enable-hard-tabs
613         Compile-in cursor-optimization code that uses hard-tabs.  We would make
614         this a standard feature except for the concern that the terminfo entry
615         may not be accurate, or that your stty settings have disabled the use
616         of tabs.
617
618     --enable-interop
619         Compile-in experimental interop bindings.  These provide generic types
620         for the form-library.
621
622     --enable-mixed-case
623         Controls whether the filesystem on which the terminfo database resides
624         supports mixed-case filenames (normal for UNIX, but not on other
625         systems).  If you do not specify this option, the configure script
626         checks the current filesystem.
627
628     --enable-no-padding
629         Compile-in support for the $NCURSES_NO_PADDING environment variable,
630         which allows you to suppress the effect of non-mandatory padding in
631         terminfo entries.  This is the default, unless you have disabled the
632         extended functions.
633
634     --enable-opaque-curses
635     --enable-opaque-form
636     --enable-opaque-menu
637     --enable-opaque-panel
638         Define symbol in curses.h which controls whether some library
639         structures are treated as "opaque".  The --enable-opaque-curses option
640         is overridden by the --enable-reentrant option.
641
642     --enable-pc-files
643         If pkg-config is found (see --with-pkg-config), generate ".pc" files
644         for each of the libraries, and install them in pkg-config's library
645         directory.
646
647     --enable-pthreads-eintr
648         add logic in threaded configuration to ensure that a read(2) system
649         call can be interrupted for SIGWINCH.
650
651     --enable-reentrant
652         Compile configuration which improves reentrant use of the library by
653         reducing global and static variables.  This option is also set if
654         --with-pthread is used.
655
656         Enabling this option adds a "t" to the library names, except for the
657         special case when --enable-weak-symbols is also used.
658
659     --enable-rpath
660         Use rpath option when generating shared libraries, and (with some
661         restrictions) when linking the corresponding programs.  This originally
662         (in 1997) applied mainly to systems using the GNU linker (read the
663         manpage).
664
665         More recently it is useful for systems that require special treatment
666         shared libraries in "unusual" locations.  The "system" libraries reside
667         in directories which are on the loader's default search-path.  While
668         you may be able to use workarounds such as the $LD_LIBRARY_PATH
669         environment variable, they do not work with setuid applications since
670         the LD_LIBRARY_PATH variable would be unset in that situation.
671
672         This option does not apply to --with-libtool, since libtool makes
673         extra assumptions about rpath.
674
675     --enable-safe-sprintf
676         Compile with experimental safe-sprintf code.  You may consider using
677         this if you are building ncurses for a system that has neither
678         vsnprintf() or vsprintf().  It is slow, however, and is used only on
679         very old systems which lack vsnprintf().
680
681     --enable-signed-char
682         The term.h header declares a Booleans[] array typed "char".  But it
683         stores signed values there and "char" is not necessarily signed.
684         Some packagers choose to alter the type of Booleans[] though this
685         is not strictly compatible.  This option allows one to implement this
686         alteration without patching the source code.
687
688     --enable-sigwinch
689         Compile support for ncurses' SIGWINCH handler.  If your application has
690         its own SIGWINCH handler, ncurses will not use its own.  The ncurses
691         handler causes wgetch() to return KEY_RESIZE when the screen-size
692         changes.  This option is the default, unless you have disabled the
693         extended functions.
694
695     --enable-sp-funcs
696         Compile-in support for extended functions which accept a SCREEN pointer,
697         reducing the need for juggling the global SP value with set_term() and
698         delscreen().
699
700     --enable-string-hacks
701         Controls whether strlcat and strlcpy may be used.  The same issue
702         applies to OpenBSD's warnings about snprintf, noting that this function
703         is weakly standardized.
704
705         Aside from stifling these warnings, there is no functional improvement
706         in ncurses.
707
708     --enable-symlinks
709         If your system supports symbolic links, make tic use symbolic links
710         rather than hard links to save diskspace when writing aliases in the
711         terminfo database.
712
713     --enable-tcap-names
714         Compile-in support for user-definable terminal capabilities.  Use the
715         -x option of tic and infocmp to treat unrecognized terminal
716         capabilities as user-defined strings.  This option is the default,
717         unless you have disabled the extended functions.
718
719     --enable-term-driver
720         Enable experimental terminal-driver.  This is currently used for the
721         MinGW port, by providing a way to substitute the low-level terminfo
722         library with different terminal drivers.
723
724     --enable-termcap
725         Compile in support for reading terminal descriptions from termcap if no
726         match is found in the terminfo database.  See also the --enable-getcap
727         and --enable-getcap-cache options.
728
729         Termcap support requires run-time parsing rather than loading
730         predigested data.  If you have specified --with-ticlib, then you
731         cannot have termcap support since run-time parsing is done in the
732         tic library, which is intentionally not part of normal linkage
733         dependencies.
734
735     --enable-warnings
736         Turn on GCC compiler warnings.  There should be only a few.
737
738     --enable-weak-symbols
739         If the --with-pthread option is set, check if the compiler supports
740         weak-symbols.  If it does, then name the thread-capable library without
741         the "t" (libncurses rather than libncursest), and provide for
742         dynamically loading the pthreads entrypoints at runtime.  This allows
743         one to reduce the number of library files for ncurses.
744
745     --enable-wgetch-events
746         Compile with experimental wgetch-events code.  See ncurses/README.IZ
747
748     --enable-widec
749         Compile with wide-character code.  This makes a different version of
750         the libraries (e.g., libncursesw.so), which stores characters as
751         wide-characters,
752
753         NOTE: applications compiled with this configuration are not compatible
754         with those built for 8-bit characters.  You cannot simply make a
755         symbolic link to equate libncurses.so with libncursesw.so
756
757         NOTE: the Ada95 binding may be built against either version of the the
758         ncurses library, but you must decide which:  the binding installs the
759         same set of files for either version.  Currently (2002/6/22) it does
760         not use the extended features from the wide-character code, so it is
761         probably better to not install the binding for that configuration.
762
763     --enable-xmc-glitch
764         Compile-in support experimental xmc (magic cookie) code.
765
766     --with-abi-version=NUM
767         Override the ABI version, which is used in shared library filenames.
768         Normally this is the same as the release version; some ports have
769         special requirements for compatibility.
770
771         This option does not affect linking with libtool, which uses the
772         release major/minor numbers.
773
774     --with-ada-compiler=CMD
775         Specify the Ada95 compiler command (default "gnatmake")
776
777     --with-ada-include=DIR
778         Tell where to install the Ada includes (default:
779         PREFIX/lib/ada/adainclude)
780
781     --with-ada-libname=NAME
782         Override the name of the Ada binding (default: "AdaCurses")
783
784     --with-ada-objects=DIR
785         Tell where to install the Ada objects (default:  PREFIX/lib/ada/adalib)
786
787     --with-ada-sharedlib
788         Build a shared library for Ada95 binding, if the compiler permits.
789
790         NOTE: You must also set the --with-shared option on some platforms
791         for a successful build.  You need not use this option when you set
792         --with-shared, unless you want to use the Ada shared library.
793
794     --with-bool=TYPE
795         If --without-cxx is specified, override the type used for the "bool"
796         declared in curses.h (normally the type is automatically chosen to
797         correspond with that in <stdbool.h>, or defaults to platform-specific
798         sizes).
799
800     --with-build-cc=XXX
801         If cross-compiling, specify a host C compiler, which is needed to
802         compile a few utilities which generate source modules for ncurses.
803         If you do not give this option, the configure script checks if the
804         $BUILD_CC variable is set, and otherwise defaults to gcc or cc.
805
806     --with-build-cflags=XXX
807         If cross-compiling, specify the host C compiler-flags.  You might need
808         to do this if the target compiler has unusual flags which confuse the
809         host compiler.
810
811         You can also set the environment variable $BUILD_CFLAGS rather than
812         use this option.
813
814     --with-build-cpp=XXX
815         This option is provided by the same macro used for $BUILD_CC, etc.,
816         but is not directly used by ncurses.
817
818     --with-build-cppflags=XXX
819         If cross-compiling, specify the host C preprocessor-flags.  You might
820         need to do this if the target compiler has unusual flags which confuse
821         the host compiler.
822
823         You can also set the environment variable $BUILD_CPPFLAGS rather than
824         use this option.
825
826     --with-build-ldflags=XXX
827         If cross-compiling, specify the host linker-flags.  You might need to
828         do this if the target linker has unusual flags which confuse the host
829         compiler.
830
831         You can also set the environment variable $BUILD_LDFLAGS rather than
832         use this option.
833
834     --with-build-libs=XXX
835         If cross-compiling, the host libraries.  You might need to do this if
836         the target environment requires unusual libraries.
837
838         You can also set the environment variable $BUILD_LIBS rather than
839         use this option.
840
841     --with-caps=XXX
842         Specify an alternate terminfo capabilities file, which makes the
843         configure script look for "include/Caps.XXX".  A few systems, e.g.,
844         AIX 4.x use the same overall file-format as ncurses for terminfo
845         data, but use different alignments within the tables to support
846         legacy applications.  For those systems, you can configure ncurses
847         to use a terminfo database which is compatible with the native
848         applications.
849
850     --with-ccharw-max=XXX
851         Override the size of the wide-character array in cchar_t structures.
852         Changing this will alter the binary interface.  This defaults to 5.
853
854     --with-chtype=TYPE
855         Override type of chtype, which stores the video attributes and (if
856         --enable-widec is not given) a character.  Prior to ncurses 5.5, this
857         was always unsigned long, but with ncurses 5.5, it may be unsigned.
858         Use this option if you need to preserve compatibility with 64-bit
859         executables, e.g., by setting "--with-chtype=long" (the configure
860         script supplies "unsigned").
861
862     --with-config-suffix=XXX
863         Specify a suffix for the ncursesw6-config file, etc., used to work
864         around conflicts with packages.
865
866     --with-cxx-shared
867         When --with-shared is set, build libncurses++ as a shared library.
868         This implicitly relies upon building with gcc/g++, since other
869         compiler suites may have differences in the way shared libraries are
870         built.  libtool by the way has similar limitations.
871
872     --with-database=XXX
873         Specify the terminfo source file to install.  Usually you will wish
874         to install ncurses' default (misc/terminfo.src).  Certain systems
875         have special requirements, e.g, OS/2 EMX has a customized terminfo
876         source file.
877
878     --with-dbmalloc
879         For testing, compile and link with Conor Cahill's dbmalloc library.
880         This also sets the --disable-leaks option.
881
882     --with-debug
883         Generate debug-libraries (default).  These are named by adding "_g"
884         to the root, e.g., libncurses_g.a
885
886     --with-default-terminfo-dir=XXX
887         Specify the default terminfo database directory.  This is normally
888         DATADIR/terminfo, e.g., /usr/share/terminfo.
889
890     --with-dmalloc
891         For testing, compile and link with Gray Watson's dmalloc library.
892         This also sets the --disable-leaks option.
893
894     --with-export-syms[=XXX]
895         Limit exported symbols using libtool.  The configure script
896         automatically chooses an appropriate ".sym" file, which lists the
897         symbols which are part of the ABI.
898
899     --with-extra-suffix[=XXX]
900         Add the given suffix to header- and library-names to simplify
901         installing incompatible ncurses libraries, e.g., those using a
902         different ABI.  The renaming affects the name of the
903         include-subdirectory if --disable-overwrite is given.
904
905     --with-fallbacks=XXX
906         Specify a list of fallback terminal descriptions which will be
907         compiled into the ncurses library.  See CONFIGURING FALLBACK ENTRIES.
908
909         See also "--with-tic-path" and "--with-infocmp-path".
910
911     --with-gpm
912         use Alessandro Rubini's GPM library to provide mouse support on the
913         Linux console.  Prior to ncurses 5.5, this introduced a dependency on
914         the GPM library.
915
916         Currently ncurses uses the dlsym() function to bind to the library at
917         runtime, so it is only necessary that the library be present when
918         ncurses is built, to obtain the filename (or soname) used in the
919         corresponding dlopen() call.  If you give a value for this option,
920         e.g.,
921
922                 --with-gpm=$HOME/tmp/test-gpm.so
923
924         that overrides the configure check for the soname.
925
926         See also --without-dlsym
927
928     --with-hashed-db[=XXX]
929         Use a hashed database for storing terminfo data rather than storing
930         each compiled entry in a separate binary file within a directory
931         tree.
932
933         In particular, this uses the Berkeley database 1.8.5 interface, as
934         provided by that and its successors db 2, 3, and 4.  The actual
935         interface is slightly different in the successor versions of the
936         Berkeley database.  The database should have been configured using
937         "--enable-compat185".
938
939         If you use this option for configuring ncurses, tic will only be able
940         to write entries in the hashed database.  infocmp can still read
941         entries from a directory tree as well as reading entries from the
942         hashed database.  To do this, infocmp determines whether the $TERMINFO
943         variable points to a directory or a file, and reads the directory-tree
944         or hashed database respectively.
945
946         You cannot have a directory containing both hashed-database and
947         filesystem-based terminfo entries.
948
949         Use the parameter value to give the install-prefix used for the
950         database, e.g.,
951                 --with-hashed-db=/usr/local/BigBase
952         to find the corresponding include- and lib-directories under the
953         given directory.  Alternatively, you can specify a directory leaf
954         name, e.g.,
955                 --with-hashed-db=db4
956         to make the configure script look for files in a subdirectory such as
957                 /usr/include/db4/db.h
958                 /usr/lib/db4/libdb.so
959
960         See also the --enable-getcap option.
961
962     --with-infocmp-path[=XXX]
963         Use this option to override the automatic detection of tic in your
964         $PATH when building fallbacks (see "--with-fallbacks").
965
966     --with-install-prefix=XXX
967         Allows you to specify an alternate location for installing ncurses
968         after building it.  The value you specify is prepended to the "real"
969         install location.  This simplifies making binary packages.  The
970         makefile variable DESTDIR is set by this option.  It is also possible
971         to use
972                 make install DESTDIR=XXX
973         since the makefiles pass that variable to subordinate makes.
974
975         NOTE: a few systems build shared libraries with fixed pathnames; this
976         option probably will not work for those configurations.
977
978     --with-lib-prefix=XXX
979         OS/2 EMX used a different naming convention from most Unix-like
980         platforms.  It required that the "lib" part of a library name was
981         omitted.  Newer EMX as part of eComStation does not follow that
982         convention.  Use this option to override the configure script's
983         assumptions about the library-prefix.  If this option is omitted, it
984         uses the original OS/2 EMX convention for that platform.  Use
985         "--with-lib-prefix=lib" for the newer EMX in eComStation.  Use
986         "--without-lib-prefix" to suppress it for other odd platforms.
987
988     --with-libtool[=XXX]
989         Generate libraries with libtool.  If this option is selected, then it
990         overrides all other library model specifications.  Note that libtool
991         must already be installed, uses makefile rules dependent on GNU make,
992         and does not promise to follow the version numbering convention of
993         other shared libraries on your system.  However, if the --with-shared
994         option does not succeed, you may get better results with this option.
995
996         If a parameter value is given, it must be the full pathname of the
997         particular version of libtool, e.g.,
998                 /usr/bin/libtool-1.2.3
999
1000         It is possible to rebuild the configure script to use the automake
1001         macros for libtool, e.g., AC_PROG_LIBTOOL.  See the comments in
1002         aclocal.m4 for CF_PROG_LIBTOOL, and ensure that you build configure
1003         using the appropriate patch for autoconf from
1004                 https://invisible-island.net/autoconf/
1005
1006     --with-libtool-opts=XXX
1007         Allow user to pass additional libtool options into the library creation
1008         and link steps.  The main use for this is to do something like
1009                 ./configure --with-libtool-opts=-static
1010         to get the same behavior as automake-flavored
1011                 ./configure --enable-static
1012
1013     --with-manpage-aliases
1014         Tell the configure script you wish to create entries in the
1015         man-directory for aliases to manpages which list them, e.g., the
1016         functions in the panel manpage.  This is the default.  You can disable
1017         it if your man program does this.  You can also disable
1018         --with-manpage-symlinks to install files containing a ".so" command
1019         rather than symbolic links.
1020
1021     --with-manpage-format=XXX
1022         Tell the configure script how you would like to install man-pages.  The
1023         option value must be one of these:  gzip, compress, BSDI, normal,
1024         formatted.  If you do not give this option, the configure script
1025         attempts to determine which is the case.
1026
1027     --with-manpage-renames=XXX
1028         Tell the configure script that you wish to rename the manpages while
1029         installing.  Currently the only distribution which does this is Debian.
1030         The option value specifies the name of a file that lists the renamed
1031         files, e.g., $srcdir/man/man_db.renames
1032
1033     --with-manpage-symlinks
1034         Tell the configure script that you wish to make symbolic links in the
1035         man-directory for aliases to the man-pages.  This is the default, but
1036         can be disabled for systems that provide this automatically.  Doing
1037         this on systems that do not support symbolic links will result in
1038         copying the man-page for each alias.
1039
1040     --with-manpage-tbl
1041         Tell the configure script that you wish to preprocess the manpages
1042         by running them through tbl to generate tables understandable by
1043         nroff.
1044
1045     --with-mmask-t=TYPE
1046         Override type of mmask_t, which stores the mouse mask.  Prior to
1047         ncurses 5.5, this was always unsigned long, but with ncurses 5.5, it
1048         may be unsigned.  Use this option if you need to preserve compatibility
1049         with 64-bit executables.
1050
1051     --with-normal
1052         Generate normal (i.e., static) libraries (default).
1053
1054         Note:  on Linux, the configure script will attempt to use the GPM
1055         library via the dlsym() function call.  Use --without-dlsym to disable
1056         this feature, or --without-gpm, depending on whether you wish to use
1057         GPM.
1058
1059     --with-ospeed=TYPE
1060         Override type of ospeed variable, which is part of the termcap
1061         compatibility interface.  In termcap, this is a 'short', which works
1062         for a wide range of baudrates because ospeed is not the actual speed
1063         but the encoded value, e.g., B9600 would be a small number such as 13.
1064         However the encoding scheme originally allowed for values "only" up to
1065         38400bd.  A newer set of definitions past 38400bd is not encoded as
1066         compactly, and is not guaranteed to fit into a short (see the function
1067         cfgetospeed(), which returns a speed_t for this reason).  In practice,
1068         applications that required knowledge of the ospeed variable, i.e.,
1069         those using termcap, do not use the higher speeds.  Your application
1070         (or system, in general) may or may not.
1071
1072     --with-pc-suffix=SUFFIX
1073         If ".pc" files are installed, optionally add a suffix to the files
1074         and corresponding package names to separate unusual configurations.
1075         If no option value is given (or if it is "none"), no suffix is added.
1076
1077     --with-pcre2
1078         Add PCRE2 (Perl-compatible regular expressions v2) to the build if it
1079         is available and the user requests it.  Assume the application will
1080         otherwise use the POSIX interface.
1081
1082         This is useful for MinGW builds because the usual POSIX interface is
1083         not supplied by the development environment, while ncurses' form
1084         library uses a regular expression feature for one of the field types.
1085
1086     --with-pkg-config=[DIR]
1087         Check for pkg-config, optionally specifying its path.
1088
1089     --with-pkg-config-libdir=[DIR]
1090         If pkg-config was found, override the automatic check for its library
1091         path.
1092
1093     --with-profile
1094         Generate profile-libraries These are named by adding "_p" to the root,
1095         e.g., libncurses_p.a
1096
1097     --with-pthread
1098         Link with POSIX threads, set --enable-reentrant.  The use_window() and
1099         use_screen() functions will use mutex's, allowing rudimentary support
1100         for multithreaded applications.
1101
1102     --with-rcs-ids
1103         Compile-in RCS identifiers.  Most of the C files have an identifier.
1104
1105     --with-rel-version=NUM
1106         Override the release version, which may be used in shared library
1107         filenames.  This consists of a major and minor version number separated
1108         by ".".  Normally the major version number is the same as the ABI
1109         version; some ports have special requirements for compatibility.
1110
1111     --with-shared
1112         Generate shared-libraries.  The names given depend on the system for
1113         which you are building, typically using a ".so" suffix, along with
1114         symbolic links that refer to the release version.
1115
1116         NOTE: Unless you override the configure script by setting the $CFLAGS
1117         environment variable, these will not be built with the -g debugging
1118         option.
1119
1120         NOTE: For some configurations, e.g., installing a new version of
1121         ncurses shared libraries on a machine which already has ncurses
1122         shared libraries, you may encounter problems with the linker.
1123         For example, it may prevent you from running  the build tree's
1124         copy of tic (for installing the terminfo database) because it
1125         loads the system's copy of the ncurses shared libraries.
1126
1127         In that case, using the misc/shlib script may be helpful, since it
1128         sets $LD_LIBRARY_PATH to point to the build tree, e.g.,
1129
1130                 ./misc/shlib make install
1131
1132         Alternatively, for most platforms, the linker accepts a list of
1133         directories which will be searched for libraries at run-time.  The
1134         configure script allows you to modify this list using the
1135         RPATH_LIST environment variable.  It is a colon-separated list of
1136         directories (default:  the "libdir" set via the configure script).
1137         If you set that to put "../lib" first in the list, the linker will
1138         look first at the build-directory, and avoid conflict with libraries
1139         already installed.  One drawback to this approach is that libraries
1140         can be accidentally searched in any "../lib" directory.
1141
1142         NOTE: If you use the --with-ada-sharedlib option, you should also
1143         set this option, to ensure that C-language modules needed for the
1144         Ada binding use appropriate compiler options.
1145
1146     --with-shlib-version=XXX
1147         Specify whether to use the release or ABI version for shared libraries.
1148         This is normally chosen automatically based on the type of system
1149         which you are building on.  We use it for testing the configure script.
1150
1151     --with-sysmouse
1152         use FreeBSD sysmouse interface provide mouse support on the console.
1153
1154     --with-system-type=XXX
1155         For testing, override the derived host system-type which is used to
1156         decide things such as the linker commands used to build shared
1157         libraries.  This is normally chosen automatically based on the type of
1158         system which you are building on.  We use it for testing the configure
1159         script.
1160
1161     --with-terminfo-dirs=XXX
1162         Specify a search-list of terminfo directories which will be compiled
1163         into the ncurses library (default: DATADIR/terminfo)
1164
1165         This is a colon-separated list, like the TERMINFO_DIRS environment
1166         variable.
1167
1168     --with-termlib[=XXX]
1169         When building the ncurses library, organize this as two parts:  the
1170         curses library (libncurses) and the low-level terminfo library
1171         (libtinfo).  This is done to accommodate applications that use only
1172         the latter.  The terminfo library is about half the size of the total.
1173
1174         If an option value is given, that overrides the name of the terminfo
1175         library.  For instance, if the wide-character version is built, the
1176         terminfo library would be named libtinfow.  But the libtinfow interface
1177         is upward compatible from libtinfo, so it would be possible to overlay
1178         libtinfo.so with a "wide" version of libtinfow.so by renaming it with
1179         this option.
1180
1181     --with-termpath=XXX
1182         Specify a search-list of termcap files which will be compiled into the
1183         ncurses library (default:  /etc/termcap:/usr/share/misc/termcap)
1184
1185     --with-tic-path[=XXX]
1186         Use this option to override the automatic detection of tic in your
1187         $PATH when building fallbacks (see "--with-fallbacks").
1188
1189     --with-ticlib[=XXX]
1190         When building the ncurses library, build a separate library for
1191         the modules that are used only by the utility programs.  Normally
1192         those would be bundled with the termlib or ncurses libraries.
1193
1194         If an option value is given, that overrides the name of the tic
1195         library.  As in termlib, there is no ABI difference between the
1196         "wide" libticw.so and libtic.so
1197
1198         NOTE: Overriding the name of the tic library may be useful if you are
1199         also using the --with-termlib option to rename libtinfo.  If you are
1200         not doing that, renaming the tic library can result in conflicting
1201         library dependencies for tic and other programs built with the tic
1202         library.
1203
1204     --with-tparm-arg[=XXX]
1205         Override the type used for tparm() arguments, which normally is a
1206         "long".  However the function must assume that its arguments can hold a
1207         pointer to char's which is not always workable for 64-bit platforms.  A
1208         better choice would be intptr_t, which was not available at the time
1209         tparm's interface was defined.
1210
1211         If the option is not given, this defaults to "long".
1212
1213     --with-trace
1214         Configure the trace() function as part of the all models of the ncurses
1215         library.  Normally it is part of the debug (libncurses_g) library only.
1216
1217     --with-valgrind
1218         For testing, compile with debug option.
1219         This also sets the --disable-leaks option.
1220
1221     --with-versioned-syms[=XXX]
1222         The Solaris, GNU and reportedly some other linkers (ld) accept a
1223         "--version-script" option which tells the linker to annotate the
1224         resulting objects with version identifiers.
1225
1226         Use "objdump -T" on a library to see the annotations.
1227
1228         The configure script attempts to automatically apply a suitable ".map"
1229         file to provide this information for Linux.  Solaris mapfiles differ:
1230
1231         a) comments are not accepted
1232         b) wildcards are not accepted, except for a special case of "_*".
1233         c) each symbol listed in the map file must exist in the library
1234
1235         The Solaris limitations conflict with the development goal of providing
1236         a small set of ".map" files as examples, which cover the most common
1237         configurations.  Because that coverage is done by merging together
1238         several builds, some symbols will be listed in the the ".map" files
1239         that do not happen to be present in one configuration or another.
1240
1241         The sample ".map" (and ".sym") files are generated using a set of
1242         scripts which build several configurations for each release version,
1243         checking to see which of the "_nc_" symbols can be made local.  In
1244         addition to the ncurses libraries and programs, the symbols used
1245         by the "tack" program before version 1.08 are made global.
1246
1247         These sample ".map" files will not cover all possible combinations.
1248         In some cases, e.g., when using the --with-weak-symbols option, you
1249         may prefer to use a different ".map" file by setting this option's
1250         value.
1251
1252     --with-wrap-prefix=XXX
1253         When using the --enable-reentrant option, ncurses redefines variables
1254         that would be global in curses, e.g., LINES, as a macro that calls a
1255         "wrapping" function which fetches the data from the current SCREEN
1256         structure.  Normally that function is named by prepending "_nc_" to the
1257         variable's name.  The function is technically private (since portable
1258         applications would not refer directly to it).  But according to one
1259         line of reasoning, it is not the same type of "private" as functions
1260         which applications should not call even via a macro.  This configure
1261         option lets you choose the prefix for these wrapped variables.
1262
1263     --with-x11-rgb=FILE
1264         Provide a pathname for the X11 rgb file, used by the picsmap program.
1265         This overrides a configure check which usually works, but is needed
1266         due to the lack of standardization for X11's files.
1267
1268     --with-xterm-kbs=XXX
1269         Configure xterm's terminfo entries to use either BS (^H, i.e., ASCII
1270         backspace) or DEL (^?, or 127).  XXX can be BS (or bs, 8) or DEL
1271         (or del, 127).
1272
1273         During installation, the makefile and scripts modifies the "xterm+kbs"
1274         terminfo entry to use this setting.
1275
1276     --without-ada
1277         Suppress the configure script's check for Ada95, do not build the
1278         Ada95 binding and related demo.
1279
1280     --without-curses-h
1281         Don't install the ncurses header with the name "curses.h".  Rather,
1282         install as "ncurses.h" and modify the installed headers and manpages
1283         accordingly.
1284
1285         Likewise, do not install an alias "curses" for the ncurses manpage.
1286
1287     --without-cxx
1288         XSI curses declares "bool" as part of the interface.  C++ also declares
1289         "bool".  Neither specifies the size and type of booleans, but both
1290         insist on the same name.  We chose to accommodate this by making the
1291         configure script check for the size and type (e.g., unsigned or signed)
1292         that your C++ compiler uses for booleans.  If you do not wish to use
1293         ncurses with C++, use this option to tell the configure script to not
1294         adjust ncurses bool to match C++.
1295
1296     --without-cxx-binding
1297         Suppress the configure script's check for C++, do not build the
1298         C++ binding and related demo.
1299
1300     --without-develop
1301         Disable development options.  This does not include those that change
1302         the interface, such as --enable-widec.
1303
1304     --without-dlsym
1305         Do not use dlsym() to load GPM dynamically.
1306
1307     --without-manpages
1308         Tell the configure script to suppress the install of ncurses' manpages.
1309
1310     --without-progs
1311         Tell the configure script to suppress the build of ncurses' application
1312         programs (e.g., tic).  The test applications will still be built if you
1313         type "make", though not if you simply do "make install".
1314
1315     --without-tack
1316         Suppress build/install with tack program, if it happens to be
1317         in the same build-tree (tack was moved out of the ncurses source-tree
1318         in 20070203).
1319
1320     --without-tests
1321         Tell the configure script to suppress the build of ncurses' test
1322         programs.
1323
1324     --without-xterm-new
1325         Tell the configure script to use "xterm-old" for the entry used in
1326         the terminfo database.  This will work with variations such as
1327         X11R5 and X11R6 xterm.
1328
1329
1330 COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
1331 --------------------------------------------
1332
1333     Because ncurses implements X/Open Curses, its interface is fairly stable.
1334     That does not mean the interface does not change.  Changes are made to the
1335     documented interfaces when we find differences between ncurses and X/Open
1336     or implementations which largely correspond to X/Open (such as Solaris).
1337     We add extensions to those interfaces to solve problems not addressed by
1338     the original curses design, but those must not conflict with the X/Open
1339     documentation.
1340
1341     Here are some of the major interface changes, and related problems which
1342     you may encounter when building a system with different versions of
1343     ncurses:
1344
1345     6.1 (Jan 27, 2018)
1346         Interface changes:
1347
1348         + X/Open Curses specifies a "reserved" void* parameter in several
1349           functions, saying that it must be NULL.  In this release, if the
1350           parameter is non-NULL, it is interpreted as a point to an integer
1351           containing a color pair.  In previous releases, a non-NULL parameter
1352           caused an error return.  Portable applications are unaffected.  Here
1353           are the functions which have been extended:
1354                 attr_get
1355                 attr_off
1356                 attr_on
1357                 attr_set
1358                 chgat
1359                 color_set
1360                 mvchgat
1361                 mvwchgat
1362                 slk_attr_off
1363                 slk_attr_on
1364                 slk_attr_set
1365                 wattr_get
1366                 wattr_on
1367                 wattr_off
1368                 wattr_set
1369                 wchgat
1370                 wcolor_set
1371
1372         + the TERMINAL structure declared in <term.h> has been made opaque,
1373           and its size increased to handle the increased size of color pair
1374           and color value, as well as other numeric capabilities.
1375
1376           A few applications required change, e.g., to use def_prog_mode;
1377           only one application (tack) is known to have a valid reason for
1378           accessing these internal details, and that was addressed by the
1379           release of tack 1.08 in 2017.  Internal functions marked as used
1380           by tack will be deprecated in future releases.
1381
1382         Added extensions:
1383
1384         + Several new functions were added to manipulate extended color pairs
1385           and color values.  These include:
1386                 alloc_pair
1387                 extended_color_content
1388                 extended_pair_content
1389                 extended_slk_color
1390                 find_pair
1391                 free_pair
1392                 init_extended_color
1393                 init_extended_pair
1394                 reset_color_pairs
1395
1396           as well as corresponding sp-functions.
1397
1398         + A new terminfo capability "RGB" tells the ncurses library that the
1399           color values are red/green/blue, to eliminate the need for palettes
1400           in that special case for the color_content function.
1401
1402         Added internal functions (other than "_sp" variants):
1403                 _nc_copy_termtype2
1404                 _nc_export_termtype2
1405                 _nc_fallback2
1406                 _nc_find_prescr
1407                 _nc_forget_prescr
1408                 _nc_free_termtype2
1409                 _nc_read_entry2
1410                 _nc_write_object
1411
1412         Removed internal functions:
1413                 _nc_check_termtype
1414                 _nc_resolve_uses
1415
1416         Modified internal functions:
1417
1418         + symbols are used by tic/infocmp/toe:
1419                 _nc_align_termtype - change parameters to TERMTYPE2*
1420                 _nc_check_termtype2 - change parameter to TERMTYPE2*
1421                 _nc_read_file_entry - change parameter to TERMTYPE2*
1422                 _nc_read_termtype - change parameter to TERMTYPE2*
1423                 _nc_trim_sgr0 - change parameter to TERMTYPE2*
1424                 _nc_write_entry - change parameter to TERMTYPE2*
1425
1426         + symbols used only within the library:
1427                 _nc_fallback - change return type to TERMTYPE2*
1428                 _nc_init_termtype - change parameter to TERMTYPE2*
1429
1430     6.0 (Aug 08, 2015)
1431         Interface changes:
1432
1433         + The 6.0 ABI modifies the defaults for these configure options:
1434            --enable-const
1435            --enable-ext-colors
1436            --enable-ext-mouse
1437            --enable-ext-putwin
1438            --enable-interop
1439            --enable-lp64
1440            --enable-sp-funcs
1441            --with-chtype=uint32_t
1442            --with-mmask_t=uint32_t
1443            --with-tparm-arg=intptr_t
1444
1445         + ncurses supports symbol versioning.  If you use this feature, about
1446           half of the "_nc_" private symbols are changed to local symbols.
1447
1448         + a few applications may need to explicitly flush the standard output
1449           when switching between printf's and (curses) printw.
1450
1451         Added extensions:
1452
1453         + use_tioctl is an improvement over use_env
1454
1455         + added wgetdelay to support the NCURSES_OPAQUE feature.
1456
1457         Added internal functions (other than "_sp" variants):
1458                 _nc_init_termtype
1459                 _nc_mvcur
1460                 _nc_putchar
1461                 _nc_setenv_num
1462                 _nc_trace_mmask_t
1463
1464         Removed internal functions:
1465                 none
1466
1467         Modified internal functions:
1468                 _nc_do_color - change parameters from short/bool to int
1469                 _nc_keypad - change parameter from bool to int
1470                 _nc_setupscreen - change parameter from bool to int
1471                 _nc_signal_handler - change parameter from bool to int
1472
1473     5.9 (Apr 04, 2011)
1474     5.8 (Feb 26, 2011)
1475         Interface changes:
1476
1477         + add an alternate library configuration, i.e., "terminal driver" to
1478           support port to Windows, built with MinGW.  There are two drivers
1479           (terminfo and Windows console).  The terminfo driver works on other
1480           platforms.
1481
1482         + add a new set of functions which accept a SCREEN* parameter, in
1483           contrast with the original set which use the global value "sp".
1484           By default, these names end with "_sp", and are otherwise
1485           functionally identical with the originals.
1486
1487           In addition to the "_sp" functions, there are a few new functions
1488           associated with this feature:  ceiling_panel, ground_panel,
1489           new_prescr.
1490
1491           If the library is not built with the sp-funcs extension, there
1492           are no related interface changes.
1493
1494         + add tiparm function based on review of X/Open Curses Issue 7.
1495
1496         + change internal _nc_has_mouse function to public has_mouse function
1497
1498         Added extensions:
1499
1500         + add a few more functions to support the NCURSES_OPAQUE feature:
1501           get_escdelay, is_pad, is_subwin
1502
1503         Added internal functions (other than "_sp" variants):
1504                 _nc_curscr_of
1505                 _nc_format_slks
1506                 _nc_get_alias_table
1507                 _nc_get_hash_info
1508                 _nc_insert_wch
1509                 _nc_newscr_of
1510                 _nc_outc_wrapper
1511                 _nc_retrace_char
1512                 _nc_retrace_int_attr_t
1513                 _nc_retrace_mmask_t
1514                 _nc_setup_tinfo
1515                 _nc_stdscr_of
1516                 _nc_tinfo_cmdch
1517
1518         Removed internal functions:
1519                 _nc_makenew (some configurations replace by _nc_makenew_sp)
1520
1521         Modified internal functions:
1522                 _nc_UpdateAttrs
1523                 _nc_get_hash_table
1524                 _nc_has_mouse
1525                 _nc_insert_ch
1526                 _nc_wgetch
1527
1528     5.7 (November 2, 2008)
1529         Interface changes:
1530
1531         + generate linkable stubs for some macros:
1532                 getattrs
1533
1534         + Add new library configuration for tic-library (the non-curses portion
1535           of the ncurses library used for the tic program as well as some
1536           others such as tack.  There is no API change, but makefiles would be
1537           changed to use the tic-library built separately.
1538
1539           tack, distributed separately from ncurses, uses some of the internal
1540           _nc_XXX functions, which are declared in the tic.h header file.
1541
1542           The reason for providing this separate library is that none of the
1543           functions in it are suitable for threaded applications.
1544
1545         + Add new library configuration (ncursest, ncurseswt) which provides
1546           rudimentary support for POSIX threads.  This introduces opaque
1547           access functions to the WINDOW structure and adds a parameter to
1548           several internal functions.
1549
1550         + move most internal variables (except tic-library) into data blocks
1551           _nc_globals and _nc_prescreen to simplify analysis.  Those were
1552           globally accessible, but since they were not part of the documented
1553           API, there is no ABI change.
1554
1555         + changed static tables of strings to be indices into long strings, to
1556           improve startup performance.  This changes parameter lists for some
1557           of the internal functions.
1558
1559         Added extensions:
1560
1561         + add NCURSES_OPAQUE definition in curses.h to control whether internal
1562           details of the WINDOW structure are visible to an application.  This
1563           is always defined when the threaded library is built, and is optional
1564           otherwise.  New functions for this:  is_cleared, is_idcok, is_idlok,
1565           is_immedok, is_keypad, is_leaveok, is_nodelay, is_notimeout,
1566           is_scrollok, is_syncok, wgetparent and wgetscrreg.
1567
1568         + the threaded library (ncursest) also disallows direct updating of
1569           global curses-level variables, providing functions (via macros) for
1570           obtaining their value.  A few of those variables can be modified by
1571           the application, using new functions:  set_escdelay, set_tabsize
1572
1573         + added functions use_window() and use_screen() which wrap a mutex
1574           (if threading is configured) around a call to a user-supplied
1575           function.
1576
1577         Added internal functions:
1578                 _nc_get_alias_table
1579                 _nc_get_screensize
1580                 _nc_keyname
1581                 _nc_screen_of
1582                 _nc_set_no_padding
1583                 _nc_tracechar
1584                 _nc_tracemouse
1585                 _nc_unctrl
1586                 _nc_ungetch
1587
1588                 These are used for leak-testing, and are stubs for
1589                 ABI compatibility when ncurses is not configured for that
1590                 using the --disable-leaks configure script option:
1591
1592                 _nc_free_and_exit
1593                 _nc_leaks_tinfo
1594
1595         Removed internal functions:
1596                 none
1597
1598         Modified internal functions:
1599                 _nc_fifo_dump
1600                 _nc_find_entry
1601                 _nc_handle_sigwinch
1602                 _nc_init_keytry
1603                 _nc_keypad
1604                 _nc_locale_breaks_acs
1605                 _nc_timed_wait
1606                 _nc_update_screensize
1607
1608                 Use new typedef TRIES to replace "struct tries":
1609
1610                 _nc_add_to_try
1611                 _nc_expand_try
1612                 _nc_remove_key
1613                 _nc_remove_string
1614                 _nc_trace_tries
1615
1616     5.6 (December 17, 2006)
1617         Interface changes:
1618
1619         + generate linkable stubs for some macros:
1620
1621           getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, getparx,
1622           getpary, getpary,
1623
1624           and (for libncursesw)
1625
1626           wgetbkgrnd
1627
1628         Added extensions:
1629                 nofilter()
1630                 use_legacy_coding()
1631
1632         Added internal functions:
1633                 _nc_first_db
1634                 _nc_get_source
1635                 _nc_handle_sigwinch
1636                 _nc_is_abs_path
1637                 _nc_is_dir_path
1638                 _nc_is_file_path
1639                 _nc_keep_tic_dir
1640                 _nc_keep_tic_dir
1641                 _nc_last_db
1642                 _nc_next_db
1643                 _nc_read_termtype
1644                 _nc_tic_dir
1645
1646                 Also (if using the hashed database configuration):
1647
1648                 _nc_db_close
1649                 _nc_db_first
1650                 _nc_db_get
1651                 _nc_db_have_data
1652                 _nc_db_have_index
1653                 _nc_db_next
1654                 _nc_db_open
1655                 _nc_db_put
1656
1657                 otherwise
1658
1659                 _nc_hashed_db
1660
1661         Removed internal functions:
1662                 none
1663
1664         Modified internal functions:
1665                 _nc_add_to_try
1666                 _nc_do_color
1667                 _nc_expand_try
1668                 _nc_remove_key
1669                 _nc_setupscreen
1670
1671     5.5 (October 10, 2005)
1672         Interface changes:
1673
1674         + terminfo installs "xterm-new" as "xterm" entry rather than
1675           "xterm-old" (aka xterm-r6).
1676
1677         + terminfo data is installed using the tic -x option (few systems
1678           still use ncurses 4.2).
1679
1680         + modify C++ binding to work with newer C++ compilers by providing
1681           initializers and using modern casts.  Old-style header names are
1682           still used in this release to allow compiling with not-so-old
1683           compilers.
1684
1685         + form and menu libraries now work with wide-character data.
1686           Applications which bypassed the form library and manipulated the
1687           FIELD.buf data directly will not work properly with libformw, since
1688           that no longer points to an array of char.  The set_field_buffer()
1689           and field_buffer() functions translate to/from the actual field
1690           data.
1691
1692         + change SP->_current_attr to a pointer, adjust ifdef's to ensure that
1693           libtinfo.so and libtinfow.so have the same ABI.  The reason for this
1694           is that the corresponding data which belongs to the upper-level
1695           ncurses library has a different size in each model.
1696
1697         + winnstr() now returns multibyte character strings for the
1698           wide-character configuration.
1699
1700         + assume_default_colors() no longer requires that use_default_colors()
1701           be called first.
1702
1703         + data_ahead() now works with wide-characters.
1704
1705         + slk_set() and slk_wset() now accept and store multibyte or
1706           multicolumn characters.
1707
1708         + start_color() now returns OK if colors have already been started.
1709           start_color() also returns ERR if it cannot allocate memory.
1710
1711         + pair_content() now returns -1 for consistency with init_pair() if it
1712           corresponds to the default-color.
1713
1714         + unctrl() now returns null if its parameter does not correspond
1715           to an unsigned char.
1716
1717         Added extensions:
1718                 Experimental mouse version 2 supports wheel mice with buttons
1719                 4 and 5.  This requires ABI 6 because it modifies the encoding
1720                 of mouse events.
1721
1722                 Experimental extended colors allows encoding of 256 foreground
1723                 and background colors, e.g., with the xterm-256color or
1724                 xterm-88color terminfo entries.  This requires ABI 6 because
1725                 it changes the size of cchar_t.
1726
1727         Added internal functions:
1728                 _nc_check_termtype2
1729                 _nc_resolve_uses2
1730                 _nc_retrace_cptr
1731                 _nc_retrace_cvoid_ptr
1732                 _nc_retrace_void_ptr
1733                 _nc_setup_term
1734
1735         Removed internal functions:
1736                 none
1737
1738         Modified internal functions:
1739                 _nc_insert_ch
1740                 _nc_save_str
1741                 _nc_trans_string
1742
1743     5.4 (February 8, 2004)
1744         Interface changes:
1745
1746         + add the remaining functions for X/Open curses wide-character support.
1747           These are only available if the library is configured using the
1748           --enable-widec option.
1749                 pecho_wchar()
1750                 slk_wset()
1751
1752         + write getyx() and related 2-return macros in terms of getcury(),
1753           getcurx(), etc.
1754
1755         + simplify ifdef for bool declaration in curses.h
1756
1757         + modify ifdef's in curses.h that disabled use of __attribute__() for
1758           g++, since recent versions implement the cases which ncurses uses.
1759
1760         + change some interfaces to use const:
1761                 define_key()
1762                 mvprintw()
1763                 mvwprintw()
1764                 printw()
1765                 vw_printw()
1766                 winsnstr()
1767                 wprintw()
1768
1769         Added extensions:
1770                 key_defined()
1771
1772         Added internal functions:
1773                 _nc_get_locale()
1774                 _nc_insert_ch()
1775                 _nc_is_charable()       wide
1776                 _nc_locale_breaks_acs()
1777                 _nc_pathlast()
1778                 _nc_to_char()           wide
1779                 _nc_to_widechar()       wide
1780                 _nc_tparm_analyze()
1781                 _nc_trace_bufcat()      debug
1782                 _nc_unicode_locale()
1783
1784         Removed internal functions:
1785                 _nc_outstr()
1786                 _nc_sigaction()
1787
1788         Modified internal functions:
1789                 _nc_remove_string()
1790                 _nc_retrace_chtype()
1791
1792     5.3 (October 12, 2002)
1793         Interface changes:
1794
1795         + change type for bool used in headers to NCURSES_BOOL, which usually
1796           is the same as the compiler's definition for 'bool'.
1797
1798         + add all but two functions for X/Open curses wide-character support.
1799           These are only available if the library is configured using the
1800           --enable-widec option.  Missing functions are
1801                 pecho_wchar()
1802                 slk_wset()
1803
1804         + add environment variable $NCURSES_ASSUMED_COLORS to modify the
1805           assume_default_colors() extension.
1806
1807         Added extensions:
1808                 is_term_resized()
1809                 resize_term()
1810
1811         Added internal functions:
1812                 _nc_altcharset_name()   debug
1813                 _nc_reset_colors()
1814                 _nc_retrace_bool()      debug
1815                 _nc_retrace_unsigned()  debug
1816                 _nc_rootname()
1817                 _nc_trace_ttymode()     debug
1818                 _nc_varargs()           debug
1819                 _nc_visbufn()           debug
1820                 _nc_wgetch()
1821
1822         Removed internal functions:
1823                 _nc_background()
1824
1825         Modified internal functions:
1826                 _nc_freeall()           debug
1827
1828     5.2 (October 21, 2000)
1829         Interface changes:
1830
1831         + revert termcap ospeed variable to 'short' (see discussion of the
1832           --with-ospeed configure option).
1833
1834     5.1 (July 8, 2000)
1835         Interface changes:
1836
1837         + made the extended terminal capabilities
1838           (configure --enable-tcap-names) a standard feature.  This should
1839           be transparent to applications that do not require it.
1840
1841         + removed the trace() function and related trace support from the
1842           production library.
1843
1844         + modified curses.h.in, undef'ing some symbols to avoid conflict
1845           with C++ STL.
1846
1847         Added extensions:  assume_default_colors().
1848
1849     5.0 (October 23, 1999)
1850         Interface changes:
1851
1852         + implemented the wcolor_set() and slk_color() functions.
1853
1854         + move macro winch to a function, to hide details of struct ldat
1855
1856         + corrected prototypes for slk_* functions, using chtype rather than
1857           attr_t.
1858
1859         + the slk_attr_{set,off,on} functions need an additional void*
1860           parameter according to XSI.
1861
1862         + modified several prototypes to correspond with 1997 version of X/Open
1863           Curses:  [w]attr_get(), [w]attr_set(), border_set() have different
1864           parameters.  Some functions were renamed or misspelled:
1865           erase_wchar(), in_wchntr(), mvin_wchntr().  Some developers have used
1866           attr_get().
1867
1868         Added extensions:  keybound(), curses_version().
1869
1870         Terminfo database changes:
1871
1872         + change translation for termcap 'rs' to terminfo 'rs2', which is
1873           the documented equivalent, rather than 'rs1'.
1874
1875         The problems are subtler in recent releases.
1876
1877         a) This release provides users with the ability to define their own
1878            terminal capability extensions, like termcap.  To accomplish this,
1879            we redesigned the TERMTYPE struct (in term.h).  Very few
1880            applications use this struct.  They must be recompiled to work with
1881            the 5.0 library.
1882
1883         a) If you use the extended terminfo names (i.e., you used configure
1884            --enable-tcap-names), the resulting terminfo database can have some
1885            entries which are not readable by older versions of ncurses.  This
1886            is a bug in the older versions:
1887
1888            + the terminfo database stores booleans, numbers and strings in
1889              arrays.  The capabilities that are listed in the arrays are
1890              specified by X/Open.  ncurses recognizes a number of obsolete and
1891              extended names which are stored past the end of the specified
1892              entries.
1893
1894            + a change to read_entry.c in 951001 made the library do an lseek()
1895              call incorrectly skipping data which is already read from the
1896              string array.  This happens when the number of strings in the
1897              terminfo data file is greater than STRCOUNT, the number of
1898              specified and obsolete or extended strings.
1899
1900            + as part of alignment with the X/Open final specification, in the
1901              990109 patch we added two new terminfo capabilities:
1902              set_a_attributes and set_pglen_inch).  This makes the indices for
1903              the obsolete and extended capabilities shift up by 2.
1904
1905            + the last two capabilities in the obsolete/extended list are memu
1906              and meml, which are found in most terminfo descriptions for xterm.
1907
1908              When trying to read this terminfo entry, the spurious lseek()
1909              causes the library to attempt to read the final portion of the
1910              terminfo data (the text of the string capabilities) 4 characters
1911              past its starting point, and reads 4 characters too few.  The
1912              library rejects the data, and applications are unable to
1913              initialize that terminal type.
1914
1915            FIX: remove memu and meml from the xterm description.  They are
1916            obsolete, not used by ncurses.  (It appears that the feature was
1917            added to xterm to make it more like hpterm).
1918
1919            This is not a problem if you do not use the -x option of tic to
1920            create a terminfo database with extended names.  Note that the
1921            user-defined terminal capabilities are not affected by this bug,
1922            since they are stored in a table after the older terminfo data ends,
1923            and are invisible to the older libraries.
1924
1925         c) Some developers did not wish to use the C++ binding, and used the
1926            configure --without-cxx option.  This causes problems if someone
1927            uses the ncurses library from C++ because that configure test
1928            determines the type for C++'s bool and makes ncurses match it, since
1929            both C++ and curses are specified to declare bool.  Calling ncurses
1930            functions with the incorrect type for bool will cause execution
1931            errors.  In 5.0 we added a configure option "--without-cxx-binding"
1932            which controls whether the binding itself is built and installed.
1933
1934     4.2 (March 2, 1998)
1935         Interface changes:
1936
1937         + correct prototype for termattrs() as per XPG4 version 2.
1938
1939         + add placeholder prototypes for color_set(), erasewchar(),
1940           term_attrs(), wcolor_set() as per XPG4 version 2.
1941
1942         + add macros getcur[xy] getbeg[xy] getpar[xy], which are defined in
1943           SVr4 headers.
1944
1945         New extensions: keyok() and define_key().
1946
1947         Terminfo database changes:
1948
1949         + corrected definition in curses.h for ACS_LANTERN, which was 'I'
1950           rather than 'i'.
1951
1952     4.1 (May 15, 1997)
1953
1954         We added these extensions:  use_default_colors().  Also added
1955         configure option --enable-const, to support the use of const where
1956         X/Open should have, but did not, specify.
1957
1958         The terminfo database content changed the representation of color for
1959         most entries that use ANSI colors.  SVr4 curses treats the setaf/setab
1960         and setf/setb capabilities differently, interchanging the red/blue
1961         colors in the latter.
1962
1963     4.0 (December 24, 1996)
1964
1965         We bumped to version 4.0 because the newly released Linux dynamic
1966         loader (ld.so.1.8.5) did not load shared libraries whose ABI and REL
1967         versions were inconsistent.  At that point, ncurses ABI was 3.4 and the
1968         REL was 1.9.9g, so we made them consistent.
1969
1970     1.9.9g (December 1, 1996)
1971
1972         This fixed most of the problems with 1.9.9e, and made these interface
1973         changes:
1974
1975         + remove tparam(), which had been provided for compatibility with
1976           some termcap.  tparm() is standard, and does not conflict with
1977           application's fallback for missing tparam().
1978
1979         + turn off hardware echo in initscr().  This changes the sense of the
1980           echo() function, which was initialized to echoing rather than
1981           nonechoing (the latter is specified).  There were several other
1982           corrections to the terminal I/O settings which cause applications to
1983           behave differently.
1984
1985         + implemented several functions (such as attr_on()) which were
1986           available only as macros.
1987
1988         + corrected several typos in curses.h.in (i.e., the mvXXXX macros).
1989
1990         + corrected prototypes for delay_output(),
1991           has_color, immedok() and idcok().
1992
1993         + corrected misspelled getbkgd().  Some applications used the
1994           misspelled name.
1995
1996         + added _yoffset to WINDOW.  The size of WINDOW does not impact
1997           applications, since they use only pointers to WINDOW structs.
1998
1999         These changes were made to the terminfo database:
2000
2001         + removed boolean 'getm' which was available as an extended name.
2002
2003         We added these extensions: wresize(), resizeterm(), has_key() and
2004         mcprint().
2005
2006     1.9.9e (March 24, 1996)
2007
2008         not recommended (a last-minute/untested change left the forms and
2009         menus libraries unusable since they do not repaint the screen).
2010         Foreground/background colors are combined incorrectly, working properly
2011         only on a black background.  When this was released, the X/Open
2012         specification was available only in draft form.
2013
2014         Some applications (such as lxdialog) were "fixed" to work with the
2015         incorrect color scheme.
2016
2017
2018 IF YOU ARE A SYSTEM INTEGRATOR:
2019 ------------------------------
2020
2021     Configuration and Installation:
2022
2023         On platforms where ncurses is assumed to be installed in /usr/lib,
2024         the configure script uses "/usr" as a default.  These include any
2025         that use the Linux kernel, as well as these special cases:
2026
2027                 FreeBSD, NetBSD, OpenBSD, Cygwin, MinGW
2028
2029         For other platforms, the default is "/usr/local".  See the discussion
2030         of the "--disable-overwrite" option.
2031
2032         The location of the terminfo is set indirectly by the "--datadir"
2033         configure option, e.g., /usr/share/terminfo, given a datadir of
2034         /usr/share.  You may want to override this if you are installing
2035         ncurses libraries in nonstandard locations, but wish to share the
2036         terminfo database.
2037
2038         Normally the ncurses library is configured in a pure-terminfo mode;
2039         that is, with the --disable-termcap option.  This makes the ncurses
2040         library smaller and faster.  The ncurses library includes a termcap
2041         emulation that queries the terminfo database, so even applications that
2042         use raw termcap to query terminal characteristics will win (providing
2043         you recompile and relink them!).
2044
2045         If you must configure with termcap fallback enabled, you may also wish
2046         to use the --enable-getcap option.  This speeds up termcap-based
2047         startups, at the expense of not allowing personal termcap entries to
2048         reference the terminfo tree.  See comments in
2049         ncurses/tinfo/read_termcap.c for further details.
2050
2051         Note that if you have $TERMCAP set, ncurses will use that value
2052         to locate termcap data.  In particular, running from xterm will
2053         set $TERMCAP to the contents of the xterm's termcap entry.
2054         If ncurses sees that, it will not examine /etc/termcap.
2055
2056     Keyboard Mapping:
2057
2058         The terminfo file assumes that Shift-Tab generates \E[Z (the ECMA-48
2059         reverse-tabulation sequence) rather than ^I.  Here are the loadkeys -d
2060         mappings that will set this up:
2061
2062                 keycode  15 = Tab             Tab
2063                         alt     keycode  15 = Meta_Tab
2064                         shift   keycode  15 = F26
2065                 string F26 ="\033[Z"
2066
2067     Naming the Console Terminal
2068
2069         In various systems there has been a practice of designating the system
2070         console driver type as `console'.  Please do not do this!  It
2071         complicates peoples' lives, because it can mean that several different
2072         terminfo entries from different operating systems all logically want to
2073         be called `console'.
2074
2075         Please pick a name unique to your console driver and set that up
2076         in the /etc/inittab table or local equivalent.  Send the entry to the
2077         terminfo maintainer (listed in the misc/terminfo file) to be included
2078         in the terminfo file, if it's not already there.  See the
2079         term(7) manual page included with this distribution for more on
2080         conventions for choosing type names.
2081
2082         Here are some recommended primary console names:
2083
2084                 linux   -- Linux console driver
2085                 freebsd -- FreeBSD
2086                 netbsd  -- NetBSD
2087                 bsdos   -- BSD/OS
2088
2089         If you are responsible for integrating ncurses for one of these
2090         distributions, please either use the recommended name or get back
2091         to us explaining why you don't want to, so we can work out nomenclature
2092         that will make users' lives easier rather than harder.
2093
2094
2095 RECENT XTERM VERSIONS:
2096 ---------------------
2097
2098         The terminfo database file included with this distribution assumes you
2099         are running a modern xterm based on XFree86 (i.e., xterm-new).  The
2100         earlier X11R6 entry (xterm-r6) and X11R5 entry (xterm-r5) is provided
2101         as well.  See the --without-xterm-new configure script option if you
2102         are unable to update your system.
2103
2104
2105 CONFIGURING FALLBACK ENTRIES:
2106 ----------------------------
2107
2108         In order to support operation of ncurses programs before the terminfo
2109         tree is accessible (that is, in single-user mode or at OS installation
2110         time) the ncurses library can be compiled to include an array of
2111         pre-fetched fallback entries.  This must be done on a machine which
2112         has ncurses' infocmp and terminfo database installed (as well as
2113         ncurses' tic and infocmp programs).
2114
2115         These entries are checked by setupterm() only when the conventional
2116         fetches from the terminfo tree and the termcap fallback (if configured)
2117         have been tried and failed.  Thus, the presence of a fallback will not
2118         shadow modifications to the on-disk entry for the same type, when that
2119         entry is accessible.
2120
2121         By default, there are no entries on the fallback list.  After you have
2122         built the ncurses suite for the first time, you can change the list
2123         (the process needs infocmp(1)).  To do so, use the script
2124         ncurses/tinfo/MKfallback.sh.  The configure script option
2125         --with-fallbacks does this (it accepts a comma-separated list of the
2126         names you wish, and does not require a rebuild).
2127
2128         If you wanted (say) to have linux, vt100, and xterm fallbacks, you
2129         might use the commands
2130
2131                 cd ncurses;
2132                 tinfo/MKfallback.sh \
2133                         $TERMINFO \
2134                         ../misc/terminfo.src \
2135                         `which tic` \
2136                         `which infocmp` \
2137                         linux vt100 xterm >fallback.c
2138
2139         The first four parameters of the script are normally supplied by
2140         the configured makefiles via the "--with-fallbacks" option.  They
2141         are
2142
2143                 1) the location of the terminfo database
2144                 2) the source for the terminfo entries
2145                 3) the location of the tic program, used to create a terminfo
2146                    database.
2147                 4) the location of the infocmp program, used to print a terminfo
2148                    description.
2149
2150         Then just rebuild and reinstall the library as you would normally.
2151         You can restore the default empty fallback list with
2152
2153                 tinfo/MKfallback.sh \
2154                         $TERMINFO \
2155                         ../misc/terminfo.src \
2156                         `which tic` \
2157                         `which infocmp` \
2158                         >fallback.c
2159
2160         The overhead for an empty fallback list is one trivial stub function.
2161         Any non-empty fallback list is const-ed and therefore lives in sharable
2162         text space.  You can look at the comment trailing each initializer in
2163         the generated ncurses/fallback.c file to see the core cost of the
2164         fallbacks.  A good rule of thumb for modern vt100-like entries is that
2165         each one will cost about 2.5K of text space.
2166
2167
2168 BSD CONVERSION NOTES:
2169 --------------------
2170
2171         If you need to support really ancient BSD programs, you probably
2172         want to configure with the --enable-bsdpad option.  What this does
2173         is enable code in tputs() that recognizes a numeric prefix on a
2174         capability as a request for that much trailing padding in milliseconds.
2175         There are old BSD programs that do things like tputs("50").
2176
2177         (If you are distributing ncurses as a support-library component of
2178         an application you probably want to put the remainder of this section
2179         in the package README file.)
2180
2181         The following note applies only if you have configured ncurses with
2182         --enable-termcap.
2183
2184 ------------------------------- CUT HERE --------------------------------
2185
2186 If you are installing this application privately (either because you
2187 have no root access or want to experiment with it before doing a root
2188 installation), there are a couple of details you need to be aware of.
2189 They have to do with the ncurses library, which uses terminfo rather
2190 than termcap for describing terminal characteristics.
2191
2192 Though the ncurses library is terminfo-based, it can interpret your
2193 TERMCAP variable (if present), any local termcap files you reference
2194 through it, and the system termcap file.  However, to avoid slowing
2195 down your application startup, it does this only once per terminal type!
2196
2197 The first time you load a given terminal type from your termcap
2198 database, the library initialization code will automatically write it
2199 in terminfo format to a subdirectory under $HOME/.terminfo.  After
2200 that, the initialization code will find it there and do a (much
2201 faster) terminfo fetch.
2202
2203 Usually, all this means is that your home directory will silently grow
2204 an invisible .terminfo subdirectory which will get filled in with
2205 terminfo descriptions of terminal types as you invoke them.  If anyone
2206 ever installs a global terminfo tree on your system, this will quietly
2207 stop happening and your $HOME/.terminfo will become redundant.
2208
2209 The objective of all this logic is to make converting from BSD termcap
2210 as painless as possible without slowing down your application (termcap
2211 compilation is expensive).
2212
2213 If you don't have a TERMCAP variable or custom personal termcap file,
2214 you can skip the rest of this dissertation.
2215
2216 If you *do* have a TERMCAP variable and/or a custom personal termcap file
2217 that defines a terminal type, that definition will stop being visible
2218 to this application after the first time you run it, because it will
2219 instead see the terminfo entry that it wrote to $HOME/terminfo the
2220 first time around.
2221
2222 Subsequently, editing the TERMCAP variable or personal TERMCAP file
2223 will have no effect unless you explicitly remove the terminfo entry
2224 under $HOME/terminfo.  If you do that, the entry will be recompiled
2225 from your termcap resources the next time it is invoked.
2226
2227 To avoid these complications, use infocmp(1) and tic(1) to edit the
2228 terminfo directory directly.
2229
2230 ------------------------------- CUT HERE --------------------------------
2231
2232 USING NCURSES WITH AFS:
2233         AFS treats each directory as a separate logical filesystem, you
2234         can't hard-link across them.  The --enable-symlinks option copes
2235         with this by making tic use symbolic links.
2236
2237 USING NCURSES WITH GPM:
2238         Ncurses 4.1 and up can be configured to use GPM (General Purpose Mouse)
2239         which is used with Linux console.  Be aware that GPM is commonly
2240         installed as a shared library which contains a wrapper for the curses
2241         wgetch() function (libcurses.o).  Some integrators have simplified
2242         linking applications by combining all or part of libcurses.so into the
2243         libgpm.so file, producing symbol conflicts with ncurses (specifically
2244         the wgetch function).  This was originally the BSD curses, but
2245         generally whatever curses library exists on the system.
2246
2247         You may be able to work around this problem by linking as follows:
2248
2249                 cc -o foo foo.o -lncurses -lgpm -lncurses
2250
2251         but the linker may not cooperate, producing mysterious errors.
2252         See the FAQ, as well as the discussion under the --with-gpm option:
2253
2254         https://invisible-island.net/ncurses/ncurses.faq.html#using_gpm_lib
2255
2256 BUILDING NCURSES WITH A CROSS-COMPILER
2257         Ncurses can be built with a cross-compiler.  Some parts must be built
2258         with the host's compiler since they are used for building programs
2259         (e.g., ncurses/make_hash and ncurses/make_keys) that generate tables
2260         that are compiled into the ncurses library.  The essential thing to do
2261         is set the BUILD_CC environment variable to your host's compiler, and
2262         run the configure script configuring for the cross-compiler.
2263
2264         The configure options --with-build-cc, etc., are provided to make this
2265         simpler.  Since make_hash and make_keys use only ANSI C features, it
2266         is normally not necessary to provide the other options such as
2267         --with-build-libs, but they are provided for completeness.
2268
2269         Note that all of the generated source-files which are part of ncurses
2270         will be made if you use
2271
2272                 make sources
2273
2274         This would be useful in porting to an environment which has little
2275         support for the tools used to generate the sources, e.g., sed, awk and
2276         Bourne-shell.
2277
2278         When ncurses has been successfully cross-compiled, you may want to use
2279         "make install" (with a suitable target directory) to construct an
2280         install tree.  Note that in this case (as with the --with-fallbacks
2281         option), ncurses uses the development platform's tic to do the
2282         "make install.data" portion.
2283
2284         The system's tic program is used to install the terminal database,
2285         even for cross-compiles.  For best results, the tic program should
2286         be from the most current version of ncurses.
2287
2288 BUGS:
2289         Send any feedback to the ncurses mailing list at
2290         bug-ncurses@gnu.org. To subscribe send mail to
2291         bug-ncurses-request@gnu.org with body that reads:
2292         subscribe ncurses <your-email-address-here>
2293
2294         The Hacker's Guide in the doc directory includes some guidelines
2295         on how to report bugs in ways that will get them fixed most quickly.
2296
2297 -- vile:txtmode