source: pst/sgml/opensp.xml@ ea92fe5

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY opensp-download-http "http://download.sourceforge.net/openjade/OpenSP-&opensp-version;.tar.gz">
  <!ENTITY opensp-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/OpenSP-&opensp-version;.tar.gz">
  <!ENTITY opensp-md5sum        "f46fe0a04b76a4454ec27b7fcc84ec54">
  <!ENTITY opensp-size          "1.4 MB">
  <!ENTITY opensp-buildsize     "43 MB">
  <!ENTITY opensp-time          "0.97 SBU">
]>

<sect1 id="opensp" xreflabel="OpenSP-&opensp-version;">
  <?dbhtml filename="opensp.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>OpenSP-&opensp-version;</title>

  <indexterm zone="opensp">
    <primary sortas="a-OpenSP">OpenSP</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to OpenSP</title>

    <para>The <application>OpenSP</application> package contains a
    <application>C++</application> library for using SGML/XML files.
    This is useful for validating, parsing and manipulating SGML and XML
    documents.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&opensp-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&opensp-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &opensp-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &opensp-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &opensp-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &opensp-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch (removes some annoying messages that can appear
        while running <command>openjade</command>): <ulink
        url="&patch-root;/OpenSP-&opensp-version;-LITLEN-1.patch"/></para>
      </listitem>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/OpenSP-&opensp-version;-gcc34-1.patch"/></para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">OpenSP Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="sgml-common"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of OpenSP</title>

    <para>Install <application>OpenSP</application> by running the following
    commands:</para>

<screen><userinput>patch -Np1 -i ../OpenSP-&opensp-version;-LITLEN-1.patch &amp;&amp;
patch -Np1 -i ../OpenSP-&opensp-version;-gcc34-1.patch &amp;&amp;
./configure --prefix=/usr --disable-static --enable-http \
    --enable-default-catalog=/etc/sgml/catalog \
    --enable-default-search-path=/usr/share/sgml &amp;&amp;
make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</userinput></screen>

    <para>To test the results, issue <command>make check</command>. As many as
    eight of the 22 tests may fail. Do not be alarmed.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; install &amp;&amp;
ln -v -sf onsgmls /usr/bin/nsgmls &amp;&amp;
ln -v -sf osgmlnorm /usr/bin/sgmlnorm &amp;&amp;
ln -v -sf ospam /usr/bin/spam &amp;&amp;
ln -v -sf ospcat /usr/bin/spcat &amp;&amp;
ln -v -sf ospent /usr/bin/spent &amp;&amp;
ln -v -sf osx /usr/bin/sx &amp;&amp;
ln -v -sf osx /usr/bin/sgml2xml &amp;&amp;
ln -v -sf libosp.so /usr/lib/libsp.so</userinput></screen>

<!--
install-catalog -add /etc/sgml/OpenSP-&opensp-version;.cat \
    /usr/share/sgml/OpenSP-&opensp-version;/catalog &amp;&amp;
install-catalog -add /etc/sgml/sgml-docbook.cat \
    /etc/sgml/OpenSP-&opensp-version;.cat</command></userinput></screen>

<tip><title>Update hint</title>
<para>Remove the above catalog items prior to upgrading with:
<screen><command>install-catalog -remove /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat \
    /usr/share/sgml/OpenSP-<replaceable>[version]</replaceable>/catalog &amp;&amp;
