ncurses 6.0 - patch 20171021
[ncurses.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 8252244d8d26dd620567be24f37a273d8606227e..87c9e3b145c5b360dbaad422b6b836af763b9f55 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
 -------------------------------------------------------------------------------
--- Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.               --
+-- Copyright (c) 1998-2016,2017 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.194 2015/10/24 19:03:42 Tomas.Cech Exp $
+-- $Id: INSTALL,v 1.198 2017/07/27 08:34:34 tom Exp $
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
@@ -470,6 +470,26 @@ SUMMARY OF CONFIGURE OPTIONS:
        list documented in X/Open.  ncurses provides varargs support for this
        function.  Use --disable-tparm-varargs to disable this support.
 
        list documented in X/Open.  ncurses provides varargs support for this
        function.  Use --disable-tparm-varargs to disable this support.
 
+    --disable-wattr-macros
+       The 6.0 ABI adds support for extended colors and for extended mouse.
+       The former is a noticeable problem when developers inadvertantly
+       compile using the ncurses6 header files and link with an ncurses5
+       library, because the wattr* macros use a new field in the WINDOW
+       structure.  These macros are used in several applications.
+
+       Since ncurses provides an actual function for each of these macros,
+       suppressing them from the curses.h header allows the ncurses5 libraries
+       to be used in most applications.
+
+       NOTE: The extended colors also are used in the cchar_t structure, but
+       fewer applications use that.
+
+       NOTE: This workaround does not help with mismatches in the ncurses
+       mouse version.  The extended mouse feature uses one less fewer bit for
+       each button, so that only the first button will work as expected with
+       a mismatch between header and library.  Again, most applications will
+       work, since most use only the first button.
+
     --enable-assertions
        For testing, compile-in assertion code.  This is used only for a few
        places where ncurses cannot easily recover by returning an error code.
     --enable-assertions
        For testing, compile-in assertion code.  This is used only for a few
        places where ncurses cannot easily recover by returning an error code.
@@ -597,6 +617,14 @@ SUMMARY OF CONFIGURE OPTIONS:
        terminfo entries.  This is the default, unless you have disabled the
        extended functions.
 
        terminfo entries.  This is the default, unless you have disabled the
        extended functions.
 
+    --enable-opaque-curses
+    --enable-opaque-form
+    --enable-opaque-menu
+    --enable-opaque-panel
+       Define symbol in curses.h which controls whether some library
+       structures are treated as "opaque".  The --enable-opaque-curses option
+       is overridden by the --enable-reentrant option.
+
     --enable-pc-files
        If pkg-config is found (see --with-pkg-config), generate ".pc" files
        for each of the libraries, and install them in pkg-config's library
     --enable-pc-files
        If pkg-config is found (see --with-pkg-config), generate ".pc" files
        for each of the libraries, and install them in pkg-config's library
@@ -607,9 +635,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        call can be interrupted for SIGWINCH.
 
     --enable-reentrant
        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
-       set if --with-pthread is used.
+       Compile configuration which improves reentrant use of the 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.
 
        Enabling this option adds a "t" to the library names, except for the
        special case when --enable-weak-symbols is also used.
@@ -1165,7 +1193,7 @@ SUMMARY OF CONFIGURE OPTIONS:
        scripts which build several configurations for each release version,
        checking to see which of the "_nc_" symbols can be made local.  In
        addition to the ncurses libraries and programs, the symbols used
        scripts which build several configurations for each release version,
        checking to see which of the "_nc_" symbols can be made local.  In
        addition to the ncurses libraries and programs, the symbols used
-       by the "tack" program are made global.
+       by the "tack" program before version 1.08 are made global.
 
        These sample ".map" files will not cover all possible combinations.
        In some cases, e.g., when using the --with-weak-symbols option, you
 
        These sample ".map" files will not cover all possible combinations.
        In some cases, e.g., when using the --with-weak-symbols option, you