ncurses 5.9 - patch 20111224
[ncurses.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index eb26ab103ef8fd05f9e6239316fd14b44407268d..c7dd3278c26717171a189f9e9dcac1cdbb911f1b 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.155 2011/03/31 08:27:24 tom Exp $
+-- $Id: INSTALL,v 1.160 2011/10/15 23:32:49 tom Exp $
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
@@ -407,13 +407,14 @@ SUMMARY OF CONFIGURE OPTIONS:
 
     --disable-tic-depends
        When building shared libraries, normally the tic library is linked to
-       depend upon the ncurses library (and in turn, on the term-library if
-       the --with-termlib option was given).  The tic- and term-libraries
-       ABI does not depend on the --enable-widec option. Some packagers have
-       used this to reduce the number of library files which are packaged
-       by using only one copy of those libraries.  To make this work properly,
+       depend upon the ncurses library (or equivalently, on the tinfo-library
+       if the --with-termlib option was given).  The tic- and tinfo-library
+       ABIs do not depend on the --enable-widec option.  Some packagers have
+       used this to reduce the number of library files which are packaged by
+       using only one copy of those libraries.  To make this work properly,
        the tic library must be built without an explicit dependency on the
-       ncurses (or ncursesw) library.  Use this configure option to do that.
+       underlying library (ncurses vs ncursesw, tinfo vs tinfow).  Use this
+       configure option to do that.
        For example
                configure --with-ticlib --with-shared --disable-tic-depends
 
@@ -616,6 +617,12 @@ SUMMARY OF CONFIGURE OPTIONS:
        match is found in the terminfo database.  See also the --enable-getcap
        and --enable-getcap-cache options.
 
+       Termcap support requires run-time parsing rather than loading
+       predigested data.  If you have specified --with-ticlib, then you
+       cannot have termcap support since run-time parsing is done in the
+       tic library, which is intentionally not part of normal linkage
+       dependencies.
+
     --enable-warnings
        Turn on GCC compiler warnings.  There should be only a few.
 
@@ -904,6 +911,10 @@ SUMMARY OF CONFIGURE OPTIONS:
     --with-pkg-config=[DIR]
        Check for pkg-config, optionally specifying its path.
 
+    --with-pkg-config-libdir=[DIR]
+       If pkg-config was found, override the automatic check for its library
+       path.
+
     --with-profile
        Generate profile-libraries These are named by adding "_p" to the root,
        e.g., libncurses_p.a
@@ -1024,6 +1035,8 @@ SUMMARY OF CONFIGURE OPTIONS:
        install as "ncurses.h" and modify the installed headers and manpages
        accordingly.
 
+       Likewise, do not install an alias "curses" for the ncurses manpage.
+
     --without-cxx
        XSI curses declares "bool" as part of the interface.  C++ also declares
        "bool".  Neither specifies the size and type of booleans, but both
@@ -1726,20 +1739,37 @@ CONFIGURING FALLBACK ENTRIES:
        By default, there are no entries on the fallback list.  After you have
        built the ncurses suite for the first time, you can change the list
        (the process needs infocmp(1)).  To do so, use the script
-       ncurses/tinfo/MKfallback.sh.  A configure script option
+       ncurses/tinfo/MKfallback.sh.  The configure script option
        --with-fallbacks does this (it accepts a comma-separated list of the
        names you wish, and does not require a rebuild).
 
        If you wanted (say) to have linux, vt100, and xterm fallbacks, you
-       would use the commands
+       might use the commands
 
                cd ncurses;
-               tinfo/MKfallback.sh linux vt100 xterm >fallback.c
+               tinfo/MKfallback.sh \
+                       $TERMINFO \
+                       ../misc/terminfo.src \
+                       `which tic` \
+                       linux vt100 xterm >fallback.c
+
+       The first three parameters of the script are normally supplied by
+       the configured makefiles via the "--with-fallbacks" option.  They
+       are
+
+               1) the location of the terminfo database
+               2) the source for the terminfo entries
+               3) the location of the tic program, used to create a terminfo
+                  database.
 
        Then just rebuild and reinstall the library as you would normally.
        You can restore the default empty fallback list with
 
-               tinfo/MKfallback.sh >fallback.c
+               tinfo/MKfallback.sh \
+                       $TERMINFO \
+                       ../misc/terminfo.src \
+                       `which tic` \
+                       >fallback.c
 
        The overhead for an empty fallback list is one trivial stub function.
        Any non-empty fallback list is const-ed and therefore lives in sharable