- prepared for 1.0.13 release
[ginac.git] / INSTALL
1 PREREQUISITES
2 =============
3
4 GiNaC requires the CLN library by Bruno Haible, available from either
5 one of the following FTP-sites:
6   * <ftp://ftp.santafe.edu/pub/gnu/>,
7   * <ftp://ftp.ilog.fr/pub/Users/haible/gnu/> or
8   * <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
9 You will also need a decent ANSI-compliant C++-compiler.  We use
10 `post-EGCS' GCC, i.e GCC >= 2.95 for development so if you have a
11 different compiler you are on your own.  Note that you may have to use
12 the same compiler you compiled CLN with because of differing
13 name-mangling schemes.
14
15
16 INSTALLATION
17 ============
18
19 As with any autoconfiguring GNU software, installation is as easy as this:
20
21  $ ./configure
22  $ make
23  $ make check
24 [become root if necessary]
25  # make install
26
27 Known to work with:
28   - Linux on x86, Alpha and Sparc using GCC 2-95.x.
29 Known not to work with:
30   - GCC 2.7.x or earlier because proper exception support is missing there.
31
32 The "configure" script can be given a number of options to enable and
33 disable various features. For a complete list, type:
34
35  $ ./configure --help
36
37 A few of the more important ones:
38
39  --prefix=PREFIX        install architecture-independent files in PREFIX
40                         [defaults to /usr/local]
41  --exec-prefix=EPREFIX  install architecture-dependent files in EPREFIX
42                         [defaults to the value given to --prefix]
43  --disable-shared       suppress the creation of a shared version of libginac
44
45 More detailed installation instructions can be found in the documentation,
46 in the doc/ directory.
47
48 The time the "make" step takes depends heavily on optimization levels.
49 Large amounts of memory (>128MB) will be required by the compiler,
50 also depending on optimization.  To give you a rough idea of what you
51 have to expect the following table may be helpful.  It was measured on
52 an Athlon/800MHz with "enough" memory:
53
54 step          | GCC optimization  | comment
55               |   -O1   |   -O2   |
56 --------------+---------+---------+----------------------------------------
57 make          |   ~6m   |   ~8m   | shared and static library
58 make check    |   ~8m   |  ~12m   | largely due to compilation
59
60
61 COMMON PROBLEMS
62 ===============
63
64 Problems with CLN
65 -----------------
66
67 You should use at least CLN-1.1, since during the development of
68 GiNaC various bugs have been discovered and fixed in earlier versions.
69 Please install CLN properly on your system before continuing with
70 GiNaC.  When using GCC3 as compiler please use at least CLN-1.1.1
71 since some parts of GiNaC won't build with CLN-1.1.
72
73 Problems with building ginsh
74 ----------------------------
75
76 The most common reason why this doesn't succeed is the absence of
77 libreadline and/or the corresponding header files.  Depending on what
78 your system/distribution is, you will have to install a package called
79 libreadline and maybe libreadline-dev.  If your system's vendor
80 doesn't supply such packages, go to <ftp://ftp.gnu.org/gnu/readline/>
81 and compile it yourself.
82
83 Problems with missing standard header files
84 -------------------------------------------
85
86 Building GiNaC requires many standard header files.  If you get a
87 configure error complaining about such missing files your compiler and
88 library are probably not up to date enough and it's no worth
89 continuing.  If the only file missing is <sstream>, however, there is
90 a solution.  GCC-2.95.2 and earlier don't ship with this file.  A
91 working implementation has been available since GCC-2.95.3.  GCC-3.0
92 and later have an even better, fully standard-conforming
93 implementation, by default.  If you are stuck with GCC-2.95.2 or
94 earlier and you cannot upgrade your compiler we recommend obtaining
95 the libstdc++-v2 <sstream> header written by Magnus Fromreide.  It was
96 posted to the gcc-patches mailing list on November 21 2000:
97 <http://gcc.gnu.org/ml/gcc-patches/2000-11/msg01152.html>.