-- $Id: INSTALL,v 1.71 2004/02/07 21:06:05 tom Exp $---------------------------------------------------------------------             How to install Ncurses/Terminfo on your system---------------------------------------------------------------------    ************************************************************    * READ ALL OF THIS FILE BEFORE YOU TRY TO INSTALL NCURSES. *    ************************************************************You should be reading the file INSTALL in a directory called ncurses-d.d, whered.d is the current version number.  There should be several subdirectories,including `c++', `form', `man', `menu', 'misc', `ncurses', `panel', `progs',and `test'.  See the README file for a roadmap to the package.If you are a Linux or FreeBSD or NetBSD distribution integrator or packager,please read and act on the section titled IF YOU ARE A SYSTEM INTEGRATORbelow.If you are converting from BSD curses and do not have root access, be sureto read the BSD CONVERSION NOTES section below.If you are using a version of XFree86 xterm older than 3.1.2F, see the sectionon RECENT XTERM VERSIONS below.If you are trying to build GNU Emacs using ncurses for terminal support,read the USING NCURSES WITH EMACS section below.If you are trying to build applications using gpm with ncurses,read the USING NCURSES WITH GPM section below.If you are running over the Andrew File System see the note below onUSING NCURSES WITH AFS.If you are cross-compiling, see the note below on BUILDING NCURSES WITH ACROSS-COMPILER.If you want to build the Ada95 binding, go to the Ada95 directory andfollow the instructions there.  The Ada95 binding is not covered below.If you are using anything but (a) Linux, or (b) one of the 4.4BSD-basedi386 Unixes, go read the Portability section in the TO-DO file before youdo anything else.REQUIREMENTS:------------You will need the following in order to build and install ncurses under UNIX:	* ANSI C compiler  (gcc, for instance)	* sh               (bash will do)	* awk              (mawk or gawk will do)	* sed	* BSD or System V style install (a script is enclosed)Ncurses has been also built in the OS/2 EMX environment.INSTALLATION PROCEDURE:----------------------1.  First, decide whether you want ncurses to replace your existing library (in    which case you'll need super-user privileges) or be installed in parallel    with it.    The --prefix option to configure changes the root directory for installing    ncurses.  The default is in subdirectories of /usr/local.  Use    --prefix=/usr to replace your default curses distribution.  This is the    default for Linux and BSD/OS users.    The package gets installed beneath the --prefix directory as follows:    In $(prefix)/bin:          tic, infocmp, captoinfo, tset,				reset, clear, tput, toe    In $(prefix)/lib:          libncurses*.* libcurses.a    In $(prefix)/share/terminfo: compiled terminal descriptions    In $(prefix)/include:      C header files    Under $(prefix)/man:       the manual pages    Note however that the configure script attempts to locate previous    installation of ncurses, and will set the default prefix according to where    it finds the ncurses headers.2.  Type `./configure' in the top-level directory of the distribution to    configure ncurses for your operating system and create the Makefiles.    Besides --prefix, various configuration options are available to customize    the installation; use `./configure --help' to list the available options.    If your operating system is not supported, read the PORTABILITY section in    the file ncurses/README for information on how to create a configuration    file for your system.    The `configure' script generates makefile rules for one or more object    models and their associated libraries:	libncurses.a (normal)	libcurses.a (normal, a link to libncurses.a)		This gets left out if you configure with --disable-overwrite.	libncurses.so (shared)	libncurses_g.a (debug)	libncurses_p.a (profile)	libncurses.la (libtool)    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.  Building and running the wide-character code relies on a fairly    recent implementation of libiconv.  We have built this configuration on    Linux using libiconv, sometimes requiring libutf8.    If you do not specify any models, the normal and debug libraries will be    configured.  Typing `configure' with no arguments is equivalent to:	./configure --with-normal --with-debug --enable-overwrite    Typing	./configure --with-shared    makes the shared libraries the default, resulting in	./configure --with-shared --with-normal --with-debug --enable-overwrite    If you want only shared libraries, type	./configure --with-shared --without-normal --without-debug    Rules for generating shared libraries are highly dependent upon the choice    of host system and compiler.  We've been testing shared libraries on Linux    and SunOS with gcc, but more work needs to be done to make shared libraries    work on other systems.    If you have libtool installed, you can type	./configure --with-libtool    to generate the appropriate static and/or shared libraries for your    platform using libtool.    You can make curses and terminfo fall back to an existing file of termcap    definitions by configuring with --enable-termcap.  If you do this, the    library will search /etc/termcap before the terminfo database, and will    also interpret the contents of the TERM environment variable.  See the    section BSD CONVERSION NOTES below.3.  Type `make'.  Ignore any warnings, no error messages should be produced.    This should compile the ncurses library, the terminfo compiler tic(1),    captoinfo(1), infocmp(1), toe(1), clear(1) tset(1), reset(1), and tput(1)    programs (see the manual pages for explanation of what they do), some test    programs, and the panels, menus, and forms libraries.4.  Run ncurses and several other test programs in the test directory to    verify that ncurses functions correctly before doing an install that    may overwrite system files.  Read the file test/README for details on    the test programs.    NOTE: You must have installed the terminfo database, or set the    environment variable $TERMINFO to point to a SVr4-compatible terminfo    database before running the test programs.  Not all vendors' terminfo    databases are SVr4-compatible, but most seem to be.  Exceptions include    DEC's Digital Unix (formerly known as OSF/1).    If you run the test programs WITHOUT installing terminfo, ncurses may    read the termcap file and cache that in $HOME/.terminfo, which will    thereafter be used instead of the terminfo database.  See the comments    on "--enable-getcap-cache", to see why this is a Bad Thing.    It is possible to configure ncurses to use other terminfo database formats.    A few are provided as examples in the include-directory (see --with-caps).    The ncurses program is designed specifically to test the ncurses library.    You can use it to verify that the screen highlights work correctly, that    cursor addressing and window scrolling works OK, etc.5.  Once you've tested, you can type `make install' to install libraries,    the programs, the terminfo database and the manual pages.  Alternately, you    can type `make install' in each directory you want to install.  In the    top-level directory, you can do a partial install using these commands:	'make install.progs'    installs tic, infocmp, etc...	'make install.includes' installs the headers.	'make install.libs'     installs the libraries (and the headers).	'make install.data'     installs the terminfo data. (Note: `tic' must				be installed before the terminfo data can be				compiled).	'make install.man'      installs the manual pages.  ############################################################################  #     CAVEAT EMPTOR: `install.data' run as root will NUKE any existing     #  #  terminfo database. If you have any custom or unusual entries SAVE them  #  #  before you install ncurses.  I have a file called terminfo.custom for   #  #  this purpose.  Don't forget to run tic on the file once you're done.    #  ############################################################################    The terminfo(5) manual page must be preprocessed with tbl(1) before    being formatted by nroff(1).  Modern man(1) implementations tend to do    this by default, but you may want to look at your version's manual page    to be sure.  You may also install the manual pages after preprocessing    with tbl(1) by specifying the configure option --with-manpage-tbl.    If the system already has a curses library that you need to keep using    you'll need to distinguish between it and ncurses.  See the discussion of    --disable-overwrite.  If ncurses is installed outside the standard    directories (/usr/include and /usr/lib) then all your users will need to    use the -I option to compile programs and -L to link them.    If you have another curses installed in your system and you accidentally    compile using its curses.h you'll end up with a large number of    undefined symbols at link time.    IF YOU DO NOT HAVE ROOT: Change directory to the `progs' subdirectory    and run the `capconvert' script.  This script will deduce various things    about your environment and use them to build you a private terminfo tree,    so you can use ncurses applications.    If more than one user at your site does this, the space for the duplicate    trees is wasted.  Try to get your site administrators to install a system-    wide terminfo tree instead.    See the BSD CONVERSION NOTES section below for a few more details.6.  The c++ directory has C++ classes that are built on top of ncurses and    panels.  You must have c++ (and its libraries) installed before you can    compile and run the demo.    Use --without-cxx-binding to tell configure to not build the C++ bindings    and demo.    If you do not have C++, you must use the --without-cxx option to tell    the configure script to not attempt to determine the type of 'bool'    which may be supported by C++.  IF YOU USE THIS OPTION, BE ADVISED THAT    YOU MAY NOT BE ABLE TO COMPILE (OR RUN) NCURSES APPLICATIONS WITH C++.SUMMARY OF CONFIGURE OPTIONS:----------------------------    The configure script provides a short list of its options when you type	./configure --help    The --help and several options are common to all configure scripts that are    generated with autoconf.  Those are all listed before the line	--enable and --with options recognized:    The other options are specific to this package.  We list them in alphabetic    order.    --disable-assumed-color	With ncurses 5.1, we introduced a new function, assume_default_colors()	which allows applications to specify what the default foreground and	background color are assumed to be.  Most color applications use	full-screen color; but a few do not color the background.  While the	assumed values can be overridden by invoking assume_default_colors(),	you may find it useful to set the assumed values to the pre-5.1	convention, using this configure option.    --disable-big-core	Assume machine has little memory.  The configure script attempts to	determine if your machine has enough memory (about 6Mb) to compile the	terminfo database without writing portions to disk.  Some allocators	return deceptive results, so you may have to override the configure	script.  Or you may be building tic for a smaller machine.    --disable-database	Use only built-in data.  The ncurses libraries normally read terminfo	and termcap data from disk.  You can configure ncurses to have a	built-in database, aka "fallback" entries.  Embedded applications may	have no need for an external database.  Some, but not all of the	programs are useful in this configuration, e.g., reset and tput versus	infocmp and tic.    --disable-ext-funcs	Disable function-extensions.  Configure ncurses without the functions	that are not specified by XSI.  See ncurses/modules for the exact	list of library modules that would be suppressed.    --disable-hashmap	Compile without hashmap scrolling-optimization code.  This algorithm is	the default.    --disable-home-terminfo	The $HOME/.terminfo directory is normally added to ncurses' search	list for reading/writing terminfo entries, since that directory is	more likely writable than the system terminfo database.  Use this	option to disable the feature altogether.    --disable-leaks	For testing, compile-in code that frees memory that normally would not	be freed, to simplify analysis of memory-leaks.    --disable-macros	For testing, use functions rather than macros.  The program will run	more slowly, but it is simpler to debug.  This makes a header file	"nomacros.h".  See also the --enable-expanded option.    --disable-overwrite	If you are installing ncurses on a system which contains another	development version of curses, or which could be confused by the loader	for another version, we recommend that you leave out the link to	-lcurses.  The ncurses library is always available as -lncurses.	Disabling overwrite also causes the ncurses header files to be	installed into a subdirectory, e.g., /usr/local/include/ncurses,