README

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