xref: /illumos-gate/usr/src/man/man1/pkgparam.1 (revision d0b12b660e0741581d18f1f3a7d5268e0a5f1806)
te
Copyright 1989 AT&T Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PKGPARAM 1 "Oct 30, 2007"
NAME
pkgparam - display package parameter values
SYNOPSIS

pkgparam [-v] [-d device] [-R root_path] pkginst [param]...

pkgparam -f filename [-v] [param]...
DESCRIPTION

pkgparam displays the value associated with the parameter or parameters requested on the command line. The values are located in either the pkginfo(4) file for pkginst or from the specific file named with the -f option.

One parameter value is shown per line. Only the value of a parameter is given unless the -v option is used. With this option, 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.

OPTIONS

Options and arguments for this command are: -d device

Specify the device on which a pkginst is stored. It can be a directory pathname or the identifiers for tape, floppy disk, or removable disk (for example, /var/tmp, /dev/diskette, and /dev/dsk/c1d0s0). The special token spool may be used to represent the default installation spool directory (/var/spool/pkg).

-f filename

Read filename for parameter values.

-R root_path

Defines the full path name of a subdirectory to use as the root_path. All files, including package system information files, are relocated to a directory tree starting in the specified root_path.

-v

Verbose mode. Display name of parameter and its value.

OPERANDS
pkginst

Defines a specific package instance for which parameter values should be displayed.

param

Defines a specific parameter whose value should be displayed.

ERRORS

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

EXIT STATUS
0

Successful completion.

>0

An error occurred.

SEE ALSO

pkgmk(1), pkgproto(1), pkgtrans(1), pkgadd(1M), pkginfo(4), attributes(5), largefile(5)

Application Packaging Developer's Guide

NOTES

With the -f option, you can specify the file from which parameter values should be extracted. This file should be in the same format as a pkginfo(4) file. For example, such a file might be created during package development and used while testing software during this stage.

Package commands are largefile(5)-aware. They handle files larger than 2 GB in the same way they handle smaller files. In their current implementations, pkgadd(1M), pkgtrans(1) and other package commands can process a datastream of up to 4 GB.