-------------------------------------------------------------------------------
--- Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. --
+-- 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 --
-- sale, use or other dealings in this Software without prior written --
-- authorization. --
-------------------------------------------------------------------------------
--- $Id: INSTALL,v 1.147 2010/09/04 20:57:46 tom Exp $
+-- $Id: INSTALL,v 1.165 2012/02/19 21:24:52 tom Exp $
---------------------------------------------------------------------
How to install Ncurses/Terminfo on your system
---------------------------------------------------------------------
--disable-tic-depends
When building shared libraries, normally the tic library is linked to
- depend upon the ncurses library (and in turn, on the term-library if
- the --with-termlib option was given). The tic- and term-libraries
- ABI does not depend on the --enable-widec option. Some packagers have
- used this to reduce the number of library files which are packaged
- by using only one copy of those libraries. To make this work properly,
+ depend upon the ncurses library (or equivalently, on the tinfo-library
+ if the --with-termlib option was given). The tic- and tinfo-library
+ ABIs do not depend on the --enable-widec option. Some packagers have
+ used this to reduce the number of library files which are packaged by
+ using only one copy of those libraries. To make this work properly,
the tic library must be built without an explicit dependency on the
- ncurses (or ncursesw) library. Use this configure option to do that.
+ underlying library (ncurses vs ncursesw, tinfo vs tinfow). Use this
+ configure option to do that.
For example
configure --with-ticlib --with-shared --disable-tic-depends
changes several data references to functions to work around this
problem.
- NOTE: With ncurses 5.1, this may not be necessary, since we are
+ NOTE: With ncurses 5.1, this may not be necessary, since we are
told that some linkers interpret uninitialized global data as a
different type of reference which behaves as described above. We have
explicitly initialized all of the global data to work around the
warning. There will still be warnings due to subtle inconsistencies
in the interface, but at a lower level.
- NOTE: configuring ncurses with this option may detract from the
+ NOTE: configuring ncurses with this option may detract from the
portability of your applications by encouraging you to use const in
places where the XSI curses interface would not allow them. Similar
issues arise when porting to SVr4 curses, which uses const in even
encoded. This applies only to the wide-character (--enable-widec)
configuration.
- NOTE: using this option will make libraries which are not binary-
+ NOTE: using this option will make libraries which are not binary-
compatible with libncursesw 5.4. None of the interfaces change, but
applications which have an array of cchar_t's must be recompiled.
That allows one to use ncurses with a wheel mouse with xterm or
similar X terminal emulators.
- NOTE: using this option will make libraries which are not binary-
+ NOTE: using this option will make libraries which are not binary-
compatible with libncursesw 5.4. None of the interfaces change, but
applications which have mouse mask mmask_t's must be recompiled.
--enable-getcap-cache
Cache translated termcaps under the directory $HOME/.terminfo
- NOTE: this sounds good - it makes ncurses run faster the second time.
+ NOTE: this sounds good - it makes ncurses run faster the second time.
But look where the data comes from - an /etc/termcap containing lots of
entries that are not up to date. If you configure with this option and
forget to install the terminfo database before running an ncurses
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
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-string-hacks
+ Controls whether strlcat and strlcpy may be used. The same issue
+ applies to OpenBSD's warnings about snprintf, noting that this function
+ is weakly standardized.
+
+ Aside from stifling these warnings, there is no functional improvement
+ in ncurses.
+
--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
and --enable-getcap-cache options.
+ Termcap support requires run-time parsing rather than loading
+ predigested data. If you have specified --with-ticlib, then you
+ cannot have termcap support since run-time parsing is done in the
+ tic library, which is intentionally not part of normal linkage
+ dependencies.
+
--enable-warnings
Turn on GCC compiler warnings. There should be only a few.
--with-ada-sharedlib
Build a shared library for Ada95 binding, if the compiler permits.
+ NOTE: You must also set the --with-shared option on some platforms
+ for a successful build. You need not use this option when you set
+ --with-shared, unless you want to use the Ada shared library.
+
--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.
--enable-widec is not given) a character. Prior to ncurses 5.5, this
was always unsigned long, but with ncurses 5.5, it may be unsigned.
Use this option if you need to preserve compatibility with 64-bit
- executables.
+ executables, e.g., by setting "--with-chtype=long" (the configure
+ script supplies "unsigned").
--with-database=XXX
Specify the terminfo source file to install. Usually you will wish
make install DESTDIR=XXX
since the makefiles pass that variable to subordinate makes.
- NOTE: a few systems build shared libraries with fixed pathnames; this
+ NOTE: a few systems build shared libraries with fixed pathnames; this
option probably will not work for those configurations.
- --with-libtool[=XXX]
+ --with-lib-prefix=XXX
+ OS/2 EMX used a different naming convention from most Unix-like
+ platforms. It required that the "lib" part of a library name was
+ omitted. Newer EMX as part of eComStation does not follow that
+ convention. Use this option to override the configure script's
+ assumptions about the library-prefix. If this option is omitted, it
+ uses the original OS/2 EMX convention for that platform. Use
+ "--with-lib-prefix=lib" for the newer EMX in eComStation. Use
+ "--without-lib-prefix" to suppress it for other odd platforms.
+
+ --with-libtool[=XXX]
Generate libraries with libtool. If this option is selected, then it
overrides all other library model specifications. Note that libtool
must already be installed, uses makefile rules dependent on GNU make,
--with-pkg-config=[DIR]
Check for pkg-config, optionally specifying its path.
+ --with-pkg-config-libdir=[DIR]
+ If pkg-config was found, override the automatic check for its library
+ path.
+
--with-profile
Generate profile-libraries These are named by adding "_p" to the root,
e.g., libncurses_p.a
which you are building, typically using a ".so" suffix, along with
symbolic links that refer to the release version.
- NOTE: Unless you override the configure script by setting the $CFLAGS
+ NOTE: Unless you override the configure script by setting the $CFLAGS
environment variable, these will not be built with the -g debugging
option.
$LD_LIBRARY_PATH to point to the build tree, e.g.,
./misc/shlib make install
+ NOTE: If you use the --with-ada-sharedlib option, you should also
+ set this option, to ensure that C-language modules needed for the
+ Ada binding use appropriate compiler options.
+
--with-shlib-version=XXX
Specify whether to use the release or ABI version for shared libraries.
This is normally chosen automatically based on the type of system
library dependencies for tic and other programs built with the tic
library.
+ --with-tparm-arg[=XXX]
+ Override the type used for tparm() arguments, which normally is a
+ "long". However the function must assume that its arguments can hold a
+ pointer to char's which is not always workable for 64-bit platforms. A
+ better choice would be intptr_t, which was not available at the time
+ tparm's interface was defined.
+
+ If the option is not given, this defaults to "long".
+
--with-trace
Configure the trace() function as part of the all models of the ncurses
library. Normally it is part of the debug (libncurses_g) library only.
+ --with-xterm-kbs=XXX
+ Configure xterm's terminfo entries to use either BS (^H, i.e., ASCII
+ backspace) or DEL (^?, or 127). XXX can be BS (or bs, 8) or DEL
+ (or del, 127).
+
+ During installation, the makefile and scripts modifies the "xterm+kbs"
+ terminfo entry to use this setting.
+
--with-valgrind
For testing, compile with debug option.
This also sets the --disable-leaks option.
install as "ncurses.h" and modify the installed headers and manpages
accordingly.
+ Likewise, do not install an alias "curses" for the ncurses manpage.
+
--without-cxx
XSI curses declares "bool" as part of the interface. C++ also declares
"bool". Neither specifies the size and type of booleans, but both
you may encounter when building a system with different versions of
ncurses:
+ 5.8 (Feb 26, 2011)
+ Interface changes:
+
+ + add an alternate library configuration, i.e., "terminal driver" to
+ support port to Windows, built with MinGW. There are two drivers
+ (terminfo and Windows console). The terminfo driver works on other
+ platforms.
+
+ + add a new set of functions which accept a SCREEN* parameter, in
+ contrast with the original set which use the global value "sp".
+ By default, these names end with "_sp", and are otherwise
+ functionally identical with the originals.
+
+ In addition to the "_sp" functions, there are a few new functions
+ associated with this feature: ceiling_panel, ground_panel,
+ new_prescr.
+
+ If the library is not built with the sp-funcs extension, there
+ are no related interface changes.
+
+ + add tiparm function based on review of X/Open Curses Issue 7.
+
+ + change internal _nc_has_mouse function to public has_mouse function
+
+ Added extensions:
+
+ + add a few more functions to support the NCURSES_OPAQUE feature:
+ get_escdelay, is_pad, is_subwin
+
+ Added internal functions (other than "_sp" variants):
+ _nc_curscr_of
+ _nc_format_slks
+ _nc_get_alias_table
+ _nc_get_hash_info
+ _nc_insert_wch
+ _nc_newscr_of
+ _nc_outc_wrapper
+ _nc_retrace_char
+ _nc_retrace_int_attr_t
+ _nc_retrace_mmask_t
+ _nc_setup_tinfo
+ _nc_stdscr_of
+ _nc_tinfo_cmdch
+
+ Removed internal functions:
+ _nc_makenew (some configurations replace by _nc_makenew_sp)
+
+ Modified internal functions:
+ _nc_UpdateAttrs
+ _nc_get_hash_table
+ _nc_has_mouse
+ _nc_insert_ch
+ _nc_wgetch
+
5.7 (November 2, 2008)
Interface changes:
By default, there are no entries on the fallback list. After you have
built the ncurses suite for the first time, you can change the list
(the process needs infocmp(1)). To do so, use the script
- ncurses/tinfo/MKfallback.sh. A configure script option
+ ncurses/tinfo/MKfallback.sh. The configure script option
--with-fallbacks does this (it accepts a comma-separated list of the
names you wish, and does not require a rebuild).
If you wanted (say) to have linux, vt100, and xterm fallbacks, you
- would use the commands
+ might use the commands
cd ncurses;
- tinfo/MKfallback.sh linux vt100 xterm >fallback.c
+ tinfo/MKfallback.sh \
+ $TERMINFO \
+ ../misc/terminfo.src \
+ `which tic` \
+ linux vt100 xterm >fallback.c
+
+ The first three parameters of the script are normally supplied by
+ the configured makefiles via the "--with-fallbacks" option. They
+ are
+
+ 1) the location of the terminfo database
+ 2) the source for the terminfo entries
+ 3) the location of the tic program, used to create a terminfo
+ database.
Then just rebuild and reinstall the library as you would normally.
You can restore the default empty fallback list with
- tinfo/MKfallback.sh >fallback.c
+ tinfo/MKfallback.sh \
+ $TERMINFO \
+ ../misc/terminfo.src \
+ `which tic` \
+ >fallback.c
The overhead for an empty fallback list is one trivial stub function.
Any non-empty fallback list is const-ed and therefore lives in sharable
projects / ncurses.git / blobdiff