xref: /freebsd-12.1/README.md (revision 21d41b78)
1f4caca1fSMartin MatuskaFreeBSD Source:
2f4caca1fSMartin Matuska---------------
3f4caca1fSMartin MatuskaThis is the top level of the FreeBSD source directory.  This file
4f4caca1fSMartin Matuskawas last revised on:
5f4caca1fSMartin Matuska$FreeBSD$
6f4caca1fSMartin Matuska
7f4caca1fSMartin MatuskaFreeBSD is an operating system used to power modern servers,
8f4caca1fSMartin Matuskadesktops, and embedded platforms. A large community has
9f4caca1fSMartin Matuskacontinually developed it for more than thirty years. Its
10f4caca1fSMartin Matuskaadvanced networking, security, and storage features have
11f4caca1fSMartin Matuskamade FreeBSD the platform of choice for many of the
12f4caca1fSMartin Matuskabusiest web sites and most pervasive embedded networking
13f4caca1fSMartin Matuskaand storage devices.
14f4caca1fSMartin Matuska
15f4caca1fSMartin MatuskaFor copyright information, please see the file COPYRIGHT in this
16f4caca1fSMartin Matuskadirectory. Additional copyright information also exists for some
17f4caca1fSMartin Matuskasources in this tree - please see the specific source directories for
18f4caca1fSMartin Matuskamore information.
19f4caca1fSMartin Matuska
20f4caca1fSMartin MatuskaThe Makefile in this directory supports a number of targets for
21f4caca1fSMartin Matuskabuilding components (or all) of the FreeBSD source tree.  See build(7), config(8),
22f4caca1fSMartin Matuskahttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
23f4caca1fSMartin Matuskahttps://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
24f4caca1fSMartin Matuskafor more information, including setting make(1) variables.
25f4caca1fSMartin Matuska
26f4caca1fSMartin MatuskaSource Roadmap:
27f4caca1fSMartin Matuska---------------
28f4caca1fSMartin Matuska```
29f4caca1fSMartin Matuskabin		System/user commands.
30f4caca1fSMartin Matuska
31f4caca1fSMartin Matuskacddl		Various commands and libraries under the Common Development
32f4caca1fSMartin Matuska		and Distribution License.
33f4caca1fSMartin Matuska
34f4caca1fSMartin Matuskacontrib		Packages contributed by 3rd parties.
35f4caca1fSMartin Matuska
36f4caca1fSMartin Matuskacrypto		Cryptography stuff (see crypto/README).
37f4caca1fSMartin Matuska
38f4caca1fSMartin Matuskaetc		Template files for /etc.
39f4caca1fSMartin Matuska
40f4caca1fSMartin Matuskagnu		Various commands and libraries under the GNU Public License.
41f4caca1fSMartin Matuska		Please see gnu/COPYING* for more information.
42f4caca1fSMartin Matuska
43f4caca1fSMartin Matuskainclude		System include files.
44f4caca1fSMartin Matuska
45f4caca1fSMartin Matuskakerberos5	Kerberos5 (Heimdal) package.
46f4caca1fSMartin Matuska
47f4caca1fSMartin Matuskalib		System libraries.
48f4caca1fSMartin Matuska
49f4caca1fSMartin Matuskalibexec		System daemons.
50f4caca1fSMartin Matuska
51f4caca1fSMartin Matuskarelease		Release building Makefile & associated tools.
52f4caca1fSMartin Matuska
53f4caca1fSMartin Matuskarescue		Build system for statically linked /rescue utilities.
54f4caca1fSMartin Matuska
55f4caca1fSMartin Matuskasbin		System commands.
56f4caca1fSMartin Matuska
57f4caca1fSMartin Matuskasecure		Cryptographic libraries and commands.
58f4caca1fSMartin Matuska
59f4caca1fSMartin Matuskashare		Shared resources.
60f4caca1fSMartin Matuska
61f4caca1fSMartin Matuskastand		Boot loader sources.
62f4caca1fSMartin Matuska
63f4caca1fSMartin Matuskasys		Kernel sources.
64f4caca1fSMartin Matuska
65f4caca1fSMartin Matuskasys/<arch>/conf Kernel configuration files. GENERIC is the configuration
66f4caca1fSMartin Matuska		used in release builds. NOTES contains documentation of
67f4caca1fSMartin Matuska		all possible entries.
68f4caca1fSMartin Matuska
69f4caca1fSMartin Matuskatests		Regression tests which can be run by Kyua.  See tests/README
70f4caca1fSMartin Matuska		for additional information.
71f4caca1fSMartin Matuska
72f4caca1fSMartin Matuskatools		Utilities for regression testing and miscellaneous tasks.
73f4caca1fSMartin Matuska
74f4caca1fSMartin Matuskausr.bin		User commands.
75f4caca1fSMartin Matuska
76f4caca1fSMartin Matuskausr.sbin	System administration commands.
77f4caca1fSMartin Matuska```
78f4caca1fSMartin Matuska
79f4caca1fSMartin MatuskaFor information on synchronizing your source tree with one or more of
80f4caca1fSMartin Matuskathe FreeBSD Project's development branches, please see:
81f4caca1fSMartin Matuska
82f4caca1fSMartin Matuska  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
83f4caca1fSMartin Matuska