JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Image Packaging System Man Pages     Oracle Solaris 11 Information Library
search filter icon
search icon

Document Information

Preface

User Commands

packagemanager(1)

pkg(1)

pkgdepend(1)

pkgdiff(1)

pkgfmt(1)

pkglint(1)

pkgmerge(1)

pkgmogrify(1)

pkgrecv(1)

pkgrepo(1)

pkgsend(1)

pkgsign(1)

pm-updatemanager(1)

System Administration Commands

Standards, Environments, and Macros

pkg

- Image Packaging System retrieval client

Synopsis

/usr/bin/pkg [options] command [cmd_options] [operands]
/usr/bin/pkg refresh [--full] [publisher ...]
/usr/bin/pkg install [-nvq] [-g path_or_uri ...] [--accept]
    [--licenses] [--no-be-activate] [--no-index] [--no-refresh]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    [--reject pkg_fmri_pattern ...] pkg_fmri_pattern ...
/usr/bin/pkg uninstall [-nvq] [--no-be-activate] [--no-index]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    pkg_fmri_pattern ...
/usr/bin/pkg update [-fnvq] [-g path_or_uri ...] [--accept]
    [--licenses] [--no-be-activate] [--no-index] [--no-refresh]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    [--reject pkg_fmri_pattern ...] [pkg_fmri_pattern ...]
/usr/bin/pkg list [-Hafnsuv] [-g path_or_uri ...]
    [--no-refresh] [pkg_fmri_pattern ...]
/usr/bin/pkg info [-lr] [-g path_or_uri ...] [--license]
    [pkg_fmri_pattern ...]
/usr/bin/pkg contents [-Hmr] [-a attribute=pattern ...]
    [-g path_or_uri ...] [-o attribute ...] [-s sort_key]
    [-t action_type ...] [pkg_fmri_pattern ...]
/usr/bin/pkg search [-HIaflpr] [-o attribute ...]
    [-s repo_uri] query
/usr/bin/pkg verify [-Hqv] [pkg_fmri_pattern ...]
/usr/bin/pkg fix [--accept] [--licenses] [pkg_fmri_pattern ...]
/usr/bin/pkg revert [-nv] [--no-be-activate]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    (--tagged tag-name ... | path-to-file ...)
/usr/bin/pkg mediator [-aH] [-F format] [mediator ...]
usr/bin/pkg set-mediator [-nv] [-I implementation]
    [-V version] [--no-be-activate]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    mediator ...
/usr/bin/pkg unset-mediator [-nvIV] [--no-be-activate]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    mediator ...
/usr/bin/pkg variant [-H] [variant.variant_name ...]
/usr/bin/pkg change-variant [-nvq] [-g path_or_uri ...]
    [--accept] [--licenses] [--no-be-activate]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name]
    variant_name=value ...
/usr/bin/pkg facet [-H] [facet_name ...]
/usr/bin/pkg change-facet [-nvq] [-g path_or_uri ...]
    [--accept] [--licenses] [--no-be-activate]
    [--no-backup-be | --require-backup-be] [--backup-be-name name]
    [--deny-new-be | --require-new-be] [--be-name name] 
    facet_name=[True|False|None] ...
/usr/bin/pkg avoid [pkg_fmri_pattern ...]
/usr/bin/pkg unavoid [pkg_fmri_pattern ...]
/usr/bin/pkg freeze [-n] [-c reason] [pkg_fmri_pattern] ...
/usr/bin/pkg unfreeze [-n] [pkg_name_pattern] ...
/usr/bin/pkg property [-H] [propname ...]
/usr/bin/pkg set-property propname propvalue
/usr/bin/pkg add-property-value propname propvalue
/usr/bin/pkg remove-property-value propname propvalue
/usr/bin/pkg unset-property propname ...
/usr/bin/pkg publisher [-HPn] [publisher ...]
/usr/bin/pkg set-publisher [-Ped] [-k ssl_key] [-c ssl_cert]
    [-g origin_to_add | --add-origin origin_to_add ...]
    [-G origin_to_remove | --remove-origin origin_to_remove ...]
    [-m mirror_to_add | --add-mirror mirror_to_add ...]
    [-M mirror_to_remove | --remove-mirror mirror_to_remove ...]
    [--enable] [--disable] [--no-refresh]
    [--reset-uuid] [--non-sticky] [--sticky]
    [--search-after publisher] [--search-before publisher]
    [--search-first]
    [--approve-ca-cert path_to_CA]
    [--revoke-ca-cert hash_of_CA_to_remove]
    [--unset-ca-cert hash_of_CA_to_remove]
    [--set-property name_of_property=value]
    [--add-property-value name_of_property=value_to_add]
    [--remove-property-value name_of_property=value_to_remove]
    [--unset-property name_of_property_to_delete]
    publisher
/usr/bin/pkg set-publisher -p repo_uri 
    [-Ped] [-k ssl_key] [-c ssl_cert]
    [--non-sticky] [--sticky]
    [--search-after publisher] [--search-before publisher]
    [--search-first] 
    [--approve-ca-cert path_to_CA]
    [--revoke-ca-cert hash_of_CA_to_remove]
    [--unset-ca-cert hash_of_CA_to_remove]
    [--set-property name_of_property=value]
    [--add-property-value name_of_property=value_to_add]
    [--remove-property-value name_of_property=value_to_remove]
    [--unset-property name_of_property_to_delete]
    [publisher]
/usr/bin/pkg unset-publisher publisher ...
/usr/bin/pkg history [-Hl] [-t [time | time-time],...]
    [-o column,...] [-n number]
/usr/bin/pkg purge-history
/usr/bin/pkg rebuild-index
/usr/bin/pkg update-format
/usr/bin/pkg version
/usr/bin/pkg help
/usr/bin/pkg image-create [-FPUfz] [--force]
    [--full | --partial | --user] [--zone]
    [-k ssl_key] [-c ssl_cert]
    [--no-refresh] [--variant variant_name=value ...]
    [-g path_or_uri | --origin path_or_uri ...]
    [-m uri | --mirror uri ...]
    [--set-property name_of_property=value]
    [--facet facet_name=(True|False) ...]
    [(-p | --publisher) [name=]repo_uri] dir

Description

