]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - INSTALL
ncurses 5.9 - patch 20150307
[ncurses.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index ef6d7d6b235281505a53e39e46f335bc40b13e3a..cad224ad5b8e99e2d92b7df26301e476e1292ce8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
 -------------------------------------------------------------------------------
--- Copyright (c) 1998-2013,2014 Free Software Foundation, Inc.               --
+-- Copyright (c) 1998-2014,2015 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             --
@@ -25,7 +25,7 @@
 -- sale, use or other dealings in this Software without prior written        --
 -- authorization.                                                            --
 -------------------------------------------------------------------------------
--- $Id: INSTALL,v 1.178 2014/11/16 00:03:32 tom Exp $
+-- $Id: INSTALL,v 1.184 2015/01/24 23:24:22 tom Exp $
 ---------------------------------------------------------------------
              How to install Ncurses/Terminfo on your system
 ---------------------------------------------------------------------
@@ -364,11 +364,17 @@ SUMMARY OF CONFIGURE OPTIONS:
        a screen, since (even after calling endwin()), it must be available
        for use in the next call to refresh().  There are also chunks of
        memory held for performance reasons.  That makes it hard to analyze
-       curses applications for memory leaks.  To work around this, build
-       debugging version of the ncurses library which frees those chunks
+       curses applications for memory leaks.  To work around this, build a
+       debugging version of the ncurses library which frees those chunks
        which it can, and provides the _nc_free_and_exit() function to free
-       the remainder on exit.  The ncurses utility and test programs use this
-       feature, e.g., via the ExitProgram() macro.
+       the remainder and then exit.  The ncurses utility and test programs
+       use this feature, e.g., via the ExitProgram() macro.
+
+       Because this lies outside of the library's intended usage, it is not
+       normally considered part of the ABI.  If there were some (as yet
+       unplanned) extension which frees memory in a manner that would let the
+       library resume and reallocate memory, then that would not use a "_nc_"
+       prefix.
 
     --disable-lp64
        The header files will ignore use of the _LP64 symbol to make chtype
@@ -991,6 +997,11 @@ SUMMARY OF CONFIGURE OPTIONS:
        those using termcap, do not use the higher speeds.  Your application
        (or system, in general) may or may not.
 
+    --with-pc-suffix=SUFFIX
+       If ".pc" files are installed, optionally add a suffix to the files
+       and corresponding package names to separate unusual configurations.
+       If no option value is given (or if it is "none"), no suffix is added.
+
     --with-pkg-config=[DIR]
        Check for pkg-config, optionally specifying its path.
 
@@ -1118,15 +1129,33 @@ SUMMARY OF CONFIGURE OPTIONS:
     --with-versioned-syms[=XXX]
        The Solaris, GNU and reportedly some other linkers (ld) accept a
        "--version-script" option which tells the linker to annotate the
-       resulting objects with version identifiers.  The configure script
-       will automatically apply a suitable ".map" file to provide this
-       information for Linux.  Solaris mapfiles differ:
+       resulting objects with version identifiers.
+
+       Use "objdump -T" on a library to see the annotations.
+
+       The configure script attempts to automatically apply a suitable ".map"
+       file to provide this information for Linux.  Solaris mapfiles differ:
 
        a) comments are not accepted
-       b) wildcards are not accepted
+       b) wildcards are not accepted, except for a special case of "_*".
        c) each symbol listed in the map file must exist in the library
 
-       Use "objdump -T" on a library to see the annotations.
+       The Solaris limitations conflict with the development goal of providing
+       a small set of ".map" files as examples, which cover the most common
+       configurations.  Because that coverage is done by merging together
+       several builds, some symbols will be listed in the the ".map" files
+       that do not happen to be present in one configuration or another.
+
+       The sample ".map" (and ".sym") files are generated using a set of
+       scripts which build several configurations for each release version,
+       checking to see which of the "_nc_" symbols can be made local.  In
+       addition to the ncurses libraries and programs, the symbols used
+       by the "tack" program are made global.
+
+       These sample ".map" files will not cover all possible combinations.
+       In some cases, e.g., when using the --with-weak-symbols option, you
+       may prefer to use a different ".map" file by setting this option's
+       value.
 
     --with-xterm-kbs=XXX
        Configure xterm's terminfo entries to use either BS (^H, i.e., ASCII