unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (OSF1-V5.1-alpha)
Page:
Section:
Apropos / Subsearch:
optional field



kitcap(4)							    kitcap(4)



NAME
  kitcap - Kit descriptor database for gentapes	and gendisk utilities

SYNOPSIS

  Disk Media Descriptor


  ProdCodeHD:partition:\
    dd=destdir[,kk=true][,rootdd=dirname]:\
      Product_Description:\
      kitdir[,kitdir]...:instctrl:subset[,subset]...\
    [:dd=destdir[,kk=true][,rootdd=dirname]:\
      Product_Description:\
      kitdir[,kitdir]...:instctrl:subset[,subset]...]...

  Tape Media Descriptor


  ProdCode{MT|TK}|Product Description:\
    directory[,directory]...:SPACE:SPACE:SPACE:\
    INSTCTRL:subset[,subset]...\
    [:%%N:subset[,subset]...]...

DESCRIPTION

  The kitcap file is a database	for kit	descriptors.  This database contains
  product codes, media codes, and the names of the directories,	files, and
  subsets that make up a product description used by gentapes or gendisk to
  create distribution media.

  The following	rules apply to kitcap records:

    +  The first field is separated from the rest of the record	by a colon
       (:) for disk media descriptors and by a pipe character (|) for tape
       media descriptors.

    +  Separate	all other fields with colons (:).

    +  Indicate	continuation with a backslash (\) at the end of	the line.

    +  Lines starting with a pound sign	(#) are	comments and are ignored.

    +  Comments	within a record	start with a pound sign	(#) and	end with a
       colon (:).  Use this feature sparingly.

  Disk Media Descriptors


  The following	sample kitcap entry is for disk	media:

       ProdCodeHD:partition:\
	 dd=/:Product_Description:\
	 directory1:directory2:directory3:\
	 instctrl:subset1:subset2:subset3:subset4:subset5:\
	 dd=SUB/DIR:Product_Description:\
	 directory1:directory2:directory3:\
	 instctrl:subset1:subset2:subset3:subset4:subset5

  The following	fields make up the kitcap descriptor for disk media:

  Kit Name
      The Kit Name field consists of two concatenated subfields: the product
      code and the media code.

      ProdCode
	  This is an arbitrary alphanumeric name unique	to the product.	 Typ-
	  ical codes include a product identifier and a	version	identifier,
	  as shown in the EXAMPLES section.  For example, if the product name
	  is MYPRODUCT and the version is 1.0, the product-code	might be
	  MYPRODUCT100.

      Media code
	  The media code for disks is HD.

  partition
      This field specifies the partition where the software will be written
      on the media by the gendisk utility.  Valid values are a through h.
      The usual	value is c, as it spans	the entire disk.

  dd=destdir
      This field specifies the directory in which to write the subsets on the
      disk media being created.	 The contraction dd can	be thought of as the
      destination directory for	the subsets.  This field is required and
      allows a hierarchical structure so that you can put multiple products
      on the same disk or place	parts of one product into different areas on
      the disk.

      Typically, a disk	is mounted by the gendisk utility to a temporary
      mount point under	/usr/tmp.  This	location becomes the disk's root
      directory.  To specify only one directory	for an entire product, a
      valid entry would	be dd=/.  This entry tells the gendisk utility to
      write all	the following subsets under the	mount point.

      You also may use the following parameters	in the dd field:

      kk=true
	  This parameter can be	used for kernel	product	kits and hardware
	  product kits,	and indicates that the kit is needed during the	boot
	  process.  When the gendisk utility finds this	parameter, it
	  automatically	generates a kitname.kk file.

      rootdd=dirname
	  This parameter specifies kit placement on the	distribution media,
	  relative to the kit-specific directory such as OAT100/kit.  For
	  example, rootdd=.. would place the kit's root	under the OAT100
	  directory on the distribution	media.

      In the disk kitcap descriptor example shown in the EXAMPLES section,
      the first	five subsets are written to the	mount point, or	root direc-
      tory, for	the disk media being made.  Then a new directory,
      /mnt_point/SUB/DIR, is created on	the disk media and the next five sub-
      sets are written into that directory.

      It is important to note that the top-level directory of the media	disk
      is always	considered the mount point used	by the gendisk script and is
      referenced by dd=/.  Any subdirectories listed as	destination direc-
      tories are created starting from the mount point and must	be referenced
      in full.	For instance, to put some other	subsets	in a subdirectory of
      DIR in the previous example, the entry would be dd=SUB/DIR/SUBSUBDIR.
      Each new destination directory requires a	product	description.

  Product_Description
      This field is similar to the optional product description	for magnetic
      tape, but	for disk media the product description is a required field.
      All words	in the description must	be connected with underscores (_).
      The gendisk script removes the underscores at run	time.  For example,
      to create	the description	for "This is a good product", the Product
      Description entry	for disk media would be: This_is_a_good_product

  directoryN
      One or more product source directories.  The gendisk utility can pro-
      duce a multiproduct disk with subsets from different products, based in
      different	directories, and merge them on the disk	to form	a combined
      product.	Directory entries provide the full path	locations for the
      subsets to be put	on the media.  There must be at	least one directory
      entry for	each kitcap descriptor.

  instctrl
      The instctrl directory contains setld control information.  This is
      analogous	to the INSTCTRL	file for magnetic tape.

  subsetN
      The subset fields	provide	a list of subsets or files to be either	writ-
      ten to the disk media or verified	from the disk media.  Each subset
      listed must be stored in one of the directories listed in	the kitcap
      descriptor.  If a	file or	subset is stored in a subdirectory of one of
      the directories listed in	the kitcap descriptor, it is possible to
      include that subpath with	the subset or file name	entry instead of
      listing the entire path or subpath as another directory listing.	For
      example, a directory listed in the kitcap	descriptor under the rules
      given in the directoryN section is listed	as:
	   /KITS/MYPRODUCT/001
      A	particular subset or file to be	included on the	media is stored	in:
	   /KITS/MYPRODUCT/001/subdirectory/subset
      Since the	subdirectory/subset specification is part of the
      /KITS/MYPRODUCT/001 directory tree, it is	not necessary to include the
      full path	of the /KITS/MYPRODUCT/001/ subdirectory in the	directory
      listing.	Alternatively, you could include the subdirectory path with
      the subset name in the subset list.  For example:
	   MY-PROD-001HD:c:\
	     dd=/KITS/MYPRODUCT/001:This_is_a_good_product:\
	     instctrl:subset1:subset2:\
	     subdirectory/subset3:\
	     subset4

  Magnetic Tape	Media Descriptors


  The following	kitcap entry examples are for TK50 and MT9 media types,
  respectively:

       ProdCodeTK|Product Description:directory1:directory2:\
	 directory3:SPACE:SPACE:SPACE:INSTCTRL:subset1:subset2:\
	 subset3:subset4:subset5

       ProdCodeMT|Product Description:directory1:directory2:\
	 directory3:SPACE:SPACE:SPACE:INSTCTRL:subset1:subset2:\
	 subset3:subset4:subset5:%%2:subset6:subset7:subset8:\
	 subset9:subset10

  The following	fields make up the kitcap descriptor for magnetic tape media:

  Kit Name
      The Kit Name field consists of two concatenated subfields: the product
      code and the media code.	For tape media,	it is separated	from the rest
      of the record by a pipe character	(|).

      ProdCode
	  This is an arbitrary alphanumeric name unique	to the product,
	  including both product and version identifiers as shown in the
	  EXAMPLES section.  For example, if the product name is MYPRODUCT
	  Version 1.0, the product-code	might be MYPRODUCT100.

      Media code (TK or	MT)
	  The media code is a 2-letter reference specifying the	type of	media
	  to be	used.  This must be either TK for TK50 or MT for 9-track mag-
	  netic	tape devices.

  Product Description
      This field is a description of the software product to be	created	by
      the gentapes utility.  It	replaces the NAME field	in the control file
      (filename.ctrl) for each of the subsets that make	up a product.  This
      field is optional	for magnetic tape media.

  directoryN
      The gentapes utility can produce multiproduct tapes.  That is, it	can
      take subsets from	different products, based in different directories,
      and merge	them on	the tape to form a combined product.  Directory
      entries provide the full path locations for the subsets to be put	on
      the media.  There	must be	at least one directory entry for each kitcap
      descriptor.

  SPACE
      The SPACE	file is	a placeholder for tape records,	and contains 10Kb of
      NULL characters.	Three SPACE files are used as dummy files to ensure
      compatibility with operating system kits.

  INSTCTRL
      The INSTCTRL image contains setld	control	information.

  subsetN
      The subset fields	provide	a list of subsets or files to be either	writ-
      ten to the magnetic tape media or	verified from the magnetic tape
      media.  Each subset listed must be stored	in one of the directories
      listed in	the kitcap descriptor.	If a file or subset is stored in a
      subdirectory of one of the directories listed in the kitcap descriptor,
      you can include that subpath with	the subset or file name	entry instead
      of listing the entire path or subpath as another directory listing.
      For example, a directory listed in the kitcap descriptor under the
      rules given in the directoryN section is listed as:
	   /KITS/MYPRODUCT/001
      A	particular subset or file to be	included on the	media is stored	in:
	   /KITS/MYPRODUCT/001/subdirectory/subset
      Since the	subdirectory/subset specification is part of the
      /KITS/MYPRODUCT/001 directory tree, it is	not necessary to include the
      full path	of the /KITS/MYPRODUCT/001/ subdirectory in the	directory
      listing.	Alternatively, you could include the subdirectory path with
      the subset name in the subset list.  For example:
	   MY-PROD-001MT|This is a good	product:\
	     /KITS/MYPRODUCT/001:SPACE:SPACE:SPACE:\
	     INSTCTRL:subset1:subset2:\
	     subdirectory/subset3:subset4

  Volume identifier (%%n)
      The volume identifier is optional.  Multitape support is provided	for
      products that have subsets or files that require more space than is
      available	on a single 9-track magnetic tape.  If the subset list
      results in an end-of-tape	condition, the subset list can be split	into
      any number of multivolume	sets by	placing	%%n anywhere appropriate in
      the subset list (where n is the volume number of the next	tape).	The
      subsets listed between the volume	identifiers must fit on	a single
      piece of media.  By default, the subset list located directly after the
      directory	list is	always considered the first volume.  Therefore,	a
      volume identifier	is not necessary for the first volume in a multivo-
      lume kit descriptor.

EXAMPLES

  Disk Description (Multiple Products):


       MYPRODUCT400HD:c:\
	 dd=MYPRODUCT/BASE:\
	 MYPRODUCT_software_version_4_base_subsets:\
	 /directory1:/directory2:/directory3:\
	 instctrl:subset1:subset2:subset3:subset4:subset5:\
	 dd=MYPRODUCT/NONBASE:\
	 MYPRODUCT_software_version_4_nonbase_subsets:\
	 /directory1:/directory2:/directory3:\
	 instctrl:subset1:subset2:subset3:subset4:subset5

  TK50 Description (Single-Volume Tape)


       MYPRODUCT400TK|MYPRODUCT	software version 4:\
	 :# directory listing :\
	 /directory1:/directory2:/directory3:\
	 SPACE:SPACE:SPACE:INSTCTRL:\
	 :# subset listing :\
	 subset1:subset2:subset3:subset4:subset5

  MT9 Description (Multivolume Tape):


       MYPRODUCT400MT|MYPRODUCT	software version 4:\
	 /directory1:/directory2:/directory3:\
	 SPACE:SPACE:SPACE:INSTCTRL:\
	 subset1:subset2:subset3:subset4:subset5:\
	 :# Volume 2 :%%2:\
	 subset6:subset7:subset8:subset9:subset10

  Disk Description (Single Product):


       MYPRODUCT400HD:c:\
	 dd=/:MYPRODUCT_software_version_4:\
	 /directory1:/directory2:/directory3:\
	 instctrl:subset1:subset2:subset3:subset4:subset5

RELATED	INFORMATION

  Commands:
      gendisk(1), gentapes(1)

  Documents:
      Guide to Preparing Product Kits