ncurses 6.1 - patch 20180825

[ncurses.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 87c9e3b145c5b360dbaad422b6b836af763b9f55..e57bbec75d0fd6cdb006474925e3e99a6494c77f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
 -------------------------------------------------------------------------------

--- Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.               --
+-- Copyright (c) 1998-2017,2018 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.198 2017/07/27 08:34:34 tom Exp $
+-- $Id: INSTALL,v 1.206 2018/08/18 20:41:07 tom Exp $

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


@@ -317,11 +317,20 @@ SUMMARY OF CONFIGURE OPTIONS:
        Do not install the terminal database.  This is used to omit features
        for packages, as done with --without-progs.
 
        Do not install the terminal database.  This is used to omit features
        for packages, as done with --without-progs.
 

+    --disable-echo
+       Use the option --disable-echo to make the build-log less verbose by
+       suppressing the display of the compile and link commands.  This makes
+       it easier to see the compiler warnings.  (You can always use "make -n"
+       to see the options that are used).
+

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

+    --disable-gnat-projects
+       Disable GNAT projects even if usable, for testing old makefile rules.
+

     --disable-hashmap
        Compile without hashmap scrolling-optimization code.  This algorithm is
        the default.
     --disable-hashmap
        Compile without hashmap scrolling-optimization code.  This algorithm is
        the default.


@@ -335,25 +344,6 @@ 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.
-
-       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.
-
-       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.
     --disable-leaks
        For testing, compile-in code that frees memory that normally would not
        be freed, to simplify analysis of memory-leaks.


@@ -374,6 +364,25 @@ SUMMARY OF CONFIGURE OPTIONS:
        library resume and reallocate memory, then that would not use a "_nc_"
        prefix.
 
        library resume and reallocate memory, then that would not use a "_nc_"
        prefix.
 

+    --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.
+
+       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.
+
+       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-lp64
        The header files will ignore use of the _LP64 symbol to make chtype
        and mmask_t types 32 bits (they may be long on 64-bit hosts, for
     --disable-lp64
        The header files will ignore use of the _LP64 symbol to make chtype
        and mmask_t types 32 bits (they may be long on 64-bit hosts, for


@@ -431,10 +440,18 @@ SUMMARY OF CONFIGURE OPTIONS:
 
     --disable-relink
        If --enable-rpath is given, the generated makefiles normally will
 
     --disable-relink
        If --enable-rpath is given, the generated makefiles normally will

-       rebuild the libraries during install.  Use this option to simply
-       copy whatever the linked produced.
+       rebuild shared libraries during install.  Use this option to simply
+       copy whatever the linker produced.
+
+       Static libraries cannot simply be copied because tools use timestamps
+       to determine if the library's symbol table is up to date.  If your
+       install program supports the "-p" (preserve timestamp) option, that
+       is used when --disable-relink is given, to avoid rebuilding the symbol
+       table.

 
 

-       This option is ignored if --enable-rpath is not given.
+       Finally, some tools ignore the subsecond timestamps supported by some
+       filesystems.  This option adds a 1-second sleep to help those tools
+       avoid unnecessary relinking during the install process.

 
     --disable-root-environ
        Compile with environment restriction, so certain environment variables
 
     --disable-root-environ
        Compile with environment restriction, so certain environment variables


@@ -452,6 +469,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        Compile without scroll-hints code.  This option is ignored when
        hashmap scrolling is configured, which is the default.
 
        Compile without scroll-hints code.  This option is ignored when
        hashmap scrolling is configured, which is the default.
 

+    --disable-stripping
+       Do not strip installed executables.
+

     --disable-tic-depends
        When building shared libraries, normally the tic library is linked to
        depend upon the ncurses library (or equivalently, on the tinfo-library
     --disable-tic-depends
        When building shared libraries, normally the tic library is linked to
        depend upon the ncurses library (or equivalently, on the tinfo-library


@@ -536,12 +556,6 @@ SUMMARY OF CONFIGURE OPTIONS:
        issues arise when porting to SVr4 curses, which uses const in even
        fewer places.
 
        issues arise when porting to SVr4 curses, which uses const in even
        fewer places.
 

-    --enable-echo
-       Use the option --disable-echo to make the build-log less verbose by
-       suppressing the display of the compile and link commands.  This makes
-       it easier to see the compiler warnings.  (You can always use "make -n"
-       to see the options that are used).
-

     --enable-expanded
        For testing, generate functions for certain macros to make them visible
        as such to the debugger.  See also the --disable-macros option.
     --enable-expanded
        For testing, generate functions for certain macros to make them visible
        as such to the debugger.  See also the --disable-macros option.


@@ -661,7 +675,8 @@ SUMMARY OF CONFIGURE OPTIONS:
     --enable-safe-sprintf
        Compile with experimental safe-sprintf code.  You may consider using
        this if you are building ncurses for a system that has neither
     --enable-safe-sprintf
        Compile with experimental safe-sprintf code.  You may consider using
        this if you are building ncurses for a system that has neither

-       vsnprintf() or vsprintf().  It is slow, however.
+       vsnprintf() or vsprintf().  It is slow, however, and is used only on
+       very old systems which lack vsnprintf().

 
     --enable-sigwinch
        Compile support for ncurses' SIGWINCH handler.  If your application has
 
     --enable-sigwinch
        Compile support for ncurses' SIGWINCH handler.  If your application has


@@ -841,6 +856,10 @@ 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-config-suffix=XXX
+       Specify a suffix for the ncursesw6-config file, etc., used to work
+       around conflicts with packages.
+

     --with-cxx-shared
        When --with-shared is set, build libncurses++ as a shared library.
        This implicitly relies upon building with gcc/g++, since other
     --with-cxx-shared
        When --with-shared is set, build libncurses++ as a shared library.
        This implicitly relies upon building with gcc/g++, since other


@@ -973,11 +992,18 @@ SUMMARY OF CONFIGURE OPTIONS:
        macros for libtool, e.g., AC_PROG_LIBTOOL.  See the comments in
        aclocal.m4 for CF_PROG_LIBTOOL, and ensure that you build configure
        using the appropriate patch for autoconf from
        macros for libtool, e.g., AC_PROG_LIBTOOL.  See the comments in
        aclocal.m4 for CF_PROG_LIBTOOL, and ensure that you build configure
        using the appropriate patch for autoconf from

-               http://invisible-island.net/autoconf/
+               https://invisible-island.net/autoconf/

 
     --with-libtool-opts=XXX
        Specify additional libtool options.
 
 
     --with-libtool-opts=XXX
        Specify additional libtool options.
 

+    --with-libtool-opts
+       Allow user to pass additional libtool options into the library creation
+       and link steps.  The main use for this is to do something like
+               ./configure --with-libtool-opts=-static
+       to get the same behavior as automake-flavored
+               ./configure --enable-static
+

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


@@ -1223,6 +1249,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        which applications should not call even via a macro.  This configure
        option lets you choose the prefix for these wrapped variables.
 
        which applications should not call even via a macro.  This configure
        option lets you choose the prefix for these wrapped variables.
 

+    --with-x11-rgb=FILE
+       Provide a pathname for the X11 rgb file, used by the picsmap program.
+       This overrides a configure check which usually works, but is needed
+       due to the lack of standardization for X11's files.
+

     --without-ada
        Suppress the configure script's check for Ada95, do not build the
        Ada95 binding and related demo.
     --without-ada
        Suppress the configure script's check for Ada95, do not build the
        Ada95 binding and related demo.


@@ -1262,6 +1293,11 @@ 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-tack
+       Suppress build/install with tack program, if it happens to be
+       in the same build-tree (tack was moved out of the ncurses source-tree
+       in 20070203).
+

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


@@ -1275,10 +1311,10 @@ SUMMARY OF CONFIGURE OPTIONS:
 COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
 --------------------------------------------
 
 COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
 --------------------------------------------
 

-    Because ncurses implements X/Open Curses, its interface is fairly stable. 
+    Because ncurses implements X/Open Curses, its interface is fairly stable.

     That does not mean the interface does not change.  Changes are made to the
     documented interfaces when we find differences between ncurses and X/Open
     That does not mean the interface does not change.  Changes are made to the
     documented interfaces when we find differences between ncurses and X/Open

-    or implementations which largely correspond to X/Open (such as Solaris). 
+    or implementations which largely correspond to X/Open (such as Solaris).

     We add extensions to those interfaces to solve problems not addressed by
     the original curses design, but those must not conflict with the X/Open
     documentation.
     We add extensions to those interfaces to solve problems not addressed by
     the original curses design, but those must not conflict with the X/Open
     documentation.


@@ -1287,6 +1323,91 @@ COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
     you may encounter when building a system with different versions of
     ncurses:
 
     you may encounter when building a system with different versions of
     ncurses:
 

+    6.1 (Jan 27, 2018)
+       Interface changes:
+
+       + X/Open Curses specifies a "reserved" void* parameter in several
+         functions, saying that it must be NULL.  In this release, if the
+         parameter is non-NULL, it is interpreted as a point to an integer
+         containing a color pair.  In previous releases, a non-NULL parameter
+         caused an error return.  Portable applications are unaffected.  Here
+         are the functions which have been extended:
+               attr_get
+               attr_off
+               attr_on
+               attr_set
+               chgat
+               color_set
+               mvchgat
+               mvwchgat
+               slk_attr_off
+               slk_attr_on
+               slk_attr_set
+               wattr_get
+               wattr_on
+               wattr_off
+               wattr_set
+               wchgat
+               wcolor_set
+
+       + the TERMINAL structure declared in <term.h> has been made opaque,
+         and its size increased to handle the increased size of color pair
+         and color value, as well as other numeric capabilities.
+
+         A few applications required change, e.g., to use def_prog_mode;
+         only one application (tack) is known to have a valid reason for
+         accessing these internal details, and that was addressed by the
+         release of tack 1.08 in 2017.  Internal functions marked as used
+         by tack will be deprecated in future releases.
+
+       Added extensions:
+
+       + Several new functions were added to manipulate extended color pairs
+         and color values.  These include:
+               alloc_pair
+               extended_color_content
+               extended_pair_content
+               extended_slk_color
+               find_pair
+               free_pair
+               init_extended_color
+               init_extended_pair
+               reset_color_pairs
+
+         as well as corresponding sp-functions.
+
+       + A new terminfo capability "RGB" tells the ncurses library that the
+         color values are red/green/blue, to eliminate the need for palettes
+         in that special case for the color_content function.
+
+       Added internal functions (other than "_sp" variants):
+               _nc_copy_termtype2
+               _nc_export_termtype2
+               _nc_fallback2
+               _nc_find_prescr
+               _nc_forget_prescr
+               _nc_free_termtype2
+               _nc_read_entry2
+               _nc_write_object
+
+       Removed internal functions:
+               _nc_check_termtype
+               _nc_resolve_uses
+
+       Modified internal functions:
+
+       + symbols are used by tic/infocmp/toe:
+               _nc_align_termtype - change parameters to TERMTYPE2*
+               _nc_check_termtype2 - change parameter to TERMTYPE2*
+               _nc_read_file_entry - change parameter to TERMTYPE2*
+               _nc_read_termtype - change parameter to TERMTYPE2*
+               _nc_trim_sgr0 - change parameter to TERMTYPE2*
+               _nc_write_entry - change parameter to TERMTYPE2*
+
+       + symbols used only within the library:
+               _nc_fallback - change return type to TERMTYPE2*
+               _nc_init_termtype - change parameter to TERMTYPE2*
+

     6.0 (Aug 08, 2015)
        Interface changes:
 
     6.0 (Aug 08, 2015)
        Interface changes:
 


@@ -2107,7 +2228,7 @@ USING NCURSES WITH GPM:
        but the linker may not cooperate, producing mysterious errors.
        See the FAQ, as well as the discussion under the --with-gpm option:
 
        but the linker may not cooperate, producing mysterious errors.
        See the FAQ, as well as the discussion under the --with-gpm option:
 

-       http://invisible-island.net/ncurses/ncurses.faq.html#using_gpm_lib
+       https://invisible-island.net/ncurses/ncurses.faq.html#using_gpm_lib

 
 BUILDING NCURSES WITH A CROSS-COMPILER
        Ncurses can be built with a cross-compiler.  Some parts must be built
 
 BUILDING NCURSES WITH A CROSS-COMPILER
        Ncurses can be built with a cross-compiler.  Some parts must be built