README

   1 This is the top level of the FreeBSD source directory.  This file
   2 was last revised on: $Id$
   3
   4 For copyright information, please see the file COPYRIGHT in this
   5 directory (additional copyright information also exists for some
   6 sources in this tree - please see the specific source directories for
   7 more information).
   8
   9 The Makefile in this directory supports a number of targets for
  10 building components (or all) of the FreeBSD source tree, the most
  11 commonly used one being ``world'', which rebuilds and installs
  12 everything in the FreeBSD system from the source tree except the
  13 kernel.  Please see the top of the Makefile for more information on
  14 the standard build targets and compile-time flags.
  15
  16 Building a kernel with config(8) is a somewhat more involved process,
  17 documentation for which can be found at:
  18    http://www.freebsd.org/handbook/kernelconfig.html
  19 And in the config(8) man page.
  20
  21 The sample kernel configuration files reside in the sys/i386/conf
  22 sub-directory (assuming that you've installed the kernel sources), the
  23 file named GENERIC being the one used to build your initial installation
  24 kernel.  The file LINT contains entries for all possible devices, not
  25 just those commonly used, and is meant more as a general reference
  26 than an actual kernel configuration file (a kernel built from it
  27 wouldn't even run).
  28
  29
  30 Source Roadmap:
  31 ---------------
  32 bin             System/User commands.
  33
  34 contrib         Packages contributed by 3rd parties.
  35
  36 eBones          Kerberos package - NOT FOR EXPORT!
  37
  38 etc             Template files for /etc
  39
  40 games           Amusements.
  41
  42 gnu             Various commands and libraries under the GNU Public License.
  43                 Please see gnu/COPYING* for more information.
  44
  45 include         System include files.
  46
  47 lib             System libraries.
  48
  49 libexec         System daemons.
  50
  51 lkm             Loadable Kernel Modules.
  52
  53 release         Release building Makefile & associated tools.
  54
  55 sbin            System commands.
  56
  57 secure          DES and DES-related utilities - NOT FOR EXPORT!
  58
  59 share           Shared resources.
  60
  61 sys             Kernel sources.
  62
  63 tools           Utilities for regression testing and miscellaneous tasks.
  64
  65 usr.bin         User commands.
  66
  67 usr.sbin        System administration commands.
  68
  69
  70 For information on synchronizing your source tree with one or more of
  71 the FreeBSD Project's development branches, please see:
  72
  73   http://www.freebsd.org/handbook/synching.html