File: README.md

package info (click to toggle)
args4j 2.0.30-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 860 kB
  • ctags: 1,162
  • sloc: java: 4,971; xml: 462; sh: 15; makefile: 7
file content (38 lines) | stat: -rw-r--r-- 1,715 bytes parent folder | download
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
args4j
======
args4j is a small Java class library that makes it easy to parse command line options/arguments in your CUI
application. See more info at [http://args4j.kohsuke.org/]

Why should I use it?
--------------------

See [the quick intro](http://weblogs.java.net/blog/kohsuke/archive/2005/05/parsing_command.html)

- It makes command line parsing very easy by using annotations
- Generate usage text very easily
- Generate HTML/XML documentation listing all options
- Full localization support
- Designed to parse javac like options, as opposed to GNU-style (where ls -lR is considered to have two options l and
  R).
- Licensed under [the MIT license](http://www.opensource.org/licenses/mit-license.php).

How can I use it?
-----------------

1. Check [the sample](https://github.com/kohsuke/args4j/blob/master/args4j/examples/SampleMain.java). This is how your
   code will look like.
2. [Download](http://maven.glassfish.org/content/groups/public/args4j/) the distribution or include the library from
   sthe Maven Repository at java.net.
3. Write your code.

More Resources
--------------

1. [A small tutorial](http://args4j.kohsuke.org/sample.html) for the use of the Starter and Args4J
2. [javadoc](http://args4j.kohsuke.org/args4j/apidocs/)
3. [How to generate a documentation for your CLI](http://args4j.kohsuke.org/apt.html)
4. [Extend args4j to handle other Java types](http://args4j.kohsuke.org/implementOptionhandler.html)
5. [Kohsuke's Blog: Parsing command line options in JDK 5.0 style]
   (http://weblogs.java.net/blog/kohsuke/archive/2005/05/parsing_command.html)
6. [A comparison between Commons CLI and Args4j](http://hikage.developpez.com/java/articles/api/cli-vs-args4j/) in
   French