cdtoc(4) - osol9

1cdtoc(4)                         File Formats                         cdtoc(4)
2
3
4

NAME

6       cdtoc - CD-ROM table of contents file
7

DESCRIPTION

9       The table of contents file, .cdtoc, is an ASCII file that describes the
10       contents of a CD-ROM or other software distribution media.  It  resides
11       in  the  top-level directory of the file system on a slice of a CD-ROM.
12       It is independent of file system format, that is, the  file  system  on
13       the slice can be either UFS or HSFS.
14
15
16       Each entry in the .cdtoc file is a line that establishes the value of a
17       parameter in the following form:
18
19
20       PARAM=value
21
22
23       Blank lines and comments (lines preceded by a  pound-sign,  ``#'')  are
24       also  allowed  in the file. Parameters are grouped by product, with the
25       beginning of a product defined by a line of the form:
26
27
28       PRODNAME=value
29
30
31       Each product is expected to consist of one or  more  software  packages
32       that  are  stored together in a subdirectory on the distribution media.
33       There can be any number of products described within the file. There is
34       no  required  order  in  which the parameters must be specified, except
35       that the parameters must be grouped by product and the PRODNAME parame‐
36       ter must appear first in the list of parameters for each product speci‐
37       fied. Each parameter is described below.  All  of  the  parameters  are
38       required for each product.
39
40       PRODNAME    The  full  name  of the product. This must be unique within
41                   the .cdtoc file and is preferably unique across all  possi‐
42                   ble  products.  This  value  may  contain  white space. The
43                   length of this value is limited to  256  ASCII  characters;
44                   other restrictions may apply (see below).
45
46
47       PRODVERS    The  version of the product. The value can contain any com‐
48                   bination of letters, numbers,  or  other  characters.  This
49                   value  may contain white space. The length of this value is
50                   limited to 256 ASCII  characters;  other  restrictions  may
51                   apply (see below).
52
53
54       PRODDIR     The name of the top-level directory containing the product.
55                   This name should be relative to the top-level directory  of
56                   the  distribution  media, for example, Solaris_2.6/Product.
57                   The number of path components in the name is  limited  only
58                   by  the  system's  maximum  path name length, which is 1024
59                   ASCII characters. Any single component is  limited  to  256
60                   ASCII characters. This value cannot contain white space.
61
62
63
64       The  lengths  of  the  values of PRODNAME and PRODVERS are further con‐
65       strained by the fact that  the  initial  install  programs  concatenate
66       these  values  to produce the full product name. For unbundled products
67       the combined length of the values of PRODNAME  and  PRODVERS  must  not
68       exceed 256 ASCII characters.
69
70
71       When  you  install  OS services with Solstice Host Manager, directories
72       for diskless clients are created by constructing names derived  from  a
73       concatenation of the values of PRODNAME, PRODVERS, and client architec‐
74       ture, for example, /export/exec/Solaris_2.x_sparc.all/usr/platform. The
75       length  of  the  component containing the product name and version must
76       not exceed 256 ASCII characters. Thus, for  products  corresponding  to
77       bundled  OS releases (for example, Solaris 2.4), the values of PRODNAME
78       and PRODVERS are effectively restricted to lengths much less than 256.
79
80
81       The initial install programs use the value of the PRODDIR macro in  the
82       .cdtoc file to indicate where packages can be found.
83

EXAMPLES

85       Example 1 Sample of .cdtoc file.
86
87
88       Here is a sample .cdtoc file:
89
90
91
92                 #
93                 # .cdtoc file -- Online product family CD
94                 #
95                 PRODNAME=Online DiskSuite
96                 PRODVERS=2.0
97                 PRODDIR=Online_DiskSuite_2.0
98                 #
99                 PRODNAME=Online Backup
100                 PRODVERS=2.0
101                 PRODDIR=Online_Backup_2.0
102
103
104
105
106       This  example corresponds to the following directory layout on a CD-ROM
107       partition:
108
109
110                 /.cdtoc
111                 /Online_DiskSuite_2.0
112                       ./SUNWmddr.c
113                       ./SUNWmddr.m
114                       ./SUNWmddu
115                 /Online_Backup_2.0
116                       ./SUNWhsm
117
118
119
120
121       The bundled release of Solaris 2.6 includes the following .cdtoc file:
122
123
124                 PRODNAME=Solaris
125                 PRODVERS=2.6
126                 PRODDIR=Solaris_2.6/Product
127
128
129
130
131       This file corresponds to the following directory layout on slice  0  of
132       the Solaris 2.6 product CD:
133
134
135                 /.cdtoc
136                 /Solaris_2.6/Product
137                      ./SUNWaccr
138                      ./SUNWaccu
139                      ./SUNWadmap
140                      .
141                      .
142                      .
143                      ./SUNWutool
144
145
146

NAME

DESCRIPTION

EXAMPLES

SEE ALSO