PREREQUISITES
=============
-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
+GiNaC requires the CLN library by Bruno Haible installed on your system.
+It is available from <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
+
+You will also need a decent ANSI-compliant C++-compiler. We recommend the
+C++ compiler from the GNU compiler collection, GCC >= 3.0. If you have a
+different or older 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.
-Optionally, GiNaC may work together with Masaharu Goto's free C++
-interpreter Cint. You may obtain it from
- * <ftp://root.cern.ch/root/>.
-Install it by following the instructions included in Cint's
-distribution before trying to compile GiNaC-cint. (See section
-`Working with the Cint C++ interpreter' below.)
+To build the GiNaC tutorial and reference manual the doxygen utility
+(it can be downloaded from http://www.stack.nl/~dimitri/doxygen) and
+TeX are necessary.
+
+Known to work with:
+ - Linux on x86, Alpha and Sparc using GCC 3.x and 4.0.
+
+Known not to work with:
+ - GCC 2.96 or earlier because proper exception and standard library support
+ is missing there.
+
+If you install from CVS, you also need GNU autoconf (>=2.59) and
+automake (>=1.7) to be installed.
INSTALLATION
============
-As with any autoconfiguring GNU software, installation is as easy as this:
+To install from a source .tar.bz2 distribution:
$ ./configure
$ make
- $ make check
-[become root if necessary]
+ [become root if necessary]
# make install
-Known to work with:
- - Linux/x86, EGCS-1.1.x and GCC 2-95.x
-Known not to work with:
- - GCC 2.7.x or earlier because proper exception support is missing there.
+To install from CVS:
+
+ $ cvs -d :pserver:anoncvs@cvs.ginac.de:/home/cvs/GiNaC login
+ [enter "anoncvs" as the password]
+ $ cvs -d :pserver:anoncvs@cvs.ginac.de:/home/cvs/GiNaC co GiNaC
+ $ cd GiNaC
+ $ autoreconf -i
+ $ ./configure
+ $ make
+ [become root if necessary]
+ # make install
+
+To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript,
+or PDF formats, use one of
+
+ $ make html
+ $ make dvi
+ $ make ps
+ $ make pdf
+
+To compile and run GiNaC's test and benchmark suite and check whether the
+library works correctly you can use
+
+ $ make check
The "configure" script can be given a number of options to enable and
disable various features. For a complete list, type:
--exec-prefix=EPREFIX install architecture-dependent files in EPREFIX
[defaults to the value given to --prefix]
--disable-shared suppress the creation of a shared version of libginac
+ --disable-static suppress the creation of a static version of libginac
More detailed installation instructions can be found in the documentation,
in the doc/ directory.
-The time the "make" step takes depends heavily on optimization levels.
-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
-an Athlon/800MHz with "enough" memory:
+The time the "make" step takes depends heavily on optimization levels. 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 an Athlon/800MHz with
+"enough" memory:
-step: | GCC optimization level: | comment:
- | -O0 | -O1 | -O2 |
---------------+--------+--------+--------+-------------------------------
-make | ~4m | ~5m | ~6m | building shared and static lib
-make check | ~20m | ~11m | ~12m | largely due to compilation
+step | GCC optimization | comment
+ | -O1 | -O2 |
+--------------+---------+---------+----------------------------------------
+make | ~6m | ~8m | shared and static library
+make check | ~8m | ~12m | largely due to compilation
COMMON PROBLEMS
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.
-
-
-Working with the Cint C++ interpreter
-=====================================
-
-Please see <http://root.cern.ch/root/Cint.html> to learn about Cint
-and install it prior to installing ginaccint. For the interpreter-
-compiler `makecint' to work properly, the Makefiles need to know where
-Cint has its system directory. This is usually done by exporting
-$CINTSYSDIR to point to the proper place. With GiNaC you may either
-try to export that variable and type
- $ ./configure --with-cint
-or specify it directly on the command line by saying
- $ ./configure --with-cint=/my/path/to/cintsysdir
-This variable does not have to be exported for running the installed
-binary: since the actual program is started by a launcher that sets it.
-Enjoy!
-
-Here is an overview to gives you an idea if you can expect GiNaC-cint
-to compile, install and work properly:
-
- Cint version | how it works
---------------+----------------------------------------------------------
- < 5.14.39 | `VERBOTEN' by license (please bite your favorite lawyer)
- < 5.14.60 | since GiNaC version 0.7, these do not compile any more
- 5.14.62-72 | compiles fine, works well with GCC 2.95.x. GCC3 no go.
+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.
+
+Problems building ginsh
+-----------------------
+
+The most common reason why this doesn't succeed is the absence of GNU
+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. Note that non-GNU versions of libreadline (in particular
+one shipped with Mac OS X) are not supported at the moment.
+
+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.
git://www.ginac.de / ginac.git / blobdiff