HP OpenVMS System Management Utilities Reference Manual


Previous Contents Index

The ABOVE, BELOW, MINIMUM, and MAXIMUM keywords can be used alone or in combination. For example, /SPAN_VERSIONS= (MINIMUM=V2.1,BELOW=V3.0) selects versions greater than or equal to V2.1 and less than (but not including) V3.0. Using the MAXIMUM keyword instead of BELOW would select versions that include V3.0.

/VERSION=version-number

Selects software products that have the specified version.

Example


$ PRODUCT LIST TEST /SELECT=TEST.* /SOURCE=[AL]
      

In this example, PCSI lists all the files that match the selection criteria TEST.* from the kit of the product TEST that is in the [AL] directory on the user's default disk.

PACKAGE

Creates a software product kit that can be installed by using the PRODUCT INSTALL command.

Format

PRODUCT PACKAGE product-name[,...] [/qualifiers] /SOURCE=file-specification /DESTINATION=device-name[:directory-name] /MATERIAL=(path-name[,...])


Description

The PRODUCT PACKAGE command collects input from the source and material directories and creates the product kit in the destination directory. The source directory contains the required product description file (PDF) and an optional product text file (PTF) that the kit developer provides. The material directories contain the executable images and other files that make up the product. In addition, any command procedures that the product developer supplies to perform product specific installation tasks are in the material directories.

During a package operation, the PCSI utility stores the PDF and PTF in the kit in a modified format. Comments are removed from the PDF and information is added such as the size of each installed file. The PTF file is converted to text library format and given a file type of .PCSI$TLB.

The PRODUCT PACKAGE command can create a product kit in either sequential or reference format. To create a kit in compressed format, first enter the PRODUCT PACKAGE command to create a kit in sequential format. Then enter the PRODUCT COPY command to convert this sequential kit to a kit in compressed format.

The PRODUCT PACKAGE command requires the /SOURCE, /DESTINATION, and /MATERIAL qualifiers.


Parameter

product-name

Names the product or list of products to be packaged.

Qualifiers

/BASE_SYSTEM=base-system-name

Selects software products whose base system matches the one specified. The base system name identifies both a hardware platform and an operating system. Standard names are:
Name Description
AXPVMS Denotes an OpenVMS Alpha product.
I64VMS Denotes an OpenVMS I64 product.
VAXVMS Denotes an OpenVMS VAX product.
VMS Indicates a product that can be installed on more than one OpenVMS platform.

/COPY(default)

/NOCOPY

Specifies whether you want the product material files and associated directories included in the product kit when you are producing a kit in reference format. The /NOCOPY qualifier can save file processing time when you are debugging a PDF file and do not need to produce a complete product kit.

The /NOCOPY and /FORMAT=SEQUENTIAL qualifiers are mutually exclusive.

/DESTINATION=device-name:[directory-name]

Specifies the location where the product kit is to be created.

If /FORMAT=SEQUENTIAL is used, /DESTINATION specifies the directory where the utility creates the sequential kit. A sequential kit is a container file that includes the PDF, PTF, and all the images and other materials that make up the product. The file type of the sequential kit file is .PCSI.

If /FORMAT=REFERENCE is used (or defaulted), /DESTINATION specifies the directory where the utility creates the output PDF file and optional PTF file. The file types of the PDF and PTF files are .PCSI$DESCRIPTION and .PCSI$TLB, respectively. The images and other materials that make up the product are placed in a directory tree under this directory.

If the device name is not provided, the command defaults to the user's default device. If the directory name is omitted, the command defaults to the user's default directory.

The PRODUCT PACKAGE operation ignores the PCSI$DESTINATION logical name whether or not you use the /DESTINATION qualifier.

/FORMAT=keyword

Specifies the output format of the product kit. Keywords are:
REFERENCE Reference format in which product files are placed in a directory tree for direct access. The utility creates a product description file, with a file type of .PCSI$DESCRIPTION, in the top level of the directory tree.
SEQUENTIAL Sequential format in which product files are placed in a container file having a .PCSI file type.
The default is /FORMAT=REFERENCE.

You cannot use the PRODUCT PACKAGE command to create a kit in compressed format. Instead, use the PRODUCT COPY command to convert a kit in sequential format to a kit in compressed format.

/LOG

/NOLOG (default)

Displays the file specifications of the files that are packaged in the product kit and the name of the product kit file.

/OPTIONS=keyword

/NOOPTIONS (default)

