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