Revision: 208
http://svn.sourceforge.net/japi/?rev=208&view=rev
Author: christianhujer
Date: 2006-11-25 06:20:20 -0800 (Sat, 25 Nov 2006)
Log Message:
-----------
Improved package description.
Modified Paths:
--------------
libs/argparser/trunk/src/net/sf/japi/io/args/package.html
Modified: libs/argparser/trunk/src/net/sf/japi/io/args/package.html
===================================================================
--- libs/argparser/trunk/src/net/sf/japi/io/args/package.html 2006-11-25 14:19:43 UTC (rev 207)
+++ libs/argparser/trunk/src/net/sf/japi/io/args/package.html 2006-11-25 14:20:20 UTC (rev 208)
@@ -27,7 +27,28 @@
</head>
<body>
<p>
- Parsing command line arguments.
+ ArgParser is a library for parsing command line arguments.
</p>
+ <p>
+ It supports short options (e.g. <samp>-h</samp>) and long options (e.g. <samp>--help</samp>).
+ </p>
+ <p>
+ If an option takes a parameter, the argument value may follow the option as separate argument.
+ If the option is a long option, the value may alternatively be included in the argument string using the <code>'='</code>-character.
+ For instance, if an option has short name <samp>i</samp> and long name <samp>in</samp> and the option takes a String argument, the following variants are possible:
+ <samp>-i foo</samp>, <samp>--in foo</samp> and <samp>--in=foo</samp>.
+ </p>
+ <p>
+ Short options may be given in the same String.
+ For instance, if there are the short options <samp>v</samp>, <samp>i</samp> and <samp>s</samp>, all of them may be given together in a single String.
+ That means the following variants are possible:
+ <samp>-vis</samp>, <samp>-v -i -s</samp> and any combination of separated and concatenated versions like <samp>-v -is</samp>.
+ If short options take argument values and they are concatenated, the argument values are separate strings following the concatenated option in exactly the order of the concatenated options.
+ In <samp>-io foo bar</samp>, given that both, <samp>i</samp> and <samp>o</samp> take an argument value, <samp>foo</samp> is value for <samp>i</samp>, while <samp>bar</samp> is value for <samp>o</samp>.
+ </p>
+ <p>
+ The special option <code>--</code> will stop argument parsing.
+ All strings that follow the <code>--</code>-option are treated as command arguments, not options, even if they start with <code>-</code>.
+ </p>
</body>
</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
