ncurses 5.9 - patch 20130720
[ncurses.git] / README
diff --git a/README b/README
index cf1ab656612f25004446ff506dde2db2d33d2e7d..c509352b785e01adc58e05b976093cc748bb46be 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,31 @@
--- $Id: README,v 1.17 1998/02/15 01:26:47 tom Exp $
+-------------------------------------------------------------------------------
+-- Copyright (c) 1998-2011,2012 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             --
+-- "Software"), to deal in the Software without restriction, including       --
+-- without limitation the rights to use, copy, modify, merge, publish,       --
+-- distribute, distribute with modifications, sublicense, and/or sell copies --
+-- of the Software, and to permit persons to whom the Software is furnished  --
+-- to do so, subject to the following conditions:                            --
+--                                                                           --
+-- The above copyright notice and this permission notice shall be included   --
+-- in all copies or substantial portions of the Software.                    --
+--                                                                           --
+-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
+-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
+-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
+-- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
+-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
+-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
+-- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
+--                                                                           --
+-- Except as contained in this notice, the name(s) of the above copyright    --
+-- holders shall not be used in advertising or otherwise to promote the      --
+-- sale, use or other dealings in this Software without prior written        --
+-- authorization.                                                            --
+-------------------------------------------------------------------------------
+-- $Id: README,v 1.25 2012/08/11 20:11:26 tom Exp $
 -------------------------------------------------------------------------------
                README file for the ncurses package
 
 -------------------------------------------------------------------------------
                README file for the ncurses package
 
@@ -10,7 +37,7 @@ See the file TO-DO for things that still need doing, including known bugs.
 Browse the file misc/ncurses-intro.html for narrative descriptions of how
 to use ncurses and the panel, menu, and form libraries.
  
 Browse the file misc/ncurses-intro.html for narrative descriptions of how
 to use ncurses and the panel, menu, and form libraries.
  
-Browse the file misc/hackguide.html for a tour of the package internals.
+Browse the file doc/html/hackguide.html for a tour of the package internals.
 
 ROADMAP AND PACKAGE OVERVIEW:
 
 
 ROADMAP AND PACKAGE OVERVIEW:
 
@@ -18,7 +45,7 @@ You should be reading this file in a directory called:  ncurses-d.d, where d.d
 is the current version number (see the dist.mk file in this directory for
 that).  There should be a number of subdirectories, including `c++', `form',
 `man', `menu', `misc', `ncurses', `panel', `progs', `test', 'tack' and `Ada95'. 
 is the current version number (see the dist.mk file in this directory for
 that).  There should be a number of subdirectories, including `c++', `form',
 `man', `menu', `misc', `ncurses', `panel', `progs', `test', 'tack' and `Ada95'. 
-(The 'tack' program is distributed separately).
+(The 'tack' program may be distributed separately).
 
 A full build/install of this package typically installs several libraries, a
 handful of utilities, and a database hierarchy.  Here is an inventory of the
 
 A full build/install of this package typically installs several libraries, a
 handful of utilities, and a database hierarchy.  Here is an inventory of the
@@ -43,6 +70,18 @@ The libraries are:
        libform.so         (shared)
        libform_g.a        (debug enabled)
 
        libform.so         (shared)
        libform_g.a        (debug enabled)
 
+If you configure using the --enable-widec option, a "w" is appended to the
+library names (e.g., libncursesw.a), and the resulting libraries support
+wide-characters, e.g., via a UTF-8 locale.  The corresponding header files
+are compatible with the non-wide-character configuration; wide-character
+features are provided by ifdef's in the header files.  The wide-character
+library interfaces are not binary-compatible with the non-wide-character
+version.
+
+If you configure using the --enable-reentrant option, a "t" is appended to the
+library names (e.g., libncursest.a) and the resulting libraries have a
+different binary interface which makes the ncurses interface more "opaque".
+
 The ncurses libraries implement the curses API.  The panel, menu and forms
 libraries implement clones of the SVr4 panel, menu and forms APIs.  The source
 code for these lives in the `ncurses', `panel', `menu', and `form' directories
 The ncurses libraries implement the curses API.  The panel, menu and forms
 libraries implement clones of the SVr4 panel, menu and forms APIs.  The source
 code for these lives in the `ncurses', `panel', `menu', and `form' directories
