Blame docsrc/osgmlnorm.xml.manpage

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