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