Package Components

Package Components

Package Metadata

 Unless otherwise indicated, the following attributes must be included with each package.

• pkg.name - short, descriptive name of the package
• pkg.description - short paragraph describing the package
• description - (same as pkg.description)
• pkg.detailed_url - link to online information about the package (optional)
• info.maintainer - name and email of individual or entity that provided the package and supports the package
• info.upstream - name and email of individual or entity that creates and supports the software contained in the package
• info.upstream_url - URL associated with the entity that creates the software contained in the package
• info.source_url - URL to the source code bundle for the package
• info.repository_url - URL to the source code repository for the package (optional)
• info.classification - list of labels classifying the package into the categories used by the Package Manager application (see Package Classifications)

 The following actions must be included with each packge.

• license - path to file containing the full license text. Includes "license" keyword that indicates the license type.

Example IPS Package Metadata Values

set name=pkg.name             value="Midnight Commander"
set name=pkg.description      value="GNU Midnight Commander - orthodox terminal file manager for Unix-like system"
set name=description          value="GNU Midnight Commander - orthodox terminal file manager for Unix-like system"
set name=pkg.detailed_url     value=http://en.wikipedia.org/wiki/Midnight_Commander
set name=info.maintainer      value="John Doe <john.doe@xyz.com>"
set name=info.upstream        value="Jane Doe <jane.dow@mc.org>"
set name=info.upstream_url    value=http://www.ibiblio.org/mc/
set name=info.source_url      value=http://www.rs/mc/mc-4.6.1.tar.gz
set name=info.repository_url  value=http://cvs.savannah.gnu.org/mc/
set name=info.classification
    value="org.opensolaris.category.2008:Applications/System Utilities"
license $HOME/COPYING       license="GPLv2"

Package Name and Version

 Each IPS package is represented by a Fault Management Resource Identifier (FMRI) composed of the following fields.

<scheme>:<name>@<compversion>,<buildversion>-<branch>:<timestamp>

• scheme - type of packaging system. Always "pkg"
• name - package name. Normally the same as the open source project name
• compversion - open source component version
• buildversion - operating system version package was built on, normally "5.11"
• branch - operating system build that was used to create the package
• timestamp - date and time package was created

Example IPS Package FMRI

pkg://meld@1.1.5.1,5.11-0.100:20081025T005716Z

[[meld>>http://meld.sourceforge.net/]] version 1.1.5.1 created on OpenSolaris build 100 on 2008.10.25 at 00:57:16

References

• IPS for End Users (Tasks)
• IPS for Developers (Commands)