Project

General

Profile

Download (2.57 KB) Statistics
| Branch: | Revision:

git_sitools_idoc / flarecast / workspace / sitools-update-classpath / out / classes / gnu / getopt / README @ master

1
This is a Java port of the GNU getopt functions based on the versions 
2
contained in glibc 2.0.6.  I have attempted to keep the functionality 
3
and programmer's interface as faithful to the original as possible.
4
However, due to differences between Java and C, some minor changes
5
has to me made.  (Given the obtuse interface in the clib version, 
6
perhaps some major changes should have been made).  This should not 
7
affect the way options appear to be parsed to the end user of program 
8
that uses this Java getopt.  The use of these classes are completely 
9
documented in the javadoc comments, so I will not repeat that info here. 
10

    
11
Note that since these objects are part of a package called "gnu.getopt", 
12
they need to be in a subdirectory called gnu/getopt somewhere in your 
13
CLASSPATH.  This includes the "MessagesBundle" files.
14

    
15
I am not aware of any bugs.  If you find one though, please send email 
16
to me at arenn@urbanophile.com.  The more detailed a bug report the better. 
17
Bug fixes are also welcome at the same address.  Please reference
18
release number "1.0.13".  If you use this code, it would be helpful
19
if you let me know so that I can let you know if anything changes or
20
if any major bugs have been found/fixed.
21

    
22
I have included a Makefile for compiling the code. If you do not have
23
access to make, then you can simply do a "javac *.java" at the OS 
24
command line (or follow your vendor's instructions for compiling a
25
Java class).  To build the documentation, do a "make docs" 
26
or "javadoc -public *.java".  Note that the images needed by the html
27
generated by javadoc are not included.  You will need to get those
28
from some other Java documentation package.
29

    
30
Note that the Makefile is not compliant with the GNU makefile
31
standards as I anticipate that at some point a master makefile will
32
be created for various GNU Java packages.  And it is serious overkill
33
to create a megabloat makefile (kinda like this megabloat README) for 
34
such a simple package.
35

    
36
There is sample code showing how to use getopt available in the
37
GetoptDemo.java file.
38

    
39
NEW: A support file for the "ant" build process was contributed.  Here are
40
some brief things you can do with it.  Note that I have not ever used this
41
so it is doubly AS IS.
42

    
43
Get ant from jakarta project (see jakarta.apache.org/ant), and run it with
44
one of these target (all is default target):
45
ant prepare: create the needed directories
46
ant classes: compile the java classes
47
ant jar: create the jar archive
48
ant javadoc: create the javadoc
49
ant all: create jar and javadoc
50
ant clean: clean everything
51

    
52
Happy hacking,
53

    
54
Aaron.
55
arenn@urbanophile.com
56
http://www.urbanophile.com/arenn/
57