mirror of
https://github.com/c-cube/linol.git
synced 2025-12-08 12:15:50 -05:00
49 lines
1.6 KiB
Markdown
Executable file
49 lines
1.6 KiB
Markdown
Executable file
Cmdliner — Declarative definition of command line interfaces for OCaml
|
|
-------------------------------------------------------------------------------
|
|
v1.3.0
|
|
|
|
Cmdliner allows the declarative definition of command line interfaces
|
|
for OCaml.
|
|
|
|
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][1] and [GNU][2] conventions.
|
|
|
|
Cmdliner has no dependencies and is distributed under the ISC license.
|
|
|
|
[1]: http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html
|
|
[2]: http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
|
|
|
|
Home page: http://erratique.ch/software/cmdliner
|
|
|
|
## Installation
|
|
|
|
Cmdliner can be installed with `opam`:
|
|
|
|
opam install cmdliner
|
|
|
|
If you don't use `opam` consult the [`opam`](opam) file for build
|
|
instructions.
|
|
|
|
|
|
## Documentation
|
|
|
|
The documentation and API reference is automatically generated by from
|
|
the source interfaces. It can be consulted [online][doc] or via
|
|
`odig doc cmdliner`.
|
|
|
|
[doc]: http://erratique.ch/software/cmdliner/doc/Cmdliner
|
|
|
|
|
|
## Sample programs
|
|
|
|
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 and run with:
|
|
|
|
topkg build --tests true && topkg test
|