1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
---
title: Chapter 1. Introduction
authors:
- author: Murray Stokely
- author: Jeroen Ruigrok van der Werven
prev: books/developers-handbook/parti
next: books/developers-handbook/tools
description: Introduction to the FreeBSD Developers Handbook
tags: ["introduction", "Developing on FreeBSD", "BSD Vision", "Architectural Guidelines"]
showBookMenu: true
weight: 2
path: "/books/developers-handbook/"
---
[[introduction]]
= Introduction
:doctype: book
:toc: macro
:toclevels: 1
:icons: font
:sectnums:
:sectnumlevels: 6
:sectnumoffset: 1
:partnums:
:source-highlighter: rouge
:experimental:
:images-path: books/developers-handbook/
ifdef::env-beastie[]
ifdef::backend-html5[]
:imagesdir: ../../../../images/{images-path}
endif::[]
ifndef::book[]
include::shared/authors.adoc[]
include::shared/mirrors.adoc[]
include::shared/releases.adoc[]
include::shared/attributes/attributes-{{% lang %}}.adoc[]
include::shared/{{% lang %}}/teams.adoc[]
include::shared/{{% lang %}}/mailing-lists.adoc[]
include::shared/{{% lang %}}/urls.adoc[]
toc::[]
endif::[]
ifdef::backend-pdf,backend-epub3[]
include::../../../../../shared/asciidoctor.adoc[]
endif::[]
endif::[]
ifndef::env-beastie[]
toc::[]
include::../../../../../shared/asciidoctor.adoc[]
endif::[]
[[introduction-devel]]
== Developing on FreeBSD
So here we are.
System all installed and you are ready to start programming.
But where to start? What does FreeBSD provide? What can it do for me, as a programmer?
These are some questions which this chapter tries to answer.
Of course, programming has different levels of proficiency like any other trade.
For some it is a hobby, for others it is their profession.
The information in this chapter might be aimed toward the beginning programmer;
indeed, it could serve useful for the programmer unfamiliar with the FreeBSD platform.
[[introduction-bsdvision]]
== The BSD Vision
To produce the best UNIX(R) like operating system package possible, with due respect to the original software tools ideology as well as usability, performance and stability.
[[introduction-archguide]]
== Architectural Guidelines
Our ideology can be described by the following guidelines
* Do not add new functionality unless an implementor cannot complete a real application without it.
* It is as important to decide what a system is not as to decide what it is. Do not serve all the world's needs; rather, make the system extensible so that additional needs can be met in an upwardly compatible fashion.
* The only thing worse than generalizing from one example is generalizing from no examples at all.
* If a problem is not completely understood, it is probably best to provide no solution at all.
* If you can get 90 percent of the desired effect for 10 percent of the work, use the simpler solution.
* Isolate complexity as much as possible.
* Provide mechanism, rather than policy. In particular, place user interface policy in the client's hands.
From Scheifler & Gettys: "X Window System"
[[introduction-layout]]
== The Layout of /usr/src
The complete source code to FreeBSD is available from our public repository.
The source code is normally installed in [.filename]#/usr/src# which contains the following subdirectories:
[.informaltable]
[cols="1,1", frame="none", options="header"]
|===
| Directory
| Description
|[.filename]#bin/#
|Source for files in [.filename]#/bin#
|[.filename]#cddl/#
|Utilities covered by the Common Development and Distribution License
|[.filename]#contrib/#
|Source for files from contributed software
|[.filename]#crypto/#
|Cryptographical sources
|[.filename]#etc/#
|Source for files in [.filename]#/etc#
|[.filename]#gnu/#
|Utilities covered by the GNU Public License
|[.filename]#include/#
|Source for files in [.filename]#/usr/include#
|[.filename]#kerberos5/#
|Source for Kerberos version 5
|[.filename]#lib/#
|Source for files in [.filename]#/usr/lib#
|[.filename]#libexec/#
|Source for files in [.filename]#/usr/libexec#
|[.filename]#release/#
|Files required to produce a FreeBSD release
|[.filename]#rescue/#
|Build system for the [.filename]#/rescue# utilities
|[.filename]#sbin/#
|Source for files in [.filename]#/sbin#
|[.filename]#secure/#
|Contributed cryptographic sources
|[.filename]#share/#
|Source for files in [.filename]#/usr/share#
|[.filename]#sys/#
|Kernel source files
|[.filename]#tests/#
|The FreeBSD test suite
|[.filename]#tools/#
|Tools used for maintenance and testing of FreeBSD
|[.filename]#usr.bin/#
|Source for files in [.filename]#/usr/bin#
|[.filename]#usr.sbin/#
|Source for files in [.filename]#/usr/sbin#
|===
|
