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