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