- Included manpage in dist.
[ginac.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 27873b6254e7081908f359e41f298dc83bfafc1d..be6b5784990aa9d87f943b3c3827fa28eca54901 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,4 +1,4 @@
-Prerequisites
+PREREQUISITES
 =============
 
 GiNaC requires the CLN library by Bruno Haible, available at either
@@ -21,7 +21,7 @@ distribution before trying to compile GiNaC-cint.  (See section
 `Working with the Cint C++ interpreter' below.)
 
 
-Installation
+INSTALLATION
 ============
 
 As with any autoconfiguring GNU software, installation is as easy as this:
@@ -33,7 +33,7 @@ As with any autoconfiguring GNU software, installation is as easy as this:
  $ make install
 
 Known to work with:
-  - Linux/x86, EGCS-1.1.2 or GCC 2-95.1/2-95.2
+  - Linux/x86, EGCS-1.1.x and GCC 2-95.x
 
 The "configure" script can be given a number of options to enable and
 disable various features. For a complete list, type:
@@ -61,11 +61,14 @@ 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
+make check    |  ~3m   |  ~3m   |  ~7m   | mostly due to compilation
 
 
+COMMON PROBLEMS
+===============
+
 Problems with CLN
-=================
+-----------------
 
 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.
@@ -74,6 +77,19 @@ 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 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.  After that it should work fine.  
+
+If you want to build a completely static ginsh and your compiler still
+complains about unresolved objects try linking with libncurses, too.
+
 
 Working with the Cint C++ interpreter
 =====================================
@@ -90,6 +106,10 @@ or specify it on the command line saying
  $ ./configure --with-cint=/my/path/to/cintsysdir
 Good luck!
 
-  Known to work with:  |  Known not to work with:   
+  Known to work with:  |  Known not to work with:
 -----------------------+----------------------------
-  Cint 5.14.26         |  Cint 5.14.29              
+  Cint 5.14.38         |  Cint before 5.14.37
+
+Due to a bug in Cint 5.14.38 compilation will fail with GCC 2.95.2,
+maybe even with all 2.95.x.  Currently you must use EGCS-1.1.x.  This
+is under investigation.