ncurses 6.0 - patch 20170603
[ncurses.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 0dbed2b4f35b5081bf96bc85d4e416da3f135bab..2bf47c2028617f50d26a6bdc9c371c67dc13e3b7 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             --
@@ -25,7 +25,7 @@
 -- sale, use or other dealings in this Software without prior written        --
 -- authorization.                                                            --
 -------------------------------------------------------------------------------
--- $Id: INSTALL,v 1.192 2015/08/15 20:11:48 tom Exp $
+-- $Id: INSTALL,v 1.197 2017/02/12 19:49:52 tom Exp $
 ---------------------------------------------------------------------
              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.
 
+    --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.
@@ -597,6 +617,14 @@ SUMMARY OF CONFIGURE OPTIONS:
        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
@@ -607,9 +635,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        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.
@@ -978,7 +1006,7 @@ SUMMARY OF CONFIGURE OPTIONS:
        copying the man-page for each alias.
 
     --with-manpage-tbl
-       Tell the configure script that you with to preprocess the manpages
+       Tell the configure script that you wish to preprocess the manpages
        by running them through tbl to generate tables understandable by
        nroff.
 
@@ -1093,6 +1121,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        Specify a search-list of terminfo directories which will be compiled
        into the ncurses library (default: DATADIR/terminfo)
 
+       This is a colon-separated list, like the TERMINFO_DIRS environment
+       variable.
+
     --with-termlib[=XXX]
        When building the ncurses library, organize this as two parts:  the
        curses library (libncurses) and the low-level terminfo library