pkg is the retrieval client for the Image Packaging System. With a valid configuration, pkg can be invoked to create locations for packages to be installed, called images, and install packages into those images. Packages are published by publishers, who can make their packages available at one or more repositories, or in package archives. pkg retrieves packages from a publisher's repository or package archives and installs the packages into an image.

A publisher name identifies a person, group of persons, or an organization as the source of one or more packages. To avoid publisher name collisions and help identify the publisher, a best practice is to use a domain name that represents the entity publishing the packages as a publisher name.

A repository is a location where clients can publish and retrieve package content (files contained within the package such as programs and documents) and metadata (information about the package such as its name and description). As an example, a publisher named example.org might have their repository located at the URI http://example.org/repository.

pkg can also uninstall packages, refresh publisher metadata (such as the list of available packages), validate package installation in an image, and query the image for various tokens. These queries can also be made of pkg(5) repositories.

Images can be of three types: full images, capable of providing a complete system; partial images, which are linked to a full image (parent image), but do not provide a complete system on their own; and user images.

Options

The following options are supported:

-R dir

Operate on the image rooted at dir. If no directory was specified or determined based on environment, the default is /. See the “Environment Variables” section for more information.

--help or -?

Display a usage message.

Sub-commands

The following subcommands are supported:

refresh [--full] [publisher ...]

Updates the client's list of available packages and publisher metadata for each publisher specified. If no publishers are specified, the operation is performed for all publishers.

With --full, force a full retrieval of all publisher metadata, instead of attempting an incremental update, and request that any proxies used during the operation ignore cached data. This option exists for troubleshooting purposes and should not be used on a regular basis.

install [-nvq] [-g path_or_uri ...] [--accept] [--licenses] [--no-be-activate] [--no-index] [--no-refresh] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] [--reject pkg_fmri_pattern ...] pkg_fmri_pattern ...

Installs and updates packages to the newest version that match pkg_fmri_pattern allowed by the packages installed in the image. To explicitly request the latest version of a package, use latest for the version portion of pkg_fmri_pattern. For example, specify vim@latest.

Some configuration files might be renamed or replaced during the installation process. For more information on how the package system determines which files to preserve, and how they are preserved during package operations, see “File Actions” in the pkg(5) man page.

If a package is on the avoid list, installing it removes it from that list.

With -g, temporarily add the specified package repository or archive to the list of sources in the image from which to retrieve package data. If packages from the specified sources are also available from configured publishers in the image, the client will retrieve content for those packages from the specified sources only. When deciding which version of a package to use, publishers configured in the image, but not found in the given sources take precedence. After install or update, any packages provided by publishers not found in the image are added to the image configuration without an origin. This option can be specified multiple times.

With -n, perform a trial run of the operation with no package changes made.

With -q, hide progress messages during the requested operation.

With -v, issue verbose progress messages during the requested operation, and display detailed planning information (such as changing facets, mediators, and variants). This option can be specified multiple times to increase the amount of planning information displayed.

With --accept, you indicate that you agree to and accept the terms of the licenses of the packages that are updated or installed. If you do not provide this option, and any package licenses require acceptance, the installation operation fails.

With --licenses, display all of the licenses for the packages that are installed or updated as part of this operation.

With --no-backup-be, do not create a backup boot environment.

With --no-be-activate, if a boot environment is created, do not set it as the active BE on the next boot. See beadm(1M) for more information.

With --no-index, do not update the search indexes after the operation has completed successfully.

With --no-refresh, do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages and other metadata.

With --backup-be-name, name the created backup boot environment using the given argument. Use of --backup-be-name implies --require-backup-be. See also beadm(1M).

With --be-name, rename the newly created boot environment to be the argument given. Use of --be-name implies --require-new-be. See also beadm(1M).

With --require-backup-be, always create a backup boot environment if a new boot environment will not be created. Without this option, a backup boot environment is created based on image policy. See be-policy in “Image Properties” below for an explanation of when backup boot environments are created automatically.

With --require-new-be, always create a new boot environment. Without this option, a boot environment is created based on image policy. See be-policy in “Image Properties” below for an explanation of when boot environments are created automatically. This option cannot be combined with --require-backup-be.

With --deny-new-be, do not create a new boot environment. This operation is not performed if a new boot environment is required.

With --reject, prevent packages with names matching the given pattern from being installed. If matching packages are already installed, they are removed as part of this operation. Rejected packages that are the target of group dependencies are placed on the avoid list.

uninstall [-nvq] [--no-be-activate] [--no-index] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] pkg_fmri_pattern ...

Removes installed packages that match pkg_fmri_pattern.

If a package is the subject of a group dependency, uninstalling it places it on the avoid list. See the avoid subcommand below.

For all other options, refer to the install command above for usage and their effects.

update [-fnvq] [-g path_or_uri ...] [--accept] [--licenses] [--no-be-activate] [--no-index] [--no-refresh] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] [--reject pkg_fmri_pattern ...] [pkg_fmri_pattern ...]

With no arguments, or if asterisk (*) is one of the patterns provided, update all installed packages in the current image to the newest version allowed by the constraints imposed on the system by installed packages and publisher configuration. To explicitly request the latest version of a package, use latest for the version portion of pkg_fmri_pattern. For example, specify vim@latest.

If pkg_fmri_pattern is provided, update replaces packages that are installed, and that match pkg_fmri_pattern, with the newest version allowed by the patterns and the constraints imposed on the system by installed packages and publisher configuration. Versions older or newer than what is already installed can be specified to perform in-place downgrades or upgrades of specific packages. Updating specific packages across package rename or obsolete boundaries is not supported.

Any preserved configuration files that are part of packages to be downgraded by update and that have been changed since the original version was installed are renamed using the extension .update. For more information about how the package system determines which files to preserve, and how these files are preserved during package upgrades, see “File Actions” in the pkg(5) man page.

With the -f option, do not execute the client up-to-date check when updating all installed packages.

For all other options, refer to the install command above for usage and their effects.

list [-Hafnsuv] [-g path_or_uri ...] [--no-refresh] [pkg_fmri_pattern ...]

Without arguments, display a list of packages in the current image, including information such as version and installed state. With arguments, display information for the specified packages. By default, package variants for a different architecture or zone type are excluded. The usual output is in three columns:

NAME (PUBLISHER)            VERSION           IFO
system/core-os              0.5.11-0.169      i--
x11/wm/fvwm (fvwm.org)      2.6.1-3           i--

