Index for Section 4

Alphabetical listing for S

Bottom of page

stl_key(4)
NAME
  stl_key - setld kit manufacturing key files (*.k)

DESCRIPTION
  Each software product that is distributed for installation by the setld
  utility has an associated key file.  The key file's name consists of the
  unique three-letter product code and a three-digit version number with the
  suffix .k, for example: OAT100.k.  The key file is used by the kits utility
  to produce software distribution packages, and consists of a global data
  section and a subset descriptor section separated by a delimiter line.

  Global Data Section

  The key file's global data section specifies the product-level attributes
  of the product.  In this section, lines that begin with number signs (#)
  are comments and are ignored by the kits(1) utility.	Attributes are
  specified as NAME=value pairs separated by equals sign, with no white
  space. There are four mandatory attributes and two optional attributes; all
  must have non-null values.  The attributes are:

  NAME
      Mandatory.  Specifies the name of the product.  The value for NAME is a
      text string of up to 40 characters.  If the string contains blank
      spaces, it must be enclosed in apostrophes ('').

  CODE
      Mandatory.  Specifies the 3-character product code for the product, for
      example, OAT.

  VERS
      Mandatory.  Specifies the 3-digit version code for the product, for
      example, 100.

  MI  Mandatory.  Specifies the pathname of the master inventory file for the
      product.

  ROOT
      Optional.	 A single-digit integer that is set to 1 if the product is
      the base operating system.  In all other cases, this option must be a
      zero (0).	 If missing, this attribute defaults to zero.

  COMPRESS
      Optional.	 A single-digit integer that is set to 1 to create compressed
      subset files using the compress(1) utility, thereby saving space on the
      distribution media.  To suppress compression, set this attribute is a
      zero (0).	 If missing, this attribute defaults to zero.

  Section Delimiter Line

  The delimiter between the key file's global data section and subset
  descriptor section is a single line containing only two percent signs (%%).

  Subset Descriptor Section

  The subset descriptor section contains one subset descriptor for each
  subset in the product. The subset descriptors must be listed in the order
  that the subsets are to be installed by setld. Comments are not permitted
  in this section. A subset descriptor contains subset-specific attributes in
  the following four fields separated by [TAB] characters:

  Subset name
      A character string up to 15 characters in length, composed of the 3-
      letter product code (for example, OAT), a mnemonic identifying the
      subset (for example, DCB), and the 3-digit version code (for example,
      100).  All letters in the subset name must be uppercase.

  Reserved
      This field must be a single period.

  Flags
      A 16-bit unsigned integer

      Bit 0 indicates whether the subset can be removed

      Bit 1 indicates whether the subset is optional

      Bits 2 to 7 are reserved

      Bits 8 to 15 are undefined

  Description
      A short description of the subset within single quotation marks, for
      example, 'Document Building Tools'

RESTRICTIONS
  Do not place comments in the subset descriptor section. They will cause
  serious problems when you run the kits utility.

  [TAB] formatting in the subset descriptors is tightly enforced by the kits
  utility.

EXAMPLES
  The following example illustrates the key file for a hypothetical product
  kit:

       #       Key file for the Orpheus Document Building Tools kit
       #
       #       Product-level attributes.
       #
       NAME='Orpheus Authoring Tools'
       CODE=OAT
       VERS=100
       MI=OAT00.mi
       ROOT=0
       COMPRESS=1
       #
       #       Subset definitions follow.
       #
       %%
       OATODB100       .       0       'Document Building Tools'
       OATODBDOC100    .       2       'Document Building Tools Documentation'

SEE ALSO
  Commands: kits(1), setld(8)

  Files: stl_comp(4), stl_ctrl(4), stl_image(4), stl_mi(4)

  Guide to Preparing Product Kits

Index for Section 4

Alphabetical listing for S

Top of page