1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE readme SYSTEM "readme.dtd" [
<!ENTITY % common SYSTEM "common.xml">
%common;
<!ENTITY m "<em>Shell</em>">
]>
<readme title="INSTALL - Shell">
<sect1><title>The "Shell" package</title>
<sect2><title>Prerequisites</title>
<p>
&m; does not need any other packages besides the O'Caml core. &m; needs
at least O'Caml 3.00. The installation procedure defined in the Makefile
requires <a href="&url.findlib-project;">findlib</a> to
work<footnote><em>Findlib</em> is a package manager, see the file
ABOUT-FINDLIB.</footnote>.
</p>
<p>&m; works only in true POSIX environments.</p>
</sect2>
<sect2><title>Configuration</title>
<p>
It is not necessary to configure "Shell".
</p>
</sect2>
<sect2><title>Compilation</title>
<p>
The Makefile defines the following goals:
</p>
<ul>
<li>
<p>make all</p>
<p>compiles with the bytecode compiler and creates shell.cma,
and libshell.a.</p>
</li>
<li>
<p>make opt</p>
<p>compiles with the native compiler and creates shell.cmxa,
and libshell.a.</p>
</li>
<li>
<p>make</p>
<p>creates the bytecode library, and only if possible, the
native library, too.</p>
</li>
</ul>
</sect2>
<sect2><title>Installation</title>
<p>
The Makefile defines the following goals:</p>
<ul>
<li>
<p>make findlib-install</p>
<p>installs the bytecode archive, the interface definitions, and if
present, the native archive in the default location of <em>findlib</em>
</p>
</li>
<li>
<p>make conventional-install</p>
<p>installs the bytecode archive, the interface definitions, and if
present, the native archive into the directory configured by the INSTALLDIR
variable of the Makefile
</p>
</li>
<li>
<p>make findlib-uninstall</p>
<p>removes the package</p>
</li>
<li>
<p>make conventional-uninstall</p>
<p>removes the files installed by conventional-install</p>
</li>
</ul>
</sect2>
<sect2>
<title>Linking Shell with findlib</title>
<p>The command
<code>
ocamlfind ocamlc ... -package shell ... -linkpkg ...
</code>
links the shell library into your program.</p>
</sect2>
</sect1>
</readme>
|