README.md 2.64 KB
Newer Older
1
2
FreeBSD Source:
---------------
Warner Losh's avatar
Warner Losh committed
3
This is the top level of the FreeBSD source directory.
4

Warner Losh's avatar
Warner Losh committed
5
6
7
FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
A large community has continually developed it for more than thirty years.
Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.
8

Warner Losh's avatar
Warner Losh committed
9
For copyright information, please see [the file COPYRIGHT](COPYRIGHT) in this directory.
Warner Losh's avatar
Warner Losh committed
10
Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.
11

Warner Losh's avatar
Warner Losh committed
12
The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree.
Li-Wen Hsu's avatar
Li-Wen Hsu committed
13
See build(7), config(8), [FreeBSD handbook on building userland](https://docs.freebsd.org/en/books/handbook/cutting-edge/#makeworld), and [Handbook for kernels](https://docs.freebsd.org/en/books/handbook/kernelconfig/) for more information, including setting make(1) variables.
14
15
16

Source Roadmap:
---------------
Warner Losh's avatar
Warner Losh committed
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| Directory | Description |
| --------- | ------------ | 
| bin | System/user commands. |
| cddl | Various commands and libraries under the Common Development and Distribution License. |
| contrib | Packages contributed by 3rd parties. |
| crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
| etc | Template files for /etc. |
| gnu | Various commands and libraries under the GNU Public License. Please see [gnu/COPYING](gnu/COPYING) and [gnu/COPYING.LIB](gnu/COPYING.LIB) for more information. |
| include | System include files. |
| kerberos5 | Kerberos5 (Heimdal) package. |
| lib | System libraries. |
| libexec | System daemons. |
| release | Release building Makefile & associated tools. |
| rescue | Build system for statically linked /rescue utilities. |
| sbin | System commands. |
| secure | Cryptographic libraries and commands. |
| share | Shared resources. |
| stand | Boot loader sources. |
| sys | Kernel sources. |
Warner Losh's avatar
Warner Losh committed
36
| sys/`arch`/conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. |
Warner Losh's avatar
Warner Losh committed
37
38
39
40
41
| tests | Regression tests which can be run by Kyua.  See [tests/README](tests/README) for additional information. |
| tools | Utilities for regression testing and miscellaneous tasks. |
| usr.bin | User commands. |
| usr.sbin | System administration commands. |

Li-Wen Hsu's avatar
Li-Wen Hsu committed
42
For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see [FreeBSD Handbook](https://docs.freebsd.org/en/books/handbook/cutting-edge/#current-stable).