Skip to content

[pull] master from apache:master #135

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.

Sign up for GitHub

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

Merged
pull merged 6 commits into from
Nov 5, 2025
Merged

[pull] master from apache:master #135

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d4cead7
Fix issue with groups not being reported in help output. (#411)
Claudenw Nov 5, 2025
ded2696
Restore method order
garydgregory Nov 5, 2025
13c57f3
Sort method
garydgregory Nov 5, 2025
99682bc
ix issue with groups not being reported in help output. #411
garydgregory Nov 5, 2025
1669210
Use oak leaf logo
garydgregory Nov 5, 2025
a476f5c
Fix Javadoc error on Java 11 only
garydgregory Nov 5, 2025
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
Prev Previous commit
Next Next commit
Use oak leaf logo
  • Loading branch information
@garydgregory
garydgregory committed Nov 5, 2025
commit 1669210c367bf15140671985f25ee532b546a7b2
45 changes: 45 additions & 0 deletions src/main/java/org/apache/commons/cli/doc-files/leaf.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/java/org/apache/commons/cli/doc-files/logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 19 additions & 9 deletions src/main/javadoc/overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,12 @@
<title>Apache Commons CLI Overview</title>
</head>
<body>
<img src="../images/commons-logo.png" alt="Apache Commons CLI">
<a href="https://commons.apache.org/cli"> <img src="org/apache/commons/cli/doc-files/logo.png" alt="Apache Commons CLI">
</a>
<section id="Introducing">
<h1>
<img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Introducing Apache Commons CLI
</h1>

<p>The Apacahe Commons CLI component parses command-line arguments for your application.</p>

Expand All @@ -40,8 +45,6 @@
<p>
The homepage for the project is <a href="https://commons.apache.org">Apache Commons</a>
</p>
<section id="Introducing">
<h1>Introducing Apache Commons CLI</h1>
<p>
There are three stages to command line processing. They are the
definition, parsing and interrogation stages. The following
Expand Down Expand Up @@ -117,7 +120,7 @@ <h2>Interrogating the CLI</h2>
</section>
</section>
<section id="Using">
<h1>Using Apache Commons CLI</h1>
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Using Apache Commons CLI</h1>
<p>
The following sections describe some example scenarios on how to
use CLI in applications.
Expand Down Expand Up @@ -240,7 +243,7 @@ <h2>Retrieving the argument value</h2>
</section>

<section>
<h1>Using Ant as an Example</h1>
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Using Ant as an Example</h1>
<p>
<a href="https://ant.apache.org/">Ant</a> will be used
here to illustrate how to create the <code>Options</code> required. The following
Expand Down Expand Up @@ -431,7 +434,7 @@ <h2>Displaying Usage and Help</h2>
</section>

<section>
<h1>Creating an ls Example</h1>
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Creating an ls Example</h1>
<p>
One of the most widely used command line applications in the *nix world
is <code>ls</code>. Due to the large number of options required for <code>ls</code>
Expand Down Expand Up @@ -494,7 +497,7 @@ <h1>Creating an ls Example</h1>
} </code></pre>
</section>
<section>
<h1>Converting (Parsing) Option Values</h1>
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Converting (Parsing) Option Values</h1>
<p>
By in most cases the values on the command line are retrieved as Strings via the
<code>commandLine.getOptionValue(key)</code> command. However, it is possible for
Expand Down Expand Up @@ -572,7 +575,7 @@ <h1>Converting (Parsing) Option Values</h1>
</p>
</section>
<section>
<h1>Deprecating Options</h1>
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Deprecating Options</h1>
<p>
Options may be marked as deprecated using ghe <code>Option.builder.deprecated()</code> method.
Additional information may be specified by passing a <code>DeprecatedAttributes</code> instance to the
Expand Down Expand Up @@ -726,7 +729,7 @@ <h2>Changing help format</h2>
</section>
</section>
<section id="Properties">
<h1>Defining Option Properties</h1>
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Defining Option Properties</h1>
<p>
The following are the properties that each
<a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these
Expand Down Expand Up @@ -819,4 +822,11 @@ <h1>Defining Option Properties</h1>
</tr>
</table>
</section>
<h1>
<img src="org/apache/commons/cli/doc-files/leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf">Requirements
</h1>
<ul>
<li>Java 8 or above.</li>
<li>If using OSGi, R7 or above.</li>
</ul>
</body>