Update the client's list of available packages and publisher metadata for all publishers.

publisher

Update the client's list of available packages and publisher metadata only for the specified publishers.

-q

Hide progress messages during the requested operation.

--full

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

Install and update the specified packages to the newest version that match pkg_fmri_pattern allowed by the packages installed in the image. To explicitly request the latest version of a package, use latest for the version portion of pkg_fmri_pattern. For example, specify vim@latest. The pkg_fmri_pattern pattern can include the ? and * characters as glob(3C)-style wildcards to match one or more packages.

Versions older or newer than what is already installed can be specified to perform in-place downgrades or upgrades of specific packages. Updating specific packages across package rename or obsolete boundaries is not supported.

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

Packages are selected based on publisher search order and stickiness. See the pkg publisher and pkg set-publisher commands for information about search order and stickiness. If the pkg_fmri_pattern 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 pkg list -a command to see which publishers provide a version of the package that can be installed in this image.

If more than one pkg_fmri_pattern is specified, and if any of the specified packages cannot be installed in this image, then none of the specified packages will be installed.

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 pkg(7) man page.

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

-C n

Specify the number of child images to update in parallel. When recursing into child images (usually installed lipkg, sparse or pkgsrc branded non-global zones), update at most n child images in parallel. The default number of child images to update in parallel is 1. If n is 0 or a negative number, all child images are updated in parallel. See also PKG_CONCURRENCY in the Environment Variables section and recursion-concurrency in the Image Properties section.

-g path_or_uri

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.

When deciding which version of a package to use, publishers configured in the image, but not found in the specified path_or_uri sources, take precedence. If the version of the package to be installed is provided by a publisher configured in the image and by a path_or_uri source, the client retrieves the content for that package from the path_or_uri 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 pkg publisher command to see which publishers are configured in the image.

-n

Perform a trial run of the operation with no package changes made.

-q

Hide progress messages during the requested operation.

-r

Run this operation in the global zone and also in all installed linked 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 pkg 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 pkg operation is applied to all installed non-global zones except as limited by the -z and -Z options. Zones that are excluded by the -z and -Z options might still be modified if updates are required to keep them in sync with the global zone.

-z zonename

Run this operation only in the specified non-global zone. The -z option can be specified multiple times. The -z option can only be used with the -r option. The -z option cannot be used with the -Z option.

-Z zonename

Run this operation in all non-global zones except for the specified zone. The -Z option can be specified multiple times. The -Z option can only be used with the -r option. The -Z option cannot be used with the -z option.

-v

Issue verbose progress messages during the requested operation, and display detailed planning information (such as changing facets, mediators, and variants).

This option can be specified multiple times to increase the amount of planning information displayed. In particular, specifying this option twice in conjunction with the install or update sub-command, results in more detailed information about why that sub-command cannot install or update the specified packages.

--accept

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.

--licenses

Display all of the licences for the packages that are installed or updated as part of this operation. For updated packages, display the licence only if the licence has changed.

--no-index

Do not update the search indexes after the operation has completed successfully.

--no-refresh

Do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages and other metadata.

--no-be-activate

If a boot environment is created, do not set it as the active boot environment on the next boot. See the beadm(8) man page for more information.

--temp-be-activate

If a boot environment is created, set it as the active boot environment for the next boot only (temporary activation). See the beadm(8) man page for more information. This is particularly useful for hosted environments where console access is not readily available. If the new boot environment boots successfully, it can be activated using beadm(8) and, if not, a power cycle will automatically revert to the previous boot environment. Temporary activation can be enabled by default for updates to an image via the temp-be-activation package property; if this is set then it is not necessary to specify the --temp-be-activate option manually.

--no-backup-be

Do not create a backup boot environment.

--require-backup-be

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

--backup-be-name name

Name the created backup boot environment using the given argument. Use of --backup-be-name implies --require-backup-be. See also the beadm(8) man page.

--deny-new-be

Do not create a new boot environment. This operation will fail if this option is specified and the operation requires a new boot environment.

--require-new-be

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

--be-name name

Rename the newly created boot environment to be the argument given. Use of --be-name implies --require-new-be. See also the beadm(8) man page.

