/[svn]/INSTALL

Diff of /INSTALL

Parent Directory | Revision Log | View Patch Patch

-revision 705 by abate,
Tue Jul 10 17:57:13 2007 UTC
+revision 1500 by abate,
Tue Jul 10 18:57:01 2007 UTC
 Line 10
  Prerequisites
  ------------------------------------------------------------------------------
+ An easy way to get a system ready to compile CDuce is to use
+ the GODI distribution:
+   http://www.ocaml-programming.de/godi/
+ It includes all the mandatory and optional packages listed below,
+ and also the special modules needed to build the OCaml/CDuce interface.
+ Mandatory packages:
+ -------------------
  Before compiling CDuce, you need to install recent releases of the
  following packages:
- ocaml  => 3.07
+ ocaml      => 3.08.1
    http://caml.inria.fr/ocaml/distrib.html
- findlib
+ findlib    => 1.0.3
    http://www.ocaml-programming.de/packages
- ulex
+ ulex       => 0.4
    http://www.cduce.org/download
- pcre-ocaml
+ pcre-ocaml => 5.03
    http://www.ai.univie.ac.at/~markus/home/ocaml_sources.html
- ocamlnet
+ ocamlnet   => 0.98
-   http://sourceforge.net/projects/ocamlnet
+   http://www.ocaml-programming.de/packages
- pxp    => 1.9.93
+ pxp        => 1.1.95
    http://www.ocaml-programming.de/packages/documentation/pxp/index_dev.html
- Important notes:
- - OCaml: cduce uses recursive modules so versions of OCaml before 3.07
+ Additional optional packages:
-   will not work. Also the standard distribution has two bugs that make
+ -----------------------------
-   CDuce compilation fail. Patch OCaml source by
+ * If you want to load xml, html, and schema files remotely on the
-       http://caml.inria.fr/bin/caml-bugs/fixed?id=1863;page=77;user=guest
+ web (http, https, ftp, ...: e.g. load_html "http://www.cduce.org") you will
-       http://www.cduce.org/download/patch-ocaml-3.07
+ need one of:
-   or (better) install OCaml cvs version
+ ocurl      => 0.15
-      cvs -d":pserver:anoncvs@camlcvs.inria.fr:/caml" login
+   http://sourceforge.net/projects/ocurl/
-   hit enter key when asked for password
-      cvs -d":pserver:anoncvs@camlcvs.inria.fr:/caml" co ocaml
+ netclient  => 0.90.1
+   http://www.ocaml-programming.de/programming/netclient.html
+ netclient support only the http protocol.
+ curl supports in addition https, ftp, and other protocols.
+ * You can also use the expat parser instead of PXP to load XML documents
+ (PXP is still needed):
+ ocaml-expat => 0.1.0
+   http://home.wanadoo.nl/maas/ocaml/
+ Important notes:
+ ----------------
  - pcre-ocaml: you may also need to install the PCRE library
-   from http://www.pcre.org/ [red-hat users: 4.3 package does
+   from http://www.pcre.org/ (use version >=4.4)
-   not work with the latest pcre-ocaml version, use tarballs]
+   [red-hat users: pcre (rawhide) packages may not work with the
+   latest pcre-ocaml versions, use tarballs]
+   In this case, configure it with the  --enable-utf8 option.
    >= 5.03 recommended but previous versions may work
  - PXP:
-   CDuce requires a development version >= 1.1.93.
+   CDuce requires a development version >= 1.1.94.2.
+   Notes: It is enough to build support UTF8 and ISO-8859-1 ocamllex-lexers:
-   Note:
-   It is enough to build support UTF8 and ISO-8859-1 ocamllex-lexers:
    ./configure -without-wlex -without-wlex-compat -lexlist utf8,iso88591
