pkgparam Command

Edit online

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 associated with the parameter or parameters 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 using the pkgadd command with the -P option, package parameters can be requested using the same alternative root directory path 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 associated with the package are shown.

Flags

Item	Description
-v	Specifies verbose mode. Displays name of 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 read from standard input.
-f	Requests that the command read File for parameter values. This file should 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 should 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 quotes to prevent the shell from interpreting the "*" character.
Param	Defines a specific parameter whose value should be displayed.
-P path	Searches for the pkginfo file in the alternate root directory path.

Exit Status

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

Item	Description
0	Successful completion of script.
1	Fatal error. Installation process is terminated at this point.

Files

Item	Description
/var/spool/pkg	default spool directory
/usr/sbin/pkgparam	Contains the pkgparam command.