Specifies PRODUCT command options. The keyword is:
NOCONFIRM Omits the confirmation dialog that asks the user to verify the products that have been selected for the operation.

/MATERIAL=(path-name[,...])

Specifies one or more locations in which the utility can search for product material files to include in the software product kit. Material files represent the output of the producer's software engineering process, that is, all files that make up the software product, including any command procedures that might be used during installation.

Note that the location of the PDF and PTF are not specified with the /MATERIAL qualifier. See the /SOURCE qualifier for more information.

This is a required qualifier for the PRODUCT PACKAGE command. Parentheses (()) are optional only when you specify a single path name. They are required when you specify multiple path names.

The format for path-name is: device-name:[directory-name]

You can specify path-name as a:
Specific directory Only one directory is searched.
Wildcard directory The directory name includes one or more of the wildcard characters asterisk (*), percent sign (%), or ellipsis (...). All directories that satisfy the wildcard specification are searched.
Root directory A period (.) following the directory name indicates a root directory specification. For example, TEST$:[ABC.FT2.] is combined with the relative file specification from the FILE statement in the PDF to locate the file during packaging.

When the path-name contains a root directory, the utility appends the relative file specification from the FILE statement in the PDF to the root directory to determine where to find the file. However, when either a specific directory or a wildcard directory is used in the path-name, the relative file specification from the FILE statement is not used to find the file. Instead, the directory as specified in the /MATERIAL qualifier is used to search for the file.

Note that when you use either a wildcard directory or a list of path names, if files in different directories have the same name, only the first file in the search path is packaged in the kit. As a result, the same file is packaged each time a FILE statement refers to the file name because the relative file specification is not used to identify the file uniquely. Therefore, if your product has different files with the same name in different directories, you must use the root directory form of the path-name to package these files correctly.

In general, using a specific directory or a root directory is more efficient than a wildcard directory. When packaging a product that contains hundreds of files, you might notice a significant difference in processing time, depending on the method you use to specify the path name. The choice of material path name does not affect the time required to install the kit.

/OWNER_UIC=uic

Specifies the owner user identification code (UIC) for files created during a copy operation. By default, the user executing the operation owns the software product files. For example, if you are logged in to your own account, you can use this qualifier during a copy operation to assign ownership of the product files to SYSTEM rather than to your own account. Specify the UIC in alphanumeric format (in the form [name]) or in octal group-member format (in the form [g,m]). UIC formats are described in the OpenVMS User's Manual.

/PRODUCER=producer-name

Selects software products that the specified manufacturer produces.

/SOURCE=file-specification

Specifies the location of the input PDF file. If the device name is omitted, it defaults to the user's default device. If the directory name is omitted, it defaults to the user's default directory. If the file name and file type components of the file specification are not provided, they default to <full-product-name>.PCSI$DESCRIPTION.

The optional PTF file, if used, must be in the same directory and have the same file name as the PDF with a .PCSI$TEXT file type. If a file named <full-product-name>.PCSI$TEXT is not found, the package operation does not use a PTF file.

This is a required qualifier for the PRODUCT PACKAGE command. The logical name PCSI$SOURCE is not used.

/VERSION=version-number

Selects software products that have the specified version.

Example


$ PRODUCT PACKAGE VIEWER - 
_$ /PRODUCER=ABC /BASE_SYSTEM=AXPVMS -
_$ /FORMAT=SEQUENTIAL /LOG -
_$ /SOURCE=BUILD$:[TEST.PDF] -
_$ /DESTINATION=DKA200:[PCSI_KITS] -
_$ /MATERIAL=BUILD$:[TEST.VIEWER0201]
 
      

The directory [TEST.PDF] contains the PDF and PTF named ABC-AXPVMS-VIEWER-0201-1.PCSI$DESC and ABC-AXPVMS-VIEWER-0201-1.PCSI$TEXT, respectively. These files and the product material files from the BUILD$:[TEST.VIEWER0201] directory are used to create the kit for product VIEWER. When the PRODUCT PACKAGE command completes, a sequential kit named ABC-AXPVMS-VIEWER-0201-1.PCSI is created and placed in the DKA200:[PCSI_KITS] directory.

The material path-name can be specified using a wildcard format such as the following:


   /MATERIAL=BUILD$:[TEST.VIEWER0201...] 

In this case, the entire directory tree is searched to find the product files to package.

The material path-name can also be specified in root directory format such as the following:


   /MATERIAL=BUILD$:[TEST.VIEWER0201.] 

