Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revised documentation #1539

Merged
merged 4 commits into from
Jan 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/A-Whirlwind-Tour-of-Picocli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ Usage: <main class> [OPTIONS] [<files>...]
Note that the positional parameters are not abbreviated.

=== Custom Synopsis
For even more control of the synopsis, use the `customSynopsis` attribute to specify one ore more synopsis lines. For example:
For even more control of the synopsis, use the `customSynopsis` attribute to specify one or more synopsis lines. For example:

.Example custom synopsis with multiple lines
----
Expand Down
2 changes: 1 addition & 1 deletion docs/A-Whirlwind-Tour-of-Picocli.html
Original file line number Diff line number Diff line change
Expand Up @@ -2293,7 +2293,7 @@ <h3 id="_abbreviated_synopsis">Abbreviated Synopsis</h3>
<div class="sect2">
<h3 id="_custom_synopsis">Custom Synopsis</h3>
<div class="paragraph">
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one ore more synopsis lines. For example:</p>
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one or more synopsis lines. For example:</p>
</div>
<div class="listingblock">
<div class="title">Example custom synopsis with multiple lines</div>
Expand Down
14 changes: 7 additions & 7 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ class Tar {
@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file")
File archive;

@Parameters(paramLabel = "FILE", description = "one ore more files to archive")
@Parameters(paramLabel = "FILE", description = "one or more files to archive")
File[] files;

@Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message")
Expand All @@ -450,7 +450,7 @@ class Tar : Runnable {
@Option(names = ["-f", "--file"], paramLabel = "ARCHIVE", description = ["the archive file"])
lateinit var archive: File;

@Parameters(paramLabel = "FILE", description = ["one ore more files to archive"])
@Parameters(paramLabel = "FILE", description = ["one or more files to archive"])
lateinit var files: Array<File>;

@Option(names = ["-h", "--help"], usageHelp = true, description = ["display a help message"])
Expand Down Expand Up @@ -3230,7 +3230,7 @@ class MyApp implements Runnable {
static class Outer {
@Option(names = "-x", defaultValue = "XX") String x = "XX";

@ArgGroup(exclusive = "true")
@ArgGroup(exclusive = true)
Inner inner; // no initial value
}

Expand Down Expand Up @@ -3265,7 +3265,7 @@ class MyApp : Runnable {
class Outer {
@Option(names = "-x", defaultValue = "XX") var x = "XX";

@ArgGroup(exclusive = "true")
@ArgGroup(exclusive = true)
lateinit var inner: Inner // no initial value
}

Expand Down Expand Up @@ -6081,7 +6081,7 @@ class App {
----

=== Custom Synopsis
For even more control of the synopsis, use the `customSynopsis` attribute to specify one ore more synopsis lines. For example:
For even more control of the synopsis, use the `customSynopsis` attribute to specify one or more synopsis lines. For example:
----
Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form)
or: ln [OPTION]... TARGET (2nd form)
Expand Down Expand Up @@ -8060,7 +8060,7 @@ class ListFiles : Runnable {
----

=== Subcommand Aliases
Commands may optionally define an `aliases` attribute to provide alternate names for commands that will be recognized by the parser. Aliases are displayed in the default help output. For example:
Commands may optionally define an `aliases` attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:

.Java
[source,java,role="primary"]
Expand Down Expand Up @@ -11861,7 +11861,7 @@ In a production system, to have to set the boolean configuration value `quarkus.
Please refer to the Quarkus guide https://quarkus.io/guides/mailer[Sending Emails] for details and additional information.
====

As an extra, our command line interface offers the opportunity to specify one ore more custom header lines via the `headers` subcommand, more specifically via the `--header` option (`KEY="MY VALUE STRINGS"`) of this subcommand:
As an extra, our command line interface offers the opportunity to specify one or more custom header lines via the `headers` subcommand, more specifically via the `--header` option (`KEY="MY VALUE STRINGS"`) of this subcommand:
----
./mvnw compile quarkus:dev -Dquarkus.args="--from= ... --to ... body message headers \
--header X-Mailer=Picocli/Quarkus --header X-Mailer-Version=1.0"
Expand Down
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2692,7 +2692,7 @@ <h3 id="_options"><a class="anchor" href="#_options"></a>3.1. Options</h3>
<span class="nd">@Option</span><span class="o">(</span><span class="n">names</span> <span class="o">=</span> <span class="o">{</span> <span class="s">"-f"</span><span class="o">,</span> <span class="s">"--file"</span> <span class="o">},</span> <span class="n">paramLabel</span> <span class="o">=</span> <span class="s">"ARCHIVE"</span><span class="o">,</span> <span class="n">description</span> <span class="o">=</span> <span class="s">"the archive file"</span><span class="o">)</span>
<span class="nc">File</span> <span class="n">archive</span><span class="o">;</span>

<span class="nd">@Parameters</span><span class="o">(</span><span class="n">paramLabel</span> <span class="o">=</span> <span class="s">"FILE"</span><span class="o">,</span> <span class="n">description</span> <span class="o">=</span> <span class="s">"one ore more files to archive"</span><span class="o">)</span>
<span class="nd">@Parameters</span><span class="o">(</span><span class="n">paramLabel</span> <span class="o">=</span> <span class="s">"FILE"</span><span class="o">,</span> <span class="n">description</span> <span class="o">=</span> <span class="s">"one or more files to archive"</span><span class="o">)</span>
<span class="nc">File</span><span class="o">[]</span> <span class="n">files</span><span class="o">;</span>

<span class="nd">@Option</span><span class="o">(</span><span class="n">names</span> <span class="o">=</span> <span class="o">{</span> <span class="s">"-h"</span><span class="o">,</span> <span class="s">"--help"</span> <span class="o">},</span> <span class="n">usageHelp</span> <span class="o">=</span> <span class="kc">true</span><span class="o">,</span> <span class="n">description</span> <span class="o">=</span> <span class="s">"display a help message"</span><span class="o">)</span>
Expand All @@ -2710,7 +2710,7 @@ <h3 id="_options"><a class="anchor" href="#_options"></a>3.1. Options</h3>
<span class="nd">@Option</span><span class="p">(</span><span class="n">names</span> <span class="p">=</span> <span class="p">[</span><span class="s">"-f"</span><span class="p">,</span> <span class="s">"--file"</span><span class="p">],</span> <span class="n">paramLabel</span> <span class="p">=</span> <span class="s">"ARCHIVE"</span><span class="p">,</span> <span class="n">description</span> <span class="p">=</span> <span class="p">[</span><span class="s">"the archive file"</span><span class="p">])</span>
<span class="k">lateinit</span> <span class="kd">var</span> <span class="py">archive</span><span class="p">:</span> <span class="nc">File</span><span class="p">;</span>

<span class="nd">@Parameters</span><span class="p">(</span><span class="n">paramLabel</span> <span class="p">=</span> <span class="s">"FILE"</span><span class="p">,</span> <span class="n">description</span> <span class="p">=</span> <span class="p">[</span><span class="s">"one ore more files to archive"</span><span class="p">])</span>
<span class="nd">@Parameters</span><span class="p">(</span><span class="n">paramLabel</span> <span class="p">=</span> <span class="s">"FILE"</span><span class="p">,</span> <span class="n">description</span> <span class="p">=</span> <span class="p">[</span><span class="s">"one or more files to archive"</span><span class="p">])</span>
<span class="k">lateinit</span> <span class="kd">var</span> <span class="py">files</span><span class="p">:</span> <span class="nc">Array</span><span class="p">&lt;</span><span class="nc">File</span><span class="p">&gt;;</span>

<span class="nd">@Option</span><span class="p">(</span><span class="n">names</span> <span class="p">=</span> <span class="p">[</span><span class="s">"-h"</span><span class="p">,</span> <span class="s">"--help"</span><span class="p">],</span> <span class="n">usageHelp</span> <span class="p">=</span> <span class="k">true</span><span class="p">,</span> <span class="n">description</span> <span class="p">=</span> <span class="p">[</span><span class="s">"display a help message"</span><span class="p">])</span>
Expand Down Expand Up @@ -9936,7 +9936,7 @@ <h3 id="_abbreviated_synopsis"><a class="anchor" href="#_abbreviated_synopsis"><
<div class="sect2">
<h3 id="_custom_synopsis"><a class="anchor" href="#_custom_synopsis"></a>14.9. Custom Synopsis</h3>
<div class="paragraph">
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one ore more synopsis lines. For example:</p>
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one or more synopsis lines. For example:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down Expand Up @@ -12344,7 +12344,7 @@ <h3 id="parentcommand-annotation"><a class="anchor" href="#parentcommand-annotat
<div class="sect2">
<h3 id="_subcommand_aliases"><a class="anchor" href="#_subcommand_aliases"></a>17.8. Subcommand Aliases</h3>
<div class="paragraph">
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names for commands that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
hamid-nazari marked this conversation as resolved.
Show resolved Hide resolved
</div>
<div class="listingblock primary">
<div class="title">Java</div>
Expand Down Expand Up @@ -16854,7 +16854,7 @@ <h3 id="_quarkus_example"><a class="anchor" href="#_quarkus_example"></a>22.4. Q
</table>
</div>
<div class="paragraph">
<p>As an extra, our command line interface offers the opportunity to specify one ore more custom header lines via the <code>headers</code> subcommand, more specifically via the <code>--header</code> option (<code>KEY="MY VALUE STRINGS"</code>) of this subcommand:</p>
<p>As an extra, our command line interface offers the opportunity to specify one or more custom header lines via the <code>headers</code> subcommand, more specifically via the <code>--header</code> option (<code>KEY="MY VALUE STRINGS"</code>) of this subcommand:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down
4 changes: 2 additions & 2 deletions docs/man/1.x/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,7 @@ <h3 id="_options">2.1. Options</h3>
<span class="annotation">@Option</span>(names = { <span class="string"><span class="delimiter">&quot;</span><span class="content">-f</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--file</span><span class="delimiter">&quot;</span></span> }, paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">ARCHIVE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">the archive file</span><span class="delimiter">&quot;</span></span>)
<span class="predefined-type">File</span> archive;

<span class="annotation">@Parameters</span>(paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">FILE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">one ore more files to archive</span><span class="delimiter">&quot;</span></span>)
<span class="annotation">@Parameters</span>(paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">FILE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">one or more files to archive</span><span class="delimiter">&quot;</span></span>)
<span class="predefined-type">File</span><span class="type">[]</span> files;

<span class="annotation">@Option</span>(names = { <span class="string"><span class="delimiter">&quot;</span><span class="content">-h</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--help</span><span class="delimiter">&quot;</span></span> }, usageHelp = <span class="predefined-constant">true</span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">display a help message</span><span class="delimiter">&quot;</span></span>)
Expand Down Expand Up @@ -1674,7 +1674,7 @@ <h3 id="_abbreviated_synopsis">8.5. Abbreviated Synopsis</h3>
<div class="sect2">
<h3 id="_custom_synopsis">8.6. Custom Synopsis</h3>
<div class="paragraph">
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one ore more synopsis lines. For example:</p>
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one or more synopsis lines. For example:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down
4 changes: 2 additions & 2 deletions docs/man/2.x/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,7 @@ <h3 id="_options">2.1. Options</h3>
<span class="annotation">@Option</span>(names = { <span class="string"><span class="delimiter">&quot;</span><span class="content">-f</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--file</span><span class="delimiter">&quot;</span></span> }, paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">ARCHIVE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">the archive file</span><span class="delimiter">&quot;</span></span>)
<span class="predefined-type">File</span> archive;

<span class="annotation">@Parameters</span>(paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">FILE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">one ore more files to archive</span><span class="delimiter">&quot;</span></span>)
<span class="annotation">@Parameters</span>(paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">FILE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">one or more files to archive</span><span class="delimiter">&quot;</span></span>)
<span class="predefined-type">File</span><span class="type">[]</span> files;

<span class="annotation">@Option</span>(names = { <span class="string"><span class="delimiter">&quot;</span><span class="content">-h</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--help</span><span class="delimiter">&quot;</span></span> }, usageHelp = <span class="predefined-constant">true</span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">display a help message</span><span class="delimiter">&quot;</span></span>)
Expand Down Expand Up @@ -2314,7 +2314,7 @@ <h3 id="_abbreviated_synopsis">9.5. Abbreviated Synopsis</h3>
<div class="sect2">
<h3 id="_custom_synopsis">9.6. Custom Synopsis</h3>
<div class="paragraph">
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one ore more synopsis lines. For example:</p>
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one or more synopsis lines. For example:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down
6 changes: 3 additions & 3 deletions docs/man/3.x/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -860,7 +860,7 @@ <h3 id="_options">2.1. Options</h3>
<span class="annotation">@Option</span>(names = { <span class="string"><span class="delimiter">&quot;</span><span class="content">-f</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--file</span><span class="delimiter">&quot;</span></span> }, paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">ARCHIVE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">the archive file</span><span class="delimiter">&quot;</span></span>)
<span class="predefined-type">File</span> archive;

<span class="annotation">@Parameters</span>(paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">FILE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">one ore more files to archive</span><span class="delimiter">&quot;</span></span>)
<span class="annotation">@Parameters</span>(paramLabel = <span class="string"><span class="delimiter">&quot;</span><span class="content">FILE</span><span class="delimiter">&quot;</span></span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">one or more files to archive</span><span class="delimiter">&quot;</span></span>)
<span class="predefined-type">File</span><span class="type">[]</span> files;

<span class="annotation">@Option</span>(names = { <span class="string"><span class="delimiter">&quot;</span><span class="content">-h</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">--help</span><span class="delimiter">&quot;</span></span> }, usageHelp = <span class="predefined-constant">true</span>, description = <span class="string"><span class="delimiter">&quot;</span><span class="content">display a help message</span><span class="delimiter">&quot;</span></span>)
Expand Down Expand Up @@ -2900,7 +2900,7 @@ <h3 id="_abbreviated_synopsis">10.6. Abbreviated Synopsis</h3>
<div class="sect2">
<h3 id="_custom_synopsis">10.7. Custom Synopsis</h3>
<div class="paragraph">
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one ore more synopsis lines. For example:</p>
<p>For even more control of the synopsis, use the <code>customSynopsis</code> attribute to specify one or more synopsis lines. For example:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down Expand Up @@ -3815,7 +3815,7 @@ <h3 id="_registering_subcommands_declaratively">13.2. Registering Subcommands De
<div class="sect2">
<h3 id="_subcommand_aliases">13.3. Subcommand Aliases</h3>
<div class="paragraph">
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names for commands that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down
Loading