Ekdohibs
/
ocaml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ocaml/manual
History
Gabriel Scherer e83607d8b6 remove ocamlbuild from the manual 
We leave a gutted-out chapter with a redirection to the github page
for stability of anchors and to inform users.
 		2016-02-18 11:41:20 -05:00
..
manual remove ocamlbuild from the manual 2016-02-18 11:41:20 -05:00
styles Add multind.sty. 2014-10-07 09:22:01 +00:00
tools clean up whitespace and cut long lines 2016-02-17 13:36:27 +01:00
LICENSE-for-the-manual clean up whitespace and cut long lines 2016-02-17 13:36:27 +01:00
Makefile manual build: have 'make all' run 'make tools' first 2015-11-29 08:41:31 +01:00
README.md manual build: have 'make all' run 'make tools' first 2015-11-29 08:41:31 +01:00

README.md

OCAML DOCUMENTATION

Prerequisites

  • Any prerequisites required to build OCaml from sources.

  • The Unix editor 'ed', no longer installed by default on some systems.

  • A LaTeX installation.

  • The HeVeA LaTeX-to-HTML convertor (available in OPAM): http://hevea.inria.fr/

Note that you must make sure hevea.sty is installed into TeX properly. Your package manager may not do this for you. Run kpsewhich hevea.sty to check.

Building

  1. Install the OCaml distribution.

  2. Run make in the manual.

NB: If you already set LD_LIBRARY_PATH (OS X: DYLD_LIBRARY_PATH) in you environnement don't forget to add otherlibs/unix:otherlibs/str to it in an absolute way.

Outputs

In the manual:

  • The HTML Manual is in directory htmlman. The main file is index.html.

  • The plain text manual is in direcory textman as file manual.txt.

  • The Info manual is in directory infoman.

  • The DVI manual is in directory texstuff as file manual.dvi.

  • The PDF manual is in directory texstuff as file pdfmanual.pdf.