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