cgi-bin/viewcvs.cgi/INSTALL

Installation Notes for CDuce
============================

CDuce is written in the OCaml programming language. It has been
sucessfully compiled under Intel Linux, SunOS 5.7, Window XP
and FreeBSD 4.7.

------------------------------------------------------------------------------
Prerequisites
------------------------------------------------------------------------------

Before compiling CDuce, you need to install recent releases of the
following packages:

ocaml      
  http://caml.inria.fr/ocaml/distrib.html
findlib    
  http://www.ocaml-programming.de/packages
wlex       
  http://www.eleves.ens.fr/home/frisch/soft.html#wlex
pcre-ocaml 
  http://www.ai.univie.ac.at/~markus/home/ocaml_sources.html
ocamlnet   
  http://ocamlnet.sourceforge.net/
pxp
  http://www.ocaml-programming.de/packages/documentation/pxp/index_dev.html


Important notes:

- the packages above must be installed in the order we used above. In
  particular wlex _must_ be installed before pcre-ocaml and pxp.

- wlex: you only need to build and install the runtime support library
  (not the wlex tool itself):

     make runtime.all & make install_runtime

- pcre-ocaml: you may also need to install the PCRE library
  from http://www.pcre.org/

  ./configure --prefix=<prefix directory> --disable-shared

  If pcre was installed in non standard place then in Makefile.conf:
  export STATIC = yes     #this may help but first try without
  export INCDIRS := <prefix_directory>/include
  export LIBDIRS := <prefix_directory>/lib

  After make all && make opt:
    cd lib
    cp ../META .
    ocamlfind install pcre META *.a *.cma *.cmxa *.cmi *.mli

- PXP:
  CDuce requires a development version >= 1.1.93.


Efficiency issues:

- OCamlnet: if you plan to load XML file with encodings other than
  UTF-8, it is advised to use the CVS version of OCamlnet:
    http://sourceforge.net/cvs/?group_id=19774  
  Indeed, the netconversion module in the lastest 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
distribution. It defines the following goals:

- make cduce
  compiles the CDuce command line interpreter

- make dtd2cduce
  compiles the dtd2cduce tools (converts DTD to CDuce types)

- make webiface
  compiles the CDuce web interface interpreter (to be used as a CGI script)

- make local_website
  compiles in the web/www/ subdirectory the HTML files of CDuce website
  (including the tutorial)

- make all
  equivalent to (make cduce; make dtd2cduce; make local_website)


Makefile accepts the following options, which can take the values
true or false.

NATIVE=true   : use the OCaml native code compiler (ocamlopt) to build CDuce
NATIVE=false  : use the OCaml bytecode compiler (ocamlc)
  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
  default: false (ocamllex is faster; wlex is more compact)

E.g.:
  make cduce NATIVE=false
1	abate	370	Installation Notes for CDuce
2			============================
3	abate	104
4	abate	370	CDuce is written in the OCaml programming language. It has been
5	abate	404	sucessfully compiled under Intel Linux, SunOS 5.7, Window XP
6			and FreeBSD 4.7.
7	abate	104
8	abate	370	------------------------------------------------------------------------------
9			Prerequisites
10			------------------------------------------------------------------------------
11	abate	104
12	abate	370	Before compiling CDuce, you need to install recent releases of the
13			following packages:
14	abate	298
15	abate	370	ocaml
16			http://caml.inria.fr/ocaml/distrib.html
17			findlib
18			http://www.ocaml-programming.de/packages
19			wlex
20			http://www.eleves.ens.fr/home/frisch/soft.html#wlex
21			pcre-ocaml
22			http://www.ai.univie.ac.at/~markus/home/ocaml_sources.html
23			ocamlnet
24			http://ocamlnet.sourceforge.net/
25			pxp
26			http://www.ocaml-programming.de/packages/documentation/pxp/index_dev.html
27	abate	323
28
29	abate	370	Important notes:
30	abate	323
31	abate	390	- the packages above must be installed in the order we used above. In
32			particular wlex _must_ be installed before pcre-ocaml and pxp.
33
34	abate	370	- wlex: you only need to build and install the runtime support library
35			(not the wlex tool itself):
36	abate	104
37	abate	370	make runtime.all & make install_runtime
38	abate	298
39	abate	370	- pcre-ocaml: you may also need to install the PCRE library
40			from http://www.pcre.org/
41	abate	298
42	abate	370	./configure --prefix=<prefix directory> --disable-shared
43	abate	298
44			If pcre was installed in non standard place then in Makefile.conf:
45			export STATIC = yes #this may help but first try without
46			export INCDIRS := <prefix_directory>/include
47			export LIBDIRS := <prefix_directory>/lib
48
49			After make all && make opt:
50	abate	104	cd lib
51			cp ../META .
52			ocamlfind install pcre META .a .cma .cmxa .cmi *.mli
53
54	abate	370	- PXP:
55			CDuce requires a development version >= 1.1.93.
56	abate	104
57
58	abate	402	Efficiency issues:
59	abate	399
60			- OCamlnet: if you plan to load XML file with encodings other than
61	abate	402	UTF-8, it is advised to use the CVS version of OCamlnet:
62	abate	399	http://sourceforge.net/cvs/?group_id=19774
63			Indeed, the netconversion module in the lastest release (0.95) was
64			very slow, and it has been rewritten since then.
65
66	abate	370	------------------------------------------------------------------------------
67			Compilation
68			------------------------------------------------------------------------------
69	abate	298
70	abate	370	You need a GNU Make (or equivalent) to use the Makefile from the
71			distribution. It defines the following goals:
72	abate	298
73	abate	402	- make cduce
74	abate	370	compiles the CDuce command line interpreter
75	abate	298
76	abate	370	- make dtd2cduce
77			compiles the dtd2cduce tools (converts DTD to CDuce types)
78	abate	298
79	abate	402	- make webiface
80	abate	370	compiles the CDuce web interface interpreter (to be used as a CGI script)
81	abate	362
82	abate	370	- make local_website
83	abate	402	compiles in the web/www/ subdirectory the HTML files of CDuce website
84	abate	370	(including the tutorial)
85	abate	402
86			- make all
87			equivalent to (make cduce; make dtd2cduce; make local_website)
88
89
90			Makefile accepts the following options, which can take the values
91			true or false.
92
93			NATIVE=true : use the OCaml native code compiler (ocamlopt) to build CDuce
94			NATIVE=false : use the OCaml bytecode compiler (ocamlc)
95			default: true (the native code version is much faster)
96
97			PXP_WLEX=true : use wlex for parsing UTF-8 XML files
98			PXP_WLEX=false: use ocamllex for parsing UTF-8 XML files
99			default: false (ocamllex is faster; wlex is more compact)
100
101			E.g.:
102			make cduce NATIVE=false