Added man page for XSD
authorLluis Sanchez <lluis@novell.com>
Mon, 26 Apr 2004 17:57:46 +0000 (17:57 -0000)
committerLluis Sanchez <lluis@novell.com>
Mon, 26 Apr 2004 17:57:46 +0000 (17:57 -0000)
svn path=/trunk/mono/; revision=26002

man/Makefile.am
man/man.xml
man/xsd.1 [new file with mode: 0644]

index c0c606fa949466675100f544dcdabc7efdb41b71..6fbf2ace01b6ca0b976752260df0860a9fe14c01 100644 (file)
@@ -1,5 +1,5 @@
 man_MANS = mcs.1 mono.1 monostyle.1 mono-config.5 sqlsharp.1 oldmono.1 ilasm.1 \
           cert2spc.1 cilc.1 genxs.1 wsdl.1 disco.1 soapsuds.1 makecert.1 \
-          chktrust.1 setreg.1 sn.1 secutil.1 signcode.1 certmgr.1 monop.1
+          chktrust.1 setreg.1 sn.1 secutil.1 signcode.1 certmgr.1 monop.1 xsd.1
 
 EXTRA_DIST = $(man_MANS)
index 61253d7fbbf2f3475b9426c0730e7d237c3c1041..18e7d975076c364154aba91b31fdb40321260918 100644 (file)
@@ -20,4 +20,5 @@
 <manpage name="soapsuds" page="soapsuds.1" />
 <manpage name="setreg" page="setreg.1" />
 <manpage name="certmgr" page="certmgr.1" />
+<manpage name="xsd" page="xsd.1" />
 </manpages>
diff --git a/man/xsd.1 b/man/xsd.1
new file mode 100644 (file)
index 0000000..ec6673b
--- /dev/null
+++ b/man/xsd.1
@@ -0,0 +1,70 @@
+.\" xsd manual page.
+.\" (C) 2004 Novell, Inc.
+.\" Author:
+.\" Lluis Sanchez Gual (lluis@ximian.com)
+.\" 
+.TH "xsd" "1" "" "" ""
+.SH "NAME"
+xsd \- Mono's utility for generating schema or class files
+.SH "SYNOPSIS"
+.PP 
+.B xsd
+<schema.xsd> /classes [options]
+.PP 
+.B xsd
+<schema.xsd> /dataset [options]
+.PP 
+.B xsd
+<assembly>.dll|<assembly>.exe [options]
+.PP 
+.B xsd
+<instance.xml> [<instance.xml> ...] [options]
+.PP 
+.SH "DESCRIPTION"
+.I xsd
+is a tool for intended to complement the XML serialization support of Mono. It can do the following tasks:
+.TP 
+Generate serializable classes
+From a given XML schema, generate a class that can be used to read and write xml documents that conform that schema (/classes option).
+.TP 
+Generate typed datasets
+From a given XML schema, generate a typed DataSet class that can be used to read and write xml documents that conform that schema (/dataset option).
+.TP 
+Generate XML schemas
+From a given assembly and an optional type name, generate an XML schema that can be used to validate the xml documents that can be obtained by serializing objects of that type. If no type is provided, xsd generates a schema for all types in the assembly. When specifying the assembly name do not include the file extension (.dll or .exe). xsd will look for the assembly using the standard assembly loading rules.
+.TP 
+Infer XML schemas
+From a given set of XML documents, infer the XML schema that can be used to validate those documents.
+
+.SH "OPTIONS"
+The following options are available:
+.TP 
+.I "/element:name" "/e:name"
+Specifies the name of the XML schema element for which a class or a dataset has to be generated.
+.TP 
+.TP 
+.I "/namespace:name" "/n:name"
+Specifies the namespace of the XML schema element for which a class or a dataset has to be generated.
+.TP 
+.I "/language:name" "/l:name"
+Specifies the programming language to use for the generated code. The only supported languages are CS (C#) and VB (Visual Basic.NET).
+.TP 
+.I "/outputdir:path" "/o:path"
+Specifies the directory where to generate the code or schemas.
+.TP 
+.I "/type:name" "/t:name"
+Specifies the full name of the type (including namespace) for which to generate the XML schema.
+.TP 
+.I "/help" "/h"
+Show usage help.
+.PP 
+.SH "AUTHORS"
+Lluis Sanchez Gual (lluis@ximian.com)
+.br 
+Atsushi Enomoto (atsushi@ximian.com)
+.PP 
+.SH "LICENSE"
+xsd is released under the terms of the GNU GPL.
+.PP 
+.SH "SEE ALSO"
+disco(1), soapsuds(1), mono(1), mcs(1), wsdl(1)