* clifford_to_lst() applies to lst.
[ginac.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 3730e91c0489aaf8c329e6bbb316ecc0fbf2cc0e..038ae7629cd8c69607701ab77c35df6b1c1c3800 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,43 +1,60 @@
 PREREQUISITES
 =============
 
 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
+GiNaC requires the CLN library by Bruno Haible installed on your system.
+It is available from <ftp://ftpthep.physik.uni-mainz.de/pub/gnu/>.
+
+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.
 
 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.)
+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
 
  $ ./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.x and GCC 2-95.x
-Known not to work with:
-  - GCC 2.7.x or earlier because proper exception support is missing there.
+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
+
+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 can be given a number of options to enable and
-disable various features. For a complete list, type:
+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
 
 
  $ ./configure --help
 
@@ -48,21 +65,22 @@ 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
  --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.
 
 
 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 ide