Document revision date: 30 March 2001

## OpenVMS System Management Utilities Reference Manual

Previous | Contents | Index

## EXTRACT PTF

> Retrieves the product text file (PTF) from a sequentially formatted software product kit. A file type of .PCSI denotes a sequential kit. The PTF file is stored in a product kit as a text library file. The file type of the extracted PTF is .PCSI$TLB. In addition, a text file version of this text library file is created with a file type of .PCSI$TEXT.

### Format

> PRODUCT EXTRACT PTF product-name[,...] [/qualifiers]

### Parameter

> #### product-name

> Names the product, or list of products, whose PTF file is to be retrieved from the kit.

### 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. The base system name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable to either OpenVMS Alpha or VAX.

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

> Specifies the location where the utility is to place the extracted product text file (PTF). If the device name is not provided, the default is the user's default device. If the directory name is omitted, or the /DESTINATION= qualifier is not specified, the default is the user's default directory. The EXTRACT PTF operation ignores the PCSI$DESTINATION logical name whether or not you use the /DESTINATION qualifier.

> #### /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:
> REFERENCE | Reference format in which product files exist in a directory tree.
> SEQUENTIAL | Sequential format in which product files are placed in <full-product-name>.PCSI, a container file.
> TYPE= kit-type | Specifies the type of product kit as follows:
> FULL | Layered product (application) software.
> OPERATING_SYSTEM | Operating system software.
> MANDATORY_UPDATE | A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
> PARTIAL | An upgrade to currently installed software. Installation of this kit changes the version of the product.
> PATCH | A correction to currently installed software. Installation of this kit does not change the version of the product.
> PLATFORM | An integrated set of software products (also called a product suite).
> TRANSITION | Used to register information about a product that is installed but not recorded in the product database (for example, a product installed by VMSINSTAL). This kit does not provide product material.

> #### /LOG

> #### /NOLOG (default)

> Displays messages as the POLYCENTER Software Installation utility performs an operation.

> #### /PRODUCER=producer-name

> Selects software products that the specified manufacturer produces.

> #### /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 that the logical name PCSI$SOURCE defines. If PCSI$SOURCE is not defined, and the /SOURCE qualifier is not specified, the POLYCENTER Software Installation utility 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.

> #### /VERSION=version-number

> Selects software products that have the specified version.

### Example

    $ PRODUCT EXTRACT PTF TEST /SOURCE=[AL]

> In this example, the POLYCENTER Software Installation utility extracts the product text file (PTF) from the sequential kit of the product TEST that is in the [AL] directory on the user's default disk and places two files in the user's current default directory: the extracted text library file (.PCSI$TLB) and a text file (.PCSI$TEXT) created from the library.

## EXTRACT RELEASE_NOTES

> Retrieves the release notes for the selected product or group of products. If no output file name is given, the release notes are written to a file named DEFAULT.PCSI$RELEASE_NOTES in the user's default directory.

### Format

> PRODUCT EXTRACT RELEASE_NOTES product-name[,...] [/qualifiers]

### Parameter

> #### product-name

> Names the product, or list of products, from which to extract release notes.

### 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. The base system name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable to either OpenVMS Alpha or VAX.

> #### /FILE=filespec

> Specifies the name of the output file that will contain the release notes. If no file name is given, the release notes are written to a file named DEFAULT.PCSI$RELEASE_NOTES in the current directory.

> #### /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:
> REFERENCE | Reference format in which product files exist in a directory tree.
> SEQUENTIAL | Sequential format in which product files are placed in <full-product-name>.PCSI, a container file.
> TYPE= kit-type | Specifies the type of product kit as follows:
> FULL | Layered product (application) software.
> OPERATING_SYSTEM | Operating system software.
> MANDATORY_UPDATE | A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
> PARTIAL | An upgrade to currently installed software. Installation of this kit changes the version of the product.
> PATCH | A correction to currently installed software. Installation of this kit does not change the version of the product.
> PLATFORM | An integrated set of software products (also called a product suite).
> TRANSITION | Used to register information about a product that is installed but not recorded in the product database (for example, a product installed by VMSINSTAL). This kit does not provide product material.

> #### /LOG

> #### /NOLOG (default)

> Displays messages as the POLYCENTER Software Installation utility performs the operation.

> #### /PRODUCER=producer-name

> Selects software products that the specified manufacturer produces.

> #### /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 that the logical name PCSI$SOURCE defines. If PCSI$SOURCE is not defined, and the /SOURCE qualifier is not specified, the POLYCENTER Software Installation utility 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.

> #### /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

    $ PRODUCT EXTRACT RELEASE_NOTES XYZ /VERSION=2.3/FILE=[RN]XYZ.TXT

