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