1OSX(1)                             Reference                            OSX(1)
2
3
4

NAME

6       osx - An SGML to XML converter
7

SYNOPSIS

9       osx [-CeghnRvx] [-aname] [-Aarchitecture] [-bencoding] [-ccatalog_file]
10           [-ddirectory] [-Ddirectory] [-iname] [-ffile] [-ldtd_file]
11           [-wwarning_type] [-xxml_output_option...] [sysid...]
12

DESCRIPTION

14       osx converts SGML to XML.  osx parses and validates the SGML document
15       contained in
16
17       and writes an equivalent XML document to the standard output.  osx will
18        warn about SGML constructs which have no XML equivalent.
19
20       Part of an SGML System Conforming to International Standard ISO 8879 --
21       Standard Generalized Markup Language. An SGML Extended Facilities
22       system conforming to Annex A of International Standard ISO/IEC 10744 --
23       Hypermedia/Time-based Structuring Language.
24

OPTIONS

26       The following options are available:
27
28       -aname, --activate=name
29           Make doctype or linkname name active.
30
31       -Aname, --architecture=name
32           Parse with respect to architecture name.
33
34       -bencoding, --encoding=encoding
35           Use the BCTF encoding for output. By default osx uses UTF-8.
36
37       -csysid, --catalog=sysid
38           Map public identifiers and entity names to system identifiers using
39           the catalog entry file whose system identifier is sysid.
40
41       -C, --catalogs
42           This has the same effect as in onsgmls(1).
43
44       -ddirectory, --entity_output_location=directory
45           Place output files in directory.
46
47       -Ddirectory, --directory=directory
48           Search directory for files specified in system identifiers. This
49           has the same effect as in onsgmls(1).
50
51       -e, --open-entities
52           Describe open entities in error messages.
53
54       -Emax_errors, --max-errors=max_errors
55           Give up after max_errors errors.
56
57       -ffile, --error-file=file
58           Redirect errors to file. This is useful mainly with shells that do
59           not support redirection of stderr.
60
61       -g, --open-elements
62           Describe open elements in error messages.
63
64       -h, --help
65           Display a help text and exit.
66
67       -iname, --include=name
68           This has the same effect as in onsgmls(1).
69
70       -ldtd-file, --dtd_location=dtd-file
71           Specify that the resulting XML file should conform to the DTD in
72           dtd-file.
73
74       -n, --error-numbers
75           Show error numbers in error messages.
76
77       --references
78           Show references in error messages.
79
80       -R, --restricted
81           This has the same effect as in onsgmls(1).
82
83       -v, --version
84           Print the version number and exit.
85
86       -wtype, --warning=type
87           Control warnings and errors according to type. This has the same
88           effect as in onsgmls(1).
89
90       -xxml_output_option, --xml-output-option=xml_output_option
91           Control the XML output according to the value of xml_output_option
92           as follows:
93
94           no-nl-in-tag Don't use newlines inside start-tags. Usually osx uses
95           newlines inside start-tags so as to reduce the probability of
96           excessively long lines.
97
98           id Output attribute declarations for ID attributes.
99
100           notation Output declarations for notations.
101
102           ndata Output declarations for external data entities. XML requires
103           these to be NDATA.  osx will warn about CDATA and SDATA external
104           data entities and output them as NDATA entities.
105
106           cdata Use XML CDATA sections for CDATA marked sections and for
107           elements with a declared content of CDATA.
108
109           comment Output comment declarations. Comment declarations in the
110           DTD will not be output.
111
112           lower Prefer lower case. Names that were subjected to upper-case
113           substitution by SGML will be folded to lower case. This does not
114           include reserved names; XML requires these to be in upper-case.
115
116           pi-escape Escape &<> in the contents of processing instructions
117           using the amp, lt and gt entities. This allows processing
118           instructions to contain the string >?, but requires that
119           applications handle the escapes.
120
121           empty Use the <e/> syntax for element types e declared as EMPTY.
122
123           attlist Output an ATTLIST declaration for every element specifying
124           the type of all attributes. The default will always be #IMPLIED.
125
126           report-input-sources Output a processing instruction to report when
127           an input source other than the main file is opened or closed in the
128           instance. Do not report any input source changes in the DTD.
129
130           report-entities Output a processing instruction to report when an
131           external entity reference has been resolved in the instance. Do not
132           report any entity resolutions in the DTD.
133
134           no-expand-external Preserve external entities, write a declaration
135           driver file named "extEntities.dtf", and include that file in the
136           instance's internal subset.
137
138           no-expand-internal Preserve internal entities, write a declaration
139           driver file named "intEntities.dtf", and include that file in the
140           instance's internal subset.
141
142           no-external-decl Do not include the external entities declaration
143           driver file in the instance's internal subset.
144
145           no-internal-decl Do not include the internal entities declaration
146           driver file in the instance's internal subset.
147
148           no-output-outside-outdir When preserving external entities, do not
149           write output files outside the specified output directory ("." by
150           default). In other words, if an external entity's system identifier
151           includes enough instances of ".." to cause osx to write a file
152           outside (above) the output directory, exit (by default osx will
153           issue a warning but will write the file and continue.
154
155           no-overwrite When preserving internal or external entities,
156           multiple output files will be written. If this option is specified,
157           do not overwrite existing files; instead, attempt to append a
158           number to the end of the original filename to create a unique
159           filename. Exit with an error if too many (100) such files already
160           exist.
161
162           preserve-case Preserve casing as specified in the DTD for element
163           names; attribute names; attribute values which are token lists.
164
165           sdata-as-pis When translating SDATA entities (whether expanding
166           them or providing a definition for them in the output's internal
167           subset), express them as processing instructions instead of as
168           general internal entities.
169
170           Multiple -x options are allowed.
171

SEE ALSO

173       onsgmls(1), ospam(1), onsgmlnorm(1), ospent(1)
174

AUTHORS

176       James Clark
177           Author.
178
179       Ian Castle <ian.castle@openjade.org>
180           Author.
181

183OpenJade                         November 2002                          OSX(1)
Impressum