ncurses 5.8 - patch 20110307
[ncurses.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 463010e907ad86818e9e8999386328b903c8099c..167b228075b3f53988566020d14f16eeffcc7c09 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
--- Copyright (c) 1998-2009,2010 Free Software Foundation, Inc.               --
+-- Copyright (c) 1998-2010,2011 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.147 2010/09/04 20:57:46 tom Exp $
+-- $Id: INSTALL,v 1.153 2011/03/05 19:09:48 tom Exp $
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
@@ -525,6 +525,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        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
@@ -586,6 +590,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        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
@@ -597,6 +606,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        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
@@ -660,6 +674,10 @@ SUMMARY OF CONFIGURE OPTIONS:
        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.
@@ -715,7 +733,8 @@ SUMMARY OF CONFIGURE OPTIONS:
        --enable-widec is not given) a character.  Prior to ncurses 5.5, this
        was always unsigned long, but with ncurses 5.5, it may be unsigned.
        Use this option if you need to preserve compatibility with 64-bit
-       executables.
+       executables, e.g., by setting "--with-chtype=long" (the configure
+       script supplies "unsigned").
 
     --with-database=XXX
        Specify the terminfo source file to install.  Usually you will wish
@@ -1050,6 +1069,60 @@ COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
     you may encounter when building a system with different versions of
     ncurses:
 
+    5.8 (Feb 26, 2011)
+       Interface changes:
+
+       + add an alternate library configuration, i.e., "terminal driver" to
+         support port to Windows, built with MinGW.  There are two drivers
+         (terminfo and Windows console).  The terminfo driver works on other
+         platforms.
+
+       + add a new set of functions which accept a SCREEN* parameter, in
+         contrast with the original set which use the global value "sp".
+         By default, these names end with "_sp", and are otherwise
+         functionally identical with the originals.
+
+         In addition to the "_sp" functions, there are a few new functions
+         associated with this feature:  ceiling_panel, ground_panel,
+         new_prescr.
+
+         If the library is not built with the sp-funcs extension, there
+         are no related interface changes.
+
+       + add tiparm function based on review of X/Open Curses Issue 7.
+
+       + change internal _nc_has_mouse function to public has_mouse function
+
+       Added extensions:
+
+       + add a few more functions to support the NCURSES_OPAQUE feature:
+         get_escdelay, is_pad, is_subwin
+
+       Added internal functions (other than "_sp" variants):
+               _nc_curscr_of
+               _nc_format_slks
+               _nc_get_alias_table
+               _nc_get_hash_info
+               _nc_insert_wch
+               _nc_newscr_of
+               _nc_outc_wrapper
+               _nc_retrace_char
+               _nc_retrace_int_attr_t
+               _nc_retrace_mmask_t
+               _nc_setup_tinfo
+               _nc_stdscr_of
+               _nc_tinfo_cmdch
+
+       Removed internal functions:
+               _nc_makenew (some configurations replace by _nc_makenew_sp)
+
+       Modified internal functions:
+               _nc_UpdateAttrs
+               _nc_get_hash_table
+               _nc_has_mouse
+               _nc_insert_ch
+               _nc_wgetch
+
     5.7 (November 2, 2008)
        Interface changes: