xref: /freebsd/contrib/ncurses/ncurses/README (revision 1f474190)
1-------------------------------------------------------------------------------
2-- Copyright 2020 Thomas E. Dickey                                           --
3-- Copyright 1998-2006,2009 Free Software Foundation, Inc.                   --
4--                                                                           --
5-- Permission is hereby granted, free of charge, to any person obtaining a   --
6-- copy of this software and associated documentation files (the             --
7-- "Software"), to deal in the Software without restriction, including       --
8-- without limitation the rights to use, copy, modify, merge, publish,       --
9-- distribute, distribute with modifications, sublicense, and/or sell copies --
10-- of the Software, and to permit persons to whom the Software is furnished  --
11-- to do so, subject to the following conditions:                            --
12--                                                                           --
13-- The above copyright notice and this permission notice shall be included   --
14-- in all copies or substantial portions of the Software.                    --
15--                                                                           --
16-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
17-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
18-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
19-- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
20-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
21-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
22-- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
23--                                                                           --
24-- Except as contained in this notice, the name(s) of the above copyright    --
25-- holders shall not be used in advertising or otherwise to promote the      --
26-- sale, use or other dealings in this Software without prior written        --
27-- authorization.                                                            --
28-------------------------------------------------------------------------------
29-- $Id: README,v 1.11 2020/02/02 23:34:34 tom Exp $
30-------------------------------------------------------------------------------
31For discussion of the package internals, see hackguide.html in the doc/html
32directory.
33
34-------------------------------------------------------------------------------
35The llib-lXXXX files could be used as lint-library sources (and were, at one
36time).  However, they are actually used as a documentation aid to keep track
37of changes to the public/private interfaces in ncurses.  Most of the text in
38these files is generated using cproto; some manual cleanup and adjustment of
39types (to reflect #define's in curses.h) is needed.  The functions listed in
40the llib-lXXXX files do not correspond to the default configure options; some
41additional ones are added to include "all" of the entrypoints for each of the
42major configurations (normal, wide-character, threaded):
43
44	--disable-macros
45	--disable-root-environ
46	--enable-expanded
47	--enable-getcap
48	--enable-getcap-cache
49	--enable-sp-funcs
50	--enable-termcap
51	--with-develop
52