In this case, each FILE statement in the PDF refers to a specific subdirectory. For example, if the FILE statement contains the relative file specification [DOC]CHAPTER1.HTML, the package operation looks up the file in BUILD$:[TEST.VIEWER0201.DOC]CHAPTER1.HTML. Using a root directory in the path-name allows more than one file named CHAPTER1.HTML to be in different subdirectories.

RECONFIGURE

Modifies the configuration of an installed product by allowing a user to change installation options.

Format

PRODUCT RECONFIGURE product-name[,...] [/qualifiers]


Description

Reconfiguration of a product might result in the addition or deletion of files, or both, depending on the user's selection or deselection of options; that is, users can select options that were not selected when the product was installed, or they can deselect options that were selected when the product was installed. At the conclusion of the operation, the product database is updated to reflect the changes.

Access to the original software product kit that was used to install the product is required to perform the reconfigure operation.


Parameter

product-name

Names the product, or list of products, to reconfigure.

Qualifiers

/BASE_SYSTEM=base-system-name

Selects software products whose base system matches the one specified. The base system name identifies both a hardware platform and an operating system. Standard names are:
Name Description
AXPVMS Denotes an OpenVMS Alpha product.
I64VMS Denotes an OpenVMS I64 product.
VAXVMS Denotes an OpenVMS VAX product.
VMS Indicates a product that can be installed on more than one OpenVMS platform.

/CONFIGURATION=(keyword[,...])

Specifies how the configuration choices are used. Keywords are:
CURRENT Uses values from the product database. These values are the configuration choices made when the product was installed or reconfigured.
PRODUCER Uses values specified by the software manufacturer of the product.
INPUT=pcf-name Uses values from the specified product configuration file.
OUTPUT=pcf-name Writes configuration choices to the specified product configuration file. If no file name is supplied, creates a file named DEFAULT.PCSI$CONFIGURATION in the current default directory.

The keywords CURRENT, PRODUCER, and INPUT are mutually exclusive. (CURRENT is the default if none of these keywords is specified.)

The OUTPUT keyword can be used with the CURRENT, PRODUCER, or INPUT keyword.

If you specify only one keyword, you can omit the parentheses.

/DEBUG

/NODEBUG (default)

Specifies options useful to the product kit developer during kit testing. Keywords are:
CONFLICT_DATA Displays supplemental information about file and module conflict resolution. This includes the generation numbers used in the comparison, whether the object is retained or replaced, and the name of the product that supplies the object.

Use /DEBUG=CONFLICT_DATA in conjunction with the /LOG qualifier to display all information about conflict resolution. For more information, see the POLYCENTER Software Installation Utility Developer's Guide.

/HELP

/NOHELP (default)

Controls whether detailed explanations of product options and informational text are displayed. The first time you install a product, these explanations can help you decide which options to select. When you perform subsequent installations or upgrades, you might choose the brief explanations to save time.

When /NOHELP is selected, you can request a detailed explanation about a question by performing one of the following actions at the prompt:

/KIT_ATTRIBUTES=keyword([,...])

Selects kits by kit type or kit format, or both. Keywords are:
FORMAT=
format-type
Designates the format of the product kit as follows:
   
COMPRESSED Compressed format in which a data compression technique has been applied to a sequential kit. A compressed kit has a .PCSI$COMPRESSED file type.
REFERENCE Reference format in which product files exist in a directory tree. A .PCSI$DESCRIPTION file in the top level of the directory tree denotes a reference kit.
SEQUENTIAL Sequential format in which product files are placed in a container file. A file type of .PCSI indicates a sequential kit.
TYPE=
kit-type
Specifies the type of product kit as follows:
FULL Layered product (application) software.
OPERATING_SYSTEM Operating system software.
PARTIAL An upgrade to currently installed software. Installation of this kit changes the version of the product.
PLATFORM An integrated set of software products (also called a product suite).

/LOG

/NOLOG (default)

Displays the file specification of each file processed. When logging is enabled, messages notify you whenever product files, libraries, directories, recovery data files, and product database files are created, deleted, or modified. Information about any file and module conflict resolution is also provided.

/OPTIONS=(keyword[,...])

/NOOPTIONS (default)

Specifies PRODUCT command options. The keywords are:
NOCONFIRM Omits the confirmation dialog that asks the user to verify the products that have been selected for the operation.

The NOCONFIRM and NODEFAULT_KIT keywords are mutually exclusive.

