source: pst/sgml/opensp.xml@ f429481

11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since f429481 was 673c070, checked in by Douglas R. Reno <renodr@…>, 9 months ago

Package update:

Update to libnsl-2.0.0
Add dependencies on libnsl to several packages where they were missing

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