OpenVMS System Management Utilities Reference Manual

CONFIGURE

Creates a product configuration file (PCF) for one or more products. Optionally uses the values in an existing PCF to create the new PCF.

Format

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

PARAMETER

product-name
Names the product, or list of products, for which product configuration files will be generated.

QUALIFIERS

/BASE_SYSTEM=base-system-name
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/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 contains 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 in the current default directory.

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

/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs the operation.
/PRODUCER=producer-name
Performs the operation only on software products that are produced by the specified manufacturer. By default, the operation is performed for all producers.
/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 Digital 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.
When you use /REMOTE, the following logical names must be defined:
PCSI$SYSDEVICE must specify the physical disk name of the target system disk. This disk must be mounted and allocated to the process executing the PRODUCT command.
PCSI$SPECIFIC must point to a system root on PCSI$SYSDEVICE. It must be defined in the following form, where x is a valid system root:
PCSI$SYSDEVICE:[SYSx.] 
Note that the definition of PCSI$SYSDEVICE and PCSI$SPECIFIC specify only where the utility will find or place its database. These logical names do not affect the /DESTINATION qualifier.
/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.
/VERSION=version-number
Performs the operation only on software products that have the specified version. By default, the operation is performed for all versions.

Example

$ PRODUCT CONFIGURE EDITOR - 
_$ /CONFIGURATION=(INPUT=EDITOR_REV1.PCF,OUTPUT=EDITOR_REV2.PCF)

The command in this example reads an existing PCF named EDITOR_REV1.PCF for a product named EDITOR and then saves your changes in EDITOR_REV2.PCF.

COPY

Manipulates a product distribution kit by either creating a sequential copy from a reference copy, creating a reference copy from a sequential copy, or creating a copy without changing the format. You must supply the /DESTINATION qualifier.

Format

PRODUCT COPY product-name/DESTINATION=device-name:[directory-name] [/qualifiers]

PARAMETER

product-name
Names the product, or list of products, to copy.

QUALIFIERS

/BASE_SYSTEM=base-system-name
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/DESTINATION=device-name:[directory-name]
Specifies a location where the utility will place a copy of a sequential kit; for a reference kit, specifies the top-level directory location where the utility will place files. If the device name is not provided, it defaults to the user's default device. If the directory name is omitted, it defaults to the user's default directory.
The PRODUCT COPY 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.

SEQUENTIAL Sequential format in which product files are placed in full-product-name.PCSI, a container file.

The default is to preserve the format of the product kit.
/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs the operation.
/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
Performs the operation only on software products that are produced by the specified manufacturer. By default, the operation is performed for all producers.
/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.
/VERSION=version-number
Performs the operation only on software products that have the specified version. By default, the operation is performed for all versions.

Example

$ PRODUCT COPY ABC/SOURCE=[SHERMAN.ABC] -
_$ /DESTINATION=[KITS]/FORMAT=SEQUENTIAL

The command in this example converts product kit ABC, located in the [SHERMAN.ABC] directory on the user's default device, to a sequential copy in the [KITS] directory on the user's default device.

EXTRACT FILE

Retrieves a user-specified file or files from a sequentially formatted software product kit. A file type of .PCSI denotes a sequential kit. The original name of the file is preserved when it is extracted.

Format

PRODUCT EXTRACT FILE product-name[,...] [/qualifiers]

PARAMETER

product-name
Names the product, or list of products, from whose kits the selected file or files are to be retrieved. This parameter is required.

QUALIFIERS

/BASE_SYSTEM=base-system-name
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/DESTINATION=device-name:[directory-name]
Specifies the location where the utility is to place all the files that the user indicates are to be retrieved. 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 FILE operation ignores the PCSI$DESTINATION logical name whether or not you use the /DESTINATION qualifier.
/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs an operation.
/PRODUCER=producer-name
Performs the operation only on software products that are produced by the specified producers. By default, the operation is performed for all producers.
/SELECT=filename[,...]
Specifies the name of a file, or a list of files, to be extracted from the specified sequential kit. You can use the asterisk (*) and the percent sign (%) wildcard characters for all or part of the file name. The file name can contain a directory specification that includes an ellipsis (...). If you omit this qualifier, all files will be extract from the specified kit or kits.
/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.
/VERSION=version-number
Performs an operation only on the specified version of the software products. By default, the operation is performed on all versions.

Example

