Retrieves a specified file or files.
1 – FILE
Retrieves a user-specified file or files from a software product
kit. The original name of the file is preserved when it is
extracted.
Format
PRODUCT EXTRACT FILE product-name[,...] [/qualifiers]
1.1 – 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.
1.2 – Qualifiers
1.2.1 /BASE_SYSTEM
/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.
1.2.2 /DESTINATION
/DESTINATION=device-name:[directory-name]
Specifies the location where the utility will place all of 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 PRODUCT EXTRACT FILE command ignores the PCSI$DESTINATION
logical name whether or not you use the /DESTINATION qualifier.
1.2.3 /KIT_ATTRIBUTES
/KIT_ATTRIBUTES=keyword([,...])
Selects kits by kit type or kit format, or both. Keywords are:
FORMAT= Designates the format of the product kit as follows:
format-type
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= Specifies the type of product kit as follows:
kit-type
FULL Layered product (application) software.
OPERATING_ Operating system software.
SYSTEM
MANDATORY_ A required correction to currently
UPDATE 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.
1.2.4 /LOG
/LOG
/NOLOG (default)
Displays the file specifications of the files that are extracted
from the kit.
1.2.5 /OPTIONS
/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.
1.2.6 /PRODUCER
/PRODUCER=producer-name
Selects software products that the specified manufacturer
produces.
1.2.7 /SELECT
/SELECT=filename[,...]
Specifies the name of a file, or a list of files, to be extracted
from the specified product 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 extracted from the specified kit or kits.
1.2.8 /SOURCE
/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, PCSI searches the current
default directory.
1.2.9 /SPAN_VERSIONS
/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.
1.2.10 /VERSION
/VERSION=version-number
Selects software products that have the specified version.
1.3 – Example
$ PRODUCT EXTRACT FILE TEST /SELECT=TEST.EXE /SOURCE=[AL]
In this example, PCSI extracts the file TEST.EXE from the 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.
2 – PDF
Retrieves the product description file (PDF) from a
software product. The file type of the extracted PDF file is
.PCSI$DESCRIPTION.
You can obtain the PDF from the software product kit or, if the
product is already installed, from the product database.
Format
PRODUCT EXTRACT PDF product-name[,...] [/qualifiers]
2.1 – Parameter
product-name
Names the product, or list of products, whose PDF file is to be
retrieved from the kit.
2.2 – Qualifiers
2.2.1 /BASE_SYSTEM
/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.
2.2.2 /DESTINATION
/DESTINATION=device-name:[directory-name]
Specifies the location where the utility will 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
The PRODUCT EXTRACT PDF command ignores the PCSI$DESTINATION
logical name whether or not you use the /DESTINATION qualifier.
2.2.3 /FROM
/FROM=keyword
Specifies whether the PDF is to be extracted from a product kit
or from the product database if the product is already installed.
Keywords are the following:
KIT Extract the PDF file from a product kit. This is the
default.
PDB Extract the PDF file of an installed product from the
product database.
The /FROM=PDB and /SOURCE qualifiers are mutually
exclusive.
2.2.4 /KIT_ATTRIBUTES
/KIT_ATTRIBUTES=keyword([,...])
Selects kits by kit type or kit format, or both. Keywords are:
FORMAT= Designates the format of the product kit as follows:
format-type
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= Specifies the type of product kit as follows:
kit-type
FULL Layered product (application) software.
OPERATING_ Operating system software.
SYSTEM
MANDATORY_ A required correction to currently
UPDATE 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.
2.2.5 /LOG
/LOG
/NOLOG (default)
Displays the file specification of the product description file
that is created.
2.2.6 /OPTIONS
/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.
2.2.7 /PRODUCER
/PRODUCER=producer-name
Selects software products that the specified manufacturer
produces.
2.2.8 /SOURCE
/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, PCSI searches the current
default directory.
The /SOURCE and /FROM=PDB qualifiers are mutually exclusive.
2.2.9 /SPAN_VERSIONS
/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.
2.2.10 /VERSION
/VERSION=version-number
Selects software products that have the specified version.
2.3 – Example
$ PRODUCT EXTRACT PDF TEST /SOURCE=[AL]
In this example, PCSI extracts the product description file
(PDF) from the 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.
3 – PTF
Retrieves the product text file (PTF) from a software product
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]
3.1 – Parameter
product-name
Names the product, or list of products, whose PTF file is to be
retrieved from the kit.
3.2 – Qualifiers
3.2.1 /BASE_SYSTEM
/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.
3.2.2 /DESTINATION
/DESTINATION=device-name:[directory-name]
Specifies the location where the utility will 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
The PRODUCT EXTRACT PTF command ignores the PCSI$DESTINATION
logical name whether or not you use the /DESTINATION qualifier.
3.2.3 /KIT_ATTRIBUTES
/KIT_ATTRIBUTES=keyword([,...])
Selects kits by kit type or kit format, or both. Keywords are:
FORMAT= Designates the format of the product kit as follows:
format-type
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= Specifies the type of product kit as follows:
kit-type
FULL Layered product (application) software.
OPERATING_ Operating system software.
SYSTEM
MANDATORY_ A required correction to currently
UPDATE 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.
3.2.4 /LOG
/LOG
/NOLOG (default)
Displays the file specifications of the product text and product
text library files that are created.
3.2.5 /OPTIONS
/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.
3.2.6 /PRODUCER
/PRODUCER=producer-name
Selects software products that the specified manufacturer
produces.
3.2.7 /SOURCE
/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, PCSI searches the current
default directory.
3.2.8 /SPAN_VERSIONS
/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.
3.2.9 /VERSION
/VERSION=version-number
Selects software products that have the specified version.
3.3 – Example
$ PRODUCT EXTRACT PTF TEST /SOURCE=[AL]
In this example, PCSI extracts the product text file (PTF)
from the 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.
4 – RELEASE_NOTES
Retrieves the release notes for the selected product or group of
products. The name of each release notes file is preserved unless
you override it with the /FILE qualifier.
Format
PRODUCT EXTRACT RELEASE_NOTES product-name[,...] [/qualifiers]
4.1 – Parameter
product-name
Names the product, or list of products, from which to extract
release notes.
4.2 – Qualifiers
4.2.1 /BASE_SYSTEM
/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.
4.2.2 /DESTINATION
/DESTINATION=device-name:[directory-name]
Specifies the location where the utility will place the extracted
release notes files. 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 PRODUCT EXTRACT RELEASE_NOTES command ignores the
PCSI$DESTINATION logical name whether or not you use the
/DESTINATION qualifier.
The /DESTINATION and /FILE qualifiers are mutually exclusive.
4.2.3 /FILE
/FILE=filespec
Specifies the name of the output file that will contain the
release notes. If no file name is given, the original name of
the release notes file is preserved and the file is written to
your default directory.
The /FILE qualifier has been superseded by /DESTINATION. VSI
recommends that you use /DESTINATION in command procedures and
operator instructions. See the description of /DESTINATION for
more information.
The /FILE and /DESTINATION qualifiers are mutually exclusive.
4.2.4 /KIT_ATTRIBUTES
/KIT_ATTRIBUTES=keyword([,...])
Selects kits by kit type or kit format, or both. Keywords are:
FORMAT= Designates the format of the product kit as follows:
format-type
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= Specifies the type of product kit as follows:
kit-type
FULL Layered product (application) software.
OPERATING_ Operating system software.
SYSTEM
MANDATORY_ A required correction to currently
UPDATE 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).
4.2.5 /LOG
/LOG
/NOLOG (default)
Displays the file specification of the release notes file that is
created.
4.2.6 /OPTIONS
/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.
4.2.7 /PRODUCER
/PRODUCER=producer-name
Selects software products that the specified manufacturer
produces.
4.2.8 /SOURCE
/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, PCSI searches the current
default directory.
4.2.9 /SPAN_VERSIONS
/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.
4.2.10 /VERSION
/VERSION=version-number
Selects software products that have the specified version.
4.2.11 /WORK
/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.
4.3 – 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.