ncurses 6.3
[ncurses.git] / README
diff --git a/README b/README
index 37cb8d2b5c197a1b1d46819b335dc95aa00215b6..84998f232edfc664b7f492a7ac559d49234c6f58 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,32 @@
--- $Id: README,v 1.22 2004/08/07 23:42:43 tom Exp $
+-------------------------------------------------------------------------------
+-- Copyright 2020,2021 Thomas E. Dickey                                      --
+-- Copyright 1998-2012,2018 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.29 2021/06/17 21:20:30 tom Exp $
 -------------------------------------------------------------------------------
                README file for the ncurses package
 
@@ -9,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 doc/html/hackguide.html for a tour of the package internals.
 
 ROADMAP AND PACKAGE OVERVIEW:
@@ -17,7 +45,7 @@ ROADMAP AND PACKAGE OVERVIEW:
 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'. 
+`man', `menu', `misc', `ncurses', `panel', `progs', `test', 'tack' and `Ada95'.
 (The 'tack' program may be distributed separately).
 
 A full build/install of this package typically installs several libraries, a
@@ -51,6 +79,10 @@ 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
@@ -95,8 +127,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
+       tabs            -- set tabs on a terminal
        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
@@ -116,7 +149,7 @@ help you systematically exercise the library functions.
 
 AUTHORS:
 
-Pavel Curtis: 
+Pavel Curtis:
        wrote the original ncurses
 
 Zeyd M. Ben-Halim:
@@ -126,8 +159,10 @@ 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
-       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
+
+               https://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