1 <refentry id="install-catalog">
4 <firstname>Eric</firstname> <surname>Bischoff</surname>
6 <address><email>ebisch@cybercable.tm.fr</email></address>
11 <refentrytitle>install-catalog</refentrytitle>
12 <manvolnum>8</manvolnum>
16 <refname>install-catalog</refname>
17 <refpurpose>Manage a SGML or XML centralized catalog</refpurpose>
22 <command>install-catalog</command>
23 <arg>option <synopfragmentref linkend="option"></synopfragmentref></arg>
24 <arg choice="req" rep="repeat">action <synopfragmentref linkend="action"></synopfragmentref></arg>
26 <synopfragment id="option"><group>
27 <arg><option>-d</option></arg>
28 <arg><option>--delegate</option></arg>
29 </group></synopfragment>
31 <synopfragment id="action"><group>
32 <arg><option>-a</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg>
33 <arg><option>--add</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg><sbr>
34 <arg><option>-r</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg>
35 <arg><option>--remove</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg><sbr>
36 <arg><option>-h</option></arg>
37 <arg><option>--help</option></arg><sbr>
38 <arg><option>-v</option></arg>
39 <arg><option>--version</option></arg>
40 </group></synopfragment>
46 <title>Description</title>
48 <para>This shell script allows to handle a centralized catalog
49 referencing other "ordinary" SGML or XML Open Catalogs.</para>
51 <para>An <firstterm>Open Catalog</firstterm> contains
52 a set of directives defined by OASIS, mostly used
53 for defining equivalences between FPIs (Formal Public
54 Identifiers) and real file names (see TR9401:1997 on <ulink
55 url="http://www.oasis-open.org">http://www.oasis-open.org</ulink>).
56 The Open Catalogs usually reside in
57 <filename>/usr/share/sgml</filename>.</para>
59 <para>A <firstterm>centralized catalog</firstterm> is a special
60 Open Catalog that includes only comments and CATALOG directives
61 pointing to other catalogs (or DELEGATE directives if supported). The
62 centralized catalog can be the key to all other SGML resources. It
63 usually resides in <filename>/etc/sgml</filename>.</para>
65 <para>The centralized catalog can be edited manually or through the
66 <application>install-catalog</application> script to add or remove
67 references to other ordinary catalogs. This script is mainly destined
68 to software package post-installation scripts.</para>
70 <para>An example of a typical call to install-catalog is:
73 install-catalog --add \
74 /usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog \
75 /etc/sgml/sgml-docbook-4.0.cat
79 <para>This call will install in
80 <filename>/etc/sgml/sgml-docbook-4.0.cat</filename> a reference to
81 <filename>/usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog</filename>.</para>
86 <title>Options</title>
88 <para>Here is the list of options that can influence the way
89 <application>install-catalog</application> works:</para>
95 <arg><option>-d</option></arg>
96 <arg><option>--delegate</option></arg>
97 </group></cmdsynopsis>
100 <para>Use DELEGATE instead of CATALOG directives to specify a pointer</para>
108 <title>Actions</title>
110 <para>Here is the list of actions that can be requested to
111 <application>install-catalog</application>:</para>
117 <arg><option>-a</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg>
118 <arg><option>--add</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg>
119 </group></cmdsynopsis>
122 <para>Declare a new SGML package.</para>
129 <arg><option>-r</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg>
130 <arg><option>--remove</option> <replaceable>centralized</replaceable> <replaceable>ordinary</replaceable></arg>
131 </group></cmdsynopsis>
134 <para>Remove a previously installed SGML package.</para>
141 <arg><option>-h</option></arg>
142 <arg><option>--help</option></arg>
143 </group></cmdsynopsis>
146 <para>Print a short help message and exit</para>
153 <arg><option>-v</option></arg>
154 <arg><option>--version</option></arg>
155 </group></cmdsynopsis>
158 <para>Print the version identifier and exit</para>
171 <filename>/etc/sgml/*</filename>
174 <para>The SGML centralized catalogs</para>
181 <title>Authors</title>
186 Eric Bischoff <email>ebisch@cybercable.tm.fr</email>
189 <para>Developper of install-catalog.</para>
198 <title>See Also</title>
203 <citerefentry> <refentrytitle>jw</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
206 <para>conversion from DocBook to other file formats
213 <!-- Next line is a hack to force a paragraph break in the man-page. -->
214 <cmdsynopsis> <command></command> </cmdsynopsis>
215 <citerefentry> <refentrytitle>nsgmls</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
218 <para>a base component of <application>Jade</application> DSSSL engine
225 <!-- Next line is a hack to force a paragraph break in the man-page. -->
226 <cmdsynopsis> <command></command> </cmdsynopsis>
227 <ulink url="http://sourceware.cygnus.com/docbook-tools/">http://sourceware.cygnus.com/docbook-tools/</ulink></glossterm>
229 <para>the home page of the DocBook tools, a compendium of
230 all tools necessary to process DocBook files, including
231 the SGML-common stuff.