README revision 159363
1This is the top level of the FreeBSD source directory. This file 2was last revised on: 3$FreeBSD: head/README 159363 2006-06-07 03:33:48Z trhodes $ 4 5For copyright information, please see the file COPYRIGHT in this 6directory (additional copyright information also exists for some 7sources in this tree - please see the specific source directories for 8more information). 9 10The Makefile in this directory supports a number of targets for 11building components (or all) of the FreeBSD source tree, the most 12commonly used one being ``world'', which rebuilds and installs 13everything in the FreeBSD system from the source tree except the 14kernel, the kernel-modules and the contents of /etc. The ``world'' 15target should only be used in cases where the source tree has not 16changed from the currently running version. See: 17http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html 18for more information, including setting make(1) variables. 19 20The ``buildkernel'' and ``installkernel'' targets build and install 21the kernel and the modules (see below). Please see the top of 22the Makefile in this directory for more information on the 23standard build targets and compile-time flags. 24 25Building a kernel is a somewhat more involved process, documentation 26for which can be found at: 27 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html 28And in the config(8) man page. 29Note: If you want to build and install the kernel with the 30``buildkernel'' and ``installkernel'' targets, you might need to build 31world before. More information is available in the handbook. 32 33The sample kernel configuration files reside in the sys/<arch>/conf 34sub-directory (assuming that you've installed the kernel sources), the 35file named GENERIC being the one used to build your initial installation 36kernel. The file NOTES contains entries and documentation for all possible 37devices, not just those commonly used. It is the successor of the ancient 38LINT file, but in contrast to LINT, it is not buildable as a kernel but a 39pure reference and documentation file. 40 41 42Source Roadmap: 43--------------- 44bin System/user commands. 45 46contrib Packages contributed by 3rd parties. 47 48crypto Cryptography stuff (see crypto/README). 49 50etc Template files for /etc. 51 52games Amusements. 53 54gnu Various commands and libraries under the GNU Public License. 55 Please see gnu/COPYING* for more information. 56 57include System include files. 58 59kerberos5 Kerberos5 (Heimdal) package. 60 61lib System libraries. 62 63libexec System daemons. 64 65release Release building Makefile & associated tools. 66 67rescue Build system for statically linked /rescue utilities. 68 69sbin System commands. 70 71secure Cryptographic libraries and commands. 72 73share Shared resources. 74 75sys Kernel sources. 76 77tools Utilities for regression testing and miscellaneous tasks. 78 79usr.bin User commands. 80 81usr.sbin System administration commands. 82 83 84For information on synchronizing your source tree with one or more of 85the FreeBSD Project's development branches, please see: 86 87 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html 88