doc/sx.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML Strict//EN">
   2 <HTML>
   3 <HEAD>
   4 <TITLE>OSX</TITLE>
   5 </HEAD>
   6 <BODY>
   7 <H1>OSX</H1>
   8 <H4>
   9 An SGML System Conforming to International Standard ISO 8879 --
  10 Standard Generalized Markup Language
  11 </H4>
  12 <H4>
  13 An SGML Extended Facilities system conforming to
  14 Annex A of International Standard ISO/IEC 10744 --
  15 Hypermedia/Time-based Structuring Language
  16 </H4>
  17 <H2>
  18 SYNOPSIS
  19 </H2>
  20 <P>
  21 <CODE>osx</CODE> [ <CODE>option...</CODE> ] <CODE><VAR>sysid...</VAR></CODE>
  22 <H2>DESCRIPTION</H2>
  23 <P>
  24 Osx converts SGML to XML.
  25 Osx parses and validates the SGML document contained in
  26 <CODE><VAR>sysid...</VAR></CODE>
  27 and writes an equivalent XML document to the standard output.
  28 Osx will warn about SGML constructs which have no XML equivalent.
  29 <H2>OPTIONS</H2>
  30 <P>
  31 The following options are available:
  32 <DL>
  33 <DT>
  34 <CODE>-b<VAR>name</VAR></CODE>,
  35 <CODE>--encoding=<VAR>name</VAR></CODE>
  36 <DD>
  37 Use the <A HREF="sysid.htm#encodings">BCTF</A> <VAR>name</VAR> for output.
  38 By default osx uses UTF-8.
  39 <DT>
  40 <CODE>-c<VAR>sysid</VAR></CODE>,
  41 <CODE>--catalog=<VAR>sysid</VAR></CODE>
  42 <DD>
  43 Map public identifiers and entity names to system identifiers
  44 using the catalog entry file whose system identifier is <VAR>sysid</VAR>.
  45 This has the same effect as in <A HREF="nsgmls.htm#optc">onsgmls</A>.
  46 <DT>
  47 <CODE>-C</CODE>,
  48 <CODE>--catalogs</CODE>
  49 <DD>
  50 This has the same effect as in <A HREF="nsgmls.htm#optC">onsgmls</A>.
  51 <DT>
  52 <CODE>-d<VAR>directory</VAR></CODE>
  53 <DD>
  54 Place output files in
  55 <CODE><VAR>directory</VAR></CODE>.
  56 <DT>
  57 <CODE>-D<VAR>directory</VAR></CODE>,
  58 <CODE>--directory=<VAR>directory</VAR></CODE>
  59 <DD>
  60 Search
  61 <CODE><VAR>directory</VAR></CODE>
  62 for files specified in system identifiers.
  63 This has the same effect as in <A HREF="nsgmls.htm#optD">onsgmls</A>.
  64 <DT>
  65 <CODE>-e</CODE>,
  66 <CODE>--open-entities</CODE>
  67 <DD>
  68 Describe open entities in error messages.
  69 <DT>
  70 <CODE>-f<VAR>file</VAR></CODE>,
  71 <CODE>--error-file=<VAR>file</VAR></CODE>
  72 <DD>
  73 Redirect errors to
  74 <CODE><VAR>file</VAR></CODE>.
  75 This is useful mainly with shells that do not support redirection
  76 of stderr.
  77 <DT>
  78 <CODE>-i<VAR>name</VAR></CODE>,
  79 <CODE>--include=<VAR>name</VAR></CODE>
  80 <DD>
  81 This has the same effect as in <A HREF="nsgmls.htm#opti">onsgmls</A>.
  82 <DT>
  83 <CODE>-l<VAR>dtd_file</VAR></CODE>
  84 <DD>
  85 Specify that the resulting XML file should conform to the DTD in
  86 <CODE><VAR>dtd_file</VAR></CODE>.
  87 <DT>
  88 <CODE>-R</CODE>,
  89 <CODE>--restricted</CODE>
  90 <DD>
  91 This has the same effect as in <A HREF="nsgmls.htm#optR">onsgmls</A>.
  92 <DT>
  93 <CODE>-v</CODE>,
  94 <CODE>--version</CODE>
  95 <DD>
  96 Print the version number.
  97 <DT>
  98 <CODE>-w<VAR>type</VAR></CODE>,
  99 <CODE>--warning=<VAR>type</VAR></CODE>
 100 <DD>
 101 Control warnings and errors according to
 102 <CODE><VAR>type</VAR></CODE>.
 103 This has the same effect as in <A HREF="nsgmls.htm#optw">onsgmls</A>.
 104 <DT>
 105 <CODE>-x<VAR>option</VAR></CODE>,
 106 <CODE>--xml-output-option=<VAR>option</VAR></CODE>
 107 <DD>
 108 Control the XML output according to the value of
 109 <CODE><VAR>option</VAR></CODE> as follows:
 110 <DL>
 111 <DT>
 112 <CODE>no-nl-in-tag</CODE>
 113 <DD>
 114 Don't use newlines inside start-tags.
 115 Usually osx uses newlines inside start-tags so as to reduce the
 116 probability of excessively long lines.
 117 <DT>
 118 <CODE>id</CODE>
 119 <DD>
 120 Output attribute declarations for ID attributes.
 121 <DT>
 122 <CODE>notation</CODE>
 123 <DD>
 124 Output declarations for notations.
 125 <DT>
 126 <CODE>ndata</CODE>
 127 <DD>
 128 Output declarations for external data entities.
 129 XML requires these to be NDATA.
 130 Osx will warn about CDATA and SDATA external data entities and
 131 output them as NDATA entities.
 132 <DT>
 133 <CODE>cdata</CODE>
 134 <DD>
 135 Use XML CDATA sections for CDATA marked sections and for elements with a
 136 declared content of CDATA.
 137 <DT>
 138 <CODE>comment</CODE>
 139 <DD>
 140 Output comment declarations.  Comment declarations in the DTD will not
 141 be output.
 142 <DT>
 143 <CODE>lower</CODE>
 144 <DD>
 145 Prefer lower case.
 146 Names that were subjected to upper-case substitution by SGML will be folded
 147 to lower case.
 148 This does not include reserved names; XML requires these to be in upper-case.
 149 <DT>
 150 <CODE>pi-escape</CODE>
 151 <DD>
 152 Escape <CODE>&amp;&lt;&gt;</CODE> in the contents of processing
 153 instructions using the <CODE>amp</CODE>, <CODE>lt</CODE> and
 154 <CODE>gt</CODE> entities.  This allows processing instructions to
 155 contain the string <CODE>&gt;?</CODE>, but requires that applications
 156 handle the escapes.
 157 <DT>
 158 <CODE>empty</CODE>
 159 <DD>
 160 Use the <CODE>&lt;<VAR>e</VAR>/&gt;</CODE> syntax for element types
 161 <CODE><VAR>e</VAR></CODE> declared as EMPTY.
 162 <DT>
 163 <CODE>attlist</CODE>
 164 <DD>
 165 Output a ATTLIST declaration for every element specifying the type of
 166 all attributes.  The default will always be <CODE>#IMPLIED</CODE>.
 167 <DT>
 168 <CODE>report-input-sources</CODE>
 169 <DD>
 170 Output a processing instruction to report when an input source other
 171 than the main file is opened or closed in the instance. Do not report
 172 any input source changes in the DTD.
 173 <DT>
 174 <CODE>report-entities</CODE>
 175 <DD>
 176 Output a processing instruction to report when an external entity
 177 reference has been resolved in the instance. Do not report any entity
 178 resolutions in the DTD.
 179 <DT>
 180 <CODE>no-expand-external</CODE>
 181 <DD>
 182 Preserve external entities (producing a new output file for each input file processed), write a declaration driver file named "extEntities.dtf", and include that file in the instance's internal subset.
 183 <DT>
 184 <CODE>no-expand-internal</CODE>
 185 <DD>
 186 Preserve internal entities, write a declaration driver file named "intEntities.dtf", and include that file in the instance's internal subset.
 187 <DT>
 188 <CODE>preserve-case</CODE>
 189 <DD>
 190 Preserve casing as specified in the DTD for element names; attribute names; attribute values which are token lists.
 191 <DT>
 192 <CODE>no-external-decl
 193 <DD>
 194 Do not include the external entities declaration driver file in the instance's internal subset.
 195 <DT>
 196 <CODE>no-internal-decl
 197 <DD>
 198 Do not include the internal entities declaration driver file in the instance's internal subset.
 199 <DT>
 200 <CODE>sdata-as-pis
 201 <DD>
 202 When translating SDATA entities (whether expanding them or providing a
 203 definition for them in the output's internal subset), express them as
 204 processing instructions instead of as general internal entities.
 205 <DT>
 206 <CODE>no-output-outside-outdir
 207 <DD>
 208 When preserving external entities, do not write output files outside the specified output directory ("." by default). In other words, if an external entity's 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.)
 209 <DT>
 210 <CODE>no-overwrite
 211 <DD>
 212 When preserving internal or external entities, multiple output files will be written.
 213 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.
 214 Exit with an error if too many (100) such files already exist.
 215 </DL>
 216 <P>
 217 Multiple
 218 <CODE>-x</CODE>
 219 options are allowed.
 220 </DL>
 221 </BODY>
 222 </HTML>