Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / oj-libjdwp / 7d5f3656439d3ca1a45b8cc76975799ef92a8d40 / . / src / linux / doc / man / schemagen.1
blob: 59c4c97ea58ae8236bf1986d8b4b7ee2f4f12ffd [file] [log] [blame]
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]1." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]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 -0700[diff] [blame]18." 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 -0700[diff] [blame]21."
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]22.TH schemagen 1 "10 May 2011"
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]23
24.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]25.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 +0000[diff] [blame]30.br
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]31\f3Implementation Version:\fP 2.1.3
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]32.LP
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]33.SH "Launching schemagen"
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]34.LP
35.LP
36The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
37.LP
38.LP
39The current schema generator can process either Java source files or class files.
40.LP
41.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]42We also provide an Ant task to run the schema generator \- see the instructions for
43.na
44\f2using schemagen with Ant\fP @
45.fi
46https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]47.LP
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]48.nf
49\f3
50.fl
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]51% schemagen.sh Foo.java Bar.java ...
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]52.fl
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]53Note: Writing schema1.xsd
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]54.fl
55\fP
56.fi
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]57
58.LP
59.LP
60If 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.
61.LP
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]62.SS
63Command Line Options
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]64.LP
65.nf
66\f3
67.fl
68Usage: schemagen [\-options ...] <java files>
69.fl
70
71.fl
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]72Options:
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]73.fl
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]74 \-d <path> : specify where to place processor and javac generated class files
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]75.fl
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]76 \-cp <path> : specify where to find user specified files
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]77.fl
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]78 \-classpath <path> : specify where to find user specified files
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]79.fl
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]80 \-encoding <encoding> : specify encoding to be used for apt/javac invocation
81.fl
82
83.fl
84 \-episode <file> : generate episode file for separate compilation
85.fl
86 \-version : display version information
87.fl
88 \-help : display this usage message
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]89.fl
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]90\fP
91.fi
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]92
93.LP
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]94.SH "Generated Resource Files"
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]95.LP
96.LP
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]97The 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
98.na
99\f2the schema generator ant task\fP @
100.fi
101https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]102.LP
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]103.SH "Name"
104See Also
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]105.LP
106.RS 3
107.TP 2
108o
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]109Running the schema generator (schemagen): [
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]110.na
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]111\f2command\-line instructions\fP @
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]112.fi
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]113https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html,
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]114.na
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]115\f2using the SchemaGen Ant task\fP @
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]116.fi
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]117https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html]
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]118.TP 2
119o
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]120.na
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]121\f2Java Architecture for XML Binding (JAXB)\fP @
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]122.fi
bpatel4bf512b2011-05-11 08:30:46 -0700[diff] [blame]123http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]124.RE
tbell16c34dd2009-05-04 18:28:26 -0700[diff] [blame]125
126.LP
duke6e45e102007-12-01 00:00:00 +0000[diff] [blame]127