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