jdk/src/linux/doc/man/schemagen.1
author bpatel
Wed, 11 May 2011 08:30:46 -0700
changeset 9573 c02ff5a7c67b
parent 5865 47da38a8c0f0
child 21743 3d979da7bdf0
permissions -rw-r--r--
7043684: Update man pages for JDK 7 tools Reviewed-by: skannan
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
     1
." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
." This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
." under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
." published by the Free Software Foundation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
." This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
." FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
." version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
." accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
." You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
." 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
."
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    18
." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    19
." or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2692
diff changeset
    20
." questions.
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    21
."
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    22
.TH schemagen 1 "10 May 2011"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    25
.SH "Name"
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    26
schemagen \- Java(TM) Architecture for XML Binding Schema Generator
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    27
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    28
.LP
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    29
\f3Specification Version:\fP 2.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
.br
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    31
\f3Implementation Version:\fP 2.1.3
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
.LP
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    33
.SH "Launching schemagen"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
The current schema generator can process either Java source files or class files.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    42
We also provide an Ant task to run the schema generator \- see the instructions for 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    43
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    44
\f2using schemagen with Ant\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    45
.fi
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    46
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
.fl
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    51
% schemagen.sh Foo.java Bar.java ...
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
.fl
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    53
Note: Writing schema1.xsd
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
.LP
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    62
.SS 
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    63
Command Line Options
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
Usage: schemagen [\-options ...] <java files> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
.fl
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    72
Options:
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    73
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    74
    \-d <path>             : specify where to place processor and javac generated class files
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
.fl
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    76
    \-cp <path>            : specify where to find user specified files
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    77
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    78
    \-classpath <path>     : specify where to find user specified files
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
.fl
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    80
    \-encoding <encoding>  : specify encoding to be used for apt/javac invocation
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    81
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    82
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
.fl
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    84
    \-episode <file>       : generate episode file for separate compilation
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.fl
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    86
    \-version              : display version information
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    87
.fl
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    88
    \-help                 : display this usage message
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
.LP
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
    94
.SH "Generated Resource Files"
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    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 
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    98
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    99
\f2the schema generator ant task\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   100
.fi
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   101
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
.LP
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   103
.SH "Name"
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   104
See Also
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
o
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   109
Running the schema generator (schemagen): [
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.na
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   111
\f2command\-line instructions\fP @
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
.fi
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   113
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagen.html, 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
.na
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   115
\f2using the SchemaGen Ant task\fP @
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
.fi
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   117
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html] 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
o
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
.na
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   121
\f2Java Architecture for XML Binding (JAXB)\fP @
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
.fi
9573
c02ff5a7c67b 7043684: Update man pages for JDK 7 tools
bpatel
parents: 5865
diff changeset
   123
http://download.oracle.com/javase/7/docs/technotes/guides/xml/jaxb/index.html 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127