1 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
2 | "http://www.oasis-open.org/docbook/xml/4.3/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-size "1.4 MB">
|
---|
9 | <!ENTITY opensp-buildsize "43 MB">
|
---|
10 | <!ENTITY opensp-time "1.03 SBU">
|
---|
11 | ]>
|
---|
12 |
|
---|
13 | <sect1 id="opensp" xreflabel="OpenSP-&opensp-version;">
|
---|
14 | <sect1info>
|
---|
15 | <othername>$LastChangedBy$</othername>
|
---|
16 | <date>$Date$</date>
|
---|
17 | </sect1info>
|
---|
18 | <?dbhtml filename="opensp.html"?>
|
---|
19 | <title>OpenSP-&opensp-version;</title>
|
---|
20 |
|
---|
21 | <sect2>
|
---|
22 | <title>Introduction to <application>OpenSP</application></title>
|
---|
23 |
|
---|
24 | <para>The <application>OpenSP</application> package contains a
|
---|
25 | <application>C++</application> library for using
|
---|
26 | <acronym>SGML</acronym>/<acronym>XML</acronym> files.
|
---|
27 | This is useful for validating, parsing and manipulating
|
---|
28 | <acronym>SGML</acronym> and <acronym>XML</acronym>
|
---|
29 | documents.</para>
|
---|
30 |
|
---|
31 | <sect3><title>Package information</title>
|
---|
32 | <itemizedlist spacing='compact'>
|
---|
33 | <listitem><para>Download (HTTP): <ulink
|
---|
34 | url="&opensp-download-http;"/></para></listitem>
|
---|
35 | <listitem><para>Download (FTP): <ulink
|
---|
36 | url="&opensp-download-ftp;"/></para></listitem>
|
---|
37 | <listitem><para>Download size: &opensp-size;</para></listitem>
|
---|
38 | <listitem><para>Estimated disk space required:
|
---|
39 | &opensp-buildsize;</para></listitem>
|
---|
40 | <listitem><para>Estimated build time:
|
---|
41 | &opensp-time;</para></listitem></itemizedlist>
|
---|
42 | </sect3>
|
---|
43 |
|
---|
44 | <sect3><title>Additional downloads</title>
|
---|
45 | <itemizedlist spacing='compact'>
|
---|
46 | <listitem><para>Required Patch (removes some annoying messages that can appear
|
---|
47 | while running <command>openjade</command>): <ulink
|
---|
48 | url="&patch-root;/OpenSP-&opensp-version;-LITLEN-1.patch"/></para></listitem>
|
---|
49 | <listitem><para>Required Patch (if using
|
---|
50 | <application>GCC</application>-3.4.x): <ulink
|
---|
51 | url="&patch-root;/OpenSP-&opensp-version;-gcc34-1.patch"/></para></listitem>
|
---|
52 | </itemizedlist></sect3>
|
---|
53 |
|
---|
54 | <sect3><title><application>OpenSP</application> dependencies</title>
|
---|
55 | <sect4><title>Required</title>
|
---|
56 | <para><xref linkend="sgml-common"/></para></sect4>
|
---|
57 | </sect3>
|
---|
58 |
|
---|
59 | </sect2>
|
---|
60 |
|
---|
61 | <sect2>
|
---|
62 | <title>Installation of <application>OpenSP</application></title>
|
---|
63 |
|
---|
64 | <para>Install <application>OpenSP</application> by running the following
|
---|
65 | commands:</para>
|
---|
66 |
|
---|
67 | <screen><userinput><command>patch -Np1 -i ../OpenSP-&opensp-version;-LITLEN-1.patch &&
|
---|
68 | patch -Np1 -i ../OpenSP-&opensp-version;-gcc34-1.patch &&
|
---|
69 | ./configure --prefix=/usr --disable-static --enable-http \
|
---|
70 | --enable-default-catalog=/etc/sgml/catalog \
|
---|
71 | --enable-default-search-path=/usr/share/sgml &&
|
---|
72 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; &&
|
---|
73 | make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version; install &&
|
---|
74 | ln -sf onsgmls /usr/bin/nsgmls &&
|
---|
75 | ln -sf osgmlnorm /usr/bin/sgmlnorm &&
|
---|
76 | ln -sf ospam /usr/bin/spam &&
|
---|
77 | ln -sf ospcat /usr/bin/spcat &&
|
---|
78 | ln -sf ospent /usr/bin/spent &&
|
---|
79 | ln -sf osx /usr/bin/sx &&
|
---|
80 | ln -sf osx /usr/bin/sgml2xml &&
|
---|
81 | ln -sf libosp.so /usr/lib/libsp.so</command></userinput></screen>
|
---|
82 |
|
---|
83 | <!-- install-catalog -add /etc/sgml/OpenSP-&opensp-version;.cat \
|
---|
84 | /usr/share/sgml/OpenSP-&opensp-version;/catalog &&
|
---|
85 | install-catalog -add /etc/sgml/sgml-docbook.cat \
|
---|
86 | /etc/sgml/OpenSP-&opensp-version;.cat</command></userinput></screen>
|
---|
87 |
|
---|
88 | <tip><title>Update hint</title>
|
---|
89 | <para>Remove the above catalog items prior to upgrading with:
|
---|
90 | <screen><command>install-catalog -remove /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat \
|
---|
91 | /usr/share/sgml/OpenSP-<replaceable>[version]</replaceable>/catalog &&
|
---|
92 | install-catalog -remove /etc/sgml/sgml-docbook.cat \
|
---|
93 | /etc/sgml/OpenSP-<replaceable>[version]</replaceable>.cat</command></screen></para></tip> -->
|
---|
94 |
|
---|
95 | </sect2>
|
---|
96 |
|
---|
97 | <sect2>
|
---|
98 | <title>Command explanations</title>
|
---|
99 |
|
---|
100 | <para><option>--disable-static</option>: This switch prevents
|
---|
101 | the building of the static library.</para>
|
---|
102 |
|
---|
103 | <para><option>--enable-http</option>: This switch adds support
|
---|
104 | for <acronym>HTTP</acronym>.</para>
|
---|
105 |
|
---|
106 | <para><parameter>--enable-default-catalog=/etc/sgml/catalog</parameter>: This
|
---|
107 | switch sets the path to the centralized catalog.</para>
|
---|
108 |
|
---|
109 | <para><parameter>--enable-default-search-path</parameter>: This switch
|
---|
110 | sets the default value of <envar>SGML_SEARCH_PATH</envar>.</para>
|
---|
111 |
|
---|
112 | <para><option>--enable-xml-messages</option>: This switch adds
|
---|
113 | support for <acronym>XML</acronym> Formatted Messages.</para>
|
---|
114 |
|
---|
115 | <para><command>make pkgdatadir=/usr/share/sgml/OpenSP-&opensp-version;</command>:
|
---|
116 | This sets the pkgdatadir variable in the <filename>Makefile</filename> from
|
---|
117 | <filename class="directory">/usr/share/OpenSP</filename> to
|
---|
118 | <filename class="directory">/usr/share/sgml/OpenSP-&opensp-version;</filename>.</para>
|
---|
119 |
|
---|
120 | <para><screen><command>ln -sf onsgmls /usr/bin/nsgmls
|
---|
121 | ln -sf osgmlnorm /usr/bin/sgmlnorm
|
---|
122 | ln -sf ospam /usr/bin/spam
|
---|
123 | ln -sf ospcat /usr/bin/spcat
|
---|
124 | ln -sf ospent /usr/bin/spent
|
---|
125 | ln -sf osx /usr/bin/sx
|
---|
126 | ln -sf osx /usr/bin/sgml2xml
|
---|
127 | ln -sf libosp.so /usr/lib/libsp.so</command></screen>
|
---|
128 | These commands create the <application>SP</application> equivalents of
|
---|
129 | <application>OpenSP</application> executables and libraries.</para>
|
---|
130 |
|
---|
131 | </sect2>
|
---|
132 |
|
---|
133 | <sect2>
|
---|
134 | <title>Contents</title>
|
---|
135 |
|
---|
136 | <para>The <application>OpenSP</application> package contains
|
---|
137 | <command>onsgmls</command>,
|
---|
138 | <command>ospam</command>,
|
---|
139 | <command>osx</command>,
|
---|
140 | <command>ospcat</command> and
|
---|
141 | <command>ospent</command>.</para>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2><title>Description</title>
|
---|
146 |
|
---|
147 | <sect3><title>onsgmls</title>
|
---|
148 | <para><command>onsgmls</command> processes <acronym>SGML</acronym>
|
---|
149 | files.</para></sect3>
|
---|
150 |
|
---|
151 | <sect3><title>ospam</title>
|
---|
152 | <para><command>ospam</command> is a markup stream editor.</para></sect3>
|
---|
153 |
|
---|
154 | <sect3><title>osx</title>
|
---|
155 | <para><command>osx</command> is a <acronym>SGML</acronym> normalizer or a
|
---|
156 | converter of <acronym>SGML</acronym> to <acronym>XML</acronym>.</para></sect3>
|
---|
157 |
|
---|
158 | <sect3><title>ospcat</title>
|
---|
159 | <para><command>ospcat</command> prints effective system identifiers found in
|
---|
160 | the catalogs.</para></sect3>
|
---|
161 |
|
---|
162 | <sect3><title>ospent</title>
|
---|
163 | <para><command>ospent</command> provides access to
|
---|
164 | <application>OpenSP</application>'s entity manager.</para></sect3>
|
---|
165 |
|
---|
166 | </sect2>
|
---|
167 |
|
---|
168 | </sect1>
|
---|
169 |
|
---|