--reject pkg_fmri_pattern

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.

--sync-actuators

Run SMF actuators synchronously. The pkg command will not return until all SMF actuators have finished in the zone in which pkg was invoked (the global zone or a non-global zone).

--sync-actuators-timeout

Run SMF actuators synchronously. If the actuators do not finish within the given timeout in seconds, pkg will continue operation and exit with return code 8.

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 exact-install subcommand behaves the same way that the install subcommand behaves. To explicitly request the latest version of a package, use latest for the version portion of pkg_fmri_pattern. For example, specify vim@latest.

Packages are selected based on publisher search order and stickiness. See the pkg publisher and pkg set-publisher commands for information about search order and stickiness. If the pkg_fmri_pattern 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 pkg list -a command to see which publishers provide a version of the package that can be installed in this image.

If more than one pkg_fmri_pattern is specified, and if any of the specified packages cannot be installed in this image, then none of the specified packages will be installed.

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 pkg(7) man page.

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

For descriptions of options, see the install sub-command above.

Remove installed packages that match pkg_fmri_pattern.

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

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 beadm(8) man page for information about managing boot environments.

--ignore-missing

Ignore packages that are not installed. Using this option prevents pkg uninstall from failing when attempting to uninstall a package that is not currently installed.

For all other options, see the install command above.

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.

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 --no-be-activate option. See the beadm(8) man page for information about managing boot environments.

Recursion can be enabled by default for updates to an image via the default-recurse image property; if this is set then it is not necessary to specify the -r option manually, however the -R option can be specified to temporarily override recursion, see below.

pkg_fmri_pattern

Update only the specified packages installed in the current image. If asterisk (*) is one of the pkg_fmri_pattern patterns provided, update all packages installed in the current image in the same way as when no pkg_fmri_pattern is provided.

To explicitly request the latest version of a package, use latest for the version portion of pkg_fmri_pattern. For example, specify vim@latest.

Versions older or newer than what is already installed can be specified to perform in-place downgrades or upgrades of specific packages. Updating specific packages across package rename or obsolete boundaries is not supported.

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

If more than one pkg_fmri_pattern is specified, and if any of the specified packages cannot be updated in this image, then none of the specified packages will be updated.

-f

Do not execute the client up-to-date check when updating all installed packages.

--ignore-missing

Ignore packages that are not installed. Using this option prevents pkg update from failing when attempting to update a package that is not currently installed.

-R

Disable recursion into linked non-global zones. This option can be used to override the default policy set on the image, refer to default-recurse in the Package Properties section. Even with this option, when you run pkg update commands in the global zone, non-global zones are modified to the extent required to keep them compatible with the global zone.

For all other options, see the install command above.

Install a hot-fix bundle from the provided location.

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 --no-be-activate option. See the beadm(8) man page for information about managing boot environments.

path_or_uri

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.

pkg_fmri_pattern

Update only the specified packages found within the hot-fix archive.

If more than one pkg_fmri_pattern is specified, and if any of the specified packages cannot be updated in this image, then none of the specified packages will be updated.

For all other options, see the install command above.

Automatically uninstall any packages which have no dependants and were not installed manually. The list of packages to be removed is the same as the list shown in the output of pkg list -rM.

Packages are marked as manually installed if they were given as arguments to a pkg install command, or if they were flagged as manually installed using the pkg flag -m command. Packages marked in this way are ignored by autoremove.

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:

NAME (PUBLISHER)                    VERSION           IFO
entire                              11-151037.0       i--
ooce/developer/cmake (extra.omnios) 3.19.5-151037.0   im-

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

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

pkg_fmri_pattern

List only the specified packages.

-F format

Specify an alternative output format. The value of format can be tsv (Tab Separated Values), json (JavaScript Object Notation as a single line), or json-formatted (JavaScript Object Notation, formatted for readability).

-H

Omit the headers from the listing.

-a

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 -a, only installed packages are listed.

-af

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

-g path_or_uri

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 -g implies -a if -n is not specified.

-i

Show only packages which are installable (i.e. not currently installed).

-M

Show only packages which were automatically (rather than manually) installed. That is, those which are part of the default system or were installed automatically as dependencies of another package.

