stl_key(4)						     Kernel Interfaces Manual							stl_key(4)

NAME

       stl_key - setld kit manufacturing key files

DESCRIPTION

       Each  software product that is distributed as subsets for the setld(8) command has an associated key file.  The key file's name consists of
       the product's unique 3-letter name and a 3-digit version number with the string .k for a suffix.  The key file is used by the software kit-
       ting program kits(1) in producing software distribution packages.

       A  key  file  has  a global data section and a subset descriptor section.  The sections are separated by a line containing only two percent
       signs (%%).

       The global section specifies the product-level attributes of the product.  In this section, lines that begin with number signs (#) are com-
       ments  and  are ignored by the kits utility.  Attributes are specified as name/value pairs separated by equals signs (=).  There must be no
       white space surrounding the equals sign.  There are four mandatory attributes and two optional attributes. Attributes  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 con-
		 tains 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  flag
		 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 sav-
		 ing space on the distribution media.  To suppress compression, this attribute is a zero (0).  If missing, this attribute defaults
		 to zero.

       The  subset descriptor section contains one subset descriptor line for each subset in the product.  Comments are not permitted in this sec-
       tion.

       A subset descriptor contains subset-specific attributes in four fields separated by TAB characters.  These fields are:

       Subset name   A character string up to 15 characters in length, composed of the 3-letter product code (for example, OAT), a mnemonic  iden-
		     tifying  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 is the ``sticky bit,'' indicating when set that the subset cannot be removed.

		     Bit 1 indicates when set that the subset is optional.

		     Bits 2 to 7 are reserved.

		     Bits 8 to 15 are undefined.

       Description   A short description of the subset, delimited by single quotation marks (''); for example, 'Document Building Tools'

       The subset descriptors must be listed in the order in which the subsets are to be installed by setld.

RESTRICTIONS

       Comments in the subset descriptor section will cause serious problems when encountered by the kits program.

       TAB formatting in the subset descriptors is tightly enforced by the kits program.

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 def-
       initions follow.  # %% OATDCB100       .       0       'Document Building Tools' OATDCBDOC100	.	2	'Document Tools Documenta-
       tion'

RELATED INFORMATION

       Commands:  kits(1), setld(8)

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

       Documents:  Guide to Preparing Product Kits delim off

																	stl_key(4)