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