jdk/src/bsd/doc/man/schemagen.1
changeset 12047 320a714614e9
child 14342 8435a30053c1
equal deleted inserted replaced
12046:378aa3362868 12047:320a714614e9
       
     1 ." Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
       
     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 ."
       
    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.
       
    21 ."
       
    22 .TH schemagen 1 "10 May 2011"
       
    23 
       
    24 .LP
       
    25 .SH "Name"
       
    26 schemagen \- Java(TM) Architecture for XML Binding Schema Generator
       
    27 .LP
       
    28 .LP
       
    29 \f3Specification Version:\fP 2.1
       
    30 .br
       
    31 \f3Implementation Version:\fP 2.1.3
       
    32 .LP
       
    33 .SH "Launching schemagen"
       
    34 .LP
       
    35 .LP
       
    36 The schema generator can be launched using the appropriate \f2schemagen\fP shell script in the \f2bin\fP directory for your platform.
       
    37 .LP
       
    38 .LP
       
    39 The current schema generator can process either Java source files or class files.
       
    40 .LP
       
    41 .LP
       
    42 We also provide an Ant task to run the schema generator \- see the instructions for
       
    43 .na
       
    44 \f2using schemagen with Ant\fP @
       
    45 .fi
       
    46 https://jaxb.dev.java.net/nonav/2.1.3/docs/schemagenTask.html.
       
    47 .LP
       
    48 .nf
       
    49 \f3
       
    50 .fl
       
    51 % schemagen.sh Foo.java Bar.java ...
       
    52 .fl
       
    53 Note: Writing schema1.xsd
       
    54 .fl
       
    55 \fP
       
    56 .fi
       
    57 
       
    58 .LP
       
    59 .LP
       
    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.
       
    61 .LP
       
    62 .SS
       
    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
       
   125 
       
   126 .LP
       
   127