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