X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=INSTALL;h=038ae7629cd8c69607701ab77c35df6b1c1c3800;hp=4555857e83d9bc7f4afb3f18a8febb96bd3da2d5;hb=308cd44009b6753631a267093f6e2baff73cc963;hpb=956eeb82c513a723e864edefa857133282cf692b diff --git a/INSTALL b/INSTALL index 4555857e..038ae762 100644 --- a/INSTALL +++ b/INSTALL @@ -1,42 +1,60 @@ -Prerequisites +PREREQUISITES ============= -GiNaC requires the CLN library by Bruno Haible, available at either -one of the following FTP-sites: - * , - * or - * . -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 +GiNaC requires the CLN library by Bruno Haible installed on your system. +It is available from . + +You will also need a decent ANSI-compliant C++-compiler. We recommend the +C++ compiler from the GNU compiler collection, GCC >= 3.0. If you have a +different or older 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 C++ -interpreter cint (which requires that you register for commercial -use). You may obtain it from - * . -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.) +Known to work with: + - Linux on x86, Alpha and Sparc using GCC 3.0.x, 3.1 and 3.2. + +Known not to work with: + - GCC 2.96 or earlier because proper exception and standard library support + is missing there. -Installation +INSTALLATION ============ -As with any autoconfiguring GNU software, installation is as easy as this: +To install from a source .tar.bz2 distribution: $ ./configure $ make - $ make check -[become root if necessary] - $ make install + [become root if necessary] + # make install -Known to work with: - - Linux/x86, EGCS-1.1.2 or GCC 2-95.1/2-95.2 +To install from CVS: + + $ cvs -d :pserver:anoncvs@cvsthep.physik.uni-mainz.de:/home/cvs login + [enter "anoncvs" as the password] + $ cvs -d :pserver:anoncvs@cvsthep.physik.uni-mainz.de:/home/cvs co GiNaC + $ cd GiNaC + $ ./autogen.sh + $ make + [become root if necessary] + # make install -The "configure" script can be given a number of options to enable and -disable various features. For a complete list, type: +To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript, +or PDF formats, use one of + + $ make html + $ make dvi + $ make ps + $ make pdf + +To compile and run GiNaC's test and benchmark suite and check whether the +library works correctly you can use + + $ make check + +The "configure" script (and "autogen.sh", which invokes "configure") can be +given a number of options to enable and disable various features. For a +complete list, type: $ ./configure --help @@ -47,37 +65,47 @@ A few of the more important ones: --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 + --disable-static suppress the creation of a static 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 -a P-III/500MHz with "enough" memory: +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 | comment + | -O1 | -O2 | +--------------+---------+---------+---------------------------------------- +make | ~6m | ~8m | shared and static library +make check | ~8m | ~12m | largely due to compilation -step: | GCC optimization level: | comment: - | -O0 | -O1 | -O2 | ---------------+--------+--------+--------+------------------------------- -make | ~4m | ~6m | ~10m | building shared and static lib -make check | ~2m | ~2m | ~7m | mostly 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. -You should use at least CLN V1.0.3, since during the development of -GiNaC various bugs have been discovered and fixed in earlier versions. -To protect you, the "configure" script checks for a feature that was -added in V1.0.3 so it won't continue with earlier versions anyhow. -Please install CLN properly on your system before continuing with -GiNaC. +Problems 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 and compile +it yourself. -Working with the Cint C++ interpreter -===================================== +Problems with missing standard header files +------------------------------------------- -You need to specify - --with-cint=$CINTSYSDIR -... +Building GiNaC requires many standard header files. If you get a configure +error complaining about such missing files your compiler and library are +probably not up to date enough and it's no worth continuing.