|
19 | 19 | <title>Apache Commons CLI Overview</title> |
20 | 20 | </head> |
21 | 21 | <body> |
22 | | - <img src="../images/commons-logo.png" alt="Apache Commons CLI"> |
| 22 | + <a href="https://commons.apache.org/cli"> <img src="org/apache/commons/cli/doc-files/logo.png" alt="Apache Commons CLI"> |
| 23 | + </a> |
| 24 | + <section id="Introducing"> |
| 25 | + <h1> |
| 26 | + <img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Introducing Apache Commons CLI |
| 27 | + </h1> |
23 | 28 |
|
24 | 29 | <p>The Apacahe Commons CLI component parses command-line arguments for your application.</p> |
25 | 30 |
|
|
40 | 45 | <p> |
41 | 46 | The homepage for the project is <a href="https://commons.apache.org">Apache Commons</a> |
42 | 47 | </p> |
43 | | - <section id="Introducing"> |
44 | | - <h1>Introducing Apache Commons CLI</h1> |
45 | 48 | <p> |
46 | 49 | There are three stages to command line processing. They are the |
47 | 50 | definition, parsing and interrogation stages. The following |
@@ -117,7 +120,7 @@ <h2>Interrogating the CLI</h2> |
117 | 120 | </section> |
118 | 121 | </section> |
119 | 122 | <section id="Using"> |
120 | | - <h1>Using Apache Commons CLI</h1> |
| 123 | + <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> |
121 | 124 | <p> |
122 | 125 | The following sections describe some example scenarios on how to |
123 | 126 | use CLI in applications. |
@@ -240,7 +243,7 @@ <h2>Retrieving the argument value</h2> |
240 | 243 | </section> |
241 | 244 |
|
242 | 245 | <section> |
243 | | - <h1>Using Ant as an Example</h1> |
| 246 | + <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> |
244 | 247 | <p> |
245 | 248 | <a href="https://ant.apache.org/">Ant</a> will be used |
246 | 249 | here to illustrate how to create the <code>Options</code> required. The following |
@@ -431,7 +434,7 @@ <h2>Displaying Usage and Help</h2> |
431 | 434 | </section> |
432 | 435 |
|
433 | 436 | <section> |
434 | | - <h1>Creating an ls Example</h1> |
| 437 | + <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> |
435 | 438 | <p> |
436 | 439 | One of the most widely used command line applications in the *nix world |
437 | 440 | is <code>ls</code>. Due to the large number of options required for <code>ls</code> |
@@ -494,7 +497,7 @@ <h1>Creating an ls Example</h1> |
494 | 497 | } </code></pre> |
495 | 498 | </section> |
496 | 499 | <section> |
497 | | - <h1>Converting (Parsing) Option Values</h1> |
| 500 | + <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> |
498 | 501 | <p> |
499 | 502 | By in most cases the values on the command line are retrieved as Strings via the |
500 | 503 | <code>commandLine.getOptionValue(key)</code> command. However, it is possible for |
@@ -572,7 +575,7 @@ <h1>Converting (Parsing) Option Values</h1> |
572 | 575 | </p> |
573 | 576 | </section> |
574 | 577 | <section> |
575 | | - <h1>Deprecating Options</h1> |
| 578 | + <h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Deprecating Options</h1> |
576 | 579 | <p> |
577 | 580 | Options may be marked as deprecated using ghe <code>Option.builder.deprecated()</code> method. |
578 | 581 | Additional information may be specified by passing a <code>DeprecatedAttributes</code> instance to the |
@@ -726,7 +729,7 @@ <h2>Changing help format</h2> |
726 | 729 | </section> |
727 | 730 | </section> |
728 | 731 | <section id="Properties"> |
729 | | - <h1>Defining Option Properties</h1> |
| 732 | + <h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Defining Option Properties</h1> |
730 | 733 | <p> |
731 | 734 | The following are the properties that each |
732 | 735 | <a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these |
@@ -819,4 +822,11 @@ <h1>Defining Option Properties</h1> |
819 | 822 | </tr> |
820 | 823 | </table> |
821 | 824 | </section> |
| 825 | + <h1> |
| 826 | + <img src="org/apache/commons/cli/doc-files/leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf">Requirements |
| 827 | + </h1> |
| 828 | + <ul> |
| 829 | + <li>Java 8 or above.</li> |
| 830 | + <li>If using OSGi, R7 or above.</li> |
| 831 | + </ul> |
822 | 832 | </body> |
0 commit comments