aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 674413e5bbdeb3efb3312aa855057179c7e6918d (plain)
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
ivy-java README
-----------------

This is open source software distributed under the terms of the GNU
Lesser General Public License.  See the COPYING.LIB file for details.
Some included utilities are distributed under the terms of the GNU
General Public License, a copy of which is included in the file COPYING.

This page has been hugely inspired from the one Wes wrote for the gnu-regexp
package. As I am a newbie in package creation, I start from an existing one.

INSTALLING

Copy the ivy-java jar file (located in the 'lib' directory)
to your usual installation directory for Java archives.

To use ivy-java, you will need to include it in your classpath
setting.  Typically this is done by adding an entry to your CLASSPATH
variable setting with the full path to the JAR file, e.g.
  csh:  % setenv CLASSPATH ${CLASSPATH}:/usr/java/lib/ivy-java.jar
 bash:  % export CLASSPATH=${CLASSPATH}:/usr/java/lib/ivy-java.jar
  DOS:  > set CLASSPATH %CLASSPATH%;C:\Java\lib\ivy-java.jar
Various shells and operating systems may have slightly different methods.
Consult your Java virtual machine documentation for details.  You may also
specify the -classpath option to the java executable, e.g.
compile: % javac -classpath /usr/java/lib/ivy-java.jar MyClass.java
execute: % java -classpath /usr/java/lib/ivy-java.jar MyClass

DOCUMENTATION

HTML documentation will be provided in the 'doc' directory.  This is basically
a snapshot of the official ivy-java web site (see below for URL).  The
documentation files are:
 doc/ivy-java.1  -- man page
 doc/html/api/*.html -- javadoc generated info

UTILITIES

ivy-java comes with a simple utility program intended to test
and demonstrate its features. It is compiled into the Java archive
file. To run fr.dgac.ivy.Probe, you will need gnu.regexp and gnu.getopt,
which are available at http://www.urbanophile.com/~arenn/hacking/download.html, and put those class files in your classpath as well. 

There is also a couple of simple graphical utilities akin to Probe ( TestIvy
and TestIvySwing ). You can try them as well


HACKING

You are free to fold, spindle, mutilate and modify this library,
provided you follow the terms outlined in COPYING.LIB.  The ivy-java
project team gratefully accepts any bug fixes or enhancements you may
come up with (see the TODO file if you're in need of some ideas). A
few parameters at the top of the Makefile in the 'src' directory
need to be edited to match your local system setup.

BUG REPORTS

Send bug reports to <jestin@cena.fr>, or join the ivy mailing list
by sending a "subscribe" message to <ivy-request@tls.cena.fr>.  It helps
if you can send a code sample showing the messages you were
using and how you were using it.

LATEST VERSION

You can always obtain info about the latest version of ivy-java at
http://www.tls.cena.fr/products/ivy/download/desc/ivy-java.html

New versions are also announced on the ivy mailing list (see above).
From time to time, upstream source are put on
http://www.tls.cena.fr/~jestin/ivy-java.html.

Thanks!

Yannick Jestin <jestin@cena.fr>