The doc/
tree is organized in a
particular fashion, and the documents that are part of the FDP are
in turn organized in a particular fashion. The aim is to make it
simple to add new documentation into the tree and:
Make it easy to automate converting the document to other formats.
Promote consistency between the different documentation organizations, to make it easier to switch between working on different documents.
Make it easy to decide where in the tree new documentation should be placed.
In addition, the documentation tree has to accommodate documentation that could be in many different languages and in many different encodings. It is important that the structure of the documentation tree does not enforce any particular defaults or cultural preferences.
There are two types of directory under
doc/
, each with very specific directory
names and meanings.
share/
share/mk
, while
the additional XML support files (such as the FreeBSD
extended DocBook DTD) are in
share/xml
.lang
.encoding
/
en_US.ISO8859-1/
and
zh_TW.Big5/
. The names are long, but
by fully specifying the language and encoding we prevent any
future headaches should a translation team want to provide
the documentation in the same language but in more than one
encoding. This also completely isolates us from any
problems that might be caused by a switch to Unicode.This, and other documents, can be downloaded from http://ftp.FreeBSD.org/pub/FreeBSD/doc/
For questions about FreeBSD, read the
documentation before
contacting <questions@FreeBSD.org>.
For questions about this documentation, e-mail <doc@FreeBSD.org>.