ncurses 5.9 - patch 20140927

[ncurses.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index bddc708c4ce72727b54e93d07bac23d07a9a7c9d..a4f4cf5f0be990c4cb11bbea305cbba6841768d4 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
 -------------------------------------------------------------------------------

--- Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.               --
+-- Copyright (c) 1998-2013,2014 Free Software Foundation, Inc.               --

 --                                                                           --
 -- Permission is hereby granted, free of charge, to any person obtaining a   --
 -- copy of this software and associated documentation files (the             --
 --                                                                           --
 -- Permission is hereby granted, free of charge, to any person obtaining a   --
 -- copy of this software and associated documentation files (the             --


@@ -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.164 2012/02/18 21:27:33 tom Exp $
+-- $Id: INSTALL,v 1.174 2014/09/20 00:51:37 tom Exp $

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


@@ -315,6 +315,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        programs are useful in this configuration, e.g., reset and tput versus
        infocmp and tic.
 
        programs are useful in this configuration, e.g., reset and tput versus
        infocmp and tic.
 

+    --disable-db-install
+       Do not install the terminal database.  This is used to omit features
+       for packages, as done with --without-progs.
+

     --disable-ext-funcs
        Disable function-extensions.  Configure ncurses without the functions
        that are not specified by XSI.  See ncurses/modules for the exact
     --disable-ext-funcs
        Disable function-extensions.  Configure ncurses without the functions
        that are not specified by XSI.  See ncurses/modules for the exact


@@ -333,6 +337,10 @@ 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-lib-suffixes
+       Suppress the "w", "t" or "tw" suffixes which normally would be added
+       to the library names for the --enable-widec and --with-pthread options.
+

     --disable-libtool-version
        when using --with-libtool, control how the major/minor version numbers
        are used for constructing the library name.
     --disable-libtool-version
        when using --with-libtool, control how the major/minor version numbers
        are used for constructing the library name.


@@ -382,6 +390,37 @@ SUMMARY OF CONFIGURE OPTIONS:
        rather than the include directory.  This makes it simpler to avoid
        compile-time conflicts with other versions of curses.h
 
        rather than the include directory.  This makes it simpler to avoid
        compile-time conflicts with other versions of curses.h
 

+       Putting the header files into a subdirectory assumes that applications
+       will follow the (standard) practice of including the headers with
+       reference to the subdirectory name.  For instance, the normal ncurses
+       header would be included using
+
+               #include <ncurses/curses.h>
+               #include <ncurses/term.h>
+
+       while the ncursesw headers would be found this way:
+
+               #include <ncursesw/curses.h>
+               #include <ncursesw/term.h>
+
+       In either case (with or without the --disable-overwrite option),
+       almost all applications are designed to include a related set of
+       curses header files from the same directory.
+
+       Manipulating the --includedir configure option to put header files
+       directly in a subdirectory of the normal include-directory defeats
+       this, and breaks builds of portable applications.  Likewise, putting
+       some headers in /usr/include, and others in a subdirectory is a good
+       way to break builds.
+
+       When configured with --disable-overwrite, the installed header files'
+       embedded #include's are adjusted to use the same style of includes
+       noted above.  In particular, the unctrl.h header is included from
+       curses.h, which means that a makefile which tells the compiler to
+       include directly from the subdirectory will fail to compile correctly.
+       Without some special effort, it will either fail to compile at all,
+       or the compiler may find a different unctrl.h file.
+

     --disable-relink
        If --enable-rpath is given, the generated makefiles normally will
        rebuild the libraries during install.  Use this option to simply
     --disable-relink
        If --enable-rpath is given, the generated makefiles normally will
        rebuild the libraries during install.  Use this option to simply


@@ -556,6 +595,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        library by reducing global and static variables.  This option is also
        set if --with-pthread is used.
 
        library by reducing global and static variables.  This option is also
        set if --with-pthread is used.
 

+       Enabling this option adds a "t" to the library names, except for the
+       special case when --enable-weak-symbols is also used.
+

     --enable-rpath
        Use rpath option when generating shared libraries, and (with some
        restrictions) when linking the corresponding programs.  This originally
     --enable-rpath
        Use rpath option when generating shared libraries, and (with some
        restrictions) when linking the corresponding programs.  This originally


@@ -596,6 +638,14 @@ SUMMARY OF CONFIGURE OPTIONS:
        reducing the need for juggling the global SP value with set_term() and
        delscreen().
 
        reducing the need for juggling the global SP value with set_term() and
        delscreen().
 

+    --enable-string-hacks
+       Controls whether strlcat and strlcpy may be used.  The same issue
+       applies to OpenBSD's warnings about snprintf, noting that this function
+       is weakly standardized.
+
+       Aside from stifling these warnings, there is no functional improvement
+       in ncurses.
+

     --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


@@ -747,6 +797,12 @@ SUMMARY OF CONFIGURE OPTIONS:
        executables, e.g., by setting "--with-chtype=long" (the configure
        script supplies "unsigned").
 
        executables, e.g., by setting "--with-chtype=long" (the configure
        script supplies "unsigned").
 

+    --with-cxx-shared
+       When --with-shared is set, build libncurses++ as a shared library.
+       This implicitly relies upon building with gcc/g++, since other
+       compiler suites may have differences in the way shared libraries are
+       built.  libtool by the way has similar limitations.
+

     --with-database=XXX
        Specify the terminfo source file to install.  Usually you will wish
        to install ncurses' default (misc/terminfo.src).  Certain systems
     --with-database=XXX
        Specify the terminfo source file to install.  Usually you will wish
        to install ncurses' default (misc/terminfo.src).  Certain systems


@@ -812,10 +868,15 @@ SUMMARY OF CONFIGURE OPTIONS:
        filesystem-based terminfo entries.
 
        Use the parameter value to give the install-prefix used for the
        filesystem-based terminfo entries.
 
        Use the parameter value to give the install-prefix used for the

-       datbase, e.g.,
+       database, e.g.,

                --with-hashed-db=/usr/local/BigBase
        to find the corresponding include- and lib-directories under the
                --with-hashed-db=/usr/local/BigBase
        to find the corresponding include- and lib-directories under the

-       given directory.
+       given directory.  Alternatively, you can specify a directory leaf
+       name, e.g.,
+               --with-hashed-db=db4
+       to make the configure script look for files in a subdirectory such as
+               /usr/include/db4/db.h
+               /usr/lib/db4/libdb.so

 
        See also the --enable-getcap option.
 
 
        See also the --enable-getcap option.
 


@@ -957,11 +1018,23 @@ SUMMARY OF CONFIGURE OPTIONS:
        shared libraries, you may encounter problems with the linker.
        For example, it may prevent you from running  the build tree's
        copy of tic (for installing the terminfo database) because it
        shared libraries, you may encounter problems with the linker.
        For example, it may prevent you from running  the build tree's
        copy of tic (for installing the terminfo database) because it

-       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
 

+       Alternatively, for most platforms, the linker accepts a list of
+       directories which will be searched for libraries at run-time.  The
+       configure script allows you to modify this list using the
+       RPATH_LIST environment variable.  It is a colon-separated list of
+       directories (default:  the "libdir" set via the configure script).
+       If you set that to put "../lib" first in the list, the linker will
+       look first at the build-directory, and avoid conflict with libraries
+       already installed.  One drawback to this approach is that libraries
+       can be accidentally searched in any "../lib" directory.
+

        NOTE: If you use the --with-ada-sharedlib option, you should also
        set this option, to ensure that C-language modules needed for the
        Ada binding use appropriate compiler options.
        NOTE: If you use the --with-ada-sharedlib option, you should also
        set this option, to ensure that C-language modules needed for the
        Ada binding use appropriate compiler options.