autodoc.git/ traditional_manual/ chapter_21.html

Branch: Tag:

2020-05-24

2020-05-24 00:18:39 by Stephen R. van den Berg <srb@cuci.nl>

Arg: Document the help/usage system.

4009:    constant <code>String.__HAVE_SPRINTF_NEGATIVE_F__</code>.</p>   </dd>   <dt class='head--doc'>Example</dt> - <dd class='example'><pre><pre><code><span class='ns'>Pike</span> v7<span class='delim'>.</span>8 release 263 running Hilfe v3<span class='delim'>.</span>5 <span class='delim'>(</span>Incremental <span class='ns'>Pike</span> Frontend<span class='delim'>)</span> + <dd class='example'><pre><pre><code><span class='ns'>Pike</span> v7.8 release 263 running Hilfe v3.5 <span class='delim'>(</span>Incremental <span class='ns'>Pike</span> Frontend<span class='delim'>)</span>   <span class='delim'>&gt;</span> sprintf<span class='delim'>(</span><span class='string'>"The unicode character %c has character code %04X."</span><span class='delim'>,</span> <span class='string'>'A'</span><span class='delim'>,</span> <span class='string'>'A'</span><span class='delim'>)</span><span class='delim'>;</span>   <span class='delim'>(</span>1<span class='delim'>)</span> Result<span class='delim'>:</span> <span class='string'>"The unicode character A has character code 0041."</span>   <span class='delim'>&gt;</span> sprintf<span class='delim'>(</span><span class='string'>"#%@02X is the HTML code for purple."</span><span class='delim'>,</span> <span class='ns'>Image</span><span class='delim'>.</span>Color<span class='delim'>.</span>purple-&gt;rgb<span class='delim'>(</span><span class='delim'>)</span><span class='delim'>)</span><span class='delim'>;</span>
9168:    and add supported arguments.</p>   <pre><code><span class='type'>class</span> MyArguments <span class='delim'>{</span>    <span class='lang'>inherit</span> <span class='ns'>Arg</span><span class='delim'>.</span>Options<span class='delim'>;</span> +  <span class='type'>string</span> help_pre <span class='delim'>=</span> <span class='string'>"Usage: somecommand"</span><span class='delim'>;</span>    Opt verbose <span class='delim'>=</span> NoOpt<span class='delim'>(</span><span class='string'>"-v"</span><span class='delim'>)</span><span class='delim'>|</span>NoOpt<span class='delim'>(</span><span class='string'>"--verbose"</span><span class='delim'>)</span><span class='delim'>;</span> -  +  <span class='type'>string</span> verbose_help <span class='delim'>=</span> <span class='string'>"Turn on verbose output"</span><span class='delim'>;</span>    Opt help <span class='delim'>=</span> MaybeOpt<span class='delim'>(</span><span class='string'>"--help"</span><span class='delim'>)</span><span class='delim'>;</span>    Opt output <span class='delim'>=</span> HasOpt<span class='delim'>(</span><span class='string'>"--output"</span><span class='delim'>)</span><span class='delim'>|</span>HasOpt<span class='delim'>(</span><span class='string'>"-o"</span><span class='delim'>)</span><span class='delim'>;</span> -  +  <span class='type'>string</span> output_help <span class='delim'>=</span> <span class='string'>"Determine where output goes to"</span><span class='delim'>;</span> +  <span class='type'>string</span> help_post <span class='delim'>=</span> <span class='string'>"Command aborted"</span><span class='delim'>;</span>   <span class='delim'>}</span><span class='delim'>;</span>   </code></pre><p>Then, in main:</p>   <pre><code>MyArguments args = MyArguments(argv);</code></pre><p>See the documentation for <code>OptLibrary</code> for details about the various