若想先自行試試看,並有信心可以作得到,那麼就照下面步驟吧。
安裝 textproc/docproj
這個組合型 port(meta-port)。
#
cd /usr/ports/textproc/docproj
#
make JADETEX=no install
下載 FreeBSD doc
tree 到本機上:
無論是用 CSup 或 CVSup 的 checkout
模式,
或是複製完整的 CVS repository 到本機上都可以。
若想在本機上只跑最低限度的 CVS repository 就好,那麼必須要
checkout 出 doc/share
以及 doc/en_US.ISO8859-1/share
這兩個目錄才行。
%
cvs checkout doc/share
%
cvs checkout doc/en_US.ISO8859-1/share
若硬碟空間還算可以的話,那可以把所有語系的 doc 都 check out 出來:
%
cvs checkout doc
可依需要從 repository 中 checkout 出來你想修改某份現有的書籍或文章內容。 若打算撰寫新書或新文章的話,可以參考現有的部分作為實例來做。
舉例來說,若想寫篇新文章,內容是有關在 FreeBSD 與 Windows 2000 之間建立 VPN 連線, 那麼可以照類似下面這樣的作法:
Check out articles
目錄:
%
cvs checkout doc/en_US.ISO8859-1/articles
複製現有的文章作為範本。在這個例子中,您打算決定把新文章放在
vpn-w2k
的目錄下。
%
cd doc/en_US.ISO8859-1/articles
%
cp -R committers-guide vpn-w2k
若是要修改現有文章,像是 FAQ(擺在 doc/en_US.ISO8859-1/books/faq
)
,那麼要從 repository 中取出來(check out):
%
cvs checkout doc/en_US.ISO8859-1/books/faq
以編輯器來編寫 .xml
檔。
以 lint
當輔助參數,來快速檢測文件結構及連結有無錯誤,
以下這個指令,實際上不會進行耗時的編書過程,只是先測試文件有無錯誤。
%
make lint
當編書的一切都就緒時,這時你可以用 FORMATS
變數來指定產生的格式為哪一種。 目前支援的格式共有:
html
, html-split
,
txt
, ps
,
pdf
, rtf
。
所支援的格式列表最新版,可參考
doc/share/mk/doc.docbook.mk
檔。 請記得:
在單一指令中,若要同時產生多種格式的話,應使用引號(quotes)來將這些格式括起來。
舉例來說,若只要產生
html
格式就好,那麼就打:
%
make FORMATS=html
但若希望有 html
及 txt
格式的話,
你可能要打兩次 make(1) 指令才能完成:
%
make FORMATS=html
%
make FORMATS=txt
其實,也可以用單一指令來完成:
%
make FORMATS="html txt"
最後,以 send-pr(1) 來提交修改的部份。
本文及其他文件,可由此下載: ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/。
若有 FreeBSD 方面疑問,請先閱讀
FreeBSD 相關文件,如不能解決的話,再洽詢
<questions@FreeBSD.org>。
關於本文件的問題,請洽詢
<doc@FreeBSD.org>。