release/doc/en_US.ISO8859-1/installation/common/layout.sgml

   1 <!--
   2         $FreeBSD: src/release/doc/en_US.ISO8859-1/installation/common/layout.sgml,v 1.1.2.4 2002/10/15 21:41:42 bmah Exp $
   3         $DragonFly: src/release/doc/en_US.ISO8859-1/installation/common/Attic/layout.sgml,v 1.2 2003/06/17 04:27:19 dillon Exp $
   4
   5         This section contains the contents of the old LAYOUT.TXT file.
   6 -->
   7 <sect1 id="layout">
   8   <title>Distribution Format</title>
   9
  10   <para>A typical &os; distribution directory looks something like this:</para>
  11
  12 <screen>ERRATA.HTM      README.TXT      compat1x        dict            kernel
  13 ERRATA.TXT      RELNOTES.HTM    compat20        doc             manpages
  14 HARDWARE.HTM    RELNOTES.TXT    compat21        docbook.css     packages
  15 HARDWARE.TXT    bin             compat22        filename.txt    ports
  16 INSTALL.HTM     boot            compat3x        floppies        proflibs
  17 INSTALL.TXT     catpages        compat4x        games           src
  18 README.HTM      cdrom.inf       crypto          info            tools</screen>
  19
  20   <para>If you want to do a CDROM, FTP or NFS installation from this
  21   distribution directory, all you need to do is make the 1.44MB boot
  22   floppies from the floppies directory (see
  23   <xref linkend="floppies"> for instructions on how to
  24   do this), boot them and follow the instructions.  The rest of the
  25   data needed during the installation will be obtained automatically
  26   based on your selections.  If you've never installed &os; before,
  27   you also want to read the entirety of this document (the
  28   installation instructions) file.</para>
  29
  30   <para>If you're trying to do some other type of installation or are
  31   merely curious about how a distribution is organized, what follows
  32   is a more thorough description of some of these items in more detail:
  33     <orderedlist>
  34       <listitem>
  35         <para>The <filename>*.TXT</filename> and
  36         <filename>*.HTM</filename> files contain
  37         documentation (for example, this document is contained in both
  38         <filename>INSTALL.TXT</filename> and
  39         <filename>INSTALL.HTM</filename>) and should be read
  40         before starting an installation.  The
  41         <filename>*.TXT</filename> files are plain text, while the
  42         <filename>*.HTM</filename> files are HTML files that can be
  43         read by almost any Web browser.  Some distributions may
  44         contain documentation in other formats as well, such as PDF or
  45         PostScript.</para>
  46       </listitem>
  47       <listitem>
  48         <para><filename>docbook.css</filename> is a Cascading Style
  49         Sheet (CSS) file used by some Web browsers for formatting the
  50         HTML documentation.
  51       </listitem>
  52       <listitem>
  53         <para>The <filename>bin</filename>,
  54         <filename>catpages</filename>,
  55         <filename>crypto</filename>,
  56         <filename>dict</filename>,
  57         <filename>doc</filename>,
  58         <filename>games</filename>,
  59         <filename>info</filename>,
  60         <filename>manpages</filename>,
  61         <filename>proflibs</filename>, and
  62         <filename>src</filename> directories contain the primary distribution
  63         components of &os; itself and are split into smaller files
  64         for easy packing onto floppies (should that be
  65         necessary).</para>
  66       </listitem>
  67       <listitem>
  68         <para>The <filename>compat1x</filename>,
  69         <filename>compat20</filename>,
  70         <filename>compat21</filename>,
  71         <filename>compat22</filename>,
  72         <filename>compat3x</filename>, and
  73         <filename>compat4x</filename>
  74         directories contain distributions for compatibility with older
  75         releases and are distributed as single gzip'd tar files - they
  76         can be installed during release time or later by running their
  77         <filename>install.sh</filename> scripts.</para>
  78       </listitem>
  79       <listitem>
  80         <para>The <filename>floppies/</filename> subdirectory contains the floppy
  81         installation images; further information on using them can be
  82         found in <xref linkend="floppies">.</para>
  83       </listitem>
  84       <listitem>
  85         <para>The <filename>packages</filename> and <filename>ports</filename> directories contain the &os;
  86         Packages and Ports Collections.  Packages may be installed from
  87         the packages directory by running the command:</para>
  88
  89         <screen>&prompt.root;<userinput>/stand/sysinstall configPackages</userinput></screen>
  90
  91         <para>Packages can also be installed by feeding individual
  92         filenames in <filename>packages</filename>/ to the &man.pkg.add.1; command.</para>
  93
  94         <para>The Ports Collection may be installed like any other
  95         distribution and requires about 100MB unpacked.  More
  96         information on the ports collection may be obtained from
  97         <ulink url="http://www.FreeBSD.org/ports/">http://www.FreeBSD.org/ports/</ulink> or locally from
  98         <filename>/usr/share/doc/handbook</filename> if you've installed the <filename>doc</filename>
  99         distribution.</para>
 100       </listitem>
 101       <listitem>
 102         <para>Last of all, the <filename>tools</filename> directory contains various DOS
 103         tools for discovering disk geometries, installing boot managers
 104         and the like.  It is purely optional and provided only for user
 105         convenience.</para>
 106       </listitem>
 107     </orderedlist>
 108   </para>
 109
 110   <para>A typical distribution directory (for example, the <filename>info</filename> distribution) looks like this internally:</para>
 111
 112 <screen>CHECKSUM.MD5    info.ab         info.ad         info.inf        install.sh
 113 info.aa         info.ac         info.ae         info.mtree</screen>
 114
 115   <para>The <filename>CHECKSUM.MD5</filename> file contains MD5 signatures for each file,
 116   should data corruption be suspected, and is purely for reference. It
 117   is not used by the actual installation and does not need to be
 118   copied with the rest of the distribution files.  The <filename>info.a*</filename> files
 119   are split, gzip'd tar files, the contents of which can be viewed by
 120   doing:</para>
 121
 122   <screen>&prompt.root; <userinput>cat info.a* | tar tvzf -</userinput></screen>
 123
 124   <para>During installation, they are automatically concatenated and
 125   extracted by the installation procedure.</para>
 126
 127   <para>The <filename>info.inf</filename> file is also necessary since it is read by the
 128   installation program in order to figure out how many pieces to look
 129   for when fetching and concatenating the distribution.  When putting
 130   distributions onto floppies, the <filename>.inf</filename> file <emphasis>must</emphasis> occupy the first
 131   floppy of each distribution set!</para>
 132
 133   <para>The <filename>info.mtree</filename> file is another non-essential file which is
 134   provided for user reference.  It contains the MD5 signatures of the
 135   <emphasis>unpacked</emphasis> distribution files and can be later
 136   used with the &man.mtree.8; program to verify the installation
 137   permissions and checksums against any possible modifications to the
 138   file.  When used with the <filename>bin</filename> distribution,
 139   this can be an excellent way of detecting trojan horse attacks on
 140   your system.</para>
 141
 142   <para>Finally, the <filename>install.sh</filename> file is for use
 143   by those who want to install the distribution after installation
 144   time.  To install the info distribution from CDROM after a system
 145   was installed, for example, you'd do:</para>
 146
 147   <screen>&prompt.root; <userinput>cd /cdrom/info</userinput>
 148 &prompt.root; <userinput>sh install.sh</userinput></screen>
 149 </sect1>