'\" te .\" Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved. .TH pkg 1 "22 Apr 2015" "SunOS 5.11" "User Commands" .SH NAME pkg \- Image Packaging System retrieval client .SH SYNOPSIS .LP .nf /usr/bin/pkg [\fIoptions\fR] command [\fIcmd_options\fR] [\fIoperands\fR] .fi .LP .nf /usr/bin/pkg refresh [-q] [--full] [\fIpublisher\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg install [-nvq] [-C \fIn\fR] [-g \fIpath_or_uri\fR]\&.\&.\&. [-r [[-z \fIzonename\fR]\&.\&.\&. | [-Z \fIzonename\fR]\&.\&.\&. ]] [--accept] [--licenses] [--no-index] [--no-refresh] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--reject \fIpkg_fmri_pattern\fR]\&.\&.\&. [--sync-actuators | --sync-actuators-timeout \fItimeout\fR] \fIpkg_fmri_pattern\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg exact-install [-nvq] [-C \fIn\fR] [-g \fIpath_or_uri\fR]\&.\&.\&. [--accept] [--licenses] [--no-index] [--no-refresh] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--reject \fIpkg_fmri_pattern\fR]\&.\&.\&. \fIpkg_fmri_pattern\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg uninstall [-nvq] [-C \fIn\fR] [-r [[-z \fIzonename\fR]\&.\&.\&. | [-Z \fIzonename\fR]\&.\&.\&. ]] [--ignore-missing] [--no-index] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--sync-actuators | --sync-actuators-timeout \fItimeout\fR] \fIpkg_fmri_pattern\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg update [-fnvq] [-C \fIn\fR] [-g \fIpath_or_uri\fR]\&.\&.\&. [-r [[-z \fIzonename\fR]\&.\&.\&. | [-Z \fIzonename\fR]\&.\&.\&. ]] [--accept] [--ignore-missing] [--licenses] [--no-index] [--no-refresh] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--reject \fIpkg_fmri_pattern\fR]\&.\&.\&. [--sync-actuators | --sync-actuators-timeout \fItimeout\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg list [-Hafnqsuv] [-g \fIpath_or_uri\fR]\&.\&.\&. [--no-refresh] [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg info [-lqr] [-g \fIpath_or_uri\fR]\&.\&.\&. [--license] [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg contents [-Hmr] [-a \fIattribute\fR=\fIpattern\fR]\&.\&.\&. [-g \fIpath_or_uri\fR]\&.\&.\&. [-o \fIattribute\fR[,\fIattribute\fR]\&.\&.\&.]\&.\&.\&. [-s \fIsort_key\fR] [-t \fIaction_name\fR[,\fIaction_name\fR]\&.\&.\&.]\&.\&.\&. [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg search [-HIaflpr] [-o \fIattribute\fR[,\fIattribute\fR]\&.\&.\&.]\&.\&.\&. [-s \fIrepo_uri\fR] \fIquery\fR .fi .LP .nf /usr/bin/pkg verify [-Hqv] [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg fix [-Hnvq] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--accept] [--licenses] [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg revert [-nv] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] (--tagged \fItag-name\fR \&.\&.\&. | \fIpath-to-file\fR \&.\&.\&.) .fi .LP .nf /usr/bin/pkg mediator [-aH] [-F \fIformat\fR] [\fImediator\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg set-mediator [-nv] [-I \fIimplementation\fR] [-V \fIversion\fR] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] \fImediator\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg unset-mediator [-nvIV] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] \fImediator\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg variant [-Haiv] [-F \fIformat\fR] [\fIvariant_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg change-variant [-nvq] [-C \fIn\fR] [-g \fIpath_or_uri\fR]\&.\&.\&. [-r [[-z \fIzonename\fR]\&.\&.\&. | [-Z \fIzonename\fR]\&.\&.\&. ]] [--accept] [--licenses] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--sync-actuators | --sync-actuators-timeout \fItimeout\fR] \fIvariant_name\fR=\fIvalue\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg facet [-Haim] [-F \fIformat\fR] [\fIfacet_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg change-facet [-nvq] [-C \fIn\fR] [-g \fIpath_or_uri\fR]\&.\&.\&. [-r [[-z \fIzonename\fR]\&.\&.\&. | [-Z \fIzonename\fR]\&.\&.\&. ]] [--accept] [--licenses] [--no-be-activate] [--no-backup-be | --require-backup-be] [--backup-be-name \fIname\fR] [--deny-new-be | --require-new-be] [--be-name \fIname\fR] [--sync-actuators | --sync-actuators-timeout \fItimeout\fR] \fIfacet_name\fR=(True|False|None) \&.\&.\&. .fi .LP .nf /usr/bin/pkg avoid [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg unavoid [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg freeze [-n] [-c \fIreason\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg unfreeze [-n] [\fIpkg_name_pattern\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg property [-H] [\fIpropname\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg set-property \fIpropname\fR \fIpropvalue\fR .fi .LP .nf /usr/bin/pkg add-property-value \fIpropname\fR \fIpropvalue\fR .fi .LP .nf /usr/bin/pkg remove-property-value \fIpropname\fR \fIpropvalue\fR .fi .LP .nf /usr/bin/pkg unset-property \fIpropname\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg publisher [-HPn] [-F \fIformat\fR] [\fIpublisher\fR \&.\&.\&.] .fi .LP .nf /usr/bin/pkg set-publisher [-Ped] [-c \fIssl_cert\fR] [-k \fIssl_key\fR] [-g \fIorigin_to_add\fR | --add-origin \fIorigin_to_add\fR]\&.\&.\&. [-G \fIorigin_to_remove\fR | --remove-origin \fIorigin_to_remove\fR]\&.\&.\&. [-m \fImirror_to_add\fR | --add-mirror \fImirror_to_add\fR]\&.\&.\&. [-M \fImirror_to_remove\fR | --remove-mirror \fImirror_to_remove\fR]\&.\&.\&. [--disable] [--enable] [--no-refresh] [--reset-uuid] [--non-sticky] [--sticky] [--search-after \fIpublisher\fR] [--search-before \fIpublisher\fR] [--search-first] [--approve-ca-cert \fIpath_to_CA\fR] [--revoke-ca-cert \fIhash_of_CA_to_remove\fR] [--unset-ca-cert \fIhash_of_CA_to_remove\fR] [--set-property \fIname_of_property\fR=\fIvalue\fR] [--add-property-value \fIname_of_property\fR=\fIvalue_to_add\fR] [--remove-property-value \fIname_of_property\fR=\fIvalue_to_remove\fR] [--unset-property \fIname_of_property_to_delete\fR] [--proxy \fIproxy_to_use\fR] \fIpublisher\fR .fi .LP .nf /usr/bin/pkg set-publisher -p \fIrepo_uri\fR [-Ped] [-c \fIssl_cert\fR] [-k \fIssl_key\fR] [--non-sticky] [--sticky] [--search-after \fIpublisher\fR] [--search-before \fIpublisher\fR] [--search-first] [--approve-ca-cert \fIpath_to_CA\fR] [--revoke-ca-cert \fIhash_of_CA_to_remove\fR] [--unset-ca-cert \fIhash_of_CA_to_remove\fR] [--set-property \fIname_of_property\fR=\fIvalue\fR] [--add-property-value \fIname_of_property\fR=\fIvalue_to_add\fR] [--remove-property-value \fIname_of_property\fR=\fIvalue_to_remove\fR] [--unset-property \fIname_of_property_to_delete\fR] [--proxy \fIproxy_to_use\fR] [\fIpublisher\fR] .fi .LP .nf /usr/bin/pkg unset-publisher \fIpublisher\fR \&.\&.\&. .fi .LP .nf /usr/bin/pkg history [-HNl] [-n \fInumber\fR] [-o \fIcolumn\fR[,\fIcolumn\fR]\&.\&.\&.]\&.\&.\&. [-t \fItime\fR | \fItime\fR-\fItime\fR[,\fItime\fR | \fItime\fR-\fItime\fR]\&.\&.\&.]\&.\&.\&. .fi .LP .nf /usr/bin/pkg purge-history .fi .LP .nf /usr/bin/pkg rebuild-index .fi .LP .nf /usr/bin/pkg update-format .fi .LP .nf /usr/bin/pkg version .fi .LP .nf /usr/bin/pkg help [-v] .fi .LP .nf /usr/bin/pkg image-create [-FPUfz] [--force] [--full | --partial | --user] [--zone] [-c \fIssl_cert\fR] [-k \fIssl_key\fR] [-g \fIpath_or_uri\fR | --origin \fIpath_or_uri\fR]\&.\&.\&. [-m \fIuri\fR | --mirror \fIuri\fR]\&.\&.\&. [--facet \fIfacet_name\fR=(True|False)]\&.\&.\&. [--no-refresh] [--set-property \fIname_of_property\fR=\fIvalue\fR] [--variant \fIvariant_name\fR=\fIvalue\fR]\&.\&.\&. [(-p | --publisher) [\fIname\fR=]\fIrepo_uri\fR] \fIdir\fR .fi .LP .nf /usr/bin/pkg -R \fIdir\fR dehydrate [-nvq] [-p \fIpublisher\fR]\&.\&.\&. .fi .LP .nf /usr/bin/pkg -R \fIdir\fR rehydrate [-nvq] [-p \fIpublisher\fR]\&.\&.\&. .fi .SH DESCRIPTION .sp .LP \fBpkg\fR is the retrieval client for the Image Packaging System\&. With a valid configuration, \fBpkg\fR 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\&. \fBpkg\fR retrieves packages from a publisher\'s repository or package archives and installs the packages into an image\&. .sp .LP Packages can only be installed into file systems that are part of a BE\&. For example, on a default Oracle Solaris 11 installation, only datasets under \fBrpool/ROOT/\fIBEname\fR/\fR are supported for package operations\&. .sp .LP 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\&. .sp .LP 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 \fBexample\&.org\fR might have their repository located at the URI \fBhttp://example\&.org/repository\fR\&. .sp .LP \fBpkg\fR 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 \fBpkg\fR(5) repositories\&. .sp .LP 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\&. .SH OPTIONS .sp .LP The following options are supported: .sp .ne 2 .mk .na \fB\fB-?\fR\fR .ad .br .na \fB\fB--help\fR\fR .ad .br .sp .6 .RS 4n Display a usage message\&. .RE .sp .ne 2 .mk .na \fB\fB-R\fR \fIdir\fR\fR .ad .br .sp .6 .RS 4n Operate on the image rooted at \fIdir\fR\&. If no directory was specified or determined based on environment, the default is /\&. See the "Environment Variables" section for more information\&. .RE .SH SUB-COMMANDS .sp .LP The following subcommands are supported: .sp .ne 2 .mk .na \fB\fBpkg refresh\fR [\fB-q\fR] [\fB--full\fR] [\fIpublisher\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Update the client\'s list of available packages and publisher metadata for all publishers\&. .sp .ne 2 .mk .na \fB\fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Update the client\'s list of available packages and publisher metadata only for the specified publishers\&. .RE .sp .ne 2 .mk .na \fB\fB-q\fR\fR .ad .br .sp .6 .RS 4n Hide progress messages during the requested operation\&. .RE .sp .ne 2 .mk .na \fB\fB--full\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg install\fR [\fB-nvq\fR] [\fB-C\fR \fIn\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB-r\fR [[\fB-z\fR \fIzonename\fR]\&.\&.\&. | [\fB-Z\fR \fIzonename\fR]\&.\&.\&. ]] [\fB--accept\fR] [\fB--licenses\fR] [\fB--no-index\fR] [\fB--no-refresh\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--reject\fR \fIpkg_fmri_pattern\fR]\&.\&.\&. [\fB--sync-actuators\fR | \fB--sync-actuators-timeout\fR \fItimeout\fR] \fIpkg_fmri_pattern\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Install and update the specified packages to the newest version that match \fIpkg_fmri_pattern\fR allowed by the packages installed in the image\&. To explicitly request the latest version of a package, use \fBlatest\fR for the version portion of \fIpkg_fmri_pattern\fR\&. For example, specify \fBvim@latest\fR\&. The \fIpkg_fmri_pattern\fR pattern can include the \fB?\fR and \fB*\fR characters as \fBglob\fR(3C)-style wildcards to match one or more packages\&. .sp Packages are selected based on publisher search order and stickiness\&. See the \fBpkg publisher\fR and \fBpkg set-publisher\fR commands for information about search order and stickiness\&. If the \fIpkg_fmri_pattern\fR does not specify the publisher, the first publisher that provides a matching package is used as the installation source\&. If that publisher does not provide a version of the package that can be installed in this image, then the installation operation fails\&. Use the \fBpkg list -a\fR command to see which publishers provide a version of the package that can be installed in this image\&. .sp If more than one \fIpkg_fmri_pattern\fR is specified, and if any of the specified packages cannot be installed in this image, then none of the specified packages will be installed\&. .sp Some configuration files might be renamed or replaced during the installation process\&. For more information about how the package system determines which files to preserve, and how they are preserved during package operations, see "File Actions" in the \fBpkg\fR(5) man page\&. .sp If a package is on the avoid list, installing it removes it from that list\&. .sp .ne 2 .mk .na \fB\fB-C\fR \fIn\fR\fR .ad .br .sp .6 .RS 4n Specify the number of child images to update in parallel\&. When recursing into child images (usually installed \fBsolaris\fR branded non-global zones), update at most \fIn\fR child images in parallel\&. The default number of child images to update in parallel is 1\&. If \fIn\fR is 0 or a negative number, all child images are updated in parallel\&. See also \fBPKG_CONCURRENCY\fR in the "Environment Variables" section\&. .RE .sp .ne 2 .mk .na \fB\fB-g\fR \fIpath_or_uri\fR\fR .ad .br .sp .6 .RS 4n Temporarily add the specified package repository or archive to the list of sources in the image from which to retrieve package data\&. Repositories that require a client SSL certificate cannot be used with this option\&. This option can be specified multiple times\&. .sp When deciding which version of a package to use, publishers configured in the image, but not found in the specified \fIpath_or_uri\fR sources, take precedence\&. If the version of the package to be installed is provided by a publisher configured in the image and by a \fIpath_or_uri\fR source, the client retrieves the content for that package from the \fIpath_or_uri\fR sources\&. After installation or update, any packages provided by publishers not configured in the image are added to the image configuration without an origin\&. Use the \fBpkg publisher\fR command to see which publishers are configured in the image\&. .RE .sp .ne 2 .mk .na \fB\fB-n\fR\fR .ad .br .sp .6 .RS 4n Perform a trial run of the operation with no package changes made\&. .RE .sp .ne 2 .mk .na \fB\fB-q\fR\fR .ad .br .sp .6 .RS 4n Hide progress messages during the requested operation\&. .RE .sp .ne 2 .mk .na \fB\fB-r\fR\fR .ad .br .sp .6 .RS 4n Run this operation in the global zone and also in all installed \fBsolaris\fR branded non-global zones\&. The effect on the non-global zone is similar to logging into each non-global zone and running the command directly\&. Without this option, when you run \fBpkg\fR commands in the global zone, non-global zones are modified only to the extent required to keep them compatible with the global zone\&. With this option, the \fBpkg\fR operation is applied to all installed non-global zones except as limited by the \fB-z\fR and \fB-Z\fR options\&. Zones that are excluded by the \fB-z\fR and \fB-Z\fR options might still be modified if updates are required to keep them in sync with the global zone\&. .RE .sp .ne 2 .mk .na \fB\fB-z\fR \fIzonename\fR\fR .ad .br .sp .6 .RS 4n Run this operation only in the specified non-global zone\&. The \fB-z\fR option can be specified multiple times\&. The \fB-z\fR option can only be used with the \fB-r\fR option\&. The \fB-z\fR option cannot be used with the \fB-Z\fR option\&. .RE .sp .ne 2 .mk .na \fB\fB-Z\fR \fIzonename\fR\fR .ad .br .sp .6 .RS 4n Run this operation in all non-global zones except for the specified zone\&. The \fB-Z\fR option can be specified multiple times\&. The \fB-Z\fR option can only be used with the \fB-r\fR option\&. The \fB-Z\fR option cannot be used with the \fB-z\fR option\&. .RE .sp .ne 2 .mk .na \fB\fB-v\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .sp .ne 2 .mk .na \fB\fB--accept\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .sp .ne 2 .mk .na \fB\fB--licenses\fR\fR .ad .br .sp .6 .RS 4n Display all of the licenses for the packages that are installed or updated as part of this operation\&. For updated packages, display the license only if the license has changed\&. .RE .sp .ne 2 .mk .na \fB\fB--no-index\fR\fR .ad .br .sp .6 .RS 4n Do not update the search indexes after the operation has completed successfully\&. .RE .sp .ne 2 .mk .na \fB\fB--no-refresh\fR\fR .ad .br .sp .6 .RS 4n Do not attempt to contact the repositories for the image\'s publishers to retrieve the newest list of available packages and other metadata\&. .RE .sp .ne 2 .mk .na \fB\fB--no-be-activate\fR\fR .ad .br .sp .6 .RS 4n If a boot environment is created, do not set it as the active boot environment on the next boot\&. See the \fBbeadm\fR(1M) man page for more information\&. .RE .sp .ne 2 .mk .na \fB\fB--no-backup-be\fR\fR .ad .br .sp .6 .RS 4n Do not create a backup boot environment\&. .RE .sp .ne 2 .mk .na \fB\fB--require-backup-be\fR\fR .ad .br .sp .6 .RS 4n 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 \fBbe-policy\fR in "Image Properties" below for an explanation of when backup boot environments are created automatically\&. .RE .sp .ne 2 .mk .na \fB\fB--backup-be-name\fR \fIname\fR\fR .ad .br .sp .6 .RS 4n Name the created backup boot environment using the given argument\&. Use of \fB--backup-be-name\fR implies \fB--require-backup-be\fR\&. See also the \fBbeadm\fR(1M) man page\&. .RE .sp .ne 2 .mk .na \fB\fB--deny-new-be\fR\fR .ad .br .sp .6 .RS 4n Do not create a new boot environment\&. This operation is not performed if a new boot environment is required\&. .RE .sp .ne 2 .mk .na \fB\fB--require-new-be\fR\fR .ad .br .sp .6 .RS 4n Always create a new boot environment\&. Without this option, a boot environment is created based on image policy\&. See \fBbe-policy\fR in "Image Properties" below for an explanation of when boot environments are created automatically\&. This option cannot be combined with \fB--require-backup-be\fR\&. .RE .sp .ne 2 .mk .na \fB\fB--be-name\fR \fIname\fR\fR .ad .br .sp .6 .RS 4n Rename the newly created boot environment to be the argument given\&. Use of \fB--be-name\fR implies \fB--require-new-be\fR\&. See also the \fBbeadm\fR(1M) man page\&. .RE .sp .ne 2 .mk .na \fB\fB--reject\fR \fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n 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\&. This option can be specified multiple times\&. .RE .sp .ne 2 .mk .na \fB\fB--sync-actuators\fR\fR .ad .br .sp .6 .RS 4n Run SMF actuators synchronously\&. The \fBpkg\fR(1) command will not return until all SMF actuators have finished in the zone in which \fBpkg\fR was invoked (the global zone or a non-global zone)\&. .RE .sp .ne 2 .mk .na \fB\fB--sync-actuators-timeout\fR \fItimeout\fR\fR .ad .br .sp .6 .RS 4n Run SMF actuators synchronously\&. If the actuators do not finish within the given \fItimeout\fR in seconds, \fBpkg\fR(1) will continue operation and exit with return code 8\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg exact-install\fR [\fB-nvq\fR] [\fB-C\fR \fIn\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB--accept\fR] [\fB--licenses\fR] [\fB--no-index\fR] [\fB--no-refresh\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--reject\fR \fIpkg_fmri_pattern\fR]\&.\&.\&. \fIpkg_fmri_pattern\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Install or update the specified packages as if installing onto a bare system\&. Any previously installed packages that are not specified on the command line and are not a dependency of the specified packages will be removed\&. This command ignores restrictions to not install packages that are on the avoid list and not update packages that are on the frozen list\&. Otherwise, this \fBexact-install\fR subcommand behaves the same way that the \fBinstall\fR subcommand behaves\&. To explicitly request the latest version of a package, use \fBlatest\fR for the version portion of \fIpkg_fmri_pattern\fR\&. For example, specify \fBvim@latest\fR\&. .sp Packages are selected based on publisher search order and stickiness\&. See the \fBpkg publisher\fR and \fBpkg set-publisher\fR commands for information about search order and stickiness\&. If the \fIpkg_fmri_pattern\fR does not specify the publisher, the first publisher that provides a matching package is used as the installation source\&. If that publisher does not provide a version of the package that can be installed in this image, then the installation operation fails\&. Use the \fBpkg list -a\fR command to see which publishers provide a version of the package that can be installed in this image\&. .sp If more than one \fIpkg_fmri_pattern\fR is specified, and if any of the specified packages cannot be installed in this image, then none of the specified packages will be installed\&. .sp Some configuration files might be renamed or replaced during the installation process\&. For more information about how the package system determines which files to preserve, and how they are preserved during package operations, see "File Actions" in the \fBpkg\fR(5) man page\&. .sp If a package is on the avoid list, installing it removes it from that list\&. .sp For descriptions of options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg uninstall\fR [\fB-nvq\fR] [\fB-C\fR \fIn\fR] [\fB-r\fR [[\fB-z\fR \fIzonename\fR]\&.\&.\&. | [\fB-Z\fR \fIzonename\fR]\&.\&.\&. ]] [\fB--ignore-missing\fR] [\fB--no-index\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--sync-actuators\fR | \fB--sync-actuators-timeout\fR \fItimeout\fR] \fIpkg_fmri_pattern\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Remove installed packages that match \fIpkg_fmri_pattern\fR\&. .sp If a package is the subject of a group dependency, uninstalling it places it on the avoid list\&. See the \fBavoid\fR subcommand below\&. .sp In the command output, note any messages that say a new boot environment has been created\&. If a new boot environment has been created and activated, that is the environment that is booted by default on next reboot\&. See the \fBbeadm\fR(1M) man page for information about managing boot environments\&. .sp .sp .ne 2 .mk .na \fB\fB--ignore-missing\fR\fR .ad .br .sp .6 .RS 4n Ignore packages that are not installed\&. Using this option prevents \fBpkg uninstall\fR from failing when attempting to uninstall a package that is not currently installed\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg update\fR [\fB-fnvq\fR] [\fB-C\fR \fIn\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB-r\fR [[\fB-z\fR \fIzonename\fR]\&.\&.\&. | [\fB-Z\fR \fIzonename\fR]\&.\&.\&. ]] [\fB--accept\fR] [\fB--ignore-missing\fR] [\fB--licenses\fR] [\fB--no-index\fR] [\fB--no-refresh\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--reject\fR \fIpkg_fmri_pattern\fR]\&.\&.\&. [\fB--sync-actuators\fR | \fB--sync-actuators-timeout\fR \fItimeout\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Update all packages installed in the current image to the newest version allowed by the constraints imposed on the system by installed packages and publisher configuration\&. .sp In the command output, note any messages that say a new boot environment has been created\&. If a new boot environment has been created and activated, that is the environment that is booted by default on next reboot if you do not specify the \fB--no-be-activate\fR option\&. See the \fBbeadm\fR(1M) man page for information about managing boot environments\&. .sp .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Update only the specified packages installed in the current image\&. If asterisk (*) is one of the \fIpkg_fmri_pattern\fR patterns provided, update all packages installed in the current image in the same way as when no \fIpkg_fmri_pattern\fR is provided\&. .sp To explicitly request the latest version of a package, use \fBlatest\fR for the version portion of \fIpkg_fmri_pattern\fR\&. For example, specify \fBvim@latest\fR\&. .sp 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\&. .sp Any preserved configuration files that are part of packages to be downgraded and that have been changed since the original version was installed are renamed using the extension \fB\&.update\fR\&. 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 \fBpkg\fR(5) man page\&. .sp If more than one \fIpkg_fmri_pattern\fR is specified, and if any of the specified packages cannot be updated in this image, then none of the specified packages will be updated\&. .RE .sp .ne 2 .mk .na \fB\fB-f\fR\fR .ad .br .sp .6 .RS 4n Do not execute the client up-to-date check when updating all installed packages\&. .RE .sp .ne 2 .mk .na \fB\fB--ignore-missing\fR\fR .ad .br .sp .6 .RS 4n Ignore packages that are not installed\&. Using this option prevents \fBpkg update\fR from failing when attempting to update a package that is not currently installed\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg list\fR [\fB-Hafnqsuv\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB--no-refresh\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display a list of all packages installed in the current image, including information such as version and installed state\&. By default, package variants for a different architecture or zone type are excluded\&. The usual output is in three columns: .sp .sp .in +2 .nf NAME (PUBLISHER) VERSION IFO system/core-os 0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 i-- x11/wm/fvwm (fvwm\&.org) 2\&.6\&.5 i-- .fi .in -2 .sp 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 \fBpkg\fR(5) man page for information about release and branch versions and about variants\&. .sp .LP The last column contains a set of flags that show the status of the package: .RS +4 .TP .ie t \(bu .el o An \fBi\fR in the \fBI\fR column shows that the package is installed\&. .RE .RS +4 .TP .ie t \(bu .el o An \fBf\fR in the \fBF\fR column shows that the package is frozen\&. .RE .RS +4 .TP .ie t \(bu .el o An \fBo\fR in the \fBO\fR column shows that the package is obsolete\&. An \fBr\fR in the \fBO\fR column shows that the package has been renamed (a form of obsoletion)\&. .RE .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n List only the specified packages\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .sp .ne 2 .mk .na \fB\fB-a\fR\fR .ad .br .sp .6 .RS 4n List installed packages and list the newest version of packages that are not installed but could be installed in this image\&. Packages can be installed 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 \fB-a\fR, list only installed packages\&. .RE .sp .ne 2 .mk .na \fB\fB-af\fR\fR .ad .br .sp .6 .RS 4n 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 \fBlatest\fR for the version portion of \fIpkg_fmri_pattern\fR\&. For example, specify \fBvim@latest\fR\&. .RE .sp .ne 2 .mk .na \fB\fB-g\fR \fIpath_or_uri\fR\fR .ad .br .sp .6 .RS 4n Use the specified package repository or archive as the source of package data for the operation\&. Repositories that require a client SSL certificate cannot be used with this option\&. This option can be specified multiple times\&. Use of \fB-g\fR implies \fB-a\fR if \fB-n\fR is not specified\&. .RE .sp .ne 2 .mk .na \fB\fB-n\fR\fR .ad .br .sp .6 .RS 4n Display the newest versions of all known packages, regardless of installed state\&. .RE .sp .ne 2 .mk .na \fB\fB-q\fR\fR .ad .br .sp .6 .RS 4n Do not list any packages, but return failure if a fatal error occurs\&. .RE .sp .ne 2 .mk .na \fB\fB-s\fR\fR .ad .br .sp .6 .RS 4n Display a one-line short-form giving the package name and summary\&. This option can be used with \fB-a\fR, \fB-n\fR, or \fB-u\fR\&. .RE .sp .ne 2 .mk .na \fB\fB-u\fR\fR .ad .br .sp .6 .RS 4n List installed packages that have newer versions available\&. This option cannot be used with \fB-g\fR\&. .RE .sp .ne 2 .mk .na \fB\fB-v\fR\fR .ad .br .sp .6 .RS 4n Show full package FMRIs, including publisher and complete version, all in the first column (the VERSION column disappears)\&. This option can be used with \fB-a\fR, \fB-n\fR, or \fB-u\fR\&. .RE .sp .ne 2 .mk .na \fB\fB--no-refresh\fR\fR .ad .br .sp .6 .RS 4n Do not attempt to contact the repositories for the image\'s publishers to retrieve the newest list of available packages\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg info\fR [\fB-lqr\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB--license\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display information about all packages installed in the current image in a human-readable form\&. .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Display information for only the specified packages\&. .RE .sp .ne 2 .mk .na \fB\fB-g\fR \fIpath_or_uri\fR\fR .ad .br .sp .6 .RS 4n Use the specified package repository or archive as the source of package data for the operation\&. Repositories that require a client SSL certificate cannot be used with this option\&. This option can be specified multiple times\&. Use of \fB-g\fR implies \fB-r\fR\&. .RE .sp .ne 2 .mk .na \fB\fB-l\fR\fR .ad .br .sp .6 .RS 4n Only display information for installed packages\&. This is the default\&. .RE .sp .ne 2 .mk .na \fB\fB-q\fR\fR .ad .br .sp .6 .RS 4n Do not display any package information, but return failure if a fatal error occurs\&. .RE .sp .ne 2 .mk .na \fB\fB-r\fR\fR .ad .br .sp .6 .RS 4n 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 \fB-r\fR, only installed packages are displayed by default\&. .RE .sp .ne 2 .mk .na \fB\fB--license\fR\fR .ad .br .sp .6 .RS 4n Display the license texts for the packages\&. This option can be combined with \fB-l\fR, \fB-q\fR, or \fB-r\fR\&. Return success if all \fIpkg_fmri_pattern\fR patterns match known packages and have licenses\&. Return failure if one or more patterns are unmatched or match packages that do not have licenses\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg contents\fR [\fB-Hmr\fR] [\fB-a\fR \fIattribute\fR=\fIpattern\fR]\&.\&.\&. [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB-o\fR \fIattribute\fR[,\fIattribute\fR]\&.\&.\&.]\&.\&.\&. [\fB-s\fR \fIsort_key\fR] [\fB-t\fR \fIaction_name\fR[,\fIaction_name\fR]\&.\&.\&.]\&.\&.\&. [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the contents (action attributes) of all packages installed in the image\&. With no options, display the value of the \fBpath\fR attribute for actions installed in the current image, sorted alphabetically by attribute value\&. For information about actions and their attributes, see "Actions" in the \fBpkg\fR(5) man page\&. See also the list of pseudo attribute names below\&. .sp .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Display contents of only the specified packages\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the output\&. .RE .sp .ne 2 .mk .na \fB\fB-a\fR \fIattribute\fR=\fIpattern\fR\fR .ad .br .sp .6 .RS 4n Limit the output to those actions that have an \fIattribute\fR named in the option argument with a value that matches the (glob) \fIpattern\fR in the option argument\&. This option can be specified multiple times\&. If multiple \fB-a\fR options are given, then actions that match any of them are displayed\&. .RE .sp .ne 2 .mk .na \fB\fB-g\fR \fIpath_or_uri\fR\fR .ad .br .sp .6 .RS 4n Display information for packages that could be installed in this image from the specified package repository or archive\&. Repositories that require a client SSL certificate cannot be used with this option\&. 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 \fB-g\fR implies \fB-r\fR\&. .RE .sp .ne 2 .mk .na \fB\fB-m\fR\fR .ad .br .sp .6 .RS 4n Display all attributes of all actions in the specified packages, including actions that could not be installed in this image\&. .RE .sp .ne 2 .mk .na \fB\fB-o\fR \fIattribute\fR\fR .ad .br .sp .6 .RS 4n Display the specified attributes, sorted according to the values of the first attribute listed\&. The \fB-o\fR option can be specified multiple times, or multiple attributes can be specified as the argument to one \fB-o\fR option by separating the attribute names with commas\&. Only actions that have the requested attributes are displayed\&. .RE .sp .ne 2 .mk .na \fB\fB-r\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .sp .ne 2 .mk .na \fB\fB-s\fR \fIsort_key\fR\fR .ad .br .sp .6 .RS 4n 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 \fB-o\fR option\&. The \fB-s\fR option can be specified multiple times\&. .RE .sp .ne 2 .mk .na \fB\fB-t\fR \fIaction_name\fR\fR .ad .br .sp .6 .RS 4n Only list the specified actions\&. The \fB-t\fR option can be specified multiple times, or multiple actions can be specified as the argument to one \fB-t\fR option by separating the action names with commas\&. The value of \fIaction_name\fR is one of the actions listed in "Actions" in the \fBpkg\fR(5) man page, such as \fBfile\fR, \fBdirectory\fR, \fBdriver\fR, \fBdepend\fR, \fBset\fR\&. .RE Several special pseudo attribute names are available for convenience: .sp .sp .ne 2 .mk .na \fB\fBaction\&.hash\fR\fR .ad .br .sp .6 .RS 4n The value of the action\'s hash, if the action carries a payload\&. .RE .sp .ne 2 .mk .na \fB\fBaction\&.key\fR\fR .ad .br .sp .6 .RS 4n The value of the action\'s key attribute\&. For example, for a \fBfile\fR action, the key attribute is the path to the file\&. Some actions do not have a key attribute\&. .RE .sp .ne 2 .mk .na \fB\fBaction\&.name\fR\fR .ad .br .sp .6 .RS 4n The name of the action\&. For example, for a file action, this is \fBfile\fR\&. .RE .sp .ne 2 .mk .na \fB\fBaction\&.raw\fR\fR .ad .br .sp .6 .RS 4n All attributes of matching actions\&. .RE .sp .ne 2 .mk .na \fB\fBpkg\&.fmri\fR\fR .ad .br .sp .6 .RS 4n The full FMRI of the package containing the action, such as \fBpkg://solaris/group/feature/amp@0\&.5\&.11,5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1:20120705T153434Z\fR\&. .RE .sp .ne 2 .mk .na \fB\fBpkg\&.name\fR\fR .ad .br .sp .6 .RS 4n The name of the package containing the action, such as \fBweb/amp\fR\&. .RE .sp .ne 2 .mk .na \fB\fBpkg\&.publisher\fR\fR .ad .br .sp .6 .RS 4n The publisher of the package containing the action, such as \fBsolaris\fR\&. .RE .sp .ne 2 .mk .na \fB\fBpkg\&.shortfmri\fR\fR .ad .br .sp .6 .RS 4n The short form FMRI of the package containing the action, such as \fBpkg://solaris/group/feature/amp@0\&.5\&.11,5\&.11-0\&.175\fR .RE The \fBcontents\fR and \fBsearch\fR subcommands are related: Both query the system for the contents of packages\&. The \fBcontents\fR subcommand displays actions in one or more installed or installable packages, filtering the output based on the specified options\&. The \fBsearch\fR subcommand approaches the query from the other direction, displaying the names of all packages that contain a user-supplied token\&. .sp 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\&. .RE .sp .ne 2 .mk .na \fB\fBpkg search\fR [\fB-HIaflpr\fR] [\fB-o\fR \fIattribute\fR[,\fIattribute\fR]\&.\&.\&.]\&.\&.\&. [\fB-s\fR \fIrepo_uri\fR] \fIquery\fR\fR .ad .br .sp .6 .RS 4n Search for actions that match \fIquery\fR, and display the matching search index, action name, action value, and package name\&. See the description of \fIquery\fR below\&. Some searches might yield duplicate results\&. .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the output\&. .RE .sp .ne 2 .mk .na \fB\fB-I\fR\fR .ad .br .sp .6 .RS 4n Use a case-sensitive search\&. .RE .sp .ne 2 .mk .na \fB\fB-a\fR\fR .ad .br .sp .6 .RS 4n Perform the search and display information about the matching actions\&. This is the default\&. .RE .sp .ne 2 .mk .na \fB\fB-f\fR\fR .ad .br .sp .6 .RS 4n Show all results, regardless of package version\&. By default, \fBsearch\fR prunes results from packages older than the currently installed version and from package versions excluded by current incorporations\&. .RE .sp .ne 2 .mk .na \fB\fB-l\fR\fR .ad .br .sp .6 .RS 4n Search the image\'s installed packages\&. .sp Both \fB-l\fR and \fB-r\fR (or \fB-s\fR) can be specified together, in which case both local and remote searches are performed\&. .RE .sp .ne 2 .mk .na \fB\fB-o\fR \fIattribute\fR\fR .ad .br .sp .6 .RS 4n Specify the columns to include in the output\&. The \fB-o\fR option can be specified multiple times, or multiple attributes can be specified as the argument to one \fB-o\fR option by separating the attribute names with commas\&. In addition to the pseudo attributes outlined above, the following attributes are defined for search results\&. These attributes help show why a particular result was a match: .sp .ne 2 .mk .na \fB\fBsearch\&.match\fR\fR .ad .br .sp .6 .RS 4n The string that matched the search query\&. .RE .sp .ne 2 .mk .na \fB\fBsearch\&.match_type\fR\fR .ad .br .sp .6 .RS 4n The attribute that contained the string that matched the search query\&. .RE .RE .sp .ne 2 .mk .na \fB\fB-p\fR\fR .ad .br .sp .6 .RS 4n Display packages that have some actions that match each query term\&. Using this option is equivalent to putting angle brackets (\fB<>\fR) around each term in the query\&. See \fIquery\fR below for more description of the \fB<>\fR operator\&. .RE .sp .ne 2 .mk .na \fB\fB-r\fR\fR .ad .br .sp .6 .RS 4n Search the repositories corresponding to the image\'s publishers\&. This is the default\&. .sp Both \fB-l\fR and \fB-r\fR (or \fB-s\fR) can be specified together, in which case both local and remote searches are performed\&. .RE .sp .ne 2 .mk .na \fB\fB-s\fR \fIrepo_uri\fR\fR .ad .br .sp .6 .RS 4n Search the \fBpkg\fR(5) repository located at the given URI\&. This can be specified multiple times\&. Package archives are not supported\&. .RE .sp .ne 2 .mk .na \fB\fIquery\fR\fR .ad .br .sp .6 .RS 4n By default, \fIquery\fR is interpreted as a series of terms to be matched exactly and multiple terms are ANDed\&. .sp AND and OR are supported\&. .sp The \fB?\fR and \fB*\fR characters can be used as \fBglob\fR(3C)\(hystyle wildcards, allowing more flexible query matches\&. .sp 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 (\fB\'\fR or \fB"\fR)\&. Be sure to take your shell into account so that \fBpkg\fR actually sees the \fB\'\fR or \fB"\fR\&. .sp Which tokens are indexed is action-dependent, but can include content hashes and path names\&. For information about actions and their attributes, see "Actions" in the \fBpkg\fR(5) man page\&. See also the list of pseudo attribute names in \fBpkg contents\fR and \fB-o\fR above\&. .sp Structured queries are supported with the following syntax: .sp .sp .in +2 .nf \fIpkg_name\fR:\fIaction_name\fR:\fIindex\fR:\fItoken\fR .fi .in -2 .sp The value of \fIaction_name\fR is one of the actions listed in "Actions" in the \fBpkg\fR(5) man page\&. The \fIindex\fR is an attribute of the action\&. The value of \fIindex\fR must match \fItoken\fR\&. .sp Not all action attributes are searchable\&. For example, \fBmode\fR is an attribute of the \fBfile\fR action, but \fBmode\fR is not a valid value for \fIindex\fR\&. .sp Some values for \fIindex\fR are not action attributes but are values derived from other attributes\&. For example, \fIindex\fR can be \fBbasename\fR, which is not an attribute of any action but is derived from the \fBpath\fR attribute of the \fBfile\fR or \fBdir\fR action by taking the last component of the path\&. .sp Different action types have different valid values for \fIindex\fR\&. This documentation does not list all possible values\&. Some of the more useful \fIindex\fR values are \fBbasename\fR and \fBpath\fR for file system actions, the dependency type (for example, \fBrequire\fR, \fBoptional\fR, \fBgroup\fR) for \fBdepend\fR actions, and \fBdriver_name\fR and \fBalias\fR for \fBdriver\fR actions\&. .sp One special value for \fIindex\fR is the value of a \fBname\fR attribute for a \fBset\fR action\&. In this case, \fItoken\fR is matched against the value of the \fBvalue\fR attribute that corresponds to the specified \fBname\fR attribute\&. For example, the following search finds packages that are classified as either Development/Databases or System/Databases\&. In the "Examples" section, see the example of finding SMF services\&. .sp .sp .in +2 .nf $ \fBpkg search info\&.classification:databases\fR .fi .in -2 .sp Missing fields in a structured query are implicitly wildcarded\&. A search for \fBbasename:pkg\fR matches all actions in all packages that have an \fIindex\fR of \fBbasename\fR and that match the \fItoken\fR \fBpkg\fR, as shown in the following partial output: .sp .sp .in +2 .nf $ \fBpkg search basename:pkg\fR INDEX ACTION VALUE PACKAGE basename dir usr/share/pkg pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 basename dir var/sadm/pkg pkg:/package/svr4@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 basename dir var/spool/pkg pkg:/package/svr4@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 basename file usr/bin/pkg pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 .fi .in -2 .sp Adding another field narrows the search, as shown in the following complete output: .sp .sp .in +2 .nf $ \fBpkg search file:basename:pkg\fR INDEX ACTION VALUE PACKAGE basename file usr/bin/pkg pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 .fi .in -2 .sp Explicit wildcards are supported in the \fIpkg_name\fR and \fItoken\fR fields\&. The \fIaction_name\fR and \fIindex\fR must match exactly\&. .sp See the "Examples" section for examples of searching for files and dependencies\&. .sp To convert actions to the packages that contain those actions, use \fB<>\fR, as shown in the following partial output: .sp .sp .in +2 .nf $ \fBpkg search \e\fR PACKAGE PUBLISHER pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 solaris pkg:/package/svr4@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 solaris .fi .in -2 .sp With the \fB-a\fR option (and by default), searching for \fBtoken\fR results in information about the actions that match \fBtoken\fR, while searching for \fB\fR results in a list of packages that contain actions that match \fBtoken\fR\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg verify\fR [\fB-Hqv\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Validate the installation of all packages installed in the current image\&. If current signature policy for related publishers is not \fBignore\fR, the signatures of each package are validated based on policy\&. See \fBsignature-policy\fR in "Image Properties" below for an explanation of how signature policies are applied\&. .sp .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Validate the installation of only the specified packages installed in the current image\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the verification output\&. .RE .sp .ne 2 .mk .na \fB\fB-v\fR\fR .ad .br .sp .6 .RS 4n Include informational messages regarding packages\&. See also the description of the \fB-v\fR option for the install command above\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg fix\fR [\fB-Hnvq\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--accept\fR] [\fB--licenses\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Fix any errors reported by \fBpkg verify\fR\&. Verification of installed package content is based on a custom content analysis that might return different results than those of other programs\&. .sp .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Fix errors reported by \fBpkg verify\fR for only the specified packages installed in the current image\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the verification output\&. .RE .sp .ne 2 .mk .na \fB\fB-v\fR\fR .ad .br .sp .6 .RS 4n Include informational messages regarding packages\&. See also the description of the \fB-v\fR option for the install command above\&. .RE .sp .ne 2 .mk .na \fB\fB--accept\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .sp .ne 2 .mk .na \fB\fB--licenses\fR\fR .ad .br .sp .6 .RS 4n Display all of the licenses for the packages that are installed or updated as part of this operation\&. For updated packages, display the license only if the license has changed\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg revert\fR [\fB-nv\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] (\fB--tagged\fR \fItag-name\fR \&.\&.\&. | \fIpath-to-file\fR \&.\&.\&.)\fR .ad .br .sp .6 .RS 4n Revert files delivered by \fBpkg\fR(5) packages to their as-delivered condition\&. File ownership and protections are also restored\&. .sp .LP Caution - .sp .RS 2 .sp .LP Reverting some editable files to their default values can make the system unbootable, or cause other malfunctions\&. .RE .sp .ne 2 .mk .na \fB\fB--tagged\fR \fItag-name\fR\fR .ad .br .sp .6 .RS 4n Revert all files tagged with \fItag-name\fR, and remove any unpackaged files or directories that are under directories with this tag and that match \fIpattern\fR\&. See the description of the \fBrevert-tag\fR attribute in "File Actions" and "Directory Actions" in the \fBpkg\fR(5) man page for more information about \fBtag-name\fR and \fIpattern\fR\&. .RE .sp .ne 2 .mk .na \fB\fIpath-to-file\fR\fR .ad .br .sp .6 .RS 4n Revert the specified files\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg mediator\fR [\fB-aH\fR] [\fB-F\fR \fIformat\fR] [\fImediator\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the current selected version and/or implementation of all mediators\&. .sp .ne 2 .mk .na \fB\fImediator\fR\fR .ad .br .sp .6 .RS 4n Display the current selected version and/or implementation of only the specified mediators\&. .RE .sp .ne 2 .mk .na \fB\fB-F\fR \fIformat\fR\fR .ad .br .sp .6 .RS 4n Specify an alternative output format\&. The value of \fIformat\fR can be \fBtsv\fR (Tab Separated Values), \fBjson\fR (JavaScript Object Notation as a single line), or json-formatted (JavaScript Object Notation, formatted for readability)\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .sp .ne 2 .mk .na \fB\fB-a\fR\fR .ad .br .sp .6 .RS 4n List the mediations that can be set for currently installed packages\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg set-mediator\fR [\fB-nv\fR] [\fB-I\fR \fIimplementation\fR] [\fB-V\fR \fIversion\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] \fImediator\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Set the version and/or implementation for the specified mediators in the current image\&. .sp .sp .ne 2 .mk .na \fB\fB-I\fR \fIimplementation\fR\fR .ad .br .sp .6 .RS 4n 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 (@)\&. .RE .sp .ne 2 .mk .na \fB\fB-V\fR \fIversion\fR\fR .ad .br .sp .6 .RS 4n Set the version of the mediated interface to use\&. .RE If the specified mediator version and/or implementation is not currently available, any links using the specified mediators are removed\&. .sp For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg unset-mediator\fR [\fB-nvIV\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] \fImediator\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Revert the version and/or implementation of the specified mediators to the system default\&. .sp .sp .ne 2 .mk .na \fB\fB-I\fR\fR .ad .br .sp .6 .RS 4n Revert only the implementation of the mediated interface\&. .RE .sp .ne 2 .mk .na \fB\fB-V\fR\fR .ad .br .sp .6 .RS 4n Revert only the version of the mediated interface\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg variant\fR [\fB-Haiv\fR] [\fB-F\fR \fIformat\fR] [\fIvariant_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the current values of all variants set in this image\&. See "Facets and Variants" in the \fBpkg\fR(5) man page for more information about variants\&. .sp .ne 2 .mk .na \fB\fIvariant_pattern\fR\fR .ad .br .sp .6 .RS 4n Display the current values of only the specified variants set in this image\&. .RE .sp .ne 2 .mk .na \fB\fB-F\fR \fIformat\fR\fR .ad .br .sp .6 .RS 4n Specify an alternative output format\&. For a description, see the \fBpkg mediator\fR command\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .sp .ne 2 .mk .na \fB\fB-a\fR\fR .ad .br .sp .6 .RS 4n Display all variants explicitly set in the image and all variants that are listed in installed packages\&. The \fB-a\fR option cannot be combined with the \fB-i\fR option\&. .RE .sp .ne 2 .mk .na \fB\fB-i\fR\fR .ad .br .sp .6 .RS 4n Display all variants that are listed in installed packages\&. The \fB-i\fR option cannot be combined with the \fB-a\fR option\&. .RE .sp .ne 2 .mk .na \fB\fB-v\fR\fR .ad .br .sp .6 .RS 4n Display the possible variant values that can be set for installed packages\&. The \fB-v\fR option can be combined with the \fB-a\fR or \fB-i\fR option\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg change-variant\fR [\fB-nvq\fR] [\fB-C\fR \fIn\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB-r\fR [[\fB-z\fR \fIzonename\fR]\&.\&.\&. | [\fB-Z\fR \fIzonename\fR]\&.\&.\&. ]] [\fB--accept\fR] [\fB--licenses\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--sync-actuators\fR | \fB--sync-actuators-timeout\fR \fItimeout\fR] \fIvariant_name\fR=\fIvalue\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Change the values of the specified variants set in the current image\&. .sp 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 \fBpkg\fR(5) man page for more information about variants\&. .sp For descriptions of options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg facet\fR [\fB-Haim\fR] [\fB-F\fR \fIformat\fR] [\fIfacet_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the current values and source of all facets that either have been set locally in this image by using the \fBpkg change-facet\fR command or have been inherited from a parent image (such as a non-global zone inheriting the facet setting from the global zone)\&. See "Facets and Variants" in the \fBpkg\fR(5) man page for more information about facets\&. .sp .ne 2 .mk .na \fB\fIfacet_pattern\fR\fR .ad .br .sp .6 .RS 4n Display the current values of only the specified facets set in this image\&. .RE .sp .ne 2 .mk .na \fB\fB-F\fR \fIformat\fR\fR .ad .br .sp .6 .RS 4n Specify an alternative output format\&. For a description, see the \fBpkg mediator\fR command\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .sp .ne 2 .mk .na \fB\fB-a\fR\fR .ad .br .sp .6 .RS 4n Display all facets explicitly set in the image and all facets that are listed in installed packages\&. The \fB-a\fR option cannot be combined with the \fB-i\fR option\&. .RE .sp .ne 2 .mk .na \fB\fB-i\fR\fR .ad .br .sp .6 .RS 4n Display all facets that are listed in installed packages\&. The \fB-i\fR option cannot be combined with the \fB-a\fR option\&. .RE .sp .ne 2 .mk .na \fB\fB-m\fR\fR .ad .br .sp .6 .RS 4n Include masked facets in the output\&. Display a column that indicates which, if any, facets are masked\&. Masked facets are facets set locally in an image (by using the \fBpkg change-facet\fR command) that are hidden by an inherited facet with the same name\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg change-facet\fR [\fB-nvq\fR] [\fB-C\fR \fIn\fR] [\fB-g\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB-r\fR [[\fB-z\fR \fIzonename\fR]\&.\&.\&. | [\fB-Z\fR \fIzonename\fR]\&.\&.\&. ]] [\fB--accept\fR] [\fB--licenses\fR] [\fB--no-be-activate\fR] [\fB--no-backup-be\fR | \fB--require-backup-be\fR] [\fB--backup-be-name\fR \fIname\fR] [\fB--deny-new-be\fR | \fB--require-new-be\fR] [\fB--be-name\fR \fIname\fR] [\fB--sync-actuators\fR | \fB--sync-actuators-timeout\fR \fItimeout\fR] \fIfacet_name\fR=(\fBTrue\fR|\fBFalse\fR|\fBNone\fR) \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Change the values of the specified facets set in the current image\&. The changes also appear in any images that inherit these facets, such as non-global zones\&. .sp Facets can be set to \fBTrue\fR or \fBFalse\fR\&. Setting a facet to \fBNone\fR applies the default value of \fBTrue\fR to that facet; thus, any actions subject to the facet will be installed\&. See "Actions" in the \fBpkg\fR(5) man page for information about actions\&. .sp 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 \fBpkg\fR(5) man page for more information about facets\&. .sp For descriptions of options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg avoid\fR [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display each avoided package along with any packages that have a group dependency on that package\&. .sp 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\&. .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Avoid 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\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg unavoid\fR [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the list of avoided packages\&. .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg freeze\fR [\fB-n\fR] [\fB-c\fR \fIreason\fR] [\fIpkg_fmri_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display information about currently frozen packages: package names, versions, when the package was frozen, and any associated reasons for freezing the packages\&. .sp Freezing a package does not prevent removal of the package\&. No warning is displayed if the package is removed\&. .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Freeze the specified packages to the specified versions\&. If no version is given, the package must be installed and is frozen at that installed version\&. Freezing a package that is already frozen replaces the freeze version with the newly specified version\&. .sp 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 \fIpkg_fmri_pattern\fR 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\&. .RE .sp .ne 2 .mk .na \fB\fB-c\fR \fIreason\fR\fR .ad .br .sp .6 .RS 4n Record the \fIreason\fR with the packages that are frozen\&. The reason is shown if a freeze prevents an installation or update from succeeding\&. .RE .sp .ne 2 .mk .na \fB\fB-n\fR\fR .ad .br .sp .6 .RS 4n Perform a trial run of the freeze operation, displaying the list of packages that would be frozen without freezing any packages\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg unfreeze\fR [\fB-n\fR] [\fIpkg_name_pattern\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display information about currently frozen packages: package names, versions, when the package was frozen, and any associated reasons for freezing the packages\&. .sp .ne 2 .mk .na \fB\fIpkg_fmri_pattern\fR\fR .ad .br .sp .6 .RS 4n Remove the constraints that freezing imposes from the specified packages\&. Any versions provided are ignored\&. .RE .sp .ne 2 .mk .na \fB\fB-n\fR\fR .ad .br .sp .6 .RS 4n Perform a trial run of the unfreeze operation, displaying the list of packages that would be unfrozen without unfreezing any packages\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg property\fR [\fB-H\fR] [\fIpropname\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the names and values of all image properties\&. See "Image Properties" below for descriptions of image properties\&. .sp .ne 2 .mk .na \fB\fIpropname\fR\fR .ad .br .sp .6 .RS 4n Display the names and values for only the specified properties\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg set-property\fR \fIpropname\fR \fIpropvalue\fR\fR .ad .br .sp .6 .RS 4n Update an existing image property or add a new image property\&. .RE .sp .ne 2 .mk .na \fB\fBpkg add-property-value\fR \fIpropname\fR \fIpropvalue\fR\fR .ad .br .sp .6 .RS 4n Add a value to an existing image property or add a new image property\&. .RE .sp .ne 2 .mk .na \fB\fBpkg remove-property-value\fR \fIpropname\fR \fIpropvalue\fR\fR .ad .br .sp .6 .RS 4n Remove a value from an existing image property\&. .RE .sp .ne 2 .mk .na \fB\fBpkg unset-property\fR \fIpropname\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Remove an existing image property or properties\&. .RE .sp .ne 2 .mk .na \fB\fBpkg publisher\fR [\fB-HPn\fR] [\fB-F\fR \fIformat\fR] [\fIpublisher\fR \&.\&.\&.]\fR .ad .br .sp .6 .RS 4n Display the list of all publishers in order of search preference\&. The following information is displayed for each publisher: name, attributes such as non-sticky and disabled, type (origin or mirror), online status, proxy, and location URI\&. Proxy information is shown only as T (true) or F (false) under the column labeled P\&. To show the proxy value for a publisher with T in the P column, use the \fB-F tsv\fR option or specify the publisher name argument\&. Proxies shown by the \fBpkg publisher\fR command were set by using the \fB--proxy\fR option of the \fBpkg set-publisher\fR command\&. Proxies set by using an \fBhttp_proxy\fR environment variable are not shown by the \fBpkg publisher\fR command\&. .sp .ne 2 .mk .na \fB\fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Display detailed configuration for only the specified publishers\&. Additional information displayed includes the proxy URI, key, and certificate for each origin or mirror URI, the client UUID, and the time the catalog was last updated\&. .RE .sp .ne 2 .mk .na \fB\fB-F\fR \fIformat\fR\fR .ad .br .sp .6 .RS 4n Specify an alternative output format\&. For a description, see the \fBpkg mediator\fR command\&. .RE .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .sp .ne 2 .mk .na \fB\fB-P\fR\fR .ad .br .sp .6 .RS 4n Display only the first publisher in the publisher search order\&. .RE .sp .ne 2 .mk .na \fB\fB-n\fR\fR .ad .br .sp .6 .RS 4n Display only enabled publishers\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg set-publisher\fR [-Ped] [\fB-c\fR \fIssl_cert\fR] [\fB-k\fR \fIssl_key\fR] [\fB-g\fR \fIorigin_to_add\fR | \fB--add-origin\fR \fIorigin_to_add\fR]\&.\&.\&. [\fB-G\fR \fIorigin_to_remove\fR | \fB--remove-origin\fR \fIorigin_to_remove\fR]\&.\&.\&. [\fB-m\fR \fImirror_to_add\fR | \fB--add-mirror\fR \fImirror_to_add\fR]\&.\&.\&. [\fB-M\fR \fImirror_to_remove\fR | \fB--remove-mirror\fR \fImirror_to_remove\fR]\&.\&.\&. [\fB--disable\fR] [\fB--enable\fR] [\fB--no-refresh\fR] [\fB--reset-uuid\fR] [\fB--non-sticky\fR] [\fB--sticky\fR] [\fB--search-after\fR \fIpublisher\fR] [\fB--search-before\fR \fIpublisher\fR] [\fB--search-first\fR] [\fB--approve-ca-cert\fR \fIpath_to_CA\fR] [\fB--revoke-ca-cert\fR \fIhash_of_CA_to_remove\fR] [\fB--unset-ca-cert\fR \fIhash_of_CA_to_remove\fR] [\fB--set-property\fR \fIname_of_property\fR=\fIvalue\fR] [\fB--add-property-value\fR \fIname_of_property\fR=\fIvalue_to_add\fR] [\fB--remove-property-value\fR \fIname_of_property\fR=\fIvalue_to_remove\fR] [\fB--unset-property\fR \fIname_of_property_to_delete\fR] [\fB--proxy\fR \fIproxy_to_use\fR] \fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Update an existing publisher or add a publisher\&. If no options affecting search order are specified, new publishers are appended to the search order and are thus searched last\&. .sp .ne 2 .mk .na \fB\fB-G\fR \fIorigin_to_remove\fR\fR .ad .br .na \fB\fB--remove-origin\fR \fIorigin_to_remove\fR\fR .ad .br .sp .6 .RS 4n Remove the URI or path from the list of origins for the given publisher\&. The special value \fB*\fR can be used to remove all origins\&. .RE .sp .ne 2 .mk .na \fB\fB-M\fR \fImirror_to_remove\fR\fR .ad .br .na \fB\fB--remove-mirror\fR \fImirror_to_remove\fR\fR .ad .br .sp .6 .RS 4n Remove the URI from the list of mirrors for the given publisher\&. The special value \fB*\fR can be used to remove all mirrors\&. .RE .sp .ne 2 .mk .na \fB\fB-P\fR\fR .ad .br .na \fB\fB--search-first\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .sp .ne 2 .mk .na \fB\fB-c\fR \fIssl_cert\fR\fR .ad .br .sp .6 .RS 4n Specify the client SSL certificate\&. .RE .sp .ne 2 .mk .na \fB\fB-d\fR\fR .ad .br .na \fB\fB--disable\fR\fR .ad .br .sp .6 .RS 4n 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\&. .RE .sp .ne 2 .mk .na \fB\fB-e\fR\fR .ad .br .na \fB\fB--enable\fR\fR .ad .br .sp .6 .RS 4n Enable the publisher\&. .RE .sp .ne 2 .mk .na \fB\fB-g\fR \fIorigin_to_add\fR\fR .ad .br .na \fB\fB--add-origin\fR \fIorigin_to_add\fR\fR .ad .br .sp .6 .RS 4n Add the specified URI or path as an origin for the given publisher\&. This should be the location of a package repository or archive\&. .RE .sp .ne 2 .mk .na \fB\fB-k\fR \fIssl_key\fR\fR .ad .br .sp .6 .RS 4n Specify the client SSL key\&. .RE .sp .ne 2 .mk .na \fB\fB-m\fR \fImirror_to_add\fR\fR .ad .br .na \fB\fB--add-mirror\fR \fImirror_to_add\fR\fR .ad .br .sp .6 .RS 4n Add the URI as a mirror for the given publisher\&. .RE .sp .ne 2 .mk .na \fB\fB--add-property-value\fR \fIname_of_property\fR=\fIvalue_to_add\fR\fR .ad .br .sp .6 .RS 4n Add a value to an existing publisher property or add a new publisher property\&. .RE .sp .ne 2 .mk .na \fB\fB--approve-ca-cert\fR \fIpath_to_CA\fR\fR .ad .br .sp .6 .RS 4n For verifying signed packages, add the specified 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 \fBpkg publisher\fR command\&. .RE .sp .ne 2 .mk .na \fB\fB--no-refresh\fR\fR .ad .br .sp .6 .RS 4n Do not attempt to contact the repositories for the image\'s publishers to retrieve the newest list of available packages and other metadata\&. .RE .sp .ne 2 .mk .na \fB\fB--non-sticky\fR\fR .ad .br .sp .6 .RS 4n Higher ranked publishers than this one can provide updates to packages originally installed from this publisher\&. .RE .sp .ne 2 .mk .na \fB\fB--proxy\fR \fIproxy_to_use\fR\fR .ad .br .sp .6 .RS 4n Use the specified proxy URI to retrieve content for the specified origin (\fB-g\fR) or mirror (\fB-m\fR)\&. The proxy value is stored as part of the publisher configuration, which means the system repository used by child images is automatically updated\&. This option cannot be used to set an authenticated proxy\&. The \fIproxy_to_use\fR value cannot have the form \fBprotocol://user:password@host\fR\&. .sp At run time, \fBhttp_proxy\fR or related environment variables override this proxy setting\&. See the "Environment" section of the \fBcurl\fR(1) man page for the list of accepted environment variable names\&. If you use an environment variable to set the proxy URI, you must also set the appropriate proxy property of the \fBsvc:/application/pkg/system-repository\fR SMF service to the same value\&. See "Specifying a Proxy" in \fIAdding and Updating Software in Oracle Solaris 11\&.3\fR\&. .RE .sp .ne 2 .mk .na \fB\fB--remove-property-value\fR \fIname_of_property\fR=\fIvalue_to_remove\fR\fR .ad .br .sp .6 .RS 4n Remove a value from an existing publisher property\&. .RE .sp .ne 2 .mk .na \fB\fB--reset-uuid\fR\fR .ad .br .sp .6 .RS 4n Choose a new unique identifier that identifies this image to its publisher\&. .RE .sp .ne 2 .mk .na \fB\fB--revoke-ca-cert\fR \fIhash_of_CA_to_remove\fR\fR .ad .br .sp .6 .RS 4n For verifying signed packages, 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 \fBpkg publisher\fR command\&. .RE .sp .ne 2 .mk .na \fB\fB--search-after\fR \fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Alter the publisher search order so that the publisher being added or modified is searched after the publisher specified in this option\&. .RE .sp .ne 2 .mk .na \fB\fB--search-before\fR \fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Alter the publisher search order so that the publisher being added or modified is searched before the publisher specified in this option\&. .RE .sp .ne 2 .mk .na \fB\fB--set-property\fR \fIname_of_property\fR=\fIvalue\fR\fR .ad .br .sp .6 .RS 4n Update an existing publisher property or add a new publisher property\&. .RE .sp .ne 2 .mk .na \fB\fB--sticky\fR\fR .ad .br .sp .6 .RS 4n Updates to packages that were installed from this publisher must also come from this publisher\&. This is the default behavior\&. .RE .sp .ne 2 .mk .na \fB\fB--unset-ca-cert\fR \fIhash_of_CA_to_remove\fR\fR .ad .br .sp .6 .RS 4n For verifying signed packages, remove the certificate with the given hash from the list of approved certificates and the list of revoked certificates\&. .RE .sp .ne 2 .mk .na \fB\fB--unset-property\fR \fIname_of_property_to_delete\fR\fR .ad .br .sp .6 .RS 4n Remove an existing publisher property\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg set-publisher\fR \fB-p\fR \fIrepo_uri\fR [-Ped] [\fB-c\fR \fIssl_cert\fR] [\fB-k\fR \fIssl_key\fR] [\fB--non-sticky\fR] [\fB--sticky\fR] [\fB--search-after\fR \fIpublisher\fR] [\fB--search-before\fR \fIpublisher\fR] [\fB--search-first\fR] [\fB--approve-ca-cert\fR \fIpath_to_CA\fR] [\fB--revoke-ca-cert\fR \fIhash_of_CA_to_remove\fR] [\fB--unset-ca-cert\fR \fIhash_of_CA_to_remove\fR] [\fB--set-property\fR \fIname_of_property\fR=\fIvalue\fR] [\fB--add-property-value\fR \fIname_of_property\fR=\fIvalue_to_add\fR] [\fB--remove-property-value\fR \fIname_of_property\fR=\fIvalue_to_remove\fR] [\fB--unset-property\fR \fIname_of_property_to_delete\fR] [\fB--proxy\fR \fIproxy_to_use\fR] [\fIpublisher\fR]\fR .ad .br .sp .6 .RS 4n Retrieve publisher configuration information from the \fIrepo_uri\fR repository URI\&. .sp If a publisher operand is specified to this \fBset-publisher\fR subcommand, then only that publisher is added or updated\&. If no publisher is specified, all publishers in \fIrepo_uri\fR are added or updated as appropriate\&. .sp For descriptions of options, see the \fBset-publisher\fR command above\&. When used with \fB-p\fR, the \fB-P\fR, \fB--search-first\fR, \fB--search-before\fR, and \fB--search-after\fR options only apply to added publishers, not to updated publishers\&. .sp The \fB-p\fR option cannot be combined with the \fB-g\fR, \fB--add-origin\fR, \fB-G\fR, \fB--remove-origin\fR, \fB-m\fR, \fB--add-mirror\fR, \fB-M\fR, \fB--remove-mirror\fR, \fB--disable\fR, \fB--enable\fR, \fB--no-refresh\fR, or \fB--reset-uuid\fR options\&. .RE .sp .ne 2 .mk .na \fB\fBpkg unset-publisher\fR \fIpublisher\fR \&.\&.\&.\fR .ad .br .sp .6 .RS 4n Remove the configuration associated with the specified publisher or publishers\&. .RE .sp .ne 2 .mk .na \fB\fBpkg history\fR [\fB-HNl\fR] [\fB-n\fR \fInumber\fR] [\fB-o\fR \fIcolumn\fR[,\fIcolumn\fR]\&.\&.\&.]\&.\&.\&. [\fB-t\fR \fItime\fR | \fItime\fR-\fItime\fR[,\fItime\fR | \fItime\fR-\fItime\fR]\&.\&.\&.]\&.\&.\&.\fR .ad .br .sp .6 .RS 4n Display the command history of the applicable image\&. Display the start time of the operation, the name of the operation (for example, \fBinstall\fR), the client (for example, \fBpkg\fR), and the outcome of the operation (Succeeded or Failed)\&. .sp .ne 2 .mk .na \fB\fB-H\fR\fR .ad .br .sp .6 .RS 4n Omit the headers from the listing\&. .RE .sp .ne 2 .mk .na \fB\fB-l\fR\fR .ad .br .sp .6 .RS 4n Display the long form of the command history of the image\&. Additional information displayed includes the version of the client, the name of the user who performed the operation, whether a new boot environment was created, the time the operation completed and total time taken, the complete command that was issued, and any errors that were encountered while executing the command\&. For operations such as \fBupdate\fR, complete FMRIs of changed packages are shown\&. .RE .sp .ne 2 .mk .na \fB\fB-N\fR\fR .ad .br .sp .6 .RS 4n Display the release note text\&. .RE .sp .ne 2 .mk .na \fB\fB-n\fR \fInumber\fR\fR .ad .br .sp .6 .RS 4n Display only the specified number of most recent entries\&. .RE .sp .ne 2 .mk .na \fB\fB-o\fR \fIcolumn\fR\fR .ad .br .sp .6 .RS 4n Display output using the specified column names\&. The \fB-o\fR option can be specified multiple times, or multiple column names can be specified as the argument to one \fB-o\fR option by separating the column names with commas\&. Valid column names are: .sp .sp .ne 2 .mk .na \fB\fBbe\fR\fR .ad .br .sp .6 .RS 4n The name of the boot environment this operation was started on\&. .RE .sp .ne 2 .mk .na \fB\fBbe_uuid\fR\fR .ad .br .sp .6 .RS 4n The \fBuuid\fR of the boot environment this operation was started on\&. .RE .sp .ne 2 .mk .na \fB\fBclient\fR\fR .ad .br .sp .6 .RS 4n The name of the client\&. .RE .sp .ne 2 .mk .na \fB\fBclient_ver\fR\fR .ad .br .sp .6 .RS 4n The version of the client\&. .RE .sp .ne 2 .mk .na \fB\fBcommand\fR\fR .ad .br .sp .6 .RS 4n The command line used for this operation\&. .RE .sp .ne 2 .mk .na \fB\fBfinish\fR\fR .ad .br .sp .6 .RS 4n The time that this operation finished\&. .RE .sp .ne 2 .mk .na \fB\fBid\fR\fR .ad .br .sp .6 .RS 4n The user id that started this operation\&. .RE .sp .ne 2 .mk .na \fB\fBnew_be\fR\fR .ad .br .sp .6 .RS 4n The new boot environment created by this operation\&. .RE .sp .ne 2 .mk .na \fB\fBnew_be_uuid\fR\fR .ad .br .sp .6 .RS 4n The \fBuuid\fR of the new boot environment created by this operation\&. .RE .sp .ne 2 .mk .na \fB\fBoperation\fR\fR .ad .br .sp .6 .RS 4n The name of the operation\&. .RE .sp .ne 2 .mk .na \fB\fBoutcome\fR\fR .ad .br .sp .6 .RS 4n A summary of the outcome of this operation\&. .RE .sp .ne 2 .mk .na \fB\fBreason\fR\fR .ad .br .sp .6 .RS 4n Additional information on the outcome of this operation\&. .RE .sp .ne 2 .mk .na \fB\fBrelease_note\fR\fR .ad .br .sp .6 .RS 4n Indicates whether this operation generated release notes\&. .RE .sp .ne 2 .mk .na \fB\fBsnapshot\fR\fR .ad .br .sp .6 .RS 4n The snapshot taken during this operation\&. This is only recorded if the snapshot was not automatically removed after successful operation completion\&. .RE .sp .ne 2 .mk .na \fB\fBstart\fR\fR .ad .br .sp .6 .RS 4n The time that this operation started\&. .RE .sp .ne 2 .mk .na \fB\fBtime\fR\fR .ad .br .sp .6 .RS 4n The total time taken to perform this operation\&. For operations that take less than one second, 0:00:00 is shown\&. .RE .sp .ne 2 .mk .na \fB\fBuser\fR\fR .ad .br .sp .6 .RS 4n The username that started this operation\&. .RE If the \fBcommand\fR or \fBreason\fR columns are specified, they must be the last item in the \fB-o\fR list, in order to preserve output field separation\&. These two columns cannot be shown in the same \fBhistory\fR command\&. .sp An asterisk (*) is shown after the values for \fBbe\fR or \fBnew_be\fR if the boot environment is no longer present on the system\&. .sp The values for \fBbe\fR and \fBnew_be\fR are obtained by looking up the current boot environment name, using the \fBbe_uuid\fR or \fBnew_be_uuid\fR fields\&. If a boot environment was subsequently renamed, and later deleted, the values displayed for \fBbe\fR and \fBnew_be\fR are the values recorded at the time of the \fBpkg\fR operation\&. .RE .sp .ne 2 .mk .na \fB\fB-t\fR \fItime\fR\fR .ad .br .na \fB\fB-t\fR \fItime\fR-\fItime\fR\fR .ad .br .sp .6 .RS 4n Display log records for a comma-separated list of timestamps, formatted with \fB%Y-%m-%dT%H:%M:%S\fR (see the \fBstrftime\fR(3C) man page)\&. To specify a range of times, use a hyphen (\fB-\fR) between a start and finish timestamp\&. The keyword \fBnow\fR can be used as an alias for the current time\&. This option can be specified multiple times\&. If the timestamps specified contain duplicate timestamps or overlapping ranges, duplicate history events are not displayed\&. Only a single instance of each history event is displayed\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg purge-history\fR\fR .ad .br .sp .6 .RS 4n Delete all existing history information\&. .RE .sp .ne 2 .mk .na \fB\fBpkg rebuild-index\fR\fR .ad .br .sp .6 .RS 4n Rebuild the index used by \fBpkg search\fR\&. This is a recovery operation not intended for general use\&. .RE .sp .ne 2 .mk .na \fB\fBpkg update-format\fR\fR .ad .br .sp .6 .RS 4n Update 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 \fBpkg\fR(5) system\&. .RE .sp .ne 2 .mk .na \fB\fBpkg version\fR\fR .ad .br .sp .6 .RS 4n Display a unique string identifying the version of \fBpkg\fR\&. This string is not guaranteed to be comparable in any fashion between versions\&. .RE .sp .ne 2 .mk .na \fB\fBpkg help\fR [\fB-v\fR]\fR .ad .br .sp .6 .RS 4n Display a full list of subcommands\&. .RE .sp .6 .RS 4n .sp .ne 2 .mk .na \fB\fB-v\fR\fR .ad .RS n .rt Display a verbose usage message of subcommands\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg image-create\fR [\fB-FPUfz\fR] [\fB--force\fR] [\fB--full\fR | \fB--partial\fR | \fB--user\fR] [\fB--zone\fR] [\fB-c\fR \fIssl_cert\fR] [\fB-k\fR \fI ssl_key\fR] [\fB-g\fR \fIpath_or_uri\fR | \fB--origin\fR \fIpath_or_uri\fR]\&.\&.\&. [\fB-m\fR \fIuri\fR | \fB--mirror\fR \fIuri\fR]\&.\&.\&. [\fB--facet\fR \fIfacet_name\fR=(\fBTrue\fR|\fBFalse\fR)]\&.\&.\&. [\fB--no-refresh\fR] [\fB--set-property\fR \fIname_of_property\fR=\fIvalue\fR] [\fB--variant\fR \fIvariant_name\fR=\fIvalue\fR]\&.\&.\&. [(\fB-p\fR | \fB--publisher\fR) [\fIname\fR=]\fIrepo_uri\fR] \fIdir\fR\fR .ad .br .sp .6 .RS 4n At the location given by \fIdir\fR, create an image suitable for package operations\&. Images created by using the \fBimage-create\fR subcommand are not bootable\&. Most users should use the \fB--be-name\fR or \fB--require-new-be\fR options with \fBpkg\fR commands, or use the \fBbeadm\fR or \fBzoneadm\fR commands to create images\&. The \fBpkg image-create\fR command is used for tasks such as maintaining packages and operating system distributions\&. .sp The default image type is user, which can be specified by using the \fB-U\fR or \fB--user\fR option\&. Alternatively, the image type can be set to a full image (\fB--F\fR or \fB--full\fR) or to a partial image (\fB-P\fR or \fB--partial\fR) linked to the full image enclosing the given \fIdir\fR path\&. .sp Additional origins can be specified using \fB-g\fR or \fB--origin\fR\&. Additional mirrors can be specified using \fB-m\fR or \fB--mirror\fR\&. .sp A package repository URI must be provided using the \fB-p\fR or \fB--publisher\fR 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\&. .sp For publishers using client SSL authentication, a client key and client certificate can be registered via the \fB-c\fR and \fB-k\fR options\&. This key and certificate are used for all publishers added during image creation\&. .sp If the image is to be run within non-global zone context, use the \fB-z\fR (\fB--zone\fR) option to set an appropriate variant\&. .sp .ne 2 .mk .na \fB\fB-f\fR\fR .ad .br .na \fB\fB--force\fR\fR .ad .br .sp .6 .RS 4n Force the creation of an image over an existing image\&. This option should be used with care\&. .RE .sp .ne 2 .mk .na \fB\fB--facet\fR \fIfacet_name\fR=(\fBTrue\fR|\fBFalse\fR)\fR .ad .br .sp .6 .RS 4n Set the specified facet to the indicated value\&. See "Facets and Variants" in the \fBpkg\fR(5) man page for more information about facets\&. .RE .sp .ne 2 .mk .na \fB\fB--no-refresh\fR\fR .ad .br .sp .6 .RS 4n Do not attempt to contact the repositories for the image\'s publishers to retrieve the newest list of available packages and other metadata\&. .RE .sp .ne 2 .mk .na \fB\fB--set-property\fR \fIname_of_property\fR=\fIvalue\fR\fR .ad .br .sp .6 .RS 4n Set the specified image property to the indicated value\&. See "Image Properties" below for descriptions of image properties\&. .RE .sp .ne 2 .mk .na \fB\fB--variant\fR \fIvariant_name\fR=\fIvalue\fR\fR .ad .br .sp .6 .RS 4n Set the specified variant to the indicated value\&. See "Facets and Variants" in the \fBpkg\fR(5) man page for more information about variants\&. .RE .RE .sp .ne 2 .mk .na \fB\fBpkg \fB-R\fR \fIdir\fR dehydrate\fR [\fB-nvq\fR] [\fB-p\fR \fIpublisher\fR]\&.\&.\&.\fR .ad .br .sp .6 .RS 4n Remove all non-editable packaged files and packaged hardlinks from the image specified by the \fB-R\fR option to create a fully dehydrated image\&. Packaged files and packaged hardlinks are files and hardlinks that are delivered by the currently installed version of a package\&. A non-editable file cannot have any \fBpreserve\fR or \fBoverlay\fR attribute and cannot have a \fBdehydrate\fR attribute with a value of \fBfalse\fR\&. .sp The \fBpkg dehydrate\fR command only operates on an alternate root\&. Use the \fB-R\fR option to specify the alternate root\&. If the alternate root belongs to a boot environment, dehydration will render it unbootable\&. .sp If the \fBpkg dehydrate\fR command succeeds, a property named \fBdehydrated\fR is set on the \fIdir\fR image specified by the \fB-R\fR option\&. The value of the \fBdehydrated\fR property is a list of all publishers set in the \fIdir\fR image that have a configured package repository\&. .sp Package installation operations on packages from a dehydrated publisher are automatically dehydrated\&. If you install a package in a dehydrated image, the package content is installed and then dehydrated\&. Package installation operations can include operations such as \fBupdate\fR and \fBchange-facet\fR as well as \fBinstall\fR\&. .sp .sp .ne 2 .mk .na \fB\fB-p\fR \fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Remove only non-editable files and hardlinks delivered by the specified publishers to create a partially dehydrated image\&. If all configured publishers of the image are specified, a fully dehydrated image is created as described above\&. .sp If one or more publishers is specified, and if any of the publishers is not configured in the image, then nothing is removed from the image\&. .sp If the \fBpkg dehydrate\fR command succeeds, a property named \fBdehydrated\fR is set on the \fIdir\fR image specified by the \fB-R\fR option\&. The value of the \fBdehydrated\fR property is a list of all publishers specified by \fB-p\fR options\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .sp .ne 2 .mk .na \fB\fBpkg \fB-R\fR \fIdir\fR rehydrate\fR [\fB-nvq\fR] [\fB-p\fR \fIpublisher\fR]\&.\&.\&.\fR .ad .br .sp .6 .RS 4n Reinstall all files and hardlinks removed by the \fBpkg dehydrate\fR command\&. .sp The \fBpkg rehydrate\fR command only operates on an alternate root\&. Use the \fB-R\fR option to specify the alternate root\&. .sp If the \fBpkg rehydrate\fR command succeeds, the value of the \fBdehydrated\fR property of the image is empty\&. .sp .sp .ne 2 .mk .na \fB\fB-p\fR \fIpublisher\fR\fR .ad .br .sp .6 .RS 4n Reinstall all files and hardlinks removed by the \fBpkg dehydrate\fR command for the specified publishers\&. .sp If one or more publishers is specified, and if any of the publishers is not configured in the image, then nothing is installed\&. .sp If the \fBpkg rehydrate\fR command succeeds, the specified publisher names are removed from the value of the \fBdehydrated\fR property set on the image\&. Publishers not specified in the \fBrehydrate\fR command remain listed in the \fBdehydrated\fR property, and content installed from those publishers will still be dehydrated\&. .RE For all other options, see the \fBinstall\fR command above\&. .RE .SH IMAGE PROPERTIES .sp .LP 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 \fBpkg property\fR command\&. To modify the values of these properties, use the \fBpkg set-property\fR and \fBpkg unset-property\fR commands\&. .sp .ne 2 .mk .na \fB\fBbe-policy\fR\fR .ad .br .sp .6 .RS 4n (string) Specify when a boot environment is created during packaging operations\&. The following values are allowed: .sp .ne 2 .mk .na \fB\fBdefault\fR\fR .ad .br .sp .6 .RS 4n Apply the default boot environment creation policy, \fBcreate-backup\fR\&. .RE .sp .ne 2 .mk .na \fB\fBalways-new\fR\fR .ad .br .sp .6 .RS 4n Requires a reboot for all package operations by performing them in a new boot environment set as active on the next boot\&. A backup boot environment is not created unless explicitly requested\&. .sp This policy is the safest, but is more strict than most sites need since no packages can be added without a reboot\&. .RE .RE .sp .ne 2 .mk .na \fB\fBcreate-backup\fR\fR .ad .br .sp .6 .RS 4n For package operations that require a reboot, a new boot environment 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 boot environment, a backup boot environment is created but not set as active\&. A backup boot environment can also be explicitly requested\&. .sp This policy is potentially risky only if newly installed software causes system instability, which is possible but relatively rare\&. .RE .sp .ne 2 .mk .na \fB\fBwhen-required\fR\fR .ad .br .sp .6 .RS 4n For package operations that require a reboot, a new boot environment is created and set as active on the next boot\&. A backup boot environment is not created unless explicitly requested\&. .sp This policy carries the greatest risk since if a packaging change to the live boot environment makes further changes impossible, there might be no recent boot environment to which one can fallback\&. .RE .sp .ne 2 .mk .na \fB\fBca-path\fR\fR .ad .br .sp .6 .RS 4n (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 \fBCApath\fR portions of \fBSSL_CTX_load_verify_locations\fR(3openssl) for requirements for the CA directory\&. .sp Default value: \fB/etc/openssl/certs\fR .RE .sp .ne 2 .mk .na \fB\fBcheck-certificate-revocation\fR\fR .ad .br .sp .6 .RS 4n (boolean) If this is set to \fBTrue\fR, 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\&. .sp Default value: \fBFalse\fR .RE .sp .ne 2 .mk .na \fB\fBcontent-update-policy\fR\fR .ad .br .sp .6 .RS 4n (string) Specify when the package system will update non-editable files during packaging operations\&. The following values are allowed: .sp .sp .ne 2 .mk .na \fB\fBdefault\fR\fR .ad .br .sp .6 .RS 4n Always apply the default content update policy\&. .RE .sp .ne 2 .mk .na \fB\fBalways\fR\fR .ad .br .sp .6 .RS 4n Always download and update non-editable files that have changed\&. .RE .sp .ne 2 .mk .na \fB\fBwhen-required\fR\fR .ad .br .sp .6 .RS 4n Download and update non-editable files that have changed only if the package system has determined that an update is required\&. .RE Default value: \fBalways\fR .RE .sp .ne 2 .mk .na \fB\fBflush-content-cache-on-success\fR\fR .ad .br .sp .6 .RS 4n (boolean) If this is set to \fBTrue\fR, the package client removes the files in its content-cache when image-modifying operations complete successfully\&. For operations that create a boot environment, the content will be removed from both the source and destination boot environment\&. .sp 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\&. .sp Default value: \fBTrue\fR .RE .sp .ne 2 .mk .na \fB\fBmirror-discovery\fR\fR .ad .br .sp .6 .RS 4n (boolean) This property tells the client to discover link-local content mirrors using mDNS and DNS-SD\&. If this property is set to \fBTrue\fR, the client attempts to download package content from mirrors it dynamically discovers\&. To run a mirror that advertises its content via mDNS, see the \fBpkg\&.depotd\fR(1M) man page\&. .sp Default value: \fBFalse\fR .RE .sp .ne 2 .mk .na \fB\fBsend-uuid\fR\fR .ad .br .sp .6 .RS 4n (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\&. .sp Default value: \fBTrue\fR .RE .sp .ne 2 .mk .na \fB\fBsignature-policy\fR\fR .ad .br .sp .6 .RS 4n (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 Internet sites, set the \fBcheck-certificate-revocation\fR image property to \fBTrue\fR\&. The following values are allowed: .sp .ne 2 .mk .na \fB\fBignore\fR\fR .ad .br .sp .6 .RS 4n Ignore signatures for all manifests\&. .RE .sp .ne 2 .mk .na \fB\fBverify\fR\fR .ad .br .sp .6 .RS 4n Verify that all manifests with signatures are validly signed, but do not require all installed packages to be signed\&. This is the default value\&. .RE .sp .ne 2 .mk .na \fB\fBrequire-signatures\fR\fR .ad .br .sp .6 .RS 4n Require that all newly installed packages have at least one valid signature\&. The \fBpkg fix\fR and \fBpkg verify\fR commands also warn if an installed package does not have a valid signature\&. .RE .sp .ne 2 .mk .na \fB\fBrequire-names\fR\fR .ad .br .sp .6 .RS 4n Follow the same requirements as \fBrequire-signatures\fR but also require that the strings listed in the \fBsignature-required-names\fR property appear as a common name of the certificates used to verify the chains of trust of the signatures\&. .RE .RE .sp .ne 2 .mk .na \fB\fBsignature-required-names\fR\fR .ad .br .sp .6 .RS 4n (list of strings) A list of names that must be seen as common names of certificates while validating the signatures of a package\&. .RE .sp .ne 2 .mk .na \fB\fBtrust-anchor-directory\fR\fR .ad .br .sp .6 .RS 4n (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 \fBignore\fR\&. .RE .sp .ne 2 .mk .na \fB\fBuse-system-repo\fR\fR .ad .br .sp .6 .RS 4n (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 \fBFalse\fR\&. See the \fBpkg\&.sysrepo\fR(1M) man page for information about system repositories\&. .RE .SH PUBLISHER PROPERTIES .sp .LP 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 \fBpkg publisher\fR \fIpublisher_name\fR command\&. To modify the values of these publisher signature policy properties, use the \fB--set-property\fR and \fB--unset-property\fR options of the \fBpkg set-publisher\fR command\&. .sp .ne 2 .mk .na \fB\fBsignature-policy\fR\fR .ad .br .sp .6 .RS 4n (string) This property functions identically to the image property of the same name except that it only applies to packages from the particular publisher\&. .RE .sp .ne 2 .mk .na \fB\fBsignature-required-names\fR\fR .ad .br .sp .6 .RS 4n (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\&. .RE .SH EXAMPLES .LP \fBExample 1\fR Create an Image With Publisher Configured .sp .LP Create a new, full image, with publisher \fBexample\&.com\fR, stored at \fB/aux0/example_root\fR\&. .sp .in +2 .nf $ \fBpkg image-create -F -p example\&.com=http://pkg\&.example\&.com:10000 \e\fR \fB/aux0/example_root\fR .fi .in -2 .sp .LP \fBExample 2\fR Create an Image, Specifying Additional Origins and Mirror .sp .LP Create a new, full image, with publisher \fBexample\&.com\fR, that also has an additional mirror, two additional origins, and is stored at \fB/aux0/example_root\fR\&. .sp .in +2 .nf $ \fBpkg image-create -F -p example\&.com=http://pkg\&.example\&.com:10000 \e\fR \fB-g http://alternate1\&.example\&.com:10000/ \e\fR \fB-g http://alternate2\&.example\&.com:10000/ \e\fR \fB-m http://mirror\&.example\&.com:10000/ \e\fR \fB/aux0/example_root\fR .fi .in -2 .sp .LP \fBExample 3\fR Create an Image With No Publisher Configured .sp .LP Create a new, full image with no publishers configured at \fB/aux0/example_root\fR\&. .sp .in +2 .nf $ \fBpkg image-create -F /aux0/example_root\fR .fi .in -2 .sp .LP \fBExample 4\fR Install a Package .sp .LP Install the latest version of the \fBwidget\fR package in the current image\&. .sp .in +2 .nf $ \fBpkg install application/widget\fR .fi .in -2 .sp .LP \fBExample 5\fR List Specified Contents of a Package .sp .LP List the contents of the \fBsystem/file-system/zfs\fR 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 \fBdir\fR, \fBfile\fR, \fBlink\fR, and \fBhardlink\fR, since specifying the \fBaction\&.name\fR attribute, which is available for all actions, displays a line for all actions, which is not desired here\&. .sp .in +2 .nf $ \fBpkg contents -t dir,file,link,hardlink \e\fR \fB-o action\&.name,mode,pkg\&.size,path,target system/file-system/zfs\fR 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 \&.\&.\&. .fi .in -2 .sp .LP \fBExample 6\fR List Specified Contents of Two Packages .sp .LP List the contents of \fBweb/browser/firefox\fR and \fBmail/thunderbird\fR, limiting the display to just the package name and path attributes of actions whose \fBpath\fR attribute ends in \fB\&.desktop\fR or \fB\&.png\fR\&. .sp .in +2 .nf $ \fBpkg contents -o pkg\&.name,path -a path=\e*\&.desktop \e\fR \fB-a path=\e*\&.png web/browser/firefox mail/thunderbird\fR 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 \&.\&.\&. .fi .in -2 .sp .LP \fBExample 7\fR Search for a Package .sp .LP Search the package database for the token \fBbge\fR\&. .sp .in +2 .nf $ \fBpkg search bge\fR INDEX ACTION VALUE PACKAGE driver_name driver bge pkg:/driver/network/ethernet/bge@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 basename file kernel/drv/sparcv9/bge pkg:/driver/network/ethernet/bge@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 basename file kernel/drv/amd64/bge pkg:/driver/network/ethernet/bge@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 basename file platform/sun4v/kernel/drv/sparcv9/bge pkg:/system/kernel/platform@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg\&.fmri set solaris/driver/network/bge pkg:/driver/network/bge@0\&.5\&.11-0\&.173\&.0\&.0\&.0\&.1\&.0 pkg\&.fmri set solaris/driver/network/ethernet/bge pkg:/driver/network/ethernet/bge@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 .fi .in -2 .sp .sp .LP The token is in the package \fBdriver/network/bge\fR both as the basename for the file action representing \fB/kernel/drv/\fIarch\fR/bge\fR and as a driver name\&. .LP \fBExample 8\fR Search for a File .sp .LP Search for the package that delivers a file by specifying the full path name of the file, including the leading slash character\&. .sp .in +2 .nf $ \fBpkg search -o path,pkg\&.name -l /usr/bin/vim\fR PATH PKG\&.NAME usr/bin/vim editor/vim/vim-core .fi .in -2 .sp .sp .LP Search for a file and the package that delivers that file by specifying \fBfile\fR for the \fIaction_name\fR, \fBpath\fR or \fBbasename\fR for the \fIindex\fR, and the full or partial file name for the \fItoken\fR\&. .sp .in +2 .nf $ \fBpkg search -o path,pkg\&.name -l file:basename:vim\fR PATH PKG\&.NAME usr/bin/vim editor/vim/vim-core .fi .in -2 .sp .LP \fBExample 9\fR Search for Files and Directories .sp .LP Search for files and directories and the packages that deliver them by specifying \fBpath\fR or \fBbasename\fR for the \fIindex\fR and the full or partial file name for the \fItoken\fR\&. Depending on your shell, you might need to escape wildcards\&. .sp .in +2 .nf $ \fBpkg search -o path,pkg\&.name -l path:*/vim\fR PATH PKG\&.NAME usr/bin/vim editor/vim/vim-core usr/share/vim editor/vim usr/share/vim editor/vim/vim-core $ \fBpkg search -o path,pkg\&.name -l basename:vim\fR PATH PKG\&.NAME usr/share/vim editor/vim usr/share/vim editor/vim/vim-core usr/bin/vim editor/vim/vim-core .fi .in -2 .sp .LP \fBExample 10\fR Show Which Packages Provide Which SMF Services .sp .LP Show which packages provide a particular SMF service by specifying the value \fBorg\&.opensolaris\&.smf\&.fmri\fR for the \fIindex\fR in a structured search and the name of the service you want to find for the \fItoken\fR\&. The value \fBorg\&.opensolaris\&.smf\&.fmri\fR is the name of an attribute of a \fBset\fR action\&. Remember to escape the : in the name of the service\&. .sp .LP For example, show which HTTP servers are available by specifying the value \fBsvc:/network/http\fR for the \fItoken\fR\&. .sp .in +2 .nf $ \fBpkg search \'org\&.opensolaris\&.smf\&.fmri:svc\e:/network/http*\'\fR INDEX ACTION VALUE PACKAGE org\&.opensolaris\&.smf\&.fmri set svc:/network/http pkg:/web/server/lighttpd-14@1\&.4\&.23-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http pkg:/web/proxy/privoxy@3\&.0\&.17-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http pkg:/web/proxy/squid@3\&.1\&.18-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http pkg:/web/java-servlet/tomcat@6\&.0\&.35-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http pkg:/web/server/apache-22@2\&.2\&.22-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http:apache22 pkg:/web/server/apache-22@2\&.2\&.22-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http:lighttpd14 pkg:/web/server/lighttpd-14@1\&.4\&.23-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http:privoxy pkg:/web/proxy/privoxy@3\&.0\&.17-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http:squid pkg:/web/proxy/squid@3\&.1\&.18-0\&.175\&.0\&.0\&.0\&.2\&.1 org\&.opensolaris\&.smf\&.fmri set svc:/network/http:tomcat6 pkg:/web/java-servlet/tomcat@6\&.0\&.35-0\&.175\&.0\&.0\&.0\&.2\&.1 .fi .in -2 .sp .LP \fBExample 11\fR Search for Packages that Depend on the Specified Package .sp .LP Search for installed packages that depend on \fBpackage/pkg\fR\&. .sp .in +2 .nf $ \fBpkg search -l depend::package/pkg\fR INDEX ACTION VALUE PACKAGE incorporate depend package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/consolidation/ips/ips-incorporation@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 require depend pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/system/library/install@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 require depend pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/system/library/boot-management@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 require depend package/pkg pkg:/system/zones/brand/brand-solaris@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 require depend pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/install/distribution-constructor@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 require depend pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/system/boot-environment-utilities@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 require depend pkg:/package/pkg@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/package/pkg/system-repository@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 .fi .in -2 .sp .LP \fBExample 12\fR Search for Dependencies .sp .LP Search for all \fBincorporate\fR dependencies in installed packages\&. .sp .in +2 .nf $ \fBpkg search -l depend:incorporate:\fR INDEX ACTION VALUE PACKAGE incorporate depend pkg:/BRCMbnx@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/consolidation/osnet/osnet-incorporation@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 incorporate depend pkg:/BRCMbnxe@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 pkg:/consolidation/osnet/osnet-incorporation@0\&.5\&.11-0\&.175\&.0\&.0\&.0\&.2\&.1 \&.\&.\&. .fi .in -2 .sp .LP \fBExample 13\fR Add a Publisher .sp .LP Add a new publisher \fBexample\&.com\fR, with a repository located at \fBhttp://www\&.example\&.com/repo\fR\&. .sp .in +2 .nf $ \fBpkg set-publisher -g http://www\&.example\&.com/repo example\&.com\fR .fi .in -2 .sp .LP \fBExample 14\fR Add a Publisher With Key and Certificate .sp .LP Add a new publisher \fBexample\&.com\fR, with a secure repository located at \fBhttps://secure\&.example\&.com/repo\fR, and a key and certificate stored in the directory \fB/root/creds\fR\&. .sp .in +2 .nf $ \fBpkg set-publisher -k /root/creds/example\&.key \e\fR \fB-c /root/creds/example\&.cert -g https://secure\&.example\&.com/repo \e\fR \fBexample\&.com\fR .fi .in -2 .sp .LP \fBExample 15\fR Add and Automatically Configure a Publisher .sp .LP Add a new publisher with a repository located at \fB/export/repo\fR using automatic configuration\&. .sp .in +2 .nf $ \fBpkg set-publisher -p /export/repo\fR .fi .in -2 .sp .LP \fBExample 16\fR Add and Manually Configure a Publisher .sp .LP Add a new publisher \fBexample\&.com\fR with a repository located at \fB/export/repo/example\&.com\fR using manual configuration\&. .sp .in +2 .nf $ \fBpkg set-publisher -g /export/repo example\&.com\fR .fi .in -2 .sp .LP \fBExample 17\fR Add a Publisher and Configure a Proxy .sp .LP Add a new publisher \fBmypub\fR with origin \fBhttp://server/repo\fR and proxy \fBhttp://webcache:8080\fR\&. .sp .in +2 .nf $ \fBpkg set-publisher -g http://server/repo \e\fR \fB--proxy http://webcache:8080 mypub\fR .fi .in -2 .sp .LP \fBExample 18\fR Verify All Signed Packages .sp .LP Configure an image to verify all signed packages\&. .sp .in +2 .nf $ \fBpkg set-property signature-policy verify\fR .fi .in -2 .sp .LP \fBExample 19\fR Require All Packages To Be Signed .sp .LP Configure an image to require all packages to be signed, and require the string \fBexample\&.com\fR to be seen as a common name for one of the certificates in the chain of trust\&. .sp .in +2 .nf $ \fBpkg set-property signature-policy require-names example\&.com\fR .fi .in -2 .sp .LP \fBExample 20\fR Require All Packages From a Specified Publisher To Be Signed .sp .LP Configure an image so that all packages installed from publisher \fBexample\&.com\fR must be signed\&. .sp .in +2 .nf $ \fBpkg set-publisher --set-property signature-policy=require-signatures \e\fR \fBexample\&.com\fR .fi .in -2 .sp .LP \fBExample 21\fR Require a Specified String in the Chain of Trust .sp .LP Add the string \fBfoo\fR to the image\'s list of common names that must be seen in a signature\'s chain of trust to be considered valid\&. .sp .in +2 .nf $ \fBpkg add-property-value signature-require-names foo\fR .fi .in -2 .sp .LP \fBExample 22\fR Remove a String From the Chain of Trust for a Specified Publisher .sp .LP Remove the string \fBfoo\fR from the list of common names that must be seen to validate a signature for the publisher \fBexample\&.com\fR\&. .sp .in +2 .nf $ \fBpkg set-publisher --remove-property-value signature-require-names=foo \e\fR \fBexample\&.com\fR .fi .in -2 .sp .LP \fBExample 23\fR Add a Trusted CA Certificate .sp .LP Add the certificate stored in \fB/tmp/example_file\&.pem\fR as a trusted CA certificate for the publisher \fBexample\&.com\fR\&. .sp .in +2 .nf $ \fBpkg set-publisher --approve-ca-cert /tmp/example_file\&.pem \e\fR \fBexample\&.com\fR .fi .in -2 .sp .LP \fBExample 24\fR Revoke a Certificate .sp .LP Revoke the certificate with the hash \fBa12345\fR for publisher \fBexample\&.com\fR, preventing the certificate from validating any signatures for packages from \fBexample\&.com\fR\&. .sp .in +2 .nf $ \fBpkg set-publisher --revoke-ca-cert a12345 example\&.com\fR .fi .in -2 .sp .LP \fBExample 25\fR Forget About a Certificate .sp .LP Make \fBpkg\fR forget that the certificate \fBa12345\fR was ever added or revoked by the user\&. .sp .in +2 .nf $ \fBpkg set-publisher --unset-ca-cert a12345 example\&.com\fR .fi .in -2 .sp .LP \fBExample 26\fR Downgrade a Package .sp .LP Downgrade the installed package \fBfoo@1\&.1\fR to an older version\&. .sp .in +2 .nf $ \fBpkg update foo@1\&.0\fR .fi .in -2 .sp .LP \fBExample 27\fR Switch Conflicting Package Installation .sp .LP 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: .sp .in +2 .nf $ \fBpkg install --reject B C\fR .fi .in -2 .sp .LP \fBExample 28\fR List Packages in a Package Archive .sp .LP List all versions of all packages in a package archive\&. .sp .in +2 .nf $ \fBpkg list -f -g /my/archive\&.p5p\fR .fi .in -2 .sp .LP \fBExample 29\fR List Packages in a Package Repository .sp .LP List all versions of all packages in a repository\&. .sp .in +2 .nf $ \fBpkg list -f -g http://example\&.com:10000\fR .fi .in -2 .sp .LP \fBExample 30\fR Display Information About a Package in a Package Archive .sp .LP Display the package information for the latest version of a package in a package archive\&. The package might or might not be currently installed\&. .sp .in +2 .nf $ \fBpkg info -g /my/archive\&.p5p pkg_name\fR .fi .in -2 .sp .LP \fBExample 31\fR Display Contents of a Package in a Package Archive .sp .LP Display the contents of a package in a package archive\&. The package is not currently installed\&. .sp .in +2 .nf $ \fBpkg contents -g /my/archive\&.p5p pkg_name\fR .fi .in -2 .sp .LP \fBExample 32\fR Remove All Publisher Origins and Mirrors .sp .LP Remove all of the origins and mirrors for a publisher and add a new origin\&. .sp .in +2 .nf $ \fBpkg set-publisher -G \'*\' -M \'*\' -g http://example\&.com:10000 \e\fR \fBexample\&.com\fR .fi .in -2 .sp .LP \fBExample 33\fR Dehydrating and Rehydrating an Image .sp .LP In these examples, \fB/tmp/test_image\fR is the image that you want to dehydrate and rehydrate\&. .sp .LP Because no publisher is specified, the following command fully dehydrates the \fB/tmp/test_image\fR image by operating on all publishers that are enabled in the \fB/tmp/test_image\fR image\&. .sp .in +2 .nf $ \fBpkg -R /tmp/test_image dehydrate\fR .fi .in -2 .sp .sp .LP Because no publisher is specified, the following command operates on all publishers configured in the \fB/tmp/test_image\fR image to fully restore the \fB/tmp/test_image\fR image\&. .sp .in +2 .nf $ \fBpkg -R /tmp/test_image rehydrate\fR .fi .in -2 .sp .LP \fBExample 34\fR Dehydrating and Rehydrating an Image Specifying Publishers .sp .LP In these examples, \fB/tmp/test_image\fR is the image that you want to dehydrate and rehydrate, and the \fBtest1\fR and \fBtest2\fR publishers are enabled in the \fB/tmp/test_image\fR image and their origins provide the necessary content\&. .sp .LP The following command operates only on files and hardlinks delivered by the \fBtest1\fR publisher\&. .sp .in +2 .nf $ \fBpkg -R /tmp/test_image dehydrate -p test1\fR .fi .in -2 .sp .sp .LP The following command rehydrates only files and hardlinks delivered by the \fBtest1\fR publisher\&. .sp .in +2 .nf $ \fBpkg -R /tmp/test_image rehydrate -p test1\fR .fi .in -2 .sp .SH ENVIRONMENT VARIABLES .sp .ne 2 .mk .na \fB\fBPKG_IMAGE\fR\fR .ad .br .sp .6 .RS 4n The directory containing the image to use for package operations\&. Ignored if \fB-R\fR is specified\&. .RE .sp .ne 2 .mk .na \fB\fBPKG_CLIENT_CONNECT_TIMEOUT\fR\fR .ad .br .sp .6 .RS 4n 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\&. .sp Default value: 60 .RE .sp .ne 2 .mk .na \fB\fBPKG_CLIENT_LOWSPEED_TIMEOUT\fR\fR .ad .br .sp .6 .RS 4n Seconds below the \fBlowspeed\fR limit (1024 bytes/second) during transport operations before the client aborts the operation\&. A value of 0 means do not abort the operation\&. .sp Default value: 30 .RE .sp .ne 2 .mk .na \fB\fBPKG_CLIENT_MAX_CONSECUTIVE_ERROR\fR\fR .ad .br .sp .6 .RS 4n Maximum number of transient transport errors before the client aborts the operation\&. A value of 0 means do not abort the operation\&. .sp Default value: 4 .RE .sp .ne 2 .mk .na \fB\fBPKG_CLIENT_MAX_REDIRECT\fR\fR .ad .br .sp .6 .RS 4n 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\&. .sp Default value: 5 .RE .sp .ne 2 .mk .na \fB\fBPKG_CONCURRENCY\fR\fR .ad .br .sp .6 .RS 4n The number of child images to update in parallel\&. Ignored if the \fB-C\fR option is specified\&. .sp When recursing into child images (usually installed \fBsolaris\fR branded non-global zones), update at most \fB$PKG_CONCURRENCY\fR child images in parallel\&. If \fB$PKG_CONCURRENCY\fR is 0 or a negative number, all child images are updated in parallel\&. .sp Default value: 1 .RE .sp .ne 2 .mk .na \fB\fBPKG_CLIENT_MAX_TIMEOUT\fR\fR .ad .br .sp .6 .RS 4n Maximum number of transport attempts per host before the client aborts the operation\&. A value of 0 means do not abort the operation\&. .sp Default value: 4 .RE .sp .ne 2 .mk .na \fB\fBhttp_proxy\fR, \fBhttps_proxy\fR\fR .ad .br .sp .6 .RS 4n HTTP or HTTPS proxy server\&. .RE .SH EXIT STATUS .sp .LP The following exit values are returned: .sp .ne 2 .mk .na \fB\fB0\fR\fR .ad .RS 6n .rt Command succeeded\&. .RE .sp .ne 2 .mk .na \fB\fB1\fR\fR .ad .RS 6n .rt An error occurred\&. .RE .sp .ne 2 .mk .na \fB\fB2\fR\fR .ad .RS 6n .rt Invalid command line options were specified\&. .RE .sp .ne 2 .mk .na \fB\fB3\fR\fR .ad .RS 6n .rt Multiple operations were requested, but only some of them succeeded\&. .RE .sp .ne 2 .mk .na \fB\fB4\fR\fR .ad .RS 6n .rt No changes were made - nothing to do\&. .RE .sp .ne 2 .mk .na \fB\fB5\fR\fR .ad .RS 6n .rt The requested operation cannot be performed on a live image\&. .RE .sp .ne 2 .mk .na \fB\fB6\fR\fR .ad .RS 6n .rt The requested operation cannot be completed because the licenses for the packages being installed or updated have not been accepted\&. .RE .sp .ne 2 .mk .na \fB\fB7\fR\fR .ad .RS 6n .rt The image is currently in use by another process and cannot be modified\&. .RE .sp .ne 2 .mk .na \fB\fB8\fR\fR .ad .RS 6n .rt One or more SMF actuators timed out\&. .RE .sp .ne 2 .mk .na \fB\fB99\fR\fR .ad .RS 6n .rt An unanticipated exception occurred\&. .RE .SH FILES .sp .LP A \fBpkg\fR(5) image can be located arbitrarily within a larger file system\&. In the following file descriptions, the token \fB$IMAGE_ROOT\fR is used to distinguish relative paths\&. For a typical system installation, \fB$IMAGE_ROOT\fR is equivalent to \fB/\fR .sp .ne 2 .mk .na \fB\fB$IMAGE_ROOT/var/pkg\fR\fR .ad .br .sp .6 .RS 4n Metadata directory for a full or partial image\&. .RE .sp .ne 2 .mk .na \fB\fB$IMAGE_ROOT/\&.org\&.opensolaris,pkg\fR\fR .ad .br .sp .6 .RS 4n Metadata directory for a user image\&. .RE .sp .LP Within a particular image\'s metadata, certain files and directories can contain information useful during repair and recovery\&. The token \fB$IMAGE_META\fR refers to the top-level directory containing the metadata\&. \fB$IMAGE_META\fR is typically one of the two paths given above\&. .sp .ne 2 .mk .na \fB\fB$IMAGE_META/lost+found\fR\fR .ad .br .sp .6 .RS 4n Location of conflicting directories and files moved during a package operation\&. Location of unpackaged contents of a removed directory\&. .RE .sp .ne 2 .mk .na \fB\fB$IMAGE_META/publisher\fR\fR .ad .br .sp .6 .RS 4n Contains a directory for each publisher\&. Each directory stores publisher-specific metadata\&. .RE .sp .LP Other paths within the \fB$IMAGE_META\fR directory hierarchy are private and are subject to change\&. .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS tab( ) box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPE ATTRIBUTE VALUE _ Availability \fBpackage/pkg\fR _ Interface Stability Uncommitted .TE .SH SEE ALSO .sp .LP \fBpkgsend\fR(1), \fBbeadm\fR(1M), \fBpkg\&.depotd\fR(1M), \fBpkg\&.sysrepo\fR(1M), \fBglob\fR(3C), \fBpkg\fR(5) .sp .LP \fIAdding and Updating Software in Oracle Solaris 11\&.3\fR .sp .LP \fBhttps://java\&.net/projects/ips/pages/Home\fR