This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/master by this push:
new 1669210c Use oak leaf logo
1669210c is described below
commit 1669210c367bf15140671985f25ee532b546a7b2
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Nov 5 07:50:34 2025 -0500
Use oak leaf logo
---
.../java/org/apache/commons/cli/doc-files/leaf.svg | 45 +++++++++++++++++++++
.../java/org/apache/commons/cli/doc-files/logo.png | Bin 0 -> 9233 bytes
src/main/javadoc/overview.html | 28 ++++++++-----
3 files changed, 64 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/doc-files/leaf.svg
b/src/main/java/org/apache/commons/cli/doc-files/leaf.svg
new file mode 100644
index 00000000..71de588c
--- /dev/null
+++ b/src/main/java/org/apache/commons/cli/doc-files/leaf.svg
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<svg id="Layer_1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 650 1000">
+ <defs>
+ <style>
+ .cls-1 {
+ fill: #7c297d;
+ }
+
+ .cls-2 {
+ fill: #f79a23;
+ }
+
+ .cls-3 {
+ fill: #dd552c;
+ }
+
+ .cls-4 {
+ fill: #d22128;
+ }
+ </style>
+ </defs>
+ <path class="cls-3"
d="M276.7092915,398.1515795c25.5279479-63.1242453,54.0110775-126.1246793,84.5729347-181.9636035-45.6212286-33.8852148-89.4276433-106.9534674-107.4259055-139.3268803-6.4642564,7.3439687-10.6608099,15.8022396-12.563595,22.6835448-16.9556402,61.2214602,43.4023987,135.1498759-5.21311,108.1394499-40.5058645-22.5076023-131.7157397-71.797557-166.5067324-22.8073561,38.9647388,50.0654049,140.8777805,176.0271745,207.1364082,213.2748452Z"/>
+ <path class="cls-2"
d="M361.2822261,216.187976c29.6137228-54.1055651,61.1725873-101.4927347,93.8913687-135.6320886,0,0-32.6340684,47.2372927-79.2457879,141.6662634,28.2289905,7.7740502,108.6249208,23.7261667,220.6090393-5.2000772,2.7531737-20.350678-10.9279818-42.734469-79.1056856-50.2283145-44.5101845-4.8872906,53.4246026-106.2822795-17.5225659-154.2363748-2.2905102-1.5509002-4.5419221-2.9193416-6.7477192-4.1444224-2.3784814-.8536468-4.8905488-1.6356133-7.5720422-2.3328667-82.8591248-
[...]
+ <path class="cls-4"
d="M210.0661969,580.0239535c18.7052902-56.0344158,41.2063761-118.989235,66.6430946-181.872374-66.2586277-37.2476707-168.1716694-163.2094403-207.1364082-213.2748452-6.9562436,9.787614-11.7099483,23.4394457-13.2934304,42.1088958-8.4973692,100.2806866,94.9567981,174.521889,74.3324318,188.0824913-27.2808561,17.9396147-81.5786546-43.0928703-102.978471-4.3138485,31.0180043,39.8477093,94.2008971,111.8472744,182.4327833,169.2696807Z"/>
+ <path class="cls-3"
d="M496.7155649,363.7515701c-52.3819806-18.6824828,54.7376547-68.786986,89.5221309-121.9411586,4.4506926-6.7965921,9.0512622-15.5806824,10.2991504-24.7883379-111.9841185,28.9262439-192.3800488,12.9741274-220.6090393,5.2000772-24.1301828,48.8924551-51.9942555,110.5048986-81.0540854,184.7917156,30.2653616,12.9415455,153.8421334,60.7457639,328.3900879,60.9933866,29.3465509-76.4372249-76.8347245-86.5311091-126.5482445-104.255683Z"/>
+ <path class="cls-4"
d="M230.3060964,590.1113213c30.7801562,9.5921223,132.7681363,38.244678,241.0835287,33.9308295,14.5510932-39.3980786-39.8509675-43.2427472-44.282111-74.84071-3.430878-24.4494858,143.1682907,20.5461697,190.3371613-68.3569045,2.3849978-4.4963073,4.2454264-8.7384756,5.819134-12.8372833-174.5479545-.2476227-298.1247263-48.0518411-328.3900879-60.9933866-21.2369067,54.2880239-43.0830957,115.2162467-64.5676252,183.0974549Z"/>
+ <path class="cls-1"
d="M230.3060964,590.1113213c-13.8310324,43.6923779-27.4763477,90.3692613-40.7209052,139.6983144-4.6983154,17.4899839-9.3412414,35.3057873-13.9190036,53.5125738,102.8057868,33.9373459,197.4726056.0781966,200.6819264-41.8873386.0260655-.3323358-.0358401-.5799585-.016291-.8992615,2.4469035-44.4482789-64.1733837-19.8098179-62.5964179-46.5335229,1.5834822-26.9191966,116.3077416-.1563933,151.7862131-57.872037,2.7205918-4.4246271,4.4930492-8.3540087,5.8680069-12.0878987-10
[...]
+ <path class="cls-1"
d="M27.6334136,410.7542728c-1.4987691,2.7173336-2.8509195,5.8582323-4.0043201,9.6116715-19.9238547,64.7533422,120.9604422,151.7405984,101.7924885,170.7032859-17.2782014,17.0859679-39.7955782-21.9602257-67.5619052-5.8321668-3.0431529,1.7724574-6.1319206,4.0075783-9.3021431,7.2592556-31.4024712,32.1714049-.4919873,124.8539837,88.6033203,174.3263973-20.7905342,69.8100589-41.489839,147.8047004-61.7525458,229.3703222,7.3504851-2.573973,16.1476081-5.1544625,18.3371143-12.
[...]
+</svg>
\ No newline at end of file
diff --git a/src/main/java/org/apache/commons/cli/doc-files/logo.png
b/src/main/java/org/apache/commons/cli/doc-files/logo.png
new file mode 100644
index 00000000..02a758f0
Binary files /dev/null and
b/src/main/java/org/apache/commons/cli/doc-files/logo.png differ
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
index 6e2df12f..794640d8 100644
--- a/src/main/javadoc/overview.html
+++ b/src/main/javadoc/overview.html
@@ -19,7 +19,12 @@ limitations under the License.
<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>
@@ -40,8 +45,6 @@ limitations under the License.
<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
@@ -117,7 +120,7 @@ limitations under the License.
</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.
@@ -240,7 +243,7 @@ else {
</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
@@ -431,7 +434,7 @@ formatter.printHelp("ant", options);</code></pre>
</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>
@@ -494,7 +497,7 @@ catch (ParseException exp) {
} </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
@@ -572,7 +575,7 @@ public static void main(String[] args) {
</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
@@ -726,7 +729,7 @@ public static void main(String[] args) {
</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
@@ -819,4 +822,11 @@ public static void main(String[] args) {
</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>
