cgi-bin/viewcvs.cgi/INSTALL.WIN32

                 Installation Notes for Windows NT/2000/XP
                 =========================================


CDuce can be executed on Microsoft Windows by using the
RedHat/Cygnus environment Cygwin freely available at

http://www.cygwin.com/

The executable needs the cygwin1.dll that is distributed 
under GPL license. This is not compatible with the CDuce license.
For this reason we do not provide binaries but give here detailed 
instructions about how to compile CDuce sources under Cygwin/Windows.


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

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


cygwin
  http://www.cygwin.com
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://sourceforge.net/projects/ocamlnet
pxp
  http://www.ocaml-programming.de/packages/documentation/pxp/index_dev.html


Installation notes (you are advised to follow this order):

1) Download and execute cygwin setup.exe.
   - Choose Internet installation
   - Choose a root directory whose path has no blanks in it
   - Choose as Local Package Directory <your root>/usr/src (optional)
   - Choose the mirror closest to you
   - When asked to select the packages to install add to the default
     choices the following packages:
       Devel/
         autoconf*
         automake*
         binutils
         gcc*
         make
       Lib/
         pcre **both binaries and sources**
     you may also find useful to install the following packages
       Editors/
         emacs or vim (no trolls)
       Net/
         openssh
         ncftp
       Devel/
         cvs
       Utils/
         diff
         patch
     then proceed with installation


2) Download (we suggest in /usr/src) and install Ocaml
   [For the impatients: ./configure && make world.opt]


3) Download (guess where) and install findlib
   a plain ./configure && make all && make opt && make install
   should work 


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

     make runtime.all & make install_runtime

5) Download and unpack pcre-ocaml. 
   - copy pcre_make.win32/pcre.h to the pcre source directory you
     installed at point (1) (it should be in /usr/src/pcre-X.Y-Z)
   - cd in the source directory of pcre, copy or rename the file 
     config.in as config.h, and change in this new file 
     the macros that define HAVE_STRERROR and HAVE_MEMMOVE to 
     define them as 1 rather than 0.
   - Compile and install by
     make STATIC=1
     make install STATIC=1

   
6) Download and install ocamlnet


7) PXP:
   CDuce requires a development version >= 1.1.93.
   configure with the following options
   ./configure -with-lex -with-lex-compat
   make all && make opt && make install


Now you can compile CDuce sources as indicated in the INSTALL file 
namely 

  
------------------------------------------------------------------------------
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)

Usage, e.g.:
  make cduce NATIVE=false


------------------------------------------------------------------------------

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 latest release (0.95) was
  very slow, and it has been rewritten since then.

