mirror of
https://github.com/c-cube/linol.git
synced 2025-12-06 03:05:31 -05:00
2 lines
4.3 KiB
HTML
2 lines
4.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (cmdliner.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">Index</a> » cmdliner</nav><header class="odoc-preamble"><h1 id="package-cmdliner"><a href="#package-cmdliner" class="anchor"></a>Package cmdliner <nav><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">changes</a> <a href="#package_info">more…</a></nav></h1><p>Cmdliner provides a simple and compositional mechanism to convert command line arguments to OCaml values and pass them to your functions.</p><p>The library automatically handles command line completion, syntax errors, help messages and UNIX man page generation. It supports programs with single or multiple commands (like <code>git</code>) and respect most of the <a href="http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html">POSIX</a> and <a href="http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html">GNU</a> conventions.</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#manuals">Manuals</a></li><li><a href="#library">Library <code>cmdliner</code></a></li><li><a href="#package_info">Package info</a></li></ul></nav></div><div class="odoc-content"><h2 id="manuals"><a href="#manuals" class="anchor"></a>Manuals</h2><p>The following manuals are available.</p><ul><li>The <a href="tutorial.html" title="tutorial">tutorial</a> makes you write your first command line interface with Cmdliner.</li><li>The <a href="cookbook.html" title="cookbook">cookbook</a> has a few off-the-shelf recipes, tips about <a href="cookbook.html#tip_src_structure" title="tip_src_structure">source code structure</a>, and <a href="cookbook.html#blueprints" title="blueprints">blueprints</a> to define your command lines with Cmdliner.</li><li>The <a href="cli.html" title="cli">command line interface manual</a> describes how command lines and environment variables are parsed by Cmdliner and how command line completion is performed. This can be communicated to the users of your tools.</li><li>The <a href="tool_man.html" title="tool_man">tool man page</a> manual describes how Cmdliner generates man pages for your tools and their commands and how you can format them.</li><li>The <a href="examples.html" title="examples">examples page</a> has examples of a some classic UNIX tools with their command line interface implemented by Cmdliner.</li></ul><h2 id="library"><a href="#library" class="anchor"></a>Library <code>cmdliner</code></h2><ul class="modules"><li><a href="Cmdliner/index.html"><code>Cmdliner</code></a> <span class="synopsis">Declarative definition of command line interfaces.</span></li></ul><ul class="modules"><li><a href="Cmdliner/Arg/index.html"><code>Cmdliner.Arg</code></a> <span class="synopsis">Terms for command line arguments.</span></li><li><a href="Cmdliner/Cmd/index.html"><code>Cmdliner.Cmd</code></a> <span class="synopsis">Commands.</span></li><li><a href="Cmdliner/Manpage/index.html"><code>Cmdliner.Manpage</code></a> <span class="synopsis">Man pages.</span></li><li><a href="Cmdliner/Term/index.html"><code>Cmdliner.Term</code></a> <span class="synopsis">Terms.</span></li></ul><h2 id="package_info"><a href="#package_info" class="anchor"></a>Package info</h2><table class="package info"><tr id="info-changes-files"><td><a href="#info-changes-files" aria-hidden="true" class="anchor"></a>changes-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/CHANGES.md">CHANGES.md</a></li></ul></td></tr><tr id="info-license-files"><td><a href="#info-license-files" aria-hidden="true" class="anchor"></a>license-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/LICENSE.md">LICENSE.md</a></li></ul></td></tr><tr id="info-readme-files"><td><a href="#info-readme-files" aria-hidden="true" class="anchor"></a>readme-files</td><td><ul><li><a type="text/plain; charset=UTF-8" href="_doc-dir/README.md">README.md</a></li></ul></td></tr></table></div></body></html>
|