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