source: pst/sgml/opensp.xml@ 92c1c66

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 7.10 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gimp3 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 92c1c66 was 92c1c66, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

More doc directory corrections

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