Chapter 5. The Documentation Build Process

Table of Contents
5.1. The FreeBSD Documentation Build Toolset
5.2. Understanding Makefiles in the Documentation Tree
5.3. FreeBSD Documentation Project Make Includes

This chapter's main purpose is to clearly explain how the documentation build process is organized, and how to affect modifications to this process.

After you have finished reading this chapter you should:

5.1. The FreeBSD Documentation Build Toolset

Here are your tools. Use them every way you can.

  • The primary build tool you will need is make, but specifically Berkeley Make.

  • Package building is handled by FreeBSD's pkg_create. If you are not using FreeBSD, you will either have to live without packages, or compile the source yourself.

  • gzip is needed to create compressed versions of the document. bzip2 compression and zip archives are also supported. tar is supported, but package building demands it.

  • install is the default method to install the documentation. There are alternatives, however.

Note:

It is unlikely you will have any trouble finding these last two, they are mentioned for completeness only.

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 <freebsd-questions@FreeBSD.org>.

Send questions about this document to <freebsd-doc@FreeBSD.org>.