-Prerequisites
+PREREQUISITES
=============
-GiNaC requires the CLN library by Bruno Haible, available at
-<ftp://ftp.santafe.eu/pub/gnu/> or <ftp://ftp.ilog.fr/pub/Users/haible/gnu/>.
-You will also need a good C++ compiler adhering to the ANSI standard (we
-used gcc for development so if you have a different compiler you are on
-your own).
+GiNaC requires the CLN library by Bruno Haible, available from either
+one of the following FTP-sites:
+ * <ftp://ftp.santafe.edu/pub/gnu/>,
+ * <ftp://ftp.ilog.fr/pub/Users/haible/gnu/> or
+ * <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
+You will also need a decent ANSI-compliant C++-compiler. We use
+`post-EGCS' GCC, i.e GCC >= 2.95 for development so if you have a
+different compiler you are on your own. Note that you may have to use
+the same compiler you compiled CLN with because of differing
+name-mangling schemes.
-Installation
+INSTALLATION
============
As with any autoconfiguring GNU software, installation is as easy as this:
$ make
$ make check
[become root if necessary]
- $ make install
+ # make install
Known to work with:
- - Linux/x86, EGCS-1.1.2 or GCC 2-95.1/2-95.2
+ - Linux on x86, Alpha and Sparc using GCC 2-95.x.
+Known not to work with:
+ - GCC 2.7.x or earlier because proper exception support is missing there.
The "configure" script can be given a number of options to enable and
disable various features. For a complete list, type:
Large amounts of memory (>128MB) will be required by the compiler,
also depending on optimization. To give you a rough idea of what you
have to expect the following table may be helpful. It was measured on
-a P-III/500MHz with "enough" memory:
+an Athlon/800MHz with "enough" memory:
-step: | GCC optimization level: | comment:
- | -O0 | -O1 | -O2 |
---------------+--------+--------+--------+-------------------------------
-make | ~4m | ~6m | ~10m | building shared and static lib
-make check | ~2m | ~2m | ~7m | mostly due to compilation
+step | GCC optimization | comment
+ | -O1 | -O2 |
+--------------+---------+---------+----------------------------------------
+make | ~6m | ~8m | shared and static library
+make check | ~8m | ~12m | largely due to compilation
-Problems with CLN
-=================
+COMMON PROBLEMS
+===============
-You should use at least CLN V1.0.2, since all earlier ones are
-somewhat buggy. Even V1.0.1 has a few problems and GiNaC will not
-support older versions. Please install it properly on your system
-before continuing with GiNaC.
+Problems with CLN
+-----------------
+
+You should use at least CLN-1.1, since during the development of
+GiNaC various bugs have been discovered and fixed in earlier versions.
+Please install CLN properly on your system before continuing with
+GiNaC. When using GCC3 as compiler please use at least CLN-1.1.1
+since some parts of GiNaC won't build with CLN-1.1.
+
+Problems with building ginsh
+----------------------------
+
+The most common reason why this doesn't succeed is the absence of
+libreadline and/or the corresponding header files. Depending on what
+your system/distribution is, you will have to install a package called
+libreadline and maybe libreadline-dev. If your system's vendor
+doesn't supply such packages, go to <ftp://ftp.gnu.org/gnu/readline/>
+and compile it yourself.
+
+Problems with missing standard header files
+-------------------------------------------
+
+Building GiNaC requires many standard header files. If you get a
+configure error complaining about such missing files your compiler and
+library are probably not up to date enough and it's no worth
+continuing. If the only file missing is <sstream>, however, there is
+a solution. GCC-2.95.2 and earlier don't ship with this file. A
+working implementation has been available since GCC-2.95.3. GCC-3.0
+and later have an even better, fully standard-conforming
+implementation, by default. If you are stuck with GCC-2.95.2 or
+earlier and you cannot upgrade your compiler we recommend obtaining
+the libstdc++-v2 <sstream> header written by Magnus Fromreide. It was
+posted to the gcc-patches mailing list on November 21 2000:
+<http://gcc.gnu.org/ml/gcc-patches/2000-11/msg01152.html>.