This can be usefully combined with -r to show automatically installed packages which can likely be removed.

-m

Show only packages which were manually installed. That is, those which were explicitly provided as arguments to a pkg install command, or were flagged using pkg flag -m.

-n

Display the newest versions of all known packages, regardless of installed state.

-o column[,column]...

Specify the columns to include in the output. Multiple attributes can be specified by separating the attribute names with commas. Valid column names are:

branch

The branch portion of the full package version.

flags

The set of flags as described above.

fmri

The full package FMRI.

name

The package name.

namepub

The package name, followed by the publisher name in brackets if it is different from the preferred (highest priority) publisher configured on the system.

osrelease

The OS release portion of the full package version.

publisher

The publisher.

release

The release portion of the full package version.

summary

The package summary text.

timestamp

The timestamp portion of the full package version.

version

The version of the package. This is the release and branch components of the version separated by a hyphen ‘-’.

-q

Do not list any packages, but return failure if a fatal error occurs.

-r

List installed packages that are removable (i.e. those that have no dependants).

-R

List installed packages that are removable, like the -r option above. However, -R also lists removable system packages, identifying them with a S in the F flags column.

-s

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

-u

List installed packages that have newer versions available. This option cannot be used with -g.

-v

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

--no-refresh

Do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages.

Display information about all packages installed in the current image in a human-readable form.

pkg_fmri_pattern

Display information for only the specified packages.

-g path_or_uri

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 -g implies -r.

-l

Only display information for installed packages. This is the default.

-q

Do not display any package information, but return failure if a fatal error occurs.

-r

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

--license

Display the licence texts for the packages. This option can be combined with -l, -q, or -r. Return success if all pkg_fmri_pattern patterns match known packages and have licenses. Return failure if one or more patterns are unmatched or match packages that do not have licenses.

Display the contents (action attributes) of all packages installed in the image. With no options, display the value of the path attribute for actions installed in the current image, sorted alphabetically by attribute value. If the -o option is not specified, the key attributes, as described in pkg(7), of the related action name will be displayed instead. In addition, depend actions will also include the type attribute, and set actions will include the value attribute.

When more than one action name is specified, the default attributes are the set of all attributes, as described above, of all the specified actions. For information about actions and their attributes, see 'Actions' in the pkg(7) man page. See also the list of pseudo attribute names below.

pkg_fmri_pattern

Display contents of only the specified packages.

-H

Omit the headers from the output.

-a attribute=pattern

Limit the output to those actions that have an attribute named in the option argument with a value that matches the (glob) pattern in the option argument. This option can be specified multiple times. If multiple -a options are given, then actions that match any of them are displayed.

-g path_or_uri

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 -g implies -r.

-m

Display all attributes of all actions in the specified packages, including actions that could not be installed in this image.

-o attribute

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

-r

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

-s sort_key

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

-t action_name

Only list the specified actions. The -t option can be specified multiple times, or multiple actions can be specified as the argument to one -t option by separating the action names with commas. The value of action_name is one of the actions listed in "Actions" in the pkg(7) man page, such as file, directory, driver, depend, set.

Several special pseudo attribute names are available for convenience:

action.hash

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

action.key

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

action.name

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

action.raw

All attributes of matching actions.

pkg.fmri

The full FMRI of the package containing the action, such as pkg://omnios/entire@11-151036.0:20201029T154929Z.

pkg.name

The name of the package containing the action, such as entire.

pkg.publisher

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

pkg.shortfmri

The short form FMRI of the package containing the action, such as pkg://omnios/entire@11-151036.0.

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

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

Search for actions that match query, and display the matching search index, action name, action value, and package name. See the description of query below. Some searches might yield duplicate results.

-H

Omit the headers from the output.

-I

Use a case-sensitive search.

-a

Perform the search and display information about the matching actions. This is the default.

-f

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

-l

Search the image's installed packages.

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

-o attribute

Specify the columns to include in the output. The -o option can be specified multiple times, or multiple attributes can be specified as the argument to one -o option by separating the attribute names with commas. In addition to the pseudo attributes outlined above, the following attributes are defined for search results. These attributes help show why a particular result was a match:

