xref: /freebsd-12.1/README (revision 110aebf7)
1*110aebf7SPeter WemmThis is the top level of the FreeBSD source directory.  This file
24e6fa1a5SPeter Wemmwas last revised on:
3*110aebf7SPeter Wemm$FreeBSD$
44e6fa1a5SPeter Wemm
54e6fa1a5SPeter WemmFreeBSD is an operating system used to power modern servers,
64e6fa1a5SPeter Wemmdesktops, and embedded platforms. A large community has
74e6fa1a5SPeter Wemmcontinually developed it for more than thirty years. Its
8*110aebf7SPeter Wemmadvanced networking, security, and storage features have
9*110aebf7SPeter Wemmmade FreeBSD the platform of choice for many of the
10*110aebf7SPeter Wemmbusiest web sites and most pervasive embedded networking
11*110aebf7SPeter Wemmand storage devices.
124e6fa1a5SPeter Wemm
134e6fa1a5SPeter WemmFor copyright information, please see the file COPYRIGHT in this
144e6fa1a5SPeter Wemmdirectory. Additional copyright information also exists for some
154e6fa1a5SPeter Wemmsources in this tree - please see the specific source directories for
161f89a666SPeter Wemmmore information.
174e6fa1a5SPeter Wemm
181f89a666SPeter WemmThe Makefile in this directory supports a number of targets for
194e6fa1a5SPeter Wemmbuilding components (or all) of the FreeBSD source tree.  See build(7), config(8),
20*110aebf7SPeter Wemmhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
21*110aebf7SPeter Wemmhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
221f89a666SPeter Wemmfor more information, including setting make(1) variables.
231f89a666SPeter Wemm
241f89a666SPeter WemmSource Roadmap:
254e6fa1a5SPeter Wemm---------------
261f89a666SPeter Wemm
278fb9cce2SPeter Wemmbin		System/user commands.
284e6fa1a5SPeter Wemm
294e6fa1a5SPeter Wemmcddl		Various commands and libraries under the Common Development
30*110aebf7SPeter Wemm		and Distribution License.
314e6fa1a5SPeter Wemm
321f89a666SPeter Wemmcontrib		Packages contributed by 3rd parties.
334e6fa1a5SPeter Wemm
341f89a666SPeter Wemmcrypto		Cryptography stuff (see crypto/README).
354e6fa1a5SPeter Wemm
361f89a666SPeter Wemmetc		Template files for /etc.
371f89a666SPeter Wemm
381f89a666SPeter Wemmgnu		Various commands and libraries under the GNU Public License.
391f89a666SPeter Wemm		Please see gnu/COPYING* for more information.
401f89a666SPeter Wemm
411f89a666SPeter Wemminclude		System include files.
421f89a666SPeter Wemm
431f89a666SPeter Wemmkerberos5	Kerberos5 (Heimdal) package.
441f89a666SPeter Wemm
451f89a666SPeter Wemmlib		System libraries.
461f89a666SPeter Wemm
471f89a666SPeter Wemmlibexec		System daemons.
481f89a666SPeter Wemm
491f89a666SPeter Wemmrelease		Release building Makefile & associated tools.
501f89a666SPeter Wemm
511f89a666SPeter Wemmrescue		Build system for statically linked /rescue utilities.
521f89a666SPeter Wemm
531f89a666SPeter Wemmsbin		System commands.
541f89a666SPeter Wemm
551f89a666SPeter Wemmsecure		Cryptographic libraries and commands.
568fb9cce2SPeter Wemm
578fb9cce2SPeter Wemmshare		Shared resources.
588fb9cce2SPeter Wemm
598fb9cce2SPeter Wemmstand		Boot loader sources.
608fb9cce2SPeter Wemm
618fb9cce2SPeter Wemmsys		Kernel sources.
621f89a666SPeter Wemm
631f89a666SPeter Wemmsys/<arch>/conf Kernel configuration files. GENERIC is the configuration
641f89a666SPeter Wemm		used in release builds. NOTES contains documentation of
651f89a666SPeter Wemm		all possible entries.
661f89a666SPeter Wemm
671f89a666SPeter Wemmtests		Regression tests which can be run by Kyua.  See tests/README
681f89a666SPeter Wemm		for additional information.
691f89a666SPeter Wemm
701f89a666SPeter Wemmtools		Utilities for regression testing and miscellaneous tasks.
711f89a666SPeter Wemm
72*110aebf7SPeter Wemmusr.bin		User commands.
731f89a666SPeter Wemm
741f89a666SPeter Wemmusr.sbin	System administration commands.
751f89a666SPeter Wemm
761f89a666SPeter Wemm
771f89a666SPeter WemmFor information on synchronizing your source tree with one or more of
781f89a666SPeter Wemmthe FreeBSD Project's development branches, please see:
791f89a666SPeter Wemm
801f89a666SPeter Wemm  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
811f89a666SPeter Wemm