CAML2HTML(1) General Commands Manual CAML2HTML(1)NAME
caml2html - colorizes a set of OCaml source files.
SYNOPSIS
caml2html [options] file*
DESCRIPTION
Caml2html colorizes a set of OCaml source files (.ml, .mli, .mll, .mly, ...). Type annotations will be shown when the mouse pointer passes
over an expression if the corresponding .annot file is available.
To obtain a .annot file, compile your OCaml source files with ocamlc -dtypes or ocamlopt -dtypes.
OPTIONS -annotfilter {innermost|outermost}
choose whether innermost or outermost type annotations should be used (default: innermost)
-charset
specify charset to use (default: iso-8859-1)
-css use CSS named style.css for styling
-cssurl
use the given URL as CSS for styling
-inhead
use default styling and place it in the head section of the document (default when applicable)
-inline
use inline styling (HTML only, default fallback if -inhead is not applicable)
-body output only document's body, for inclusion into an existing document (see also -make-css and -make-latex-defs)
-ln add line number at the beginning of each line
-hc comments are treated as raw HTML or LaTeX code (no newlines inside of tags)
-t add a title to the HTML page
-nf do not add footnotes to the HTML page
-ie7 drop support for type annotations on Internet Explorer 6 and older
-noannot
do not insert type annotations as read from .annot files (HTML output only)
-notab do not replace tabs by spaces
-tab replace tab by n spaces (default = 8)
-d generate files in directory dir, rather than in current directory
-o output file
-v print version number to stdout and exit
-make-css
create CSS file with default color definitions and exit
-ext <NAME:CMD>
use the given external command CMD to handle comments that start with (*NAME. NAME must be a lowercase identifier.
-latex output LaTeX code instead of HTML.
-make-latex-defs
create a file containing the default LaTeX color definitions and matching highlighting commands, and exit. is not included.
-help|--help
Display this list of options
AUTHORS
Sylvain Le Gall.
Caml2html User Manual November 9, 2010 CAML2HTML(1)
Check Out this Related Man Page
coqdoc(1) General Commands Manual coqdoc(1)NAME
coqdoc - A documentation tool for the Coq proof assistant
SYNOPSIS
coqdoc [ options ] files
DESCRIPTION
coqdoc is a documentation tool for the Coq proof assistant. It creates LaTeX or HTML documents from a set of Coq files. See the Coq ref-
erence manual for documentation (url below).
OPTIONS
Overall options
-h Help. Will give you the complete list of options accepted by coqdoc.
--html Select a HTML output.
--latex
Select a LATEX output.
--dvi Select a DVI output.
--ps Select a PostScript output.
--texmacs
Select a TeXmacs output.
--stdout
Redirect the output to stdout
-o file,--output file
Redirect the output into the file file.
-d dir, --directory dir
Output files into directory dir instead of current directory (option -d does not change the filename specified with option -o, if
any).
-s, --short
Do not insert titles for the files. The default behavior is to insert a title like ``Library Foo'' for each file.
-t string, --title string
Set the document title.
--body-only
Suppress the header and trailer of the final document. Thus, you can insert the resulting document into a larger one.
-p string, --preamble string
Insert some material in the LATEX preamble, right before egin{document} (meaningless with -html).
--vernac-file file, --tex-file file
Considers the file `file' respectively as a .v (or .g) file or a .tex file.
--files-from file
Read file names to process in file `file' as if they were given on the command line. Useful for program sources split in several
directories.
-q, --quiet
Be quiet. Do not print anything except errors.
-h, --help
Give a short summary of the options and exit.
-v, --version
Print the version and exit.
Index options
Default behavior is to build an index, for the HTML output only, into index.html.
--no-index
Do not output the index.
--multi-index
Generate one page for each category and each letter in the index, together with a top page index.html.
Table of contents option
-toc, --table-of-contents
Insert a table of contents. For a LATEX output, it inserts a ableofcontents at the beginning of the document. For a HTML output,
it builds a table of contents into toc.html.
Hyperlinks options
--glob-from file
Make references using Coq globalizations from file file. (Such globalizations are obtained with Coq option -dump-glob).
--no-externals
Do not insert links to the Coq standard library.
--external url libroot
Set base URL for the external library whose root prefix is libroot.
--coqlib url
Set base URL for the Coq standard library (default is http://coq.inria.fr/library/).
--coqlib_path dir
Set the base path where the Coq files are installed, especially style files coqdoc.sty and coqdoc.css.
-R dir coqdir
Map physical directory dir to Coq logical directory coqdir (similarly to Coq option -R). Note: option -R only has effect on the
files following it on the command line, so you will probably need to put this option first.
Contents options
-g, --gallina
Do not print proofs.
-l, --light
Light mode. Suppress proofs (as with -g) and the following commands:
* [Recursive] Tactic Definition
* Hint / Hints
* Require
* Transparent / Opaque
* Implicit Argument / Implicits
* Section / Variable / Hypothesis / End
The behavior of options -g and -l can be locally overridden using the (* begin show *) ... (* end show *) environment (see above).
Language options
Default behavior is to assume ASCII 7 bits input files.
-latin1, --latin1
Select ISO-8859-1 input files. It is equivalent to --inputenc latin1 --charset iso-8859-1.
-utf8, --utf8
Select UTF-8 (Unicode) input files. It is equivalent to --inputenc utf8 --charset utf-8. LATEX UTF-8 support can be found at
http://www.ctan.org/tex-archive/macros/latex/contrib/supported/unicode/.
--inputenc string
Give a LATEX input encoding, as an option to LATEX package inputenc.
--charset string
Specify the HTML character set, to be inserted in the HTML header.
SEE ALSO
The Coq Reference Manual from http://coq.inria.fr/
April, 2006 coqdoc(1)