1pkgmap(4) File Formats pkgmap(4)
2
6 pkgmap - package contents description file
7
9 pkgmap is an ASCII file that provides a complete listing of the package
10 contents. It is automatically generated by pkgmk(1) using the informa‐
11 tion in the prototype(4) file.
12 Each entry in pkgmap describes a single ``deliverable object file.'' A
15 deliverable object file includes shell scripts, executable objects,
16 data files, directories, and so forth. The entry consists of several
17 fields of information, each field separated by a space. The fields are
18 described below and must appear in the order shown.
19 part An optional field designating the part number in which the
21 object resides. A part is a collection of files and is the
22 atomic unit by which a package is processed. A developer
23 can choose the criteria for grouping files into a part (for
24 example, based on class). If no value is defined in this
25 field, part 1 is assumed.
26 ftype A one-character field that indicates the file type. Valid
29 values are listed below. File types are divided between
30 those that are not to be modified and those that are modi‐
31 fiable.
32 Files of the following types must never be modified:
34 b block special device
36 c character special device
39 d directory
42 f a standard executable file, data file, or other type
45 of file, the contents of which must never be modified.
46 i information file (such as a file containing a copy‐
49 right, list of dependencies, or package information)
50 or installation script (such as checkinstall, class
51 action [i.], pre/post install/remove), the contents of
52 which must never be modified.
53 l linked file
56 p named pipe
59 s symbolic link
62 x an exclusive directory accessible only by this package
65 Files of the following types can be modified:
67 e An editable file, intended to be edited (selectively
69 modified) after installation. An editable file is
70 expected to change on installation or removal, can be
71 shared by several packages, and must be installed by a
72 class action script. Examples are a configuration file
73 or a list of users.
74 v A volatile file, intended to be overwritten or
77 appended to after installation. A volatile file is not
78 expected to change on installation or removal, is not
79 preserved between installations, and can be installed
80 by a class action script. Examples are a log file or a
81 lock file.
82 Following package installation, the contents of files of
84 all types except e and v must not change. Any file that is
85 subject to change should be marked as e or v.
86 class The installation class to which the file belongs. This name
89 must contain only alphanumeric characters and be no longer
90 than 12 characters. It is not specified if the ftype is i
91 (information file).
92 pathname pathname may contain variables of the form $variable that
95 support install-time configuration of the file. variable
96 may be embedded in the pathname structure. (See proto‐
97 type(4) for definitions of variable specifications.)
98 Do not use the following reserved words in pathname, since
100 they are applied by pkgadd(1M) using a different mechanism:
101 PKG_INSTALL_ROOT
103 BASEDIR
104 CLIENT_BASEDIR
105 major The major device number. The field is only specified for
110 block or character special devices.
111 minor The minor device number. The field is only specified for
114 block or character special devices.
115 mode The octal mode of the file (for example, 0664). A question
118 mark (?) indicates that the mode will be left unchanged,
119 implying that the file already exists on the target
120 machine. This field is not used for linked files, packaging
121 information files, or non-installable files.
122 The mode can contain a variable specification. (See proto‐
124 type(4) for definitions of variable specifications.)
125 owner The owner of the file (for example, bin or root). The field
128 is limited to 14 characters in length. A question mark (?)
129 indicates that the owner will be left unchanged or changed
130 to the owner stored in the package database, which could be
131 different from what is on the file system. When the ques‐
132 tion mark is used, it implies that the file is already on
133 the file system. This field is not used for linked files or
134 non-installable files. It is used optionally with a package
135 information file. If used, it indicates with what owner an
136 installation script will be executed.
137 The owner can contain a variable specification. (See proto‐
139 type(4) for definitions of variable specifications.)
140 group The group to which the file belongs (for example, bin or
143 sys). The field is limited to 14 characters in length. A
144 question mark (?) indicates that the group will be left
145 unchanged or changed to the owner stored in the package
146 database, which could be different from what is on the file
147 system. When the question mark is used, it implies that the
148 file is already on the file system. This field is not used
149 for linked files or non-installable files. It is used
150 optionally with a package information file. If used, it
151 indicates with what group an installation script will be
152 executed.
153 The group can contain a variable specification. (See proto‐
155 type(4) for definitions of variable specifications.)
156 size The actual size of the file in bytes. This field is not
159 specified for named pipes, special devices, directories or
160 linked files.
161 cksum The checksum of the file contents. This field is not speci‐
164 fied for named pipes, special devices, directories, or
165 linked files.
166 modtime The time of last modification, as reported by the stat(2)
169 function call. This field is not specified for named pipes,
170 special devices, directories, or linked files.
171 Each pkgmap file must have one line that provides information about the
175 number of parts, maximum size of parts that make up the package, and,
176 optionally, the size of the package after compression (where size is
177 given in 512-byte blocks). This line is in the following format:
178 : number_of_parts maximum_part_size compressed_pkg_size
181 Lines that begin with ``#'' are comment lines and are ignored.
184 When files are saved during installation before they are overwritten,
187 they are normally just copied to a temporary pathname. However, for
188 files whose mode includes execute permission (but which are not
189 editable), the existing version is linked to a temporary pathname and
190 the original file is removed. This allows processes which are executing
191 during installation to be overwritten.
192
194 Example 1 A Sample pkgmap File
195 : 2 500
197 1 i pkginfo 237 1179 541296672
198 1 b class1 /dev/diskette 17 134 0644 root other
199 1 c class1 /dev/rdiskette 17 134 0644 root other
200 1 d none bin 0755 root bin
201 1 f none bin/INSTALL 0755 root bin 11103 17954 541295535
202 1 f none bin/REMOVE 0755 root bin 3214 50237 541295541
203 1 l none bin/UNINSTALL=bin/REMOVE
204 1 f none bin/cmda 0755 root bin 3580 60325 541295567
205 1 f none bin/cmdb 0755 root bin 49107 51255 541438368
206 1 f class1 bin/cmdc 0755 root bin 45599 26048 541295599
207 1 f class1 bin/cmdd 0755 root bin 4648 8473 541461238
208 1 f none bin/cmde 0755 root bin 40501 1264 541295622
209 1 f class2 bin/cmdf 0755 root bin 2345 35889 541295574
210 1 f none bin/cmdg 0755 root bin 41185 47653 541461242
211 2 d class2 data 0755 root bin
212 2 p class1 data/apipe 0755 root other
213 2 d none log 0755 root bin
214 2 v none log/logfile 0755 root bin 41815 47563 541461333
215 2 d none save 0755 root bin
216 2 d none spool 0755 root bin
217 2 d none tmp 0755 root bin
218
222 pkgmk(1), pkgadd(1M), stat(2), pkginfo(4), prototype(4)
223 Application Packaging Developer's Guide
226
228 The pkgmap file may contain only one entry per unique pathname.
229SunOS 5.11 12 Jul 2006 pkgmap(4)