search.match

The string that matched the search query.

search.match_type

The attribute that contained the string that matched the search query.

-p

Display packages that have some actions that match each query term. Using this option is equivalent to putting angle brackets (⟨⟩) around each term in the query. See query below for more description of the ⟨⟩ operator.

-r

Search the repositories corresponding to the image's publishers. This is the default.

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

-s repo_uri

Search the pkg repository located at the given URI. This can be specified multiple times. Package archives are not supported.

query

By default, query is interpreted as a series of terms to be matched exactly and multiple terms are ANDed.

AND and OR are supported.

The ? and * characters can be used as glob(3C)- style wildcards, allowing more flexible query matches.

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

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 pkg(7) man page. See also the list of pseudo attribute names in pkg contents and -o above.

Structured queries are supported with the following syntax:

pkg_name:action_name:index:token

The value of action_name is one of the actions listed in "Actions" in the pkg(7) man page. The index is an attribute of the action. The value of index must match token.

Not all action attributes are searchable. For example, mode is an attribute of the file action, but mode is not a valid value for index.

Some values for index are not action attributes but are values derived from other attributes. For example, index can be basename, which is not an attribute of any action but is derived from the path attribute of the file or dir action by taking the last component of the path.

Different action types have different valid values for index. This documentation does not list all possible values. Some of the more useful index values are basename and path for file system actions, the dependency type (for example, require, optional, group) for depend actions, and driver_name and alias for driver actions.

One special value for index is the value of a name attribute for a set action. In this case, token is matched against the value of the value attribute that corresponds to the specified name 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.

$ pkg search info.classification:databases

Missing fields in a structured query are implicitly wildcarded. A search for basename:pkg matches all actions in all packages that have an index of basename and that match the token pkg, as shown in the following partial output:

$ pkg search basename:pkg
INDEX    ACTION VALUE         PACKAGE
basename dir    usr/share/pkg pkg:/package/pkg@0.5.11
basename dir    var/sadm/pkg  pkg:/package/svr4@0.5.11
basename dir    var/spool/pkg pkg:/package/svr4@0.5.11
basename file   usr/bin/pkg   pkg:/package/pkg@0.5.11

Adding another field narrows the search, as shown in the following complete output:

$ pkg search file:basename:pkg
INDEX    ACTION VALUE       PACKAGE
basename file   usr/bin/pkg pkg:/package/pkg@0.5.11

Explicit wildcards are supported in the pkg_name and token fields. The action_name and index must match exactly.

See the Examples section for examples of searching for files and dependencies.

To convert actions to the packages that contain those actions, use ⟨⟩, as shown in the following partial output:

$ pkg search \<pkg\>
PACKAGE                             PUBLISHER
pkg:/package/pkg@0.5.11-151036.0    omnios
pkg:/package/svr4@0.5.11-151036.0   omnios

With the -a option (and by default), searching for token results in information about the actions that match token, while searching for ⟨token⟩ results in a list of packages that contain actions that match token.

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

pkg_fmri_pattern

Validate the installation of only the specified packages installed in the current image. When used with -p, only the maching actions from the specified packages will be verified.

-H

Omit the headers from the verification output.

-p path

Validate individual files, links or directories by specifying the paths. Paths specified are assumed to be relative to the root of the image on which the verify is performed. If a directory or a link is specified, only the matching action for the directory or the link will be verified.

If no pkg_fmri_patterns are provided when specifying paths, all matching actions from packages installed in the image will be verified.

--parsable version

Parsable output; the supported version is 0. Use of this option implies -q.

-q

Suppress progress messages and all other output during the requested operation.

--unpackaged

Report unpackaged contents in addition to general output. Current unpackaged contents includes unpackaged files and unpackaged directories. This option can be combined with --parsable.

--unpackaged-only

Report only unpackaged contents. This option excludes general verification output and only reports the unpackaged files and directories. This option can be combined with --parsable.

-v

Include informational messages regarding packages.

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

pkg_fmri_pattern

Fix errors reported by pkg verify for only the specified packages installed in the current image.

--accept

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.

--licenses

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.

--parsable version

