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