xref: /dragonfly/README (revision 8a7bdfea)
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.9 2008/01/27 09:08:39 nth 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 being ``buildworld'' and ``installworld'', which rebuild
14and install everything in the DragonFly system from the source tree
15except the kernel, 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://wiki.dragonflybsd.org/index.cgi/kernelconfig.html
24Also see the the build(7) and config(8) man pages.
25
26Note: If you want to build and install the kernel with the
27``buildkernel'' and ``installkernel'' targets, you might need to build
28world before.  More information is available in the DragonFly handbook.
29
30The sample kernel configuration files reside in the sys/config
31sub-directory (assuming that you've installed the kernel sources), the
32file named GENERIC being the one used to build your initial installation
33kernel.  The file LINT contains entries for all possible devices, not
34just those commonly used, and is meant more as a general reference
35than an actual kernel configuration file (a kernel built from it
36wouldn't even run).
37
38
39Source Roadmap:
40---------------
41bin		System/user commands.
42
43contrib		Packages contributed by 3rd parties.
44
45crypto		Cryptography stuff (see crypto/README).
46
47etc		Template files for /etc.
48
49games		Amusements.
50
51gnu		Various commands and libraries under the GNU Public License.
52		Please see gnu/COPYING* for more information.
53
54include		System include files.
55
56kerberos5	Kerberos5 (Heimdal) package.
57
58lib		System libraries.
59
60libexec		System daemons.
61
62nrelease	Framework for building the ``live'' CD image.
63
64sbin		System commands.
65
66secure		Cryptographic libraries and commands.
67
68share		Shared resources.
69
70sys		Kernel sources.
71
72test		System tests.
73
74tools		Utilities for regression testing and miscellaneous tasks.
75
76usr.bin		User commands.
77
78usr.sbin	System administration commands.
79