'\" t
.\"     Title: osx
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: November 2002
.\"    Manual: Reference
.\"    Source: OpenJade
.\"  Language: English
.\"
.TH "OSX" "1" "November 2002" "OpenJade" "Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
osx \- An SGML to XML converter
.SH "SYNOPSIS"
.HP \w'\fBosx\fR\ 'u
\fBosx\fR [\fB\-CeghnRvx\fR] [\fB\-a\fR\fB\fIname\fR\fR] [\fB\-A\fR\fB\fIarchitecture\fR\fR] [\fB\-b\fR\fB\fIencoding\fR\fR] [\fB\-c\fR\fB\fIcatalog_file\fR\fR] [\fB\-d\fR\fB\fIdirectory\fR\fR] [\fB\-D\fR\fB\fIdirectory\fR\fR] [\fB\-i\fR\fB\fIname\fR\fR] [\fB\-f\fR\fB\fIfile\fR\fR] [\fB\-l\fR\fB\fIdtd_file\fR\fR] [\fB\-w\fR\fB\fIwarning_type\fR\fR] [\fB\-x\fR\fB\fIxml_output_option\fR\fR...] [\fB\fIsysid\fR\fR...]
.SH "DESCRIPTION"
.PP
\fBosx\fR
converts SGML to XML\&.
\fBosx\fR
parses and validates the SGML document contained in
.HP \w'\ 'u [\fB\fIsysid\fR\fR...]
and writes an equivalent XML document to the standard output\&.
\fBosx\fR
will warn about SGML constructs which have no XML equivalent\&.
.PP
Part of an SGML System Conforming to International Standard ISO 8879 \-\- Standard Generalized Markup Language\&. An SGML Extended Facilities system conforming to Annex A of International Standard ISO/IEC 10744 \-\- Hypermedia/Time\-based Structuring Language\&.
.SH "OPTIONS"
.PP
The following options are available:
.PP
\fB\-a\fR\fB\fIname\fR\fR, \fB\-\-activate=\fR\fB\fIname\fR\fR
.RS 4
Make doctype or linkname
\fIname\fR
active\&.
.RE
.PP
\fB\-A\fR\fB\fIname\fR\fR, \fB\-\-architecture=\fR\fB\fIname\fR\fR
.RS 4
Parse with respect to architecture
\fIname\fR\&.
.RE
.PP
\fB\-b\fR\fB\fIencoding\fR\fR, \fB\-\-encoding=\fR\fB\fIencoding\fR\fR
.RS 4
Use the BCTF
\fIencoding\fR
for output\&. By default
\fBosx\fR
uses UTF\-8\&.
.RE
.PP
\fB\-c\fR\fB\fIsysid\fR\fR, \fB\-\-catalog=\fR\fB\fIsysid\fR\fR
.RS 4
Map public identifiers and entity names to system identifiers using the catalog entry file whose system identifier is
\fIsysid\fR\&.
.RE
.PP
\fB\-C\fR, \fB\-\-catalogs\fR
.RS 4
This has the same effect as in
\fBonsgmls(1)\fR\&.
.RE
.PP
\fB\-d\fR\fB\fIdirectory\fR\fR, \fB\-\-entity_output_location=\fR\fB\fIdirectory\fR\fR
.RS 4
Place output files in
\fIdirectory\fR\&.
.RE
.PP
\fB\-D\fR\fB\fIdirectory\fR\fR, \fB\-\-directory=\fR\fB\fIdirectory\fR\fR
.RS 4
Search
\fIdirectory\fR
for files specified in system identifiers\&. This has the same effect as in
\fBonsgmls(1)\fR\&.
.RE
.PP
\fB\-e\fR, \fB\-\-open\-entities\fR
.RS 4
Describe open entities in error messages\&.
.RE
.PP
\fB\-E\fR\fB\fImax_errors\fR\fR, \fB\-\-max\-errors=\fR\fB\fImax_errors\fR\fR
.RS 4
Give up after
\fImax_errors\fR
errors\&.
.RE
.PP
\fB\-f\fR\fB\fIfile\fR\fR, \fB\-\-error\-file=\fR\fB\fIfile\fR\fR
.RS 4
Redirect errors to
\fIfile\fR\&. This is useful mainly with shells that do not support redirection of stderr\&.
.RE
.PP
\fB\-g\fR, \fB\-\-open\-elements\fR
.RS 4
Describe open elements in error messages\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display a help text and exit\&.
.RE
.PP
\fB\-i\fR\fB\fIname\fR\fR, \fB\-\-include=\fR\fB\fIname\fR\fR
.RS 4
This has the same effect as in
\fBonsgmls(1)\fR\&.
.RE
.PP
\fB\-l\fR\fB\fIdtd\-file\fR\fR, \fB\-\-dtd_location=\fR\fB\fIdtd\-file\fR\fR
.RS 4
Specify that the resulting XML file should conform to the DTD in
\fIdtd\-file\fR\&.
.RE
.PP
\fB\-n\fR, \fB\-\-error\-numbers\fR
.RS 4
Show error numbers in error messages\&.
.RE
.PP
\fB\-\-references\fR
.RS 4
Show references in error messages\&.
.RE
.PP
\fB\-R\fR, \fB\-\-restricted\fR
.RS 4
This has the same effect as in
\fBonsgmls(1)\fR\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Print the version number and exit\&.
.RE
.PP
\fB\-w\fR\fB\fItype\fR\fR, \fB\-\-warning=\fR\fB\fItype\fR\fR
.RS 4
Control warnings and errors according to type\&. This has the same effect as in
\fBonsgmls(1)\fR\&.
.RE
.PP
\fB\-x\fR\fB\fIxml_output_option\fR\fR, \fB\-\-xml\-output\-option=\fR\fB\fIxml_output_option\fR\fR
.RS 4
Control the XML output according to the value of
\fIxml_output_option\fR
as follows:
.sp
\fBno\-nl\-in\-tag\fR
Don\*(Aqt use newlines inside start\-tags\&. Usually
\fBosx\fR
uses newlines inside start\-tags so as to reduce the probability of excessively long lines\&.
.sp
\fBid\fR
Output attribute declarations for ID attributes\&.
.sp
\fBnotation\fR
Output declarations for notations\&.
.sp
\fBndata\fR
Output declarations for external data entities\&. XML requires these to be NDATA\&.
\fBosx\fR
will warn about CDATA and SDATA external data entities and output them as NDATA entities\&.
.sp
\fBcdata\fR
Use XML CDATA sections for CDATA marked sections and for elements with a declared content of CDATA\&.
.sp
\fBcomment\fR
Output comment declarations\&. Comment declarations in the DTD will not be output\&.
.sp
\fBlower\fR
Prefer lower case\&. Names that were subjected to upper\-case substitution by SGML will be folded to lower case\&. This does not include reserved names; XML requires these to be in upper\-case\&.
.sp
\fBpi\-escape\fR
Escape &<> in the contents of processing instructions using the amp, lt and gt entities\&. This allows processing instructions to contain the string >?, but requires that applications handle the escapes\&.
.sp
\fBempty\fR
Use the <e/> syntax for element types e declared as EMPTY\&.
.sp
\fBattlist\fR
Output an ATTLIST declaration for every element specifying the type of all attributes\&. The default will always be #IMPLIED\&.
.sp
\fBreport\-input\-sources\fR
Output a processing instruction to report when an input source other than the main file is opened or closed in the instance\&. Do not report any input source changes in the DTD\&.
.sp
\fBreport\-entities\fR
Output a processing instruction to report when an external entity reference has been resolved in the instance\&. Do not report any entity resolutions in the DTD\&.
.sp
\fBno\-expand\-external\fR
Preserve external entities, write a declaration driver file named "extEntities\&.dtf", and include that file in the instance\*(Aqs internal subset\&.
.sp
\fBno\-expand\-internal\fR
Preserve internal entities, write a declaration driver file named "intEntities\&.dtf", and include that file in the instance\*(Aqs internal subset\&.
.sp
\fBno\-external\-decl\fR
Do not include the external entities declaration driver file in the instance\*(Aqs internal subset\&.
.sp
\fBno\-internal\-decl\fR
Do not include the internal entities declaration driver file in the instance\*(Aqs internal subset\&.
.sp
\fBno\-output\-outside\-outdir\fR
When preserving external entities, do not write output files outside the specified output directory ("\&." by default)\&. In other words, if an external entity\*(Aqs system identifier includes enough instances of "\&.\&." to cause osx to write a file outside (above) the output directory, exit (by default osx will issue a warning but will write the file and continue\&.
.sp
\fBno\-overwrite\fR
When preserving internal or external entities, multiple output files will be written\&. If this option is specified, do not overwrite existing files; instead, attempt to append a number to the end of the original filename to create a unique filename\&. Exit with an error if too many (100) such files already exist\&.
.sp
\fBpreserve\-case\fR
Preserve casing as specified in the DTD for element names; attribute names; attribute values which are token lists\&.
.sp
\fBsdata\-as\-pis\fR
When translating SDATA entities (whether expanding them or providing a definition for them in the output\*(Aqs internal subset), express them as processing instructions instead of as general internal entities\&.
.sp
Multiple
\fB\-x\fR
options are allowed\&.
.RE
.SH "SEE ALSO"
.PP
\fBonsgmls(1)\fR,
\fBospam(1)\fR,
\fBosgmlnorm(1)\fR,
\fBospent(1)\fR
.SH "AUTHORS"
.PP
\fBJames Clark\fR
.RS 4
Author.
.RE
.PP
\fBIan Castle\fR <\&ian.castle@openjade.org\&>
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br