svn commit: r439319 - /webservices/muse/trunk/modules/muse-tools/scripts/readme.txt

[ae...@apache.org]

Author: aeberbac
Date: Fri Sep  1 06:46:25 2006
New Revision: 439319

URL: http://svn.apache.org/viewvc?rev=439319&view=rev
Log:
added better readme as per MUSE-62

Modified:
    webservices/muse/trunk/modules/muse-tools/scripts/readme.txt

Modified: webservices/muse/trunk/modules/muse-tools/scripts/readme.txt
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-tools/scripts/readme.txt?rev=439319&r1=439318&r2=439319&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-tools/scripts/readme.txt (original)
+++ webservices/muse/trunk/modules/muse-tools/scripts/readme.txt Fri Sep  1 06:46:25 2006
@@ -1,14 +1,39 @@
 Command Line Tooling
+=====================
 
-Requirements:
-The java executable in your PATH
-Apache Ant in your PATH (see: http://ant.apache.org)
+Tools:
+
+* wsdl2java
+* wsdlmerge
+
+
+wsdl2java
+=========
+
+Description: 
+------------
+This tool will take a WSDL file and generate code and a
+self-contained project where that code can be built. 
+
+Wsdl2java handles several environments and is extremely 
+pluggable, see
+
+docs/overview/overview-tools.html
 
-Simply invoke either one of these and pass it the WSDL you wish to use.
+Requirements:
+-------------
+* The java executable in your PATH
+* Apache Ant in your PATH (see: http://ant.apache.org)
+
+Usage:
+------
+The following is a description of running the tool in a Windows 
+environment. Running in a unix environment entails changing wsdl2java.bat
+to wsdl2java.sh. 
 
-For example, if wsdl2java.bat is in your path then run:
+If wsdl2java.bat is in your path then run:
 
-wsdl2java.bat foo.wsdl
+wsdl2java.bat -wsdl foo.wsdl
 
 This will create:
 
@@ -20,12 +45,67 @@
 
 ant
 
-This will create a capability.war file in your current directory that can be deployed to a J2EE server.
+while will create a war file in your current directory 
+that that will have the base name of the directory. For
+example if the current directory is
 
-For more information see 
+c:\temp\work\myTouchpoint
 
-docs/overview/overview-tools.html
+then the war file will be called
+
+myTouchpoint.war
+
+To see more usage information run wsdl2java with the -help option.
+To see more advanced usage inforation run wsdl2java with the -helpall option.
+
+
+wsdlmerge
+=========
+
+Description: 
+------------
+This tool will take several WSDL files and generate 
+one combined WSDL file that has the following properties:
+
+* Combines the portType element of each WSDL file into
+one portType 
+* Combines the WS-RF Document schema from each WSDL (if present)
+into a one merged WS-RF Document schema.
+* Creates a binding based on the new portType using
+conventions needed for wsdl2java and Muse
+* Creates a service element that attaches to the new binding and
+portType
+
+Requirements:
+-------------
+* The java executable in your PATH
+
+Usage:
+------
+The following is a description of running the tool in a Windows 
+environment. Running in a unix environment entails changing wsdmerge.bat
+to wsdlmerge.sh. 
+
+If wsdlmerge.bat is in your path then run:
+
+wsdlmerge.bat -address ADDRESS -uri URI -output OUTPUT FILES
+
+Where:
+
+* ADDRESS is the address at which to create the service element. For example:
+
+-address "http://localhost:8080/myEndpoint/services/myServiceName"
+
+* URI is the targetNamespace of the newly created WSDL. For example:
+
+-uri "http://tempuri.og/myEndpoint.wsdl"
+
+* OUTPUT is the file name of the new WSDL. For example:
+
+-output myEndpoint.wsdl
 
-in the Muse directory.
+* FILES is a list of one or more WSDL documents to merge. For example:
 
+wsdl1.wsdl wsdl2.wsdl
 
+To see more usage information run wsdlmerge with the -help option.
\ No newline at end of file



---------------------------------------------------------------------
To unsubscribe, e-mail: muse-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-commits-help@ws.apache.org