The first column contains the name of the package. If the publisher from which the package is installed (or available, if not installed) is not the first in the publisher search order, then the publisher name is listed in parentheses after the package name. The second column contains the release and branch versions of the package. See the pkg(5) man page for information about release and branch versions and about variants.

The last column contains a set of flags that show the status of the package:

  • An i in the I column shows that the package is installed.

  • An f in the F column shows that the package is frozen.

  • An o in the O column shows that the package is obsolete. An r in the O column shows that the package has been renamed (a form of obsoletion).

With -H, omit the headers from the listing.

With -a, list installed packages and the newest version of packages that are available for installation. Packages are considered to be available for installation if they are allowed by the installed incorporations and by the image's variants. If one or more patterns are specified, then the newest version matching the specified pattern and allowed by any installed incorporations and the image's variants is listed. Without -a, list only installed packages.

With -f and -a, list all versions of all packages for all variants regardless of incorporation constraints or installed state. To explicitly list the latest version of a package when using these options, use latest for the version portion of pkg_fmri_pattern. For example, specify vim@latest.

With -g, use the specified package repository or archive as the source of package data for the operation. This option can be specified multiple times. Use of -g implies -a if -n is not specified.

With -n, display the newest versions of all known packages, regardless of installed state.

With -s, display a one-line short-form giving the package name and summary. This option can be used with -a, -n, -u or -v.

With -u, list only packages with newer versions available. This option cannot be used with -g.

With -v, show full package FMRIs, including publisher and complete version, all in the first column (the VERSION column disappears). This option can be used with -a, -n, or -u.

With --no-refresh, do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages.

info [-lr] [-g path_or_uri ...] [--license] [pkg_fmri_pattern ...]

Display information about packages in a human-readable form. Multiple FMRI patterns can be specified. With no patterns, display information on all installed packages in the image.

With -g, use the specified package repository or archive as the source of package data for the operation. This option can be specified multiple times. Use of -g implies -r.

With -l, only display information for installed packages. This is the default.

With -r, match packages based on the newest available versions, retrieving information for packages not currently installed (if necessary) from the repositories of the image's configured publishers. At least one package must be specified when using this option. Without -r, only installed packages are displayed by default.

With --license, display the license texts for the packages. This option can be combined with -l or -r.

contents [-Hmr] [-a attribute=pattern ...] [-g path_or_uri ...] [-o attribute,...] [-s sort_key] [-t action_type ...] [pkg_fmri_pattern ...]

Display the contents (action attributes) of packages. With no options or operands, display the value of the path attribute for actions installed in the current image, sorted alphabetically by attribute value. For information about actions and their attributes, see “Actions” in the pkg(5) man page. See also the list of pseudo attribute names below.

With -a, limit the output to those actions that have an attribute named in the option argument with a value that matches the (glob) pattern in the option argument (following the attribute name with an equals sign). If multiple -a options are given, then actions matching any of them are displayed.

With -g, display information for packages that could be installed in this image from the specified package repository or archive. Packages that could be installed include packages that are currently installed and other packages that satisfy criteria for installation in this image, such as variant and facet restrictions. This option can be specified multiple times. Use of -g implies -r.

With -m, display all attributes of all actions in the specified packages, including actions that could not be installed in this image.

With -o, display the listed attributes, sorted according to the values of the first attribute listed. The -o option can be specified multiple times, or multiple attributes can be specified as the argument to one -o option by separating the attribute names with commas. Only actions that have the requested attributes are displayed.

With -r, display information for the newest available versions of packages that could be installed in this image from the repositories of the publishers configured in this image. Packages that could be installed include packages that are currently installed and other packages that satisfy criteria for installation in this image, such as variant and facet restrictions. At least one package must be specified when using this option.

With -s, sort actions by the specified action attribute. If not provided, the default is to sort by path or by the first attribute specified by the -o option. The -s option can be specified multiple times.

With -t, only list actions of the type specified. Multiple types can be specified in a comma-separated list. This option can be specified multiple times.

With -H, omit the headers from the listing.

With pkg_fmri_pattern, display information only for those named packages.

Several special pseudo attribute names are available for convenience:

action.hash

The value of the action's hash, if the action carries a payload.

action.key

The value of the action's key attribute. For example, for a file action, the key attribute is the path to the file. Some actions do not have a key attribute.

action.name

The name of the action. For example, for a file action, this is file.

action.raw

All attributes of matching actions.

pkg.fmri

The full FMRI of the package containing the action, such as pkg://solaris/web/amp@0.5.11,5.11-0.169:20110705T153434Z.

pkg.name

The name of the package containing the action, such as web/amp.

pkg.publisher

The publisher of the package containing the action, such as solaris.

pkg.shortfmri

The short form FMRI of the package containing the action, such as pkg://solaris/web/amp@0.5.11,5.11-0.169

The contents and search subcommands are related: Both query the system for the contents of packages. The contents subcommand displays actions in one or more installed or installable packages, filtering the output based on the specified options. The search subcommand approaches the query from the other direction, displaying the names of all packages that contain a user-supplied token.

Each subcommand is capable of formulating some queries of which the other is capable. Care should be taken in choosing the subcommand, as a given query can be more naturally formulated in one than in the other.

search [-HIaflpr] [-o attribute,...] [-s repo_uri] query

Search for matches to the query, and display the results. Which tokens are indexed are action-dependent, but can include content hashes and path names. For information about actions and their attributes, see “Actions” in the pkg(5) man page. See also the list of pseudo attribute names in pkg contents above and in -o below.

By default, queries are interpreted as a series of terms to be matched exactly. The ? and * characters can be used as glob(3C)-style wildcards, allowing more flexible query matches.

With -H, omit the headers.

With -I, use a case-sensitive search.

By default, and with -a, perform the search and display information about the matching actions.

By default, search prunes results from packages older than the currently installed version and from package versions excluded by current incorporations. Use -f to show all results, regardless of package version.

With -l, search the image's installed packages.

With -o, the columns of the results can be controlled. The -o option can be specified multiple times, or multiple attributes can be specified as the argument to one -o option by separating the attribute names with commas. In addition to the pseudo attributes outlined above, the following attributes are defined for search results:

search.match

Corresponds to the string that matched the search query.

search.match_type

Corresponds to the attribute that contained the string that matched the search query.