Parsable output; the supported version is 0. Use of this option implies -q.

--unpackaged

Report unpackaged contents in addition to general output.

For all other options, see the install command above.

Revert files delivered by packages to their as-delivered condition. File ownership and protections are also restored. Caution - Reverting some editable files to their default values can make the system unbootable, or cause other malfunctions.

--tagged tag-name

Revert all files tagged with tag-name, and remove any unpackaged files or directories that are under directories with this tag and that match pattern. See the description of the revert-tag attribute in "File Actions" and "Directory Actions" in the pkg(7) man page for more information about tag-name and pattern.

path-to-file

Revert the specified files.

For all other options, see the install command above.

Display the current selected version and/or implementation of all mediators.

mediator

Display the current selected version and/or implementation of only the specified mediators.

-F format

Specify an alternative output format. The value of format can be tsv (Tab Separated Values), json (JavaScript Object Notation as a single line), or json-formatted (JavaScript Object Notation, formatted for readability).

-H

Omit the headers from the listing.

-a

List the mediations that can be set for currently installed packages.

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

-I implementation

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 (@).

-V version

Set the version of the mediated interface to use.

If the specified mediator version and/or implementation is not currently available, any links using the specified mediators are removed. If, during an update, the mediated link target is removed, a warning will be produced indicating this. If the update had created a new boot environment, the boot environment will be left mounted and not activated.

For all other options, see the install command above.

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

-I

Revert only the implementation of the mediated interface.

-V

Revert only the version of the mediated interface.

For all other options, see the install command above.

Display the current values of all variants set in this image. See "Facets and Variants" in the pkg(7) man page for more information about variants.

variant_pattern

Display the current values of only the specified variants set in this image.

-F format

Specify an alternative output format. For a description, see the pkg mediator command.

-H

Omit the headers from the listing.

-a

Display all variants explicitly set in the image and all variants that are listed in installed packages. The -a option cannot be combined with the -i option.

-i

Display all variants that are listed in installed packages. The -i option cannot be combined with the -a option.

-v

Display the possible variant values that can be set for installed packages. The -v option can be combined with the -a or -i options.

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

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

For descriptions of the options, see the install command above.

Display the current values and source of all facets that either have been set locally in this image by using the pkg change-facet 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 pkg(7) man page for more information about facets.

facet_pattern

Display the current values of only the specified facets set in this image.

-F format

Specify an alternative output format. For a description, see the pkg mediator command.

-H

Omit the headers from the listing.

-a

Display all facets explicitly set in the image and all facets that are listed in installed packages. The -a option cannot be combined with the -i option.

-i

Display all facets that are listed in installed packages. The -i option cannot be combined with the -a option.

-m

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 pkg change-facet command) that are hidden by an inherited facet with the same name.

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.

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

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

For dscriptions of the options, see the install command above.

Display each avoided package along with any packages that have a group dependency on that package.

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

pkg_fmri_pattern

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.

Display the list of avoided packages.

pkg_fmri_pattern

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

Display information about currently frozen packages: package names, versions, when the package was frozen, and any associated reasons for freezing the packages.

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

pkg_fmri_pattern

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.

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

-c reason

Record the reason with the packages that are frozen. The reason is shown if a freeze prevents an installation or update from succeeding.

-n

Perform a trial run of the freeze operation, displaying the list of packages that would be frozen without freezing any packages.

Display information about currently frozen packages: package names, versions, when the package was frozen, and any associated reasons for freezing the packages.

pkg_fmri_pattern

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

-n

Perform a trial run of the unfreeze operation, displaying the list of packages that would be unfrozen without unfreezing any packages.

Set or unset flags on installed packages as specified by the options shown below.

pkg_fmri_pattern

Set or unset the flag on the specified installed packages. Any versions provided are ignored.

-m

Flag the package as manually installed.

-M

Remove the manually installed flag from the package.

Clean the downloaded package content cache. To automatically clear the content cache after each successful image-modifying operation, see flush-content-cache-on-success in IMAGE PROPERTIES below.

-v

Produce verbose output.

Display the names and values of all image properties. See Image Properties below for descriptions of image properties.

propname

Display the names and values for only the specified properties.

-H

