Contents of /INSTALL

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
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.)


INSTALLATION
============

As with any autoconfiguring GNU software, installation is as easy as this:

 $ ./configure
 $ make
 $ make check
[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.

The "configure" script can be given a number of options to enable and
disable various features. For a complete list, type:

 $ ./configure --help

A few of the more important ones:

 --prefix=PREFIX        install architecture-independent files in PREFIX
                        [defaults to /usr/local]
 --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

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:

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


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.62    | since GiNaC version 0.7, these do not compile any more
   5.14.64-86 | compiles fine, works well with GCC 2.95.x.  GCC3 no go.
1	kreckel	1.10	PREREQUISITES
2	kreckel	1.1	=============
3
4	kreckel	1.18	GiNaC requires the CLN library by Bruno Haible, available from either
5	kreckel	1.6	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	kreckel	1.18	Optionally, GiNaC may work together with Masaharu Goto's free C++
16			interpreter Cint. You may obtain it from
17	kreckel	1.6	* <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	cbauer	1.2
22
23	kreckel	1.10	INSTALLATION
24	cbauer	1.2	============
25
26	kreckel	1.1	As with any autoconfiguring GNU software, installation is as easy as this:
27
28	cbauer	1.2	$ ./configure
29			$ make
30			$ make check
31			[become root if necessary]
32	cbauer	1.26	# make install
33	kreckel	1.1
34			Known to work with:
35	kreckel	1.16	- Linux/x86, EGCS-1.1.x and GCC 2-95.x
36	kreckel	1.18	Known not to work with:
37			- GCC 2.7.x or earlier because proper exception support is missing there.
38	kreckel	1.1
39	cbauer	1.2	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	kreckel	1.1	More detailed installation instructions can be found in the documentation,
53			in the doc/ directory.
54	kreckel	1.3
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	kreckel	1.23	an Athlon/800MHz with "enough" memory:
60	kreckel	1.3
61	kreckel	1.4	step: \| GCC optimization level: \| comment:
62			\| -O0 \| -O1 \| -O2 \|
63			--------------+--------+--------+--------+-------------------------------
64	kreckel	1.23	make \| ~4m \| ~5m \| ~6m \| building shared and static lib
65			make check \| ~20m \| ~11m \| ~12m \| largely due to compilation
66	kreckel	1.1
67
68	kreckel	1.10	COMMON PROBLEMS
69			===============
70
71	cbauer	1.2	Problems with CLN
72	kreckel	1.10	-----------------
73	kreckel	1.1
74	kreckel	1.30	You should use at least CLN-1.1, since during the development of
75	kreckel	1.5	GiNaC various bugs have been discovered and fixed in earlier versions.
76			Please install CLN properly on your system before continuing with
77	kreckel	1.34	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	kreckel	1.10
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	kreckel	1.18	and compile it yourself.
89	kreckel	1.6
90
91			Working with the Cint C++ interpreter
92			=====================================
93
94	kreckel	1.17	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	kreckel	1.7	$ ./configure --with-cint
101	kreckel	1.17	or specify it directly on the command line by saying
102	kreckel	1.7	$ ./configure --with-cint=/my/path/to/cintsysdir
103	kreckel	1.21	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	kreckel	1.17	Enjoy!
106	kreckel	1.7
107	kreckel	1.21	Here is an overview to gives you an idea if you can expect GiNaC-cint
108	kreckel	1.17	to compile, install and work properly:
109	kreckel	1.16
110	kreckel	1.21	Cint version \| how it works
111			--------------+----------------------------------------------------------
112			< 5.14.39 \| `VERBOTEN' by license (please bite your favorite lawyer)
113	kreckel	1.40	< 5.14.62 \| since GiNaC version 0.7, these do not compile any more
114	kreckel	1.41	5.14.64-86 \| compiles fine, works well with GCC 2.95.x. GCC3 no go.
Christian Bauer">Christian Bauer	ViewVC Help
Powered by ViewVC 1.1.15