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