pkginfo(4) pkginfo(4)
NAME
pkginfo - package characteristics file
DESCRIPTION
pkginfo is an ASCII file that describes the characteristics of the
package along with information that helps control the flow of instal-
lation. It is created by the software package developer.
Each entry in the pkginfo file is a line that establishes the value of
a parameter in the following form:
PARAM="value"
There is no required order in which the parameters must be specified
within the file. Each parameter is described below. Only fields marked
with an asterisk (*) are mandatory.
PKG* Abbreviation for the package being installed, gen-
erally three characters in length (for example, dir or
pkg). All characters in the abbreviation must be
alphanumeric and the first must not be numeric. The
abbreviation is limited to a maximum length of nine
characters. install, new, and all are reserved abbre-
viations.
NAME* Text that specifies the package name (maximum length
of 256 ASCII characters).
ARCH* A comma-separated list of alphanumeric tokens that
indicate the architecture (for example, MIPS) associ-
ated with the package. The pkgmk tool may be used to
create or modify this value when actually building the
package. The maximum length of a token is characters
and it cannot include a comma. This value can be
specified with the -a option of the pkgmk command when
the package is being built.
VERSION* Text that specifies the current version associated
with the software package. The maximum length is 256
ASCII characters and the first character cannot be a
left parenthesis. The pkgmk tool may be used to create
or modify this value when actually building the pack-
age.
CATEGORY* A comma-separated list of categories under which a
package may be displayed. A package must at least
belong to the system or application category.
Categories are case-insensitive and may contain only
alphanumerics. Each category is limited in length to
characters.
Page 1 Reliant UNIX 5.44 Printed 11/98
pkginfo(4) pkginfo(4)
DESC Text that describes the package (maximum length of 256
ASCII characters).
VENDOR Used to identify the vendor who holds the software
copyright (maximum length of 256 ASCII characters).
HOTLINE Phone number and/or mailing address where further
information may be received or bugs may be reported
(maximum length of 256 ASCII characters).
EMAIL An electronic address where further information is
available or bugs may be reported (maximum length of
256 ASCII characters).
VSTOCK The vendor stock number, if any, that identifies this
product (maximum length of 256 ASCII characters).
CLASSES A space-separated list of classes defined for a pack-
age. The order of the list determines the order in
which the classes are installed. Classes listed first
will be installed first (on a media by media basis).
This parameter may be modified by the request script.
ISTATES A list of permissible run states for package installa-
tion (for example, "S s 1").
RSTATES A list of permissible run states for package removal
(for example, "S s 1").
BASEDIR The standard basic directory for collectively relocat-
able objects in the package. If package objects are to
be freely relocatable, this parameter must be present
and have a value other than zero.
ULIMIT If set, this parameter is passed as an argument to the
ulimit command, which establishes the maximum size of
a file during installation.
ORDER A list of classes defining the order in which they
should be put on the medium. Used by pkgmk in creating
the package. Classes not defined in this field are
placed on the medium using the standard ordering pro-
cedures.
MAXINST The maximum number of package instances that should be
allowed on a machine at the same time. By default,
only one instance of a package is allowed. This param-
eter must be set in order to have multiple instances
of a package.
Page 2 Reliant UNIX 5.44 Printed 11/98
pkginfo(4) pkginfo(4)
PSTAMP Production stamp used to mark the pkgmap file on the
output volumes. Provides a means of distinguishing
between production copies of a version if more than
one is in use at a time. If PSTAMP is not defined, the
default is used. The default consists of the Reliant
UNIX system machine name followed by the string
"YYMMDDHHMM" (year, month, date, hour, minutes).
INTONLY Indicates that the package should only be installed
interactively when set to any non-zero value.
PREDEPEND Used to maintain compatibility with pre-SVR4 package
dependency checking. Pre-SVR4 dependency checks were
based on whether or not the name file for the required
package existed in the /var/options directory. This
directory is not maintained for SVR4 packages since
the depend file is used for checking dependencies.
However, entries can be created in this directory to
maintain compatibility. Setting the PREDEPEND parame-
ter to y or yes creates a /usr/option entry for the
package. (Packages that are new for SVR4 do not need
to use this parameter.)
EXAMPLES
Here is a sample pkginfo:
PKG="oam"
NAME="OAM Installation Utilities"
VERSION="1"
VENDOR="AT&T"
HOTLINE="1-800-ATT-BUGS"
EMAIL="attunix!olsen"
VSTOCK="0122c3f5566"
CATEGORY="system.essential"
ISTATES="S 2"
RSTATES="S 2"
NOTES
Developers may define their own installation parameters by adding a
definition to this file. A developer-defined parameter must begin with
an uppercase letter.
The parameter values can be enclosed in single or double quotes (' or
"). Use of these two characters should be avoided within the values,
alternatively they can be preceded by \ (this character is retained).
Page 3 Reliant UNIX 5.44 Printed 11/98