$ PRODUCT EXTRACT FILE TEST /SELECT=TEST.EXE /SOURCE=[AL]

In this example, the POLYCENTER Software Installation utility extracts the file TEST.EXE from the sequential kit of the product TEST that is in the [AL] directory on the user's default disk. The extracted file TEST.EXE is placed in the user's current default directory.

EXTRACT PDF

Retrieves the product description file (PDF) from a sequentially formatted software product kit. A file type of .PCSI denotes a sequential kit. The file type of the extracted PDF file is .PCSI$DESCRIPTION.

Format

PRODUCT EXTRACT PDF product-name[,...] [/qualifiers]

PARAMETER

product-name
Names the product, or list of products, whose PDF file is to be retrieved from the kit.

QUALIFIERS

/BASE_SYSTEM=base-system-name
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/DESTINATION=device-name:[directory-name]
Specifies the location where the utility is to place the extracted product description file (PDF). 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 PDF operation ignores the PCSI$DESTINATION logical name whether or not you use the /DESTINATION qualifier.
/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs an operation.
/PRODUCER=producer-name
Performs the operation only on software products that are produced by the specified producers. By default, the operation is performed for all producers.
/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.
/VERSION=version-number
Performs an operation only on the specified version of the software products. By default, the operation is performed on all versions.

Example

$ PRODUCT EXTRACT PDF TEST /SOURCE=[AL]

In this example, the POLYCENTER Software Installation utility extracts the product description file (PDF) from the sequential kit of the product TEST that is in the [AL] directory on the user's default disk and places it in the user's current default directory.

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 is stored in a product kit as a text library file. The file type of the extracted PTF file 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
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/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.
/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs an operation.
/PRODUCER=producer-name
Performs the operation only on the software products of specified producers. By default, the operation is performed for all producers.
/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.
/VERSION=version-number
Performs an operation only on the specified version of the software products. By default, the operation is performed on all versions.

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
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/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.
/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs the operation.
/PRODUCER=producer-name
Performs the operation only on the software products of specified producers. By default, the operation is performed for all producers.
/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.
/VERSION=version-number
Performs the operation only on software products that have the specified version. By default, the operation is performed for all versions.
/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
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs the operation.
/PRODUCER=producer-name
Performs the operation only on the software products of specified producers. By default, the operation is performed for all producers.
/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.
/VERSION=version-number
Performs the operation only on software products that have the specified version. By default, the operation is performed for all versions.

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
Performs the operation only on software products that apply to the named base system. The name AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX. By default, the operation is performed for products with any base system designation.
/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

/LOG

/NOLOG (default)
Displays messages as the POLYCENTER Software Installation utility performs the operation.
/PRODUCER=producer-name
Performs the operation only on the software products of specified producers. By default, the operation is performed for all producers.
/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 Digital 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.
When you use /REMOTE, the following logical names must be defined:
PCSI$SYSDEVICE must specify the physical disk name of the target system disk. This disk must be mounted and allocated to the process executing the PRODUCT command.
PCSI$SPECIFIC must point to a system root on PCSI$SYSDEVICE. It must be defined in the following form, where x is a valid system root:
PCSI$SYSDEVICE:[SYSx.] 
Note that the definition of PCSI$SYSDEVICE and PCSI$SPECIFIC specify only where the utility will find or place its database. These logical names do not affect the /DESTINATION qualifier.
/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.
/TEST (default)

/NOTEST
Requests that the POLYCENTER Software Installation utility run the installation verification procedure (IVP) for the product.
/TRACE

/NOTRACE (default)
Displays all DCL commands that the POLYCENTER Software Installation utility may execute while performing the operation. Any output generated by these commands is also displayed. This qualifier is a debugging aid to trace the execution of DCL commands and command procedures executed in a subprocess.
/VERSION=version-number
Performs the operation only on software products that have the specified version. By default, the operation is performed for all versions.
/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 INSTALL POSIX/VERSION=3.0/CONFIGURATION=OUTPUT=POSIX.PCF

The command in this example installs POSIX Version 3.0 and creates a product configuration file.

  6048P042.HTM
  OSSG Documentation
  26-NOV-1996 12:43:22.42

Legal

CURRENT	This is the default. It uses values from the product database, which contains 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 in the current default directory.

REFERENCE	Reference format in which product files are placed in a directory tree.

SEQUENTIAL	Sequential format in which product files are placed in full-product-name.PCSI, a container file.