install-catalog -remove /etc/sgml/sgml-docbook.cat \
    /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat</command></screen></para></tip>
 -->

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--disable-static</parameter>: This switch prevents
    the building of the static library.</para>

    <para><parameter>--enable-http</parameter>: This switch adds support
    for HTTP.</para>

    <para><parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>:
    This switch sets the path to the centralized catalog.</para>

    <para><parameter>--enable-default-search-path</parameter>: This switch
    sets the default value of <envar>SGML_SEARCH_PATH</envar>.</para>

    <para><option>--enable-xml-messages</option>: This switch adds
    support for XML Formatted Messages.</para>

    <para><command>make
    pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</command>: This sets the
    pkgdatadir variable in the <filename>Makefile</filename> from
    <filename class="directory">/usr/share/OpenSP</filename> to <filename
    class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.</para>

    <para><command>ln -v -sf ...</command>: These commands create the
    <application>SP</application> equivalents of
    <application>OpenSP</application> executables and libraries.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>onsgmls, osgmlnorm, ospam, ospcat, ospent, osx, and the
        <application>SP</application> equivalent symlinks: nsgmls, sgml2xml,
        sgmlnorm, spam, spcat, spent, and sx</seg>
        <seg>libosp.so and the <application>SP</application> equivalent symlink:
        libsp.so</seg>
        <seg>/usr/include/OpenSP, /usr/share/doc/OpenSP, and
        /usr/share/sgml/OpenSP-&opensp-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="onsgmls">
        <term><command>onsgmls</command></term>
        <listitem>
          <para>is used to process SGML files.</para>
          <indexterm zone="opensp onsgmls">
            <primary sortas="b-onsgmls">onsgmls</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="osgmlnorm">
        <term><command>osgmlnorm</command></term>
        <listitem>
          <para>prints on the standard output a normalized document instance
          for the SGML document contained in the concatenation of the entities
          with system identifiers .nf and .fi.</para>
          <indexterm zone="opensp osgmlnorm">
            <primary sortas="b-osgmlnorm">osgmlnorm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ospam">
        <term><command>ospam</command></term>
        <listitem>
          <para>is a markup stream editor.</para>
          <indexterm zone="opensp ospam">
            <primary sortas="b-ospam">ospam</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ospcat">
        <term><command>ospcat</command></term>
        <listitem>
          <para>prints effective system identifiers found in the catalogs.</para>
          <indexterm zone="opensp ospcat">
            <primary sortas="b-ospcat">ospcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ospent">
        <term><command>ospent</command></term>
        <listitem>
          <para>provides access to <application>OpenSP</application>'s
          entity manager.</para>
          <indexterm zone="opensp ospent">
            <primary sortas="b-ospent">ospent</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="osx">
        <term><command>osx</command></term>
        <listitem>
          <para>is an SGML normalizer or used to convert
          SGML files to XML files.</para>
          <indexterm zone="opensp osx">
            <primary sortas="b-osx">osx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nsgmls">
        <term><command>nsgmls</command></term>
        <listitem>
          <para>is a symlink to <command>onsgmls</command>.</para>
          <indexterm zone="opensp nsgmls">
            <primary sortas="g-nsgmls">nsgmls</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sgml2xml">
        <term><command>sgml2xml</command></term>
        <listitem>
          <para>is a symlink to <command>osx</command>.</para>
          <indexterm zone="opensp sgml2xml">
            <primary sortas="g-sgml2xml">sgml2xml</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sgmlnorm">
        <term><command>sgmlnorm</command></term>
        <listitem>
          <para>is a symlink to <command>osgmlnorm</command>.</para>
          <indexterm zone="opensp sgmlnorm">
            <primary sortas="g-sgmlnorm">sgmlnorm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spam">
        <term><command>spam</command></term>
        <listitem>
          <para>is a symlink to <command>ospam</command>.</para>
          <indexterm zone="opensp spam">
            <primary sortas="g-spam">spam</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spcat">
        <term><command>spcat</command></term>
        <listitem>
          <para>is a symlink to <command>ospcat</command>.</para>
          <indexterm zone="opensp spcat">
            <primary sortas="g-spcat">spcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="spent">
        <term><command>spent</command></term>
        <listitem>
          <para>is a symlink to <command>ospent</command>.</para>
          <indexterm zone="opensp spent">
            <primary sortas="g-spent">spent</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sx">
        <term><command>sx</command></term>
        <listitem>
          <para>is a symlink to <command>osx</command>.</para>
          <indexterm zone="opensp sx">
            <primary sortas="g-sx">sx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libosp">
        <term><filename class='libraryfile'>libosp.so</filename></term>
        <listitem>
          <para>contains functions required by the
          <application>OpenSP</application> programs to parse, validate and
          manipulate SGML and XML files.</para>
          <indexterm zone="opensp libosp">
            <primary sortas="c-libosp">libosp.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsp">
        <term><filename class='libraryfile'>libsp.so</filename></term>
        <listitem>
          <para>is a symlink to
          <filename class='libraryfile'>libosp.so</filename>.</para>
          <indexterm zone="opensp libsp">
            <primary sortas="g-libsp">libsp.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>