blob: f23cae2052f0804c9249875af738e235e82a661c [file] [log] [blame]
bpatel87d64cc2010-07-14 15:42:06 -07001." Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
duke6e45e102007-12-01 00:00:00 +00002." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3."
4." This code is free software; you can redistribute it and/or modify it
5." under the terms of the GNU General Public License version 2 only, as
6." published by the Free Software Foundation.
7."
8." This code is distributed in the hope that it will be useful, but WITHOUT
9." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11." version 2 for more details (a copy is included in the LICENSE file that
12." accompanied this code).
13."
14." You should have received a copy of the GNU General Public License version
15." 2 along with this work; if not, write to the Free Software Foundation,
16." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17."
ohair2283b9d2010-05-25 15:58:33 -070018." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
19." or visit www.oracle.com if you need additional information or have any
20." questions.
tbell16c34dd2009-05-04 18:28:26 -070021."
bpatel87d64cc2010-07-14 15:42:06 -070022.TH schemagen 1 "02 Jun 2010"
duke6e45e102007-12-01 00:00:00 +000023
24.LP
tbell16c34dd2009-05-04 18:28:26 -070025.SH "Name"
26schemagen \- Java(TM) Architecture for XML Binding Schema Generator
27.LP
28.LP
29\f3Specification Version:\fP 2.1
duke6e45e102007-12-01 00:00:00 +000030.br
tbell16c34dd2009-05-04 18:28:26 -070031\f3Implementation Version:\fP 2.1.3
duke6e45e102007-12-01 00:00:00 +000032.LP
33.SS
34Launching schemagen
35.LP
36.LP
37The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
38.LP
39.LP
40The current schema generator can process either Java source files or class files.
41.LP
42.LP
tbell16c34dd2009-05-04 18:28:26 -070043We also provide an Ant task to run the schema generator \- see the instructions for
44.na
45\f2using schemagen with Ant\fP @
46.fi
47https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
duke6e45e102007-12-01 00:00:00 +000048.LP
49.RS 3
50
51.LP
duke6e45e102007-12-01 00:00:00 +000052.nf
53\f3
54.fl
tbell16c34dd2009-05-04 18:28:26 -070055% schemagen.sh Foo.java Bar.java ...
duke6e45e102007-12-01 00:00:00 +000056.fl
tbell16c34dd2009-05-04 18:28:26 -070057Note: Writing schema1.xsd
duke6e45e102007-12-01 00:00:00 +000058.fl
59\fP
60.fi
61.RE
62
63.LP
64.LP
65If 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.
66.LP
67.RS 3
68
69.LP
70\f3Command Line Options\fP
71.LP
72.RS 3
73
74.LP
75.nf
76\f3
77.fl
78Usage: schemagen [\-options ...] <java files>
79.fl
80
81.fl
82Options:
83.fl
84 \-d <path> : Specify where to place processor and javac generated class files
85.fl
86 \-cp <path> : Specify where to find user specified files
87.fl
88 \-classpath <path> : Specify where to find user specified files
89.fl
90 \-help : Display this usage message
91.fl
duke6e45e102007-12-01 00:00:00 +000092\fP
93.fi
94.RE
95
96.LP
97.RE
98.SS
99Generated Resource Files
100.LP
101.LP
tbell16c34dd2009-05-04 18:28:26 -0700102The 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
103.na
104\f2the schema generator ant task\fP @
105.fi
106https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
duke6e45e102007-12-01 00:00:00 +0000107.LP
108.SH "See Also"
109.LP
110.RS 3
111.TP 2
112o
tbell16c34dd2009-05-04 18:28:26 -0700113Running the schema generator (schemagen): [
duke6e45e102007-12-01 00:00:00 +0000114.na
tbell16c34dd2009-05-04 18:28:26 -0700115\f2command\-line instructions\fP @
duke6e45e102007-12-01 00:00:00 +0000116.fi
tbell16c34dd2009-05-04 18:28:26 -0700117https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html,
duke6e45e102007-12-01 00:00:00 +0000118.na
tbell16c34dd2009-05-04 18:28:26 -0700119\f2using the SchemaGen Ant task\fP @
duke6e45e102007-12-01 00:00:00 +0000120.fi
tbell16c34dd2009-05-04 18:28:26 -0700121https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html]
duke6e45e102007-12-01 00:00:00 +0000122.TP 2
123o
duke6e45e102007-12-01 00:00:00 +0000124.na
tbell16c34dd2009-05-04 18:28:26 -0700125\f2Java Architecture for XML Binding (JAXB)\fP @
duke6e45e102007-12-01 00:00:00 +0000126.fi
tbell16c34dd2009-05-04 18:28:26 -0700127http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html
duke6e45e102007-12-01 00:00:00 +0000128.RE
tbell16c34dd2009-05-04 18:28:26 -0700129
130.LP
duke6e45e102007-12-01 00:00:00 +0000131