source: pst/sgml/opensp.xml@ 1a518e97

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 1a518e97 was 1a518e97, checked in by Pierre Labastie <pieere@…>, 8 years ago

Last round of option vs parameter fixes

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17881 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 &lfs7a_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><command>sed -i 's/32,/253,/...unicode.syn}</command>:
120 These seds prevent some annoying messages that may otherwise appear
121 while running <command>openjade</command>.</para>
122
123 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
124 href="../../xincludes/static-libraries.xml"/>
125
126 <para><parameter>--enable-http</parameter>: This switch adds support
127 for HTTP.</para>
128
129 <para><parameter>--disable-doc-build</parameter>: This switch prevents the
130 <command>configure</command> script checking if you have
131 <application>xmlto</application> installed. If you have
132 <application>xmlto</application>, you can remove this option.</para>
133
134 <para><parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>:
135 This switch sets the path to the centralized catalog.</para>
136
137 <para><parameter>--enable-default-search-path</parameter>: This switch
138 sets the default value of <envar>SGML_SEARCH_PATH</envar>.</para>
139
140 <para><option>--enable-xml-messages</option>: This switch adds
141 support for XML Formatted Messages.</para>
142
143 <para><command>make
144 pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</command>: This sets the
145 pkgdatadir variable in the <filename>Makefile</filename> from
146 <filename class="directory">/usr/share/OpenSP</filename> to <filename
147 class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.</para>
148
149 <para><command>ln -v -sf ...</command>: These commands create the
150 <application>SP</application> equivalents of
151 <application>OpenSP</application> executables and libraries.</para>
152
153 </sect2>
154
155 <sect2 role="content">
156 <title>Contents</title>
157
158 <segmentedlist>
159 <segtitle>Installed Programs</segtitle>
160 <segtitle>Installed Library</segtitle>
161 <segtitle>Installed Directories</segtitle>
162
163 <seglistitem>
164 <seg>onsgmls, osgmlnorm, ospam, ospcat, ospent, osx, and the
165 <application>SP</application> equivalent symlinks: nsgmls, sgml2xml,
166 sgmlnorm, spam, spcat, spent, and sx</seg>
167 <seg>libosp.so and the <application>SP</application> equivalent symlink:
168 libsp.so</seg>
169 <seg>/usr/include/OpenSP, /usr/share/doc/OpenSP, and
170 /usr/share/sgml/OpenSP-&opensp-version;</seg>
171 </seglistitem>
172 </segmentedlist>
173
174 <variablelist>
175 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
176 <?dbfo list-presentation="list"?>
177 <?dbhtml list-presentation="table"?>
178
179 <varlistentry id="onsgmls">
180 <term><command>onsgmls</command></term>
181 <listitem>
182 <para>is used to process SGML files.</para>
183 <indexterm zone="opensp onsgmls">
184 <primary sortas="b-onsgmls">onsgmls</primary>
185 </indexterm>
186 </listitem>
187 </varlistentry>
188
189 <varlistentry id="osgmlnorm">
190 <term><command>osgmlnorm</command></term>
191 <listitem>
192 <para>prints on the standard output a normalized document instance
193 for the SGML document contained in the concatenation of the entities
194 with system identifiers .nf and .fi.</para>
195 <indexterm zone="opensp osgmlnorm">
196 <primary sortas="b-osgmlnorm">osgmlnorm</primary>
197 </indexterm>
198 </listitem>
199 </varlistentry>
200
201 <varlistentry id="ospam">
202 <term><command>ospam</command></term>
203 <listitem>
204 <para>is a markup stream editor.</para>
205 <indexterm zone="opensp ospam">
206 <primary sortas="b-ospam">ospam</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="ospcat">
212 <term><command>ospcat</command></term>
213 <listitem>
214 <para>prints effective system identifiers found in the catalogs.</para>
215 <indexterm zone="opensp ospcat">
216 <primary sortas="b-ospcat">ospcat</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry id="ospent">
222 <term><command>ospent</command></term>
223 <listitem>
224 <para>provides access to <application>OpenSP</application>'s
225 entity manager.</para>
226 <indexterm zone="opensp ospent">
227 <primary sortas="b-ospent">ospent</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="osx">
233 <term><command>osx</command></term>
234 <listitem>
235 <para>is an SGML normalizer or used to convert
236 SGML files to XML files.</para>
237 <indexterm zone="opensp osx">
238 <primary sortas="b-osx">osx</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="nsgmls">
244 <term><command>nsgmls</command></term>
245 <listitem>
246 <para>is a symlink to <command>onsgmls</command>.</para>
247 <indexterm zone="opensp nsgmls">
248 <primary sortas="b-nsgmls">nsgmls</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="sgml2xml">
254 <term><command>sgml2xml</command></term>
255 <listitem>
256 <para>is a symlink to <command>osx</command>.</para>
257 <indexterm zone="opensp sgml2xml">
258 <primary sortas="b-sgml2xml">sgml2xml</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="sgmlnorm">
264 <term><command>sgmlnorm</command></term>
265 <listitem>
266 <para>is a symlink to <command>osgmlnorm</command>.</para>
267 <indexterm zone="opensp sgmlnorm">
268 <primary sortas="b-sgmlnorm">sgmlnorm</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="spam">
274 <term><command>spam</command></term>
275 <listitem>
276 <para>is a symlink to <command>ospam</command>.</para>
277 <indexterm zone="opensp spam">
278 <primary sortas="b-spam">spam</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="spcat">
284 <term><command>spcat</command></term>
285 <listitem>
286 <para>is a symlink to <command>ospcat</command>.</para>
287 <indexterm zone="opensp spcat">
288 <primary sortas="b-spcat">spcat</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="spent">
294 <term><command>spent</command></term>
295 <listitem>
296 <para>is a symlink to <command>ospent</command>.</para>
297 <indexterm zone="opensp spent">
298 <primary sortas="b-spent">spent</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="sx">
304 <term><command>sx</command></term>
305 <listitem>
306 <para>is a symlink to <command>osx</command>.</para>
307 <indexterm zone="opensp sx">
308 <primary sortas="b-sx">sx</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="libosp">
314 <term><filename class='libraryfile'>libosp.so</filename></term>
315 <listitem>
316 <para>contains functions required by the
317 <application>OpenSP</application> programs to parse, validate and
318 manipulate SGML and XML files.</para>
319 <indexterm zone="opensp libosp">
320 <primary sortas="c-libosp">libosp.so</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="libsp">
326 <term><filename class='libraryfile'>libsp.so</filename></term>
327 <listitem>
328 <para>is a symlink to
329 <filename class='libraryfile'>libosp.so</filename>.</para>
330 <indexterm zone="opensp libsp">
331 <primary sortas="c-libsp">libsp.so</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 </variablelist>
337
338 </sect2>
339
340</sect1>
Note: See TracBrowser for help on using the repository browser.