Omit the headers from the listing.

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

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

Remove a value from an existing image property.

Remove an existing image property or properties.

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 -F tsv option or specify the publisher name argument. Proxies shown by the pkg publisher command were set by using the --proxy option of the pkg set-publisher command. Proxies set by using an http_proxy environment variable are not shown by the pkg publisher command.

publisher

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.

-F format

Specify an alternative output format. The value of format can only be tsv (Tab Separated Values).

-H

Omit the headers from the listing.

-P

Display only the first publisher in the publisher search order.

-n

Display only enabled publishers.

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.

-G origin_to_remove | --remove-origin origin_to_remove

Remove the URI or path from the list of origins for the given publisher. The special value * can be used to remove all origins.

-M mirror_to_remove | --remove-mirror mirror_to_remove

Remove the URI from the list of mirrors for the given publisher. The special value * can be used to remove all mirrors.

-O origin_to_set | --origin-uri origin_to_set

Remove all existing origins for the given publisher and set a single new one. If a client SSL key/certificate is configured and the new origin transport is https, then the SSL information will be retained in the publisher.

-r

Run this operation in the global zone and also in all installed linked non-global zones. The effect on the non-global zone is similar to logging into each non-global zone and running the command directly.

-z zonename

Run this operation only in the specified non-global zone. The -z option can be specified multiple times. The -z option can only be used with the -r option. The -z option cannot be used with the -Z option.

-Z zonename

Run this operation in all non-global zones except for the specified zone. The -Z option can be specified multiple times. The -Z option can only be used with the -r option. The -Z option cannot be used with the -z option.

-P | --search-first

Set the specified publisher first in the search order. When installing new packages, this publisher is searched first. Updates to already installed packages come from the same publisher that originally provided the package as long as that publisher remains sticky.

-c ssl_cert

Specify the client SSL certificate.

-d | --disable

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

-e | --enable

Enable the publisher.

-g origin_to_add | --add-origin origin_to_add

Add the specified URI or path as an origin for the given publisher. This should be the location of a package repository or archive. If combined with --enable or --disable, the origins will be enabled or disabled as specified. In this case, * can be used to enable or disable all origins.

-k ssl_key

Specify the client SSL key.

-m mirror_to_add | --add-mirror mirror_to_add

Add the URI as a mirror for the given publisher.

--add-property-value name=value

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

--approve-ca-cert path-to-CA

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 pkg publisher command.

--no-refresh

Do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages and other metadata.

--non-sticky

Higher ranked publishers than this one can provide updates to packages originally installed from this publisher.

--proxy proxy_to_use

