| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY opensp-download-http "&sourceforge-dl;/openjade/OpenSP-&opensp-version;.tar.gz">
|
|---|
| 8 | <!ENTITY opensp-download-ftp " ">
|
|---|
| 9 | <!ENTITY opensp-md5sum "670b223c5d12cee40c9137be86b6c39b">
|
|---|
| 10 | <!ENTITY opensp-size "1.5 MB">
|
|---|
| 11 | <!ENTITY opensp-buildsize "32 MB">
|
|---|
| 12 | <!ENTITY opensp-time "1.0 SBU">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="opensp" xreflabel="OpenSP-&opensp-version;">
|
|---|
| 16 | <?dbhtml filename="opensp.html"?>
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | <title>OpenSP-&opensp-version;</title>
|
|---|
| 20 |
|
|---|
| 21 | <indexterm zone="opensp">
|
|---|
| 22 | <primary sortas="a-OpenSP">OpenSP</primary>
|
|---|
| 23 | </indexterm>
|
|---|
| 24 |
|
|---|
| 25 | <sect2 role="package">
|
|---|
| 26 | <title>Introduction to OpenSP</title>
|
|---|
| 27 |
|
|---|
| 28 | <para>
|
|---|
| 29 | The <application>OpenSP</application> package contains a
|
|---|
| 30 | <application>C++</application> library for using SGML/XML files.
|
|---|
| 31 | This is useful for validating, parsing and manipulating SGML and XML
|
|---|
| 32 | documents.
|
|---|
| 33 | </para>
|
|---|
| 34 |
|
|---|
| 35 | &lfs121_checked;
|
|---|
| 36 |
|
|---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 38 | <itemizedlist spacing="compact">
|
|---|
| 39 | <listitem>
|
|---|
| 40 | <para>
|
|---|
| 41 | Download (HTTP): <ulink url="&opensp-download-http;"/>
|
|---|
| 42 | </para>
|
|---|
| 43 | </listitem>
|
|---|
| 44 | <listitem>
|
|---|
| 45 | <para>
|
|---|
| 46 | Download (FTP): <ulink url="&opensp-download-ftp;"/>
|
|---|
| 47 | </para>
|
|---|
| 48 | </listitem>
|
|---|
| 49 | <listitem>
|
|---|
| 50 | <para>
|
|---|
| 51 | Download MD5 sum: &opensp-md5sum;
|
|---|
| 52 | </para>
|
|---|
| 53 | </listitem>
|
|---|
| 54 | <listitem>
|
|---|
| 55 | <para>
|
|---|
| 56 | Download size: &opensp-size;
|
|---|
| 57 | </para>
|
|---|
| 58 | </listitem>
|
|---|
| 59 | <listitem>
|
|---|
| 60 | <para>
|
|---|
| 61 | Estimated disk space required: &opensp-buildsize;
|
|---|
| 62 | </para>
|
|---|
| 63 | </listitem>
|
|---|
| 64 | <listitem>
|
|---|
| 65 | <para>
|
|---|
| 66 | Estimated build time: &opensp-time;
|
|---|
| 67 | </para>
|
|---|
| 68 | </listitem>
|
|---|
| 69 | </itemizedlist>
|
|---|
| 70 |
|
|---|
| 71 | <bridgehead renderas="sect3">OpenSP Dependencies</bridgehead>
|
|---|
| 72 |
|
|---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 74 | <para role="required">
|
|---|
| 75 | <xref linkend="sgml-common"/>
|
|---|
| 76 | </para>
|
|---|
| 77 |
|
|---|
| 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 79 | <para role="optional">
|
|---|
| 80 | <xref linkend="libnsl"/> and
|
|---|
| 81 | <xref linkend="xmlto"/>
|
|---|
| 82 | </para>
|
|---|
| 83 |
|
|---|
| 84 | </sect2>
|
|---|
| 85 |
|
|---|
| 86 | <sect2 role="installation">
|
|---|
| 87 | <title>Installation of OpenSP</title>
|
|---|
| 88 |
|
|---|
| 89 | <para>
|
|---|
| 90 | Install <application>OpenSP</application> by running the following
|
|---|
| 91 | commands:
|
|---|
| 92 | </para>
|
|---|
| 93 |
|
|---|
| 94 | <screen><userinput>sed -i 's/32,/253,/' lib/Syntax.cxx &&
|
|---|
| 95 | sed -i 's/LITLEN 240 /LITLEN 8092/' \
|
|---|
| 96 | unicode/{gensyntax.pl,unicode.syn} &&
|
|---|
| 97 |
|
|---|
| 98 | ./configure --prefix=/usr \
|
|---|
| 99 | --disable-static \
|
|---|
| 100 | --disable-doc-build \
|
|---|
| 101 | --enable-default-catalog=/etc/sgml/catalog \
|
|---|
| 102 | --enable-http \
|
|---|
| 103 | --enable-default-search-path=/usr/share/sgml &&
|
|---|
| 104 |
|
|---|
| 105 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</userinput></screen>
|
|---|
| 106 |
|
|---|
| 107 | <para>
|
|---|
| 108 | To test the results, issue: <command>make check</command>. As many as
|
|---|
| 109 | nine of the 23 tests may fail. Do not be alarmed.
|
|---|
| 110 | </para>
|
|---|
| 111 |
|
|---|
| 112 | <para>
|
|---|
| 113 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 114 | </para>
|
|---|
| 115 |
|
|---|
| 116 | <screen role="root"><userinput>make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; \
|
|---|
| 117 | docdir=/usr/share/doc/OpenSP-&opensp-version; \
|
|---|
| 118 | install &&
|
|---|
| 119 |
|
|---|
| 120 | ln -v -sf onsgmls /usr/bin/nsgmls &&
|
|---|
| 121 | ln -v -sf osgmlnorm /usr/bin/sgmlnorm &&
|
|---|
| 122 | ln -v -sf ospam /usr/bin/spam &&
|
|---|
| 123 | ln -v -sf ospcat /usr/bin/spcat &&
|
|---|
| 124 | ln -v -sf ospent /usr/bin/spent &&
|
|---|
| 125 | ln -v -sf osx /usr/bin/sx &&
|
|---|
| 126 | ln -v -sf osx /usr/bin/sgml2xml &&
|
|---|
| 127 | ln -v -sf libosp.so /usr/lib/libsp.so</userinput></screen>
|
|---|
| 128 |
|
|---|
| 129 | </sect2>
|
|---|
| 130 |
|
|---|
| 131 | <sect2 role="commands">
|
|---|
| 132 | <title>Command Explanations</title>
|
|---|
| 133 |
|
|---|
| 134 | <para>
|
|---|
| 135 | <command>sed -i 's/32,/253,/...unicode.syn}</command>:
|
|---|
| 136 | These seds prevent some annoying messages that may otherwise appear
|
|---|
| 137 | while running <command>openjade</command>.
|
|---|
| 138 | </para>
|
|---|
| 139 |
|
|---|
| 140 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 141 | href="../../xincludes/static-libraries.xml"/>
|
|---|
| 142 |
|
|---|
| 143 | <para>
|
|---|
| 144 | <parameter>--enable-http</parameter>: This switch adds support
|
|---|
| 145 | for HTTP.
|
|---|
| 146 | </para>
|
|---|
| 147 |
|
|---|
| 148 | <para>
|
|---|
| 149 | <parameter>--disable-doc-build</parameter>: This switch prevents the
|
|---|
| 150 | <command>configure</command> script checking if you have
|
|---|
| 151 | <application>xmlto</application> installed. If you have
|
|---|
| 152 | <application>xmlto</application>, you can remove this option.
|
|---|
| 153 | </para>
|
|---|
| 154 |
|
|---|
| 155 | <para>
|
|---|
| 156 | <parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>:
|
|---|
| 157 | This switch sets the path to the centralized catalog.
|
|---|
| 158 | </para>
|
|---|
| 159 |
|
|---|
| 160 | <para>
|
|---|
| 161 | <parameter>--enable-default-search-path</parameter>: This switch
|
|---|
| 162 | sets the default value of <envar>SGML_SEARCH_PATH</envar>.
|
|---|
| 163 | </para>
|
|---|
| 164 |
|
|---|
| 165 | <para>
|
|---|
| 166 | <option>--enable-xml-messages</option>: This switch adds
|
|---|
| 167 | support for XML Formatted Messages.
|
|---|
| 168 | </para>
|
|---|
| 169 |
|
|---|
| 170 | <para>
|
|---|
| 171 | <command>
|
|---|
| 172 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;
|
|---|
| 173 | </command>: This sets the
|
|---|
| 174 | pkgdatadir variable in the <filename>Makefile</filename> from
|
|---|
| 175 | <filename class="directory">/usr/share/OpenSP</filename> to <filename
|
|---|
| 176 | class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.
|
|---|
| 177 | </para>
|
|---|
| 178 |
|
|---|
| 179 | <para>
|
|---|
| 180 | <command>ln -v -sf ...</command>: These commands create the
|
|---|
| 181 | <application>SP</application> equivalents of
|
|---|
| 182 | <application>OpenSP</application> executables and libraries.
|
|---|
| 183 | </para>
|
|---|
| 184 |
|
|---|
| 185 | </sect2>
|
|---|
| 186 |
|
|---|
| 187 | <sect2 role="content">
|
|---|
| 188 | <title>Contents</title>
|
|---|
| 189 |
|
|---|
| 190 | <segmentedlist>
|
|---|
| 191 | <segtitle>Installed Programs</segtitle>
|
|---|
| 192 | <segtitle>Installed Library</segtitle>
|
|---|
| 193 | <segtitle>Installed Directories</segtitle>
|
|---|
| 194 |
|
|---|
| 195 | <seglistitem>
|
|---|
| 196 | <seg>onsgmls, osgmlnorm, ospam, ospcat, ospent, osx, and the
|
|---|
| 197 | <application>SP</application> equivalent symlinks: nsgmls, sgml2xml,
|
|---|
| 198 | sgmlnorm, spam, spcat, spent, and sx</seg>
|
|---|
| 199 | <seg>libosp.so and the <application>SP</application> equivalent symlink:
|
|---|
| 200 | libsp.so</seg>
|
|---|
| 201 | <seg>/usr/include/OpenSP, /usr/share/doc/OpenSP, and
|
|---|
| 202 | /usr/share/sgml/OpenSP-&opensp-version;</seg>
|
|---|
| 203 | </seglistitem>
|
|---|
| 204 | </segmentedlist>
|
|---|
| 205 |
|
|---|
| 206 | <variablelist>
|
|---|
| 207 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 208 | <?dbfo list-presentation="list"?>
|
|---|
| 209 | <?dbhtml list-presentation="table"?>
|
|---|
| 210 |
|
|---|
| 211 | <varlistentry id="onsgmls">
|
|---|
| 212 | <term><command>onsgmls</command></term>
|
|---|
| 213 | <listitem>
|
|---|
| 214 | <para>
|
|---|
| 215 | is used to process SGML files
|
|---|
| 216 | </para>
|
|---|
| 217 | <indexterm zone="opensp onsgmls">
|
|---|
| 218 | <primary sortas="b-onsgmls">onsgmls</primary>
|
|---|
| 219 | </indexterm>
|
|---|
| 220 | </listitem>
|
|---|
| 221 | </varlistentry>
|
|---|
| 222 |
|
|---|
| 223 | <varlistentry id="osgmlnorm">
|
|---|
| 224 | <term><command>osgmlnorm</command></term>
|
|---|
| 225 | <listitem>
|
|---|
| 226 | <para>
|
|---|
| 227 | prints on the standard output a normalized document instance for
|
|---|
| 228 | the SGML document contained in the concatenation of the entities
|
|---|
| 229 | with system identifiers .nf and .fi
|
|---|
| 230 | </para>
|
|---|
| 231 | <indexterm zone="opensp osgmlnorm">
|
|---|
| 232 | <primary sortas="b-osgmlnorm">osgmlnorm</primary>
|
|---|
| 233 | </indexterm>
|
|---|
| 234 | </listitem>
|
|---|
| 235 | </varlistentry>
|
|---|
| 236 |
|
|---|
| 237 | <varlistentry id="ospam">
|
|---|
| 238 | <term><command>ospam</command></term>
|
|---|
| 239 | <listitem>
|
|---|
| 240 | <para>
|
|---|
| 241 | is a markup stream editor
|
|---|
| 242 | </para>
|
|---|
| 243 | <indexterm zone="opensp ospam">
|
|---|
| 244 | <primary sortas="b-ospam">ospam</primary>
|
|---|
| 245 | </indexterm>
|
|---|
| 246 | </listitem>
|
|---|
| 247 | </varlistentry>
|
|---|
| 248 |
|
|---|
| 249 | <varlistentry id="ospcat">
|
|---|
| 250 | <term><command>ospcat</command></term>
|
|---|
| 251 | <listitem>
|
|---|
| 252 | <para>
|
|---|
| 253 | prints effective system identifiers found in the catalogs
|
|---|
| 254 | </para>
|
|---|
| 255 | <indexterm zone="opensp ospcat">
|
|---|
| 256 | <primary sortas="b-ospcat">ospcat</primary>
|
|---|
| 257 | </indexterm>
|
|---|
| 258 | </listitem>
|
|---|
| 259 | </varlistentry>
|
|---|
| 260 |
|
|---|
| 261 | <varlistentry id="ospent">
|
|---|
| 262 | <term><command>ospent</command></term>
|
|---|
| 263 | <listitem>
|
|---|
| 264 | <para>
|
|---|
| 265 | provides access to <application>OpenSP</application>'s
|
|---|
| 266 | entity manager
|
|---|
| 267 | </para>
|
|---|
| 268 | <indexterm zone="opensp ospent">
|
|---|
| 269 | <primary sortas="b-ospent">ospent</primary>
|
|---|
| 270 | </indexterm>
|
|---|
| 271 | </listitem>
|
|---|
| 272 | </varlistentry>
|
|---|
| 273 |
|
|---|
| 274 | <varlistentry id="osx">
|
|---|
| 275 | <term><command>osx</command></term>
|
|---|
| 276 | <listitem>
|
|---|
| 277 | <para>
|
|---|
| 278 | is an SGML normalizer or used to convert
|
|---|
| 279 | SGML files to XML files
|
|---|
| 280 | </para>
|
|---|
| 281 | <indexterm zone="opensp osx">
|
|---|
| 282 | <primary sortas="b-osx">osx</primary>
|
|---|
| 283 | </indexterm>
|
|---|
| 284 | </listitem>
|
|---|
| 285 | </varlistentry>
|
|---|
| 286 |
|
|---|
| 287 | <varlistentry id="nsgmls">
|
|---|
| 288 | <term><command>nsgmls</command></term>
|
|---|
| 289 | <listitem>
|
|---|
| 290 | <para>
|
|---|
| 291 | is a symlink to <command>onsgmls</command>
|
|---|
| 292 | </para>
|
|---|
| 293 | <indexterm zone="opensp nsgmls">
|
|---|
| 294 | <primary sortas="b-nsgmls">nsgmls</primary>
|
|---|
| 295 | </indexterm>
|
|---|
| 296 | </listitem>
|
|---|
| 297 | </varlistentry>
|
|---|
| 298 |
|
|---|
| 299 | <varlistentry id="sgml2xml">
|
|---|
| 300 | <term><command>sgml2xml</command></term>
|
|---|
| 301 | <listitem>
|
|---|
| 302 | <para>
|
|---|
| 303 | is a symlink to <command>osx</command>
|
|---|
| 304 | </para>
|
|---|
| 305 | <indexterm zone="opensp sgml2xml">
|
|---|
| 306 | <primary sortas="b-sgml2xml">sgml2xml</primary>
|
|---|
| 307 | </indexterm>
|
|---|
| 308 | </listitem>
|
|---|
| 309 | </varlistentry>
|
|---|
| 310 |
|
|---|
| 311 | <varlistentry id="sgmlnorm">
|
|---|
| 312 | <term><command>sgmlnorm</command></term>
|
|---|
| 313 | <listitem>
|
|---|
| 314 | <para>
|
|---|
| 315 | is a symlink to <command>osgmlnorm</command>
|
|---|
| 316 | </para>
|
|---|
| 317 | <indexterm zone="opensp sgmlnorm">
|
|---|
| 318 | <primary sortas="b-sgmlnorm">sgmlnorm</primary>
|
|---|
| 319 | </indexterm>
|
|---|
| 320 | </listitem>
|
|---|
| 321 | </varlistentry>
|
|---|
| 322 |
|
|---|
| 323 | <varlistentry id="spam">
|
|---|
| 324 | <term><command>spam</command></term>
|
|---|
| 325 | <listitem>
|
|---|
| 326 | <para>
|
|---|
| 327 | is a symlink to <command>ospam</command>
|
|---|
| 328 | </para>
|
|---|
| 329 | <indexterm zone="opensp spam">
|
|---|
| 330 | <primary sortas="b-spam">spam</primary>
|
|---|
| 331 | </indexterm>
|
|---|
| 332 | </listitem>
|
|---|
| 333 | </varlistentry>
|
|---|
| 334 |
|
|---|
| 335 | <varlistentry id="spcat">
|
|---|
| 336 | <term><command>spcat</command></term>
|
|---|
| 337 | <listitem>
|
|---|
| 338 | <para>
|
|---|
| 339 | is a symlink to <command>ospcat</command>
|
|---|
| 340 | </para>
|
|---|
| 341 | <indexterm zone="opensp spcat">
|
|---|
| 342 | <primary sortas="b-spcat">spcat</primary>
|
|---|
| 343 | </indexterm>
|
|---|
| 344 | </listitem>
|
|---|
| 345 | </varlistentry>
|
|---|
| 346 |
|
|---|
| 347 | <varlistentry id="spent">
|
|---|
| 348 | <term><command>spent</command></term>
|
|---|
| 349 | <listitem>
|
|---|
| 350 | <para>
|
|---|
| 351 | is a symlink to <command>ospent</command>
|
|---|
| 352 | </para>
|
|---|
| 353 | <indexterm zone="opensp spent">
|
|---|
| 354 | <primary sortas="b-spent">spent</primary>
|
|---|
| 355 | </indexterm>
|
|---|
| 356 | </listitem>
|
|---|
| 357 | </varlistentry>
|
|---|
| 358 |
|
|---|
| 359 | <varlistentry id="sx">
|
|---|
| 360 | <term><command>sx</command></term>
|
|---|
| 361 | <listitem>
|
|---|
| 362 | <para>
|
|---|
| 363 | is a symlink to <command>osx</command>
|
|---|
| 364 | </para>
|
|---|
| 365 | <indexterm zone="opensp sx">
|
|---|
| 366 | <primary sortas="b-sx">sx</primary>
|
|---|
| 367 | </indexterm>
|
|---|
| 368 | </listitem>
|
|---|
| 369 | </varlistentry>
|
|---|
| 370 |
|
|---|
| 371 | <varlistentry id="libosp">
|
|---|
| 372 | <term><filename class="libraryfile">libosp.so</filename></term>
|
|---|
| 373 | <listitem>
|
|---|
| 374 | <para>
|
|---|
| 375 | contains functions required by the
|
|---|
| 376 | <application>OpenSP</application> programs to parse, validate and
|
|---|
| 377 | manipulate SGML and XML files
|
|---|
| 378 | </para>
|
|---|
| 379 | <indexterm zone="opensp libosp">
|
|---|
| 380 | <primary sortas="c-libosp">libosp.so</primary>
|
|---|
| 381 | </indexterm>
|
|---|
| 382 | </listitem>
|
|---|
| 383 | </varlistentry>
|
|---|
| 384 |
|
|---|
| 385 | <varlistentry id="libsp">
|
|---|
| 386 | <term><filename class="libraryfile">libsp.so</filename></term>
|
|---|
| 387 | <listitem>
|
|---|
| 388 | <para>
|
|---|
| 389 | is a symlink to
|
|---|
| 390 | <filename class="libraryfile">libosp.so</filename>
|
|---|
| 391 | </para>
|
|---|
| 392 | <indexterm zone="opensp libsp">
|
|---|
| 393 | <primary sortas="c-libsp">libsp.so</primary>
|
|---|
| 394 | </indexterm>
|
|---|
| 395 | </listitem>
|
|---|
| 396 | </varlistentry>
|
|---|
| 397 |
|
|---|
| 398 | </variablelist>
|
|---|
| 399 |
|
|---|
| 400 | </sect2>
|
|---|
| 401 |
|
|---|
| 402 | </sect1>
|
|---|
