This chapter covers organization of the documentation build process and how make(1) is used to control it.
Different types of output can be produced from a single
DocBook source file. The type of output desired is set with the
FORMATS variable. A list of known formats is
stored in KNOWN_FORMATS:
%cd ~/doc/en_US.ISO8859-1/books/handbook%make -V KNOWN_FORMATS
FORMATS Value | File Type | Description |
|---|---|---|
html | HTML, one file | A single book.html or
article.html. |
html-split | HTML, multiple files | Multiple HTML files, one for each chapter or section, for use on a typical web site. |
pdf | Portable Document Format |
The default output format can vary by document, but is
usually html-split. Other formats are chosen
by setting FORMATS to a specific value.
Multiple output formats can be created at a single time by
setting FORMATS to a list of formats.
%cd ~/doc/en_US.ISO8859-1/books/handbook%make FORMATS=html
%cd ~/doc/en_US.ISO8859-1/books/handbook%make FORMATS="html-split pdf"
All FreeBSD documents are available for download at https://download.freebsd.org/ftp/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>.