| blob | eb0600dc28deb8dba871b0b781391539513c59be |
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH PKGCHK 1M "Oct 30, 2007"
7 .SH NAME
8 pkgchk \- check package installation accuracy
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBpkgchk\fR [\fB-l\fR | \fB-acfnqvx\fR] [\fB-i\fR \fIfile\fR | -]
13 [\fB-p\fR \fIpath\fR... | \fB-P\fR \fIpartial-path\fR...] [\fB-R\fR \fIroot_path\fR]
14 [ [\fB-m\fR \fIpkgmap\fR [\fB-e\fR \fIenvfile\fR]] | pkginst... | \fB-Y\fR \fIcategory\fR,\fIcategory\fR\&.\|.\|.]
15 .fi
17 .LP
18 .nf
19 \fBpkgchk\fR \fB-d\fR \fIdevice\fR [\fB-l\fR | \fB-fv\fR] [\fB-i\fR \fIfile\fR | -] [\fB-M\fR] [\fB-p\fR \fIpath\fR]...
20 [\fB-V\fR \fIfs_file\fR]
21 [pkginst... | \fB-Y\fR \fIcategory\fR[,\fIcategory\fR\&.\|.\|.]]
22 .fi
24 .SH DESCRIPTION
25 .sp
26 .LP
27 \fBpkgchk\fR checks the accuracy of installed files or, by using the \fB-l\fR
28 option, displays information about package files. \fBpkgchk\fR checks the
29 integrity of directory structures and files. Discrepancies are written to
30 standard error along with a detailed explanation of the problem.
31 .sp
32 .LP
33 The first synopsis defined above is used to list or check the contents and/or
34 attributes of objects that are currently installed on the system, or in the
35 indicated \fBpkgmap\fR. Package names may be listed on the command line, or by
36 default, the entire contents of a machine will be checked.
37 .sp
38 .LP
39 The second synopsis is used to list or check the contents of a package which
40 has been spooled on the specified device, but not installed. Note that
41 attributes cannot be checked for spooled packages.
42 .SH OPTIONS
43 .sp
44 .LP
45 The following options are supported:
46 .sp
47 .ne 2
48 .na
49 \fB\fB-a\fR\fR
50 .ad
51 .sp .6
52 .RS 4n
53 Audit the file attributes only and do not check file contents. Default is to
54 check both.
55 .RE
57 .sp
58 .ne 2
59 .na
60 \fB\fB-c\fR\fR
61 .ad
62 .sp .6
63 .RS 4n
64 Audit the file contents only and do not check file attributes. Default is to
65 check both.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB\fR\fB-d\fR \fIdevice\fR\fR
72 .ad
73 .sp .6
74 .RS 4n
75 Specify the device on which a spooled package resides. \fIdevice\fR can be a
76 directory path name or the identifiers for tape, floppy disk, or removable disk
77 (for example, \fB/var/tmp\fR or \fB/dev/diskette\fR).
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB\fR\fB-e\fR \fIenvfile\fR\fR
84 .ad
85 .sp .6
86 .RS 4n
87 Request that the package information file named as \fIenvfile\fR be used to
88 resolve parameters noted in the specified \fBpkgmap\fR file.
89 .RE
91 .sp
92 .ne 2
93 .na
94 \fB\fB-f\fR\fR
95 .ad
96 .sp .6
97 .RS 4n
98 Correct file attributes if possible. If used with the \fB-x\fR option, this
99 option removes hidden files. When \fBpkgchk\fR is invoked with this option, it
100 creates directories, named pipes, links, and special devices if they do not
101 already exist. If the \fB-d\fR option calls out an uninstalled package, the
102 \fB-f\fR option will only take effect if the package is in directory (not
103 stream) format. All file attributes will be set to agree with the entries in
104 the \fBpkgmap\fR file except that setuid, setgid, and sticky bits will not be
105 set in the mode.
106 .RE
108 .sp
109 .ne 2
110 .na
111 \fB\fB\fR\fB-i\fR \fIfile\fR | \fB-\fR\fR
112 .ad
113 .sp .6
114 .RS 4n
115 Read a list of path names from \fIfile\fR or from stdin (\fB-\fR) and compare
116 this list against the installation software database or the indicated
117 \fBpkgmap\fR file. Path names that are not contained in \fIfile\fR or stdin are
118 not checked.
119 .RE
121 .sp
122 .ne 2
123 .na
124 \fB\fB-l\fR\fR
125 .ad
126 .sp .6
127 .RS 4n
128 List information on the selected files that make up a package. This option is
129 not compatible with the \fB-a\fR, \fB-c\fR, \fB-f\fR, \fB-g\fR, and \fB-v\fR
130 options.
131 .RE
133 .sp
134 .ne 2
135 .na
136 \fB\fB-m\fR \fBpkgmap\fR\fR
137 .ad
138 .sp .6
139 .RS 4n
140 Check the package against the package map file, \fBpkgmap\fR.
141 .RE
143 .sp
144 .ne 2
145 .na
146 \fB\fB-M\fR\fR
147 .ad
148 .sp .6
149 .RS 4n
150 Instruct \fBpkgchk\fR not to use the \fB$\fR\fIroot_path\fR\fB/etc/vfstab\fR
151 file for determining the client's mount points. This option assumes the mount
152 points are correct on the server and it behaves consistently with Solaris 2.5
153 and earlier releases.
154 .RE
156 .sp
157 .ne 2
158 .na
159 \fB\fB-n\fR\fR
160 .ad
161 .sp .6
162 .RS 4n
163 Do not check volatile or editable files' contents. This should be used for most
164 post-installation checking.
165 .RE
167 .sp
168 .ne 2
169 .na
170 \fB\fB\fR\fB-p\fR \fIpath\fR\fR
171 .ad
172 .sp .6
173 .RS 4n
174 Check the accuracy only of the path name or path names listed. \fIpath\fR can
175 be one or more path names separated by commas (or by whitespace, if the list is
176 quoted).
177 .sp
178 To specify a \fIpath\fR that includes a comma, you must use the \fB-i\fR
179 option, described above. See EXAMPLES.
180 .RE
182 .sp
183 .ne 2
184 .na
185 \fB\fB\fR\fB-P\fR \fIpartial-path\fR\fR
186 .ad
187 .sp .6
188 .RS 4n
189 Check the accuracy of only the partial path name or path names listed.
190 \fIpartial-path\fR can be one or more partial path names separated by commas
191 (or by whitespace, if the list is quoted). This option can be used instead of
192 \fB-p\fR and is not compatible with the other option. This option matches any
193 path name that contains the string contained in the partial path. See the note
194 about paths that contain commas in the description of \fB-p\fR.
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fB-q\fR\fR
201 .ad
202 .sp .6
203 .RS 4n
204 Quiet mode. Do not give messages about missing files.
205 .RE
207 .sp
208 .ne 2
209 .na
210 \fB\fB-R\fR \fIroot_path\fR\fR
211 .ad
212 .sp .6
213 .RS 4n
214 Define the full name of a directory to use as the \fIroot_path\fR. All files,
215 including package system information files, are relocated to a directory tree
216 starting in the specified \fIroot_path\fR. The \fIroot_path\fR may be specified
217 when installing to a client from a server (for example,
218 \fB/export/root/client1\fR).
219 .LP
220 Note -
221 .sp
222 .RS 2
223 The root file system of any non-global zones must not be referenced with the
224 \fB-R\fR option. Doing so might damage the global zone's file system, might
225 compromise the security of the global zone, and might damage the non-global
226 zone's file system. See \fBzones\fR(5).
227 .RE
228 .RE
230 .sp
231 .ne 2
232 .na
233 \fB\fB-v\fR\fR
234 .ad
235 .sp .6
236 .RS 4n
237 Verbose mode. Files are listed as processed.
238 .RE
240 .sp
241 .ne 2
242 .na
243 \fB\fB-V\fR \fIfs_file\fR\fR
244 .ad
245 .sp .6
246 .RS 4n
247 Specify an alternative \fIfs_file\fR to map the client's file systems. For
248 example, used in situations where the \fB$\fR\fIroot_path\fR\fB/etc/vfstab\fR
249 file is non-existent or unreliable.
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fB-x\fR\fR
256 .ad
257 .sp .6
258 .RS 4n
259 Search exclusive directories, looking for files which exist that are not in the
260 installation software database or the indicated \fBpkgmap\fR file.
261 .RE
263 .sp
264 .ne 2
265 .na
266 \fB\fB-Y\fR \fIcategory\fR\fR
267 .ad
268 .sp .6
269 .RS 4n
270 Check packages based on the value of the \fBCATEGORY\fR parameter stored in the
271 installed or spooled package's \fBpkginfo\fR(4) file.
272 .RE
274 .SH OPERANDS
275 .sp
276 .ne 2
277 .na
278 \fB\fIpkginst\fR\fR
279 .ad
280 .sp .6
281 .RS 4n
282 The package instance or instances to be checked. The format
283 \fIpkginst\fR\fB\&.*\fR can be used to check all instances of a package. The
284 default is to display all information about all installed packages.
285 .sp
286 The asterisk character (\fB*\fR) is a special character to some shells and may
287 need to be escaped. In the C-Shell, an asterisk must be surrounded by single
288 quotes (\fB\&'\fR) or preceded by a backslash (\e);
289 .RE
291 .sp
292 .ne 2
293 .na
294 \fB\fIpartial-path\fR\fR
295 .ad
296 .sp .6
297 .RS 4n
298 A portion of a path, such as a file or directory name.
299 .RE
301 .SH EXAMPLES
302 .LP
303 \fBExample 1 \fRUsing \fBpkgchk\fR for Displaying Package Installation
304 Information
305 .sp
306 .LP
307 The following example displays package installation information for
308 \fB/usr/bin/ls\fR:
310 .sp
311 .in +2
312 .nf
313 example% \fBpkgchk -l -p /usr/bin/ls\fR
314 .fi
315 .in -2
316 .sp
318 .LP
319 \fBExample 2 \fRChecking on Java Font Properties
320 .sp
321 .LP
322 The following example displays package installation information for all Java
323 font properties installed on the system.
325 .sp
326 .in +2
327 .nf
328 example% \fBpkgchk -l -P font.properties\fR
329 .fi
330 .in -2
331 .sp
333 .LP
334 \fBExample 3 \fRSpecifying a Path That Contains a Comma
335 .sp
336 .LP
337 Assume you want to specify the path:
339 .sp
340 .in +2
341 .nf
342 /platform/SUNW,Netra-T12/lib
343 .fi
344 .in -2
345 .sp
347 .sp
348 .LP
349 List this path in a file. Here is one way in which you can do that:
351 .sp
352 .in +2
353 .nf
354 example% \fBecho "/platform/SUNW,Netra-T12/lib" > /tmp/p\fR
355 .fi
356 .in -2
357 .sp
359 .sp
360 .LP
361 You can then enter:
363 .sp
364 .in +2
365 .nf
366 example% \fBpkgchk -i /tmp/p -l\fR
367 Pathname: /platform/SUNW,Netra-T12/lib
368 Type: directory
369 Expected mode: 0755
370 Expected owner: root
371 Expected group: bin
372 Referenced by the following packages:
373 SUNWcar
374 Current status: installed
375 .fi
376 .in -2
377 .sp
379 .SH EXIT STATUS
380 .sp
381 .ne 2
382 .na
383 \fB\fB0\fR\fR
384 .ad
385 .sp .6
386 .RS 4n
387 Successful completion.
388 .RE
390 .sp
391 .ne 2
392 .na
393 \fB\fB>0\fR\fR
394 .ad
395 .sp .6
396 .RS 4n
397 An error occurred.
398 .RE
400 .SH SEE ALSO
401 .sp
402 .LP
403 \fBpkginfo\fR(1), \fBpkgtrans\fR(1), \fBpkgadd\fR(1M), \fBpkgask\fR(1M),
404 \fBpkgrm\fR(1M), \fBpkginfo\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5)
405 .sp
406 .LP
407 \fI\fR
408 .SH NOTES
409 .sp
410 .LP
411 Package commands are \fBlargefile\fR(5)-aware. They handle files larger than 2
412 GB in the same way they handle smaller files. In their current implementations,
413 \fBpkgadd\fR(1M), \fBpkgtrans\fR(1) and other package commands can process a
414 datastream of up to 4 GB.