pkgparam Command

Purpose

Displays package parameter values.

Syntax

To Display the Value of a Parameter Contained in pkginfo

pkgparam [ -v] [ -d Device] [ -P path ] Pkginst [ Param ...]

To Display the Value of a Parameter Contained in a Device

pkgparam -d Device [ -v] [ Param ...]

To Display the Value of a Parameter Contained in a File

pkgparam -f File [ -v] [ Param ...]

Description

pkgparam Displays the value that is associated with the parameter or parameters that are requested on the command line. The values are located in one of the following places: in the pkginfo file for Pkginst, on the Device named with the -d flag, or on the specific file named with the -f flag. When a Device is given, but a Pkginst is not (as shown in the second synopsis), parameter information for all packages residing on Device is shown.

If packages are installed in an alternative root directory path by using the pkgadd command with the -P option, package parameters can be requested by using the same alternative root directory path that is specified with the -P option.

One parameter value is shown per line. Only the value of a parameter is given unless the -v flag is used. With this flag, the output of the command is in this format:

   Parameter1='Value1'
   Parameter2='Value2'
   Parameter3='Value3'

If no parameters are specified on the command line, values for all parameters that are associated with the package are shown.

Flags

Table 1. Flags
Item	Description
-v	Specifies a verbose mode. Displays the name of the parameter and its value.
-d `Device`	Specifies the `Device` on which a `Pkginst` is stored. `Device` can be the full pathname to a directory (such as /var/tmp), or `"-"` which specifies packages in datastream format that is read from standard input.
-f	Requests that the command read `File` for parameter values. This file must be in the same format as a pkginfo file. As an example, such a file might be created during package development and used while testing software during this stage.
`Pkginst`	Defines a specific package for which parameter values must be displayed. The format `Pkginst.` can be used to indicate all instances of a package. When using this format, enclose the command line in single quotation marks to prevent the shell from interpreting the `` character.
`Param`	Defines a specific parameter whose value must be displayed.
-P `path`	Searches for the pkginfo file in the alternative root directory path.

Exit Status

If parameter information is not available for the indicated package, the command exits with a non-zero status.

Table 2. Exit Status
Item	Description
0	Successful completion of script.
1	Fatal error. The installation process is terminated.

Files

Table 3. Files
Item	Description
/var/spool/pkg	Default spool directory
/usr/sbin/pkgparam	Contains the pkgparam command.