[Mpfi-commits] r403 - trunk/mpfi/doc

[ptheveny at users.gforge.inria.fr]

Author: ptheveny
Date: 2010-07-15 18:10:02 +0200 (Thu, 15 Jul 2010)
New Revision: 403

Modified:
   trunk/mpfi/doc/mpfi.texi
Log:
Update 'Installing MPFI' section in doc/mpfi.texi

Modified: trunk/mpfi/doc/mpfi.texi
===================================================================
--- trunk/mpfi/doc/mpfi.texi	2010-07-15 15:26:38 UTC (rev 402)
+++ trunk/mpfi/doc/mpfi.texi	2010-07-15 16:10:02 UTC (rev 403)
@@ -227,80 +227,105 @@
 @chapter Installing MPFI
 @cindex Installation
 
-To build MPFI, you first have to install MPFR (version 2.0 or above)
+To build MPFI, you first have to install MPFR (version 3.2.0 or above)
 on your computer.
-You need a C compiler, preferably GCC, but any reasonable compiler should
-work.  And you need a standard Unix @samp{make} program, plus some other
+You need a C compiler, preferably GCC, but any reasonable compiler
+should work.
+And you need a standard Unix @samp{make} program, plus some other
 standard Unix utility programs.
 
-Here are the steps needed to install the MPFI library on Unix systems:
+Here are the steps needed to install the MPFI library on Unix systems.
+In the MPFI source directory, type the following commands.
 
 @enumerate
 @item
-Edit the file @samp{Makefile} and set the various variables:
-set @samp{CC} to your C compiler, @samp{COPT} to the optimization
-options for the compiler, @samp{C_EXTRA_FLAGS}
-to some other useful options (@samp{-static} may reveal useful)
-and @samp{AR}, @samp{LD} to the proper  utilities.
-Also set @samp{GMP_INCLUDE} to the directory containing
-the GNU MP header files and @samp{GMP_LIB} to the GNU MP library
-directory. Similarly, set @samp{MPFR_INCLUDE} to the directory containing
-the MPFR header files and @samp{MPFR_LIB}  to the directory
-containing the MPFR library files.
- at c If you get error messages, your machine might not be supported.
+ at samp {./configure}
 
+This will prepare the build and setup the options according to your system.
+
+You can specify the path to GMP and MPFR libraries with configure
+options: @samp{--with-gmp=DIR} assumes that GMP is installed in the
+ at samp{DIR} directory.
+Alternatively, you can use the @samp{--with-gmp-lib=DIR} and
+ at samp{--with-gmp-include=DIR} to specify respectively the GMP lib and GMP
+include directories.
+Options @samp{--with-mpfr=DIR}, @samp{--with-mpfr-include}, and
+ at samp{--with-mpfr-lib=DIR} have the same usage for the MPFR library.
+
+See the @file{INSTALL} file and the output of @samp{./configure
+--help} for a description of standard options.
+
 @item
- at samp{make all}
+ at samp{make}
 
-This will compile MPFI, and create a library archive file @file{libmpfi.a} 
-in the working directory.
+This will compile MPFI, and create a library archive file @file{libmpfi.a}.
+On most platforms, a dynamic library will be produced too.
 
 @item
- at samp{make tests}
+ at samp{make check}
 
-This will make some random tests in order to check
-whether MPFI was built correctly.  
+This will make sure MPFI was built correctly.
 If you get error messages from the test program, please
-report this to @samp{Nathalie.Revol@@ens-lyon.fr, Fabrice.Rouillier@@loria.fr, sylvain.chevillard@@ens-lyon.org, christoph.lauter@@ens-lyon.org, hong.diep.nguyen@@ens-lyon.fr}.  (@xref{Reporting Bugs}, for
-information on what to include in useful bug reports.)
+report this to
+ at c FIXME: update this list of email
+ at samp{Nathalie.Revol@@ens-lyon.fr,
+ Fabrice.Rouillier@@loria.fr,
+ sylvain.chevillard@@ens-lyon.org,
+ christoph.lauter@@ens-lyon.org,
+ hong.diep.nguyen@@ens-lyon.fr}.
+(@xref{Reporting Bugs}, for information on what to include in useful
+bug reports.)
+
+ at item
+ at samp{make install}
+
+This will copy
+the file @file{mpfi.h} to the directory @file{/usr/local/include},
+the library files (@file{libmpfi.a} and possibly others) to the directory
+ at file{/usr/local/lib},
+the file @file{mpfi.info} to the directory @file{/usr/local/share/info},
+and some other documentation files to the directory
+ at file{/usr/local/share/doc/mpfi}
+(or if you passed the @samp{--prefix} option to @file{configure},
+using the prefix directory given as argument to @samp{--prefix}
+instead of @file{/usr/local}).
 @end enumerate
 
 There are some other useful make targets:
 
 @itemize @bullet
 @item
+ at samp{mpfi.info} or @samp{info}
+
+Create an info version of the manual, in @file{mpfi.info}.
+
+ at item
+ at samp{mpfi.pdf}
+
+Create a Postscript version of the manual, in @file{mpfi.ps}.
+
+ at item
 @samp{mpfi.dvi} or @samp{dvi}
 
 Create a DVI version of the manual, in @file{mpfi.dvi}.
- at c and a set of info files, in @file{mpfr.info}, @file{mpfr.info-1}, @file{mpfr.info-2}, etc.
 
 @item
- at samp{mpfi.info} or @samp{info}
+ at samp{mpfi.ps}
 
-Create an info version of the manual, in @file{mpfi.info}.
+Create a Postscript version of the manual, in @file{mpfi.ps}.
 
- at c @item
- at c @samp{mpfr.ps}
- at c 
- at c Create a Postscript version of the manual, in @file{mpfr.ps}.
- at c 
- at c @item
- at c @samp{html}
- at c Create a HTML version of the manual, in @file{mpfr.html}.
+ at item
+ at samp{html}
+Create a HTML version of the manual, in @file{mpfi.html}.
 
 @item
 @samp{clean}
 
 Delete all object files and archive files, but not the configuration files.
 
- at c @item
- at c @samp{distclean}
- at c 
- at c Delete all files not included in the distribution.
-
- at c @item
- at c @samp{uninstall}
- at c Delete all files copied by @samp{make install}.
+ at item
+ at samp{uninstall}
+Delete all files copied by @samp{make install}.
 @end itemize