1 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
2 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
3 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
4 | %general-entities;
|
---|
5 |
|
---|
6 | <!ENTITY opensp-download-http "http://download.sourceforge.net/openjade/OpenSP-&opensp-version;.tar.gz">
|
---|
7 | <!ENTITY opensp-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/OpenSP-&opensp-version;.tar.gz">
|
---|
8 | <!ENTITY opensp-md5sum "f46fe0a04b76a4454ec27b7fcc84ec54">
|
---|
9 | <!ENTITY opensp-size "1.4 MB">
|
---|
10 | <!ENTITY opensp-buildsize "43 MB">
|
---|
11 | <!ENTITY opensp-time "0.97 SBU">
|
---|
12 | ]>
|
---|
13 |
|
---|
14 | <sect1 id="opensp" xreflabel="OpenSP-&opensp-version;">
|
---|
15 | <sect1info>
|
---|
16 | <othername>$LastChangedBy$</othername>
|
---|
17 | <date>$Date$</date>
|
---|
18 | </sect1info>
|
---|
19 | <?dbhtml filename="opensp.html"?>
|
---|
20 | <title>OpenSP-&opensp-version;</title>
|
---|
21 | <indexterm zone="opensp">
|
---|
22 | <primary sortas="a-OpenSP">OpenSP</primary></indexterm>
|
---|
23 |
|
---|
24 | <sect2>
|
---|
25 | <title>Introduction to <application>OpenSP</application></title>
|
---|
26 |
|
---|
27 | <para>The <application>OpenSP</application> package contains a
|
---|
28 | <application>C++</application> library for using
|
---|
29 | <acronym>SGML</acronym>/<acronym>XML</acronym> files.
|
---|
30 | This is useful for validating, parsing and manipulating
|
---|
31 | <acronym>SGML</acronym> and <acronym>XML</acronym>
|
---|
32 | documents.</para>
|
---|
33 |
|
---|
34 | <sect3><title>Package information</title>
|
---|
35 | <itemizedlist spacing='compact'>
|
---|
36 | <listitem><para>Download (HTTP): <ulink
|
---|
37 | url="&opensp-download-http;"/></para></listitem>
|
---|
38 | <listitem><para>Download (FTP): <ulink
|
---|
39 | url="&opensp-download-ftp;"/></para></listitem>
|
---|
40 | <listitem><para>Download MD5 sum: &opensp-md5sum;</para></listitem>
|
---|
41 | <listitem><para>Download size: &opensp-size;</para></listitem>
|
---|
42 | <listitem><para>Estimated disk space required:
|
---|
43 | &opensp-buildsize;</para></listitem>
|
---|
44 | <listitem><para>Estimated build time:
|
---|
45 | &opensp-time;</para></listitem></itemizedlist>
|
---|
46 | </sect3>
|
---|
47 |
|
---|
48 | <sect3><title>Additional downloads</title>
|
---|
49 | <itemizedlist spacing='compact'>
|
---|
50 | <listitem><para>Required Patch (removes some annoying messages that can appear
|
---|
51 | while running <command>openjade</command>): <ulink
|
---|
52 | url="&patch-root;/OpenSP-&opensp-version;-LITLEN-1.patch"/></para></listitem>
|
---|
53 | <listitem><para>Required Patch: <ulink
|
---|
54 | url="&patch-root;/OpenSP-&opensp-version;-gcc34-1.patch"/></para></listitem>
|
---|
55 | </itemizedlist></sect3>
|
---|
56 |
|
---|
57 | <sect3><title><application>OpenSP</application> dependencies</title>
|
---|
58 | <sect4><title>Required</title>
|
---|
59 | <para><xref linkend="sgml-common"/></para>
|
---|
60 | </sect4>
|
---|
61 | </sect3>
|
---|
62 |
|
---|
63 | </sect2>
|
---|
64 |
|
---|
65 | <sect2>
|
---|
66 | <title>Installation of <application>OpenSP</application></title>
|
---|
67 |
|
---|
68 | <para>Install <application>OpenSP</application> by running the following
|
---|
69 | commands:</para>
|
---|
70 |
|
---|
71 | <screen><userinput><command>patch -Np1 -i ../OpenSP-&opensp-version;-LITLEN-1.patch &&
|
---|
72 | patch -Np1 -i ../OpenSP-&opensp-version;-gcc34-1.patch &&
|
---|
73 | ./configure --prefix=/usr --disable-static --enable-http \
|
---|
74 | --enable-default-catalog=/etc/sgml/catalog \
|
---|
75 | --enable-default-search-path=/usr/share/sgml &&
|
---|
76 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</command></userinput></screen>
|
---|
77 |
|
---|
78 | <para>Now, as the root user:</para>
|
---|
79 |
|
---|
80 | <screen><userinput role='root'><command>make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; install &&
|
---|
81 | ln -sf onsgmls /usr/bin/nsgmls &&
|
---|
82 | ln -sf osgmlnorm /usr/bin/sgmlnorm &&
|
---|
83 | ln -sf ospam /usr/bin/spam &&
|
---|
84 | ln -sf ospcat /usr/bin/spcat &&
|
---|
85 | ln -sf ospent /usr/bin/spent &&
|
---|
86 | ln -sf osx /usr/bin/sx &&
|
---|
87 | ln -sf osx /usr/bin/sgml2xml &&
|
---|
88 | ln -sf libosp.so /usr/lib/libsp.so</command></userinput></screen>
|
---|
89 |
|
---|
90 | <!--
|
---|
91 | install-catalog -add /etc/sgml/OpenSP-&opensp-version;.cat \
|
---|
92 | /usr/share/sgml/OpenSP-&opensp-version;/catalog &&
|
---|
93 | install-catalog -add /etc/sgml/sgml-docbook.cat \
|
---|
94 | /etc/sgml/OpenSP-&opensp-version;.cat</command></userinput></screen>
|
---|
95 |
|
---|
96 | <tip><title>Update hint</title>
|
---|
97 | <para>Remove the above catalog items prior to upgrading with:
|
---|
98 | <screen><command>install-catalog -remove /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat \
|
---|
99 | /usr/share/sgml/OpenSP-<replaceable>[version]</replaceable>/catalog &&
|
---|
100 | install-catalog -remove /etc/sgml/sgml-docbook.cat \
|
---|
101 | /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat</command></screen></para></tip>
|
---|
102 | -->
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <sect2>
|
---|
107 | <title>Command explanations</title>
|
---|
108 |
|
---|
109 | <para><option>--disable-static</option>: This switch prevents
|
---|
110 | the building of the static library.</para>
|
---|
111 |
|
---|
112 | <para><option>--enable-http</option>: This switch adds support
|
---|
113 | for <acronym>HTTP</acronym>.</para>
|
---|
114 |
|
---|
115 | <para><parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>: This
|
---|
116 | switch sets the path to the centralized catalog.</para>
|
---|
117 |
|
---|
118 | <para><parameter>--enable-default-search-path</parameter>: This switch
|
---|
119 | sets the default value of <envar>SGML_SEARCH_PATH</envar>.</para>
|
---|
120 |
|
---|
121 | <para><option>--enable-xml-messages</option>: This switch adds
|
---|
122 | support for <acronym>XML</acronym> Formatted Messages.</para>
|
---|
123 |
|
---|
124 | <para><command>make
|
---|
125 | pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</command>: This sets the
|
---|
126 | pkgdatadir variable in the <filename>Makefile</filename> from
|
---|
127 | <filename class="directory">/usr/share/OpenSP</filename> to
|
---|
128 | <filename class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <para><command>ln -sf ...</command>: These commands create the
|
---|
132 | <application>SP</application> equivalents of
|
---|
133 | <application>OpenSP</application> executables and libraries.</para>
|
---|
134 |
|
---|
135 | </sect2>
|
---|
136 |
|
---|
137 | <sect2>
|
---|
138 | <title>Contents</title>
|
---|
139 |
|
---|
140 | <segmentedlist>
|
---|
141 | <segtitle>Installed Programs</segtitle>
|
---|
142 | <segtitle>Installed Library</segtitle>
|
---|
143 | <segtitle>Installed Directories</segtitle>
|
---|
144 |
|
---|
145 | <seglistitem>
|
---|
146 | <seg>onsgmls, osgmlnorm, ospam, ospcat, ospent, osx and the
|
---|
147 | <application>SP</application> equivalent symlinks: nsgmls, sgml2xml, sgmlnorm,
|
---|
148 | spam, spcat, spent and sx</seg>
|
---|
149 | <seg>libosp.so and the <application>SP</application> equivalent symlink:
|
---|
150 | libsp.so</seg>
|
---|
151 | <seg>/usr/include/OpenSP, /usr/share/doc/OpenSP and
|
---|
152 | /usr/share/sgml/OpenSP-&opensp-version;</seg>
|
---|
153 | </seglistitem>
|
---|
154 | </segmentedlist>
|
---|
155 |
|
---|
156 | <variablelist>
|
---|
157 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
158 | <?dbfo list-presentation="list"?>
|
---|
159 |
|
---|
160 | <varlistentry id="onsgmls">
|
---|
161 | <term><command>onsgmls</command></term>
|
---|
162 | <listitem><para>is used to process <acronym>SGML</acronym> files.</para>
|
---|
163 | <indexterm zone="opensp onsgmls">
|
---|
164 | <primary sortas="b-onsgmls">onsgmls</primary>
|
---|
165 | </indexterm></listitem>
|
---|
166 | </varlistentry>
|
---|
167 |
|
---|
168 | <varlistentry id="osgmlnorm">
|
---|
169 | <term><command>osgmlnorm</command></term>
|
---|
170 | <listitem><para>prints on the standard output a normalized document instance
|
---|
171 | for the SGML document contained in the concatenation of the entities with
|
---|
172 | system identifiers .nf and .fi.</para>
|
---|
173 | <indexterm zone="opensp osgmlnorm">
|
---|
174 | <primary sortas="b-osgmlnorm">osgmlnorm</primary>
|
---|
175 | </indexterm></listitem>
|
---|
176 | </varlistentry>
|
---|
177 |
|
---|
178 | <varlistentry id="ospam">
|
---|
179 | <term><command>ospam</command></term>
|
---|
180 | <listitem><para>is a markup stream editor.</para>
|
---|
181 | <indexterm zone="opensp ospam">
|
---|
182 | <primary sortas="b-ospam">ospam</primary>
|
---|
183 | </indexterm></listitem>
|
---|
184 | </varlistentry>
|
---|
185 |
|
---|
186 | <varlistentry id="ospcat">
|
---|
187 | <term><command>ospcat</command></term>
|
---|
188 | <listitem><para>prints effective system identifiers found in the
|
---|
189 | catalogs.</para>
|
---|
190 | <indexterm zone="opensp ospcat">
|
---|
191 | <primary sortas="b-ospcat">ospcat</primary>
|
---|
192 | </indexterm></listitem>
|
---|
193 | </varlistentry>
|
---|
194 |
|
---|
195 | <varlistentry id="ospent">
|
---|
196 | <term><command>ospent</command></term>
|
---|
197 | <listitem><para>provides access to <application>OpenSP</application>'s
|
---|
198 | entity manager.</para>
|
---|
199 | <indexterm zone="opensp ospent">
|
---|
200 | <primary sortas="b-ospent">ospent</primary>
|
---|
201 | </indexterm></listitem>
|
---|
202 | </varlistentry>
|
---|
203 |
|
---|
204 | <varlistentry id="osx">
|
---|
205 | <term><command>osx</command></term>
|
---|
206 | <listitem><para>is an <acronym>SGML</acronym> normalizer or used to convert
|
---|
207 | <acronym>SGML</acronym> files to <acronym>XML</acronym> files.</para>
|
---|
208 | <indexterm zone="opensp osx">
|
---|
209 | <primary sortas="b-osx">osx</primary>
|
---|
210 | </indexterm></listitem>
|
---|
211 | </varlistentry>
|
---|
212 |
|
---|
213 | <varlistentry id="nsgmls">
|
---|
214 | <term><command>nsgmls</command></term>
|
---|
215 | <listitem><para>is a symlink to <command>onsgmls</command>.</para>
|
---|
216 | <indexterm zone="opensp nsgmls">
|
---|
217 | <primary sortas="g-nsgmls">nsgmls</primary>
|
---|
218 | </indexterm></listitem>
|
---|
219 | </varlistentry>
|
---|
220 |
|
---|
221 | <varlistentry id="sgml2xml">
|
---|
222 | <term><command>sgml2xml</command></term>
|
---|
223 | <listitem><para>is a symlink to <command>osx</command>.</para>
|
---|
224 | <indexterm zone="opensp sgml2xml">
|
---|
225 | <primary sortas="g-sgml2xml">sgml2xml</primary>
|
---|
226 | </indexterm></listitem>
|
---|
227 | </varlistentry>
|
---|
228 |
|
---|
229 | <varlistentry id="sgmlnorm">
|
---|
230 | <term><command>sgmlnorm</command></term>
|
---|
231 | <listitem><para>is a symlink to <command>osgmlnorm</command>.</para>
|
---|
232 | <indexterm zone="opensp sgmlnorm">
|
---|
233 | <primary sortas="g-sgmlnorm">sgmlnorm</primary>
|
---|
234 | </indexterm></listitem>
|
---|
235 | </varlistentry>
|
---|
236 |
|
---|
237 | <varlistentry id="spam">
|
---|
238 | <term><command>spam</command></term>
|
---|
239 | <listitem><para>is a symlink to <command>ospam</command>.</para>
|
---|
240 | <indexterm zone="opensp spam">
|
---|
241 | <primary sortas="g-spam">spam</primary>
|
---|
242 | </indexterm></listitem>
|
---|
243 | </varlistentry>
|
---|
244 |
|
---|
245 | <varlistentry id="spcat">
|
---|
246 | <term><command>spcat</command></term>
|
---|
247 | <listitem><para>is a symlink to <command>ospcat</command>.</para>
|
---|
248 | <indexterm zone="opensp spcat">
|
---|
249 | <primary sortas="g-spcat">spcat</primary>
|
---|
250 | </indexterm></listitem>
|
---|
251 | </varlistentry>
|
---|
252 |
|
---|
253 | <varlistentry id="spent">
|
---|
254 | <term><command>spent</command></term>
|
---|
255 | <listitem><para>is a symlink to <command>ospent</command>.</para>
|
---|
256 | <indexterm zone="opensp spent">
|
---|
257 | <primary sortas="g-spent">spent</primary>
|
---|
258 | </indexterm></listitem>
|
---|
259 | </varlistentry>
|
---|
260 |
|
---|
261 | <varlistentry id="sx">
|
---|
262 | <term><command>sx</command></term>
|
---|
263 | <listitem><para>is a symlink to <command>osx</command>.</para>
|
---|
264 | <indexterm zone="opensp sx">
|
---|
265 | <primary sortas="g-sx">sx</primary>
|
---|
266 | </indexterm></listitem>
|
---|
267 | </varlistentry>
|
---|
268 |
|
---|
269 | <varlistentry id="libosp">
|
---|
270 | <term><filename class='libraryfile'>libosp.so</filename></term>
|
---|
271 | <listitem><para>contains functions required by the
|
---|
272 | <application>OpenSP</application> programs to parse, validate and
|
---|
273 | manipulate SGML and XML files.</para>
|
---|
274 | <indexterm zone="opensp libosp">
|
---|
275 | <primary sortas="c-libosp">libosp.so</primary>
|
---|
276 | </indexterm></listitem>
|
---|
277 | </varlistentry>
|
---|
278 |
|
---|
279 | <varlistentry id="libsp">
|
---|
280 | <term><filename class='libraryfile'>libsp.so</filename></term>
|
---|
281 | <listitem><para>is a symlink to
|
---|
282 | <filename class='libraryfile'>libosp.so</filename>.</para>
|
---|
283 | <indexterm zone="opensp libsp">
|
---|
284 | <primary sortas="g-libsp">libsp.so</primary>
|
---|
285 | </indexterm></listitem>
|
---|
286 | </varlistentry>
|
---|
287 | </variablelist>
|
---|
288 |
|
---|
289 | </sect2>
|
---|
290 |
|
---|
291 | </sect1>
|
---|
292 |
|
---|