HP OpenVMS systems documentation

In this CHESS kit example, the [TEST.KIT] directory contains the following files to package the kit:

• CHESS.PCSI$DESC, the product description file
• CHESS.PCSI$TEXT, the product text file
• PACKAGE.COM, as a convenience

PACKAGE.COM has been created to simplify the task of entering the PRODUCT PACKAGE command with the appropriate qualifiers.

The content of the packaging files for the CHESS product might be similar to the following:

$ TYPE [TEST.KIT]*.* DKA300:[TEST.KIT]CHESS.PCSI$DESC;1 product ABC_CO AXPVMS CHESS V1.0 full ; execute preconfigure "@pcsi$source:[000000]check_space.com" uses [000000]check_space.com interactive ; file [sysexe]chess.exe ; file [sysexe]chess.openings ; option master_games ; file [sysexe]chess.games ; end option ; file [systest]chess_ivp.com ; execute test "@pcsi$destination:[systest]chess_ivp.com" ; end product ; DKA300:[TEST.KIT]CHESS.PCSI$TEXT;1 =product abc_co axpvms chess v1.0 full 1 'PRODUCT =prompt ABC Company's Chess for OpenVMS Alpha Chess V1.0 provides a chess playing engine with 50 selectable user levels (rated playing strength from 1200 to 2450), a graphical interface with 2D and 3D boards, an extensive database of openings, plus thousands of complete master games, and three modes of operation: play, analyze, and tutorial. 1 MASTER_GAMES =prompt Do you want the database of master games? Answer YES to install a database containing 16000 complete games played by GMs and IMs (25000 blocks). Your choice does not affect the quality or size of the opening database which is always installed in its entirety. DKA300:[TEST.KIT]PACKAGE.COM;1 $! This command file packages product CHESS into a sequential format kit. $! $! Note that by default the package command searches for the input PDF and $! input PTF in the source directory using file name and type of: $! <producer-base-product-version-edit-type>.pcsi$desc (for PDF) [1] $! <producer-base-product-version-edit-type>.pcsi$text (for PTF) $! For example: $! abc_co-axpvms-chess-v0100--1.pcsi$desc $! abc_co-axpvms-chess-v0100--1.pcsi$text $! $! You can override this default by specifying the file name of the PDF and $! PTF (and optionally the file type of the PDF) in the /source qualifier $! (for example, /source=dev:[dir]chess.pdf). The file type of the PTF, however, $! must be .pcsi$text. The approach used in this command procedure is $! to specify the file name of the PDF and PTF in the /source qualifier and $! let the file types be defaulted. For example, /source=dev:[dir]chess $! causes the package command to search for input PDF and input PTF named: $! chess.pcsi$desc $! chess.pcsi$text $! $! [1] For OpenVMS V6.1-V7.1, the default input PDF file type was $! .pcsi$description (the same as the output PDF), but beginning with $! OpenVMS V7.1-2, the utility looks for .pcsi$desc; if not found it $! then searches for .pcsi$description. $! $ product package chess - /base=axpvms - /producer=abc_co - /source=dka300:[test.kit]chess - ! where to find PDF and PTF /destination=dka300:[test.kit] - ! where to put .PCSI file /material=dka300:[test.*] - ! where to find product material /format=sequential $ exit

5.3 Creating the Product Kit

The sample output below shows the execution of the PRODUCT PACKAGE command (via a command procedure listed in Section 5.2) to create the product kit in sequential format. The full kit name for CHESS V1.0 produced by ABC_CO to run on OpenVMS Alpha is ABC_CO-AXPVMS-CHESS-V0100--1.PCSI.

$ SET DEFAULT [TEST.KIT] $ @PACKAGE.COM The following product has been selected: ABC_CO AXPVMS CHESS V1.0 Layered Product Do you want to continue? [YES] The following product will be packaged: ABC_CO AXPVMS CHESS V1.0 Portion done: 0%...100% The following product has been packaged: ABC_CO AXPVMS CHESS V1.0 Layered Product $ DIRECTORY /COLUMN=1 /NOTRAILING Directory DKA300:[TEST.KIT] ABC_CO-AXPVMS-CHESS-V0100--1.PCSI;1 CHESS.PCSI$DESC;1 CHESS.PCSI$TEXT;1 PACKAGE.COM;1

5.4 Listing the Contents of the Product Kit

A product kit in sequential format is a container file. You can list its contents with the PRODUCT LIST command. In the following example, note:

• During the packaging operation, the input PTF has been converted to a text library file with a file type of .PCSI$TLB.
• The input PDF with a file type of .PCSI$DESC has been packaged as an output PDF with a file type of .PCSI$DESCRIPTION.
• During the packaging operation, the output PDF has the same format as the input PDF, but comments have been removed and additional information such as file size has been added to the file.

