File Formats                                             cdtoc(4)



NAME
     cdtoc - CD-ROM table of contents file

DESCRIPTION
     The table of contents file, .cdtoc, is an  ASCI  file  that
     describes the contents of a CD-ROM or other software distri-
     bution media. It resides in the top-level directory  of  the
     file  system  on  a  slice of a CD-ROM. It is independent of
     file system format, that is, the file system  on  the  slice
     can be either UFS or HSFS.


     Each entry in the .cdtoc file is a line that establishes the
     value of a parameter in the following form:


     PARAM=value


     Blank lines and comments (lines preceded  by  a  pound-sign,
     ``#'')  are also allowed in the file. Parameters are grouped
     by product, with the beginning of a  product  defined  by  a
     line of the form:


     PRODNAME=value


     Each product is expected to consist of one or more  software
     packages  that  are stored together in a subdirectory on the
     distribution media. There can  be  any  number  of  products
     described  within  the  file.  There is no required order in
     which the parameters must  be  specified,  except  that  the
     parameters  must  be  grouped  by  product  and the PRODNAME
     parameter must appear first in the list  of  parameters  for
     each  product  specified. Each parameter is described below.
     All of the parameters are required for each product.

     PRODNAME    The full name  of  the  product.  This  must  be
                 unique  within the .cdtoc file and is preferably
                 unique across all possible products. This  value
                 may  contain  white  space.  The  length of this
                 value is limited to 256 ASCI characters;  other
                 restrictions may apply (see below).


     PRODVERS    The version of the product. The value  can  con-
                 tain  any  combination  of  letters, numbers, or
                 other characters. This value may  contain  white
                 space.  The  length  of this value is limited to
                 256 ASCI  characters;  other  restrictions  may
                 apply (see below).



SunOS 5.11          Last change: 14 Sept 2004                   1






File Formats                                             cdtoc(4)



     PRODIR     The name of the top-level  directory  containing
                 the product. This name should be relative to the
                 top-level directory of the  distribution  media,
                 for  example, Solaris2.6/Product. The number of
                 path components in the name is limited  only  by
                 the  system's maximum path name length, which is
                 1024 ASCI characters. Any single  component  is
                 limited to 256 ASCI characters. This value can-
                 not contain white space.



     The lengths of the  values  of  PRODNAME  and  PRODVERS  are
     further  constrained  by  the  fact that the initial install
     programs concatenate these values to produce the  full  pro-
     duct name. For unbundled products the combined length of the
     values of PRODNAME and PRODVERS must not  exceed  256  ASCI
     characters.


     When you install OS services  with  Solstice  Host  Manager,
     directories for diskless clients are created by constructing
     names derived from a concatenation of the  values  of  PROD-
     NAME,   PRODVERS,  and  client  architecture,  for  example,
     /export/exec/Solaris2.xsparc.all/usr/platform. The  length
     of  the  component  containing  the product name and version
     must not exceed 256 ASCI  characters.  Thus,  for  products
     corresponding  to  bundled OS releases (for example, Solaris
     2.4), the values of PRODNAME and  PRODVERS  are  effectively
     restricted to lengths much less than 256.


     The initial install programs use the value  of  the  PRODIR
     macro  in  the .cdtoc file to indicate where packages can be
     found.

EXAMPLES
     Example 1 Sample of .cdtoc file.


     Here is a sample .cdtoc file:



               #
               # .cdtoc file -- Online product family CD
               #
               PRODNAME=Online DiskSuite
               PRODVERS=2.0
               PRODIR=OnlineDiskSuite2.0
               #
               PRODNAME=Online Backup



SunOS 5.11          Last change: 14 Sept 2004                   2






File Formats                                             cdtoc(4)



               PRODVERS=2.0
               PRODIR=OnlineBackup2.0




     This example corresponds to the following  directory  layout
     on a CD-ROM partition:


               /.cdtoc
               /OnlineDiskSuite2.0
                     ./SUNWmddr.c
                     ./SUNWmddr.m
                     ./SUNWmddu
               /OnlineBackup2.0
                     ./SUNWhsm




     The bundled release of Solaris 2.6  includes  the  following
     .cdtoc file:


               PRODNAME=Solaris
               PRODVERS=2.6
               PRODIR=Solaris2.6/Product




     This file corresponds to the following directory  layout  on
     slice 0 of the Solaris 2.6 product CD:


               /.cdtoc
               /Solaris2.6/Product
                    ./SUNWaccr
                    ./SUNWaccu
                    ./SUNWadmap
                    .
                    .
                    .
                    ./SUNWutool



SEE ALSO
     clustertoc(4), packagetoc(4), pkginfo(4)





SunOS 5.11          Last change: 14 Sept 2004                   3