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