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