+   You can also build pxp with wlex support (more compact code). This
+   can be done by installing wlex runtime support library  *before* pxp
+     http://www.eleves.ens.fr/home/frisch/soft.html#wlex
+   and build pxp -with-wlex*. When building CDuce you still have the
+   choice whether to use wlex or ocamllex (to choose wlex,
+   do ./configure --with-pxp_wlex or set PXP_WLEX=true in Makefile.conf).
+ - ocurl:
+   you may also need to install libcurl (http://curl.haxx.se/libcurl/)
+ - ocaml-expat:
+   you may also need to install libexpat (http://expat.sourceforge.net/)
  Efficiency issues:
- - OCamlnet: if you plan to load XML file with encodings other than
+ - PXP: ocamllex lexers are more efficient than wlex lexers.
-   UTF-8, it is advised to use a recent version of OCamlnet (>= 0.96).
-   Indeed, the netconversion module in the previous release (0.95) was
-   very slow, and it has been rewritten since then.
  ------------------------------------------------------------------------------
  Compilation
  ------------------------------------------------------------------------------
- You need a GNU Make (or equivalent) to use the Makefile from the
+ There is a configure script. It will check for the presence of
- distribution. It defines the following goals:
+ mandatory packages, and detect automatically optional ones.  It will
+ also set installation directories.  Running the script produces a
+ Makefile.conf file.  You can get usage information about the script
+ with: ./configure --help
+ Alternatively, it is also possible to copy Makefile.conf.template to
+ Makefile.conf and modify it by hand.
+ The usual command line for configuring and building CDuce:
+ ./configure && make all && make install
+ To see all the configuration options:
+ ./configure --help
+ You need a GNU Make (or equivalent). The Makefile defines the following goals:
+ - make help
+   print a summary of what follows
  - make cduce
    compiles the CDuce command line interpreter
-Line 72
+Line 130
  - make dtd2cduce
    compiles the dtd2cduce tools (converts DTD to CDuce types)
- - make webiface
+ - make cduce_validate
-   compiles the CDuce web interface interpreter (to be used as a CGI script)
+   compiles the schema validation tool
- - make webpages
+ - make doc
-   compiles in the web/www/ subdirectory the HTML files for the CDuce website
+   compiles in the subdirectory web/doc the HTML documentation for CDuce
-   (including the tutorial and manual)
- - make install_web
-   compiles webiface and webpages, and install everything (see Makefile.conf)
  - make all
-   equivalent to (make cduce dtd2cduce)
+   equivalent to (make cduce dtd2cduce cduce_validate)
  - make install
-   it installs
+   installs binaries into $(BINDIR), manpages into $(MANDIR)/man1,
-   cduce and dtd2cduce into $(PREFIX)/bin
+   and registers the cduce_lib library with findlib.
-   cduce.1 into $(PREFIX)/man/man1
-   (see PREFIX below)
- Makefile accepts the following options.
+ - make clean
+   back to the starting point
- NATIVE=true   : use the OCaml native code compiler (ocamlopt) to build CDuce
+ - make uninstall
- NATIVE=false  : use the OCaml bytecode compiler (ocamlc)
+   removes installed files
-   default: true  (the native code version is much faster)
- PXP_WLEX=true : use wlex for parsing UTF-8 XML files
+ ------------------------------------------------------------------------------
- PXP_WLEX=false: use ocamllex for parsing UTF-8 XML files
+ Building the CDuce/OCaml interface
-   default: false (ocamllex is faster; wlex is more compact)
+ ------------------------------------------------------------------------------
- EXPAT=true: build expat support (see below)
+ If you want to build the OCaml/CDuce interface, you will need some
+ parts of the OCaml compilers which are not installed by default with
+ OCaml. The files you need are the compiled units from the
+ subdirectories utils/ parsing/ and typing/ of the OCaml standard
+ distribution (the .cmi files, and either the corresponding .cmo or the
+ .cmx+.o). If you still have the compiled OCaml source tree that you used
+ to build the current version of ocamlc/ocamlopt, in, say
+ $HOME/ocaml-3.07, you can activate the OCaml/CDuce interface with:
+  ./configure --mliface=$HOME/ocaml-3.08
+ Another option is to copy all the needed files (.cmi,.cmo/.cmx+.o)
+ to a single directory, say $HOME/ocaml-modules. Then you can do:
+  ./configure --mliface=$HOME/ocaml-modules
+ (the configure script automatically detect whether the files
+ are directly in the specified directory, or in utils/ parsing/ typing/
+ subdirectories)
- PREFIX=/usr/local by default: where to install CDuce files (see
+ Note for GODI users:
-  Makefile.conf)
+ ====================
- E.g.:
+ The GODI distribution *does* install the files in
-   make cduce NATIVE=false
+  $(LOCALBASE)/lib/ocaml/compiler-lib.
- You can also modify Makefile.conf to set values for these choices.
  ------------------------------------------------------------------------------
- Support for the expat parser
+ Note on using the expat parser
  ------------------------------------------------------------------------------
  CDuce can uses two XML parsers: PXP and expat. PXP is needed
  to build CDuce, and expat support can be additionnaly added.
- Here is how to do so.
- You need to install the expat C library and the OCaml wrapper.
- The wrapper can be found at:
- http://home.wanadoo.nl/maas/ocaml/
- Once the wrapper and be installed, you can build CDuce with
+ When CDuce is built with expat support, it uses by default expat to
- the Makefile option EXPAT=true (which can be set on make command
+ load XML files. You can still use PXP by adding "--no expat" to
- line or in Makefile.conf).
+ the CDuce command line.
- The interpreter is now using expat for loading XML files.
- You can still use PXP by providing the --pxp switch on the command
- line.
  Note: the current wrapper for expat does not support inclusion
  of external entities. Moreover, the error messages in case of

 Legend:



Removed from v.705
 


changed lines


 
Added in v.1500
 Legend:



Removed from v.705
 


changed lines


 
Added in v.1500
-Removed from v.705
+Added in v.1500

CVS Admin">CVS Admin	ViewVC Help
Powered by ViewVC 1.1.5