[e7323adb] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[50d3491a] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[f6f7820] | 6 |
|
---|
[50d3491a] | 7 | <!ENTITY opensp-download-http "http://download.sourceforge.net/openjade/OpenSP-&opensp-version;.tar.gz">
|
---|
[cb6de2e] | 8 | <!ENTITY opensp-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/OpenSP-&opensp-version;.tar.gz">
|
---|
[c2a37a6] | 9 | <!ENTITY opensp-md5sum "f46fe0a04b76a4454ec27b7fcc84ec54">
|
---|
[50d3491a] | 10 | <!ENTITY opensp-size "1.4 MB">
|
---|
[b650556] | 11 | <!ENTITY opensp-buildsize "43 MB">
|
---|
[dbfc8e65] | 12 | <!ENTITY opensp-time "0.97 SBU">
|
---|
[50d3491a] | 13 | ]>
|
---|
| 14 |
|
---|
[8223b66] | 15 | <sect1 id="opensp" xreflabel="OpenSP-&opensp-version;">
|
---|
[e7323adb] | 16 | <?dbhtml filename="opensp.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[d352a28] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">OpenSP-&opensp-version;.tar</keyword>
|
---|
[f1283d3f] | 23 | <keyword role="ftpdir">OpenSP</keyword>
|
---|
[d352a28] | 24 | </keywordset>
|
---|
[e7323adb] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>OpenSP-&opensp-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="opensp">
|
---|
| 30 | <primary sortas="a-OpenSP">OpenSP</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to OpenSP</title>
|
---|
| 35 |
|
---|
| 36 | <para>The <application>OpenSP</application> package contains a
|
---|
| 37 | <application>C++</application> library for using SGML/XML files.
|
---|
| 38 | This is useful for validating, parsing and manipulating SGML and XML
|
---|
| 39 | documents.</para>
|
---|
| 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (HTTP): <ulink url="&opensp-download-http;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (FTP): <ulink url="&opensp-download-ftp;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download MD5 sum: &opensp-md5sum;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download size: &opensp-size;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated disk space required: &opensp-buildsize;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Estimated build time: &opensp-time;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | </itemizedlist>
|
---|
| 62 |
|
---|
| 63 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 64 | <itemizedlist spacing='compact'>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>Required Patch (removes some annoying messages that can appear
|
---|
| 67 | while running <command>openjade</command>): <ulink
|
---|
| 68 | url="&patch-root;/OpenSP-&opensp-version;-LITLEN-1.patch"/></para>
|
---|
| 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>Required Patch: <ulink
|
---|
| 72 | url="&patch-root;/OpenSP-&opensp-version;-gcc34-1.patch"/></para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect3">OpenSP Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[d352a28] | 79 | <para role="required"><xref linkend="sgml-common"/></para>
|
---|
[e7323adb] | 80 |
|
---|
| 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of OpenSP</title>
|
---|
| 85 |
|
---|
| 86 | <para>Install <application>OpenSP</application> by running the following
|
---|
| 87 | commands:</para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput>patch -Np1 -i ../OpenSP-&opensp-version;-LITLEN-1.patch &&
|
---|
[f3ed6a7] | 90 | patch -Np1 -i ../OpenSP-&opensp-version;-gcc34-1.patch &&
|
---|
| 91 | ./configure --prefix=/usr --disable-static --enable-http \
|
---|
[50d3491a] | 92 | --enable-default-catalog=/etc/sgml/catalog \
|
---|
| 93 | --enable-default-search-path=/usr/share/sgml &&
|
---|
[e7323adb] | 94 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</userinput></screen>
|
---|
[dbfc8e65] | 95 |
|
---|
[ea92fe5] | 96 | <para>To test the results, issue <command>make check</command>. As many as
|
---|
| 97 | eight of the 22 tests may fail. Do not be alarmed.</para>
|
---|
| 98 |
|
---|
[e7323adb] | 99 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[dbfc8e65] | 100 |
|
---|
[e7323adb] | 101 | <screen role="root"><userinput>make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; install &&
|
---|
| 102 | ln -v -sf onsgmls /usr/bin/nsgmls &&
|
---|
| 103 | ln -v -sf osgmlnorm /usr/bin/sgmlnorm &&
|
---|
| 104 | ln -v -sf ospam /usr/bin/spam &&
|
---|
| 105 | ln -v -sf ospcat /usr/bin/spcat &&
|
---|
| 106 | ln -v -sf ospent /usr/bin/spent &&
|
---|
| 107 | ln -v -sf osx /usr/bin/sx &&
|
---|
| 108 | ln -v -sf osx /usr/bin/sgml2xml &&
|
---|
| 109 | ln -v -sf libosp.so /usr/lib/libsp.so</userinput></screen>
|
---|
[402131a2] | 110 |
|
---|
[e7323adb] | 111 | <!--
|
---|
[dbfc8e65] | 112 | install-catalog -add /etc/sgml/OpenSP-&opensp-version;.cat \
|
---|
[50d3491a] | 113 | /usr/share/sgml/OpenSP-&opensp-version;/catalog &&
|
---|
[402131a2] | 114 | install-catalog -add /etc/sgml/sgml-docbook.cat \
|
---|
[50d3491a] | 115 | /etc/sgml/OpenSP-&opensp-version;.cat</command></userinput></screen>
|
---|
| 116 |
|
---|
| 117 | <tip><title>Update hint</title>
|
---|
| 118 | <para>Remove the above catalog items prior to upgrading with:
|
---|
[402131a2] | 119 | <screen><command>install-catalog -remove /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat \
|
---|
[50d3491a] | 120 | /usr/share/sgml/OpenSP-<replaceable>[version]</replaceable>/catalog &&
|
---|
[402131a2] | 121 | install-catalog -remove /etc/sgml/sgml-docbook.cat \
|
---|
[dbfc8e65] | 122 | /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat</command></screen></para></tip>
|
---|
| 123 | -->
|
---|
[50d3491a] | 124 |
|
---|
[e7323adb] | 125 | </sect2>
|
---|
| 126 |
|
---|
| 127 | <sect2 role="commands">
|
---|
| 128 | <title>Command Explanations</title>
|
---|
| 129 |
|
---|
| 130 | <para><parameter>--disable-static</parameter>: This switch prevents
|
---|
| 131 | the building of the static library.</para>
|
---|
| 132 |
|
---|
| 133 | <para><parameter>--enable-http</parameter>: This switch adds support
|
---|
| 134 | for HTTP.</para>
|
---|
| 135 |
|
---|
| 136 | <para><parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>:
|
---|
| 137 | This switch sets the path to the centralized catalog.</para>
|
---|
| 138 |
|
---|
| 139 | <para><parameter>--enable-default-search-path</parameter>: This switch
|
---|
| 140 | sets the default value of <envar>SGML_SEARCH_PATH</envar>.</para>
|
---|
| 141 |
|
---|
| 142 | <para><option>--enable-xml-messages</option>: This switch adds
|
---|
| 143 | support for XML Formatted Messages.</para>
|
---|
| 144 |
|
---|
| 145 | <para><command>make
|
---|
| 146 | pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</command>: This sets the
|
---|
| 147 | pkgdatadir variable in the <filename>Makefile</filename> from
|
---|
| 148 | <filename class="directory">/usr/share/OpenSP</filename> to <filename
|
---|
| 149 | class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.</para>
|
---|
| 150 |
|
---|
| 151 | <para><command>ln -v -sf ...</command>: These commands create the
|
---|
| 152 | <application>SP</application> equivalents of
|
---|
| 153 | <application>OpenSP</application> executables and libraries.</para>
|
---|
| 154 |
|
---|
| 155 | </sect2>
|
---|
| 156 |
|
---|
| 157 | <sect2 role="content">
|
---|
| 158 | <title>Contents</title>
|
---|
| 159 |
|
---|
| 160 | <segmentedlist>
|
---|
| 161 | <segtitle>Installed Programs</segtitle>
|
---|
| 162 | <segtitle>Installed Library</segtitle>
|
---|
| 163 | <segtitle>Installed Directories</segtitle>
|
---|
| 164 |
|
---|
| 165 | <seglistitem>
|
---|
| 166 | <seg>onsgmls, osgmlnorm, ospam, ospcat, ospent, osx, and the
|
---|
| 167 | <application>SP</application> equivalent symlinks: nsgmls, sgml2xml,
|
---|
| 168 | sgmlnorm, spam, spcat, spent, and sx</seg>
|
---|
| 169 | <seg>libosp.so and the <application>SP</application> equivalent symlink:
|
---|
| 170 | libsp.so</seg>
|
---|
| 171 | <seg>/usr/include/OpenSP, /usr/share/doc/OpenSP, and
|
---|
| 172 | /usr/share/sgml/OpenSP-&opensp-version;</seg>
|
---|
| 173 | </seglistitem>
|
---|
| 174 | </segmentedlist>
|
---|
| 175 |
|
---|
| 176 | <variablelist>
|
---|
| 177 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 178 | <?dbfo list-presentation="list"?>
|
---|
| 179 | <?dbhtml list-presentation="table"?>
|
---|
| 180 |
|
---|
| 181 | <varlistentry id="onsgmls">
|
---|
| 182 | <term><command>onsgmls</command></term>
|
---|
| 183 | <listitem>
|
---|
| 184 | <para>is used to process SGML files.</para>
|
---|
| 185 | <indexterm zone="opensp onsgmls">
|
---|
| 186 | <primary sortas="b-onsgmls">onsgmls</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
| 191 | <varlistentry id="osgmlnorm">
|
---|
| 192 | <term><command>osgmlnorm</command></term>
|
---|
| 193 | <listitem>
|
---|
| 194 | <para>prints on the standard output a normalized document instance
|
---|
| 195 | for the SGML document contained in the concatenation of the entities
|
---|
| 196 | with system identifiers .nf and .fi.</para>
|
---|
| 197 | <indexterm zone="opensp osgmlnorm">
|
---|
| 198 | <primary sortas="b-osgmlnorm">osgmlnorm</primary>
|
---|
| 199 | </indexterm>
|
---|
| 200 | </listitem>
|
---|
| 201 | </varlistentry>
|
---|
| 202 |
|
---|
| 203 | <varlistentry id="ospam">
|
---|
| 204 | <term><command>ospam</command></term>
|
---|
| 205 | <listitem>
|
---|
| 206 | <para>is a markup stream editor.</para>
|
---|
| 207 | <indexterm zone="opensp ospam">
|
---|
| 208 | <primary sortas="b-ospam">ospam</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="ospcat">
|
---|
| 214 | <term><command>ospcat</command></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>prints effective system identifiers found in the catalogs.</para>
|
---|
| 217 | <indexterm zone="opensp ospcat">
|
---|
| 218 | <primary sortas="b-ospcat">ospcat</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
| 223 | <varlistentry id="ospent">
|
---|
| 224 | <term><command>ospent</command></term>
|
---|
| 225 | <listitem>
|
---|
| 226 | <para>provides access to <application>OpenSP</application>'s
|
---|
| 227 | entity manager.</para>
|
---|
| 228 | <indexterm zone="opensp ospent">
|
---|
| 229 | <primary sortas="b-ospent">ospent</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 |
|
---|
| 234 | <varlistentry id="osx">
|
---|
| 235 | <term><command>osx</command></term>
|
---|
| 236 | <listitem>
|
---|
| 237 | <para>is an SGML normalizer or used to convert
|
---|
| 238 | SGML files to XML files.</para>
|
---|
| 239 | <indexterm zone="opensp osx">
|
---|
| 240 | <primary sortas="b-osx">osx</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | <varlistentry id="nsgmls">
|
---|
| 246 | <term><command>nsgmls</command></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>is a symlink to <command>onsgmls</command>.</para>
|
---|
| 249 | <indexterm zone="opensp nsgmls">
|
---|
| 250 | <primary sortas="g-nsgmls">nsgmls</primary>
|
---|
| 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
| 254 |
|
---|
| 255 | <varlistentry id="sgml2xml">
|
---|
| 256 | <term><command>sgml2xml</command></term>
|
---|
| 257 | <listitem>
|
---|
| 258 | <para>is a symlink to <command>osx</command>.</para>
|
---|
| 259 | <indexterm zone="opensp sgml2xml">
|
---|
| 260 | <primary sortas="g-sgml2xml">sgml2xml</primary>
|
---|
| 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
| 264 |
|
---|
| 265 | <varlistentry id="sgmlnorm">
|
---|
| 266 | <term><command>sgmlnorm</command></term>
|
---|
| 267 | <listitem>
|
---|
| 268 | <para>is a symlink to <command>osgmlnorm</command>.</para>
|
---|
| 269 | <indexterm zone="opensp sgmlnorm">
|
---|
| 270 | <primary sortas="g-sgmlnorm">sgmlnorm</primary>
|
---|
| 271 | </indexterm>
|
---|
| 272 | </listitem>
|
---|
| 273 | </varlistentry>
|
---|
| 274 |
|
---|
| 275 | <varlistentry id="spam">
|
---|
| 276 | <term><command>spam</command></term>
|
---|
| 277 | <listitem>
|
---|
| 278 | <para>is a symlink to <command>ospam</command>.</para>
|
---|
| 279 | <indexterm zone="opensp spam">
|
---|
| 280 | <primary sortas="g-spam">spam</primary>
|
---|
| 281 | </indexterm>
|
---|
| 282 | </listitem>
|
---|
| 283 | </varlistentry>
|
---|
| 284 |
|
---|
| 285 | <varlistentry id="spcat">
|
---|
| 286 | <term><command>spcat</command></term>
|
---|
| 287 | <listitem>
|
---|
| 288 | <para>is a symlink to <command>ospcat</command>.</para>
|
---|
| 289 | <indexterm zone="opensp spcat">
|
---|
| 290 | <primary sortas="g-spcat">spcat</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
| 294 |
|
---|
| 295 | <varlistentry id="spent">
|
---|
| 296 | <term><command>spent</command></term>
|
---|
| 297 | <listitem>
|
---|
| 298 | <para>is a symlink to <command>ospent</command>.</para>
|
---|
| 299 | <indexterm zone="opensp spent">
|
---|
| 300 | <primary sortas="g-spent">spent</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
| 305 | <varlistentry id="sx">
|
---|
| 306 | <term><command>sx</command></term>
|
---|
| 307 | <listitem>
|
---|
| 308 | <para>is a symlink to <command>osx</command>.</para>
|
---|
| 309 | <indexterm zone="opensp sx">
|
---|
| 310 | <primary sortas="g-sx">sx</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 |
|
---|
| 315 | <varlistentry id="libosp">
|
---|
| 316 | <term><filename class='libraryfile'>libosp.so</filename></term>
|
---|
| 317 | <listitem>
|
---|
| 318 | <para>contains functions required by the
|
---|
| 319 | <application>OpenSP</application> programs to parse, validate and
|
---|
| 320 | manipulate SGML and XML files.</para>
|
---|
| 321 | <indexterm zone="opensp libosp">
|
---|
| 322 | <primary sortas="c-libosp">libosp.so</primary>
|
---|
| 323 | </indexterm>
|
---|
| 324 | </listitem>
|
---|
| 325 | </varlistentry>
|
---|
| 326 |
|
---|
| 327 | <varlistentry id="libsp">
|
---|
| 328 | <term><filename class='libraryfile'>libsp.so</filename></term>
|
---|
| 329 | <listitem>
|
---|
| 330 | <para>is a symlink to
|
---|
| 331 | <filename class='libraryfile'>libosp.so</filename>.</para>
|
---|
| 332 | <indexterm zone="opensp libsp">
|
---|
| 333 | <primary sortas="g-libsp">libsp.so</primary>
|
---|
| 334 | </indexterm>
|
---|
| 335 | </listitem>
|
---|
| 336 | </varlistentry>
|
---|
| 337 |
|
---|
| 338 | </variablelist>
|
---|
| 339 |
|
---|
| 340 | </sect2>
|
---|
[7ff89fa4] | 341 |
|
---|
| 342 | </sect1>
|
---|