Debian Codegraph @

docs/index.html

raw
1 <html>
2 <head>
3 <title>debian-cd</title>
4 </head>
5 <body>
6 <h1>debian-cd</h1>
7 <h2>An attempt at documentation!</h2>
8
9 <p>debian-cd is a small but quite complex package. On the surface, its
10 job is simple - make CD images from a Debian archive. The details are
11 rather more involved...</p>
12
13 <h2>Overview - what goes on a CD?</h2>
14
15 <p>There are several important items that make up a Debian
16 CD. Depending on the type of CD, not all of them are needed.</p>
17
18 <ul>
19 <li><a href="volinfo.html">Volume information</a> (required)
20 <li><a href="packages.html">Debian packages and/or source files</a> (optional)
21 <li><a href="package-metadata.html">Metadata to reference those</a> (optional)
22 <li><a href="d-i.html">Debian-Installer</a> (optional)
23 <li><a href="booting.html">Scripts/binaries to make the CD bootable</a> (optional)
24 </ul>
25
26 <p>The only things that <strong>must</strong> be on a Debian CD for it
27 to recognised as such are the volume info, the files that give some
28 information about the CD itself. Everything else is strictly optional,
29 but without anything else on the CD it won't be very useful!</p>
30
31 <p>A normal installation CD will contain all five of the above
32 sections, but other combinations can be useful too. A bootable
33 business card CD will contain volume info, d-i and bootable files, but
34 no actual packages or sources - the installer will download the bits
35 it needs. An update CD will contain volume info, packages and package
36 metadata - it's expected to be used just as a source of new packages
37 for an existing system.</p>
38
39 <p>For more information on the layout of the CD, see <a
40 href="cd-contents.html">CD contents</a>.</p>
41
42 <h2>Overview (again) - how does debian-cd work?</h2>
43
44 <p>debian-cd is made up of a large central Makefile and lots of
45 small(ish) helper scripts written in sh and perl. It depends on
46 various other packages to do lots of the hard work, for example apt to
47 calculate package dependencies and debootstrap to provide the list of
48 packages needed for a base installation.</p>
49
50 <p>A typical debian-cd run will involve:</p>
51
52 <ul>
53 <li>Setup in the configuration file <a href="conf.sh.html">CONF.sh</a>
54 - which architecture(s), where to find files (local Debian mirror),
55 temporary working location and output location are most important, but
56 there are other config options.
57 <li>Running a build wrapper script (build.sh or build_all.sh); the wrapper script will call various rules in the Makefile
58 <li>Parse Packages files from the mirror to work out what packages are
59 available
60 <li>Make temporary trees, one for each output image
61 <li>Set up volume information in each tree
62 <li>Copy in boot files and d-i bits onto each CD where they are wanted
63 <li>Copy documentation files onto CDs as required
64 <li>Copy packages files onto each CD; generate Packages metadata
65 files along the way
66 <li>Generate checksums of the files on each CD
67 <li>Run mkisofs to turn the temporary trees into ISO images and/or
68 jigdo files
69 </ul>
70
71 <p>This is a <strong>rough</strong> guide only - see later for more
72 details on each of the steps!</p>
73
74 <hr>
75 (c) Steve McIntyre &lt;[email protected]&gt;, December 2006. GPL v2<br>
76 <a href="getting.html">Next - Getting debian-cd</a>
77 </body>
78 </html>