doc/refentry/install-catalog.sgml

   1 <refentry id="install-catalog">
   2   <docinfo>
   3     <author>
   4       <firstname>Eric</firstname> <surname>Bischoff</surname>
   5       <affiliation>
   6         <address><email>ebisch@cybercable.tm.fr</email></address>
   7       </affiliation>
   8     </author>
   9   </docinfo>
  10   <refmeta>
  11     <refentrytitle>install-catalog</refentrytitle>
  12     <manvolnum>8</manvolnum>
  13   </refmeta>
  14
  15   <refnamediv>
  16     <refname>install-catalog</refname>
  17     <refpurpose>Manage a SGML or XML centralized catalog</refpurpose>
  18   </refnamediv>
  19
  20   <refsynopsisdiv>
  21     <cmdsynopsis>
  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>
  25
  26       <synopfragment id="option"><group>
  27         <arg><option>-d</option></arg>
  28         <arg><option>--delegate</option></arg>
  29       </group></synopfragment>
  30
  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>
  41
  42     </cmdsynopsis>
  43   </refsynopsisdiv>
  44
  45   <refsect1>
  46     <title>Description</title>
  47
  48     <para>This shell script allows to handle a centralized catalog
  49     referencing other "ordinary" SGML or XML Open Catalogs.</para>
  50
  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>
  58
  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>
  64
  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>
  69
  70     <para>An example of a typical call to install-catalog is:
  71
  72       <screen>
  73       install-catalog --add \
  74         /usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog \
  75         /etc/sgml/sgml-docbook-4.0.cat
  76       </screen>
  77     </para>
  78
  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>
  82
  83   </refsect1>
  84
  85   <refsect1>
  86     <title>Options</title>
  87
  88     <para>Here is the list of options that can influence the way
  89     <application>install-catalog</application> works:</para>
  90
  91     <glosslist>
  92       <glossentry>
  93         <glossterm>
  94           <cmdsynopsis><group>
  95             <arg><option>-d</option></arg>
  96             <arg><option>--delegate</option></arg>
  97           </group></cmdsynopsis>
  98         </glossterm>
  99         <glossdef>
 100           <para>Use DELEGATE instead of CATALOG directives to specify a pointer</para>
 101         </glossdef>
 102       </glossentry>
 103
 104     </glosslist>
 105   </refsect1>
 106
 107   <refsect1>
 108     <title>Actions</title>
 109
 110     <para>Here is the list of actions that can be requested to
 111     <application>install-catalog</application>:</para>
 112
 113     <glosslist>
 114       <glossentry>
 115         <glossterm>
 116           <cmdsynopsis><group>
 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>
 120         </glossterm>
 121         <glossdef>
 122           <para>Declare a new SGML package.</para>
 123         </glossdef>
 124       </glossentry>
 125
 126       <glossentry>
 127         <glossterm>
 128           <cmdsynopsis><group>
 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>
 132         </glossterm>
 133         <glossdef>
 134           <para>Remove a previously installed SGML package.</para>
 135         </glossdef>
 136       </glossentry>
 137
 138       <glossentry>
 139         <glossterm>
 140           <cmdsynopsis><group>
 141             <arg><option>-h</option></arg>
 142             <arg><option>--help</option></arg>
 143           </group></cmdsynopsis>
 144         </glossterm>
 145         <glossdef>
 146           <para>Print a short help message and exit</para>
 147         </glossdef>
 148       </glossentry>
 149
 150       <glossentry>
 151         <glossterm>
 152           <cmdsynopsis><group>
 153             <arg><option>-v</option></arg>
 154             <arg><option>--version</option></arg>
 155           </group></cmdsynopsis>
 156         </glossterm>
 157         <glossdef>
 158           <para>Print the version identifier and exit</para>
 159         </glossdef>
 160       </glossentry>
 161     </glosslist>
 162
 163   </refsect1>
 164
 165   <refsect1>
 166     <title>Files</title>
 167     <glosslist>
 168
 169       <glossentry>
 170         <glossterm>
 171           <filename>/etc/sgml/*</filename>
 172         </glossterm>
 173         <glossdef>
 174           <para>The SGML centralized catalogs</para>
 175         </glossdef>
 176       </glossentry>
 177     </glosslist>
 178   </refsect1>
 179
 180   <refsect1>
 181     <title>Authors</title>
 182     <glosslist>
 183
 184       <glossentry>
 185         <glossterm>
 186           Eric Bischoff <email>ebisch@cybercable.tm.fr</email>
 187         </glossterm>
 188         <glossdef>
 189           <para>Developper of install-catalog.</para>
 190         </glossdef>
 191       </glossentry>
 192
 193     </glosslist>
 194
 195   </refsect1>
 196
 197   <refsect1>
 198     <title>See Also</title>
 199     <glosslist>
 200
 201       <glossentry>
 202         <glossterm>
 203           <citerefentry> <refentrytitle>jw</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
 204         </glossterm>
 205         <glossdef>
 206           <para>conversion from DocBook to other file formats
 207           </para>
 208         </glossdef>
 209       </glossentry>
 210
 211       <glossentry>
 212         <glossterm>
 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>
 216         </glossterm>
 217         <glossdef>
 218           <para>a base component of <application>Jade</application> DSSSL engine
 219           </para>
 220         </glossdef>
 221       </glossentry>
 222
 223       <glossentry>
 224         <glossterm>
 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>
 228         <glossdef>
 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.
 232           </para>
 233         </glossdef>
 234       </glossentry>
 235
 236     </glosslist>
 237   </refsect1>
 238
 239 </refentry>