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