1	abate	406	Installation Notes for Windows NT/2000/XP
2	abate	404	=========================================
3
4
5			CDuce can be executed on Microsoft Windows by using the
6			RedHat/Cygnus environment Cygwin freely available at
7
8	abate	446	http://www.cygwin.com/
9	abate	404
10	abate	406	The executable needs the cygwin1.dll that is distributed
11			under GPL license. This is not compatible with the CDuce license.
12			For this reason we do not provide binaries but give here detailed
13	abate	404	instructions about how to compile CDuce sources under Cygwin/Windows.
14
15
16
17			------------------------------------------------------------------------------
18			Prerequisites
19			------------------------------------------------------------------------------
20
21			Before compiling CDuce on Windows, you need to install recent
22			releases of the following packages:
23
24
25			cygwin
26	abate	415	http://www.cygwin.com
27	abate	404	ocaml
28			http://caml.inria.fr/ocaml/distrib.html
29			findlib
30			http://www.ocaml-programming.de/packages
31			wlex
32			http://www.eleves.ens.fr/home/frisch/soft.html#wlex
33			pcre-ocaml
34			http://www.ai.univie.ac.at/~markus/home/ocaml_sources.html
35			ocamlnet
36	abate	446	http://sourceforge.net/projects/ocamlnet
37	abate	404	pxp
38			http://www.ocaml-programming.de/packages/documentation/pxp/index_dev.html
39
40
41			Installation notes (you are advised to follow this order):
42
43			1) Download and execute cygwin setup.exe.
44			- Choose Internet installation
45			- Choose a root directory whose path has no blanks in it
46			- Choose as Local Package Directory <your root>/usr/src (optional)
47			- Choose the mirror closest to you
48			- When asked to select the packages to install add to the default
49			choices the following packages:
50			Devel/
51			autoconf*
52			automake*
53			binutils
54			gcc*
55			make
56			Lib/
57			pcre both binaries and sources
58			you may also find useful to install the following packages
59			Editors/
60			emacs or vim (no trolls)
61			Net/
62			openssh
63			ncftp
64			Devel/
65			cvs
66			Utils/
67			diff
68			patch
69	abate	406	then proceed with installation
70	abate	404
71
72			2) Download (we suggest in /usr/src) and install Ocaml
73			[For the impatients: ./configure && make world.opt]
74
75
76			3) Download (guess where) and install findlib
77			a plain ./configure && make all && make opt && make install
78			should work
79
80
81			4) Download and install wlex:
82			you only need to build and install the runtime support library
83			(not the wlex tool itself):
84
85			make runtime.all & make install_runtime
86
87			5) Download and unpack pcre-ocaml.
88	abate	498	- copy pcre_make.win32/pcre.h to the pcre source directory you
89	abate	404	installed at point (1) (it should be in /usr/src/pcre-X.Y-Z)
90	abate	498	- cd in the source directory of pcre, copy or rename the file
91			config.in as config.h, and change in this new file
92	abate	404	the macros that define HAVE_STRERROR and HAVE_MEMMOVE to
93			define them as 1 rather than 0.
94			- Compile and install by
95			make STATIC=1
96			make install STATIC=1
97
98
99			6) Download and install ocamlnet
100
101
102			7) PXP:
103			CDuce requires a development version >= 1.1.93.
104			configure with the following options
105			./configure -with-lex -with-lex-compat
106			make all && make opt && make install
107
108
109
110			Now you can compile CDuce sources as indicated in the INSTALL file
111			namely
112
113
114			------------------------------------------------------------------------------
115			Compilation
116			------------------------------------------------------------------------------
117
118			You need a GNU Make (or equivalent) to use the Makefile from the
119			distribution. It defines the following goals:
120
121			- make cduce
122			compiles the CDuce command line interpreter
123
124			- make dtd2cduce
125			compiles the dtd2cduce tools (converts DTD to CDuce types)
126
127			- make webiface
128			compiles the CDuce web interface interpreter (to be used as a CGI script)
129
130			- make local_website
131			compiles in the web/www/ subdirectory the HTML files of CDuce website
132			(including the tutorial)
133
134			- make all
135			equivalent to (make cduce; make dtd2cduce; make local_website)
136
137
138			Makefile accepts the following options, which can take the values
139			true or false.
140
141			NATIVE=true : use the OCaml native code compiler (ocamlopt) to build CDuce
142			NATIVE=false : use the OCaml bytecode compiler (ocamlc)
143			default: true (the native code version is much faster)
144
145			PXP_WLEX=true : use wlex for parsing UTF-8 XML files
146			PXP_WLEX=false: use ocamllex for parsing UTF-8 XML files
147			default: false (ocamllex is faster; wlex is more compact)
148
149			Usage, e.g.:
150			make cduce NATIVE=false
151
152
153			------------------------------------------------------------------------------
154
155			Efficiency issues:
156
157			- OCamlnet: if you plan to load XML file with encodings other than
158			UTF-8, it is advised to use the CVS version of OCamlnet:
159			http://sourceforge.net/cvs/?group_id=19774
160	abate	406	Indeed, the netconversion module in the latest release (0.95) was
161	abate	404	very slow, and it has been rewritten since then.
162