1packagetoc(4) File Formats packagetoc(4)
2
6 packagetoc - package table of contents description file
7
9 The package table of contents file, .packagetoc, is an ASCII file con‐
10 taining all of the information necessary for installing a product
11 release distributed in package form. It centralizes and summarizes all
12 of the relevant information about each package in the product. This
13 allows the install software to quickly read one file to obtain all of
14 the relevant information about each package instead of having to exam‐
15 ine each package at run time to obtain this information. The .package‐
16 toc file resides in the top-level directory containing the product.
17 If a .packagetoc file exists for a product, there must also be a .order
20 file.
21 Each entry in the .packagetoc file is a line that establishes the value
24 of a parameter in the following form:
25 PARAM=value
27 A line starting with a pound-sign, ``#'', is considered a comment and
31 is ignored.
32 Parameters are grouped by package. The start of a package description
35 is defined by a line of the form:
36 PKG=value
38 There is no order implied or assumed for specifying the parameters for
42 a package with the exception of the PKG parameter, which must appear
43 first. Only one occurrence of a parameter is permitted per package.
44 The parameters recognized are described below. Those marked with an
47 asterisk are mandatory.
48 PKG* The package identifier, for example, SUNWaccu. The
50 maximum length of the identifier is nine characters.
51 All the characters must be alphanumeric. The first
52 character must be alphabetic. install, new, and all are
53 reserved identifiers.
54 PKGDIR* The name of the directory containing the package. This
57 directory is relative to the directory containing the
58 product.
59 NAME* The full name of the package.
62 VENDOR The name of the package's vendor.
65 VERSION The version of the package.
68 PRODNAME The name of the product to which this package belongs.
71 PRODVERS The version of the product to which this package
74 belongs.
75 SUNW_PKGTYPE The package type. Valid values are:
78 root indicates that the package will be installed in
80 the / file system. The root packages are the
81 only packages installed during dataless client
82 installations. The root packages are spooled
83 during a server installation to allow the later
84 installation of diskless clients.
85 usr indicates that the package will be installed in
88 the /usr file system.
89 kvm indicates that the package will be installed in
92 the /usr/platform file system.
93 ow indicates a package that is part of the bundled
96 OpenWindows product release. If no SUNW_PKGTYPE
97 macro is present, the package is assumed to be
98 of type usr.
99 ARCH* The architecture(s) supported by the package. This
103 macro is taken from the package's pkginfo(4) file and
104 is subject to the same length and formatting con‐
105 straints.
106 The install program currently assumes that exactly one
108 architecture token is specified for a package. For
109 example, ARCH=sparc.sun4u is acceptable, but
110 ARCH=sparc.sun4u, sparc.sun4m is not.
111 DESC A detailed textual description of the package.
114 BASEDIR* The default installation base directory of the package.
117 SUNW_PDEPEND A dependency specification for a prerequisite package.
120 Each prerequisite dependency must appear as a separate
121 macro. See depend(4) for more information on dependen‐
122 cies and instance specifications.
123 SUNW_IDEPEND A dependency specification for an incompatible package.
126 Each incompatible dependency should appear as a sepa‐
127 rate macro. See depend(4) for more information on
128 dependencies and instance specifications.
129 SUNW_RDEPEND A dependency specification for a reversed package
132 dependency. Each reverse dependency should appear as a
133 separate macro. See depend(4) for more information on
134 dependencies and instance specifications.
135 CATEGORY The category of the package.
138 SUNW_LOC Indicates that this package contains localizations for
141 other packages. Such localization packages are treated
142 as special case packages. Each package which has a
143 SUNW_LOC macro must have a corresponding SUNW_PKGLIST
144 macro. The value specified by this macro should be a
145 valid locale.
146 SUNW_PKGLIST A comma separated list of package identifiers. Cur‐
149 rently this macro is used to indicate which packages
150 are localized by a localization package.
151 ROOTSIZE* The space used by the package in the / file system.
154 USRSIZE* The space used by the package in the /usr subtree of
157 the file system.
158 VARSIZE* The space used by the package in the /var subtree of
161 the file system.
162 OPTSIZE* The space used by the package in the /opt subtree of
165 the file system.
166 EXPORTSIZE* The space used by the package in the /export subtree of
169 the file system.
170 USROWNSIZE* The space used by the package in the /usr/openwin sub‐
173 tree of the file system.
174 SPOOLEDSIZE* The space used by the spooled version of this package.
177 This is used during the setup of a server by the ini‐
178 tial system installation programs.
179 All sizes are specified in bytes. Default disk partitions and file
183 system sizes are derived from the values provided: accuracy is impor‐
184 tant.
185
187 Example 1 A Sample .packagetoc File
188 The following is an example package entry in a .packagetoc file.
191 #ident "@(#)packagetoc.4 1.2 92/04/28"
194 PKG=SUNWaccr
195 PKGDIR=SUNWaccr
196 NAME=System Accounting, (Root)
197 VENDOR=Sun Microsystems, Inc.
198 VERSION=8.1
199 PRODNAME=SunOS
200 PRODVERS=5.0beta2
201 SUNW_PKGTYPE=root
202 ARCH=sparc
203 DESC=System Accounting, (Root)
204 BASEDIR=/
205 CATEGORY=system
206 ROOTSIZE=11264
207 VARSIZE= 15360
208 OPTSIZE=0
209 EXPORTSIZE=0
210 USRSIZE=0
211 USROWNSIZE=0
212
216 cdtoc(4), clustertoc(4), depend(4), order(4), pkginfo(4), pkgmap(4)
217
219 The parameters NAME, VENDOR, VERSION, PRODNAME, PRODVERS, SUNW_PKGTYPE,
220 SUNW_LOC, SUNW_PKGLIST, ARCH, DESC, BASEDIR, and CATEGORY are assumed
221 to have been taken directly from the package's pkginfo(4) file. The
222 length and formatting restrictions placed on the values for these
223 parameters are identical to those for the corresponding entries in the
224 pkginfo(4) file.
225 The value specified for the parameter PKGDIR should not exceed 255
228 characters.
229 The value specified for the parameters ROOTSIZE, VARSIZE, OPTSIZE,
232 EXPORTSIZE, USRSIZE and USROWNSIZE must be a single integer value. The
233 values can be derived from the package's pkgmap file by counting all
234 space consumed by any files installed in the applicable file system.
235 The space includes that used for directory entries and any UFS overhead
236 that exists because of the way the files are represented (directory
237 allocation scheme; direct, indirect, double indirect blocks; fragments;
238 etc.)
239 The following kinds of entries in the pkgmap(4) file should be
242 included in the space derivation:
243 f regular file
245 c character special file
248 b block special file
251 p pipe
254 l hard link
257 s symbolic link
260 x, d directory
263 i packaging installation script or information file (copyright,
266 depend, postinstall, postremove)
267SunOS 5.11 19 Nov 2002 packagetoc(4)