@@ -56,7 +95,7 @@ install.libs' rule as libncurses++.
 In the `Ada95' directory, you'll find code and documentation for an
 Ada95 binding of the curses API, to be used with the GNAT compiler.
 This binding is built by a normal top-level `make' if configure detects
 In the `Ada95' directory, you'll find code and documentation for an
 Ada95 binding of the curses API, to be used with the GNAT compiler.
 This binding is built by a normal top-level `make' if configure detects
-an usable version of GNAT (3.10 or above). It is not installed automatically.
+an usable version of GNAT (3.11 or above). It is not installed automatically.
 See the Ada95 directory for more build and installation instructions and
 for documentation of the binding.
 
 See the Ada95 directory for more build and installation instructions and
 for documentation of the binding.
 
@@ -87,8 +126,9 @@ The utilities are as follows:
        tic             -- terminfo source to binary compiler
        infocmp         -- terminfo binary to source decompiler/comparator
        clear           -- emits clear-screen for current terminal
        tic             -- terminfo source to binary compiler
        infocmp         -- terminfo binary to source decompiler/comparator
        clear           -- emits clear-screen for current terminal
+       tabs            -- set tabs on a terminal
        tput            -- shell-script access to terminal capabilities.
        tput            -- shell-script access to terminal capabilities.
-       toe             -- table of entries utility
+       toe             -- table of entries utility
        tset            -- terminal-initialization utility
 
 The first two (tic and infocmp) are used for manipulating terminfo
        tset            -- terminal-initialization utility
 
 The first two (tic and infocmp) are used for manipulating terminfo
@@ -96,10 +136,10 @@ descriptions; the next two (clear and tput) are for use in shell scripts.  The
 last (tset) is provided for 4.4BSD compatibility.  The source code for all of
 these lives in the `progs' directory.
 
 last (tset) is provided for 4.4BSD compatibility.  The source code for all of
 these lives in the `progs' directory.
 
-Detailed documentation for all libraries and utilities can be found in
-the `man' directory.  An HTML introduction to ncurses, panels, and
-menus programming lives in the `misc' directory.  Manpages in HTML format
-are under `Ada95/html'.
+Detailed documentation for all libraries and utilities can be found in the
+`man' and `doc' directories.  An HTML introduction to ncurses, panels, and
+menus programming lives in the `doc/html' directory.  Manpages in HTML format
+are under `doc/html/man'.
 
 The `test' directory contains programs that can be used to verify or
 demonstrate the functions of the ncurses libraries.  See test/README for
 
 The `test' directory contains programs that can be used to verify or
 demonstrate the functions of the ncurses libraries.  See test/README for
@@ -114,12 +154,14 @@ Pavel Curtis:
 Zeyd M. Ben-Halim:
        port of original to Linux and many enhancements.
 
 Zeyd M. Ben-Halim:
        port of original to Linux and many enhancements.
 
-Thomas Dickey (maintainer since 1.9.9e):
+Thomas Dickey (maintainer for 1.9.9g through 4.1, resuming with FSF's 5.0):
        configuration scripts, porting, mods to adhere to XSI Curses in the
        areas of background color, terminal modes.  Also memory leak testing,
        the wresize, default colors and key definition extensions and numerous
        configuration scripts, porting, mods to adhere to XSI Curses in the
        areas of background color, terminal modes.  Also memory leak testing,
        the wresize, default colors and key definition extensions and numerous
-       bug fixes (more than half of those enumerated in NEWS beginning with
-       the internal release 1.8.9).
+       bug fixes -- more than half of those enumerated in NEWS beginning with
+       the internal release 1.8.9, see
+
+               http://invisible-island.net/personal/changelogs.html
 
 Florian La Roche (official maintainer for FSF's ncurses 4.2)
        Beginning with release 4.2, ncurses is distributed under an MIT-style
 
 Florian La Roche (official maintainer for FSF's ncurses 4.2)
        Beginning with release 4.2, ncurses is distributed under an MIT-style
@@ -171,5 +213,5 @@ suggesting improvements, and generally whining about ncurses :-)
 
 BUGS:
        See the INSTALL file for bug and developer-list addresses.
 
 BUGS:
        See the INSTALL file for bug and developer-list addresses.
-       The Hacker's Guide in the misc directory includes some guidelines
+       The Hacker's Guide in the doc directory includes some guidelines
        on how to report bugs in ways that will get them fixed most quickly.
        on how to report bugs in ways that will get them fixed most quickly.