0571e98d261ede7dcfd49c201ddc4984669f07a5
[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.130 2008/09/27 22:04:56 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         This option does not affect linking with libtool, which uses the
609         release major/minor numbers.
610
611     --with-ada-compiler=CMD
612         Specify the Ada95 compiler command (default "gnatmake")
613
614     --with-ada-include=DIR
615         Tell where to install the Ada includes (default:
616         PREFIX/lib/ada/adainclude)
617
618     --with-ada-objects=DIR
619         Tell where to install the Ada objects (default:  PREFIX/lib/ada/adalib)
620
621     --with-bool=TYPE
622         If --without-cxx is specified, override the type used for the "bool"
623         declared in curses.h (normally the type is automatically chosen to
624         correspond with that in <stdbool.h>, or defaults to platform-specific
625         sizes).
626
627     --with-build-cc=XXX
628         If cross-compiling, specify a host C compiler, which is needed to
629         compile a few utilities which generate source modules for ncurses.
630         If you do not give this option, the configure script checks if the
631         $BUILD_CC variable is set, and otherwise defaults to gcc or cc.
632
633     --with-build-cflags=XXX
634         If cross-compiling, specify the host C compiler-flags.  You might need
635         to do this if the target compiler has unusual flags which confuse the
636         host compiler.
637
638         You can also set the environment variable $BUILD_CFLAGS rather than
639         use this option.
640
641     --with-build-cppflags=XXX
642         If cross-compiling, specify the host C preprocessor-flags.  You might
643         need to do this if the target compiler has unusual flags which confuse
644         the host compiler.
645
646         You can also set the environment variable $BUILD_CPPFLAGS rather than
647         use this option.
648
649     --with-build-ldflags=XXX
650         If cross-compiling, specify the host linker-flags.  You might need to
651         do this if the target linker has unusual flags which confuse the host
652         compiler.
653
654         You can also set the environment variable $BUILD_LDFLAGS rather than
655         use this option.
656
657     --with-build-libs=XXX
658         If cross-compiling, the host libraries.  You might need to do this if
659         the target environment requires unusual libraries.
660
661         You can also set the environment variable $BUILD_LIBS rather than
662         use this option.
663
664     --with-caps=XXX
665         Specify an alternate terminfo capabilities file, which makes the
666         configure script look for "include/Caps.XXX".  A few systems, e.g.,
667         AIX 4.x use the same overall file-format as ncurses for terminfo
668         data, but use different alignments within the tables to support
669         legacy applications.  For those systems, you can configure ncurses
670         to use a terminfo database which is compatible with the native
671         applications.
672
673     --with-chtype=TYPE
674         Override type of chtype, which stores the video attributes and (if
675         --enable-widec is not given) a character.  Prior to ncurses 5.5, this
676         was always unsigned long, but with ncurses 5.5, it may be unsigned.
677         Use this option if you need to preserve compatibility with 64-bit
678         executables.
679
680     --with-database=XXX
681         Specify the terminfo source file to install.  Usually you will wish
682         to install ncurses' default (misc/terminfo.src).  Certain systems
683         have special requirements, e.g, OS/2 EMX has a customized terminfo
684         source file.
685
686     --with-dbmalloc
687         For testing, compile and link with Conor Cahill's dbmalloc library.
688         This also sets the --disable-leaks option.
689
690     --with-debug
691         Generate debug-libraries (default).  These are named by adding "_g"
692         to the root, e.g., libncurses_g.a
693
694     --with-default-terminfo-dir=XXX
695         Specify the default terminfo database directory.  This is normally
696         DATADIR/terminfo, e.g., /usr/share/terminfo.
697
698     --with-dmalloc
699         For testing, compile and link with Gray Watson's dmalloc library.
700         This also sets the --disable-leaks option.
701
702     --with-fallbacks=XXX
703         Specify a list of fallback terminal descriptions which will be
704         compiled into the ncurses library.  See CONFIGURING FALLBACK ENTRIES.
705
706     --with-gpm
707         use Alessandro Rubini's GPM library to provide mouse support on the
708         Linux console.  Prior to ncurses 5.5, this introduced a dependency on
709         the GPM library.
710         
711         Currently ncurses uses the dlsym() function to bind to the library at
712         runtime, so it is only necessary that the library be present when
713         ncurses is built, to obtain the filename (or soname) used in the
714         corresponding dlopen() call.  If you give a value for this option,
715         e.g.,
716
717                 --with-gpm=$HOME/tmp/test-gpm.so
718
719         that overrides the configure check for the soname.
720
721         See also --without-dlsym
722
723     --with-hashed-db[=XXX]
724         Use a hashed database for storing terminfo data rather than storing
725         each compiled entry in a separate binary file within a directory
726         tree.
727         
728         In particular, this uses the Berkeley database 1.8.5 interface, as
729         provided by that and its successors db 2, 3, and 4.  The actual
730         interface is slightly different in the successor versions of the
731         Berkeley database.  The database should have been configured using
732         "--enable-compat185".
733
734         If you use this option for configuring ncurses, tic will only be able
735         to write entries in the hashed database.  infocmp can still read
736         entries from a directory tree as well as reading entries from the
737         hashed database.  To do this, infocmp determines whether the $TERMINFO
738         variable points to a directory or a file, and reads the directory-tree
739         or hashed database respectively.
740
741         You cannot have a directory containing both hashed-database and
742         filesystem-based terminfo entries.
743
744         Use the parameter value to give the install-prefix used for the
745         datbase, e.g.,
746                 --with-hashed-db=/usr/local/BigBase
747         to find the corresponding include- and lib-directories under the
748         given directory.
749
750         See also the --enable-getcap option.
751
752     --with-install-prefix=XXX
753         Allows you to specify an alternate location for installing ncurses
754         after building it.  The value you specify is prepended to the "real"
755         install location.  This simplifies making binary packages.  The
756         makefile variable DESTDIR is set by this option.  It is also possible
757         to use
758                 make install DESTDIR=XXX
759         since the makefiles pass that variable to subordinate makes.
760
761         NOTE:  a few systems build shared libraries with fixed pathnames; this
762         option probably will not work for those configurations.
763
764      --with-libtool[=XXX]
765         Generate libraries with libtool.  If this option is selected, then it
766         overrides all other library model specifications.  Note that libtool
767         must already be installed, uses makefile rules dependent on GNU make,
768         and does not promise to follow the version numbering convention of
769         other shared libraries on your system.  However, if the --with-shared
770         option does not succeed, you may get better results with this option.
771
772         If a parameter value is given, it must be the full pathname of the
773         particular version of libtool, e.g.,
774                 /usr/bin/libtool-1.2.3
775
776         It is possible to rebuild the configure script to use the automake
777         macros for libtool, e.g., AC_PROG_LIBTOOL.  See the comments in
778         aclocal.m4 for CF_PROG_LIBTOOL, and ensure that you build configure
779         using the appropriate patch for autoconf from
780                 http://invisible-island.net/autoconf/
781
782     --with-manpage-aliases
783         Tell the configure script you wish to create entries in the
784         man-directory for aliases to manpages which list them, e.g., the
785         functions in the panel manpage.  This is the default.  You can disable
786         it if your man program does this.  You can also disable
787         --with-manpage-symlinks to install files containing a ".so" command
788         rather than symbolic links.
789
790     --with-manpage-format=XXX
791         Tell the configure script how you would like to install man-pages.  The
792         option value must be one of these:  gzip, compress, BSDI, normal,
793         formatted.  If you do not give this option, the configure script
794         attempts to determine which is the case.
795
796     --with-manpage-renames=XXX
797         Tell the configure script that you wish to rename the manpages while
798         installing.  Currently the only distribution which does this is
799         the Linux Debian.  The option value specifies the name of a file
800         that lists the renamed files, e.g., $srcdir/man/man_db.renames
801
802     --with-manpage-symlinks
803         Tell the configure script that you wish to make symbolic links in the
804         man-directory for aliases to the man-pages.  This is the default, but
805         can be disabled for systems that provide this automatically.  Doing
806         this on systems that do not support symbolic links will result in
807         copying the man-page for each alias.
808
809     --with-manpage-tbl
810         Tell the configure script that you with to preprocess the manpages
811         by running them through tbl to generate tables understandable by
812         nroff.
813
814     --with-mmask-t=TYPE
815         Override type of mmask_t, which stores the mouse mask.  Prior to
816         ncurses 5.5, this was always unsigned long, but with ncurses 5.5, it
817         may be unsigned.  Use this option if you need to preserve compatibility
818         with 64-bit executables.
819
820     --with-normal
821         Generate normal (i.e., static) libraries (default).
822
823         Note:  on Linux, the configure script will attempt to use the GPM
824         library via the dlsym() function call.  Use --without-dlsym to disable
825         this feature, or --without-gpm, depending on whether you wish to use
826         GPM.
827
828     --with-ospeed=TYPE
829         Override type of ospeed variable, which is part of the termcap
830         compatibility interface.  In termcap, this is a 'short', which works
831         for a wide range of baudrates because ospeed is not the actual speed
832         but the encoded value, e.g., B9600 would be a small number such as 13.
833         However the encoding scheme originally allowed for values "only" up to
834         38400bd.  A newer set of definitions past 38400bd is not encoded as
835         compactly, and is not guaranteed to fit into a short (see the function
836         cfgetospeed(), which returns a speed_t for this reason).  In practice,
837         applications that required knowledge of the ospeed variable, i.e.,
838         those using termcap, do not use the higher speeds.  Your application
839         (or system, in general) may or may not.
840
841     --with-profile
842         Generate profile-libraries These are named by adding "_p" to the root,
843         e.g., libncurses_p.a
844
845     --with-pthread
846         Link with POSIX threads, set --enable-reentrant.  The use_window() and
847         use_screen() functions will use mutex's, allowing rudimentary support
848         for multithreaded applications.
849
850     --with-rcs-ids
851         Compile-in RCS identifiers.  Most of the C files have an identifier.
852
853     --with-rel-version=NUM
854         Override the release version, which may be used in shared library
855         filenames.  This consists of a major and minor version number separated
856         by ".".  Normally the major version number is the same as the ABI
857         version; some ports have special requirements for compatibility.
858
859     --with-shared
860         Generate shared-libraries.  The names given depend on the system for
861         which you are building, typically using a ".so" suffix, along with
862         symbolic links that refer to the release version.
863
864         NOTE:  Unless you override the configure script by setting the $CFLAGS
865         environment variable, these will not be built with the -g debugging
866         option.
867
868         NOTE: For some configurations, e.g., installing a new version of
869         ncurses shared libraries on a machine which already has ncurses
870         shared libraries, you may encounter problems with the linker.
871         For example, it may prevent you from running  the build tree's
872         copy of tic (for installing the terminfo database) because it
873         loads the system's copy of the ncurses shared libraries.  In that
874         case, using the misc/shlib script may be helpful, since it sets
875         $LD_LIBRARY_PATH to point to the build tree, e.g.,
876                 ./misc/shlib make install       
877
878     --with-shlib-version=XXX
879         Specify whether to use the release or ABI version for shared libraries.
880         This is normally chosen automatically based on the type of system
881         which you are building on.  We use it for testing the configure script.
882
883     --with-sysmouse
884         use FreeBSD sysmouse interface provide mouse support on the console.
885
886     --with-system-type=XXX
887         For testing, override the derived host system-type which is used to
888         decide things such as the linker commands used to build shared
889         libraries.  This is normally chosen automatically based on the type of
890         system which you are building on.  We use it for testing the configure
891         script.
892
893     --with-terminfo-dirs=XXX
894         Specify a search-list of terminfo directories which will be compiled
895         into the ncurses library (default: DATADIR/terminfo)
896
897     --with-termlib[=XXX]
898         When building the ncurses library, organize this as two parts:  the
899         curses library (libncurses) and the low-level terminfo library
900         (libtinfo).  This is done to accommodate applications that use only
901         the latter.  The terminfo library is about half the size of the total.
902
903         If an option value is given, that overrides the name of the terminfo
904         library.  For instance, if the wide-character version is built, the
905         terminfo library would be named libtinfow.  But the libtinfow interface
906         is upward compatible from libtinfo, so it would be possible to overlay
907         libtinfo.so with a "wide" version of libtinfow.so by renaming it with
908         this option.
909
910     --with-termpath=XXX
911         Specify a search-list of termcap files which will be compiled into the
912         ncurses library (default:  /etc/termcap:/usr/share/misc/termcap)
913
914     --with-ticlib[=XXX]
915         When building the ncurses library, build a separate library for
916         the modules that are used only by the utility programs.  Normally
917         those would be bundled with the termlib or ncurses libraries.
918
919         If an option value is given, that overrides the name of the tic
920         library.  As in termlib, there is no ABI difference between the
921         "wide" libticw.so and libtic.so
922
923         NOTE: Overriding the name of the tic library may be useful if you are
924         also using the --with-termlib option to rename libtinfo.  If you are
925         not doing that, renaming the tic library can result in conflicting
926         library dependencies for tic and other programs built with the tic
927         library.
928
929     --with-trace
930         Configure the trace() function as part of the all models of the ncurses
931         library.  Normally it is part of the debug (libncurses_g) library only.
932
933     --with-valgrind
934         For testing, compile with debug option.
935         This also sets the --disable-leaks option.
936
937     --without-ada
938         Suppress the configure script's check for Ada95, do not build the
939         Ada95 binding and related demo.
940
941     --without-curses-h
942         Don't install the ncurses header with the name "curses.h".  Rather,
943         install as "ncurses.h" and modify the installed headers and manpages
944         accordingly.
945
946     --without-cxx
947         XSI curses declares "bool" as part of the interface.  C++ also declares
948         "bool".  Neither specifies the size and type of booleans, but both
949         insist on the same name.  We chose to accommodate this by making the
950         configure script check for the size and type (e.g., unsigned or signed)
951         that your C++ compiler uses for booleans.  If you do not wish to use
952         ncurses with C++, use this option to tell the configure script to not
953         adjust ncurses bool to match C++.
954
955     --without-cxx-binding
956         Suppress the configure script's check for C++, do not build the
957         C++ binding and related demo.
958
959     --without-develop
960         Disable development options.  This does not include those that change
961         the interface, such as --enable-widec.
962
963     --without-dlsym
964         Do not use dlsym() to load GPM dynamically.
965
966     --without-progs
967         Tell the configure script to suppress the build of ncurses' application
968         programs (e.g., tic).  The test applications will still be built if you
969         type "make", though not if you simply do "make install".
970
971     --without-xterm-new
972         Tell the configure script to use "xterm-old" for the entry used in
973         the terminfo database.  This will work with variations such as
974         X11R5 and X11R6 xterm.
975
976
977 COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
978 --------------------------------------------
979
980     Because ncurses implements the X/Open Curses Specification, its interface
981     is fairly stable.  That does not mean the interface does not change.
982     Changes are made to the documented interfaces when we find differences
983     between ncurses and X/Open or implementations which they certify (such as
984     Solaris).  We add extensions to those interfaces to solve problems not
985     addressed by the original curses design, but those must not conflict with
986     the X/Open documentation.
987
988     Here are some of the major interface changes, and related problems which
989     you may encounter when building a system with different versions of
990     ncurses:
991
992     5.6 (December 17, 2006)
993         Interface changes:
994
995         + generate linkable stubs for some macros:
996
997           getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, getparx,
998           getpary, getpary,
999
1000           and (for libncursesw)
1001
1002           wgetbkgrnd
1003
1004         Added extensions:
1005                 nofilter()
1006                 use_legacy_coding()
1007
1008         Added internal functions:
1009                 _nc_first_db
1010                 _nc_get_source
1011                 _nc_handle_sigwinch
1012                 _nc_is_abs_path
1013                 _nc_is_dir_path
1014                 _nc_is_file_path
1015                 _nc_keep_tic_dir
1016                 _nc_keep_tic_dir
1017                 _nc_last_db
1018                 _nc_next_db
1019                 _nc_read_termtype
1020                 _nc_tic_dir
1021
1022                 Also (if using the hashed database configuration):
1023
1024                 _nc_db_close
1025                 _nc_db_first
1026                 _nc_db_get
1027                 _nc_db_have_data
1028                 _nc_db_have_index
1029                 _nc_db_next
1030                 _nc_db_open
1031                 _nc_db_put
1032
1033                 otherwise
1034
1035                 _nc_hashed_db
1036
1037         Removed internal functions:
1038                 none
1039
1040         Modified internal functions:
1041                 _nc_add_to_try
1042                 _nc_do_color
1043                 _nc_expand_try
1044                 _nc_remove_key
1045                 _nc_setupscreen
1046
1047     5.5 (October 10, 2005)
1048         Interface changes:
1049
1050         + terminfo installs "xterm-new" as "xterm" entry rather than
1051           "xterm-old" (aka xterm-r6).
1052
1053         + terminfo data is installed using the tic -x option (few systems
1054           still use ncurses 4.2).
1055
1056         + modify C++ binding to work with newer C++ compilers by providing
1057           initializers and using modern casts.  Old-style header names are
1058           still used in this release to allow compiling with not-so-old
1059           compilers.
1060
1061         + form and menu libraries now work with wide-character data. 
1062           Applications which bypassed the form library and manipulated the
1063           FIELD.buf data directly will not work properly with libformw, since
1064           that no longer points to an array of char.  The set_field_buffer()
1065           and field_buffer() functions translate to/from the actual field
1066           data.
1067
1068         + change SP->_current_attr to a pointer, adjust ifdef's to ensure that
1069           libtinfo.so and libtinfow.so have the same ABI.  The reason for this
1070           is that the corresponding data which belongs to the upper-level
1071           ncurses library has a different size in each model.
1072
1073         + winnstr() now returns multibyte character strings for the
1074           wide-character configuration.
1075
1076         + assume_default_colors() no longer requires that use_default_colors()
1077           be called first.
1078
1079         + data_ahead() now works with wide-characters.
1080
1081         + slk_set() and slk_wset() now accept and store multibyte or
1082           multicolumn characters.
1083
1084         + start_color() now returns OK if colors have already been started.
1085           start_color() also returns ERR if it cannot allocate memory.
1086
1087         + pair_content() now returns -1 for consistency with init_pair() if it
1088           corresponds to the default-color.
1089
1090         + unctrl() now returns null if its parameter does not correspond
1091           to an unsigned char.
1092
1093         Added extensions:
1094                 Experimental mouse version 2 supports wheel mice with buttons
1095                 4 and 5.  This requires ABI 6 because it modifies the encoding
1096                 of mouse events.
1097
1098                 Experimental extended colors allows encoding of 256 foreground
1099                 and background colors, e.g., with the xterm-256color or
1100                 xterm-88color terminfo entries.  This requires ABI 6 because
1101                 it changes the size of cchar_t.
1102
1103         Added internal functions:
1104                 _nc_check_termtype2
1105                 _nc_resolve_uses2
1106                 _nc_retrace_cptr
1107                 _nc_retrace_cvoid_ptr
1108                 _nc_retrace_void_ptr
1109                 _nc_setup_term
1110
1111         Removed internal functions:
1112                 none
1113
1114         Modified internal functions:
1115                 _nc_insert_ch
1116                 _nc_save_str
1117                 _nc_trans_string
1118
1119     5.4 (February 8, 2004)
1120         Interface changes:
1121
1122         + add the remaining functions for X/Open curses wide-character support.
1123           These are only available if the library is configured using the
1124           --enable-widec option.
1125                 pecho_wchar()
1126                 slk_wset()
1127
1128         + write getyx() and related 2-return macros in terms of getcury(),
1129           getcurx(), etc.
1130
1131         + simplify ifdef for bool declaration in curses.h
1132
1133         + modify ifdef's in curses.h that disabled use of __attribute__() for
1134           g++, since recent versions implement the cases which ncurses uses.
1135
1136         + change some interfaces to use const:
1137                 define_key()
1138                 mvprintw()
1139                 mvwprintw()
1140                 printw()
1141                 vw_printw()
1142                 winsnstr()
1143                 wprintw()
1144
1145         Added extensions:
1146                 key_defined()
1147
1148         Added internal functions:
1149                 _nc_get_locale()
1150                 _nc_insert_ch()
1151                 _nc_is_charable()       wide
1152                 _nc_locale_breaks_acs()
1153                 _nc_pathlast()
1154                 _nc_to_char()           wide
1155                 _nc_to_widechar()       wide
1156                 _nc_tparm_analyze()
1157                 _nc_trace_bufcat()      debug
1158                 _nc_unicode_locale()
1159
1160         Removed internal functions:
1161                 _nc_outstr()
1162                 _nc_sigaction()
1163
1164         Modified internal functions:
1165                 _nc_remove_string()
1166                 _nc_retrace_chtype()
1167
1168     5.3 (October 12, 2002)
1169         Interface changes:
1170
1171         + change type for bool used in headers to NCURSES_BOOL, which usually
1172           is the same as the compiler's definition for 'bool'.
1173
1174         + add all but two functions for X/Open curses wide-character support.
1175           These are only available if the library is configured using the
1176           --enable-widec option.  Missing functions are
1177                 pecho_wchar()
1178                 slk_wset()
1179
1180         + add environment variable $NCURSES_ASSUMED_COLORS to modify the
1181           assume_default_colors() extension.
1182
1183         Added extensions:
1184                 is_term_resized()
1185                 resize_term()
1186
1187         Added internal functions:
1188                 _nc_altcharset_name()   debug
1189                 _nc_reset_colors()
1190                 _nc_retrace_bool()      debug
1191                 _nc_retrace_unsigned()  debug
1192                 _nc_rootname()
1193                 _nc_trace_ttymode()     debug
1194                 _nc_varargs()           debug
1195                 _nc_visbufn()           debug
1196                 _nc_wgetch()
1197
1198         Removed internal functions:
1199                 _nc_background()
1200
1201         Modified internal functions:
1202                 _nc_freeall()           debug
1203
1204     5.2 (October 21, 2000)
1205         Interface changes:
1206
1207         + revert termcap ospeed variable to 'short' (see discussion of the
1208           --with-ospeed configure option).
1209
1210     5.1 (July 8, 2000)
1211         Interface changes:
1212
1213         + made the extended terminal capabilities
1214           (configure --enable-tcap-names) a standard feature.  This should
1215           be transparent to applications that do not require it.
1216
1217         + removed the trace() function and related trace support from the
1218           production library.
1219
1220         + modified curses.h.in, undef'ing some symbols to avoid conflict
1221           with C++ STL.
1222
1223         Added extensions:  assume_default_colors().
1224
1225     5.0 (October 23, 1999)
1226         Interface changes:
1227
1228         + implemented the wcolor_set() and slk_color() functions.
1229
1230         + move macro winch to a function, to hide details of struct ldat
1231
1232         + corrected prototypes for slk_* functions, using chtype rather than
1233           attr_t.
1234
1235         + the slk_attr_{set,off,on} functions need an additional void*
1236           parameter according to XSI.
1237
1238         + modified several prototypes to correspond with 1997 version of X/Open
1239           Curses:  [w]attr_get(), [w]attr_set(), border_set() have different
1240           parameters.  Some functions were renamed or misspelled:
1241           erase_wchar(), in_wchntr(), mvin_wchntr().  Some developers have used
1242           attr_get().
1243
1244         Added extensions:  keybound(), curses_version().
1245
1246         Terminfo database changes:
1247
1248         + change translation for termcap 'rs' to terminfo 'rs2', which is
1249           the documented equivalent, rather than 'rs1'.
1250
1251         The problems are subtler in recent releases.
1252
1253         a) This release provides users with the ability to define their own
1254            terminal capability extensions, like termcap.  To accomplish this,
1255            we redesigned the TERMTYPE struct (in term.h).  Very few
1256            applications use this struct.  They must be recompiled to work with
1257            the 5.0 library.
1258
1259         a) If you use the extended terminfo names (i.e., you used configure
1260            --enable-tcap-names), the resulting terminfo database can have some
1261            entries which are not readable by older versions of ncurses.  This
1262            is a bug in the older versions:
1263
1264            + the terminfo database stores booleans, numbers and strings in
1265              arrays.  The capabilities that are listed in the arrays are
1266              specified by X/Open.  ncurses recognizes a number of obsolete and
1267              extended names which are stored past the end of the specified
1268              entries.
1269
1270            + a change to read_entry.c in 951001 made the library do an lseek()
1271              call incorrectly skipping data which is already read from the
1272              string array.  This happens when the number of strings in the
1273              terminfo data file is greater than STRCOUNT, the number of
1274              specified and obsolete or extended strings.
1275
1276            + as part of alignment with the X/Open final specification, in the
1277              990109 patch we added two new terminfo capabilities:
1278              set_a_attributes and set_pglen_inch).  This makes the indices for
1279              the obsolete and extended capabilities shift up by 2.
1280
1281            + the last two capabilities in the obsolete/extended list are memu
1282              and meml, which are found in most terminfo descriptions for xterm.
1283
1284              When trying to read this terminfo entry, the spurious lseek()
1285              causes the library to attempt to read the final portion of the
1286              terminfo data (the text of the string capabilities) 4 characters
1287              past its starting point, and reads 4 characters too few.  The
1288              library rejects the data, and applications are unable to
1289              initialize that terminal type.
1290
1291            FIX: remove memu and meml from the xterm description.  They are
1292            obsolete, not used by ncurses.  (It appears that the feature was
1293            added to xterm to make it more like hpterm).
1294
1295            This is not a problem if you do not use the -x option of tic to
1296            create a terminfo database with extended names.  Note that the
1297            user-defined terminal capabilities are not affected by this bug,
1298            since they are stored in a table after the older terminfo data ends,
1299            and are invisible to the older libraries.
1300
1301         c) Some developers did not wish to use the C++ binding, and used the
1302            configure --without-cxx option.  This causes problems if someone
1303            uses the ncurses library from C++ because that configure test
1304            determines the type for C++'s bool and makes ncurses match it, since
1305            both C++ and curses are specified to declare bool.  Calling ncurses
1306            functions with the incorrect type for bool will cause execution
1307            errors.  In 5.0 we added a configure option "--without-cxx-binding"
1308            which controls whether the binding itself is built and installed.
1309
1310     4.2 (March 2, 1998)
1311         Interface changes:
1312
1313         + correct prototype for termattrs() as per XPG4 version 2.
1314
1315         + add placeholder prototypes for color_set(), erasewchar(),
1316           term_attrs(), wcolor_set() as per XPG4 version 2.
1317
1318         + add macros getcur[xy] getbeg[xy] getpar[xy], which are defined in
1319           SVr4 headers.
1320
1321         New extensions: keyok() and define_key().
1322
1323         Terminfo database changes:
1324
1325         + corrected definition in curses.h for ACS_LANTERN, which was 'I'
1326           rather than 'i'.
1327
1328     4.1 (May 15, 1997)
1329
1330         We added these extensions:  use_default_colors().  Also added
1331         configure option --enable-const, to support the use of const where
1332         X/Open should have, but did not, specify.
1333
1334         The terminfo database content changed the representation of color for
1335         most entries that use ANSI colors.  SVr4 curses treats the setaf/setab
1336         and setf/setb capabilities differently, interchanging the red/blue
1337         colors in the latter.
1338
1339     4.0 (December 24, 1996)
1340
1341         We bumped to version 4.0 because the newly released dynamic loader
1342         (ld.so.1.8.5) on Linux did not load shared libraries whose ABI and REL
1343         versions were inconsistent.  At that point, ncurses ABI was 3.4 and the
1344         REL was 1.9.9g, so we made them consistent.
1345
1346     1.9.9g (December 1, 1996)
1347
1348         This fixed most of the problems with 1.9.9e, and made these interface
1349         changes:
1350
1351         + remove tparam(), which had been provided for compatibility with
1352           some termcap.  tparm() is standard, and does not conflict with
1353           application's fallback for missing tparam().
1354
1355         + turn off hardware echo in initscr().  This changes the sense of the
1356           echo() function, which was initialized to echoing rather than
1357           nonechoing (the latter is specified).  There were several other
1358           corrections to the terminal I/O settings which cause applications to
1359           behave differently.
1360
1361         + implemented several functions (such as attr_on()) which were
1362           available only as macros.
1363
1364         + corrected several typos in curses.h.in (i.e., the mvXXXX macros).
1365
1366         + corrected prototypes for delay_output(),
1367           has_color, immedok() and idcok().
1368
1369         + corrected misspelled getbkgd().  Some applications used the
1370           misspelled name.
1371
1372         + added _yoffset to WINDOW.  The size of WINDOW does not impact
1373           applications, since they use only pointers to WINDOW structs.
1374
1375         These changes were made to the terminfo database:
1376
1377         + removed boolean 'getm' which was available as an extended name.
1378
1379         We added these extensions: wresize(), resizeterm(), has_key() and
1380         mcprint().
1381
1382     1.9.9e (March 24, 1996)
1383
1384         not recommended (a last-minute/untested change left the forms and
1385         menus libraries unusable since they do not repaint the screen).
1386         Foreground/background colors are combined incorrectly, working properly
1387         only on a black background.  When this was released, the X/Open
1388         specification was available only in draft form.
1389
1390         Some applications (such as lxdialog) were "fixed" to work with the
1391         incorrect color scheme.
1392
1393
1394 IF YOU ARE A SYSTEM INTEGRATOR:
1395 ------------------------------
1396
1397     Configuration and Installation:
1398
1399         On platforms where ncurses is assumed to be installed in /usr/lib,
1400         the configure script uses "/usr" as a default:
1401
1402                 Linux, FreeBSD, NetBSD, OpenBSD, Cygwin
1403
1404         For other platforms, the default is "/usr/local".  See the discussion
1405         of the "--disable-overwrite" option.
1406
1407         The location of the terminfo is set indirectly by the "--datadir"
1408         configure option, e.g., /usr/share/terminfo, given a datadir of
1409         /usr/share.  You may want to override this if you are installing
1410         ncurses libraries in nonstandard locations, but wish to share the
1411         terminfo database.
1412
1413         Normally the ncurses library is configured in a pure-terminfo mode;
1414         that is, with the --disable-termcap option.  This makes the ncurses
1415         library smaller and faster.  The ncurses library includes a termcap
1416         emulation that queries the terminfo database, so even applications that
1417         use raw termcap to query terminal characteristics will win (providing
1418         you recompile and relink them!).
1419
1420         If you must configure with termcap fallback enabled, you may also wish
1421         to use the --enable-getcap option.  This speeds up termcap-based
1422         startups, at the expense of not allowing personal termcap entries to
1423         reference the terminfo tree.  See comments in
1424         ncurses/tinfo/read_termcap.c for further details.
1425
1426         Note that if you have $TERMCAP set, ncurses will use that value
1427         to locate termcap data.  In particular, running from xterm will
1428         set $TERMCAP to the contents of the xterm's termcap entry.
1429         If ncurses sees that, it will not examine /etc/termcap.
1430
1431     Keyboard Mapping:
1432
1433         The terminfo file assumes that Shift-Tab generates \E[Z (the ECMA-48
1434         reverse-tabulation sequence) rather than ^I.  Here are the loadkeys -d
1435         mappings that will set this up:
1436
1437                 keycode  15 = Tab             Tab
1438                         alt     keycode  15 = Meta_Tab
1439                         shift   keycode  15 = F26
1440                 string F26 ="\033[Z"
1441
1442     Naming the Console Terminal
1443
1444         In various systems there has been a practice of designating the system
1445         console driver type as `console'.  Please do not do this!  It
1446         complicates peoples' lives, because it can mean that several different
1447         terminfo entries from different operating systems all logically want to
1448         be called `console'.
1449
1450         Please pick a name unique to your console driver and set that up
1451         in the /etc/inittab table or local equivalent.  Send the entry to the
1452         terminfo maintainer (listed in the misc/terminfo file) to be included
1453         in the terminfo file, if it's not already there.  See the
1454         term(7) manual page included with this distribution for more on
1455         conventions for choosing type names.
1456
1457         Here are some recommended primary console names:
1458
1459                 linux   -- Linux console driver
1460                 freebsd -- FreeBSD
1461                 netbsd  -- NetBSD
1462                 bsdos   -- BSD/OS
1463
1464         If you are responsible for integrating ncurses for one of these
1465         distribution, please either use the recommended name or get back
1466         to us explaining why you don't want to, so we can work out nomenclature
1467         that will make users' lives easier rather than harder.
1468
1469
1470 RECENT XTERM VERSIONS:
1471 ---------------------
1472
1473         The terminfo database file included with this distribution assumes you
1474         are running a modern xterm based on XFree86 (i.e., xterm-new).  The
1475         earlier X11R6 entry (xterm-r6) and X11R5 entry (xterm-r5) is provided
1476         as well.  See the --without-xterm-new configure script option if you
1477         are unable to update your system.
1478
1479
1480 CONFIGURING FALLBACK ENTRIES:
1481 ----------------------------
1482
1483         In order to support operation of ncurses programs before the terminfo
1484         tree is accessible (that is, in single-user mode or at OS installation
1485         time) the ncurses library can be compiled to include an array of
1486         pre-fetched fallback entries.  This must be done on a machine which
1487         has ncurses' infocmp and terminfo database installed.
1488
1489         These entries are checked by setupterm() only when the conventional
1490         fetches from the terminfo tree and the termcap fallback (if configured)
1491         have been tried and failed.  Thus, the presence of a fallback will not
1492         shadow modifications to the on-disk entry for the same type, when that
1493         entry is accessible.
1494
1495         By default, there are no entries on the fallback list.  After you have
1496         built the ncurses suite for the first time, you can change the list
1497         (the process needs infocmp(1)).  To do so, use the script
1498         ncurses/tinfo/MKfallback.sh.  A configure script option
1499         --with-fallbacks does this (it accepts a comma-separated list of the
1500         names you wish, and does not require a rebuild).
1501
1502         If you wanted (say) to have linux, vt100, and xterm fallbacks, you
1503         would use the commands
1504
1505                 cd ncurses;
1506                 tinfo/MKfallback.sh linux vt100 xterm >fallback.c
1507
1508         Then just rebuild and reinstall the library as you would normally.
1509         You can restore the default empty fallback list with
1510
1511                 tinfo/MKfallback.sh >fallback.c
1512
1513         The overhead for an empty fallback list is one trivial stub function.
1514         Any non-empty fallback list is const-ed and therefore lives in sharable
1515         text space.  You can look at the comment trailing each initializer in
1516         the generated ncurses/fallback.c file to see the core cost of the
1517         fallbacks.  A good rule of thumb for modern vt100-like entries is that
1518         each one will cost about 2.5K of text space.
1519
1520
1521 BSD CONVERSION NOTES:
1522 --------------------
1523
1524         If you need to support really ancient BSD programs, you probably
1525         want to configure with the --enable-bsdpad option.  What this does
1526         is enable code in tputs() that recognizes a numeric prefix on a
1527         capability as a request for that much trailing padding in milliseconds.
1528         There are old BSD programs that do things like tputs("50").
1529
1530         (If you are distributing ncurses as a support-library component of
1531         an application you probably want to put the remainder of this section
1532         in the package README file.)
1533
1534         The following note applies only if you have configured ncurses with
1535         --enable-termcap.
1536
1537 ------------------------------- CUT HERE --------------------------------
1538
1539 If you are installing this application privately (either because you
1540 have no root access or want to experiment with it before doing a root
1541 installation), there are a couple of details you need to be aware of.
1542 They have to do with the ncurses library, which uses terminfo rather
1543 than termcap for describing terminal characteristics.
1544
1545 Though the ncurses library is terminfo-based, it will interpret your
1546 TERMCAP variable (if present), any local termcap files you reference
1547 through it, and the system termcap file.  However, in order to avoid
1548 slowing down your application startup, it will only do this once per
1549 terminal type!
1550
1551 The first time you load a given terminal type from your termcap
1552 database, the library initialization code will automatically write it
1553 in terminfo format to a subdirectory under $HOME/.terminfo.  After
1554 that, the initialization code will find it there and do a (much
1555 faster) terminfo fetch.
1556
1557 Usually, all this means is that your home directory will silently grow
1558 an invisible .terminfo subdirectory which will get filled in with
1559 terminfo descriptions of terminal types as you invoke them.  If anyone
1560 ever installs a global terminfo tree on your system, this will quietly
1561 stop happening and your $HOME/.terminfo will become redundant.
1562
1563 The objective of all this logic is to make converting from BSD termcap
1564 as painless as possible without slowing down your application (termcap
1565 compilation is expensive).
1566
1567 If you don't have a TERMCAP variable or custom personal termcap file,
1568 you can skip the rest of this dissertation.
1569
1570 If you *do* have a TERMCAP variable and/or a custom personal termcap file
1571 that defines a terminal type, that definition will stop being visible
1572 to this application after the first time you run it, because it will
1573 instead see the terminfo entry that it wrote to $HOME/terminfo the
1574 first time around.
1575
1576 Subsequently, editing the TERMCAP variable or personal TERMCAP file
1577 will have no effect unless you explicitly remove the terminfo entry
1578 under $HOME/terminfo.  If you do that, the entry will be recompiled
1579 from your termcap resources the next time it is invoked.
1580
1581 To avoid these complications, use infocmp(1) and tic(1) to edit the
1582 terminfo directory directly.
1583
1584 ------------------------------- CUT HERE --------------------------------
1585
1586 USING NCURSES WITH AFS:
1587         AFS treats each directory as a separate logical filesystem, you
1588         can't hard-link across them.  The --enable-symlinks option copes
1589         with this by making tic use symbolic links.
1590
1591 USING NCURSES WITH GPM:
1592         Ncurses 4.1 and up can be configured to use GPM (General Purpose
1593         Mouse) which is used on Linux console.  Be aware that GPM is commonly
1594         installed as a shared library which contains a wrapper for the curses
1595         wgetch() function (libcurses.o).  Some integrators have simplified
1596         linking applications by combining all or part of libcurses.so into the
1597         libgpm.so file, producing symbol conflicts with ncurses (specifically
1598         the wgetch function).  This was originally the BSD curses, but
1599         generally whatever curses library exists on the system.
1600
1601         You may be able to work around this problem by linking as follows:
1602
1603                 cc -o foo foo.o -lncurses -lgpm -lncurses
1604
1605         but the linker may not cooperate, producing mysterious errors.
1606         See the FAQ, as well as the discussion under the --with-gpm option:
1607
1608         http://invisible-island.net/ncurses/ncurses.faq.html#using_gpm_lib
1609
1610 BUILDING NCURSES WITH A CROSS-COMPILER
1611         Ncurses can be built with a cross-compiler.  Some parts must be built
1612         with the host's compiler since they are used for building programs
1613         (e.g., ncurses/make_hash and ncurses/make_keys) that generate tables
1614         that are compiled into the ncurses library.  The essential thing to do
1615         is set the BUILD_CC environment variable to your host's compiler, and
1616         run the configure script configuring for the cross-compiler.
1617
1618         The configure options --with-build-cc, etc., are provided to make this
1619         simpler.  Since make_hash and make_keys use only ANSI C features, it
1620         is normally not necessary to provide the other options such as
1621         --with-build-libs, but they are provided for completeness.
1622
1623         Note that all of the generated source-files which are part of ncurses
1624         will be made if you use
1625
1626                 make sources
1627
1628         This would be useful in porting to an environment which has little
1629         support for the tools used to generate the sources, e.g., sed, awk and
1630         Bourne-shell.
1631
1632         When ncurses has been successfully cross-compiled, you may want to use
1633         "make install" (with a suitable target directory) to construct an
1634         install tree.  Note that in this case (as with the --with-fallbacks
1635         option), ncurses uses the development platform's tic to do the
1636         "make install.data" portion.
1637
1638 BUGS:
1639         Send any feedback to the ncurses mailing list at
1640         bug-ncurses@gnu.org. To subscribe send mail to
1641         bug-ncurses-request@gnu.org with body that reads:
1642         subscribe ncurses <your-email-address-here>
1643
1644         The Hacker's Guide in the doc directory includes some guidelines
1645         on how to report bugs in ways that will get them fixed most quickly.
1646
1647 -- vile:txtmode