Use the specified proxy URI to retrieve content for the specified origin ( (-g) or mirror (-m). 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 proxy_to_use value cannot have the form protocol://user:password@host.

At run time, http_proxy or related environment variables override this proxy setting. See the "Environment" section of the curl(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 svc:/application/pkg/system-repository SMF service to the same value.

--remove-property-value

Remove a value from an existing publisher property.

--reset-uuid

Choose a new unique identifier that identifies this image to its publisher.

--revoke-ca-cert CA_hash

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 pkg publisher command.

--search-after publisher

Alter the publisher search order so that the publisher being added or modified is searched after the publisher specified in this option.

--search-before publisher

Alter the publisher search order so that the publisher being added or modified is searched before the publisher specified in this option.

--set-property name=value

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

--sticky

Updates to packages that were installed from this publisher must also come from this publisher. This is the default behaviour.

--unset-ca-cert CA_hash

For verifying signed packages, remove the certificate with the given hash from the list of approved certificates and the list of revoked certificates.

--unset-property name

Remove an existing publisher property.

-v

Issue verbose progress messages during the requested operation.

Retrieve publisher configuration information from the repo_uri repository URI.

If a publisher operand is specified to this set-publisher subcommand, then only that publisher is added or updated. If no publisher is specified, all publishers in repo_uri are added or updated as appropriate.

For descriptions of options, see the set-publisher command above. When used with -p, the -P, --search-first, --search-before, and --search-after options only apply to added publishers, not to updated publishers.

The -p option cannot be combined with the -g, --add-origin, -G, --remove-origin, -m, --add-mirror, -M, --origin-uri, -O, --remove-mirror, --disable, --enable, --no-refresh, or --reset-uuid options.

Remove the configuration associated with the specified publisher or publishers.

Display the command history of the applicable image. Display the start time of the operation, the name of the operation (for example install), the client (for example, pkg), and the outcome of the operation (Succeeded or Failed).

-H

Omit the headers from the listing.

-l

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 update, complete FMRIs of changed packages are shown.

-N

Display the release note text.

-n number

Display only the specified number of most recent entries.

-o column

Display output using the specified column names. The -o option can be specified multiple times, or multiple column names can be specified as the argument to one -o option by separating the column names with commas.

Valid column names are:

be

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

be_uuid

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

client

The name of the client.

client_ver

The version of the client.

command

The command line used for this operation.

finish

The time that this operation finished.

id

The user id that started this operation.

new_be

The new boot environment created by this operation.

new_be_uuid

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

operation

The name of the operation.

outcome

A summary of the outcome of this operation.

reason

Additional information on the outcome of this operation.

release_note

Indicates whether this operation generated release notes.

snapshot

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

start

The time that this operation started.

time

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

user

The username that started this operation.

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

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

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

-t time | -time-time

Display log records for a comma-separated list of timestamps, formatted with %Y-%m-%dT%H:%M:%S (see the strftime(3C) man page). To specify a range of times, use a hyphen (-) between a start and finish timestamp. The keyword now can be used as an alias for the current time. 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.

Delete all existing history information.

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

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 pkg(7) system.

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

Display a usage message.

At the location given by dir, create an image suitable for package operations. Images created by using the image-create subcommand are not bootable. Most users should use the --be-name or --require-new-be options with pkg commands, or use the beadm(8) or zoneadm(8) commands to create images. The pkg image-create command is used for tasks such as maintaining packages and operating system distributions.

The default image type is user, which can be specified by using the -U or --user option. Alternatively, the image type can be set to a full image (-F or --full) or to a partial image (-P or --partial) linked to the full image enclosing the given dir path.

Additional origins can be specified using -g or --origin. Additional mirrors can be specified using -m or --mirror.

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

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

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

-f | --force

Force the creation of an image over an existing image. This option should be used with care.

--facet name=(True|False)

Set the specified facet to the indicated value. See "Facets and Variants" in the pkg(7) man page for more information about facets.

--no-refresh

Do not attempt to contact the repositories for the image's publishers to retrieve the newest list of available packages and other metadata.

--set-property name=value

Set the specified image property to the indicated value. See Image Properties below for descriptions of image properties.

--variant name=value

Set the specified variant to the indicated value. See "Facets and Variants" in the pkg(7) man page for more information about variants.

Remove all non-editable packaged files and packaged hardlinks from the image specified by the -R option to create a fully dehydrated image. A non-editable packaged file is a file delivered by the currently installed version of a package that has no preserve or overlay attribute, and does not have a dehydrate attribute set to false. A packaged hardlink is a hardlink delivered by the currently installed version of a package.

The pkg dehydrate command only operates on an alternate root. Use the -R option to specify the alternate root. If the alternate root belongs to a boot environment, dehydration will render it unbootable.

If the pkg dehydrate command succeeds, a property named dehydrated with the value of all publishers with a configured package repository is set on the image specified by the -R option.

All other packaging operations for a dehydrated publisher will be automatically dehydrated.

-p publisher

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.

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.

If the pkg dehydrate command succeeds, a property named dehydrated with the names of the publishers as the value is set on the image.

For all other options, see the install command above.

Reinstall all files and hardlinks removed by the pkg dehydrate command.

The pkg rehydrate command only operates on an alternate root. Use the -R option to specify the alternate root.

If the pkg rehydrate command succeeds, the value of the dehydrated property of the image is removed.

-p publisher

Reinstall all files and hardlinks removed by the pkg dehydrate command for the specified publishers.

If one or more publishers is specified, and if any of the publishers is not configured in the image, then nothing is installed.

If the pkg rehydrate command succeeds, the specified publisher names are removed from the value of the dehydrated property set on the image.

For all other options, see the install command above.