xref: /freebsd-13.1/README.md (revision f91319d4)
1bf77fadcSStefan EßerFreeBSD Source:
2bf77fadcSStefan Eßer---------------
3bf77fadcSStefan EßerThis is the top level of the FreeBSD source directory.  This file
4bf77fadcSStefan Eßerwas last revised on:
5bf77fadcSStefan Eßer$FreeBSD$
6bf77fadcSStefan Eßer
7bf77fadcSStefan EßerFreeBSD is an operating system used to power modern servers,
8bf77fadcSStefan Eßerdesktops, and embedded platforms. A large community has
9bf77fadcSStefan Eßercontinually developed it for more than thirty years. Its
10bf77fadcSStefan Eßeradvanced networking, security, and storage features have
11bf77fadcSStefan Eßermade FreeBSD the platform of choice for many of the
12bf77fadcSStefan Eßerbusiest web sites and most pervasive embedded networking
13bf77fadcSStefan Eßerand storage devices.
14bf77fadcSStefan Eßer
15bf77fadcSStefan EßerFor copyright information, please see the file COPYRIGHT in this
16bf77fadcSStefan Eßerdirectory. Additional copyright information also exists for some
17bf77fadcSStefan Eßersources in this tree - please see the specific source directories for
18bf77fadcSStefan Eßermore information.
19bf77fadcSStefan Eßer
20bf77fadcSStefan EßerThe Makefile in this directory supports a number of targets for
21bf77fadcSStefan Eßerbuilding components (or all) of the FreeBSD source tree.  See build(7), config(8),
22bf77fadcSStefan Eßerhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
23bf77fadcSStefan Eßerhttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
24bf77fadcSStefan Eßerfor more information, including setting make(1) variables.
25bf77fadcSStefan Eßer
26bf77fadcSStefan EßerSource Roadmap:
27bf77fadcSStefan Eßer---------------
28bf77fadcSStefan Eßer```
29bf77fadcSStefan Eßerbin		System/user commands.
30bf77fadcSStefan Eßer
31bf77fadcSStefan Eßercddl		Various commands and libraries under the Common Development
32bf77fadcSStefan Eßer		and Distribution License.
33bf77fadcSStefan Eßer
34bf77fadcSStefan Eßercontrib		Packages contributed by 3rd parties.
35bf77fadcSStefan Eßer
36bf77fadcSStefan Eßercrypto		Cryptography stuff (see crypto/README).
37bf77fadcSStefan Eßer
38bf77fadcSStefan Eßeretc		Template files for /etc.
39bf77fadcSStefan Eßer
40*f91319d4SEd Mastegnu		Commands and libraries under the GNU General Public License
41*f91319d4SEd Maste		(GPL) or Lesser General Public License (LGPL).  Please see
42*f91319d4SEd Maste		gnu/COPYING* for more information.
43bf77fadcSStefan Eßer
44bf77fadcSStefan Eßerinclude		System include files.
45bf77fadcSStefan Eßer
46bf77fadcSStefan Eßerkerberos5	Kerberos5 (Heimdal) package.
47bf77fadcSStefan Eßer
48bf77fadcSStefan Eßerlib		System libraries.
49bf77fadcSStefan Eßer
50bf77fadcSStefan Eßerlibexec		System daemons.
51bf77fadcSStefan Eßer
52bf77fadcSStefan Eßerrelease		Release building Makefile & associated tools.
53bf77fadcSStefan Eßer
54bf77fadcSStefan Eßerrescue		Build system for statically linked /rescue utilities.
55bf77fadcSStefan Eßer
56bf77fadcSStefan Eßersbin		System commands.
57bf77fadcSStefan Eßer
58bf77fadcSStefan Eßersecure		Cryptographic libraries and commands.
59bf77fadcSStefan Eßer
60bf77fadcSStefan Eßershare		Shared resources.
61bf77fadcSStefan Eßer
62bf77fadcSStefan Eßerstand		Boot loader sources.
63bf77fadcSStefan Eßer
64bf77fadcSStefan Eßersys		Kernel sources.
65bf77fadcSStefan Eßer
66bf77fadcSStefan Eßersys/<arch>/conf Kernel configuration files. GENERIC is the configuration
67bf77fadcSStefan Eßer		used in release builds. NOTES contains documentation of
68bf77fadcSStefan Eßer		all possible entries.
69bf77fadcSStefan Eßer
70bf77fadcSStefan Eßertests		Regression tests which can be run by Kyua.  See tests/README
71bf77fadcSStefan Eßer		for additional information.
72bf77fadcSStefan Eßer
73bf77fadcSStefan Eßertools		Utilities for regression testing and miscellaneous tasks.
74bf77fadcSStefan Eßer
75bf77fadcSStefan Eßerusr.bin		User commands.
76bf77fadcSStefan Eßer
77bf77fadcSStefan Eßerusr.sbin	System administration commands.
78bf77fadcSStefan Eßer```
79bf77fadcSStefan Eßer
80bf77fadcSStefan EßerFor information on synchronizing your source tree with one or more of
81bf77fadcSStefan Eßerthe FreeBSD Project's development branches, please see:
82bf77fadcSStefan Eßer
83bf77fadcSStefan Eßer  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
84