blob: 562a2f9450fea85a55956837f6b2cba3612d0e70 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001.'" t
2."
3." Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
4." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5."
6." This code is free software; you can redistribute it and/or modify it
7." under the terms of the GNU General Public License version 2 only, as
8." published by the Free Software Foundation.
9."
10." This code is distributed in the hope that it will be useful, but WITHOUT
11." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13." version 2 for more details (a copy is included in the LICENSE file that
14." accompanied this code).
15."
16." You should have received a copy of the GNU General Public License version
17." 2 along with this work; if not, write to the Free Software Foundation,
18." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19."
20." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21." CA 95054 USA or visit www.sun.com if you need additional information or
22." have any questions.
23."
24." `
25.TH schemagen 1 "07 Aug 2006"
26." Generated by html2man
27
28.LP
29.ad c
30.SH NAME
31schemagen \- Java(TM) Architecture for XML Binding Schema Generator \f3Specification Version:\fP 2.0
32.br
33\f3Reference Implementation (RI) Version:\fP 2.0 ea3
34.br
35.ad l
36
37.LP
38.SS
39Launching schemagen
40.LP
41.LP
42The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
43.LP
44.LP
45The current schema generator can process either Java source files or class files.
46.LP
47.LP
48We also provide an Ant task to run the schema generator \- see the instructions for using schemagen with Ant.
49.LP
50.RS 3
51
52.LP
53\f3For Solaris/Linux\fP
54.LP
55.nf
56\f3
57.fl
58 % path/to/jaxb/bin/schemagen.sh Foo.java Bar.java ...
59.fl
60 Note: Writing schema1.xsd
61.fl
62
63.fl
64\fP
65.fi
66
67.LP
68\f3For WindowsNT/2000/XP\fP
69.LP
70.nf
71\f3
72.fl
73 > path\\to\\jaxb\\bin\\schemagen.bat Foo.java Bar.java ...
74.fl
75 Note: Writing schema1.xsd
76.fl
77
78.fl
79\fP
80.fi
81.RE
82
83.LP
84.LP
85If your java sources/classes reference other classes, they must be accessable on your system CLASSPATH environment variable, or they need to be given to the tool by using the \f2\-classpath\fP/\f2\-cp\fP options. Otherwise you will see errors when generating your schema.
86.LP
87.RS 3
88
89.LP
90\f3Command Line Options\fP
91.LP
92.RS 3
93
94.LP
95.nf
96\f3
97.fl
98Usage: schemagen [\-options ...] <java files>
99.fl
100
101.fl
102Options:
103.fl
104 \-d <path> : Specify where to place processor and javac generated class files
105.fl
106 \-cp <path> : Specify where to find user specified files
107.fl
108 \-classpath <path> : Specify where to find user specified files
109.fl
110 \-help : Display this usage message
111.fl
112
113.fl
114\fP
115.fi
116.RE
117
118.LP
119.RE
120.SS
121Generated Resource Files
122.LP
123.LP
124The current schema generator simply creates a schema file for each namespace referenced in your Java classes. There is no way to control the name of the generated schema files at this time. For that purpose, use the schema generator ant task.
125.LP
126.SH "See Also"
127.LP
128.RS 3
129.TP 2
130o
131JAXB 2.0:
132.RS 3
133.TP 2
134*
135.na
136\f2Release Notes\fP @
137.fi
138http://java.sun.com/webservices/docs/2.0/jaxb/ReleaseNotes.html
139.TP 2
140*
141.na
142\f2XJC\fP @
143.fi
144http://java.sun.com/webservices/docs/2.0/jaxb/xjc.html
145.TP 2
146*
147.na
148\f2XJCTask\fP @
149.fi
150http://java.sun.com/webservices/docs/2.0/jaxb/xjcTask.html
151.TP 2
152*
153.na
154\f2SchemaGen\fP @
155.fi
156http://java.sun.com/webservices/docs/2.0/jaxb/schemagen.html
157.TP 2
158*
159.na
160\f2schemagenTask\fP @
161.fi
162http://java.sun.com/webservices/docs/2.0/jaxb/schemagenTask.html
163.TP 2
164*
165.na
166\f2Sample Apps\fP @
167.fi
168http://java.sun.com/webservices/docs/2.0/jaxb/samples.html
169.TP 2
170*
171.na
172\f2Changelog\fP @
173.fi
174http://java.sun.com/webservices/docs/2.0/jaxb/changelog2.html
175.RE
176.TP 2
177o
178JAXB 1.0.x:
179.RS 3
180.TP 2
181*
182.na
183\f2Release Notes\fP @
184.fi
185http://java.sun.com/webservices/docs/2.0/jaxb/jaxb\-1_0.html
186.TP 2
187*
188.na
189\f2Changelog\fP @
190.fi
191http://java.sun.com/webservices/docs/2.0/jaxb/changelog.html
192.RE
193.TP 2
194o
195JAXB RI Extensions:
196.RS 3
197.TP 2
198*
199.na
200\f2Runtime Properties\fP @
201.fi
202http://java.sun.com/webservices/docs/2.0/jaxb/vendorProperties.html
203.TP 2
204*
205.na
206\f2XJC Customizations\fP @
207.fi
208http://java.sun.com/webservices/docs/2.0/jaxb/vendorCustomizations.html
209.TP 2
210*
211.na
212\f2Develop Plugins\fP @
213.fi
214http://java.sun.com/webservices/docs/2.0/jaxb/developPlugins.html
215.RE
216.TP 2
217o
218JAXB RI Schema Languages:
219.RS 3
220.TP 2
221*
222.na
223\f2W3C XML Schema\fP @
224.fi
225http://java.sun.com/webservices/docs/2.0/jaxb/vendorSchemaLangs.html#xschema
226.TP 2
227*
228.na
229\f2RELAX NG\fP @
230.fi
231http://java.sun.com/webservices/docs/2.0/jaxb/vendorSchemaLangs.html#relaxng
232.TP 2
233*
234.na
235\f2DTD\fP @
236.fi
237http://java.sun.com/webservices/docs/2.0/jaxb/vendorSchemaLangs.html#dtd
238.RE
239.TP 2
240o
241JAXB Community:
242.RS 3
243.TP 2
244*
245.na
246\f2Java.net Homepage\fP @
247.fi
248http://jaxb.dev.java.net
249.TP 2
250*
251.na
252\f2Developer interest list\fP @
253.fi
254https://jaxb.dev.java.net/servlets/ProjectMailingListList
255.TP 2
256*
257.na
258\f2FAQ\fP @
259.fi
260https://jaxb.dev.java.net/faq/index.html
261.RE
262.RE
263
264.LP
265