README revision 281727
1This is the top level of the FreeBSD source directory. This file 2was last revised on: 3$FreeBSD: head/README 281727 2015-04-19 07:16:44Z 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. See build(7) 12and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html 13for more information, including setting make(1) variables. 14 15The `buildkernel` and `installkernel` targets build and install 16the kernel and the modules (see below). Please see the top of 17the Makefile in this directory for more information on the 18standard build targets and compile-time flags. 19 20Building a kernel is a somewhat more involved process. See build(7), config(8), 21and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html 22for more information. 23 24Note: If you want to build and install the kernel with the 25`buildkernel` and `installkernel` targets, you might need to build 26world before. More information is available in the handbook. 27 28The kernel configuration files reside in the sys/<arch>/conf 29sub-directory. GENERIC is the default configuration used in release builds. 30NOTES contains entries and documentation for all possible 31devices, not just those commonly used. 32 33 34Source Roadmap: 35--------------- 36 37bin System/user commands. 38 39cddl Various commands and libraries under the Common Development 40 and Distribution License. 41 42contrib Packages contributed by 3rd parties. 43 44crypto Cryptography stuff (see crypto/README). 45 46etc Template files for /etc. 47 48games Amusements. 49 50gnu Various commands and libraries under the GNU Public License. 51 Please see gnu/COPYING* for more information. 52 53include System include files. 54 55kerberos5 Kerberos5 (Heimdal) package. 56 57lib System libraries. 58 59libexec System daemons. 60 61release Release building Makefile & associated tools. 62 63rescue Build system for statically linked /rescue utilities. 64 65sbin System commands. 66 67secure Cryptographic libraries and commands. 68 69share Shared resources. 70 71sys Kernel sources. 72 73tests Regression tests which can be run by Kyua. See tests/README 74 for additional information. 75 76tools Utilities for regression testing and miscellaneous tasks. 77 78usr.bin User commands. 79 80usr.sbin System administration commands. 81 82 83For information on synchronizing your source tree with one or more of 84the FreeBSD Project's development branches, please see: 85 86 http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html 87