ncurses 5.7 - patch 20101023

[ncurses.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 0a5e6213755a9a0a03fe7fa3bdc67cc37a710926..c8f780747883cef43a148fc757ef67303064bf8f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -25,7 +25,7 @@
 -- sale, use or other dealings in this Software without prior written        --
 -- authorization.                                                            --
 -------------------------------------------------------------------------------
 -- sale, use or other dealings in this Software without prior written        --
 -- authorization.                                                            --
 -------------------------------------------------------------------------------

--- $Id: INSTALL,v 1.143 2010/01/09 19:26:36 tom Exp $
+-- $Id: INSTALL,v 1.148 2010/10/23 22:41:32 tom Exp $

 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------


@@ -100,12 +100,12 @@ INSTALLATION PROCEDURE:
 
     Do not use commands such as
 
 
     Do not use commands such as
 

-       make install prefix=XXX
+       make install prefix=XXX

 
     to change the prefix after configuration, since the prefix value is used
     for some absolute pathnames such as TERMINFO.  Instead do this
 
 
     to change the prefix after configuration, since the prefix value is used
     for some absolute pathnames such as TERMINFO.  Instead do this
 

-       make install DESTDIR=XXX
+       make install DESTDIR=XXX

 
     See also the discussion of --with-install-prefix.
 
 
     See also the discussion of --with-install-prefix.
 


@@ -333,6 +333,17 @@ SUMMARY OF CONFIGURE OPTIONS:
     --disable-largefile
        Disable compiler flags needed to use large-file interfaces.
 
     --disable-largefile
        Disable compiler flags needed to use large-file interfaces.
 

+    --disable-libtool-version
+       when using --with-libtool, control how the major/minor version numbers
+       are used for constructing the library name.
+
+       The default uses the -version-number feature of libtool, which makes
+       the library names compatible (though not identical) with the standard
+       build using --with-shared.
+
+       Use --disable-libtool-version to use the libtool -version-info feature.
+       This corresponds to the setting used before patch 20100515.
+

     --disable-leaks
        For testing, compile-in code that frees memory that normally would not
        be freed, to simplify analysis of memory-leaks.
     --disable-leaks
        For testing, compile-in code that frees memory that normally would not
        be freed, to simplify analysis of memory-leaks.


@@ -384,6 +395,12 @@ SUMMARY OF CONFIGURE OPTIONS:
        application.  These are (for example $TERMINFO) those that allow the
        search path for the terminfo or termcap entry to be customized.
 
        application.  These are (for example $TERMINFO) those that allow the
        search path for the terminfo or termcap entry to be customized.
 

+    --disable-rpath-hack
+       Normally the configure script helps link libraries found in unusual
+       places by adding an rpath option to the link command.  If you are
+       building packages, this feature may be redundant.  Use this option
+       to suppress the feature.
+

     --disable-scroll-hints
        Compile without scroll-hints code.  This option is ignored when
        hashmap scrolling is configured, which is the default.
     --disable-scroll-hints
        Compile without scroll-hints code.  This option is ignored when
        hashmap scrolling is configured, which is the default.


@@ -508,6 +525,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        may not be accurate, or that your stty settings have disabled the use
        of tabs.
 
        may not be accurate, or that your stty settings have disabled the use
        of tabs.
 

+    --enable-interop
+       Compile-in experimental interop bindings.  These provide generic types
+       for the form-library.
+

     --enable-mixed-case
        Controls whether the filesystem on which the terminfo database resides
        supports mixed-case filenames (normal for UNIX, but not on other
     --enable-mixed-case
        Controls whether the filesystem on which the terminfo database resides
        supports mixed-case filenames (normal for UNIX, but not on other


@@ -525,6 +546,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        for each of the libraries, and install them in pkg-config's library
        directory.
 
        for each of the libraries, and install them in pkg-config's library
        directory.
 

+    --enable-pthreads-eintr
+       add logic in threaded configuration to ensure that a read(2) system
+       call can be interrupted for SIGWINCH.
+

     --enable-reentrant
        Compile experimental configuration which improves reentrant use of the
        library by reducing global and static variables.  This option is also
     --enable-reentrant
        Compile experimental configuration which improves reentrant use of the
        library by reducing global and static variables.  This option is also


@@ -565,6 +590,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        is not strictly compatible.  This option allows one to implement this
        alteration without patching the source code.
 
        is not strictly compatible.  This option allows one to implement this
        alteration without patching the source code.
 

+    --enable-sp-funcs
+       Compile-in support for extended functions which accept a SCREEN pointer,
+       reducing the need for juggling the global SP value with set_term() and
+       delscreen().
+

     --enable-symlinks
        If your system supports symbolic links, make tic use symbolic links
        rather than hard links to save diskspace when writing aliases in the
     --enable-symlinks
        If your system supports symbolic links, make tic use symbolic links
        rather than hard links to save diskspace when writing aliases in the


@@ -576,6 +606,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        capabilities as user-defined strings.  This option is the default,
        unless you have disabled the extended functions.
 
        capabilities as user-defined strings.  This option is the default,
        unless you have disabled the extended functions.
 

+    --enable-term-driver
+       Enable experimental terminal-driver.  This is currently used for the
+       MinGW port, by providing a way to substitute the low-level terminfo
+       library with different terminal drivers.
+

     --enable-termcap
        Compile in support for reading terminal descriptions from termcap if no
        match is found in the terminfo database.  See also the --enable-getcap
     --enable-termcap
        Compile in support for reading terminal descriptions from termcap if no
        match is found in the terminfo database.  See also the --enable-getcap


@@ -630,12 +665,19 @@ SUMMARY OF CONFIGURE OPTIONS:
     --with-ada-objects=DIR
        Tell where to install the Ada objects (default:  PREFIX/lib/ada/adalib)
 
     --with-ada-objects=DIR
        Tell where to install the Ada objects (default:  PREFIX/lib/ada/adalib)
 

+    --with-ada-sharedlib
+       Build a shared library for Ada95 binding, if the compiler permits.
+

     --with-bool=TYPE
        If --without-cxx is specified, override the type used for the "bool"
        declared in curses.h (normally the type is automatically chosen to
        correspond with that in <stdbool.h>, or defaults to platform-specific
        sizes).
 
     --with-bool=TYPE
        If --without-cxx is specified, override the type used for the "bool"
        declared in curses.h (normally the type is automatically chosen to
        correspond with that in <stdbool.h>, or defaults to platform-specific
        sizes).
 

+    --with-build-cpp=XXX
+       This option is provided by the same macro used for $BUILD_CC, etc.,
+       but is not directly used by ncurses.
+

     --with-build-cc=XXX
        If cross-compiling, specify a host C compiler, which is needed to
        compile a few utilities which generate source modules for ncurses.
     --with-build-cc=XXX
        If cross-compiling, specify a host C compiler, which is needed to
        compile a few utilities which generate source modules for ncurses.


@@ -723,7 +765,7 @@ SUMMARY OF CONFIGURE OPTIONS:
        use Alessandro Rubini's GPM library to provide mouse support on the
        Linux console.  Prior to ncurses 5.5, this introduced a dependency on
        the GPM library.
        use Alessandro Rubini's GPM library to provide mouse support on the
        Linux console.  Prior to ncurses 5.5, this introduced a dependency on
        the GPM library.

-       
+

        Currently ncurses uses the dlsym() function to bind to the library at
        runtime, so it is only necessary that the library be present when
        ncurses is built, to obtain the filename (or soname) used in the
        Currently ncurses uses the dlsym() function to bind to the library at
        runtime, so it is only necessary that the library be present when
        ncurses is built, to obtain the filename (or soname) used in the


@@ -740,7 +782,7 @@ SUMMARY OF CONFIGURE OPTIONS:
        Use a hashed database for storing terminfo data rather than storing
        each compiled entry in a separate binary file within a directory
        tree.
        Use a hashed database for storing terminfo data rather than storing
        each compiled entry in a separate binary file within a directory
        tree.

-       
+

        In particular, this uses the Berkeley database 1.8.5 interface, as
        provided by that and its successors db 2, 3, and 4.  The actual
        interface is slightly different in the successor versions of the
        In particular, this uses the Berkeley database 1.8.5 interface, as
        provided by that and its successors db 2, 3, and 4.  The actual
        interface is slightly different in the successor versions of the


@@ -811,7 +853,7 @@ SUMMARY OF CONFIGURE OPTIONS:
 
     --with-manpage-renames=XXX
        Tell the configure script that you wish to rename the manpages while
 
     --with-manpage-renames=XXX
        Tell the configure script that you wish to rename the manpages while

-       installing.  Currently the only distribution which does this is Debian. 
+       installing.  Currently the only distribution which does this is Debian.

        The option value specifies the name of a file that lists the renamed
        files, e.g., $srcdir/man/man_db.renames
 
        The option value specifies the name of a file that lists the renamed
        files, e.g., $srcdir/man/man_db.renames
 


@@ -892,7 +934,7 @@ SUMMARY OF CONFIGURE OPTIONS:
        loads the system's copy of the ncurses shared libraries.  In that
        case, using the misc/shlib script may be helpful, since it sets
        $LD_LIBRARY_PATH to point to the build tree, e.g.,
        loads the system's copy of the ncurses shared libraries.  In that
        case, using the misc/shlib script may be helpful, since it sets
        $LD_LIBRARY_PATH to point to the build tree, e.g.,

-               ./misc/shlib make install       
+               ./misc/shlib make install

 
     --with-shlib-version=XXX
        Specify whether to use the release or ABI version for shared libraries.
 
     --with-shlib-version=XXX
        Specify whether to use the release or ABI version for shared libraries.


@@ -1001,6 +1043,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        programs (e.g., tic).  The test applications will still be built if you
        type "make", though not if you simply do "make install".
 
        programs (e.g., tic).  The test applications will still be built if you
        type "make", though not if you simply do "make install".
 

+    --without-tests
+       Tell the configure script to suppress the build of ncurses' test
+       programs.
+

     --without-xterm-new
        Tell the configure script to use "xterm-old" for the entry used in
        the terminfo database.  This will work with variations such as
     --without-xterm-new
        Tell the configure script to use "xterm-old" for the entry used in
        the terminfo database.  This will work with variations such as


@@ -1032,7 +1078,7 @@ COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
          of the ncurses library used for the tic program as well as some
          others such as tack.  There is no API change, but makefiles would be
          changed to use the tic-library built separately.
          of the ncurses library used for the tic program as well as some
          others such as tack.  There is no API change, but makefiles would be
          changed to use the tic-library built separately.

-         
+

          tack, distributed separately from ncurses, uses some of the internal
          _nc_XXX functions, which are declared in the tic.h header file.
 
          tack, distributed separately from ncurses, uses some of the internal
          _nc_XXX functions, which are declared in the tic.h header file.
 


@@ -1179,7 +1225,7 @@ COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
          still used in this release to allow compiling with not-so-old
          compilers.
 
          still used in this release to allow compiling with not-so-old
          compilers.
 

-       + form and menu libraries now work with wide-character data. 
+       + form and menu libraries now work with wide-character data.

          Applications which bypassed the form library and manipulated the
          FIELD.buf data directly will not work properly with libformw, since
          that no longer points to an array of char.  The set_field_buffer()
          Applications which bypassed the form library and manipulated the
          FIELD.buf data directly will not work properly with libformw, since
          that no longer points to an array of char.  The set_field_buffer()


@@ -1517,7 +1563,7 @@ IF YOU ARE A SYSTEM INTEGRATOR:
 
     Configuration and Installation:
 
 
     Configuration and Installation:
 

-       On platforms where ncurses is assumed to be installed in /usr/lib,
+       On platforms where ncurses is assumed to be installed in /usr/lib,

        the configure script uses "/usr" as a default:
 
                GNU/Linux, FreeBSD, NetBSD, OpenBSD, Cygwin
        the configure script uses "/usr" as a default:
 
                GNU/Linux, FreeBSD, NetBSD, OpenBSD, Cygwin