Manual Page Result
0
Command: kitcap | Section: 4 | Source: Digital UNIX | File: kitcap.4.gz
kitcap(4) Kernel Interfaces Manual kitcap(4)
NAME
kitcap - Kit descriptor database for gentapes and gendisk utilities.
DESCRIPTION
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 dis-
tribution media. All fields are separated by colons (:) with a back-
slash (\) 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:\
directory3:SPACE:SPACE:SPACE:INSTCTRL:subset1:subset2:subset3:\
subset4:subset5
Product-codeMT | Product Description:directory1:directory2:\
directory3:SPACE:SPACE:SPACE:INSTCTRL:subset1:subset2:subset3:\
subset4:subset5:%%2:\
subset6:subset7:subset8:subset9:subset10
The following parts make up the kitcap descriptor for magnetic tape me-
dia:
Product-code
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 ei-
ther TK for TK50 or MT for 9-track magnetic tape devices. Dur-
ing run time, the gentapes utility probes the device to be writ-
ten 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 be-
ing 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 me-
dia.
Directories
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 prod-
uct. 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.
SPACE 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.
INSTCTRL
The INSTCTRL image contains setld control information.
Subsets
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/MYPROD-
UCT/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/MYPROD-
UCT/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:\
/KITS/MYPRODUCT/001:SPACE:SPACE:SPACE:\
INSTCTRL:subset1:subset2:subdirectory/subset3:subset4
Volume identifier
The volume identifier is optional. Multitape support is pro-
vided 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 vol-
ume number of the next tape). The subsets listed between the
volume identifiers must fit on a single piece of media. By de-
fault, 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:\
dd=/:Product_Description:\
directory1:directory2:directory3:\
instctrl:subset1:subset2:subset3:subset4:subset5:\
dd=SUB/DIR:Product_Description:\
instctrl:directory1:directory2:directory3:\
subset1:subset2:subset3:subset4:subset5
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 sub-
sets 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 multi-
ple products on the same disk or place parts of one product into dif-
ferent areas on the disk.
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 di-
rectory. 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 di-
rectory.
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 directo-
ries are created starting from the mount point and must be referenced
in full. For instance, in the previous example, to put some other sub-
sets in a subdirectory of DIR, the entry would be dd=SUB/DIR/SUBSUBDIR.
Note that each new destination directory requires a product descrip-
tion. This field is similar to the one defined for magnetic tape.
However, in the case of disk media the product description is a re-
quired 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 prod-
uct'' the Product Description entry when making disk media would be:
This_is_a_good_product Same as for magnetic tape. A directory contain-
ing the same information as the INSTCTRL file on magnetic tape. Same
as for magnetic tape.
EXAMPLES
TK50 and MT9 (single-volume tape) kitcap description: MYPRODUCT400 |
MYPRODUCT software version 4:\
:# directory listing :\
/directory1:/directory2:/directory3:\
SPACE:SPACE:SPACE:INSTCTRL:\
:# subset listing :\
subset1:subset2:subset3:subset4:subset5
MT9 kitcap description (multivolume tape): MYPRODUCT400 | 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 kitcap description (single product): MYPRODUCT400:c:\
dd=/:MYPRODUCT_software_version_4:\
/directory1:/directory2:/directory3:\
instctrl:subset1:subset2:subset3:subset4:subset5
Disk kitcap description (multiple product): MYPRODUCT400: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
RELATED INFORMATION
Commands: gendisk(1), gentapes(1)
Documents: Guide to Preparing Product Kits delim off
kitcap(4)