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 sgml-common-download-http "https://sourceware.org/ftp/docbook-tools/new-trials/SOURCES/sgml-common-&sgml-common-version;.tgz">
|
---|
8 | <!ENTITY sgml-common-download-ftp "ftp://sourceware.org/pub/docbook-tools/new-trials/SOURCES/sgml-common-&sgml-common-version;.tgz">
|
---|
9 | <!ENTITY sgml-common-md5sum "103c9828f24820df86e55e7862e28974">
|
---|
10 | <!ENTITY sgml-common-size "75 KB">
|
---|
11 | <!ENTITY sgml-common-buildsize "1.5 MB">
|
---|
12 | <!ENTITY sgml-common-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="sgml-common" xreflabel="sgml-common-&sgml-common-version;">
|
---|
16 | <?dbhtml filename="sgml-common.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <date>$Date$</date>
|
---|
20 | </sect1info>
|
---|
21 |
|
---|
22 | <title>sgml-common-&sgml-common-version;</title>
|
---|
23 |
|
---|
24 | <indexterm zone="sgml-common">
|
---|
25 | <primary sortas="a-SGML-Common">SGML Common</primary>
|
---|
26 | </indexterm>
|
---|
27 |
|
---|
28 | <sect2 role="package">
|
---|
29 | <title>Introduction to SGML Common</title>
|
---|
30 |
|
---|
31 | <para>
|
---|
32 | The <application>SGML Common</application> package contains
|
---|
33 | <command>install-catalog</command>. This is useful for creating and
|
---|
34 | maintaining centralized SGML catalogs.
|
---|
35 | </para>
|
---|
36 |
|
---|
37 | &lfs110a_checked;
|
---|
38 |
|
---|
39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
40 | <itemizedlist spacing="compact">
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (HTTP): <ulink url="&sgml-common-download-http;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download (FTP): <ulink url="&sgml-common-download-ftp;"/>
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download MD5 sum: &sgml-common-md5sum;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Download size: &sgml-common-size;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated disk space required: &sgml-common-buildsize;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | <listitem>
|
---|
67 | <para>
|
---|
68 | Estimated build time: &sgml-common-time;
|
---|
69 | </para>
|
---|
70 | </listitem>
|
---|
71 | </itemizedlist>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
74 | <itemizedlist spacing='compact'>
|
---|
75 | <listitem>
|
---|
76 | <para>
|
---|
77 | Required patch: <ulink url=
|
---|
78 | "&patch-root;/sgml-common-&sgml-common-version;-manpage-1.patch"/>
|
---|
79 | </para>
|
---|
80 | </listitem>
|
---|
81 | </itemizedlist>
|
---|
82 |
|
---|
83 | <para condition="html" role="usernotes">User Notes:
|
---|
84 | <ulink url="&blfs-wiki;/sgml-common"/></para>
|
---|
85 |
|
---|
86 | </sect2>
|
---|
87 |
|
---|
88 | <sect2 role="installation">
|
---|
89 | <title>Installation of SGML Common</title>
|
---|
90 |
|
---|
91 | <para>
|
---|
92 | Instead of the normal convention of including the autotools files
|
---|
93 | in the package, the maintainers included symlinks to the files in
|
---|
94 | <filename class="directory">/usr/share/automake</filename>. For previous
|
---|
95 | versions of <application>Automake</application> this convention is
|
---|
96 | correct, but recent versions of <application>Automake</application>
|
---|
97 | install the internal files in version specific directories. This causes
|
---|
98 | the <command>configure</command> script to abort. To fix this error, the
|
---|
99 | autotools are regenerated. Since the included
|
---|
100 | <filename>Makefile.am</filename> file uses a syntax not supported by
|
---|
101 | current versions of <application>Automake</application>, a patch is
|
---|
102 | required to fix the syntax.
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <screen><userinput>patch -Np1 -i ../sgml-common-0.6.3-manpage-1.patch &&
|
---|
106 | autoreconf -f -i</userinput></screen>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | Install <application>SGML Common</application> by
|
---|
110 | running the following commands:
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
114 | make</userinput></screen>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | This package does not come with a test suite.
|
---|
118 | </para>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <screen role="root"><userinput>make docdir=/usr/share/doc install &&
|
---|
125 |
|
---|
126 | install-catalog --add /etc/sgml/sgml-ent.cat \
|
---|
127 | /usr/share/sgml/sgml-iso-entities-8879.1986/catalog &&
|
---|
128 |
|
---|
129 | install-catalog --add /etc/sgml/sgml-docbook.cat \
|
---|
130 | /etc/sgml/sgml-ent.cat</userinput></screen>
|
---|
131 |
|
---|
132 | <tip>
|
---|
133 | <title>Update Hint</title>
|
---|
134 |
|
---|
135 | <para>
|
---|
136 | Remove the above catalog items prior to upgrading (as the
|
---|
137 | <systemitem class='username'>root</systemitem> user) with:
|
---|
138 | </para>
|
---|
139 |
|
---|
140 | <screen role="nodump"><userinput>install-catalog --remove /etc/sgml/sgml-ent.cat \
|
---|
141 | /usr/share/sgml/sgml-iso-entities-8879.1986/catalog &&
|
---|
142 |
|
---|
143 | install-catalog --remove /etc/sgml/sgml-docbook.cat \
|
---|
144 | /etc/sgml/sgml-ent.cat</userinput></screen>
|
---|
145 |
|
---|
146 | </tip>
|
---|
147 |
|
---|
148 | </sect2>
|
---|
149 |
|
---|
150 | <sect2 role="configuration">
|
---|
151 | <title>Configuring SGML Common</title>
|
---|
152 |
|
---|
153 | <sect3 id="sgml-common-config">
|
---|
154 | <title>Config Files</title>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | <filename>/etc/sgml/sgml.conf</filename>
|
---|
158 | </para>
|
---|
159 |
|
---|
160 | <indexterm zone="sgml-common sgml-common-config">
|
---|
161 | <primary sortas="e-etc-sgml-sgml.conf">/etc/sgml/sgml.conf</primary>
|
---|
162 | </indexterm>
|
---|
163 |
|
---|
164 | </sect3>
|
---|
165 |
|
---|
166 | <sect3>
|
---|
167 | <title>Configuration Information</title>
|
---|
168 |
|
---|
169 | <para>
|
---|
170 | No change in this file is necessary.
|
---|
171 | </para>
|
---|
172 |
|
---|
173 | </sect3>
|
---|
174 |
|
---|
175 | </sect2>
|
---|
176 |
|
---|
177 | <sect2 role="content">
|
---|
178 | <title>Contents</title>
|
---|
179 |
|
---|
180 | <segmentedlist>
|
---|
181 | <segtitle>Installed Programs</segtitle>
|
---|
182 | <segtitle>Installed Libraries</segtitle>
|
---|
183 | <segtitle>Installed Files</segtitle>
|
---|
184 | <segtitle>Installed Directories</segtitle>
|
---|
185 |
|
---|
186 | <seglistitem>
|
---|
187 | <seg>install-catalog and sgmlwhich</seg>
|
---|
188 | <seg>None</seg>
|
---|
189 | <seg>SGML and XML DocBook entity files</seg>
|
---|
190 | <seg>/etc/sgml, /usr/share/doc/sgml-common-&sgml-common-version;, and
|
---|
191 | /usr/share/sgml</seg>
|
---|
192 | </seglistitem>
|
---|
193 | </segmentedlist>
|
---|
194 |
|
---|
195 | <variablelist>
|
---|
196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
197 | <?dbfo list-presentation="list"?>
|
---|
198 | <?dbhtml list-presentation="table"?>
|
---|
199 |
|
---|
200 | <varlistentry id="install-catalog">
|
---|
201 | <term><command>install-catalog</command></term>
|
---|
202 | <listitem>
|
---|
203 | <para>
|
---|
204 | creates a centralized catalog that maintains references to
|
---|
205 | catalogs scattered throughout the
|
---|
206 | <filename class="directory">/usr/share/sgml</filename> directory
|
---|
207 | tree
|
---|
208 | </para>
|
---|
209 | <indexterm zone="sgml-common install-catalog">
|
---|
210 | <primary sortas="b-install-catalog">install-catalog</primary>
|
---|
211 | </indexterm>
|
---|
212 | </listitem>
|
---|
213 | </varlistentry>
|
---|
214 |
|
---|
215 | <varlistentry id="sgmlwhich">
|
---|
216 | <term><command>sgmlwhich</command></term>
|
---|
217 | <listitem>
|
---|
218 | <para>
|
---|
219 | prints to standard output the name of the main configuration file
|
---|
220 | </para>
|
---|
221 | <indexterm zone="sgml-common sgmlwhich">
|
---|
222 | <primary sortas="b-sgmlwhich">sgmlwhich</primary>
|
---|
223 | </indexterm>
|
---|
224 | </listitem>
|
---|
225 | </varlistentry>
|
---|
226 |
|
---|
227 | <varlistentry id="SGML-entities">
|
---|
228 | <term><filename>SGML entities files</filename></term>
|
---|
229 | <listitem>
|
---|
230 | <para>
|
---|
231 | contains the basic character entities defined with SDATA entries
|
---|
232 | </para>
|
---|
233 | <indexterm zone="sgml-common SGML-entities">
|
---|
234 | <primary sortas="g-SGML-ENT-files">SGML entity files</primary>
|
---|
235 | </indexterm>
|
---|
236 | </listitem>
|
---|
237 | </varlistentry>
|
---|
238 |
|
---|
239 | <varlistentry id="XML-entities">
|
---|
240 | <term><filename>XML entities files</filename></term>
|
---|
241 | <listitem>
|
---|
242 | <para>
|
---|
243 | contains the basic character entities defined by a hexadecimal
|
---|
244 | representation of the Unicode character number
|
---|
245 | </para>
|
---|
246 | <indexterm zone="sgml-common XML-entities">
|
---|
247 | <primary sortas="g-XML-ENT-files">XML entity files</primary>
|
---|
248 | </indexterm>
|
---|
249 | </listitem>
|
---|
250 | </varlistentry>
|
---|
251 |
|
---|
252 | </variablelist>
|
---|
253 |
|
---|
254 | </sect2>
|
---|
255 |
|
---|
256 | </sect1>
|
---|