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