xref: /dragonfly/README (revision 333227be)
1This is the top level of the DragonFly 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.5 2004/01/31 08:52:16 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 DragonFly source tree, the most
13commonly used one being ``world'', which rebuilds and installs
14everything in the DragonFly 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 involved process.  Documentation
22for it can be found at:
23   http://www.FreeBSD.org/handbook/kernelconfig.html
24Although the above reference is FreeBSD-specific, it is also generally
25applicable to DragonFly.  Also see the the config(8) man page.
26
27Note: If you want to build and install the kernel with the
28``buildkernel'' and ``installkernel'' targets, you might need to build
29world before.  More information is available in the FreeBSD handbook.
30
31The sample kernel configuration files reside in the sys/<arch>/conf
32sub-directory (assuming that you've installed the kernel sources), the
33file named GENERIC being the one used to build your initial installation
34kernel.  The file LINT contains entries for all possible devices, not
35just those commonly used, and is meant more as a general reference
36than an actual kernel configuration file (a kernel built from it
37wouldn't even run).
38
39
40Source Roadmap:
41---------------
42bin		System/user commands.
43
44contrib		Packages contributed by 3rd parties.
45
46crypto		Cryptography stuff (see crypto/README).
47
48etc		Template files for /etc.
49
50games		Amusements.
51
52gnu		Various commands and libraries under the GNU Public License.
53		Please see gnu/COPYING* for more information.
54
55include		System include files.
56
57kerberos5	Kerberos5 (Heimdal) package.
58
59lib		System libraries.
60
61libexec		System daemons.
62
63nrelease	Framework for building the ``live'' CD image.
64
65release		Release building Makefile & associated tools.
66
67sbin		System commands.
68
69secure		Cryptographic libraries and commands.
70
71share		Shared resources.
72
73sys		Kernel sources.
74
75test		System tests.
76
77tools		Utilities for regression testing and miscellaneous tasks.
78
79usr.bin		User commands.
80
81usr.sbin	System administration commands.
82