README 2.57 KB
Newer Older
1
This is the top level of the FreeBSD source directory.  This file
Peter Wemm's avatar
Peter Wemm committed
2
3
was last revised on:
$FreeBSD$
4
5
6
7
8
9
10

For copyright information, please see the file COPYRIGHT in this
directory (additional copyright information also exists for some
sources in this tree - please see the specific source directories for
more information).

The Makefile in this directory supports a number of targets for
Eitan Adler's avatar
Eitan Adler committed
11
building components (or all) of the FreeBSD source tree.  See build(7)
Eitan Adler's avatar
Eitan Adler committed
12
and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
13
14
for more information, including setting make(1) variables.

Eitan Adler's avatar
Eitan Adler committed
15
The `buildkernel` and `installkernel` targets build and install
16
17
18
the kernel and the modules (see below).  Please see the top of
the Makefile in this directory for more information on the
standard build targets and compile-time flags.
19

Eitan Adler's avatar
Eitan Adler committed
20
Building a kernel is a somewhat more involved process.  See build(7), config(8),
Eitan Adler's avatar
Eitan Adler committed
21
and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
Eitan Adler's avatar
Eitan Adler committed
22
23
for more information.

24
Note: If you want to build and install the kernel with the
Eitan Adler's avatar
Eitan Adler committed
25
`buildkernel` and `installkernel` targets, you might need to build
26
world before.  More information is available in the handbook.
27

Eitan Adler's avatar
Eitan Adler committed
28
29
30
The kernel configuration files reside in the sys/<arch>/conf
sub-directory.  GENERIC is the default configuration used in release builds.
NOTES contains entries and documentation for all possible
Eitan Adler's avatar
README:    
Eitan Adler committed
31
devices, not just those commonly used.
32
33
34
35


Source Roadmap:
---------------
Eitan Adler's avatar
Eitan Adler committed
36

Ruslan Ermilov's avatar
Ruslan Ermilov committed
37
bin		System/user commands.
38

Joel Dahl's avatar
Joel Dahl committed
39
40
41
cddl		Various commands and libraries under the Common Development
		and Distribution License.

42
43
contrib		Packages contributed by 3rd parties.

Alexander Langer's avatar
Alexander Langer committed
44
crypto		Cryptography stuff (see crypto/README).
45

Ruslan Ermilov's avatar
Ruslan Ermilov committed
46
etc		Template files for /etc.
47
48
49
50
51
52

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

Ruslan Ermilov's avatar
Ruslan Ermilov committed
53
54
kerberos5	Kerberos5 (Heimdal) package.

55
56
57
58
59
60
lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

61
62
rescue		Build system for statically linked /rescue utilities.

63
64
sbin		System commands.

65
secure		Cryptographic libraries and commands.
66
67
68
69
70

share		Shared resources.

sys		Kernel sources.

Eitan Adler's avatar
README:    
Eitan Adler committed
71
72
73
tests		Regression tests which can be run by Kyua.  See tests/README
		for additional information.

74
75
76
77
78
79
80
81
82
83
tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.


For information on synchronizing your source tree with one or more of
the FreeBSD Project's development branches, please see:

84
  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html