blob: d43a7ee38b2dd906b12c9479c45bdfd64bf9474f [file] [log] [blame]
duke6e45e102007-12-01 00:00:00 +00001." Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
2." 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."
22.TH schemagen 1 "04 May 2009"
23." Generated from HTML by html2man (author: Eric Armstrong)
duke6e45e102007-12-01 00:00:00 +000024
25.LP
tbell16c34dd2009-05-04 18:28:26 -070026.SH "Name"
27schemagen \- Java(TM) Architecture for XML Binding Schema Generator
28.LP
29.LP
30\f3Specification Version:\fP 2.1
duke6e45e102007-12-01 00:00:00 +000031.br
tbell16c34dd2009-05-04 18:28:26 -070032\f3Implementation Version:\fP 2.1.3
duke6e45e102007-12-01 00:00:00 +000033.LP
34.SS
35Launching schemagen
36.LP
37.LP
38The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
39.LP
40.LP
41The current schema generator can process either Java source files or class files.
42.LP
43.LP
tbell16c34dd2009-05-04 18:28:26 -070044We also provide an Ant task to run the schema generator \- see the instructions for
45.na
46\f2using schemagen with Ant\fP @
47.fi
48https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
duke6e45e102007-12-01 00:00:00 +000049.LP
50.RS 3
51
52.LP
duke6e45e102007-12-01 00:00:00 +000053.nf
54\f3
55.fl
tbell16c34dd2009-05-04 18:28:26 -070056% schemagen.sh Foo.java Bar.java ...
duke6e45e102007-12-01 00:00:00 +000057.fl
tbell16c34dd2009-05-04 18:28:26 -070058Note: Writing schema1.xsd
duke6e45e102007-12-01 00:00:00 +000059.fl
60\fP
61.fi
62.RE
63
64.LP
65.LP
66If 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.
67.LP
68.RS 3
69
70.LP
71\f3Command Line Options\fP
72.LP
73.RS 3
74
75.LP
76.nf
77\f3
78.fl
79Usage: schemagen [\-options ...] <java files>
80.fl
81
82.fl
83Options:
84.fl
85 \-d <path> : Specify where to place processor and javac generated class files
86.fl
87 \-cp <path> : Specify where to find user specified files
88.fl
89 \-classpath <path> : Specify where to find user specified files
90.fl
91 \-help : Display this usage message
92.fl
duke6e45e102007-12-01 00:00:00 +000093\fP
94.fi
95.RE
96
97.LP
98.RE
99.SS
100Generated Resource Files
101.LP
102.LP
tbell16c34dd2009-05-04 18:28:26 -0700103The 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
104.na
105\f2the schema generator ant task\fP @
106.fi
107https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
duke6e45e102007-12-01 00:00:00 +0000108.LP
109.SH "See Also"
110.LP
111.RS 3
112.TP 2
113o
tbell16c34dd2009-05-04 18:28:26 -0700114Running the schema generator (schemagen): [
duke6e45e102007-12-01 00:00:00 +0000115.na
tbell16c34dd2009-05-04 18:28:26 -0700116\f2command\-line instructions\fP @
duke6e45e102007-12-01 00:00:00 +0000117.fi
tbell16c34dd2009-05-04 18:28:26 -0700118https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html,
duke6e45e102007-12-01 00:00:00 +0000119.na
tbell16c34dd2009-05-04 18:28:26 -0700120\f2using the SchemaGen Ant task\fP @
duke6e45e102007-12-01 00:00:00 +0000121.fi
tbell16c34dd2009-05-04 18:28:26 -0700122https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html]
duke6e45e102007-12-01 00:00:00 +0000123.TP 2
124o
duke6e45e102007-12-01 00:00:00 +0000125.na
tbell16c34dd2009-05-04 18:28:26 -0700126\f2Java Architecture for XML Binding (JAXB)\fP @
duke6e45e102007-12-01 00:00:00 +0000127.fi
tbell16c34dd2009-05-04 18:28:26 -0700128http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html
duke6e45e102007-12-01 00:00:00 +0000129.RE
tbell16c34dd2009-05-04 18:28:26 -0700130
131.LP
duke6e45e102007-12-01 00:00:00 +0000132
133.LP
134