With -p, display packages that have some actions that match each query term. Using this option is equivalent to putting angle brackets (<>) around each term in the query. See below for more description of the <> operator.

By default, and with -r, search the repositories corresponding to the image's publishers.

With -s, search the pkg(5) repository located at the given URI. This can be specified multiple times. Package archives are not supported.

Both -l and -r (or -s) can be specified together, in which case both local and remote searches are performed.

In addition to simple token matching and wildcard search, a more complicated query language is supported. Phrases can be searched for by using single or double quotation marks (' or "). Be sure to take your shell into account so that pkg actually sees the ' or ".

Boolean search using AND and OR is supported. Field, or structured, queries are supported. The syntax for these is pkg_name:action_type:key:token. Missing fields are implicitly wildcarded. A search for :basename:pkg matches all action types in all packages with a key of basename and that match the token pkg. Explicit wildcards are supported in the pkg_name and token fields. The action_type and key must match exactly.

To convert actions to the packages that contain those actions, use <>. With the -a option, searching for token results in information about the actions matching token, while searching for <token> results in a list of packages containing actions that matched token.

verify [-Hqv] [pkg_fmri_pattern ...]

Validate the installation of packages in the current image. If current signature policy for related publishers is not ignore, the signatures of each package are validated based on policy. See signature-policy in “Image Properties” below for an explanation of how signature policies are applied.

With -H, omit the headers from the verification output.

With -q, print nothing, but return failure if there are any fatal errors.

With -v, include informational messages regarding packages.

fix [--accept] [--licenses] [pkg_fmri_pattern ...]

Fix any errors reported by pkg verify. Verification of installed package content is based on a custom content analysis that might return different results than those of other programs.

With --accept, you indicate that you agree to and accept the terms of the licenses of the packages that are updated or installed. If you do not provide this option, and any package licenses require acceptance, the operation fails.

With --licenses, display all of the licenses for the packages to be installed or updated as part of this operation.

revert [-nv] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] (--tagged tag-name ... | path-to-file ...)

Revert files to their as-delivered condition. Either all files tagged with a particular value, or individual files can be reverted. File ownership and protections are also restored.


Caution

Caution - Reverting some editable files to their default values can make the system unbootable, or cause other malfunctions.


For all other options, refer to the install command above for usage and their effects.

mediator [-aH] [-F format] [mediator ...]

Display the current selected version and/or implementation of all mediators, or with arguments, only the mediators specified.

With -a, list the mediations that can be set for currently installed packages.

With -F, specify an alternative output format. Currently, only tsv (Tab Separated Values) is valid.

With -H, omit the headers from the listing.

set-mediator [-nv] [-I implementation] [-V version] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] mediator ...

Set the version and/or implementation for the specified mediators in the current image.

With -I, set the implementation of the mediated interface to use. By default, if no version is specified, all implementation versions are allowed. To specify an implementation with no version, append an at sign (@).

With -V, set the version of the mediated interface to use.

If the specified mediator version and/or implementation is not currently available, any links using the specified mediators are removed.

For all other options, refer to the install command above for their usage and effects.

unset-mediator [-nvIV] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] mediator ...

Revert the version and/or implementation of the specified mediators to the system default.

With -I, revert only the implementation of the mediated interface.

With -V, revert only the version of the mediated interface.

For all other options, refer to the install command above for their usage and effects.

variant [-H] [variant.variant_name ...]

Without arguments, display the current values of all variants set in this image. With arguments, display the value of each specified variant.variant_name set in this image.

With -H, omit the headers from the listing.

See “Facets and Variants” in the pkg(5) man page for more information about variants.

change-variant [-nvq] [-g path_or_uri ...] [--accept] [--licenses] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] variant_name=value ...

Change the values of the specified variants set in the current image.

For option usage and effects, refer to the install command above.

Changing the value of a variant can cause package content to be removed, updated, or installed. Changing a variant value can also cause entire packages to be installed, updated, or removed to satisfy the new image configuration. See “Facets and Variants” in the pkg(5) man page for more information about variants.

facet [-H] [facet_name ...]

Without arguments, display the current values of all facets that have been explicitly set in this image by using the pkg change-facet command. With arguments, display the value of each specified facet_name set in this image.

With -H, omit the headers from the listing.

See “Facets and Variants” in the pkg(5) man page for more information about facets.

change-facet [-nvq] [-g path_or_uri ...] [--accept] [--licenses] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name name] [--deny-new-be | --require-new-be] [--be-name name] facet_name=[True|False|None] ...

Change the values of the specified facets set in the current image.

Facets can be set to True or False. Setting a facet to None applies the default value of True to that facet; thus, any actions subject to the facet will be installed. See “Actions” in the pkg(5) man page for information about actions..

For option usage and effects, refer to the install command above.

Changing the value of a facet can cause package content to be removed, updated, or installed. Changing a facet value can also cause entire packages to be installed, updated, or removed to satisfy the new image configuration. See “Facets and Variants” in the pkg(5) man page for more information about facets.

avoid [pkg_fmri_pattern ...]

Avoids the specified packages if they are the target of a group dependency by placing the package names that currently match the specified patterns on the avoid list. Only packages that are not currently installed can be avoided. If a package is currently the target of a group dependency, uninstalling the package places it on the avoid list.

Without any arguments, display each avoided package along with any packages that have a group dependency on that package.

Packages that are on the avoid list are installed if needed to satisfy a required dependency. If that dependency is removed, the package is uninstalled.

unavoid [pkg_fmri_pattern ...]

Remove the specified packages from the avoid list. Packages on the avoid list that match an installed package's group dependency cannot be removed using this subcommand. To remove a package from the avoid list that matches a group dependency, install the package.

Without any arguments, display the list of avoided packages.

freeze [-n] [-c reason] [pkg_fmri_pattern] ...

Freeze the specified packages to the versions specified. If no version is given, the package must be installed and is frozen at that installed version. When a package that is frozen is installed or updated, it must end up at a version that matches the version at which it was frozen. For example, if a package was frozen at 1.2, then it could be updated to 1.2.1, 1.2.9, 1.2.0.0.1, and so on. That package could not end up at 1.3, or 1.1. A publisher presented in the pkg_fmri_pattern is used to find matching packages. However, publisher information is not recorded as part of the freeze. A package is frozen with respect to its version only, not its publisher. Freezing a package that is already frozen replaces the freeze version with the newly specified version.