NODEFAULT_KIT Directs the utility to query the user instead of choosing a default kit when more than one kit that matches the selection criteria for the product is found in the source directory path. The selection criteria include the producer, base system, product name, and product version strings that are embedded in the file name of a kit.

If multiple kits are found for a selected product, and NODEFAULT_KIT is not specified, the utility determines the default kit to use by applying the following rules:

  1. The last character of the kit's file name (1-7) is used to order the kits by kit type. In descending order, the precedence is as follows: full, operating system, partial, patch, platform, transition, and mandatory update.
  2. The file type is used to order the kits by format. In descending order, the precedence is as follows: compressed (.PCSI$COMPRESSED), sequential (.PCSI), and reference (.PCSI$DESCRIPTION).
  3. If multiple kits are found with the same file name and file type, but differ in their directory path names, the case of their file specifications, or their file versions, then the first file found by RMS search rules takes precedence.

The NODEFAULT_KIT and NOCONFIRM keywords are mutually exclusive.

NOVALIDATE_KIT Disables validation of software product kits that are signed and have a manifest file in the source directory.

The NOVALIDATE_KIT and SIGNED_KIT keywords are mutually exclusive.

SHOW_DISK_USAGE Displays estimated disk block usage. Both peak utilization and net change are shown in addition to the amount of free space available before and after the operation.
SIGNED_KIT Requires all software product kits selected for the operation to be signed kits that have passed validation; otherwise, the operation is not performed.

The SIGNED_KIT and NOVALIDATE_KIT keywords are mutually exclusive.

/PRODUCER=producer-name

Selects software products that the specified manufacturer produces.

/RECOVERY_MODE (default)

/NORECOVERY_MODE

Enables or disables product reconfiguration in recovery mode. The directories, files, and libraries that are modified or deleted in the reconfiguration process are saved in a directory tree on the system disk unless you specify /NORECOVERY_MODE. These files, along with a copy of the product database, comprise the recovery data set.

The recovery data set is handled somewhat differently when a reconfiguration ends successfully or if it terminates unsuccessfully.

/REMARK=string

Records a comment in the product database about the task you are performing. The PRODUCT SHOW HISTORY command displays the recorded comments. For each product, PCSI stores a chronological list of tasks you perform and the associated remarks. The default behavior is that no remark is recorded.

/REMOTE

/NOREMOTE (default)

Selects the product database located on a privately mounted system disk. By default, PCSI searches the currently booted system disk for the product database.

When you use /REMOTE, the following logical names must be defined:

/SOURCE=device-name:[directory-name]

Specifies the disk and directory where the utility searches for the software product kit or kits. If /SOURCE is not specified, the utility searches in the location defined by the logical name PCSI$SOURCE. If PCSI$SOURCE is not defined, and the /SOURCE qualifier is not specified, PCSI searches the current default directory.

/SPAN_VERSIONS=keyword([,...])

Selects software products whose versions match the specified version criteria. The keywords are:
ABOVE=version Selects versions greater than the version specified
BELOW=version Selects versions less than the version specified
MINIMUM=version Selects versions greater than or equal to the version specified
MAXIMUM=version Selects versions less than or equal to the version specified

The ABOVE, BELOW, MINIMUM, and MAXIMUM keywords can be used alone or in combination. For example, /SPAN_VERSIONS= (MINIMUM=V2.1,BELOW=V3.0) selects versions greater than or equal to V2.1 and less than (but not including) V3.0. Using the MAXIMUM keyword instead of BELOW would select versions that include V3.0.

/TRACE

/NOTRACE (default)

Identifies the creation and deletion of subprocesses and the DCL commands and command procedures submitted to these subprocesses for execution during the processing of the PRODUCT command. Also shows the creation and deletion of scratch directories and temporary files that the PCSI utility provides for the subprocess environment. Any output that DCL produces is also displayed.

This qualifier is primarily a debugging aid for product developers to trace the execution of command procedures included in their product kits. See the POLYCENTER Software Installation Utility Developer's Guide for more information.

/VERSION=version-number

Selects software products that have the specified version.

/WORK=device:[directory]

Specifies the name of the device and directory acting as a temporary work area. By default, temporary files are created in subdirectories of the user's login directory.

Example


$ DEFINE PCSI$SOURCE DKA500:[DWMOTIF.KIT]
$ PRODUCT RECONFIGURE DWMOTIF /VERSION=V1.2-3
 
      

The command in this example enters into a dialog with the user to change the configuration options for the product DECwindows Motif Version 1.2-3.


Previous Next Contents Index