jdk/src/solaris/doc/sun/man/man1/schemagen.1
author bpatel
Wed, 14 Jul 2010 15:42:06 -0700
changeset 5865 47da38a8c0f0
parent 5506 202f599c92aa
child 9573 c02ff5a7c67b
permissions -rw-r--r--
6955341: Oracle rebranding changes for man pages Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5865
47da38a8c0f0 6955341: Oracle rebranding changes for man pages
bpatel
parents: 5506
diff changeset
     1
." Copyright (c) 2005, 2010, 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
."
5865
47da38a8c0f0 6955341: Oracle rebranding changes for man pages
bpatel
parents: 5506
diff changeset
    22
.TH schemagen 1 "02 Jun 2010"
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
.SS 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
Launching schemagen
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
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
    38
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
The current schema generator can process either Java source files or class files.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    43
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
    44
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    45
\f2using schemagen with Ant\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    46
.fi
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    47
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
.fl
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    55
% schemagen.sh Foo.java Bar.java ...
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
.fl
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
    57
Note: Writing schema1.xsd
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
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
    66
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
\f3Command Line Options\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
.nf
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
\f3
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
Usage: schemagen [\-options ...] <java files> 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
Options: 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    \-d <path>         :  Specify where to place processor and javac generated class files 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    \-cp <path>        :  Specify where to find user specified files  
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    \-classpath <path> :  Specify where to find user specified files  
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    \-help             :  Display this usage message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
.fl
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
\fP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
.fi
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
.SS 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
Generated Resource Files
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
.LP
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   102
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
   103
.na
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   104
\f2the schema generator ant task\fP @
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   105
.fi
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   106
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
.SH "See Also"
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
.RS 3
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
o
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   113
Running the schema generator (schemagen): [
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
.na
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   115
\f2command\-line instructions\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/schemagen.html, 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
.na
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   119
\f2using the SchemaGen Ant task\fP @
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
.fi
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   121
https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html] 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
.TP 2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
o
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
.na
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   125
\f2Java Architecture for XML Binding (JAXB)\fP @
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
.fi
2692
345bc8d65b19 6837214: Update JDK7 man pages
tbell
parents: 2
diff changeset
   127
http://java.sun.com/javase/6/docs/technotes/guides/xml/jaxb/index.html 
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
.RE
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
.LP
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131