| blob | 59d4b17eec72ac90436096cbdfbee9c2e1ad8231 |
1 '\" te
2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH PKGINFO 4 "Mar 24, 2006"
8 .SH NAME
9 pkginfo \- package characteristics file
10 .SH DESCRIPTION
11 .sp
12 .LP
13 \fBpkginfo\fR is an \fBASCII\fR file that describes the characteristics of the
14 package along with information that helps control the flow of installation. It
15 is created by the software package developer.
16 .sp
17 .LP
18 Each entry in the \fBpkginfo\fR file is a line that establishes the value of a
19 parameter in the following form:
20 .sp
21 .in +2
22 .nf
23 PARAM="\fIvalue\fR"
24 .fi
25 .in -2
27 .sp
28 .LP
29 There is no required order in which the parameters must be specified within the
30 file. The \fBPKG\fR, \fBNAME\fR, \fBARCH\fR, \fBVERSION\fR and \fBCATEGORY\fR
31 parameters are mandatory. Other parameters are optional.
32 .sp
33 .LP
34 \fBpkginfo\fR provides optional parameters and an environment variable in
35 support of the zones (multiple Solaris environments) feature. See
36 \fBzones\fR(5).
37 .sp
38 .LP
39 The following paramaters are mandatory:
40 .sp
41 .ne 2
42 .na
43 \fB\fBARCH\fR\fR
44 .ad
45 .sp .6
46 .RS 4n
47 A comma-separated list of alphanumeric tokens that indicate the architecture
48 associated with the package. The \fBpkgmk\fR(1) tool can be used to create or
49 modify this value when actually building the package. The maximum length of a
50 token is 16 characters and it cannot include a comma.
51 .sp
52 Solaris's installation software meaningfully uses only one architecture token
53 of the form:
54 .sp
55 .in +2
56 .nf
57 <\fIinstruction_set_architecture\fR>[.<\fIplatform_group\fR>]
58 .fi
59 .in -2
61 where \fIplatform_group\fR is intended only for Solaris installation packages.
62 Third party application software should restrict itself to \fBARCH\fR values
63 from the following Solaris-supported instruction set architectures (\fBuname
64 -p\fR): \fBsparc\fR, \fBi386\fR, and \fBppc\fR. Examples of Solaris' platform
65 groups (\fBuname -m\fR) are \fBsun4u\fR for the \fBSPARC\fR instruction set and
66 \fBi86pc\fR for the i386 instruction set. See \fBuname\fR(1) and
67 \fBisalist\fR(1) for more details.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fBCATEGORY\fR\fR
74 .ad
75 .sp .6
76 .RS 4n
77 A comma-separated list of categories under which a package can be displayed. A
78 package must at least belong to the system or application category. Categories
79 are case-insensitive and can contain only alphanumerics. Each category is
80 limited in length to 16 characters.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fBNAME\fR\fR
87 .ad
88 .sp .6
89 .RS 4n
90 Text that specifies the package name (maximum length of 256 \fBASCII\fR
91 characters). Use the \fBNAME\fR parameter as the foundation for describing the
92 functionality and purpose of the package; spell out any acronyms and avoid
93 internal product/project code names. The \fBDESC\fR parameter can then be used
94 to expand the descriptive information. Use the \fBNAME\fR parameter to state as
95 specifically as possible the use of the package, why a user would need to load
96 it, and so on.
97 .RE
99 .sp
100 .ne 2
101 .na
102 \fB\fBPKG\fR\fR
103 .ad
104 .sp .6
105 .RS 4n
106 Abbreviation for the package being installed. All characters in the
107 abbreviation must be alphanumeric. You can also use the \fB\(mi\fR and \fB+\fR
108 characters in the abbreviation. The first character cannot be numeric, a
109 \fB+\fR or a \fB-\fR.
110 .sp
111 The abbreviation is limited to a maximum length of 32 characters.
112 \fBinstall\fR, \fBnew\fR, and \fBall\fR are reserved abbreviations. It is
113 customary to make the first four letters unique to your company, such as the
114 company's stock symbol.
115 .RE
117 .sp
118 .ne 2
119 .na
120 \fB\fBVERSION\fR\fR
121 .ad
122 .sp .6
123 .RS 4n
124 Text that specifies the current version associated with the software package.
125 The maximum length is 256 \fBASCII\fR characters and the first character cannot
126 be a left parenthesis. The \fBpkgmk\fR(1) tool can be used to create or modify
127 this value when actually building the package. Current Solaris software
128 practice is to assign this parameter monotonically increasing Dewey decimal
129 values of the form:
130 .sp
131 .in +2
132 .nf
133 <\fImajor_revision\fR>.<\fIminor_revision\fR>[.<\fImicro_revision\fR>]
134 .fi
135 .in -2
137 where all the revision fields are integers. The versioning fields can be
138 extended to an arbitrary string of numbers in Dewey-decimal format, if
139 necessary.
140 .RE
142 .sp
143 .LP
144 The following parameters are optional:
145 .sp
146 .ne 2
147 .na
148 \fB\fBBASEDIR\fR\fR
149 .ad
150 .sp .6
151 .RS 4n
152 The pathname to a default directory where "relocatable" files can be installed.
153 If blank, the package is not relocatable and any files that have relative
154 pathnames are not installed. An administrator can override the default
155 directory.
156 .RE
158 .sp
159 .ne 2
160 .na
161 \fB\fBCLASSES\fR\fR
162 .ad
163 .sp .6
164 .RS 4n
165 A space-separated list of classes defined for a package. The order of the list
166 determines the order in which the classes are installed. Classes listed first
167 are installed first (on a media by media basis). This parameter can be modified
168 by the request script.
169 .RE
171 .sp
172 .ne 2
173 .na
174 \fB\fBDESC\fR\fR
175 .ad
176 .sp .6
177 .RS 4n
178 Text that describes the package (maximum length of 256 \fBASCII\fR characters).
179 This parameter value is used to provide the installer with a description of
180 what the package contains and should build on the description provided in the
181 \fBNAME\fR parameter. Try to make the two parameters work together so that a
182 \fBpkginfo\fR \fB-l\fR provides a fairly comprehensive textual description of
183 the package.
184 .RE
186 .sp
187 .ne 2
188 .na
189 \fB\fBEMAIL\fR\fR
190 .ad
191 .sp .6
192 .RS 4n
193 An electronic address where further information is available or bugs can be
194 reported (maximum length of 256 \fBASCII\fR characters).
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fB\fBHOTLINE\fR\fR
201 .ad
202 .sp .6
203 .RS 4n
204 Phone number and/or mailing address where further information can be received
205 or bugs can be reported (maximum length of 256 \fBASCII\fR characters).
206 .RE
208 .sp
209 .ne 2
210 .na
211 \fB\fBINTONLY\fR\fR
212 .ad
213 .sp .6
214 .RS 4n
215 Indicates that the package should only be installed interactively when set to
216 any non-null value.
217 .RE
219 .sp
220 .ne 2
221 .na
222 \fB\fBISTATES\fR\fR
223 .ad
224 .sp .6
225 .RS 4n
226 A list of allowable run states for package installation (for example, "\fBS s
227 1\fR" allows run states of \fBS\fR, \fBs\fR or \fB1\fR). The Solaris operating
228 environment supports the run levels \fBs\fR, \fBS\fR, \fB0\fR, \fB1\fR,
229 \fB2\fR, \fB3\fR, \fB5\fR, and \fB6\fR. Applicable run levels for this
230 parameter are \fBs\fR, \fBS\fR, \fB1\fR, \fB2\fR, and \fB3\fR. See
231 \fBinit\fR(1M) for details.
232 .RE
234 .sp
235 .ne 2
236 .na
237 \fB\fBMAXINST\fR\fR
238 .ad
239 .sp .6
240 .RS 4n
241 The maximum number of package instances that should be allowed on a machine at
242 the same time. By default, only one instance of a package is allowed. This
243 parameter must be set in order to have multiple instances of a package. In
244 order to support multiple instances of packages (for example, packages that
245 differ in their \fBARCH\fR or \fBVERSION\fR parameter value), the value of this
246 parameter must be high enough to allow for all instances of a given package,
247 including multiple versions coexisting on a software server.
248 .RE
250 .sp
251 .ne 2
252 .na
253 \fB\fBORDER\fR\fR
254 .ad
255 .sp .6
256 .RS 4n
257 A list of classes defining the order in which they should be put on the medium.
258 Used by \fBpkgmk\fR(1) in creating the package. Classes not defined in this
259 field are placed on the medium using the standard ordering procedures.
260 .RE
262 .sp
263 .ne 2
264 .na
265 \fB\fBPSTAMP\fR\fR
266 .ad
267 .sp .6
268 .RS 4n
269 Production stamp used to mark the \fBpkgmap\fR(4) file on the output volumes.
270 Provides a means for distinguishing between production copies of a version if
271 more than one is in use at a time. If \fBPSTAMP\fR is not defined, the default
272 is used. The default consists of the UNIX system machine name followed by the
273 string "\fIYYYYMMDDHHMMSS\fR" (year, month, date, hour, minutes, seconds).
274 .RE
276 .sp
277 .ne 2
278 .na
279 \fB\fBRSTATES\fR\fR
280 .ad
281 .sp .6
282 .RS 4n
283 A list of allowable run states for package removal (for example, "\fBS s 1\fR"
284 allows run states of \fBS\fR, \fBs\fR or \fB1\fR). The Solaris operating
285 environment supports the run levels \fBs\fR, \fBS\fR, \fB0\fR, \fB1\fR,
286 \fB2\fR, \fB3\fR, \fB5\fR, and \fB6\fR. Applicable run levels for this
287 parameter are \fBs\fR, \fBS\fR, \fB1\fR, \fB2\fR, and \fB3\fR See
288 \fBinit\fR(1M) for details.
289 .RE
291 .sp
292 .ne 2
293 .na
294 \fB\fBSUNW_ISA\fR\fR
295 .ad
296 .sp .6
297 .RS 4n
298 Solaris-only optional parameter that indicates a software package contains
299 64-bit objects if it is set to \fBsparcv9\fR. If this parameter is not set, the
300 default \fBISA\fR (instruction set architecture) is set to the value of the
301 \fBARCH\fR parameter.
302 .RE
304 .sp
305 .ne 2
306 .na
307 \fB\fBSUNW_LOC\fR\fR
308 .ad
309 .sp .6
310 .RS 4n
311 Solaris-only optional parameter used to indicate a software package containing
312 localization files for a given product or application. The parameter value is a
313 comma-separated list of locales supported by a package. It is only used for
314 packages containing localization files, typically the message catalogues. The
315 allowable values for this string field are those found in the table of Standard
316 Locale Names located in the \fIInternational Language Environments Guide\fR.
317 .sp
318 .in +2
319 .nf
320 SUNW_LOC="<\fIlocale_name\fR>,<\fIlocale_name\fR>,..,\e
321 <\fIlocale_name\fR>"
322 .fi
323 .in -2
325 where
326 .sp
327 .in +2
328 .nf
329 <\fIlocale_name\fR>::= <\fIlanguage\fR>[_<\fIterritory\fR>]\e
330 [.<\fIcodeset\fR>]
331 <\fIlanguage\fR>::= the set of names from ISO 639
332 <\fIterritory\fR>::= the set of territories specified
333 in ISO 3166
334 <\fIcodeset\fR>::= is a string corresponding to the coded
335 character set
336 .fi
337 .in -2
339 Since a value of C specifies the traditional UNIX system behavior (American
340 English, en_US), packages belonging to the C locale are viewed as non-localized
341 packages, and thus must not have \fBSUNW_LOC\fR and \fBSUNW_PKGLIST\fR included
342 in their \fBpkginfo\fR file. See also the \fBSUNW_LOC\fR parameter in
343 \fBpackagetoc\fR(4) and \fBsetlocale\fR(3C) for more information. This keyword
344 is not recognized by the add-on software utility Software Manager.
345 .RE
347 .sp
348 .ne 2
349 .na
350 \fB\fBSUNW_PKG_DIR\fR\fR
351 .ad
352 .sp .6
353 .RS 4n
354 A value set by \fBpkgadd\fR that contains the location of the installing
355 package. This value is provided to any install time package procedure scripts
356 that need to know where the installing package is located. This parameter
357 should never be set manually from within a \fBpkginfo\fR file.
358 .RE
360 .sp
361 .ne 2
362 .na
363 \fB\fBSUNW_PKG_ALLZONES\fR\fR
364 .ad
365 .sp .6
366 .RS 4n
367 Defines whether a package, when installed, must be installed and must be
368 identical in all zones. Assigned value can be \fBtrue\fR or \fBfalse\fR. The
369 default value is \fBfalse\fR. The setting of \fBSUNW_PKG_ALLZONES\fR has the
370 effects described below.
371 .sp
372 If set to \fBtrue\fR, the following conditions are in effect:
373 .RS +4
374 .TP
375 .ie t \(bu
376 .el o
377 The package must be installed in the global zone.
378 .RE
379 .RS +4
380 .TP
381 .ie t \(bu
382 .el o
383 The package must be installed in any non-global zone that is created.
384 .RE
385 .RS +4
386 .TP
387 .ie t \(bu
388 .el o
389 The package must be identical in all zones.
390 .RE
391 .RS +4
392 .TP
393 .ie t \(bu
394 .el o
395 The package can be installed only by the global zone administrator.
396 .RE
397 .RS +4
398 .TP
399 .ie t \(bu
400 .el o
401 The package cannot be installed by a non-global zone administrator.
402 .RE
403 If set to \fBfalse\fR, the following conditions are in effect:
404 .RS +4
405 .TP
406 .ie t \(bu
407 .el o
408 The package is not required to be installed in all zones.
409 .RE
410 .RS +4
411 .TP
412 .ie t \(bu
413 .el o
414 The package is not required to be identical across all zones.
415 .RE
416 .RS +4
417 .TP
418 .ie t \(bu
419 .el o
420 The package can be installed by the global zone administrator or by a
421 non-global zone administrator.
422 .RE
423 Packages that must be identical across all zones must set this variable to
424 \fBtrue\fR. This would include packages that deliver components that are part
425 of the core operating system, or that are dependent on interfaces exported by
426 the core operating system, or that deliver device drivers, or runtime libraries
427 that use or export operating system interfaces that are not guaranteed to be
428 stable across minor releases.
429 .sp
430 Packages that deliver components that are not part of the core operating system
431 (such as application programs) that can be different between any two zones must
432 set this variable to \fBfalse\fR.
433 .sp
434 With respect to \fBSUNW_PKG_ALLZONES\fR, keep in mind the following:
435 .RS +4
436 .TP
437 .ie t \(bu
438 .el o
439 Use of \fBpkgadd\fR in the global zone installs packages in all zones unless
440 \fB-G\fR is specified, in which case packages are installed in the global zone
441 only. The setting of \fBSUNW_PKG_ALLZONES\fR does not change this behavior. For
442 example, a package that has a setting of \fBSUNW_PKG_ALLZONES=false\fR is not
443 installed in the global zone only.
444 .RE
445 .RS +4
446 .TP
447 .ie t \(bu
448 .el o
449 The \fBSUNW_PKG_ALLZONES\fR attribute controls whether a package \fBmust\fR be
450 installed in all zones (and must be the same in all zones) when it is
451 installed.
452 .RE
453 .RS +4
454 .TP
455 .ie t \(bu
456 .el o
457 Use of the \fB-G\fR option to \fBpkgadd\fR with a package that has
458 \fBSUNW_PKG_ALLZONES=true\fR is an error and causes installation of that
459 package to fail.
460 .RE
461 .RE
463 .sp
464 .ne 2
465 .na
466 \fB\fBSUNW_PKG_HOLLOW\fR\fR
467 .ad
468 .sp .6
469 .RS 4n
470 Defines whether a package should be visible in any non-global zone if that
471 package is required to be installed and be identical in all zones (for example,
472 a package that has \fBSUNW_PKG_ALLZONES=true\fR). Assigned value can be
473 \fBtrue\fR or \fBfalse\fR. The default value is \fBfalse\fR. The package is not
474 required to be installed, but if it is installed, the setting of
475 \fBSUNW_PKG_HOLLOW\fR has the effects described below.
476 .sp
477 If set to \fBfalse\fR, the following conditions are in effect:
478 .RS +4
479 .TP
480 .ie t \(bu
481 .el o
482 If installed in the global zone, the package content and installation
483 information are required in all non-global zones.
484 .RE
485 .RS +4
486 .TP
487 .ie t \(bu
488 .el o
489 Software delivered by the package is visible in all non-global zones. An
490 example of such a a package is the package that delivers the \fBtruss\fR(1)
491 command.
492 .RE
493 If set to \fBtrue\fR, the following conditions are in effect:
494 .RS +4
495 .TP
496 .ie t \(bu
497 .el o
498 The package content is not delivered on any non-global zone. However, the
499 package installation information is required on all non-global zones.
500 .RE
501 .RS +4
502 .TP
503 .ie t \(bu
504 .el o
505 The package delivers software that should not be visible in all non-global
506 zones. Examples include kernel drivers and system configuration files that work
507 only in the global zone. This setting allows the non-global zone to resolve
508 dependencies on packages that are installed only in the global zone without
509 actually installing the package data.
510 .RE
511 .RS +4
512 .TP
513 .ie t \(bu
514 .el o
515 In the global zone, the package is recognized as having been installed, and all
516 components of the package are installed. Directories are created, files are
517 installed, and class action and other scripts are run as appropriate when the
518 package is installed.
519 .RE
520 .RS +4
521 .TP
522 .ie t \(bu
523 .el o
524 In a non-global zone, the package is recognized as having been installed, but
525 no components of the package are installed. No directories are created, no
526 files are installed, and no class action or other install scripts are run when
527 the package is installed.
528 .RE
529 .RS +4
530 .TP
531 .ie t \(bu
532 .el o
533 When removed from the global zone, the package is recognized as having been
534 completely installed. Appropriate directories and files are removed, and class
535 action or other install scripts are run when the package is removed.
536 .RE
537 .RS +4
538 .TP
539 .ie t \(bu
540 .el o
541 When removed from a non-global zone, the package is recognized as not having
542 been completely installed. No directories are removed, no files are removed,
543 and no class action or other install scripts are run when the package is
544 removed.
545 .RE
546 .RS +4
547 .TP
548 .ie t \(bu
549 .el o
550 The package is recognized as being installed in all zones for purposes of
551 dependency checking by other packages that rely on this package being
552 installed.
553 .RE
554 If \fBSUNW_PKG_ALLZONES\fR is set to \fBfalse\fR, the value of this variable
555 has no meaning. It is a package construction error to set
556 \fBSUNW_PKG_ALLZONES\fR to \fBfalse\fR, then set \fBSUNW_PKG_HOLLOW\fR to
557 \fBtrue\fR.
558 .RE
560 .sp
561 .ne 2
562 .na
563 \fB\fBSUNW_PKG_THISZONE\fR\fR
564 .ad
565 .sp .6
566 .RS 4n
567 Defines whether a package must be installed in the current zone only. Assigned
568 value can be \fBtrue\fR or \fBfalse\fR. The default value is \fBfalse\fR. The
569 setting of \fBSUNW_PKG_THISZONE\fR has the effects described below.
570 .sp
571 If set to true, the following conditions are in effect:
572 .RS +4
573 .TP
574 .ie t \(bu
575 .el o
576 The package is installed in the current zone only.
577 .RE
578 .RS +4
579 .TP
580 .ie t \(bu
581 .el o
582 If installed in the global zone, the package is not added to any currently
583 existing or yet-to-be-created non-global zones. This is the same behavior that
584 would occur if the \fB-G\fR option were specified to \fBpkgadd\fR.
585 .RE
586 If set to false, the following conditions are in effect:
587 .RS +4
588 .TP
589 .ie t \(bu
590 .el o
591 If \fBpkgadd\fR is run in a non-global zone, the package is installed in the
592 current zone only.
593 .RE
594 .RS +4
595 .TP
596 .ie t \(bu
597 .el o
598 If \fBpkgadd\fR is run in the global zone, the package is installed in the
599 global zone, and is also installed in all currently installed non-global zones.
600 In addition, the package will be propagated to all future, newly installed
601 non-global zones.
602 .RE
603 .RE
605 .sp
606 .ne 2
607 .na
608 \fB\fBSUNW_PKGLIST\fR\fR
609 .ad
610 .sp .6
611 .RS 4n
612 Solaris-only optional parameter used to associate a localization package to the
613 package(s) from which it is derived. It is required whenever the \fBSUNW_LOC\fR
614 parameter is defined. This parameter value is an comma-separated list of
615 package abbreviations of the form:
616 .sp
617 .in +2
618 .nf
619 SUNW_PKGLIST="\fIpkg1\fR[\fI:version\fR],\fIpkg2\fR[:\fIversion\fR],..."
620 .fi
621 .in -2
623 where \fIversion\fR (if specified) should match the version string in the base
624 package specified (see \fBVERSION\fR parameter in this manual page). When in
625 use, \fBSUNW_PKGLIST\fR helps determine the order of package installation. The
626 packages listed in the parameter are installed before the localization package
627 in question is installed. When left blank, \fBSUNW_PKGLIST="\|"\fR, the package
628 is assumed to be required for the locale to function correctly. See the
629 \fBSUNW_PKGLIST\fR parameter in \fBpackagetoc\fR(4) for more information. This
630 keyword is not recognized by the add-on software utility Software Manager.
631 .RE
633 .sp
634 .ne 2
635 .na
636 \fB\fBSUNW_PKGTYPE\fR\fR
637 .ad
638 .sp .6
639 .RS 4n
640 Solaris-only parameter for Sun internal use only. Required for packages part of
641 the Solaris operating environment releases which install into the \fB/\fR,
642 \fB/usr\fR, \fB/usr/kvm\fR, and \fB/usr/openwin\fR file systems. The Solaris
643 operating environment installation software must know which packages are part
644 of which file system to properly install a server/client configuration. The
645 currently allowable values for this parameter are \fBroot\fR, \fBusr\fR,
646 \fBkvm\fR, and \fBow\fR. If no \fBSUNW_PKGTYPE\fR parameter is present, the
647 package is assumed to be of \fBBASEDIR=\fR\fI/opt\fR. \fBSUNW_PKGTYPE\fR is
648 optional only for packages which install into the \fB/opt\fR name space as is
649 the case for the majority of Solaris add-on software. See the
650 \fBSUNW_PKGTYPE\fR parameter in \fBpackagetoc\fR(4) for further information.
651 .RE
653 .sp
654 .ne 2
655 .na
656 \fB\fBSUNW_PKGVERS\fR\fR
657 .ad
658 .sp .6
659 .RS 4n
660 Solaris-only parameter indicating of version of the Solaris operating
661 environment package interface.
662 .sp
663 .in +2
664 .nf
665 SUNW_PKGVERS="<\fIsunw_package_version\fR>"
666 .fi
667 .in -2
669 where <\fIunw_package_version\fR> has the form \fIx.y[.z]\fR and \fIx\fR,
670 \fIy\fR, and z are integers. For packages built for this release and previous
671 releases, use \fBSUNW_PKGVERS="\fI1.0\fR"\fR.
672 .RE
674 .sp
675 .ne 2
676 .na
677 \fB\fBSUNW_PRODNAME\fR\fR
678 .ad
679 .sp .6
680 .RS 4n
681 Solaris-only parameter indicating the name of the product this package is a
682 part of or comprises (maximum length of 256 \fBASCII\fR characters). A few
683 examples of currently used \fBSUNW_PRODNAME\fR values are: \fB"SunOS"\fR,
684 \fB"OpenWindows"\fR, and \fB"Common Desktop Environment"\fR.
685 .RE
687 .sp
688 .ne 2
689 .na
690 \fB\fBSUNW_PRODVERS\fR\fR
691 .ad
692 .sp .6
693 .RS 4n
694 Solaris-only parameter indicating the version or release of the product
695 described in \fBSUNW_PRODNAME\fR (maximum length of 256 \fBASCII\fR
696 characters). For example, where \fBSUNW_PRODNAME="\fR\fISunOS\fR\fB"\fR, and
697 the Solaris 2.x Beta release, this string could be \fB"5.x BETA"\fR, while for
698 the Solaris 2.x FCS release, the string would be \fB"5.x"\fR. For Solaris 10,
699 the string is \fB"5.10"\fR. If the \fBSUNW_PRODNAME\fR parameter is \fINULL\fR,
700 so should be the \fBSUNW_PRODVERS\fR parameter.
701 .RE
703 .sp
704 .ne 2
705 .na
706 \fB\fBULIMIT\fR\fR
707 .ad
708 .sp .6
709 .RS 4n
710 If set, this parameter is passed as an argument to the \fBulimit\fR(1) command
711 (see \fBlimit\fR(1)), which establishes the maximum size of a file during
712 installation.
713 .RE
715 .sp
716 .ne 2
717 .na
718 \fB\fBVENDOR\fR\fR
719 .ad
720 .sp .6
721 .RS 4n
722 Used to identify the vendor that holds the software copyright (maximum length
723 of 256 \fBASCII\fR characters).
724 .RE
726 .sp
727 .ne 2
728 .na
729 \fB\fBVSTOCK\fR\fR
730 .ad
731 .sp .6
732 .RS 4n
733 The vendor stock number, if any, that identifies this product (maximum length
734 of 256 \fBASCII\fR characters).
735 .RE
737 .sp
738 .LP
739 For further discussion of the zones-related parameters described above, see
740 \fISystem Administration Guide: Virtualization Using the Solaris Operating
741 System\fR.
742 .SH ENVIRONMENT VARIABLES
743 .sp
744 .LP
745 The following environment variables are available only to package class action
746 scripts and to checkinstall, preinstall, postinstall scripts.
747 .sp
748 .ne 2
749 .na
750 \fB\fBSUNW_PKG_INSTALL_ZONENAME\fR\fR
751 .ad
752 .sp .6
753 .RS 4n
754 This variable is set only during the initial installation of a zone.
755 .sp
756 If this variable is not set, the system does not support the \fBzones\fR(5)
757 feature. In this case, the package is being installed to or removed from a
758 system that is not configured for zones.
759 .sp
760 If the variable is set, and equal to \fBglobal\fR, the package is being
761 installed to or removed from the global zone.
762 .sp
763 If the variable is set and not equal to \fBglobal\fR, the package is being
764 installed to or removed from the non-global zone named by the contents of the
765 environment variable \fB${\fR\fBSUNW_PKG_INSTALL_ZONENAME\fR\fB}\fR.
766 .RE
768 .sp
769 .ne 2
770 .na
771 \fB\fBPKG_INIT_INSTALL\fR\fR
772 .ad
773 .sp .6
774 .RS 4n
775 This variable is set only during an initial installation of Solaris, such as
776 installing Solaris from a CD, DVD, or net install image.
777 .sp
778 If this variable is set and equal to \fBTRUE\fR, then the package is being
779 installed as part of an initial installation of Solaris.
780 .sp
781 If this variable is not set, or set and not equal to \fBTRUE\fR, then the
782 package is not being installed as part of an initial installation of Solaris.
783 .RE
785 .sp
786 .LP
787 The following code excerpt illustrates the semantics of the preceding
788 environment variables.
789 .sp
790 .in +2
791 .nf
792 if [ $PKG_INIT_INSTALL != "" ] ; then
793 # Package being installed as part of initial
794 # installation of Solaris.
796 elif [ $SUNW_PKG_INSTALL_ZONENAME != "" ] ; then
798 if [ $SUNW_PKG_INSTALL_ZONENAME != "global" ] ; then
799 # Package being installed as part of initial installation
800 # of non-global zone $SUNW_PKG_INSTALL_ZONENAME
801 else
802 # Package being installed as part of initial installation
803 # of a global zone.
804 fi
806 else
807 # Package not being installed as part of initial installation of
808 # Solaris and package not being installed as part of initial
809 # installation of non-global zone.
810 fi
811 .fi
812 .in -2
814 .SH EXAMPLES
815 .LP
816 \fBExample 1 \fRA Sample \fBpkginfo\fR File
817 .sp
818 .LP
819 Here is a sample \fBpkginfo\fR file:
821 .sp
822 .in +2
823 .nf
824 SUNW_PRODNAME="SunOS"
825 SUNW_PRODVERS="5.5"
826 SUNW_PKGTYPE="usr"
827 SUNW_PKG_ALLZONES=false
828 SUNW_PKG_HOLLOW=false
829 PKG="SUNWesu"
830 NAME="Extended System Utilities"
831 VERSION="11.5.1"
832 ARCH="sparc"
833 VENDOR="Sun Microsystems, Inc."
834 HOTLINE="Please contact your local service provider"
835 EMAIL=""
836 VSTOCK="0122c3f5566"
837 CATEGORY="system"
838 ISTATES="S 2"
839 RSTATES="S 2"
840 .fi
841 .in -2
843 .SH ATTRIBUTES
844 .sp
845 .LP
846 See \fBattributes\fR(5) for descriptions of the following attributes:
847 .sp
849 .sp
850 .TS
851 box;
852 c | c
853 l | l .
854 ATTRIBUTE TYPE ATTRIBUTE VALUE
855 _
856 Interface Stability See entries below
857 _
858 PKG value Evolving
859 _
860 VERSION value Evolving
861 _
862 NAME value Evolving
863 _
864 DESC value Evolving
865 _
866 ARCH value Evolving
867 _
868 CATEGORY value Evolving
869 _
870 BASEDIR value Evolving
871 _
872 ISTATES value Evolving
873 _
874 RSTATES value Evolving
875 _
876 MAXINST value Evolving
877 _
878 SUNW_PKG_ALLZONES Evolving
879 _
880 SUNW_PKG_HOLLOW Evolving
881 _
882 SUNW_PKG_THISZONE Evolving
883 _
884 SUNW_PRODNAME Evolving
885 _
886 SUNW_PRODVERS Evolving
887 _
888 SUNW_PKGVERS Evolving
889 _
890 SUNW_PKGTYPE Unstable
891 _
892 SUNW_LOC Evolving
893 _
894 SUNW_PKGLIST Evolving
895 _
896 SUNW_PKG_DIR Evolving
897 _
898 PKG_INIT_INSTALL Unstable
899 .TE
901 .SH SEE ALSO
902 .sp
903 .LP
904 \fBisalist\fR(1), \fBlimit\fR(1), \fBpkgmk\fR(1), \fBuname\fR(1),
905 \fBinit\fR(1M), \fBsetlocale\fR(3C), \fBclustertoc\fR(4), \fBorder\fR(4),
906 \fBpackagetoc\fR(4), \fBpkgmap\fR(4), \fBattributes\fR(5), \fBzones\fR(5)
907 .sp
908 .LP
909 \fIApplication Packaging Developer\&'s Guide\fR
910 .sp
911 .LP
912 \fIInternational Language Environments Guide\fR
913 .sp
914 .LP
915 \fISystem Administration Guide: Virtualization Using the Solaris Operating
916 System\fR
917 .SH NOTES
918 .sp
919 .LP
920 Developers can define their own installation parameters by adding a definition
921 to this file. A developer-defined parameter must begin with a capital letter.
922 .sp
923 .LP
924 Trailing white space after any parameter value is ignored. For example,
925 \fBVENDOR="Sun Microsystems, Inc."\fR is the same as \fBVENDOR="Sun
926 Microsystems, Inc. "\fR.