$ PRODUCT LIST CHESS The following product has been selected: ABC_CO AXPVMS CHESS V1.0 Layered Product Do you want to continue? [YES] Product kit in sequential format: _KRYSYS$DKA300:[TEST.KIT]ABC_CO-AXPVMS-CHESS-V0100--1.PCSI -------------------------------------------------------- CONTENTS OF KIT USING RELATIVE FILE SPECIFICATION -------------------------------------------------------- [000000]ABC_CO-AXPVMS-CHESS-V0100--1.PCSI$TLB [000000]CHECK_SPACE.COM [SYSEXE]CHESS.EXE [SYSEXE]CHESS.GAMES [SYSEXE]CHESS.OPENINGS [SYSTEST]CHESS_IVP.COM [000000]ABC_CO-AXPVMS-CHESS-V0100--1.PCSI$DESCRIPTION --------------------------------------------------------

Starting with OpenVMS Version 7.3, you can use the /FULL qualifier with the PRODUCT LIST command. The expanded output lists the following:

• The size of most files.
  Certain files, such as the PDF, PTF, temporary command procedures, and files created at install time with an ASSEMBLE USES option, will not have a file size listed.
• Additional information on certain files in a comments field.

You can extract one or more files from a product kit using the PRODUCT EXTRACT and PRODUCT COPY commands. The PRODUCT EXTRACT command is often used with the PRODUCT LIST command to identify a file or a set of files to extract.

5.5.1 Extracting Files by Name

With the PRODUCT EXTRACT FILE command, you can obtain a single file by name or a set of files with a wildcard file specification from a product kit. For example:

$ PRODUCT EXTRACT FILE CHESS /SELECT=*.EXE /LOG The following product has been selected: ABC_CO AXPVMS CHESS V1.0 Layered Product Do you want to continue? [YES] Portion done: 0% %PCSI-I-CREFIL, created DISK$WORK7:[TEST.KIT.][000000]CHESS.EXE;1 Portion done: 100% %PCSIUI-I-SUCEXTRFIL, EXTRACT FILE operation completed successfully

5.5.2 Extracting the PDF, PTF, or Release Notes

You can extract the PDF, PTF, or release notes file by name. If you do not know their names, use the following EXTRACT commands:

• PRODUCT EXTRACT PDF
• PRODUCT EXTRACT PTF
• PRODUCT EXTRACT RELEASE_NOTES

Every product kit contains a PDF. A PTF and a file designated as the release notes are optionally present in a kit.

The following example illustrates how to obtain the PDF from a sequential kit:

$ SET DEFAULT [TEST.KIT] $ PRODUCT EXTRACT PDF CHESS /DESTINATION=[TEMP] /LOG The following product has been selected: ABC_CO AXPVMS CHESS V1.0 Layered Product Do you want to continue? [YES] Portion done: 0% %PCSI-I-CREFIL, created DISK$WORK7:[TEMP.][000000]ABC_CO-AXPVMS-CHESS-V0100--1.PCSI$DESCRIPTION;1 Portion done: 100% Product Description File has been extracted from the following product: ABC_CO AXPVMS CHESS V1.0 Layered Product %PCSIUI-I-SUCEXTRPDF, EXTRACT PDF operation completed successfully

When you extract the PTF, the following two files are produced:

• The output form of the PTF as a text library file
• A recreation of the input form of the PTF as a sequential text file

$ PRODUCT EXTRACT PTF CHESS /LOG The following product has been selected: ABC_CO AXPVMS CHESS V1.0 Layered Product Do you want to continue? [YES] Portion done: 0% %PCSI-I-CREFIL, created DISK$WORK7:[TEST.KIT.][000000]ABC_CO-AXPVMS-CHESS-V0100--1.PCSI$TLB;1 %PCSI-I-CREFIL, created DISK$WORK7:[TEST.KIT.][000000]ABC_CO-AXPVMS-CHESS-V0100--1.PCSI$TEXT;1 Portion done: 100% Product Text File has been extracted from the following product: ABC_CO AXPVMS CHESS V1.0 Layered Product %PCSIUI-I-SUCEXTRPTF, EXTRACT PTF operation completed successfully

Use the PRODUCT EXTRACT RELEASE_NOTES command to examine any release notes file that may be present in the kit. This command always places the release notes in the user's default directory. By default, the name of the release notes file is preserved.

$ SET DEFAULT [TEMP] $ PRODUCT EXTRACT RELEASE_NOTES CHESS /SOURCE=[TEST.KIT] The following product has been selected: ABC_CO AXPVMS CHESS V1.0 Layered Product Do you want to continue? [YES] Portion done: 0%...100%