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 | &lfs122_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">Additional Downloads</bridgehead>
|
---|
72 | <itemizedlist spacing='compact'>
|
---|
73 | <listitem>
|
---|
74 | <para>
|
---|
75 | Required patch: <ulink
|
---|
76 | url="&patch-root;/OpenSP-&opensp-version;-gcc14-1.patch"/>
|
---|
77 | </para>
|
---|
78 | </listitem>
|
---|
79 | </itemizedlist>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect3">OpenSP Dependencies</bridgehead>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
84 | <para role="required">
|
---|
85 | <xref linkend="sgml-common"/>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
89 | <para role="optional">
|
---|
90 | <xref linkend="libnsl"/> and
|
---|
91 | <xref linkend="xmlto"/>
|
---|
92 | </para>
|
---|
93 |
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of OpenSP</title>
|
---|
98 |
|
---|
99 | <para>
|
---|
100 | Install <application>OpenSP</application> by running the following
|
---|
101 | commands:
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | <screen><userinput>patch -Np1 -i ../OpenSP-&opensp-version;-gcc14-1.patch &&
|
---|
105 | sed -i 's/32,/253,/' lib/Syntax.cxx &&
|
---|
106 | sed -i 's/LITLEN 240 /LITLEN 8092/' \
|
---|
107 | unicode/{gensyntax.pl,unicode.syn} &&
|
---|
108 |
|
---|
109 | ./configure --prefix=/usr \
|
---|
110 | --disable-static \
|
---|
111 | --disable-doc-build \
|
---|
112 | --enable-default-catalog=/etc/sgml/catalog \
|
---|
113 | --enable-http \
|
---|
114 | --enable-default-search-path=/usr/share/sgml &&
|
---|
115 |
|
---|
116 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</userinput></screen>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | To test the results, issue: <command>make check</command>. As many as
|
---|
120 | nine of the 23 tests may fail. Do not be alarmed.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
125 | </para>
|
---|
126 |
|
---|
127 | <screen role="root"><userinput>make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; \
|
---|
128 | docdir=/usr/share/doc/OpenSP-&opensp-version; \
|
---|
129 | install &&
|
---|
130 |
|
---|
131 | ln -v -sf onsgmls /usr/bin/nsgmls &&
|
---|
132 | ln -v -sf osgmlnorm /usr/bin/sgmlnorm &&
|
---|
133 | ln -v -sf ospam /usr/bin/spam &&
|
---|
134 | ln -v -sf ospcat /usr/bin/spcat &&
|
---|
135 | ln -v -sf ospent /usr/bin/spent &&
|
---|
136 | ln -v -sf osx /usr/bin/sx &&
|
---|
137 | ln -v -sf osx /usr/bin/sgml2xml &&
|
---|
138 | ln -v -sf libosp.so /usr/lib/libsp.so</userinput></screen>
|
---|
139 |
|
---|
140 | </sect2>
|
---|
141 |
|
---|
142 | <sect2 role="commands">
|
---|
143 | <title>Command Explanations</title>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | <command>sed -i 's/32,/253,/...unicode.syn}</command>:
|
---|
147 | These seds prevent some annoying messages that may otherwise appear
|
---|
148 | while running <command>openjade</command>.
|
---|
149 | </para>
|
---|
150 |
|
---|
151 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
152 | href="../../xincludes/static-libraries.xml"/>
|
---|
153 |
|
---|
154 | <para>
|
---|
155 | <parameter>--enable-http</parameter>: This switch adds support
|
---|
156 | for HTTP.
|
---|
157 | </para>
|
---|
158 |
|
---|
159 | <para>
|
---|
160 | <parameter>--disable-doc-build</parameter>: This switch prevents the
|
---|
161 | <command>configure</command> script checking if you have
|
---|
162 | <application>xmlto</application> installed. If you have
|
---|
163 | <application>xmlto</application>, you can remove this option.
|
---|
164 | </para>
|
---|
165 |
|
---|
166 | <para>
|
---|
167 | <parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>:
|
---|
168 | This switch sets the path to the centralized catalog.
|
---|
169 | </para>
|
---|
170 |
|
---|
171 | <para>
|
---|
172 | <parameter>--enable-default-search-path</parameter>: This switch
|
---|
173 | sets the default value of <envar>SGML_SEARCH_PATH</envar>.
|
---|
174 | </para>
|
---|
175 |
|
---|
176 | <para>
|
---|
177 | <option>--enable-xml-messages</option>: This switch adds
|
---|
178 | support for XML Formatted Messages.
|
---|
179 | </para>
|
---|
180 |
|
---|
181 | <para>
|
---|
182 | <command>
|
---|
183 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;
|
---|
184 | </command>: This sets the
|
---|
185 | pkgdatadir variable in the <filename>Makefile</filename> from
|
---|
186 | <filename class="directory">/usr/share/OpenSP</filename> to <filename
|
---|
187 | class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.
|
---|
188 | </para>
|
---|
189 |
|
---|
190 | <para>
|
---|
191 | <command>ln -v -sf ...</command>: These commands create the
|
---|
192 | <application>SP</application> equivalents of
|
---|
193 | <application>OpenSP</application> executables and libraries.
|
---|
194 | </para>
|
---|
195 |
|
---|
196 | </sect2>
|
---|
197 |
|
---|
198 | <sect2 role="content">
|
---|
199 | <title>Contents</title>
|
---|
200 |
|
---|
201 | <segmentedlist>
|
---|
202 | <segtitle>Installed Programs</segtitle>
|
---|
203 | <segtitle>Installed Library</segtitle>
|
---|
204 | <segtitle>Installed Directories</segtitle>
|
---|
205 |
|
---|
206 | <seglistitem>
|
---|
207 | <seg>onsgmls, osgmlnorm, ospam, ospcat, ospent, osx, and the
|
---|
208 | <application>SP</application> equivalent symlinks: nsgmls, sgml2xml,
|
---|
209 | sgmlnorm, spam, spcat, spent, and sx</seg>
|
---|
210 | <seg>libosp.so and the <application>SP</application> equivalent symlink:
|
---|
211 | libsp.so</seg>
|
---|
212 | <seg>/usr/include/OpenSP, /usr/share/doc/OpenSP, and
|
---|
213 | /usr/share/sgml/OpenSP-&opensp-version;</seg>
|
---|
214 | </seglistitem>
|
---|
215 | </segmentedlist>
|
---|
216 |
|
---|
217 | <variablelist>
|
---|
218 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
219 | <?dbfo list-presentation="list"?>
|
---|
220 | <?dbhtml list-presentation="table"?>
|
---|
221 |
|
---|
222 | <varlistentry id="onsgmls">
|
---|
223 | <term><command>onsgmls</command></term>
|
---|
224 | <listitem>
|
---|
225 | <para>
|
---|
226 | is used to process SGML files
|
---|
227 | </para>
|
---|
228 | <indexterm zone="opensp onsgmls">
|
---|
229 | <primary sortas="b-onsgmls">onsgmls</primary>
|
---|
230 | </indexterm>
|
---|
231 | </listitem>
|
---|
232 | </varlistentry>
|
---|
233 |
|
---|
234 | <varlistentry id="osgmlnorm">
|
---|
235 | <term><command>osgmlnorm</command></term>
|
---|
236 | <listitem>
|
---|
237 | <para>
|
---|
238 | prints on the standard output a normalized document instance for
|
---|
239 | the SGML document contained in the concatenation of the entities
|
---|
240 | with system identifiers .nf and .fi
|
---|
241 | </para>
|
---|
242 | <indexterm zone="opensp osgmlnorm">
|
---|
243 | <primary sortas="b-osgmlnorm">osgmlnorm</primary>
|
---|
244 | </indexterm>
|
---|
245 | </listitem>
|
---|
246 | </varlistentry>
|
---|
247 |
|
---|
248 | <varlistentry id="ospam">
|
---|
249 | <term><command>ospam</command></term>
|
---|
250 | <listitem>
|
---|
251 | <para>
|
---|
252 | is a markup stream editor
|
---|
253 | </para>
|
---|
254 | <indexterm zone="opensp ospam">
|
---|
255 | <primary sortas="b-ospam">ospam</primary>
|
---|
256 | </indexterm>
|
---|
257 | </listitem>
|
---|
258 | </varlistentry>
|
---|
259 |
|
---|
260 | <varlistentry id="ospcat">
|
---|
261 | <term><command>ospcat</command></term>
|
---|
262 | <listitem>
|
---|
263 | <para>
|
---|
264 | prints effective system identifiers found in the catalogs
|
---|
265 | </para>
|
---|
266 | <indexterm zone="opensp ospcat">
|
---|
267 | <primary sortas="b-ospcat">ospcat</primary>
|
---|
268 | </indexterm>
|
---|
269 | </listitem>
|
---|
270 | </varlistentry>
|
---|
271 |
|
---|
272 | <varlistentry id="ospent">
|
---|
273 | <term><command>ospent</command></term>
|
---|
274 | <listitem>
|
---|
275 | <para>
|
---|
276 | provides access to <application>OpenSP</application>'s
|
---|
277 | entity manager
|
---|
278 | </para>
|
---|
279 | <indexterm zone="opensp ospent">
|
---|
280 | <primary sortas="b-ospent">ospent</primary>
|
---|
281 | </indexterm>
|
---|
282 | </listitem>
|
---|
283 | </varlistentry>
|
---|
284 |
|
---|
285 | <varlistentry id="osx">
|
---|
286 | <term><command>osx</command></term>
|
---|
287 | <listitem>
|
---|
288 | <para>
|
---|
289 | is an SGML normalizer or used to convert
|
---|
290 | SGML files to XML files
|
---|
291 | </para>
|
---|
292 | <indexterm zone="opensp osx">
|
---|
293 | <primary sortas="b-osx">osx</primary>
|
---|
294 | </indexterm>
|
---|
295 | </listitem>
|
---|
296 | </varlistentry>
|
---|
297 |
|
---|
298 | <varlistentry id="nsgmls">
|
---|
299 | <term><command>nsgmls</command></term>
|
---|
300 | <listitem>
|
---|
301 | <para>
|
---|
302 | is a symlink to <command>onsgmls</command>
|
---|
303 | </para>
|
---|
304 | <indexterm zone="opensp nsgmls">
|
---|
305 | <primary sortas="b-nsgmls">nsgmls</primary>
|
---|
306 | </indexterm>
|
---|
307 | </listitem>
|
---|
308 | </varlistentry>
|
---|
309 |
|
---|
310 | <varlistentry id="sgml2xml">
|
---|
311 | <term><command>sgml2xml</command></term>
|
---|
312 | <listitem>
|
---|
313 | <para>
|
---|
314 | is a symlink to <command>osx</command>
|
---|
315 | </para>
|
---|
316 | <indexterm zone="opensp sgml2xml">
|
---|
317 | <primary sortas="b-sgml2xml">sgml2xml</primary>
|
---|
318 | </indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | <varlistentry id="sgmlnorm">
|
---|
323 | <term><command>sgmlnorm</command></term>
|
---|
324 | <listitem>
|
---|
325 | <para>
|
---|
326 | is a symlink to <command>osgmlnorm</command>
|
---|
327 | </para>
|
---|
328 | <indexterm zone="opensp sgmlnorm">
|
---|
329 | <primary sortas="b-sgmlnorm">sgmlnorm</primary>
|
---|
330 | </indexterm>
|
---|
331 | </listitem>
|
---|
332 | </varlistentry>
|
---|
333 |
|
---|
334 | <varlistentry id="spam">
|
---|
335 | <term><command>spam</command></term>
|
---|
336 | <listitem>
|
---|
337 | <para>
|
---|
338 | is a symlink to <command>ospam</command>
|
---|
339 | </para>
|
---|
340 | <indexterm zone="opensp spam">
|
---|
341 | <primary sortas="b-spam">spam</primary>
|
---|
342 | </indexterm>
|
---|
343 | </listitem>
|
---|
344 | </varlistentry>
|
---|
345 |
|
---|
346 | <varlistentry id="spcat">
|
---|
347 | <term><command>spcat</command></term>
|
---|
348 | <listitem>
|
---|
349 | <para>
|
---|
350 | is a symlink to <command>ospcat</command>
|
---|
351 | </para>
|
---|
352 | <indexterm zone="opensp spcat">
|
---|
353 | <primary sortas="b-spcat">spcat</primary>
|
---|
354 | </indexterm>
|
---|
355 | </listitem>
|
---|
356 | </varlistentry>
|
---|
357 |
|
---|
358 | <varlistentry id="spent">
|
---|
359 | <term><command>spent</command></term>
|
---|
360 | <listitem>
|
---|
361 | <para>
|
---|
362 | is a symlink to <command>ospent</command>
|
---|
363 | </para>
|
---|
364 | <indexterm zone="opensp spent">
|
---|
365 | <primary sortas="b-spent">spent</primary>
|
---|
366 | </indexterm>
|
---|
367 | </listitem>
|
---|
368 | </varlistentry>
|
---|
369 |
|
---|
370 | <varlistentry id="sx">
|
---|
371 | <term><command>sx</command></term>
|
---|
372 | <listitem>
|
---|
373 | <para>
|
---|
374 | is a symlink to <command>osx</command>
|
---|
375 | </para>
|
---|
376 | <indexterm zone="opensp sx">
|
---|
377 | <primary sortas="b-sx">sx</primary>
|
---|
378 | </indexterm>
|
---|
379 | </listitem>
|
---|
380 | </varlistentry>
|
---|
381 |
|
---|
382 | <varlistentry id="libosp">
|
---|
383 | <term><filename class="libraryfile">libosp.so</filename></term>
|
---|
384 | <listitem>
|
---|
385 | <para>
|
---|
386 | contains functions required by the
|
---|
387 | <application>OpenSP</application> programs to parse, validate and
|
---|
388 | manipulate SGML and XML files
|
---|
389 | </para>
|
---|
390 | <indexterm zone="opensp libosp">
|
---|
391 | <primary sortas="c-libosp">libosp.so</primary>
|
---|
392 | </indexterm>
|
---|
393 | </listitem>
|
---|
394 | </varlistentry>
|
---|
395 |
|
---|
396 | <varlistentry id="libsp">
|
---|
397 | <term><filename class="libraryfile">libsp.so</filename></term>
|
---|
398 | <listitem>
|
---|
399 | <para>
|
---|
400 | is a symlink to
|
---|
401 | <filename class="libraryfile">libosp.so</filename>
|
---|
402 | </para>
|
---|
403 | <indexterm zone="opensp libsp">
|
---|
404 | <primary sortas="c-libsp">libsp.so</primary>
|
---|
405 | </indexterm>
|
---|
406 | </listitem>
|
---|
407 | </varlistentry>
|
---|
408 |
|
---|
409 | </variablelist>
|
---|
410 |
|
---|
411 | </sect2>
|
---|
412 |
|
---|
413 | </sect1>
|
---|