If no packages are provided, information about currently frozen packages is displayed: package names, versions, when the package was frozen, and any associated reasons.

Freezing a package does not prevent removal of the package. No warning is displayed if the package is removed.

With -c, record the reason with the packages that are frozen. The reason is shown if a freeze prevents an installation or update from succeeding.

With -n, perform a trial run of the operation, displaying the list of packages that would be frozen without freezing any packages.

unfreeze [-n] [pkg_name_pattern] ...

Remove the constraints that freezing imposes from the specified packages. Any versions provided are ignored.

With -n, perform a trial run of the unfreeze, displaying the list of packages that would be unfrozen without unfreezing any packages.

property [-H] [propname ...]

Display image property information. With no argument, display the names and values for all image properties. If a specific list of property names is requested, display the names and values for those properties. See “Image Properties” below for descriptions of image properties.

With -H, omit the headers from the listing.

set-property propname propvalue

Update an existing image property or add a new image property.

add-property-value propname propvalue

Add a value to an existing image property or add a new image property.

remove-property-value propname propvalue

Remove a value from an existing image property.

unset-property propname ...

Remove an existing image property or properties.

publisher [-HPn] [publisher ...]

Display publisher information. With no arguments, display the list of all publishers, their origin URIs, and mirrors in order of search preference. If specific publishers are requested, display detailed configuration for those publishers.

With -H, omit the headers from the listing.

With -P, display only the first publisher in the publisher search order.

With -n, display only enabled publishers.

set-publisher [-Ped] [-k ssl_key] [-c ssl_cert] [-g origin_to_add | --add-origin origin_to_add ...] [-G origin_to_remove | --remove-origin origin_to_remove ...] [-m mirror_to_add | --add-mirror mirror_to_add ...] [-M mirror_to_remove | --remove-mirror mirror_to_remove ...] [--enable] [--disable] [--no-refresh] [--reset-uuid] [--non-sticky] [--sticky] [--search-after publisher] [--search-before publisher] [--search-first] [--approve-ca-cert path_to_CA] [--revoke-ca-cert hash_of_CA_to_remove] [--unset-ca-cert hash_of_CA_to_remove] [--set-property name_of_property=value] [--add-property-value name_of_property=value_to_add] [--remove-property-value name_of_property=value_to_remove] [--unset-property name_of_property_to_delete] publisher

Update an existing publisher or add a package publisher. If no options affecting search order are specified, new publishers are appended to the search order and are thus searched last.

With -P or --search-first, set the specified publisher first in the search order. When installing new packages, this publisher is searched first. Updates to already installed packages come from the same publisher that originally provided the package as long as that publisher remains sticky. When -P or --search-first is used with -p, only added publishers are placed first in search order.

With --non-sticky, specify that higher ranked publishers than this one can provide updates to packages originally installed from this publisher.

With --sticky, specify that updates to packages that were installed from this publisher must also come from this publisher. This is the default behavior.

With --search-before, alter the publisher search order so that the publisher being modified is searched before the specified publisher. When used with -p, --search-before only applies to added publishers.

With --search-after, alter the publisher search order so that the publisher being modified is searched after the specified publisher. When used with -p, --search-after only applies to added publishers.

With --approve-ca-cert, add the given certificate as a CA certificate that is trusted. The hashes of the PEM representation of the user-approved CA certificates are listed in the detailed output of the pkg publisher command.

With --revoke-ca-cert, treat the certificate with the given hash of its PEM representation as revoked. The hashes of the user-revoked CA certificates are listed in the detailed output of the pkg publisher command.

With --unset-ca-cert, remove the certificate with the given hash from the list of approved certificates and the list of revoked certificates.

With --set-property, update an existing publisher property or add a new publisher property.

With --add-property-value, add a value to an existing publisher property or add a new publisher property.

With --remove-property-value, remove a value from an existing publisher property.

With --unset-property, remove an existing publisher property.

With -c and -k, specify client SSL certificate and key respectively.

With -g (--add-origin), add the specified URI or path as an origin for the given publisher. This should be the location of a package repository or archive.

With -G (--remove-origin), remove the URI or path from the list of origins for the given publisher. The special value * can be used to remove all origins.

With --no-refresh, do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages and other metadata.

With --reset-uuid, choose a new unique identifier that identifies this image to its publisher.

With -m (--add-mirror), add the URI as a mirror for the given publisher.

With -M (--remove-mirror), remove the URI from the list of mirrors for the given publisher. The special value * can be used to remove all mirrors.

With -p, retrieve publisher configuration information from the specified repository URI. If a publisher is specified, then only the matching publisher is added or updated. If no publisher is specified, all publishers are added or updated as appropriate. This option cannot be combined with the -g, --add-origin, --G, --remove-origin, -m, --add-mirror, -M, --remove-mirror, --disable, --enable, --no-refresh, or --reset-uuid options.

With -e (--enable), enable the publisher. With -d (--disable), disable the publisher. A disabled publisher is not used when populating the package list or in certain package operations (install, uninstall, and update). However, the properties for a disabled publisher can still be set and viewed. If only one publisher exists, it cannot be disabled.

/usr/bin/pkg set-publisher -p repo_uri [-Ped] [-k ssl_key] [-c ssl_cert] [--non-sticky] [--sticky] [--search-after publisher] [--search-before publisher] [--search-first] [--approve-ca-cert path_to_CA] [--revoke-ca-cert hash_of_CA_to_remove] [--unset-ca-cert hash_of_CA_to_remove] [--set-property name_of_property=value] [--add-property-value name_of_property=value_to_add] [--remove-property-value name_of_property=value_to_remove] [--unset-property name_of_property_to_delete] [publisher]

With -p, retrieve publisher configuration information from the specified repository URI. If a publisher is specified, then only the matching publisher is added or updated. If no publisher is specified, all publishers are added or updated as appropriate. See pkg set-publisher above for descriptions of other options that can be used with the -p option. The -p option cannot be combined with the -g, --add-origin, -G, --remove-origin, -m, --add-mirror, -M, --remove-mirror, --disable, --enable, --no-refresh, or --reset-uuid options.

unset-publisher publisher ...

Remove the configuration associated with the given publisher or publishers.

history [-Hl] [-t [time | time-time],...] [-o column,...] [-n number]

Display the command history of the applicable image.

With -H, omit the headers from the listing.

