README revision 37283
121173SjkhThis is the top level of the FreeBSD source directory.  This file
237283Sjkhwas last revised on: $Id: README,v 1.11 1997/08/09 14:36:20 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
1328014Sjkhkernel and the contents of /etc.  Please see the top of the Makefile
1428014Sjkhin this directory for more information on the standard build targets
1528014Sjkhand compile-time flags.
1621173Sjkh
1721369SmaxBuilding a kernel with config(8) is a somewhat more involved process,
1821173Sjkhdocumentation for which can be found at:
1921173Sjkh   http://www.freebsd.org/handbook/kernelconfig.html
2021369SmaxAnd in the config(8) man page.
2121173Sjkh
2221173SjkhThe sample kernel configuration files reside in the sys/i386/conf
2321173Sjkhsub-directory (assuming that you've installed the kernel sources), the
2421173Sjkhfile named GENERIC being the one used to build your initial installation
2521173Sjkhkernel.  The file LINT contains entries for all possible devices, not
2621173Sjkhjust those commonly used, and is meant more as a general reference
2721173Sjkhthan an actual kernel configuration file (a kernel built from it
2821173Sjkhwouldn't even run).
2921173Sjkh
3021173Sjkh
3121173SjkhSource Roadmap:
3221173Sjkh---------------
3321173Sjkhbin		System/User commands.
3421173Sjkh
3521173Sjkhcontrib		Packages contributed by 3rd parties.
3621173Sjkh
3737283Sjkhcrypto		Export controlled stuff (see crypto/README).
3821173Sjkh
3921173Sjkhetc		Template files for /etc
4021173Sjkh
4121173Sjkhgames		Amusements.
4221173Sjkh
4321173Sjkhgnu		Various commands and libraries under the GNU Public License.
4421173Sjkh		Please see gnu/COPYING* for more information.
4521173Sjkh
4621173Sjkhinclude		System include files.
4721173Sjkh
4837283SjkhkerberosIV	Kerberos package - also export controlled.
4937283Sjkh
5021173Sjkhlib		System libraries.
5121173Sjkh
5221173Sjkhlibexec		System daemons.
5321173Sjkh
5421173Sjkhlkm		Loadable Kernel Modules.
5521173Sjkh
5621173Sjkhrelease		Release building Makefile & associated tools.
5721173Sjkh
5821173Sjkhsbin		System commands.
5921173Sjkh
6021173Sjkhsecure		DES and DES-related utilities - NOT FOR EXPORT!
6121173Sjkh
6221173Sjkhshare		Shared resources.
6321173Sjkh
6421173Sjkhsys		Kernel sources.
6521173Sjkh
6621173Sjkhtools		Utilities for regression testing and miscellaneous tasks.
6721173Sjkh
6821173Sjkhusr.bin		User commands.
6921173Sjkh
7021173Sjkhusr.sbin	System administration commands.
7121173Sjkh
7221173Sjkh
7321173SjkhFor information on synchronizing your source tree with one or more of
7421173Sjkhthe FreeBSD Project's development branches, please see:
7521173Sjkh
7621173Sjkh  http://www.freebsd.org/handbook/synching.html
77