1 ." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. |
1 '\" t |
2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
2 .\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
3 ." |
3 .\" |
4 ." This code is free software; you can redistribute it and/or modify it |
4 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
5 ." under the terms of the GNU General Public License version 2 only, as |
5 .\" |
6 ." published by the Free Software Foundation. |
6 .\" This code is free software; you can redistribute it and/or modify it |
7 ." |
7 .\" under the terms of the GNU General Public License version 2 only, as |
8 ." This code is distributed in the hope that it will be useful, but WITHOUT |
8 .\" published by the Free Software Foundation. |
9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
9 .\" |
10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
10 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
11 ." version 2 for more details (a copy is included in the LICENSE file that |
11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
12 ." accompanied this code). |
12 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
13 ." |
13 .\" version 2 for more details (a copy is included in the LICENSE file that |
14 ." You should have received a copy of the GNU General Public License version |
14 .\" accompanied this code). |
15 ." 2 along with this work; if not, write to the Free Software Foundation, |
15 .\" |
16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
16 .\" You should have received a copy of the GNU General Public License version |
17 ." |
17 .\" 2 along with this work; if not, write to the Free Software Foundation, |
18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
18 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
19 ." or visit www.oracle.com if you need additional information or have any |
19 .\" |
20 ." questions. |
20 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
21 ." |
21 .\" or visit www.oracle.com if you need additional information or have any |
22 .TH schemagen 1 "10 May 2011" |
22 .\" questions. |
|
23 .\" |
|
24 .\" Arch: generic |
|
25 .\" Software: JDK 8 |
|
26 .\" Date: 21 November 2013 |
|
27 .\" SectDesc: Java Web Services Tools |
|
28 .\" Title: schemagen.1 |
|
29 .\" |
|
30 .if n .pl 99999 |
|
31 .TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools" |
|
32 .\" ----------------------------------------------------------------- |
|
33 .\" * Define some portability stuff |
|
34 .\" ----------------------------------------------------------------- |
|
35 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
36 .\" http://bugs.debian.org/507673 |
|
37 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
38 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
39 .ie \n(.g .ds Aq \(aq |
|
40 .el .ds Aq ' |
|
41 .\" ----------------------------------------------------------------- |
|
42 .\" * set default formatting |
|
43 .\" ----------------------------------------------------------------- |
|
44 .\" disable hyphenation |
|
45 .nh |
|
46 .\" disable justification (adjust text to left margin only) |
|
47 .ad l |
|
48 .\" ----------------------------------------------------------------- |
|
49 .\" * MAIN CONTENT STARTS HERE * |
|
50 .\" ----------------------------------------------------------------- |
23 |
51 |
24 .LP |
52 .SH NAME |
25 .SH "Name" |
53 schemagen \- Generates a schema for every name space that is referenced in your Java classes\&. |
26 schemagen \- Java(TM) Architecture for XML Binding Schema Generator |
54 .SH SYNOPSIS |
27 .LP |
55 .sp |
28 .LP |
56 .nf |
29 \f3Specification Version:\fP 2.1 |
57 |
|
58 \fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR |
|
59 .fi |
|
60 .sp |
|
61 .TP |
|
62 \fIoptions\fR |
|
63 The command-line options\&. See Options\&. |
|
64 .TP |
|
65 \fIjava-files\fR |
|
66 The Java class files to be processed\&. |
|
67 .SH DESCRIPTION |
|
68 The schema generator creates a schema file for each name space referenced in your Java classes\&. Currently, you cannot control the name of the generated schema files\&. To control the schema file names, see Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html |
|
69 .PP |
|
70 Start the schema generator with the appropriate \f3schemagen\fR shell script in the bin directory for your platform\&. The current schema generator can process either Java source files or class files\&. |
|
71 .sp |
|
72 .nf |
|
73 \f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP |
|
74 .fi |
|
75 .nf |
|
76 \f3Note: Writing schema1\&.xsd\fP |
|
77 .fi |
|
78 .nf |
|
79 \f3\fP |
|
80 .fi |
|
81 .sp |
|
82 If your java files reference other classes, then those classes must be accessible on your system \f3CLASSPATH\fR environment variable, or they need to be specified in the \f3schemagen\fR command line with the class path options\&. See Options\&. If the referenced files are not accessible or specified, then you get errors when you generate the schema\&. |
|
83 .SH OPTIONS |
|
84 .TP |
|
85 -d \fIpath\fR |
30 .br |
86 .br |
31 \f3Implementation Version:\fP 2.1.3 |
87 The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&. |
32 .LP |
88 .TP |
33 .SH "Launching schemagen" |
89 -cp \fIpath\fR |
34 .LP |
90 .br |
35 .LP |
91 The location where the \f3schemagen\fR command places user-specified files\&. |
36 The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform. |
92 .TP |
37 .LP |
93 -classpath \fIpath\fR |
38 .LP |
94 .br |
39 The current schema generator can process either Java source files or class files. |
95 The location where the \f3schemagen\fR command places user-specified files\&. |
40 .LP |
96 .TP |
41 .LP |
97 -encoding \fIencoding\fR |
42 We also provide an Ant task to run the schema generator \- see the instructions for |
98 .br |
43 .na |
99 Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&. |
44 \f2using schemagen with Ant\fP @ |
100 .TP |
45 .fi |
101 -episode \fIfile\fR |
46 https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. |
102 .br |
47 .LP |
103 Generates an episode file for separate compilation\&. |
48 .nf |
104 .TP |
49 \f3 |
105 -version |
50 .fl |
106 .br |
51 % schemagen.sh Foo.java Bar.java ... |
107 Displays release information\&. |
52 .fl |
108 .TP |
53 Note: Writing schema1.xsd |
109 -help |
54 .fl |
110 .br |
55 \fP |
111 Displays a help message\&. |
56 .fi |
112 .SH SEE\ ALSO |
57 |
113 .TP 0.2i |
58 .LP |
114 \(bu |
59 .LP |
115 Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html |
60 If 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. |
116 .TP 0.2i |
61 .LP |
117 \(bu |
62 .SS |
118 Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html |
63 Command Line Options |
|
64 .LP |
|
65 .nf |
|
66 \f3 |
|
67 .fl |
|
68 Usage: schemagen [\-options ...] <java files> |
|
69 .fl |
|
70 |
|
71 .fl |
|
72 Options: |
|
73 .fl |
|
74 \-d <path> : specify where to place processor and javac generated class files |
|
75 .fl |
|
76 \-cp <path> : specify where to find user specified files |
|
77 .fl |
|
78 \-classpath <path> : specify where to find user specified files |
|
79 .fl |
|
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 |
|
89 .fl |
|
90 \fP |
|
91 .fi |
|
92 |
|
93 .LP |
|
94 .SH "Generated Resource Files" |
|
95 .LP |
|
96 .LP |
|
97 The 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 |
|
101 https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html. |
|
102 .LP |
|
103 .SH "Name" |
|
104 See Also |
|
105 .LP |
|
106 .RS 3 |
|
107 .TP 2 |
|
108 o |
|
109 Running the schema generator (schemagen): [ |
|
110 .na |
|
111 \f2command\-line instructions\fP @ |
|
112 .fi |
|
113 https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html, |
|
114 .na |
|
115 \f2using the SchemaGen Ant task\fP @ |
|
116 .fi |
|
117 https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html] |
|
118 .TP 2 |
|
119 o |
|
120 .na |
|
121 \f2Java Architecture for XML Binding (JAXB)\fP @ |
|
122 .fi |
|
123 http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html |
|
124 .RE |
119 .RE |
125 |
120 .br |
126 .LP |
121 'pl 8.5i |
127 |
122 'bp |