Initial import from FreeBSD RELENG_4:
[dragonfly.git] / README
CommitLineData
984263bc
MD
1This is the top level of the FreeBSD source directory. This file
2was last revised on:
3$FreeBSD: src/README,v 1.15.2.4 2002/04/26 16:01:35 bmah Exp $
4
5For copyright information, please see the file COPYRIGHT in this
6directory (additional copyright information also exists for some
7sources in this tree - please see the specific source directories for
8more information).
9
10The Makefile in this directory supports a number of targets for
11building components (or all) of the FreeBSD source tree, the most
12commonly used one being ``world'', which rebuilds and installs
13everything in the FreeBSD system from the source tree except the
14kernel, the kernel-modules and the contents of /etc. The
15``buildkernel'' and ``installkernel'' targets build and install
16the kernel and the modules (see below). Please see the top of
17the Makefile in this directory for more information on the
18standard build targets and compile-time flags.
19
20Building a kernel is a somewhat more involved process, documentation
21for which can be found at:
22 http://www.FreeBSD.org/handbook/kernelconfig.html
23And in the config(8) man page.
24Note: If you want to build and install the kernel with the
25``buildkernel'' and ``installkernel'' targets, you might need to build
26world before. More information is available in the handbook.
27
28The sample kernel configuration files reside in the sys/<arch>/conf
29sub-directory (assuming that you've installed the kernel sources), the
30file named GENERIC being the one used to build your initial installation
31kernel. The file LINT contains entries for all possible devices, not
32just those commonly used, and is meant more as a general reference
33than an actual kernel configuration file (a kernel built from it
34wouldn't even run).
35
36
37Source Roadmap:
38---------------
39bin System/user commands.
40
41contrib Packages contributed by 3rd parties.
42
43crypto Cryptography stuff (see crypto/README).
44
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