README revision 21369
121173SjkhThis is the top level of the FreeBSD source directory.  This file
221369Smaxwas last revised on: $Id: README,v 1.7 1997/01/01 14:06:29 jkh Exp $
321173Sjkh
421173SjkhFor copyright information, please see the file COPYRIGHT in this
521173Sjkhdirectory (additional copyright information also exists for some
621173Sjkhsources in this tree - please see the specific source directories for
721173Sjkhmore information).
821173Sjkh
921173SjkhThe Makefile in this directory supports a number of targets for
1021173Sjkhbuilding components (or all) of the FreeBSD source tree, the most
1121173Sjkhcommonly used one being ``world'', which rebuilds and installs
1221173Sjkheverything in the FreeBSD system from the source tree except the
1321173Sjkhkernel.  Please see the top of the Makefile for more information on
1421173Sjkhthe standard build targets and compile-time flags.
1521173Sjkh
1621369SmaxBuilding a kernel with config(8) is a somewhat more involved process,
1721173Sjkhdocumentation for which can be found at:
1821173Sjkh   http://www.freebsd.org/handbook/kernelconfig.html
1921369SmaxAnd in the config(8) man page.
2021173Sjkh
2121173SjkhThe sample kernel configuration files reside in the sys/i386/conf
2221173Sjkhsub-directory (assuming that you've installed the kernel sources), the
2321173Sjkhfile named GENERIC being the one used to build your initial installation
2421173Sjkhkernel.  The file LINT contains entries for all possible devices, not
2521173Sjkhjust those commonly used, and is meant more as a general reference
2621173Sjkhthan an actual kernel configuration file (a kernel built from it
2721173Sjkhwouldn't even run).
2821173Sjkh
2921173Sjkh
3021173SjkhSource Roadmap:
3121173Sjkh---------------
3221173Sjkhbin		System/User commands.
3321173Sjkh
3421173Sjkhcontrib		Packages contributed by 3rd parties.
3521173Sjkh
3621173SjkheBones		Kerberos package - NOT FOR EXPORT!
3721173Sjkh
3821173Sjkhetc		Template files for /etc
3921173Sjkh
4021173Sjkhgames		Amusements.
4121173Sjkh
4221173Sjkhgnu		Various commands and libraries under the GNU Public License.
4321173Sjkh		Please see gnu/COPYING* for more information.
4421173Sjkh
4521173Sjkhinclude		System include files.
4621173Sjkh
4721173Sjkhlib		System libraries.
4821173Sjkh
4921173Sjkhlibexec		System daemons.
5021173Sjkh
5121173Sjkhlkm		Loadable Kernel Modules.
5221173Sjkh
5321173Sjkhrelease		Release building Makefile & associated tools.
5421173Sjkh
5521173Sjkhsbin		System commands.
5621173Sjkh
5721173Sjkhsecure		DES and DES-related utilities - NOT FOR EXPORT!
5821173Sjkh
5921173Sjkhshare		Shared resources.
6021173Sjkh
6121173Sjkhsys		Kernel sources.
6221173Sjkh
6321173Sjkhtools		Utilities for regression testing and miscellaneous tasks.
6421173Sjkh
6521173Sjkhusr.bin		User commands.
6621173Sjkh
6721173Sjkhusr.sbin	System administration commands.
6821173Sjkh
6921173Sjkh
7021173SjkhFor information on synchronizing your source tree with one or more of
7121173Sjkhthe FreeBSD Project's development branches, please see:
7221173Sjkh
7321173Sjkh  http://www.freebsd.org/handbook/synching.html
74