ncurses 5.7 - patch 20090411

[ncurses.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 3119da759ccac39cca6148bfa7710598acbc9dbf..0213b14799ae94acf9f115914cc59f295acc5600 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
 -------------------------------------------------------------------------------

--- Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.               --
+-- Copyright (c) 1998-2008,2009 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.131 2008/10/11 18:48:48 tom Exp $
+-- $Id: INSTALL,v 1.138 2009/03/21 20:23:29 tom Exp $

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


@@ -525,6 +525,11 @@ 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-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
+       directory.
+

     --enable-reentrant
        Compile experimental configuration which improves reentrant use of the
        library by reducing global and static variables.  This option is also
     --enable-reentrant
        Compile experimental configuration which improves reentrant use of the
        library by reducing global and static variables.  This option is also


@@ -850,6 +855,9 @@ SUMMARY OF CONFIGURE OPTIONS:
        those using termcap, do not use the higher speeds.  Your application
        (or system, in general) may or may not.
 
        those using termcap, do not use the higher speeds.  Your application
        (or system, in general) may or may not.
 

+    --with-pkg-config=[DIR]
+       Check for pkg-config, optionally specifying its path.
+

     --with-profile
        Generate profile-libraries These are named by adding "_p" to the root,
        e.g., libncurses_p.a
     --with-profile
        Generate profile-libraries These are named by adding "_p" to the root,
        e.g., libncurses_p.a


@@ -946,6 +954,17 @@ SUMMARY OF CONFIGURE OPTIONS:
        For testing, compile with debug option.
        This also sets the --disable-leaks option.
 
        For testing, compile with debug option.
        This also sets the --disable-leaks option.
 

+    --with-wrap-prefix=XXX
+       When using the --enable-reentrant option, ncurses redefines variables
+       that would be global in curses, e.g., LINES, as a macro that calls a
+       "wrapping" function which fetches the data from the current SCREEN
+       structure.  Normally that function is named by prepending "_nc_" to the
+       variable's name.  The function is technically private (since portable
+       applications would not refer directly to it).  But according to one
+       line of reasoning, it is not the same type of "private" as functions
+       which applications should not call even via a macro.  This configure
+       option lets you choose the prefix for these wrapped variables.
+

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


@@ -975,6 +994,9 @@ SUMMARY OF CONFIGURE OPTIONS:
     --without-dlsym
        Do not use dlsym() to load GPM dynamically.
 
     --without-dlsym
        Do not use dlsym() to load GPM dynamically.
 

+    --without-manpages
+       Tell the configure script to suppress the install of ncurses' manpages.
+

     --without-progs
        Tell the configure script to suppress the build of ncurses' application
        programs (e.g., tic).  The test applications will still be built if you
     --without-progs
        Tell the configure script to suppress the build of ncurses' application
        programs (e.g., tic).  The test applications will still be built if you


@@ -1001,6 +1023,94 @@ 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:
 

+    5.7 (November 2, 2008)
+       Interface changes:
+
+       + generate linkable stubs for some macros:
+               getattrs
+
+       + Add new library configuration for tic-library (the non-curses portion
+         of the ncurses library used for the tic program as well as some
+         others such as tack.  There is no API change, but makefiles would be
+         changed to use the tic-library built separately.
+         
+         tack, distributed separately from ncurses, uses some of the internal
+         _nc_XXX functions, which are declared in the tic.h header file.
+
+         The reason for providing this separate library is that none of the
+         functions in it are suitable for threaded applications.
+
+       + Add new library configuration (ncursest, ncurseswt) which provides
+         rudimentary support for POSIX threads.  This introduces opaque
+         access functions to the WINDOW structure and adds a parameter to
+         several internal functions.
+
+       + move most internal variables (except tic-library) into data blocks
+         _nc_globals and _nc_prescreen to simplify analysis.  Those were
+         globally accessible, but since they were not part of the documented
+         API, there is no ABI change.
+
+       + changed static tables of strings to be indices into long strings, to
+         improve startup performance.  This changes parameter lists for some
+         of the internal functions.
+
+       Added extensions:
+
+       + add NCURSES_OPAQUE definition in curses.h to control whether internal
+         details of the WINDOW structure are visible to an application.  This
+         is always defined when the threaded library is built, and is optional
+         otherwise.  New functions for this:  is_cleared, is_idcok, is_idlok,
+         is_immedok, is_keypad, is_leaveok, is_nodelay, is_notimeout,
+         is_scrollok, is_syncok, wgetparent and wgetscrreg.
+
+       + the threaded library (ncursest) also disallows direct updating of
+         global curses-level variables, providing functions (via macros) for
+         obtaining their value.  A few of those variables can be modified by
+         the application, using new functions:  set_escdelay, set_tabsize
+
+       + added functions use_window() and use_screen() which wrap a mutex
+         (if threading is configured) around a call to a user-supplied
+         function.
+
+       Added internal functions:
+               _nc_get_alias_table
+               _nc_get_screensize
+               _nc_keyname
+               _nc_screen_of
+               _nc_set_no_padding
+               _nc_tracechar
+               _nc_tracemouse
+               _nc_unctrl
+               _nc_ungetch
+
+               These are used for leak-testing, and are stubs for
+               ABI compatibility when ncurses is not configured for that
+               using the --disable-leaks configure script option:
+
+               _nc_free_and_exit
+               _nc_leaks_tinfo
+
+       Removed internal functions:
+               none
+
+       Modified internal functions:
+               _nc_fifo_dump
+               _nc_find_entry
+               _nc_handle_sigwinch
+               _nc_init_keytry
+               _nc_keypad
+               _nc_locale_breaks_acs
+               _nc_timed_wait
+               _nc_update_screensize
+
+               Use new typedef TRIES to replace "struct tries":
+
+               _nc_add_to_try
+               _nc_expand_try
+               _nc_remove_key
+               _nc_remove_string
+               _nc_trace_tries
+

     5.6 (December 17, 2006)
        Interface changes:
 
     5.6 (December 17, 2006)
        Interface changes: