OCaml module Generator
Reference manual
Version 3.3

Pierre Weis <Pierre.Weis@inria.fr>

2014-01-31

1  Installation of OCamlGen

To install the OCamlGen command, follow the instructions in the INSTALL file of the distribution, or use the generic instructions of the next section.

OCamlGen is a free software distributed under the BSD license, see the LICENSE file for details.

2  For the users of the distributed version of your package

They should follow the directives of the INSTALL file of the distribution of your package.

2.1  To configure, build and install the package

  ./configure [<installation_root_directory>]
  make
  make install

When called with one argument, the configure script makes it the root directory for the installation. When called without argument, the configure script interactively asks the user.

The variable installation_root_directory stands for the directory where the project will be installed; it must contain a valid directory name where the user can write. All the files that are installed by your project will be copied into sub directories of this one. Namely:

0pt 5pt •
binaries go into the sub-directory
installation_root_directory/bin,
•
includes go into the sub-directory
installation_root_directory/include/<project_package_name>,
•
OCaml libraries go into the sub-directory
installation_root_directory/include/lib/ocaml/<project_package_name> and other libraries go into the sub-directory
installation_root_directory/lib/<project_package_name>,
•
manual pages go into the sub-directory
installation_root_directory/man/man<man_section>,
•
(La)TeX documentations go into the sub-directory
installation_root_directory/share/doc/tex and HTML documentation pages go into the sub-directory
installation_root_directory/share/doc/htm,
•
other materials go into the sub-directory
installation_root_directory/share/<project_package_name>.

2.2  To clean and remove the package

To remove all files installed by make install, all files built by make and all files created by ./configure, respectively type in:

  make uninstall
  make clean
  ./unconfigure
This document was translated from LATEX by HEVEA.