[dragonfly.git] / README

This is the top level of the DragonFly source directory.  This file
was last revised on:
$FreeBSD: src/README,v 1.15.2.4 2002/04/26 16:01:35 bmah Exp $
$DragonFly: src/README,v 1.9 2008/01/27 09:08:39 nth Exp $

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
building components (or all) of the DragonFly source tree, the most
commonly used being ``buildworld'' and ``installworld'', which rebuild
and install everything in the DragonFly system from the source tree
except the kernel, the kernel-modules and the contents of /etc.  The
``buildkernel'' and ``installkernel'' targets build and install
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.

Building a kernel is a somewhat involved process.  Documentation
for it can be found at:
   http://www.dragonflybsd.org/docs/handbook/
Also see the the build(7) and config(8) man pages.

Note: If you want to build and install the kernel with the
``buildkernel'' and ``installkernel'' targets, you might need to build
world before.  More information is available in the DragonFly handbook.

The sample kernel configuration files reside in the sys/config
sub-directory (assuming that you've installed the kernel sources), the
file named GENERIC being the one used to build your initial installation
kernel.  The file LINT contains entries for all possible devices, not
just those commonly used, and is meant more as a general reference
than an actual kernel configuration file (a kernel built from it
wouldn't even run).


Source Roadmap:
---------------
bin		System/user commands.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

games		Amusements.

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

include		System include files.

lib		System libraries.

libexec		System daemons.

nrelease	Framework for building the ``live'' CD image.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

sys		Kernel sources.

test		System tests.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.
Commit	Line	Data
b515e798	1	This is the top level of the DragonFly source directory. This file
984263bc MD	2	was last revised on:
984263bc MD	3	$FreeBSD: src/README,v 1.15.2.4 2002/04/26 16:01:35 bmah Exp $
d65c89ec	4	$DragonFly: src/README,v 1.9 2008/01/27 09:08:39 nth Exp $
984263bc MD	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
b515e798	12	building components (or all) of the DragonFly source tree, the most
587429e4 SW	13	commonly used being ``buildworld'' and ``installworld'', which rebuild
	14	and install everything in the DragonFly system from the source tree
	15	except the kernel, the kernel-modules and the contents of /etc. The
984263bc MD	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
b515e798 JR	21	Building a kernel is a somewhat involved process. Documentation
b515e798 JR	22	for it can be found at:
a754a615	23	http://www.dragonflybsd.org/docs/handbook/
587429e4	24	Also see the the build(7) and config(8) man pages.
b515e798	25
984263bc MD	26	Note: If you want to build and install the kernel with the
984263bc MD	27	``buildkernel'' and ``installkernel'' targets, you might need to build
587429e4	28	world before. More information is available in the DragonFly handbook.
984263bc	29
23e12d00	30	The sample kernel configuration files reside in the sys/config
984263bc MD	31	sub-directory (assuming that you've installed the kernel sources), the
	32	file named GENERIC being the one used to build your initial installation
	33	kernel. The file LINT contains entries for all possible devices, not
	34	just those commonly used, and is meant more as a general reference
	35	than an actual kernel configuration file (a kernel built from it
	36	wouldn't even run).
	37
	38
	39	Source Roadmap:
	40	---------------
	41	bin System/user commands.
	42
	43	contrib Packages contributed by 3rd parties.
	44
	45	crypto Cryptography stuff (see crypto/README).
	46
	47	etc Template files for /etc.
	48
	49	games Amusements.
	50
	51	gnu Various commands and libraries under the GNU Public License.
	52	Please see gnu/COPYING* for more information.
	53
	54	include System include files.
	55
984263bc MD	56	lib System libraries.
	57
	58	libexec System daemons.
	59
b515e798 JR	60	nrelease Framework for building the ``live'' CD image.
b515e798 JR	61
984263bc MD	62	sbin System commands.
	63
	64	secure Cryptographic libraries and commands.
	65
	66	share Shared resources.
	67
	68	sys Kernel sources.
	69
b515e798 JR	70	test System tests.
b515e798 JR	71
984263bc MD	72	tools Utilities for regression testing and miscellaneous tasks.
	73
	74	usr.bin User commands.
	75
	76	usr.sbin System administration commands.