* INSTALL: adjusted Cint status.
[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 Optionally, GiNaC may work together with Masaharu Goto's free C++
16 interpreter Cint.  You may obtain it from
17   * <ftp://root.cern.ch/root/>.
18 Install it by following the instructions included in Cint's
19 distribution before trying to compile GiNaC-cint.  (See section
20 `Working with the Cint C++ interpreter' below.)
21
22
23 INSTALLATION
24 ============
25
26 As with any autoconfiguring GNU software, installation is as easy as this:
27
28  $ ./configure
29  $ make
30  $ make check
31 [become root if necessary]
32  # make install
33
34 Known to work with:
35   - Linux/x86, EGCS-1.1.x and GCC 2-95.x
36 Known not to work with:
37   - GCC 2.7.x or earlier because proper exception support is missing there.
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
52 More detailed installation instructions can be found in the documentation,
53 in the doc/ directory.
54
55 The time the "make" step takes depends heavily on optimization levels.
56 Large amounts of memory (>128MB) will be required by the compiler,
57 also depending on optimization.  To give you a rough idea of what you
58 have to expect the following table may be helpful.  It was measured on
59 an Athlon/800MHz with "enough" memory:
60
61 step:         | GCC optimization level:  | comment:
62               |  -O0   |  -O1   |  -O2   |
63 --------------+--------+--------+--------+-------------------------------
64 make          |   ~4m  |   ~5m  |   ~6m  | building shared and static lib
65 make check    |  ~20m  |  ~11m  |  ~12m  | largely due to compilation
66
67
68 COMMON PROBLEMS
69 ===============
70
71 Problems with CLN
72 -----------------
73
74 You should use at least CLN-1.1, since during the development of
75 GiNaC various bugs have been discovered and fixed in earlier versions.
76 Please install CLN properly on your system before continuing with
77 GiNaC.  When using GCC3 as compiler please use at least CLN-1.1.1
78 since some parts of GiNaC won't build with CLN-1.1.
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
91 Working with the Cint C++ interpreter
92 =====================================
93
94 Please see <http://root.cern.ch/root/Cint.html> to learn about Cint
95 and install it prior to installing ginaccint.  For the interpreter-
96 compiler `makecint' to work properly, the Makefiles need to know where
97 Cint has its system directory.  This is usually done by exporting
98 $CINTSYSDIR to point to the proper place.  With GiNaC you may either
99 try to export that variable and type
100  $ ./configure --with-cint
101 or specify it directly on the command line by saying
102  $ ./configure --with-cint=/my/path/to/cintsysdir
103 This variable does not have to be exported for running the installed
104 binary: since the actual program is started by a launcher that sets it.
105 Enjoy!
106
107 Here is an overview to gives you an idea if you can expect GiNaC-cint
108 to compile, install and work properly:
109
110  Cint version | how it works
111 --------------+----------------------------------------------------------
112  < 5.14.39    | `VERBOTEN' by license (please bite your favorite lawyer)
113  < 5.14.60    | since GiNaC version 0.7, these do not compile any more
114    5.14.62-83 | compiles fine, works well with GCC 2.95.x.  GCC3 no go.