Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / xsd.1
1 .\" xsd manual page.
2 .\" (C) 2004 Novell, Inc.
3 .\" Author:
4 .\" Lluis Sanchez Gual (lluis@ximian.com)
5 .\" 
6 .TH "xsd" "1" "" "" ""
7 .SH "NAME"
8 xsd \- Mono's utility for generating schema or class files
9 .SH "SYNOPSIS"
10 .PP 
11 .B xsd
12 <schema.xsd> /classes [options]
13 .PP 
14 .B xsd
15 <schema.xsd> /dataset [options]
16 .PP 
17 .B xsd
18 <assembly>.dll|<assembly>.exe [options]
19 .PP 
20 .B xsd
21 <instance.xml> [<instance.xml> ...] [options]
22 .PP 
23 .SH "DESCRIPTION"
24 .I xsd
25 is a tool for intended to complement the XML serialization support of Mono. It can do the following tasks:
26 .TP 
27 Generate serializable classes
28 From a given XML schema, generate a class that can be used to read and write xml documents that conform that schema (/classes option).
29 .TP 
30 Generate typed datasets
31 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).
32 .TP 
33 Generate XML schemas
34 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.
35 .TP 
36 Infer XML schemas
37 From a given set of XML documents, infer the XML schema that can be used to validate those documents.
38
39 .SH "OPTIONS"
40 The following options are available:
41 .TP 
42 .I "/element:name" "/e:name"
43 Specifies the name of the XML schema element for which a class or a dataset has to be generated.
44 .TP 
45 .TP 
46 .I "/namespace:name" "/n:name"
47 Specifies the namespace of the XML schema element for which a class or a dataset has to be generated.
48 .TP 
49 .I "/language:name" "/l:name"
50 Specifies the programming language to use for the generated code. The only supported languages are CS (C#) and VB (Visual Basic.NET).
51 .TP 
52 .I "/generator:type,assembly" "/g:type,assembly"
53 Indicates xsd.exe to use custom CodeDomProvider to generate code. The type name must be full name. Assembly name is a local file name that is going to be loaded. The specified Type must have the default constructor.
54 .TP 
55 .I "/outputdir:path" "/o:path"
56 Specifies the directory where to generate the code or schemas.
57 .TP 
58 .I "/type:name" "/t:name"
59 Specifies the full name of the type (including namespace) for which to generate the XML schema.
60 .TP 
61 .I "/help" "/h"
62 Show usage help.
63 .PP 
64 .SH "AUTHORS"
65 Lluis Sanchez Gual (lluis@ximian.com)
66 .br 
67 Atsushi Enomoto (atsushi@ximian.com)
68 .PP 
69 .SH "LICENSE"
70 xsd is released under the terms of the GNU GPL.
71 .PP 
72 .SH "SEE ALSO"
73 disco(1), soapsuds(1), mono(1), mcs(1), wsdl(1)