Library /sys$common/syshlp/helplib.hlb  —  PRODUCT  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[,...])

1  –  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.

2  –  Parameter

 product-name

    Names the product or list of products to be packaged.

3  –  Qualifiers

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

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

3.3    /DESTINATION

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

    Specifies the location where the product kit will 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 command ignores the PCSI$DESTINATION
    logical name whether or not you use the /DESTINATION qualifier.

3.4    /FORMAT

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

3.5    /LOG

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

3.6    /OPTIONS

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

3.7    /MATERIAL

       /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       Only one directory is searched.
    directory

    Wildcard       The directory name includes one or more of the
    directory      wildcard characters asterisk (*),  percent sign
                   (%),  or ellipsis (...). All directories that
                   satisfy the wildcard specification are searched.

    Root           A period (.)  following the directory name
    directory      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.

3.8    /OWNER_UIC

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

3.9    /PRODUCER

       /PRODUCER=producer-name

    Selects software products that the specified manufacturer
    produces.

3.10    /SOURCE

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

3.11    /VERSION

       /VERSION=version-number

    Selects software products that have the specified version.

4  –  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.
Close Help