With -t, display log records for a comma-separated list of timestamps, formatted with %Y-%m-%dT%H:%M:%S (see strftime(3C)). To specify a range of times, use a hyphen (-) between a start and finish timestamp. The keyword now can be used as an alias for the current time. If the timestamps specified contain duplicate timestamps or overlapping date ranges, only a single instance of each duplicate history event is printed.

With -l, display log records in long format, which, in addition to the standard format, includes the outcome of the command, the time the command completed, the version and name of the client used, the name of the user who performed the operation, and any errors that were encountered while executing the command.

With -n, display only the specified number of most recent entries.

With -o, display output using the specified comma-separated list of column names. Valid column names are:

be

The name of the boot environment this operation was started on.

be_uuid

The uuid of the boot environment this operation was started on.

client

The name of the client.

client_ver

The version of the client.

command

The command line used for this operation.

finish

The time that this operation finished.

id

The user id that started this operation.

new_be

The new boot environment created by this operation.

new_be_uuid

The uuid of the new boot environment created by this operation.

operation

The name of the operation.

outcome

A summary of the outcome of this operation.

reason

Additional information on the outcome of this operation.

snapshot

The snapshot taken during this operation. This is only recorded if the snapshot was not automatically removed after successful operation completion.

start

The time that this operation started.

time

The total time taken to perform this operation. For operations that take less than one second, 0:00:00 is shown.

user

The username that started this operation.

If the command or reason columns are specified, they must be the last item in the -o list, in order to preserve output field separation. These two columns cannot be shown in the same history command.

An asterisk (*) is shown after the values for be or new_be if the boot environment is no longer present on the system.

The values for be and new_be are obtained by looking up the current boot environment name, using the be_uuid or new_be_uuid fields. If a boot environment was subsequently renamed, and later deleted, the values displayed for be and new_be are the values recorded at the time of the pkg operation.

purge-history

Deletes all existing history information.

rebuild-index

Rebuilds the index used by pkg search. This is a recovery operation not intended for general use.

update-format

Updates the format of the image to the current version. Once this operation has completed, the image can no longer be used with older versions of the pkg(5) system.

version

Display a unique string identifying the version of pkg(1). This string is not guaranteed to be comparable in any fashion between versions.

image-create [-FPUfz] [--force] [--full | --partial | --user] [--zone] [-k ssl_key] [-c ssl_cert] [--no-refresh] [--variant variant_name=value ...] [-g path_or_uri | --origin path_or_uri ...] [-m uri | --mirror uri ...] [--set-property name_of_property=value][--facet facet_name=(True|False) ...] [(-p | --publisher) [name=]repo_uri] dir

At the location given by dir, create an image suitable for package operations. The default image type is user, as given by the -U (--user) option. The image type can be set to a full image (--F or --full) or to a partial image (-P or --partial) linked to the full image enclosing the given dir path. Additional origins can be specified using -g or --origin. Additional mirrors can be specified using --m or --mirror.

A package repository URI must be provided using the -p or --publisher option. If a publisher name is also provided, then only that publisher is added when the image is created. If a publisher name is not provided, then all publishers known by the specified repository are added to the image. An attempt to retrieve the catalog associated with this publisher is made following the initial creation operations.

For publishers using client SSL authentication, a client key and client certificate can be registered via the -c and -k options. This key and certificate are used for all publishers added during image creation.

If the image is to be run within non-global zone context, then the -z (--zone) option can be used to set an appropriate variant.

With -f (--force), force the creation of an image over an existing image. This option should be used with care.

With --no-refresh, do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages and other metadata.

With --variant, set the specified variant to the indicated value. See “Facets and Variants” in the pkg(5) man page for more information about variants.

With --facet, set the specified facet to the indicated value. See “Facets and Variants” in the pkg(5) man page for more information about facets.

With --set-property, set the specified image property to the indicated value. See “Image Properties” below for descriptions of image properties.

Image Properties

The following properties define characteristics of the image. These properties store information about the purpose, content, and behavior of the image. To view the current values of these properties in the image, use the pkg property command. To modify the values of these properties, use the pkg set-property and pkg unset-property commands.

be-policy

(string) Specify when a boot environment is created during packaging operations. The following values are allowed:

default

Apply the default BE creation policy, create-backup.

always-new

Requires a reboot for all package operations by performing them in a new BE set as active on the next boot. A backup BE is not created unless explicitly requested.

This policy is the safest, but is more strict than most sites need since no packages can be added without a reboot.

create-backup

For package operations that require a reboot, a new BE is created and set as active on the next boot. If packages are modified or content that could affect the kernel is installed and the operation affects the live BE, a backup BE is created but not set as active. A backup BE can also be explicitly requested.

This policy is potentially risky only if newly installed software causes system instability, which is possible but relatively rare.

when-required

For package operations that require a reboot, a new BE is created and set as active on the next boot. A backup BE is not created unless explicitly requested.

This policy carries the greatest risk since if a packaging change to the live BE makes further changes impossible, there might be no recent BE to which one can fallback.

ca-path

(string) A path name that points to a directory where CA certificates are kept for SSL operations. The format of this directory is specific to the underlying SSL implementation. To use an alternate location for trusted CA certificates, change this value to point to a different directory. See the CApath portions of SSL_CTX_load_verify_locations(3openssl) for requirements for the CA directory.

Default value: /etc/openssl/certs

check-certificate-revocation

(boolean) If this is set to True, the package client attempts to contact any CRL distribution points in the certificates used for signature verification to determine whether the certificate has been revoked since being issued.

Default value: False

flush-content-cache-on-success

(boolean) If this is set to True, the package client removes the files in its content-cache when install or update operations complete. For update operations, the content is removed only from the source BE. When a packaging operation next occurs in the destination BE, the package client flushes its content cache if this option has not been changed.

This property can be used to keep the content-cache small on systems with limited disk space. This property can cause operations to take longer to complete.

Default value: True

mirror-discovery

(boolean) This property tells the client to discover link-local content mirrors using mDNS and DNS-SD. If this property is set to True, the client attempts to download package content from mirrors it dynamically discovers. To run a mirror that advertises its content via mDNS, see pkg.depotd(1M).

Default value: False

send-uuid

(boolean) Send the image's Universally Unique Identifier (UUID) when performing network operations. Although users can disable this option, some network repositories might refuse to talk to clients that do not supply a UUID.

