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 The "configure" script can be given a number of options to enable and
  32 disable various features. For a complete list, type:
  33
  34  $ ./configure --help
  35
  36 A few of the more important ones:
  37
  38  --prefix=PREFIX        install architecture-independent files in PREFIX
  39                         [defaults to /usr/local]
  40  --exec-prefix=EPREFIX  install architecture-dependent files in EPREFIX
  41                         [defaults to the value given to --prefix]
  42  --disable-shared       suppress the creation of a shared version of libginac
  43
  44 More detailed installation instructions can be found in the documentation,
  45 in the doc/ directory.
  46
  47 The time the "make" step takes depends heavily on optimization levels.
  48 Large amounts of memory (>128MB) will be required by the compiler,
  49 also depending on optimization.  To give you a rough idea of what you
  50 have to expect the following table may be helpful.  It was measured on
  51 an Athlon/800MHz with "enough" memory:
  52
  53 step          | GCC optimization  | comment
  54               |   -O1   |   -O2   |
  55 --------------+---------+---------+----------------------------------------
  56 make          |   ~6m   |   ~8m   | shared and static library
  57 make check    |   ~8m   |  ~12m   | largely due to compilation
  58
  59
  60 COMMON PROBLEMS
  61 ===============
  62
  63 Problems with CLN
  64 -----------------
  65
  66 You should use at least CLN-1.1, since during the development of
  67 GiNaC various bugs have been discovered and fixed in earlier versions.
  68 Please install CLN properly on your system before continuing with
  69 GiNaC.
  70
  71 Problems with building ginsh
  72 ----------------------------
  73
  74 The most common reason why this doesn't succeed is the absence of
  75 libreadline and/or the corresponding header files.  Depending on what
  76 your system/distribution is, you will have to install a package called
  77 libreadline and maybe libreadline-dev.  If your system's vendor
  78 doesn't supply such packages, go to <ftp://ftp.gnu.org/gnu/readline/>
  79 and compile it yourself.
  80
  81 Problems with missing standard header files
  82 -------------------------------------------
  83
  84 Building GiNaC requires many standard header files.  If you get a
  85 configure error complaining about such missing files your compiler and
  86 library are probably not up to date enough and it's no worth
  87 continuing.