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