Default value: True

signature-policy

(string) Determine what checks will be performed on manifests when installing, updating, modifying, or verifying packages in the image. The final policy applied to a package depends on the combination of image policy and publisher policy. The combination will be at least as strict as the stricter of the two policies taken individually. By default, the package client does not check whether certificates have been revoked. To enable those checks, which might require the client to contact external web sites, set the check-certificate-revocation image property to True. The following values are allowed:

ignore

Ignore signatures for all manifests.

verify

Verify that all manifests with signatures are validly signed, but do not require all installed packages to be signed. This is the default value.

require-signatures

Require that all newly installed packages have at least one valid signature. The pkg fix and pkg verify commands also warn if an installed package does not have a valid signature.

require-names

Follow the same requirements as require-signatures but also require that the strings listed in the signature-required-names property appear as a common name of the certificates used to verify the chains of trust of the signatures.

signature-required-names

(list of strings) A list of names that must be seen as common names of certificates while validating the signatures of a package.

trust-anchor-directory

(string) The path name of the directory that contains the trust anchors for the image. This path is relative to the image. The default value is ignore.

use-system-repo

(boolean) This property indicates whether the image should use the system repository as a source for image and publisher configuration and as a proxy for communicating with the publishers provided. The default value is False. See pkg.sysrepo(1M) for information about system repositories.

Publisher Properties

The following properties define signature policy for a particular publisher. The image properties of the same name define signature policy for the image. To view the current values of these properties for a particular publisher, use the pkg publisher publisher_name command. To modify the values of these publisher signature policy properties, use the --set-property and --unset-property options of the pkg set-publisher command.

signature-policy

(string) This property functions identically to the image property of the same name except that it only applies to packages from the particular publisher.

signature-required-names

(list of strings) This property functions identically to the image property of the same name except that it only applies to packages from the particular publisher.

Examples

Example 1 Create an Image With Publisher Configured

Create a new, full image, with publisher example.com, stored at /aux0/example_root.

$ pkg image-create -F -p example.com=http://pkg.example.com:10000 \
/aux0/example_root

Example 2 Create an Image, Specifying Additional Origins and Mirror

Create a new, full image, with publisher example.com, that also has an additional mirror, two additional origins, and is stored at /aux0/example_root.

$ pkg image-create -F -p example.com=http://pkg.example.com:10000 \
-g http://alternate1.example.com:10000/ \
-g http://alternate2.example.com:10000/ \
-m http://mirror.example.com:10000/ \
/aux0/example_root

Example 3 Create an Image With No Publisher Configured

Create a new, full image with no publishers configured at /aux0/example_root.

$ pkg image-create -F /aux0/example_root

Example 4 Install a Package

Install the latest version of the widget package in the current image.

$ pkg install application/widget

Example 5 List Specified Contents of a Package

List the contents of the system/file-system/zfs package. Display the action name, the mode of the file (if defined), the size (if defined), the path, and the target (if a link). Limit the action to types dir, file, link, and hardlink, since specifying the action.name attribute, which is available for all actions, displays a line for all actions, which is not desired here.

$ pkg contents -t dir,file,link,hardlink \
-o action.name,mode,pkg.size,path,target system/file-system/zfs
ACTION.NAME MODE PKG.SIZE PATH                 TARGET
dir         0755          etc
dir         0755          etc/fs
dir         0755          etc/fs/zfs
link                      etc/fs/zfs/mount     ../../../usr/sbin/zfs
link                      etc/fs/zfs/umount    ../../../usr/sbin/zfs
dir         0755          etc/zfs
dir         0755          kernel
dir         0755          kernel/drv
dir         0755          kernel/drv/amd64
file        0755  1706744 kernel/drv/amd64/zfs
file        0644      980 kernel/drv/zfs.conf
dir         0755          kernel/fs
dir         0755          kernel/fs/amd64
hardlink                  kernel/fs/amd64/zfs  ../../../kernel/drv/amd64/zfs
...

Example 6 List Specified Contents of Two Packages

List the contents of web/browser/firefox and mail/thunderbird, limiting the display to just the package name and path attributes of actions whose path attribute ends in .desktop or .png.

$ pkg contents -o pkg.name,path -a path=\*.desktop \
-a path=\*.png web/browser/firefox mail/thunderbird
PKG.NAME            PATH
web/browser/firefox usr/share/applications/firefox.desktop
mail/thunderbird    usr/share/applications/thunderbird.desktop
web/browser/firefox usr/share/pixmaps/firefox-icon.png
mail/thunderbird    usr/share/pixmaps/thunderbird-icon.png
...

Example 7 Search for a Package

Search the package database for the token bge.

$ pkg search bge
INDEX       ACTION VALUE                      PACKAGE
driver_name driver bge                        pkg:/driver/network/bge@0.5.11-0.169
basename    file   kernel/drv/sparcv9/bge     pkg:/driver/network/bge@0.5.11-0.169
basename    file   kernel/drv/amd64/bge       pkg:/driver/network/bge@0.5.11-0.169
pkg.fmri    set    solaris/driver/network/bge pkg:/driver/network/bge@0.5.11-0.169

The token is in the package driver/network/bge both as the basename for the file action representing /kernel/drv/arch/bge and as a driver name.

Example 8 Search for Packages that Depend on the Specified Package

Search for installed packages that depend on package/pkg.

$ pkg search -l 'depend::package/pkg'
INDEX       ACTION VALUE                    PACKAGE
incorporate depend package/pkg@0.5.11-0.169 pkg:/consolidation/ips/ips-incorporation@0.5.11-0.169
require     depend package/pkg@0.5.11-0.169 pkg:/system/install@0.5.11-0.169
require     depend package/pkg@0.5.11-0.169 pkg:/package/pkg/system-repository@0.5.11-0.169

Example 9 Search for Dependencies

Search for all incorporate dependencies in installed packages.

$ pkg search -l 'depend:incorporate:'
INDEX       ACTION VALUE                           PACKAGE
incorporate depend pkg:/BRCMbnx@0.5.11,5.11-0.133  pkg:/consolidation/osnet/osnet-incorporation@0.5.11-0.169
incorporate depend pkg:/BRCMbnxe@0.5.11,5.11-0.133 pkg:/consolidation/osnet/osnet-incorporation@0.5.11-0.169
...

Example 10 Add a Publisher

