File: dh_installxmlcatalogs.1

package info (click to toggle)
xml-core 0.19
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 244 kB
  • sloc: perl: 565; makefile: 141; sh: 46; xml: 10
file content (221 lines) | stat: -rw-r--r-- 8,419 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DH_INSTALLXMLCATALOGS 1"
.TH DH_INSTALLXMLCATALOGS 1 "2023-12-12" "perl v5.36.0" "Debhelper"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
dh_installxmlcatalogs \- install and register XML catalog files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_installxmlcatalogs\fR [\fIdebhelper\ options\fR] [\fB\-n\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_installxmlcatalogs\fR is a debhelper program that installs and
registers \s-1XML\s0 catalog files.  It complies with the Debian \s-1XML/SGML\s0
policy.
.PP
The file \fIdebian/\fIpackage\fI.xmlcatalogs\fR lists the local \s-1XML\s0 catalog
files to be installed per package as well as the \s-1XML\s0 entities in those
local \s-1XML\s0 catalog files that are to be registered in the \s-1XML\s0 catalog
system.
.PP
The local \s-1XML\s0 catalog file entries in that file should be of the form
\&\f(CW\*(C`local;source;dest\*(C'\fR, where the verbatim \f(CW\*(C`local\*(C'\fR indicates this is an
entry for a local \s-1XML\s0 catalog file, \f(CW\*(C`source\*(C'\fR indicates where the
local \s-1XML\s0 catalog resides in the source tree, and \f(CW\*(C`dest\*(C'\fR indicates
the destination location for the local \s-1XML\s0 catalog under the package
build area.  \f(CW\*(C`dest\*(C'\fR should start with \fI/usr/share/xml/\fR.
.PP
The entries for the \s-1XML\s0 entities to be registered in the package \s-1XML\s0
catalog file should be of the form \f(CW\*(C`package;type;id;catalog\*(C'\fR, where
the verbatim \f(CW\*(C`package\*(C'\fR indicates this is an entry for an \s-1XML\s0 entity
to be registered in the package \s-1XML\s0 catalog file, \f(CW\*(C`type\*(C'\fR indicates
the \s-1XML\s0 entity type (public, system, uri), \f(CW\*(C`id\*(C'\fR indicates the \s-1XML\s0
entity id, and \f(CW\*(C`catalog\*(C'\fR indicates the local \s-1XML\s0 catalog file.
.PP
The entries for the \s-1XML\s0 entities to be registered in the root \s-1XML\s0
catalog file should be of the form \f(CW\*(C`root;type;id\*(C'\fR, where the verbatim
\&\f(CW\*(C`root\*(C'\fR indicates this is an entry for an \s-1XML\s0 entity to be registered
in the root \s-1XML\s0 catalog file, \f(CW\*(C`type\*(C'\fR indicates the \s-1XML\s0 entity type
(public, system, uri), and \f(CW\*(C`id\*(C'\fR indicates the \s-1XML\s0 entity id.
.PP
If an entry for is to be registered identically in the root catalog
and the package catalog file, you can use the form
\&\f(CW\*(C`root\-and\-package;type;id;catalog\*(C'\fR, where the verbatim
\&\f(CW\*(C`root\-and\-package\*(C'\fR indicates this is an entry for an \s-1XML\s0 entity to be
registered in both the root and package \s-1XML\s0 catalog files, \f(CW\*(C`type\*(C'\fR
indicates the \s-1XML\s0 entity type (public, system, uri), \f(CW\*(C`id\*(C'\fR indicates
the \s-1XML\s0 entity id, and \f(CW\*(C`catalog\*(C'\fR indicates the local \s-1XML\s0 catalog
file.
.PP
\&\s-1XML\s0 entity types are described in \fBupdate\-xmlcatalog\fR\|(8).  Using the
\&\f(CW\*(C`root\*(C'\fR or \f(CW\*(C`package\*(C'\fR commands, a type of \f(CW\*(C`public\*(C'\fR will general
\&\f(CW\*(C`delegatePublic\*(C'\fR statements in the applicable catalog file. Generally
you will want to use the types \f(CW\*(C`public\*(C'\fR for any formal public
identifiers, and \f(CW\*(C`system\*(C'\fR for any files on the local filesystem or
URLs.  \f(CW\*(C`uri\*(C'\fR is only used for non-local files which are not part of
the external document subset, e.g., they are not used for entities or
DTDs.
.PP
\&\fBdh_installxmlcatalogs\fR automatically adds maintainer script snippets
for the registration and unregistration of the listed \s-1XML\s0 entities in
the \s-1XML\s0 catalog system (unless \fB\-n\fR is used).	A dependency on the
\&\fBxml-core\fR package will be added to \f(CW\*(C`${misc:Depends}\*(C'\fR, so be sure to
use that variable in the file \fIdebian/control\fR.  See
\&\fBdh_installdeb\fR\|(1) for an explanation of Debhelper maintainer script
snippets.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-n\fR, \fB\-\-noscripts\fR" 4
.IX Item "-n, --noscripts"
Do not modify \fIpostinst\fR/\fIpostrm\fR/\fIprerm\fR scripts.
.SH "NOTES"
.IX Header "NOTES"
Note that this command is not idempotent. \*(L"dh_clean \-k\*(R" should be
called between invocations of this command. Otherwise, it may cause
multiple instances of the same text to be added to maintainer scripts.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebhelper\fR\|(7)
.PP
\&\fI/usr/share/doc/xml\-core/\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\fBArdo van Rangelrooij\fR <ardo@debian.org>
.PP
\&\fBAdam Di Carlo\fR <aph@debian.org>