xref: /dragonfly/README (revision 2d8a3be7)
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$DragonFly: src/README,v 1.4 2003/08/14 18:27:49 asmodai Exp $
5
6For copyright information, please see the file COPYRIGHT in this
7directory (additional copyright information also exists for some
8sources in this tree - please see the specific source directories for
9more information).
10
11The Makefile in this directory supports a number of targets for
12building components (or all) of the FreeBSD source tree, the most
13commonly used one being ``world'', which rebuilds and installs
14everything in the FreeBSD system from the source tree except the
15kernel, the kernel-modules and the contents of /etc.  The
16``buildkernel'' and ``installkernel'' targets build and install
17the kernel and the modules (see below).  Please see the top of
18the Makefile in this directory for more information on the
19standard build targets and compile-time flags.
20
21Building a kernel is a somewhat more involved process, documentation
22for which can be found at:
23   http://www.FreeBSD.org/handbook/kernelconfig.html
24And in the config(8) man page.
25Note: If you want to build and install the kernel with the
26``buildkernel'' and ``installkernel'' targets, you might need to build
27world before.  More information is available in the handbook.
28
29The sample kernel configuration files reside in the sys/<arch>/conf
30sub-directory (assuming that you've installed the kernel sources), the
31file named GENERIC being the one used to build your initial installation
32kernel.  The file LINT contains entries for all possible devices, not
33just those commonly used, and is meant more as a general reference
34than an actual kernel configuration file (a kernel built from it
35wouldn't even run).
36
37
38Source Roadmap:
39---------------
40bin		System/user commands.
41
42contrib		Packages contributed by 3rd parties.
43
44crypto		Cryptography stuff (see crypto/README).
45
46etc		Template files for /etc.
47
48games		Amusements.
49
50gnu		Various commands and libraries under the GNU Public License.
51		Please see gnu/COPYING* for more information.
52
53include		System include files.
54
55kerberos5	Kerberos5 (Heimdal) package.
56
57lib		System libraries.
58
59libexec		System daemons.
60
61release		Release building Makefile & associated tools.
62
63sbin		System commands.
64
65secure		Cryptographic libraries and commands.
66
67share		Shared resources.
68
69sys		Kernel sources.
70
71tools		Utilities for regression testing and miscellaneous tasks.
72
73usr.bin		User commands.
74
75usr.sbin	System administration commands.
76