xref: /freebsd-13.1/README (revision f91319d4)
1d20f8f69SJordan K. HubbardThis is the top level of the FreeBSD source directory.  This file
297d92980SPeter Wemmwas last revised on:
397d92980SPeter Wemm$FreeBSD$
4d20f8f69SJordan K. Hubbard
57c063179SEitan AdlerFreeBSD is an operating system used to power modern servers,
67c063179SEitan Adlerdesktops, and embedded platforms. A large community has
77c063179SEitan Adlercontinually developed it for more than thirty years. Its
87c063179SEitan Adleradvanced networking, security, and storage features have
97c063179SEitan Adlermade FreeBSD the platform of choice for many of the
107c063179SEitan Adlerbusiest web sites and most pervasive embedded networking
117c063179SEitan Adlerand storage devices.
127c063179SEitan Adler
13d20f8f69SJordan K. HubbardFor copyright information, please see the file COPYRIGHT in this
147c063179SEitan Adlerdirectory. Additional copyright information also exists for some
15d20f8f69SJordan K. Hubbardsources in this tree - please see the specific source directories for
167c063179SEitan Adlermore information.
17d20f8f69SJordan K. Hubbard
18d20f8f69SJordan K. HubbardThe Makefile in this directory supports a number of targets for
197c063179SEitan Adlerbuilding components (or all) of the FreeBSD source tree.  See build(7), config(8),
207c063179SEitan Adlerhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
217c063179SEitan Adlerhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
22fb55e855STom Rhodesfor more information, including setting make(1) variables.
23fb55e855STom Rhodes
24d20f8f69SJordan K. HubbardSource Roadmap:
25d20f8f69SJordan K. Hubbard---------------
2694ec8566SEitan Adler
27d74e4cbcSRuslan Ermilovbin		System/user commands.
28d20f8f69SJordan K. Hubbard
29fcd01b8aSJoel Dahlcddl		Various commands and libraries under the Common Development
30fcd01b8aSJoel Dahl		and Distribution License.
31fcd01b8aSJoel Dahl
32d20f8f69SJordan K. Hubbardcontrib		Packages contributed by 3rd parties.
33d20f8f69SJordan K. Hubbard
341368d692SAlexander Langercrypto		Cryptography stuff (see crypto/README).
35d20f8f69SJordan K. Hubbard
36d74e4cbcSRuslan Ermilovetc		Template files for /etc.
37d20f8f69SJordan K. Hubbard
38*f91319d4SEd Mastegnu		Commands and libraries under the GNU General Public License
39*f91319d4SEd Maste		(GPL) or Lesser General Public License (LGPL).  Please see
40*f91319d4SEd Maste		gnu/COPYING* for more information.
41d20f8f69SJordan K. Hubbard
42d20f8f69SJordan K. Hubbardinclude		System include files.
43d20f8f69SJordan K. Hubbard
44d74e4cbcSRuslan Ermilovkerberos5	Kerberos5 (Heimdal) package.
45d74e4cbcSRuslan Ermilov
46d20f8f69SJordan K. Hubbardlib		System libraries.
47d20f8f69SJordan K. Hubbard
48d20f8f69SJordan K. Hubbardlibexec		System daemons.
49d20f8f69SJordan K. Hubbard
50d20f8f69SJordan K. Hubbardrelease		Release building Makefile & associated tools.
51d20f8f69SJordan K. Hubbard
52a452d38eSCeri Daviesrescue		Build system for statically linked /rescue utilities.
53a452d38eSCeri Davies
54d20f8f69SJordan K. Hubbardsbin		System commands.
55d20f8f69SJordan K. Hubbard
56cc2e9757SMark Murraysecure		Cryptographic libraries and commands.
57d20f8f69SJordan K. Hubbard
58d20f8f69SJordan K. Hubbardshare		Shared resources.
59d20f8f69SJordan K. Hubbard
608960a019SMark Johnstonstand		Boot loader sources.
618960a019SMark Johnston
62d20f8f69SJordan K. Hubbardsys		Kernel sources.
63d20f8f69SJordan K. Hubbard
640eba55c3SEitan Adlersys/<arch>/conf Kernel configuration files. GENERIC is the configuration
650eba55c3SEitan Adler		used in release builds. NOTES contains documentation of
660eba55c3SEitan Adler		all possible entries.
677c063179SEitan Adler
680a68701fSEitan Adlertests		Regression tests which can be run by Kyua.  See tests/README
690a68701fSEitan Adler		for additional information.
700a68701fSEitan Adler
71d20f8f69SJordan K. Hubbardtools		Utilities for regression testing and miscellaneous tasks.
72d20f8f69SJordan K. Hubbard
73d20f8f69SJordan K. Hubbardusr.bin		User commands.
74d20f8f69SJordan K. Hubbard
75d20f8f69SJordan K. Hubbardusr.sbin	System administration commands.
76d20f8f69SJordan K. Hubbard
77d20f8f69SJordan K. Hubbard
78d20f8f69SJordan K. HubbardFor information on synchronizing your source tree with one or more of
79d20f8f69SJordan K. Hubbardthe FreeBSD Project's development branches, please see:
80d20f8f69SJordan K. Hubbard
81745ddc10SEitan Adler  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
82