schemagen.1 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. '\" t
  2. .\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
  3. .\" Arch: generic
  4. .\" Software: JDK 8
  5. .\" Date: 21 November 2013
  6. .\" SectDesc: Java Web Services Tools
  7. .\" Title: schemagen.1
  8. .\"
  9. .if n .pl 99999
  10. .TH schemagen 1 "21 November 2013" "JDK 8" "Java Web Services Tools"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH NAME
  31. schemagen \- Generates a schema for every name space that is referenced in your Java classes\&.
  32. .SH SYNOPSIS
  33. .sp
  34. .nf
  35. \fBschemagen\fR [ \fIoptions\fR ] \fIjava\-files\fR
  36. .fi
  37. .sp
  38. .TP
  39. \fIoptions\fR
  40. The command-line options\&. See Options\&.
  41. .TP
  42. \fIjava-files\fR
  43. The Java class files to be processed\&.
  44. .SH DESCRIPTION
  45. 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
  46. .PP
  47. 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\&.
  48. .sp
  49. .nf
  50. \f3schemagen\&.sh Foo\&.java Bar\&.java \&.\&.\&.\fP
  51. .fi
  52. .nf
  53. \f3Note: Writing schema1\&.xsd\fP
  54. .fi
  55. .nf
  56. \f3\fP
  57. .fi
  58. .sp
  59. 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\&.
  60. .SH OPTIONS
  61. .TP
  62. -d \fIpath\fR
  63. .br
  64. The location where the \f3schemagen\fR command places processor-generated and \f3javac\fR-generated class files\&.
  65. .TP
  66. -cp \fIpath\fR
  67. .br
  68. The location where the \f3schemagen\fR command places user-specified files\&.
  69. .TP
  70. -classpath \fIpath\fR
  71. .br
  72. The location where the \f3schemagen\fR command places user-specified files\&.
  73. .TP
  74. -encoding \fIencoding\fR
  75. .br
  76. Specifies the encoding to use for \f3apt\fR or \f3javac\fR command invocations\&.
  77. .TP
  78. -episode \fIfile\fR
  79. .br
  80. Generates an episode file for separate compilation\&.
  81. .TP
  82. -version
  83. .br
  84. Displays release information\&.
  85. .TP
  86. -help
  87. .br
  88. Displays a help message\&.
  89. .SH SEE\ ALSO
  90. .TP 0.2i
  91. \(bu
  92. Using SchemaGen with Ant at http://jaxb\&.java\&.net/nonav/2\&.2\&.3u1/docs/schemagenTask\&.html
  93. .TP 0.2i
  94. \(bu
  95. Java Architecture for XML Binding (JAXB) at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/xml/jaxb/index\&.html
  96. .RE
  97. .br
  98. 'pl 8.5i
  99. 'bp