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