Several software tools are used to manage the FreeBSD documentation and render it to different output formats. Some of these tools are required and must be installed before working through the examples in the following chapters. Some are optional, adding capabilities or making the job of creating documentation less demanding.
Install
docproj
meta-port
as shown in
the overview chapter
from the Ports Collection.
These applications are required to do useful work with the FreeBSD documentation.
Some further notes on particular components are given below.
These applications are not required, but can make working on the documentation easier or add capabilities.
Vim ( editors/vim ) — a popular editor for working with Asciidoctor.
Emacs ( editors/emacs ).
Both tools include a special mode that reduces the amount of typing needed, and helps to reduce errors.
Last modified on : April 18, 2025 by Graham Perrin