> The command in this example places the release notes for Version 2.3 of the product XYZ in a file named [RN]XYZ.TXT on your current default device.

## FIND

> Displays the names of software product kits located in the specified directory.

### Format

> PRODUCT FIND product-name[,...] [/qualifiers]

### Parameter

> #### product-name

> Names the product, or list of products to find.

### 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. The base system name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable to either OpenVMS Alpha or VAX.

> #### /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:
> REFERENCE | Reference format in which product files exist in a directory tree.
> SEQUENTIAL | Sequential format in which product files are placed in <full-product-name>.PCSI, a container file.
> TYPE= kit-type | Specifies the type of product kit as follows:
> FULL | Layered product (application) software.
> OPERATING_SYSTEM | Operating system software.
> MANDATORY_UPDATE | A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
> PARTIAL | An upgrade to currently installed software. Installation of this kit changes the version of the product.
> PATCH | A correction to currently installed software. Installation of this kit does not change the version of the product.
> PLATFORM | An integrated set of software products (also called a product suite).
> TRANSITION | Used to register information about a product that is installed but not recorded in the product database (for example, a product installed by VMSINSTAL). This kit does not provide product material.

> #### /LOG

> #### /NOLOG (default)

> Displays messages as the POLYCENTER Software Installation utility performs the operation.

> #### /PRODUCER=producer-name

> Selects software products that the specified manufacturer produces.

> #### /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, the POLYCENTER Software Installation utility 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.

> #### /VERSION=version-number

> Selects software products that have the specified version.

### Example

    $ PRODUCT FIND TEST* /BASE_SYSTEM=VAXVMS

> The command in this example searches for all software product kits located in the user's default directory and displays the names of all versions of products whose names begin with "TEST" and are intended to be installed on OpenVMS VAX.

## INSTALL

> Installs one or more software products on your system and updates the product database.

### Format

> PRODUCT INSTALL product-name[,...] [/qualifiers]

### Parameter

> #### product-name

> Names the product, or list of products, to install.

### 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. The base system name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable to either OpenVMS Alpha or VAX.

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

> Specifies how the configuration choices will be supplied. Keywords are:

> CURRENT | This is the default. It uses values from the product database, which has the current values recorded from the last time the product was installed or reconfigured.
> PRODUCER | Uses values specified by the software manufacturer for this version 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.

> The keywords CURRENT, PRODUCER, and INPUT are mutually exclusive. Each of these, however, can be used with the keyword OUTPUT. If you specify only one keyword, you can omit the parentheses.

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

> Specifies a location where the utility will install software product files. If you omit the device name, the utility uses your current default device. If you omit the directory name, the utility uses the [VMS$COMMON] directory as the default directory.

> If you do not use this qualifier to specify a destination, the utility installs the software in the location defined by logical name PCSI$DESTINATION. If this logical name is not defined, the utility installs the software in SYS$SYSDEVICE:[VMS$COMMON], the top-level directory for software product files.

> #### /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:

> - Press the Help key or PF2 key
> - Type ? and press the Return key

> #### /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:
> REFERENCE | Reference format in which product files exist in a directory tree.
> SEQUENTIAL | Sequential format in which product files are placed in <full-product-name>.PCSI, a container file.
> TYPE= kit-type | Specifies the type of product kit as follows:
> FULL | Layered product (application) software.
> OPERATING_SYSTEM | Operating system software.
> MANDATORY_UPDATE | A required correction to currently installed software. Functionally, this type of kit is the same as a patch kit.
> PARTIAL | An upgrade to currently installed software. Installation of this kit changes the version of the product.
> PATCH | A correction to currently installed software. Installation of this kit does not change the version of the product.
> PLATFORM | An integrated set of software products (also called a product suite).
> TRANSITION | Used to register information about a product that is installed but not recorded in the product database (for example, a product installed by VMSINSTAL). This kit does not provide product material.

> #### /LOG

> #### /NOLOG (default)

> Displays messages as the POLYCENTER Software Installation utility performs the operation.

> #### /PRODUCER=producer-name

> Selects software products that the specified manufacturer produces.

> #### /REMARK=string

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

> #### /REMOTE

> #### /NOREMOTE (default)

> Uses the product database on a system other than the currently running system. This qualifier is primarily for use in command procedures that Compaq supplies. Incorrect use of this qualifier can corrupt the POLYCENTER Software Installation utility database, corrupt installed products, or cause other problems. In some cases, /REMOTE can be useful with the CONFIGURE and SHOW commands.

> Previous | Next | Contents | Index

> | privacy and legal statement |
> 6048PRO_050.HTML