Page
Library
Module
Module type
Parameter
Class
Class type
Source
Release 0.9.4
Cmdliner is a module for the declarative definition of command line interfaces.
It provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions. The module automatically handles syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands and respects most of the POSIX and GNU conventions.
Cmdliner is made of a single independent module and distributed under the BSD3 license.
Home page: http://erratique.ch/software/cmdliner Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>
Cmdliner can be installed with opam
:
opam install cmdliner
If you don't use opam
consult the opam
file for build instructions.
The documentation and API reference is automatically generated by ocamldoc
from the interfaces. It can be consulted online and there is a generated version in the doc
directory of the distribution.
If you installed Cmdliner with opam
sample programs are located in the directory opam config var cmdliner:doc
. These programs define the command line of some classic programs.
In the distribution sample programs are located in the test
directory of the distribution. They can be built with:
ocamlbuild -use-ocamlfind test/tests.otarget
The resulting binaries are in _build/test
.