-------------------------------------------------------------------------------
--- Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. --
+-- Copyright (c) 1998-2009,2010 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 --
-- sale, use or other dealings in this Software without prior written --
-- authorization. --
-------------------------------------------------------------------------------
--- $Id: INSTALL,v 1.140 2009/08/01 19:32:04 tom Exp $
+-- $Id: INSTALL,v 1.148 2010/10/23 22:41:32 tom Exp $
---------------------------------------------------------------------
How to install Ncurses/Terminfo on your system
---------------------------------------------------------------------
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 INTEGRATOR
-below.
+If you are a distribution integrator or packager, please read and act on the
+section titled IF YOU ARE A SYSTEM INTEGRATOR below.
If you are converting from BSD curses and do not have root access, be sure
to read the BSD CONVERSION NOTES section below.
If you want to build the Ada95 binding, go to the Ada95 directory and
follow 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-based
-i386 Unixes, go read the Portability section in the TO-DO file before you
-do anything else.
-
REQUIREMENTS:
------------
The --prefix option to configure changes the root directory for installing
ncurses. The default is normally in subdirectories of /usr/local, except
- for systems where ncurses is normally installed as a system library, e.g.,
- Linux, the various BSD systems and Cygwin. Use --prefix=/usr to replace
- your default curses distribution.
+ for systems where ncurses is normally installed as a system library (see
+ "IF YOU ARE A SYSTEM INTEGRATOR"). Use --prefix=/usr to replace your
+ default curses distribution.
The package gets installed beneath the --prefix directory as follows:
In $(prefix)/bin: tic, infocmp, captoinfo, tset,
- reset, clear, tput, toe
+ reset, clear, tput, toe, tabs
In $(prefix)/lib: libncurses*.* libcurses.a
In $(prefix)/share/terminfo: compiled terminal descriptions
In $(prefix)/include: C header files
Do not use commands such as
- make install prefix=XXX
+ make install prefix=XXX
to change the prefix after configuration, since the prefix value is used
for some absolute pathnames such as TERMINFO. Instead do this
- make install DESTDIR=XXX
+ make install DESTDIR=XXX
See also the discussion of --with-install-prefix.
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.
+ various systems using libiconv, sometimes requiring libutf8.
If you configure using the --with-pthread option, a "t" is appended to
the library names (e.g., libncursest.a, libncursestw.a).
./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
+ of host system and compiler. We've been testing shared libraries on
+ several systems, but more work needs to be done to make shared libraries
work on other systems.
If you have libtool installed, you can type
--disable-largefile
Disable compiler flags needed to use large-file interfaces.
+ --disable-libtool-version
+ when using --with-libtool, control how the major/minor version numbers
+ are used for constructing the library name.
+
+ The default uses the -version-number feature of libtool, which makes
+ the library names compatible (though not identical) with the standard
+ build using --with-shared.
+
+ Use --disable-libtool-version to use the libtool -version-info feature.
+ This corresponds to the setting used before patch 20100515.
+
--disable-leaks
For testing, compile-in code that frees memory that normally would not
be freed, to simplify analysis of memory-leaks.
application. These are (for example $TERMINFO) those that allow the
search path for the terminfo or termcap entry to be customized.
+ --disable-rpath-hack
+ Normally the configure script helps link libraries found in unusual
+ places by adding an rpath option to the link command. If you are
+ building packages, this feature may be redundant. Use this option
+ to suppress the feature.
+
--disable-scroll-hints
Compile without scroll-hints code. This option is ignored when
hashmap scrolling is configured, which is the default.
may not be accurate, or that your stty settings have disabled the use
of tabs.
+ --enable-interop
+ Compile-in experimental interop bindings. These provide generic types
+ for the form-library.
+
--enable-mixed-case
Controls whether the filesystem on which the terminfo database resides
supports mixed-case filenames (normal for UNIX, but not on other
for each of the libraries, and install them in pkg-config's library
directory.
+ --enable-pthreads-eintr
+ add logic in threaded configuration to ensure that a read(2) system
+ call can be interrupted for SIGWINCH.
+
--enable-reentrant
Compile experimental configuration which improves reentrant use of the
library by reducing global and static variables. This option is also
is not strictly compatible. This option allows one to implement this
alteration without patching the source code.
+ --enable-sp-funcs
+ Compile-in support for extended functions which accept a SCREEN pointer,
+ reducing the need for juggling the global SP value with set_term() and
+ delscreen().
+
--enable-symlinks
If your system supports symbolic links, make tic use symbolic links
rather than hard links to save diskspace when writing aliases in the
capabilities as user-defined strings. This option is the default,
unless you have disabled the extended functions.
+ --enable-term-driver
+ Enable experimental terminal-driver. This is currently used for the
+ MinGW port, by providing a way to substitute the low-level terminfo
+ library with different terminal drivers.
+
--enable-termcap
Compile in support for reading terminal descriptions from termcap if no
match is found in the terminfo database. See also the --enable-getcap
--with-ada-objects=DIR
Tell where to install the Ada objects (default: PREFIX/lib/ada/adalib)
+ --with-ada-sharedlib
+ Build a shared library for Ada95 binding, if the compiler permits.
+
--with-bool=TYPE
If --without-cxx is specified, override the type used for the "bool"
declared in curses.h (normally the type is automatically chosen to
correspond with that in <stdbool.h>, or defaults to platform-specific
sizes).
+ --with-build-cpp=XXX
+ This option is provided by the same macro used for $BUILD_CC, etc.,
+ but is not directly used by ncurses.
+
--with-build-cc=XXX
If cross-compiling, specify a host C compiler, which is needed to
compile a few utilities which generate source modules for ncurses.
use Alessandro Rubini's GPM library to provide mouse support on the
Linux console. Prior to ncurses 5.5, this introduced a dependency on
the GPM library.
-
+
Currently ncurses uses the dlsym() function to bind to the library at
runtime, so it is only necessary that the library be present when
ncurses is built, to obtain the filename (or soname) used in the
Use a hashed database for storing terminfo data rather than storing
each compiled entry in a separate binary file within a directory
tree.
-
+
In particular, this uses the Berkeley database 1.8.5 interface, as
provided by that and its successors db 2, 3, and 4. The actual
interface is slightly different in the successor versions of the
--with-manpage-renames=XXX
Tell the configure script that you wish to rename the manpages while
- installing. Currently the only distribution which does this is
- the Linux Debian. The option value specifies the name of a file
- that lists the renamed files, e.g., $srcdir/man/man_db.renames
+ installing. Currently the only distribution which does this is Debian.
+ The option value specifies the name of a file that lists the renamed
+ files, e.g., $srcdir/man/man_db.renames
--with-manpage-symlinks
Tell the configure script that you wish to make symbolic links in the
loads the system's copy of the ncurses shared libraries. In that
case, using the misc/shlib script may be helpful, since it sets
$LD_LIBRARY_PATH to point to the build tree, e.g.,
- ./misc/shlib make install
+ ./misc/shlib make install
--with-shlib-version=XXX
Specify whether to use the release or ABI version for shared libraries.
programs (e.g., tic). The test applications will still be built if you
type "make", though not if you simply do "make install".
+ --without-tests
+ Tell the configure script to suppress the build of ncurses' test
+ programs.
+
--without-xterm-new
Tell the configure script to use "xterm-old" for the entry used in
the terminfo database. This will work with variations such as
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.
still used in this release to allow compiling with not-so-old
compilers.
- + form and menu libraries now work with wide-character data.
+ + form and menu libraries now work with wide-character data.
Applications which bypassed the form library and manipulated the
FIELD.buf data directly will not work properly with libformw, since
that no longer points to an array of char. The set_field_buffer()
4.0 (December 24, 1996)
- We bumped to version 4.0 because the newly released dynamic loader
- (ld.so.1.8.5) on Linux did not load shared libraries whose ABI and REL
+ We bumped to version 4.0 because the newly released Linux dynamic
+ loader (ld.so.1.8.5) did not load shared libraries whose ABI and REL
versions were inconsistent. At that point, ncurses ABI was 3.4 and the
REL was 1.9.9g, so we made them consistent.
Configuration and Installation:
- On platforms where ncurses is assumed to be installed in /usr/lib,
+ On platforms where ncurses is assumed to be installed in /usr/lib,
the configure script uses "/usr" as a default:
- Linux, FreeBSD, NetBSD, OpenBSD, Cygwin
+ GNU/Linux, FreeBSD, NetBSD, OpenBSD, Cygwin
For other platforms, the default is "/usr/local". See the discussion
of the "--disable-overwrite" option.
bsdos -- BSD/OS
If you are responsible for integrating ncurses for one of these
- distribution, please either use the recommended name or get back
+ distributions, please either use the recommended name or get back
to us explaining why you don't want to, so we can work out nomenclature
that will make users' lives easier rather than harder.
with this by making tic use symbolic links.
USING NCURSES WITH GPM:
- Ncurses 4.1 and up can be configured to use GPM (General Purpose
- Mouse) which is used on Linux console. Be aware that GPM is commonly
+ Ncurses 4.1 and up can be configured to use GPM (General Purpose Mouse)
+ which is used with Linux console. Be aware that GPM is commonly
installed as a shared library which contains a wrapper for the curses
wgetch() function (libcurses.o). Some integrators have simplified
linking applications by combining all or part of libcurses.so into the
projects / ncurses.git / blobdiff