Blame docsrc/osgmlnorm.xml

Packit 8a864e
Packit 8a864e
Packit 8a864e
 "/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd">
Packit 8a864e
<article>
Packit 8a864e
  <articleinfo>
Packit 8a864e
    <title>osgmlnorm</title>
Packit 8a864e
    <author>
Packit 8a864e
      <firstname>James</firstname>
Packit 8a864e
      <surname>Clark</surname>
Packit 8a864e
    </author>
Packit 8a864e
    <author>
Packit 8a864e
      <firstname>Ian</firstname>
Packit 8a864e
      <surname>Castle</surname>
Packit 8a864e
      <affiliation><address><email>ian.castle@openjade.org</email></address></affiliation>
Packit 8a864e
    </author>
Packit 8a864e
    <copyright>
Packit 8a864e
      <year>2002</year>
Packit 8a864e
      <holder>OpenJade Project</holder>
Packit 8a864e
    </copyright>
Packit 8a864e
  </articleinfo>
Packit 8a864e
Packit 8a864e
  <section>
Packit 8a864e
    <title>Reference</title>
Packit 8a864e
    
Packit 8a864e
    <refentry>
Packit 8a864e
      <refentryinfo>
Packit 8a864e
        <title>osgmlnorm</title>
Packit 8a864e
        <date>January 2002</date>
Packit 8a864e
        <productname>OpenJade</productname>
Packit 8a864e
      </refentryinfo>
Packit 8a864e
Packit 8a864e
      <refmeta>
Packit 8a864e
        <refentrytitle>osgmlnorm</refentrytitle>
Packit 8a864e
        <manvolnum>1</manvolnum>
Packit 8a864e
      </refmeta>
Packit 8a864e
Packit 8a864e
      <refnamediv>
Packit 8a864e
        <refname>osgmlnorm</refname>
Packit 8a864e
	<refpurpose>An SGML/XML document normalizer</refpurpose>
Packit 8a864e
      </refnamediv>
Packit 8a864e
Packit 8a864e
      <refsynopsisdiv>
Packit 8a864e
        <cmdsynopsis>
Packit 8a864e
          <command>osgmlnorm</command>
Packit 8a864e
          <arg choice="opt"><option>-CdeghmnrRvx</option></arg>
Packit 8a864e
          <arg choice="opt"><option>-a<replaceable>linktype</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt"><option>-A<replaceable>architecture</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt"><option>-b<replaceable>bctf</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt"><option>-c<replaceable>catalog</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt" rep="repeat"><option>-D<replaceable>directory</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt" rep="repeat"><option>-E<replaceable>max_errors</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt" rep="repeat"><option>-i<replaceable>name</replaceable></option></arg>
Packit 8a864e
          <arg choice="opt" rep="repeat"><option>-f<replaceable>name</replaceable></option></arg>
Packit 8a864e
	  <arg choice="opt" rep="repeat"><option>-w<replaceable>warning</replaceable></option></arg>
Packit 8a864e
          <arg rep="repeat"><replaceable>sysid</replaceable></arg>
Packit 8a864e
    
Packit 8a864e
Packit 8a864e
   sgmlnorm [ -Cdemnv ] [ -bbctf ] [ -ccatalog ] [ -Ddir ] [ -iname ] [
Packit 8a864e
   -wwarning ] sysid...
Packit 8a864e
-->
Packit 8a864e
        </cmdsynopsis>
Packit 8a864e
      </refsynopsisdiv>
Packit 8a864e
   
Packit 8a864e
      <refsect1>
Packit 8a864e
        <title>Description</title>
Packit 8a864e
Packit 8a864e
   <para><command>osgmlnorm</command> prints on the standard output a normalized document instance
Packit 8a864e
   for the SGML document contained in the concatenation of the entities
Packit 8a864e
   with system identifiers <cmdsynopsis><arg rep="repeat"><replaceable>sysid</replaceable></arg></cmdsynopsis>.</para>
Packit 8a864e
   
Packit 8a864e
   <para>When the normalized instance is prefixed with the original SGML
Packit 8a864e
   declaration and prolog, it will have the same ESIS as the original
Packit 8a864e
   SGML document, with the following exceptions:</para>
Packit 8a864e
<para>* The output of osgmlnorm does not protect against the recognition of
Packit 8a864e
       short reference delimiters, so any USEMAP declarations must be
Packit 8a864e
       removed from the DTD.</para>
Packit 8a864e
     <para>* The normalized instance will use the reference delimiters, even if
Packit 8a864e
       the original instance did not.</para>
Packit 8a864e
     <para>* If marked sections are included in the output using the -m option,
Packit 8a864e
       the reference reserved names will be used for the status keywords
Packit 8a864e
       even if the original instance did not.</para>
Packit 8a864e
     <para>* Any ESIS information relating to the SGML LINK feature will be
Packit 8a864e
       lost.</para>
