blob: aa3717b7469852f7fd548a4e1da17d1e7815ef27 [file] [log] [blame]
<?xml version="1.0"?>
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
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
<author email="">commons-dev</author>
<section name="Commons CLI">
The Apache Commons CLI library provides an API for parsing command line options passed to programs.
It's also able to print help messages detailing the options available for a command line tool.
Commons CLI supports different types of options:
<li>POSIX like options (ie. <code>tar -zxvf foo.tar.gz</code>)</li>
<li>GNU like long options (ie. <code>du --human-readable --max-depth=1</code>)</li>
<li>Java like properties (ie. <code>java -Djava.awt.headless=true Foo</code>)</li>
<li>Short options with value attached (ie. <code>gcc -O2 foo.c</code>)</li>
<li>long options with single hyphen (ie. <code>ant -projecthelp</code>)</li>
A typical help message displayed by Commons CLI looks like this:
usage: ls
-A,--almost-all do not list implied . and ..
-a,--all do not hide entries starting with .
-B,--ignore-backups do not list implied entried ending with ~
-b,--escape print octal escapes for nongraphic characters
--block-size &lt;SIZE> use SIZE-byte blocks
-c with -lt: sort by, and show, ctime (time of last
modification of file status information) with
-l:show ctime and sort by name otherwise: sort
by ctime
-C list entries by columns
Check out the <a href="introduction.html">introduction</a> page for a detailed presentation.
<section name="CLI 2?">
<p>Commons CLI 1.0 was formed from the merger of ideas and code from three different libraries -
Werken, Avalon and Optz. In dealing with the bugs and the feature requests a freshly designed and not
backwards compatible CLI 2 was created in 2004, but never finished or released. </p>
<p>The current plan is to continue to maintain the 1.x line. The CLI2 work may be found in the Commons Sandbox. </p>
<section name="Documentation">
A full <a href="introduction.html">User's Guide</a> is available
as are various <a href="project-reports.html">project reports</a>.
The Javadoc API documents are available online:
<li><a href="javadocs/api-release/index.html">CLI 1.3.1 (current release)</a></li>
<li><a href="javadocs/api-1.3/index.html">CLI 1.3</a></li>
<li><a href="javadocs/api-1.2/index.html">CLI 1.2</a></li>
<li><a href="javadocs/api-1.1/index.html">CLI 1.1</a></li>
<li><a href="javadocs/api-1.0/index.html">CLI 1.0</a></li>
The <a href="source-repository.html">Subversion repository</a> can be
<a href="">browsed</a>.
<section name="Releases">
The latest version is v1.3.1 -
<a href="">Download now!</a>
The <a href="release_1_3_1.html">release notes</a> are also available.
For previous releases, see the <a href="">Apache Archive</a>.
<section name="Support">
<p>The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum. The user list
is suitable for most library usage queries. The dev list is intended for the development discussion. Please
remember that the lists are shared between all commons components, so prefix your email subject by
<p>Issues may be reported via the <a href="issue-tracking.html">ASF JIRA</a>.</p>