README revision 39122
1This is the top level of the FreeBSD source directory.  This file
2was last revised on: $Id: README,v 1.12 1998/06/30 08:08:05 jkh Exp $
3
4For copyright information, please see the file COPYRIGHT in this
5directory (additional copyright information also exists for some
6sources in this tree - please see the specific source directories for
7more information).
8
9The Makefile in this directory supports a number of targets for
10building components (or all) of the FreeBSD source tree, the most
11commonly used one being ``world'', which rebuilds and installs
12everything in the FreeBSD system from the source tree except the
13kernel and the contents of /etc.  Please see the top of the Makefile
14in this directory for more information on the standard build targets
15and compile-time flags.
16
17Building a kernel with config(8) is a somewhat more involved process,
18documentation for which can be found at:
19   http://www.freebsd.org/handbook/kernelconfig.html
20And in the config(8) man page.
21
22The sample kernel configuration files reside in the sys/i386/conf
23sub-directory (assuming that you've installed the kernel sources), the
24file named GENERIC being the one used to build your initial installation
25kernel.  The file LINT contains entries for all possible devices, not
26just those commonly used, and is meant more as a general reference
27than an actual kernel configuration file (a kernel built from it
28wouldn't even run).
29
30
31Source Roadmap:
32---------------
33bin		System/User commands.
34
35contrib		Packages contributed by 3rd parties.
36
37crypto		Export controlled stuff (see crypto/README).
38
39etc		Template files for /etc
40
41games		Amusements.
42
43gnu		Various commands and libraries under the GNU Public License.
44		Please see gnu/COPYING* for more information.
45
46include		System include files.
47
48kerberosIV	Kerberos package.
49
50lib		System libraries.
51
52libexec		System daemons.
53
54lkm		Loadable Kernel Modules.
55
56release		Release building Makefile & associated tools.
57
58sbin		System commands.
59
60secure		DES and DES-related utilities - NOT FOR EXPORT!
61
62share		Shared resources.
63
64sys		Kernel sources.
65
66tools		Utilities for regression testing and miscellaneous tasks.
67
68usr.bin		User commands.
69
70usr.sbin	System administration commands.
71
72
73For information on synchronizing your source tree with one or more of
74the FreeBSD Project's development branches, please see:
75
76  http://www.freebsd.org/handbook/synching.html
77