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