ncurses 5.9 - patch 20141220

[ncurses.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index a4f4cf5f0be990c4cb11bbea305cbba6841768d4..8174b34493509205fa2a3e0cb0083122c39e5df1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -25,7 +25,7 @@
 -- sale, use or other dealings in this Software without prior written        --
 -- authorization.                                                            --
 -------------------------------------------------------------------------------
--- $Id: INSTALL,v 1.174 2014/09/20 00:51:37 tom Exp $
+-- $Id: INSTALL,v 1.180 2014/12/14 00:13:57 tom Exp $
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
@@ -352,6 +352,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        Use --disable-libtool-version to use the libtool -version-info feature.
        This corresponds to the setting used before patch 20100515.
 
+       Starting with patch 20141115, using this option causes the configure
+       script to apply the top-level VERSION file to the ABI version used
+       for libtool.
+
     --disable-leaks
        For testing, compile-in code that frees memory that normally would not
        be freed, to simplify analysis of memory-leaks.
@@ -360,11 +364,17 @@ SUMMARY OF CONFIGURE OPTIONS:
        a screen, since (even after calling endwin()), it must be available
        for use in the next call to refresh().  There are also chunks of
        memory held for performance reasons.  That makes it hard to analyze
-       curses applications for memory leaks.  To work around this, build
-       a debugging version of the ncurses library which frees those chunks
+       curses applications for memory leaks.  To work around this, build a
+       debugging version of the ncurses library which frees those chunks
        which it can, and provides the _nc_free_and_exit() function to free
-       the remainder on exit.  The ncurses utility and test programs use this
-       feature, e.g., via the ExitProgram() macro.
+       the remainder and then exit.  The ncurses utility and test programs
+       use this feature, e.g., via the ExitProgram() macro.
+
+       Because this lies outside of the library's intended usage, it is not
+       normally considered part of the ABI.  If there were some (as yet
+       unplanned) extension which frees memory in a manner that would let the
+       library resume and reallocate memory, then that would not use a "_nc_"
+       prefix.
 
     --disable-lp64
        The header files will ignore use of the _LP64 symbol to make chtype
@@ -825,6 +835,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        For testing, compile and link with Gray Watson's dmalloc library.
        This also sets the --disable-leaks option.
 
+    --with-export-syms[=XXX]
+       Limit exported symbols using libtool.  The configure script
+       automatically chooses an appropriate ".sym" file, which lists the
+       symbols which are part of the ABI.
+
     --with-fallbacks=XXX
        Specify a list of fallback terminal descriptions which will be
        compiled into the ncurses library.  See CONFIGURING FALLBACK ENTRIES.
@@ -920,6 +935,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        using the appropriate patch for autoconf from
                http://invisible-island.net/autoconf/
 
+    --with-libtool-opts=XXX
+       Specify additional libtool options.
+
     --with-manpage-aliases
        Tell the configure script you wish to create entries in the
        man-directory for aliases to manpages which list them, e.g., the
@@ -979,6 +997,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        those using termcap, do not use the higher speeds.  Your application
        (or system, in general) may or may not.
 
+    --with-pc-suffix=SUFFIX
+       If ".pc" files are installed, optionally add a suffix to the files
+       and corresponding package names to separate unusual configurations.
+       If no option value is given (or if it is "none"), no suffix is added.
+
     --with-pkg-config=[DIR]
        Check for pkg-config, optionally specifying its path.
 
@@ -1103,6 +1126,19 @@ SUMMARY OF CONFIGURE OPTIONS:
        Configure the trace() function as part of the all models of the ncurses
        library.  Normally it is part of the debug (libncurses_g) library only.
 
+    --with-versioned-syms[=XXX]
+       The Solaris, GNU and reportedly some other linkers (ld) accept a
+       "--version-script" option which tells the linker to annotate the
+       resulting objects with version identifiers.  The configure script
+       will automatically apply a suitable ".map" file to provide this
+       information for Linux.  Solaris mapfiles differ:
+
+       a) comments are not accepted
+       b) wildcards are not accepted
+       c) each symbol listed in the map file must exist in the library
+
+       Use "objdump -T" on a library to see the annotations.
+
     --with-xterm-kbs=XXX
        Configure xterm's terminfo entries to use either BS (^H, i.e., ASCII
        backspace) or DEL (^?, or 127).  XXX can be BS (or bs, 8) or DEL