README revision 281478
1This is the top level of the FreeBSD source directory. This file 2was last revised on: 3$FreeBSD: head/README 281478 2015-04-12 23:43:41Z eadler $ 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. 38 39 40Source Roadmap: 41--------------- 42bin System/user commands. 43 44cddl Various commands and libraries under the Common Development 45 and Distribution License. 46 47contrib Packages contributed by 3rd parties. 48 49crypto Cryptography stuff (see crypto/README). 50 51etc Template files for /etc. 52 53games Amusements. 54 55gnu Various commands and libraries under the GNU Public License. 56 Please see gnu/COPYING* for more information. 57 58include System include files. 59 60kerberos5 Kerberos5 (Heimdal) package. 61 62lib System libraries. 63 64libexec System daemons. 65 66release Release building Makefile & associated tools. 67 68rescue Build system for statically linked /rescue utilities. 69 70sbin System commands. 71 72secure Cryptographic libraries and commands. 73 74share Shared resources. 75 76sys Kernel sources. 77 78tests Regression tests which can be run by Kyua. See tests/README 79 for additional information. 80 81tools Utilities for regression testing and miscellaneous tasks. 82 83usr.bin User commands. 84 85usr.sbin System administration commands. 86 87 88For information on synchronizing your source tree with one or more of 89the FreeBSD Project's development branches, please see: 90 91 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html 92