IDLflex version 1.0.0                                       2001-06-15
----------------------------------------------------------------------
A flexible and generic code generator for CORBA IDL

Copyright (C) 2000-2001
		Hans Reiser, AspectIX Research Team
		University of Erlangen-Nuernberg, Germany

IDLflex is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License (GPL)
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
See the file LICENSE.txt for details.

This distribution contains the Xerces XML parsing software developed
by the Apache Software Foundation (http://xml.apache.org/). Please note
that the Xerces software comes with the Apache Software License and
*not* with GPL. The full text of this license can be found in the file
lib/xerces-LICENSE.txt. This license applies to file lib/xerces.jar. 

This distribution contains parts of the JavaORB CORBA implementation
developed by the Distributed Object Group (http://dog.intalio.com/).
Please note that JavaORB comes with its own license and *not* with GPL.
The full text of this license can be found in the file
lib/JavaORB-LICENSE.txt. This license applies to file lib/JavaORB.jar.
----------------------------------------------------------------------

Operate IDLflex:
================

    You need Java 2 or newer. There is no need to compile IDLflex as
    the distribution contains a fully operational binary version.

    Edit the first two lines of bin/idlflex or bin/idlflex.bat to
    reflect the current location of either the root directory of the
    distribution and a Java 2 interpreter.

    idlflex [-vV] [-I<scopedname>] [-X<scopedname>] [-D<name>]
	    [-m<Mapping>] [filename]

    filename
	If a filename is given, an empty JavaORB interface repository
	will be created, the specified file will be fed into it and
	then processed.

	If no filename is given, idlflex tries to connect to a running
	interface repository. This code makes no difference between ORB
	implementations. JavaORB will use the ORB.ref file to locate
	the Interface Repository automatically.

    -I<scopedname>
	Includes <scopedname> in the processing. The name must be an
	absolute scoped name of the form
	"::Module1::Module2::Interface", and matches all names starting
	with this substring. Only the IR elements with matching entries
	will be processed. There may be more than one -I entry. If
	there is no -I entry, all entries will be matched.
	Note: JavaORB 2.3.3 returns relative paths (without the
	starting "::") when the absolute_name() method is called...

    -X<scopedname>
	Excludes <scopedname> from the processing. The exclude check is
	made after any include checks. Thus -X has a higher priority
	than the -I option.

    -D<name>
	Defines <name> as an attribute. This might be used in the XML
	mapping specification to produce conditional compiling, using
	a <IF ATTR="DEF:<name>">  tag

	JavaMapping.xml is using these attributes:
	  -DPOA: create POA (IfPOA) instead of BOA (_IfImplBase)
	  -DTIE: create Tie classes (IfPOATie resp. IFTie)

    -m<Mapping>
	Specifies the mapping to use.  <Mapping> may be an absolute or
	relative path name. If it is a relative path, idlflex tries to
	evalute <Mapping> as a filename relative to the current working
	directory, to the IDLFlex root directory and to the IDLFlex
	Mapping directory (in this order)

	If no mapping is specified, the default value "JavaMapping.xml"
	is used.

    -v
	Verbose flag

    -V
	Print version string.


Compile IDLflex:
================

    Starting with version 1.2.0 of IDLflex, ant is used as build tool.
    If you really want to build IDLflex with a traditional Makefile,
    please download version 1.1.0 and adapt the Makefile yourself.

    The following build options are available:

    ant -f build-idlflex.xml
	Compiles all IDLflex classes and organizes them into Jar files.


    ant -f build-idlflex.xml clean
	Removes all class files and other unnecessary files.


Documentation:
==============

    An overview gives the file doc/TR-I4-01-06.ps. Other files are 
    in German and may not be generally usefull.


Status:
=======

    The developement of IDLflex is not yet complete. So, the version
    number 1.0.0 is a bit euphemistic (a beta version number may be
    more appropriate). However, this distribution can already be
    used for testing and experimenting with IDLflex.


Bug Reports:
============

    Send bug reports and comments to idlflex@aspectix.org

----------------------------------------------------------------------
End of README.txt