Packit 8a864e
       
Packit 8a864e
   <para>The normalized instance will not use any markup minimization features
Packit 8a864e
   except that:</para>
Packit 8a864e
<para>* Any attributes that were not specified in the original instance
Packit 8a864e
       will not be included in the normalized instance. (Current
Packit 8a864e
       attributes will be included.)</para>
Packit 8a864e
     <para>* If the declared value of an attribute was a name token group, and
Packit 8a864e
       a value was specified that was the same as the name of the
Packit 8a864e
       attribute, then the attribute name and value indicator will be
Packit 8a864e
       omitted. For example, with HTML osgmlnorm would output <DL COMPACT>
Packit 8a864e
       rather than <DL COMPACT="COMPACT"></para>
Packit 8a864e
       
Packit 8a864e
        <para>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.</para>
Packit 8a864e
   <para>The following options are available:</para>
Packit 8a864e
   
Packit 8a864e
   <variablelist>
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-a<replaceable>name</replaceable></option></term>
Packit 8a864e
       <term><option>--activate=<replaceable>name</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Make doctype or linktype <replaceable>name</replaceable> active.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-A<replaceable>architecture</replaceable></option></term>
Packit 8a864e
       <term><option>--architecture=<replaceable>architecture</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Parse with respect to architecture <replaceable>architecture</replaceable>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-b<replaceable>bctf</replaceable></option></term>
Packit 8a864e
       <term><option>--bctf=<replaceable>bctf</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Use the BCTF with name <replaceable>bctf</replaceable> for output.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-c<replaceable>sysid</replaceable></option></term>
Packit 8a864e
       <term><option>--catalog=<replaceable>sysid</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Map public identifiers and entity names to system identifiers
Packit 8a864e
          using the catalog entry file whose system identifier is
Packit 8a864e
          <replaceable>sysid</replaceable>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-C</option></term>
Packit 8a864e
       <term><option>--catalogs</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-d</option></term>
Packit 8a864e
       <term><option>--dtd</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Output a document type declaration with the same external
Packit 8a864e
          identifier as the input document, and with no internal
Packit 8a864e
          declaration subset. No check is performed that the document
Packit 8a864e
          instance is valid with respect to this DTD.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-D<replaceable>directory</replaceable></option></term>
Packit 8a864e
       <term><option>--directory=<replaceable>directory</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Search <replaceable>directory</replaceable> for files specified in system identifiers.</para>
Packit 8a864e
          <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-e</option></term>
Packit 8a864e
       <term><option>--open-entities</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Describe open entities in error messages.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>--error-numbers</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Show error numbers in error messages.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit Service f4b535
Packit Service f4b535
     <varlistentry>
Packit Service f4b535
       <term><option>-g</option></term>
Packit Service f4b535
       <term><option>--open-elements</option></term>
Packit Service f4b535
         <listitem>
Packit Service f4b535
           <para>Show the generic identifiers of open elements in error
Packit Service f4b535
           messages.</para>
Packit Service f4b535
         </listitem>
Packit Service f4b535
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-h</option></term>
Packit 8a864e
       <term><option>--help</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Display a help text and exit.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-i<replaceable>name</replaceable></option></term>
Packit 8a864e
       <term><option>--include=<replaceable>name</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
          
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-m</option></term>
Packit 8a864e
       <term><option>--marked-sections</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Output any marked sections that were in the input document
Packit 8a864e
          instance.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-n</option></term>
Packit 8a864e
       <term><option>--comments</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Output any comments that were in the input document instance.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-r</option></term>
Packit 8a864e
       <term><option>--raw</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Raw output. Don't perform any conversion on RSs and REs when
Packit 8a864e
          printing the entity. The entity would typically have the
Packit 8a864e
          storage manager attribute records=asis.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-R</option></term>
Packit 8a864e
       <term><option>--restricted</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-v</option></term>
Packit 8a864e
       <term><option>--version</option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Print the version number.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
Packit 8a864e
     <varlistentry>
Packit 8a864e
       <term><option>-w<replaceable>type</replaceable></option></term>
Packit 8a864e
       <listitem>
Packit 8a864e
          <para>Control warnings and errors according to type. This has the
Packit 8a864e
          same effect as in <command>onsgmls(1)</command>.</para>
Packit 8a864e
       </listitem>
Packit 8a864e
     </varlistentry>
Packit 8a864e
     </variablelist>
Packit 8a864e
   </refsect1>
Packit 8a864e
Packit 8a864e
   <refsect1>
Packit 8a864e
     <title>See Also</title>
Packit 8a864e
     <para><command>onsgmls(1)</command>, <command>ospam(1)</command>,
Packit 8a864e
     <command>ospent(1)</command>, <command>osx(1)</command></para>
Packit 8a864e
   </refsect1>
Packit 8a864e
 </refentry>
Packit 8a864e
</section>
Packit 8a864e
</article>