mirror of
https://github.com/c-cube/linol.git
synced 2025-12-08 04:05:46 -05:00
2 lines
5.5 KiB
HTML
2 lines
5.5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Exit (cmdliner.Cmdliner.Cmd.Exit)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">cmdliner</a> » <a href="../../index.html">Cmdliner</a> » <a href="../index.html">Cmd</a> » Exit</nav><header class="odoc-preamble"><h1>Module <code><span>Cmd.Exit</span></code></h1><p>Exit codes and their information.</p></header><nav class="odoc-toc"><ul><li><a href="#codes">Exit codes</a></li><li><a href="#info">Exit code information</a></li></ul></nav><div class="odoc-content"><h2 id="codes"><a href="#codes" class="anchor"></a>Exit codes</h2><div class="odoc-spec"><div class="spec type anchored" id="type-code"><a href="#type-code" class="anchor"></a><code><span><span class="keyword">type</span> code</span><span> = int</span></code></div><div class="spec-doc"><p>The type for exit codes.</p><p><b>Warning.</b> You should avoid status codes strictly greater than 125 as those may be used by <a href="https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html">some</a> shells.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ok"><a href="#val-ok" class="anchor"></a><code><span><span class="keyword">val</span> ok : <a href="#type-code">code</a></span></code></div><div class="spec-doc"><p><code>ok</code> is <code>0</code>, the exit status for success.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-some_error"><a href="#val-some_error" class="anchor"></a><code><span><span class="keyword">val</span> some_error : <a href="#type-code">code</a></span></code></div><div class="spec-doc"><p><code>some_error</code> is <code>123</code>, an exit status for indisciminate errors reported on stderr.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cli_error"><a href="#val-cli_error" class="anchor"></a><code><span><span class="keyword">val</span> cli_error : <a href="#type-code">code</a></span></code></div><div class="spec-doc"><p><code>cli_error</code> is <code>124</code>, an exit status for command line parsing errors.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-internal_error"><a href="#val-internal_error" class="anchor"></a><code><span><span class="keyword">val</span> internal_error : <a href="#type-code">code</a></span></code></div><div class="spec-doc"><p><code>internal_error</code> is <code>125</code>, an exit status for unexpected internal errors.</p></div></div><h2 id="info"><a href="#info" class="anchor"></a>Exit code information</h2><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> info</span></code></div><div class="spec-doc"><p>The type for exit code information.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span><span class="optlabel">?docs</span>:string <span class="arrow">-></span></span> <span><span class="optlabel">?doc</span>:string <span class="arrow">-></span></span> <span><span class="optlabel">?max</span>:<a href="#type-code">code</a> <span class="arrow">-></span></span> <span><a href="#type-code">code</a> <span class="arrow">-></span></span> <a href="#type-info">info</a></span></code></div><div class="spec-doc"><p><code>exit_info ~docs ~doc min ~max</code> describe the range of exit statuses from <code>min</code> to <code>max</code> (defaults to <code>min</code>). <code>doc</code> is the man page information for the statuses, defaults to <code>"undocumented"</code>. <code>docs</code> is the title of the man page section in which the statuses will be listed, it defaults to <a href="../../Manpage/index.html#val-s_exit_status"><code>Manpage.s_exit_status</code></a>.</p><p>In <code>doc</code> the <a href="../../../tool_man.html#doclang" title="doclang">documentation markup language</a> can be used with following variables:</p><ul><li><code>$(status)</code>, the value of <code>min</code>.</li><li><code>$(status_max)</code>, the value of <code>max</code>.</li><li>The variables mentioned in the <a href="../index.html#val-info"><code>Cmd.info</code></a></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info_code"><a href="#val-info_code" class="anchor"></a><code><span><span class="keyword">val</span> info_code : <span><a href="#type-info">info</a> <span class="arrow">-></span></span> <a href="#type-code">code</a></span></code></div><div class="spec-doc"><p><code>info_code i</code> is the minimal code of <code>i</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-defaults"><a href="#val-defaults" class="anchor"></a><code><span><span class="keyword">val</span> defaults : <span><a href="#type-info">info</a> list</span></span></code></div><div class="spec-doc"><p><code>defaults</code> are exit code information for <a href="#val-ok"><code>ok</code></a>, <a href="#val-some_error"><code>some_error</code></a> <a href="#val-cli_error"><code>cli_error</code></a> and <a href="#val-internal_error"><code>internal_error</code></a>.</p></div></div></div></body></html>
|