glfs/pst/sgml/opensp.xml
Ken Moffat f89fc455b9 more tags
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@15909 af4574ff-66df-0310-9fd7-8a98e5e911e0
2015-05-01 01:41:31 +00:00

342 lines
12 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY opensp-download-http "&sourceforge-repo;/openjade/OpenSP-&opensp-version;.tar.gz">
<!ENTITY opensp-download-ftp " ">
<!--
<!ENTITY opensp-download-ftp "&gentoo-ftp-repo;/OpenSP-&opensp-version;.tar.gz">
-->
<!ENTITY opensp-md5sum "670b223c5d12cee40c9137be86b6c39b">
<!ENTITY opensp-size "1.5 MB">
<!ENTITY opensp-buildsize "32 MB">
<!ENTITY opensp-time "1.0 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>
&lfs77_checked; &gcc5_checked;
<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">OpenSP Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="sgml-common"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="xmlto"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/opensp"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of OpenSP</title>
<para>Install <application>OpenSP</application> by running the following
commands:</para>
<screen><userinput>sed -i 's/32,/253,/' lib/Syntax.cxx &amp;&amp;
sed -i 's/LITLEN 240 /LITLEN 8092/' \
unicode/{gensyntax.pl,unicode.syn} &amp;&amp;
./configure --prefix=/usr \
--disable-static \
--disable-doc-build \
--enable-default-catalog=/etc/sgml/catalog \
--enable-http \
--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
nine of the 23 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; \
docdir=/usr/share/doc/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>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para><parameter>sed -i 's/32,/253,/...unicode.syn}</parameter>:
These seds prevent some annoying messages that may otherwise appear
while running <command>openjade</command>.</para>
<para><parameter>--disable-static</parameter>: This switch prevents
the building of the static library.</para>
<!-- Why don't we want the static library? -->
<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><option>--disable-doc-build</option>: This switch prevents the
<command>configure</command> script checking if you have
<application>xmlto</application> installed. If you have
<application>xmlto</application>, you can remove this option.</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="b-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="b-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="b-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="b-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="b-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="b-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="b-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="c-libsp">libsp.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>