README revision 93217
12116SjkhThis is the top level of the FreeBSD source directory.  This file
22116Sjkhwas last revised on:
32116Sjkh$FreeBSD: head/README 93217 2002-03-26 12:35:49Z ru $
42116Sjkh
52116SjkhFor copyright information, please see the file COPYRIGHT in this
62116Sjkhdirectory (additional copyright information also exists for some
72116Sjkhsources in this tree - please see the specific source directories for
82116Sjkhmore information).
92116Sjkh
102116SjkhThe Makefile in this directory supports a number of targets for
112116Sjkhbuilding components (or all) of the FreeBSD source tree, the most
122116Sjkhcommonly used one being ``world'', which rebuilds and installs
132116Sjkheverything in the FreeBSD system from the source tree except the
142116Sjkhkernel, the kernel-modules and the contents of /etc.  The
152116Sjkh``buildkernel'' and ``installkernel'' targets build and install
162116Sjkhthe kernel and the modules (see below).  Please see the top of
172116Sjkhthe Makefile in this directory for more information on the
182116Sjkhstandard build targets and compile-time flags.
192116Sjkh
202116SjkhBuilding a kernel is a somewhat more involved process, documentation
212116Sjkhfor which can be found at:
222116Sjkh   http://www.FreeBSD.org/handbook/kernelconfig.html
232116SjkhAnd in the config(8) man page.
242116SjkhNote: If you want to build and install the kernel with the
252116Sjkh``buildkernel'' and ``installkernel'' targets, you might need to build
262116Sjkhworld before.  More information is available in the handbook.
272116Sjkh
282116SjkhThe sample kernel configuration files reside in the sys/<arch>/conf
292116Sjkhsub-directory (assuming that you've installed the kernel sources), the
302116Sjkhfile named GENERIC being the one used to build your initial installation
312116Sjkhkernel.  The file NOTES contains entries and documentation for all possible
322116Sjkhdevices, not just those commonly used.  It is the successor of the ancient
332116SjkhLINT file, but in contrast to LINT, it is not buildable as a kernel but a
342116Sjkhpure reference and documentation file.
352116Sjkh
3623577Sbde
372116SjkhSource Roadmap:
3850476Speter---------------
392116Sjkhbin		System/user commands.
40141280Sdas
412116Sjkhcontrib		Packages contributed by 3rd parties.
422116Sjkh
432116Sjkhcrypto		Cryptography stuff (see crypto/README).
44192760Sattilio
45etc		Template files for /etc.
46
47games		Amusements.
48
49gnu		Various commands and libraries under the GNU Public License.
50		Please see gnu/COPYING* for more information.
51
52include		System include files.
53
54kerberos5	Kerberos5 (Heimdal) package.
55
56kerberosIV	KerberosIV (eBones) package.
57
58lib		System libraries.
59
60libexec		System daemons.
61
62release		Release building Makefile & associated tools.
63
64sbin		System commands.
65
66secure		Cryptographic libraries and commands.
67
68share		Shared resources.
69
70sys		Kernel sources.
71
72tools		Utilities for regression testing and miscellaneous tasks.
73
74usr.bin		User commands.
75
76usr.sbin	System administration commands.
77
78
79For information on synchronizing your source tree with one or more of
80the FreeBSD Project's development branches, please see:
81
82  http://www.FreeBSD.org/handbook/synching.html
83