Files and directories in the
doc/ tree follow a
structure meant to:
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 must accommodate documents in many different languages and encodings. It is important that the documentation tree structure 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.
| Directory | Usage |
|---|---|
share | Contains files that are not specific to the various
translations and encodings of the documentation.
Contains subdirectories to further categorize the
information. For example, the files that comprise the
make(1) infrastructure are in
share/mk, while
the additional XML support files
(such as the FreeBSD extended DocBook
DTD) are in share/xml. |
| One directory exists for each available translation
and encoding of the documentation, for example
en_US.ISO8859-1/
and zh_TW.UTF-8/.
The names are long, but by fully specifying the language
and encoding we prevent any future headaches when a
translation team wants to provide documentation in the
same language but in more than one encoding. This also
avoids problems that might be caused by a future switch
to Unicode. |
All FreeBSD documents are available for download at http://ftp.FreeBSD.org/pub/FreeBSD/doc/
Questions that are not answered by the
documentation may be
sent to <[email protected]>.
Send questions about this document to <[email protected]>.