You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by ha...@apache.org on 2002/08/11 00:38:39 UTC
cvs commit: jakarta-avalon-site/docs/excalibur/cli index.html
hammant 2002/08/10 15:38:39
Modified: docs/excalibur/cli/api allclasses-frame.html
deprecated-list.html help-doc.html index-all.html
index.html overview-tree.html packages.html
serialized-form.html
docs/excalibur/cli/api/org/apache/avalon/excalibur/cli
AbstractParserControl.html CLArgsParser.html
CLOption.html CLOptionDescriptor.html CLUtil.html
ParserControl.html package-frame.html
package-summary.html package-tree.html
docs/excalibur/cli index.html
Log:
general updates
Revision Changes Path
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/allclasses-frame.html
Index: allclasses-frame.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/allclasses-frame.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- allclasses-frame.html 7 Apr 2002 10:25:43 -0000 1.1
+++ allclasses-frame.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
All Classes
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/deprecated-list.html
Index: deprecated-list.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/deprecated-list.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- deprecated-list.html 7 Apr 2002 10:25:43 -0000 1.1
+++ deprecated-list.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Deprecated List
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/help-doc.html
Index: help-doc.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/help-doc.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- help-doc.html 7 Apr 2002 10:25:43 -0000 1.1
+++ help-doc.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: API Help
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/index-all.html
Index: index-all.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/index-all.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index-all.html 7 Apr 2002 10:25:43 -0000 1.1
+++ index-all.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Index
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/index.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.html 7 Apr 2002 10:25:43 -0000 1.1
+++ index.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002-->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002-->
<TITLE>
Excalibur CLI API
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/overview-tree.html
Index: overview-tree.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/overview-tree.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- overview-tree.html 7 Apr 2002 10:25:43 -0000 1.1
+++ overview-tree.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Class Hierarchy
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/packages.html
Index: packages.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/packages.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- packages.html 7 Apr 2002 10:25:43 -0000 1.1
+++ packages.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/serialized-form.html
Index: serialized-form.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/serialized-form.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- serialized-form.html 7 Apr 2002 10:25:43 -0000 1.1
+++ serialized-form.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Serialized Form
</TITLE>
1.3 +3 -3 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/AbstractParserControl.html
Index: AbstractParserControl.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/AbstractParserControl.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractParserControl.html 6 Aug 2002 11:20:54 -0000 1.2
+++ AbstractParserControl.html 10 Aug 2002 22:38:38 -0000 1.3
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Class AbstractParserControl
</TITLE>
@@ -75,7 +75,7 @@
<DL>
<DT><B>Since: </B><DD>4.0</DD>
<DT><B>Version: </B><DD>$Revision$ $Date$</DD>
-<DT><B>Author: </B><DD><a href="mailto:peter @ apache.org">Peter Donald</a></DD>
+<DT><B>Author: </B><DD><a href="mailto:peter at apache.org">Peter Donald</a></DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/avalon/excalibur/cli/ParserControl.html"><CODE>ParserControl</CODE></A></DL>
<HR>
1.3 +3 -3 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLArgsParser.html
Index: CLArgsParser.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLArgsParser.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CLArgsParser.html 6 Aug 2002 11:20:54 -0000 1.2
+++ CLArgsParser.html 10 Aug 2002 22:38:38 -0000 1.3
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Class CLArgsParser
</TITLE>
@@ -76,7 +76,7 @@
<DL>
<DT><B>Since: </B><DD>4.0</DD>
<DT><B>Version: </B><DD>$Revision$ $Date$</DD>
-<DT><B>Author: </B><DD><a href="mailto:peter @ apache.org">Peter Donald</a></DD>
+<DT><B>Author: </B><DD><a href="mailto:peter at apache.org">Peter Donald</a></DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/avalon/excalibur/cli/ParserControl.html"><CODE>ParserControl</CODE></A>,
<A HREF="../../../../../org/apache/avalon/excalibur/cli/CLOption.html"><CODE>CLOption</CODE></A>,
<A HREF="../../../../../org/apache/avalon/excalibur/cli/CLOptionDescriptor.html"><CODE>CLOptionDescriptor</CODE></A></DL>
1.3 +3 -3 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLOption.html
Index: CLOption.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLOption.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CLOption.html 6 Aug 2002 11:20:54 -0000 1.2
+++ CLOption.html 10 Aug 2002 22:38:38 -0000 1.3
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Class CLOption
</TITLE>
@@ -71,7 +71,7 @@
<DL>
<DT><B>Since: </B><DD>4.0</DD>
<DT><B>Version: </B><DD>$Revision$ $Date$</DD>
-<DT><B>Author: </B><DD><a href="mailto:peter @ apache.org">Peter Donald</a></DD>
+<DT><B>Author: </B><DD><a href="mailto:peter at apache.org">Peter Donald</a></DD>
</DL>
<HR>
1.3 +3 -3 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLOptionDescriptor.html
Index: CLOptionDescriptor.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLOptionDescriptor.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CLOptionDescriptor.html 6 Aug 2002 11:20:54 -0000 1.2
+++ CLOptionDescriptor.html 10 Aug 2002 22:38:38 -0000 1.3
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Class CLOptionDescriptor
</TITLE>
@@ -73,7 +73,7 @@
<DL>
<DT><B>Since: </B><DD>4.0</DD>
<DT><B>Version: </B><DD>$Revision$ $Date$</DD>
-<DT><B>Author: </B><DD><a href="mailto:peter @ apache.org">Peter Donald</a></DD>
+<DT><B>Author: </B><DD><a href="mailto:peter at apache.org">Peter Donald</a></DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/avalon/excalibur/cli/CLArgsParser.html"><CODE>CLArgsParser</CODE></A>,
<A HREF="../../../../../org/apache/avalon/excalibur/cli/CLUtil.html"><CODE>CLUtil</CODE></A></DL>
<HR>
1.3 +3 -3 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLUtil.html
Index: CLUtil.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/CLUtil.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CLUtil.html 6 Aug 2002 11:20:54 -0000 1.2
+++ CLUtil.html 10 Aug 2002 22:38:38 -0000 1.3
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Class CLUtil
</TITLE>
@@ -71,7 +71,7 @@
<DL>
<DT><B>Since: </B><DD>4.0</DD>
<DT><B>Version: </B><DD>$Revision$ $Date$</DD>
-<DT><B>Author: </B><DD><a href="mailto:peter @ apache.org">Peter Donald</a></DD>
+<DT><B>Author: </B><DD><a href="mailto:peter at apache.org">Peter Donald</a></DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/avalon/excalibur/cli/CLOptionDescriptor.html"><CODE>CLOptionDescriptor</CODE></A></DL>
<HR>
1.3 +3 -3 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/ParserControl.html
Index: ParserControl.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/ParserControl.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ParserControl.html 6 Aug 2002 11:20:54 -0000 1.2
+++ ParserControl.html 10 Aug 2002 22:38:38 -0000 1.3
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Interface ParserControl
</TITLE>
@@ -69,7 +69,7 @@
<DL>
<DT><B>Since: </B><DD>4.0</DD>
<DT><B>Version: </B><DD>$Revision$ $Date$</DD>
-<DT><B>Author: </B><DD><a href="mailto:peter @ apache.org">Peter Donald</a></DD>
+<DT><B>Author: </B><DD><a href="mailto:peter at apache.org">Peter Donald</a></DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/avalon/excalibur/cli/AbstractParserControl.html"><CODE>AbstractParserControl</CODE></A></DL>
<HR>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/package-frame.html
Index: package-frame.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/package-frame.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package-frame.html 7 Apr 2002 10:25:44 -0000 1.1
+++ package-frame.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Package org.apache.avalon.excalibur.cli
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/package-summary.html
Index: package-summary.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/package-summary.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package-summary.html 7 Apr 2002 10:25:44 -0000 1.1
+++ package-summary.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: Package org.apache.avalon.excalibur.cli
</TITLE>
1.2 +1 -1 jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/package-tree.html
Index: package-tree.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/api/org/apache/avalon/excalibur/cli/package-tree.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package-tree.html 7 Apr 2002 10:25:44 -0000 1.1
+++ package-tree.html 10 Aug 2002 22:38:38 -0000 1.2
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sun Apr 07 10:50:47 BST 2002 -->
+<!-- Generated by javadoc on Sat Aug 10 23:20:21 BST 2002 -->
<TITLE>
Excalibur CLI API: org.apache.avalon.excalibur.cli Class Hierarchy
</TITLE>
1.7 +169 -74 jakarta-avalon-site/docs/excalibur/cli/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-site/docs/excalibur/cli/index.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- index.html 22 Jul 2002 20:09:30 -0000 1.6
+++ index.html 10 Aug 2002 22:38:39 -0000 1.7
@@ -1,74 +1,169 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><link rel="stylesheet" href="skin/tigris.css" type="text/css"><link rel="stylesheet" href="skin/site.css" type="text/css"><link media="print" rel="stylesheet" href="skin/print.css" type="text/css"><meta value="Avalon Documentation Team" name="author"><meta value="avalon-dev@jakarta.apache.org" name="email"><title>NO TITLE</title></head><body class="composite" marginheight="0" marginwidth="0"><div id="banner"><table width="100%" cellpadding="8" cellspacing="0" border="0"><tbody><tr><td align="left"><a href="http://jakarta.apache.org/"><img border="0" src="images/jakarta-logo.gif"></a></td><td align="right"><a href="http://jakarta.apache.org/avalon/"><img border="0" src="images/header.gif"></a></td></tr></tbody></table></div><div id="breadcrumbs"><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></div><table id="main" width="100%" cellpadding="8" cellspacing="0" border="0"><tbody><tr valign="top"><td id="leftcol"><div id="navcolumn"><div><strong>About</strong><div><a href="index.html">Overview</a></div><div><a href="http://jakarta.apache.org/avalon/excalibur/index.html">Excalibur Home</a></div><div><a href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release/cli">Download</a></div><div><a href="api/">API Docs</a></div></div></div></td><td><div id="bodycol"><div class="app"><div align="center"><h1>NO TITLE</h1><h2></h2></div><div class="h3">
-
- Excalibur Command-line Utilities - Overview
- Peter Donald
-
-
- <div class="h3"><h3></h3></div>
- <p>
- This component allows you to parse Command Line Options
- during application start-up. It is designed to parse the
- command line options in the same manner as the C getopt()
- function in glibc (the GNU C runtime library). It attempts
- to do this in a simpler, more Java-centric manner than the
- original product.
- </p>
- <p>
- There are a number of examples in the examples/ directory
- of this release. These examples allow you to get started
- fast and easy. See the examples/README.txt file for
- further details.
- </p>
-
- <div class="h3"><h3></h3></div>
- <p>
- The command line is parsed according to the following rules. There are
- two forms of options in this package, the Long form and the Short form.
- The long form of an option is preceded by the '--' characters while the
- short form is preceded by a single '-'. Some example options would be;
- "--an-option", "-a", "--day", "-s -f -a".
- </p>
- <p>
- In the tradition of UNIX programs, the short form of an option can occur
- immediately after another short form option. So if 'a', 'b' and 'c' are
- short forms of options that take no parameters then the following
- command lines are equivalent: "-abc", "-a -bc", "-a -b -c", "-ab -c", etc.
- </p>
- <p>
- Options can also accept arguments if specified. You can specify that an
- option requires an argument in which the text immediately following the
- option will be considered to be an argument to the option. So if 'a' was an
- option that required an argument then the following would be equivalent;
- "-abc", "-a bc" (namely the option 'a' with argument 'bc').
- </p>
- <p>
- Options can also specify optional arguments. In this case if there is any
- text immediately following the option character then it is considered an
- argument. Otherwise, the option has no arguments. For example if 'a' was an
- option that required an optional argument then "-abc" is an option 'a' with
- argument "bc" while "-a bc" is an option 'a' with no argument, followed by
- the text "bc". </p>
- <p>It is also possible to place an '=' sign between the option
- and it's argument. So if we assume that a is an option that
- requires an argument then the following are all equivalent;
- "-a=bc", "-a bc" "-abc".
- </p>
- <p>
- In some cases it is also necessary to disable command line parsing so that you
- can pass a text argument to the program that starts with a '-' character. To do
- this insert the sequence '--' onto the command line with no text immediately
- following it. This will disable processing for the rest of the command line.
- The '--' characters will not be passed to the user program. For instance the
- line "-- -b" would result in the program being passed the
- text "-b" (ie. not as an option).
- </p>
-
-
-
-</div></div></div></td></tr></tbody></table><div id="footer"><table width="100%" cellpadding="4" cellspacing="0" border="0"><tbody><tr><td align="left">Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.</td><td></td><td align="right"><script language="JavaScript">
- <!--
- document.write("last modified: " + document.lastModified);
- // -->
-
- </script></td></tr></tbody></table></div></body></html>
\ No newline at end of file
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<!-- This is a generated file. Do not edit. -->
+ <html>
+ <head>
+ <style type="text/css">
+ @import url("./css/tigris.css");
+ @import url("./css/site.css");
+ </style>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="Peter Donald">
+ <meta name="email" value="peter at apache.org">
+
+ <title>Excalibur CLI - Excalibur Command-line Utilities - Overview</title>
+ </head>
+
+ <body marginwidth="0" marginheight="0" class="composite">
+
+ <div id="banner">
+ <table border="0" cellspacing="0" cellpadding="8" width="100%">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td> <td colspan="2">
+ <a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif" align="left" border="0"/></a>
+ </td>
+ </td>
+ <td><div align="right" valign="bottom"><b><font size="+3">Excalibur CLI</font></b></div></td>
+ </tr>
+ </table>
+ </div>
+
+ <table border="0" cellspacing="0" cellpadding="8" width="100%" id="main">
+ <tr valign="top">
+ <!-- LEFT SIDE NAVIGATION -->
+ <td id="leftcol" width="20%">
+ <div id="navcolumn">
+ <div>
+ <strong>About</strong>
+ <div><small> <a href="index.html">Overview</a>
+ </small></div>
+ <div><small> <a href="http://jakarta.apache.org/avalon/excalibur/index.html">Excalibur Home</a>
+ </small></div>
+ <div><small> <a href="http://jakarta.apache.org/builds/jakarta-avalon-excalibur/release/cli">Download</a>
+ </small></div>
+ <div><small> <a href="api/">API Docs</a>
+ </small></div>
+ </div>
+ </div>
+ </td>
+ <td><div id="bodycol"><div class="app">
+
+ <div class="h3">
+ <h3><a name="Introduction">Introduction</a></h3>
+ <p
+ >
+ This component allows you to parse Command Line Options
+ during application start-up. It is designed to parse the
+ command line options in the same manner as the C getopt()
+ function in glibc (the GNU C runtime library). It attempts
+ to do this in a simpler, more Java-centric manner than the
+ original product.
+
+ </p>
+ <p
+ >
+ There are a number of examples in the examples/ directory
+ of this release. These examples allow you to get started
+ fast and easy. See the examples/README.txt file for
+ further details.
+
+ </p>
+ </div>
+ <div class="h3">
+ <h3><a name="Parsing Rules">Parsing Rules</a></h3>
+ <p
+ >
+ The command line is parsed according to the following rules. There are
+ two forms of options in this package, the Long form and the Short form.
+ The long form of an option is preceded by the '--' characters while the
+ short form is preceded by a single '-'. Some example options would be;
+ "--an-option", "-a", "--day", "-s -f -a".
+
+ </p>
+ <p
+ >
+ In the tradition of UNIX programs, the short form of an option can occur
+ immediately after another short form option. So if 'a', 'b' and 'c' are
+ short forms of options that take no parameters then the following
+ command lines are equivalent: "-abc", "-a -bc", "-a -b -c", "-ab -c", etc.
+
+ </p>
+ <p
+ >
+ Options can also accept arguments if specified. You can specify that an
+ option requires an argument in which the text immediately following the
+ option will be considered to be an argument to the option. So if 'a' was an
+ option that required an argument then the following would be equivalent;
+ "-abc", "-a bc" (namely the option 'a' with argument 'bc').
+
+ </p>
+ <p
+ >
+ Options can also specify optional arguments. In this case if there is any
+ text immediately following the option character then it is considered an
+ argument. Otherwise, the option has no arguments. For example if 'a' was an
+ option that required an optional argument then "-abc" is an option 'a' with
+ argument "bc" while "-a bc" is an option 'a' with no argument, followed by
+ the text "bc".
+ </p>
+ <p
+ > It is also possible to place an '=' sign between the option
+ and it's argument. So if we assume that a is an option that
+ requires an argument then the following are all equivalent;
+ "-a=bc", "-a bc" "-abc".
+
+ </p>
+ <p
+ >
+ In some cases it is also necessary to disable command line parsing so that you
+ can pass a text argument to the program that starts with a '-' character. To do
+ this insert the sequence '--' onto the command line with no text immediately
+ following it. This will disable processing for the rest of the command line.
+ The '--' characters will not be passed to the user program. For instance the
+ line "-- -b" would result in the program being passed the
+ text "-b" (ie. not as an option).
+
+ </p>
+ </div>
+ </div>
+ <div align="right" id="authors">
+ by <a href="mailto:peter at apache.org">Peter Donald</a>
+ </div>
+ </div></td>
+ </tr>
+ </table>
+
+ <!-- FOOTER -->
+ <div id="footer">
+ <table border="0" cellspacing="0" cellpadding="4">
+ <tr>
+ <td>Copyright © 1999-2002, Apache Software Foundation</td>
+ </tr>
+ </table>
+ </div>
+
+ </body>
+ </html>
+
+
+
+
+
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>