Add a new publisher example.com, with a repository located at http://www.example.com/repo.

$ pkg set-publisher -g http://www.example.com/repo example.com

Example 11 Add a Publisher With Key and Certificate

Add a new publisher example.com, with a secure repository located at https://secure.example.com/repo, and a key and certificate stored in the directory /root/creds.

$ pkg set-publisher -k /root/creds/example.key \
-c /root/creds/example.cert -g https://secure.example.com/repo \
example.com

Example 12 Add and Automatically Configure a Publisher

Add a new publisher with a repository located at /export/repo using automatic configuration.

$ pkg set-publisher -p /export/repo

Example 13 Add and Manually Configure a Publisher

Add a new publisher example.com with a repository located at /export/repo/example.com using manual configuration.

$ pkg set-publisher -g /export/repo example.com

Example 14 Verify All Signed Packages

Configure an image to verify all signed packages.

$ pkg set-property signature-policy verify

Example 15 Require All Packages To Be Signed

Configure an image to require all packages to be signed, and require the string example.com to be seen as a common name for one of the certificates in the chain of trust.

$ pkg set-property signature-policy require-names example.com

Example 16 Require All Packages From a Specified Publisher To Be Signed

Configure an image so that all packages installed from publisher example.com must be signed.

$ pkg set-publisher --set-property signature-policy=require-signatures \
example.com

Example 17 Require a Specified String in the Chain of Trust

Add the string foo to the image's list of common names that must be seen in a signature's chain of trust to be considered valid.

$ pkg add-property-value signature-require-names foo

Example 18 Remove a String From the Chain of Trust for a Specified Publisher

Remove the string foo from the list of common names that must be seen to validate a signature for the publisher example.com.

$ pkg set-publisher --remove-property-value signature-require-names=foo \
example.com

Example 19 Add a Trusted CA Certificate

Add the certificate stored in /tmp/example_file.pem as a trusted CA certificate for the publisher example.com.

$ pkg set-publisher --approve-ca-cert /tmp/example_file.pem \
example.com

Example 20 Revoke a Certificate

Revoke the certificate with the hash a12345 for publisher example.com, preventing the certificate from validating any signatures for packages from example.com.

$ pkg set-publisher --revoke-ca-cert a12345 example.com

Example 21 Forget About a Certificate

Make pkg forget that the certificate a12345 was ever added or revoked by the user.

$ pkg set-publisher --unset-ca-cert a12345 example.com

Example 22 Downgrade a Package

Downgrade the installed package foo@1.1 to an older version.

$ pkg update foo@1.0

Example 23 Switch Conflicting Package Installation

In the case of two conflicting packages, change which package is installed. Suppose package A depends on either package B or package C, and B and C are mutually exclusive. If A and B are installed, use the following command to switch to using C instead of B without uninstalling A:

$ pkg install --reject B C

Example 24 List Packages in a Package Archive

List all versions of all packages in a package archive.

$ pkg list -f -g /my/archive.p5p

Example 25 List Packages in a Package Repository

List all versions of all packages in a repository.

$ pkg list -f -g http://example.com:10000

Example 26 Display Information About a Package in a Package Archive

Display the package information for the latest version of a package in a package archive. The package might or might not be currently installed.

$ pkg info -g /my/archive.p5p pkg_name

Example 27 Display Contents of a Package in a Package Archive

Display the contents of a package in a package archive. The package is not currently installed.

$ pkg contents -g /my/archive.p5p pkg_name

Example 28 Remove All Publisher Origins and Mirrors

Remove all of the origins and mirrors for a publisher and add a new origin.

$ pkg set-publisher -G '*' -M '*' -g http://example.com:10000 \
example.com

Environment Variables

PKG_IMAGE

The directory containing the image to use for package operations. Ignored if -R is specified.

PKG_CLIENT_CONNECT_TIMEOUT

Seconds to wait trying to connect during transport operations (for each attempt) before the client aborts the operation. A value of 0 means wait indefinitely.

Default value: 60

PKG_CLIENT_LOWSPEED_TIMEOUT

Seconds below the lowspeed limit (1024 bytes/sec) during transport operations before the client aborts the operation. A value of 0 means do not abort the operation.

Default value: 30

PKG_CLIENT_MAX_CONSECUTIVE_ERROR

Maximum number of transient transport errors before the client aborts the operation. A value of 0 means do not abort the operation.

Default value: 4

PKG_CLIENT_MAX_REDIRECT

Maximum number of HTTP or HTTPS redirects allowed during transport operations before a connection is aborted. A value of 0 means do not abort the operation.

Default value: 5

PKG_CLIENT_MAX_TIMEOUT

Maximum number of transport attempts per host before the client aborts the operation. A value of 0 means do not abort the operation.

Default value: 4

http_proxy, https_proxy

HTTP or HTTPS proxy server.

Exit Status

The following exit values are returned:

0

Command succeeded.

1

An error occurred.

2

Invalid command line options were specified.

3

Multiple operations were requested, but only some of them succeeded.

4

No changes were made - nothing to do.

5

The requested operation cannot be performed on a live image.

6

The requested operation cannot be completed because the licenses for the packages being installed or updated have not been accepted.

7

The image is currently in use by another process and cannot be modified.

99

An unanticipated exception occurred.

Files

A pkg(5) image can be located arbitrarily within a larger file system. In the following file descriptions, the token $IMAGE_ROOT is used to distinguish relative paths. For a typical system installation, $IMAGE_ROOT is equivalent to /

$IMAGE_ROOT/var/pkg

Metadata directory for a full or partial image.

$IMAGE_ROOT/.org.opensolaris,pkg

Metadata directory for a user image.

Within a particular image's metadata, certain files and directories can contain information useful during repair and recovery. The token $IMAGE_META refers to the top-level directory containing the metadata. $IMAGE_META is typically one of the two paths given above.

$IMAGE_META/lost+found

Location of conflicting directories and files moved during a package operation. Location of unpackaged contents of a removed directory.

$IMAGE_META/publisher

Contains a directory for each publisher. Each directory stores publisher-specific metadata.

Other paths within the $IMAGE_META directory hierarchy are private and are subject to change.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
package/pkg
Interface Stability
Uncommitted

See Also

pkgsend(1), pkg.depotd(1m), glob(3C), pkg(5), beadm(1M)

http://hub.opensolaris.org/bin/view/Project+pkg/