source: pst/sgml/opensp.xml@ f6f7820

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/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-size          "1.4 MB">
  <!ENTITY opensp-buildsize     "37 MB">
  <!ENTITY opensp-time          "1.50 SBU">
]>

<sect1 id="opensp" xreflabel="OpenSP-&opensp-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="opensp.html"?>
<title>OpenSP-&opensp-version;</title>

<sect2>
<title>Introduction to <application>OpenSP</application></title>

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

<sect3><title>Package information</title>
<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 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>
</sect3>

<sect3><title>Additional downloads</title>
<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 (if using 
<application>GCC</application>-3.4.x): <ulink 
url="&patch-root;/OpenSP-&opensp-version;-gcc34-1.patch"/></para></listitem>
</itemizedlist></sect3>

<sect3><title><application>OpenSP</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="sgml-common"/></para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>OpenSP</application></title>

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

<screen><userinput><command>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; &amp;&amp;
make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; install &amp;&amp;
ln -sf onsgmls /usr/bin/nsgmls &amp;&amp;
ln -sf osgmlnorm /usr/bin/sgmlnorm &amp;&amp;
ln -sf ospam /usr/bin/spam &amp;&amp;
ln -sf ospcat /usr/bin/spcat &amp;&amp;
ln -sf ospent /usr/bin/spent &amp;&amp;
ln -sf osx /usr/bin/sx &amp;&amp;
ln -sf osx /usr/bin/sgml2xml &amp;&amp;
ln -sf libosp.so /usr/lib/libsp.so &amp;&amp;
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>
<title>Command explanations</title>

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

<para><option>--enable-http</option>: This switch adds support
for <acronym>HTTP</acronym>.</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 <acronym>XML</acronym> 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><screen><command>ln -sf onsgmls /usr/bin/nsgmls
ln -sf osgmlnorm /usr/bin/sgmlnorm
ln -sf ospam /usr/bin/spam
ln -sf ospcat /usr/bin/spcat
ln -sf ospent /usr/bin/spent
ln -sf osx /usr/bin/sx
ln -sf osx /usr/bin/sgml2xml
ln -sf libosp.so /usr/lib/libsp.so</command></screen>
These commands create the <application>SP</application> equivalents of
<application>OpenSP</application> executables and libraries.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>OpenSP</application> package contains 
<command>onsgmls</command>,
<command>ospam</command>, <command>osx</command>,
<command>ospcat</command> and
<command>ospent</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>onsgmls</title>
<para><command>onsgmls</command> processes <acronym>SGML</acronym> 
files.</para></sect3>

<sect3><title>ospam</title>
<para><command>ospam</command> is a markup stream editor.</para></sect3>

<sect3><title>osx</title>
<para><command>osx</command> is a <acronym>SGML</acronym> normalizer or a 
converter of <acronym>SGML</acronym> to <acronym>XML</acronym>.</para></sect3>

<sect3><title>ospcat</title>
<para><command>ospcat</command> prints effective system identifiers found in 
the catalogs.</para></sect3>

<sect3><title>ospent</title>
<para><command>ospent</command> provides access to
<application>OpenSP</application>'s entity manager.</para></sect3>

</sect2>

</sect1>