diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 106 |
1 files changed, 59 insertions, 47 deletions
@@ -1,75 +1,87 @@ -ivy-java README ------------------ + + 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. +Last modificiation, lun jan 6 16:25:35 CET 2003 , Yannick +----------------------------------------------------------------------------- -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. + Ivy java is open source software distributed under the terms of the GNU + Lesser General Public License (LGPL). 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 started from an existing one. INSTALLING -Copy the ivy-java jar file (located in the 'lib' directory) -to your usual installation directory for Java archives. + Copy the ivy-java jar file (located in the 'lib' directory) + to your usual installation directory for Java archives. If it is located in + your main java class repository, it is possible that will just work as is, + however, you might want to put it elsewhere and fiddle with the CLASSPATH + environment variable. -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. + 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 + 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 + 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 + ivy-java should come with + - one man page: doc/ivy-java.1, + - the javadoc api html documentation tree: doc/api/ + - a programmer's guide both in html: doc/programmersguide/ + and in pdf format: doc/programmersguide.pdf + + If any of those file is missing, see the tar.gz archive on the Ivy java + web page ( http://www.tls.cena.fr/products/ivy/ivy-java.html ) 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. + 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 + Running java fr.dgac.ivy.Probe successfully is the key to knowing whether + your ivy-java installation is OK. + Ivy also comes with a simple TCP relay, allowing any script application to + send text messages onto an Ivy bus. To run the relay, launch + $ java fr.dgac.ivy.IvyDaemon + Then any line sent to the local port 3456 will be forwarded as an ivy + message. It can be used in shell scripts in conjunction with netcat + $ echo "hello world" | nc -q 0 localhost 3456 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. + 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. + 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. + 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 Thanks! -Yannick Jestin <jestin@cena.fr> +-- + Yannick Jestin <jestin@cena.fr> |