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, the kernel-modules and the contents of /etc.  The ``world''
  15 target should only be used in cases where the source tree has not
  16 changed from the currently running version.  See:
  17 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
  18 for more information, including setting make(1) variables.
  19
  20 The ``buildkernel'' and ``installkernel'' targets build and install
  21 the kernel and the modules (see below).  Please see the top of
  22 the Makefile in this directory for more information on the
  23 standard build targets and compile-time flags.
  24
  25 Building a kernel is a somewhat more involved process, documentation
  26 for which can be found at:
  27    http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
  28 And in the config(8) man page.
  29 Note: If you want to build and install the kernel with the
  30 ``buildkernel'' and ``installkernel'' targets, you might need to build
  31 world before.  More information is available in the handbook.
  32
  33 The sample kernel configuration files reside in the sys/<arch>/conf
  34 sub-directory (assuming that you've installed the kernel sources), the
  35 file named GENERIC being the one used to build your initial installation
  36 kernel.  The file NOTES contains entries and documentation for all possible
  37 devices, not just those commonly used.  It is the successor of the ancient
  38 LINT file, but in contrast to LINT, it is not buildable as a kernel but a
  39 pure reference and documentation file.
  40
  41
  42 Source Roadmap:
  43 ---------------
  44 bin             System/user commands.
  45
  46 contrib         Packages contributed by 3rd parties.
  47
  48 crypto          Cryptography stuff (see crypto/README).
  49
  50 etc             Template files for /etc.
  51
  52 games           Amusements.
  53
  54 gnu             Various commands and libraries under the GNU Public License.
  55                 Please see gnu/COPYING* for more information.
  56
  57 include         System include files.
  58
  59 kerberos5       Kerberos5 (Heimdal) package.
  60
  61 lib             System libraries.
  62
  63 libexec         System daemons.
  64
  65 release         Release building Makefile & associated tools.
  66
  67 rescue          Build system for statically linked /rescue utilities.
  68
  69 sbin            System commands.
  70
  71 secure          Cryptographic libraries and commands.
  72
  73 share           Shared resources.
  74
  75 sys             Kernel sources.
  76
  77 tools           Utilities for regression testing and miscellaneous tasks.
  78
  79 usr.bin         User commands.
  80
  81 usr.sbin        System administration commands.
  82
  83
  84 For information on synchronizing your source tree with one or more of
  85 the FreeBSD Project's development branches, please see:
  86
  87   http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html