1.3 快速上手篇

安装 textproc/docproj 这个组合型 port (meta-port)。

# cd /usr/ports/textproc/docproj
# make JADETEX=no install

获取一份 FreeBSD doc 部分的本地副本。 您可以使用 CVSup 的 checkout 模式来完成此项工作， 也可以获取一份完整的本地 CVS 文档库副本。

如果您在本地维护 CVS 文档库的副本， 则您还至少需要检出 doc/share， 以及 doc/en_US.ISO8859-1/share 这些目录。

% cvs checkout doc/share
% cvs checkout doc/en_US.ISO8859-1/share

若硬盘空间够大的话，那可以把所有 doc 都检出：

% cvs checkout doc

如果您打算修改某个现有的书籍或文章， 就可以根据需要从文档库中检出。 如果您计划撰写新书或文章， 则可以以现有的作为例子来进行。

举例来说，若想写篇新文章，内容是有关在 FreeBSD 与 Windows 2000 之间建立 VPN 联机， 那么可以照类似下面这样的作法：

若是要修改现有文章，像是 FAQ (摆在 doc/en_US.ISO8859-1/books/faq)， 那么要从 repository 中取出来(check out)：

% cvs checkout doc/en_US.ISO8859-1/books/faq

以编辑器来编写 .sgml 文件。

以 lint 当辅助参数， 来快速检测文档结构及其中的超链接有无错误， 以下这个指令， 实际上不会进行耗时的编书过程， 只是先测试文档有无错误。

% make lint

如果您已经为构建文档做好了准备， 则可以通过 FORMATS 变量来指定生成格式。 目前支持的格式共有： html、 html-split、 txt、 ps、 pdf， 以及 rtf。 支持格式的最新列表， 可以在 doc/share/mk/doc.docbook.mk 文件的开头找到。 务必注意， 在单个命令行中指定多种格式时， 应使用引号将这些格式括起来。

举例来说，若只要 html 格式就好，那么就打：

% make FORMATS=html

但若希望有 html 及 txt 格式的话， 你可能要打两次 make(1) 指令才能完成：

% make FORMATS=html
% make FORMATS=txt

其实，也可以用单一指令来完成：

% make FORMATS="html txt"

最后，以 send-pr(1) 来提交修改的部份。