commons-cli/xdocs/index.xml at 6b7691b583f10c92258d2ca1960896af187bbcd9 · apache/commons-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?xml version="1.0"?>
<!--
 Copyright 2002,2004 The Apache Software Foundation

 Licensed 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

     http://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.
-->
<document>

 <properties>
    <title>Introduction</title>
    <author email="commons-dev@jakarta.apache.org">commons-dev</author>
 </properties>

  <body>
    <section name="Jakarta Commons CLI">
      <p>
        The Jakarta Commons CLI library provides an API for processing command
        line interfaces.
      </p>
      <p>
        CLI1 was formed by the merger of ideas and code from three different
        libraries and allows most simple interfaces to be modelled.  CLI1
        became increasingly difficult to maintain and develop further and so
        CLI2 has been developed with the goals of clearer responsibilities and
        being more flexible.  The intention is that CLI2 should be able to
        model a far greater selection of interfaces and do so more completely,
        validating as much as possible.
      </p>
      <p>
        The redesigned CLI2 is rooted in the <code>org.apache.commons.cli2</code>
        package and the distribution retains the <code>org.apache.commons.cli</code>
        package so that the upgrade doesn't break old code.  The CLI1 package
        should be regarded as deprecated to encourage the transition to the
        more flexible CLI2 framework but minor bug fixes and patches may be
        accepted to ensure that CLI1 based applications continue to function as
        expected.
      </p>
      <p>
        The rest of the documentation is split into the following three sections:
        <ul>
          <li><a href="manual/index.html">CLI2</a> - a reference manual for version 2</li>
          <li><a href="introduction.html">CLI1</a> - documentation for version 1 </li>
          <li><a href="examples/index.html">Examples</a> - a selection of worked examples demonstrating CLI2 features</li>
        </ul>
      </p>
      <p>
        The latest version of this documentation is available on the web:
        <ul>
          <li><a href="http://jakarta.apache.org/commons/cli/">http://jakarta.apache.org/commons/cli/</a></li>
          <li>
            <a href="http://jakarta.apache.org/commons/cli/commons-cli.pdf">http://jakarta.apache.org/commons/cli/commons-cli.pdf</a>
            <a href="http://jakarta.apache.org/commons/cli/commons-cli.pdf"><img border="0" src="images/pdf.gif"/></a>
          </li>
        </ul>
      </p>
    </section>
    <section name="Dependancies">
      <p>
        The generated list of <a href="dependencies.html">dependencies</a>
        lists the libraries needed to compile and test Commons CLI.  To use
        the precompiled distribution none of these dependancies are strictly
        necessary.  The following is a breakdown of what is required and when:
      </p>
      <table>
        <tr>
          <th>Library</th><th>Usage</th>
        </tr>
        <tr>
          <td>Java 1.2</td>
          <td>This is the minimum java level needed to use CLI2</td>
        </tr>
        <tr>
          <td>Java 1.4</td>
          <td>Needed if the PreferencesCommandLine is needed</td>
        </tr>
        <tr>
          <td>commons-lang</td>
          <td>Needed if the CLI1 package is being used</td>
        </tr>
        <tr>
          <td>jdepend</td>
          <td>Needed to build and test CLI2 only</td>
        </tr>
        <tr>
          <td>junit</td>
          <td>Needed to build and test CLI1 and CLI2</td>
        </tr>
      </table>
    </section>

  </body>

</document>