TIVI-153: add as dependency for iputils
[profile/ivi/sgml-common.git] / doc / man / install-catalog.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "INSTALL-CATALOG" "8" "04 August 2000" "" ""
7 .SH NAME
8 install-catalog \- Manage a SGML or XML centralized catalog
9 .SH SYNOPSIS
10
11 \fBinstall-catalog\fR [ \fBoption \fR]  \fBaction \fR\fI ...\fR [ \fB [ -d]  [ --delegate] \fR]  [ \fB [ -a \fIcentralized\fB \fIordinary\fB]  [ --add \fIcentralized\fB \fIordinary\fB] 
12
13  [ -r \fIcentralized\fB \fIordinary\fB]  [ --remove \fIcentralized\fB \fIordinary\fB] 
14
15  [ -h]  [ --help] 
16
17  [ -v]  [ --version] \fR] 
18
19 .SH "DESCRIPTION"
20 .PP
21 This shell script allows to handle a centralized catalog
22 referencing other "ordinary" SGML or XML Open Catalogs.
23 .PP
24 An \fIOpen Catalog\fR contains
25 a set of directives defined by OASIS, mostly used
26 for defining equivalences between FPIs (Formal Public
27 Identifiers) and real file names (see TR9401:1997 on http://www.oasis-open.org <URL:http://www.oasis-open.org>).
28 The Open Catalogs usually reside in
29 \fI/usr/share/sgml\fR.
30 .PP
31 A \fIcentralized catalog\fR is a special
32 Open Catalog that includes only comments and CATALOG directives
33 pointing to other catalogs (or DELEGATE directives if supported). The
34 centralized catalog can be the key to all other SGML resources. It
35 usually resides in \fI/etc/sgml\fR.
36 .PP
37 The centralized catalog can be edited manually or through the
38 \fBinstall-catalog\fR script to add or remove
39 references to other ordinary catalogs. This script is mainly destined
40 to software package post-installation scripts.
41 .PP
42 An example of a typical call to install-catalog is:
43
44 .nf
45       install-catalog --add \\
46         /usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog \\
47         /etc/sgml/sgml-docbook-4.0.cat
48       
49 .fi
50 .PP
51 This call will install in
52 \fI/etc/sgml/sgml-docbook-4.0.cat\fR a reference to
53 \fI/usr/share/sgml/docbook/dsssl-stylesheets-1.54/catalog\fR.
54 .SH "OPTIONS"
55 .PP
56 Here is the list of options that can influence the way
57 \fBinstall-catalog\fR works:
58
59  [ \fB [ -d]  [ --delegate] \fR] 
60
61 .PP
62 Use DELEGATE instead of CATALOG directives to specify a pointer
63 .SH "ACTIONS"
64 .PP
65 Here is the list of actions that can be requested to
66 \fBinstall-catalog\fR:
67
68  [ \fB [ -a \fIcentralized\fB \fIordinary\fB]  [ --add \fIcentralized\fB \fIordinary\fB] \fR] 
69
70 .PP
71 Declare a new SGML package.
72
73  [ \fB [ -r \fIcentralized\fB \fIordinary\fB]  [ --remove \fIcentralized\fB \fIordinary\fB] \fR] 
74
75 .PP
76 Remove a previously installed SGML package.
77
78  [ \fB [ -h]  [ --help] \fR] 
79
80 .PP
81 Print a short help message and exit
82
83  [ \fB [ -v]  [ --version] \fR] 
84
85 .PP
86 Print the version identifier and exit
87 .SH "FILES"
88 \fI/etc/sgml/*\fR
89 .PP
90 The SGML centralized catalogs
91 .SH "AUTHORS"
92 Eric Bischoff <ebisch@cybercable.tm.fr>
93 .PP
94 Developper of install-catalog.
95 .SH "SEE ALSO"
96 \fBjw\fR(1)
97 .PP
98 conversion from DocBook to other file formats
99
100 \fB\fR
101
102 \fBnsgmls\fR(1)
103 .PP
104 a base component of \fBJade\fR DSSSL engine
105
106 \fB\fR
107
108 http://sourceware.cygnus.com/docbook-tools/ <URL:http://sourceware.cygnus.com/docbook-tools/>
109 .PP
110 the home page of the DocBook tools, a compendium of
111 all tools necessary to process DocBook files, including
112 the SGML-common stuff.