Content-type: text/html Man page of kitcap


Section: Devices and Network Interfaces (4)
Index Return to Main Contents


kitcap - Kit descriptor database for gentapes and gendisk utilities  


The kitcap file is a database for kit descriptors containing product codes and the names of the directories, files, and subsets that make up a product description to be used by gentapes or gendisk to create distribution media. All fields are separated by colons (:) with a backslash (\) at the end of a line indicating continuation. Lines starting with a number sign (#) are comments and are ignored. Comment fields with a kitcode description are delimited by an opening number sign (#) and a closing colon (:).

The following kitcap entry examples are for TK50 and MT9 media types:
Product-codeTK | Product Description:directory1:directory2:\

Product-codeMT | Product Description:directory1:directory2:\

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

This is an arbitrary name made up of letters and/or numbers unique to the product that it describes. Typical codes include a product identifier and a version identifier, as indicated in the previous examples. For example, if the product name is MYPRODUCT and the version is 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 the files will be written on. The media code must be either TK for TK50 or MT for 9-track magnetic tape devices. During run time, the gentapes utility probes the device to be written to and determines if it is a TK50 or MT9 device. It then appends either TK or MT to the product-code given on the command line and searches for the corresponding kit identifier (product-code/media-code) in the kitcap file.
Product Description
This field is a description of the software product that is being 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.
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 that are to be put on the media. There must be at least one directory entry for each kitcap descriptor.
The SPACE file is a placeholder for tape records, containing 10Kb of NULL characters. Three SPACE files are used as dummy files to ensure compatibility with operating system kits.
The INSTCTRL image contains setld control information.
This field provides a list of subsets or files that are to be either written 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, it is possible to include that sub-path with the subset/filename entry instead of listing the entire path/subpath as another directory listing. For example, a directory listed in the kitcap descriptor under the rules given in the Directories 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. An alternative is to include the subdirectory path with the subset name in the subset list. For example: MY-PROD-001 | This is a good product:\
Volume identifier

The volume identifier is optional. Multitape support is provided for products that have subsets or files requiring 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 for the first volume in a multivolume kit descriptor is not necessary.

The following example shows a kitcap entry for disks: Product-codeHD:partition:\

The following parts make up the kitcap descriptor for disk media: Same as for magnetic tape. The media code for disks is HD and is appended to the product-code by the gendisk utility. This field specifies the partition in which the software is to be written on the media being created. 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. The dd= option has two options that are separated by commas when used: For kits in Direct CD-ROM (DCD) format, this field specifies the path to the expanded subset files relative to the path specified in the dd= option. When creating a kit in DCD format, the rootdd=path defaults to the top of the media. This field specifies that the kit is a kernel kit and it creates a .kk file in the instctrl directory along with a symbolic link to the instctrl directory in the rootdd=path directory. Any entry after the directories entry that ends in a .tar suffix is considered to be a compressed or uncompressed tar file and is extracted at the path specified by the dd= option.

Typically, a disk is mounted by the gendisk utility on 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.

In the disk kitcap descriptor example given previously, the first five subsets are written to the mount point, or root directory, for the disk media being made. Then a new directory, /mnt_point/SUB/DIR, is created on the disk media and the next five subsets 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 directories are created starting from the mount point and must be referenced in full. For instance, in the previous example, to put some other subsets in a subdirectory of DIR, the entry would be dd=SUB/DIR/SUBSUBDIR. Note that each new destination directory requires a product description. This field is similar to the one defined for magnetic tape. However, in the case of disk media the product description is a required field, and 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 ``This is a good product'' the Product Description entry when making disk media would be: This_is_a_good_product Same as for magnetic tape. A directory containing the same information as the INSTCTRL file on magnetic tape. Same as for magnetic tape.  


TK50 and MT9 (single-volume tape) kitcap description: MYPRODUCT400 | MYPRODUCT software version 4:\
        :# directory listing :\
        :# subset listing :\

MT9 kitcap description (multivolume tape): MYPRODUCT400 | MYPRODUCT software version 4:\
        :# Volume 2 :\

Disk kitcap description (single product): MYPRODUCT400:c:\

The following is an example which when used with the -d option of the gendisk utility expands the subsets at the top of the media: KIT-1.0-BWHD:c:\ dd=/V2.0K/kit,kk=true:Graphics_Driver_Product:\ /kit/graphics/subsets:\ instctrl:GRAHWBASE100:GRAHWBIN100:GRAHWBINCOM100

The following is an example which when used with the -d option of the gendisk utility expands the subsets one directory above the kit location specified by the dd= option: KIT-1.0-BWHD:c:\ dd=/V2.0K/kit,rootdd=..,kk=true:Graphics_Driver_Product:\ /kit/graphics/subsets:\ instctrl:GRAHWBASE100:GRAHWBIN100:GRAHWBINCOM100

Disk kitcap description (multiple product): MYPRODUCT400:c:\


Commands: gendisk(1), gentapes(1)

Documents: Guide to Preparing Product Kits delim off




This document was created by man2html, using the manual pages.
Time: 02:40:09 GMT, October 02, 2010