pspec



NAME

      pspec - generate Product Specification information


SYNOPSIS

      pspec [-d |-m] [-t] [-nt sub_dir ] [-o old_prod_root ] [-p
      file_name.mif ] [-w n ] [-PD] [any cpp option] [pd_file [product_root
      ]]


DESCRIPTION

      The command pspec lists product specification information for files in
      a product directory or PD file to standard output and optionally to a
      Maker Interchange Format file, that can be imported into a FrameMaker
      document.
      The product specification information consists of filename (from
      product directory or PD file), description (from PD files) and state
      (New, Modified, Unmodified or Obsolete).
      A table of product specification information is produced for each
      subdirectory and it is proceeded by a header with the directory name.
      All files are listed by default. With option -m, the command lists
      only new and modified files, with option -d, the command lists only
      deleted files. Files in a subdirectory can be listed with option -nt
      sub_dir.
      Internally, pcopy is used to extract the contents of the PD file(s)
      without actually copying any files. difftree is used to compare two
      directory trees. diff compares file by file if option -PD is
      specified.

    PARAMETERS
       pd_file
           Product Definition file. If not specified, and the environment
           variable SDE_PD is undefined, the command prompts for the
           parameter.

      product_root
           Product root directory. If not specified, and the environment
           variable PRODUCT_ROOT is undefined, the command prompts for the
           parameter.

    OPTIONS
      -d   List only files not included in the product. Comparison with
           files in the old product defined by option -o.

      -m   List only modified and new files in the product. Comparison with
           files in the old product defined by option -o.

      -nt sub_dir
           List only files in product_root/sub_dir.

      -o old_prod_root
           Compare files in product_root with files in old_prod_root.

      -p file_name.mif
           Create a file that can be imported into a FrameMaker document.
           The file produced is in Maker Interchange Format and must have
           extension .mif. If the file exists, it is overwritten.

      -t   If the pd_file does not consist of "include statements" use this
           option to find all PD files in the tree. The option is used
           internally with the command pcopy.

      -w n
           Option used internally in dircmp to specify output width in n
           number of characters. Used to avoid truncation of long file and
           directory names.

      -PD  Generate information for files in PD file. If a file defined in a
           PD file is not found a WARNING message is printed on stderr.


EXTERNAL INFLUENCES

      The environment variable SDE_PD defines the PD file name.  The
      environment variable PRODUCT_ROOT defines the product root directory.


EXAMPLES

      pspec -p ex1.mif -o /ipa/products/ex_prod/2.1-0
         /aut/km/ex_system/2.2-0/ex.pd /ipa/products/ex_prod/2.2-0

      creates product specification information for all files in a product
      directory when an older version of the product exists.

      pspec -PD /aut/km/ex_system/1.0-0/ex.pd /ipa/products/ex/1.0-0

      creates product specification information for files in a PD file.


WARNINGS

      For test of consistency between PD files and files in the product
      directory, use the command pdcheck before pspec.


SEE ALSO

      pdcheck(1), pcopy(1), difftree(1), dircmp(1)


AUTHOR

      E Antonsson