說明文件是 FreeBSD 作業系統不可或缺的一部份。最新版本的 FreeBSD 文件除了可在 FreeBSD 網站 (https://www.freebsd.org/doc/) 取得,也可很簡單的取得本地的 FreeBSD 網站、使用手冊、FAQ 及文章副本。
本節將說明如何使用原始碼與 FreeBSD Port 套件集來取得最新版本 FreeBSD 文件本地複本。
有關編輯與提出修正說明文件的資訊,請參考 FreeBSD 文件計畫入門書 (https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/)。
從原始碼重新編譯 FreeBSD 文件需要一些不屬於 FreeBSD 基礎系統的工具。需要的工具包括 svn 可透過由 FreeBSD 文件計劃所開發的 textproc/docproj 套件或 Port 安裝。
安裝完成之後,可使用 svn 來取得乾淨的文件原始碼複本:
# svn checkout https://svn.FreeBSD.org/doc/head /usr/doc第一次下載文件原始碼需要一些時間,請耐心等候執行完畢。
往後更新文件原始碼可執行:
# svn update /usr/doc下載最新的文件原始碼到 /usr/doc 之後,便完成要更新已安裝文件的準備動作。
完整更新所有可用的語言可以執行:
# cd /usr/doc
# make install clean若只想要更新特定語言,可對 /usr/doc 中特定語言的子目錄執行 make:
# cd /usr/doc/en_US.ISO8859-1
# make install clean另一個更新文件的方式是在 /usr/doc 或特定的語言子目錄下執行此指令:
# make update要指定安裝的輸出格式可使用 FORMATS 來設定:
# cd /usr/doc
# make FORMATS='html html-split' install clean有數個選項可更新部份文件或只編譯特定翻譯來簡化更新程序。這些選項可在 /etc/make.conf 設為系統全域的預設選項,或是透過指令傳送給 make。
選項有:
DOC_LANG要編譯與安裝的語言及編碼清單,例如 en_US.ISO8859-1 代表英語文件。
FORMATS要編譯的輸出格式清單,目前支援 html, html-split, txt, ps 以及 pdf。
DOCDIR要安裝文件的位置,預設為 /usr/share/doc。
要取得更多可做為 FreeBSD 系統全域選項的 make 變數,請參考 make.conf(5)。
前一節介紹了由原始碼更新 FreeBSD 文件的方法,本節將說明使用 Port 套件集的替代方法,可由以下方式達成:
安裝事先編譯好的文件套件,無須在本地編譯任何東西或安裝文件工具集。
使用 Port 框架來編譯文件原始碼,可讓取得與編譯文件的步驟更簡單。
這個更新 FreeBSD 文件的方法,會使用到一系列由文件工程團隊 <doceng@FreeBSD.org> 每月更新的文件 Port 與套件。這些套件列於 FreeBSD Port 套件集的 docs 分類下 (http://www.freshports.org/docs/)。
文件 Port 的組織方式如下:
misc/freebsd-doc-en 套件或 Port 會安裝所有英語的文件。
misc/freebsd-doc-all 套件或 Port 會安裝所有可用語言的文件。
每個翻譯語言都有套件與 Port,如 misc/freebsd-doc-hu 為匈牙利語文件。
當使用 Binary 套件時,會安裝指定語言 FreeBSD 文件的所有可用格式。例如以下指令會安裝最新的匈牙利語文件套件:
# pkg install hu-freebsd-doc套件使用的名稱格式與 Port 的名稱不同:,其中 lang-freebsd-doclang 是語言代碼的縮寫,例如 hu 代表匈牙利語,zh_cn 代表簡體中文。
要指定文件的格式,需以編譯 Port 來代替安裝套件。例如要編譯並安裝英語文件:
# cd /usr/ports/misc/freebsd-doc-en
# make install cleanPort 提供設定選單來指定要編譯與安裝的格式,預設會選擇分頁的 HTML (類似 http://www.FreeBSD.org 使用的格式) 以及 PDF。
此外,編譯文件 Port 時也可指定數個 make 選項,包括:
WITH_HTML編譯一份文件使用一個 HTML 檔的 HTML 格式。格式化後的文件會儲存至名稱為 article.html 或 book.html 的檔案。
WITH_PDF格式化的文件會儲存至名稱為 article.pdf 或 book.pdf 的檔案。
DOCBASE指定要安裝文件的位置,預設為 /usr/local/share/doc/freebsd。
以下範例使用變數來安裝 PDF 的匈牙利語文件到特定目錄:
# cd /usr/ports/misc/freebsd-doc-hu
# make -DWITH_PDF DOCBASE=share/doc/freebsd/hu install clean文件套件或 Port 可以依 章 4, 安裝應用程式:套件與 Port 的說明更新。例如以下指令會使用 ports-mgmt/portmaster 更新已安裝的匈牙利語文件:
# portmaster -PP hu-freebsd-doc本文及其他文件,可由此下載: ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/。
若有 FreeBSD 方面疑問,請先閱讀
FreeBSD 相關文件,如不能解決的話,再洽詢
<questions@FreeBSD.org>。
關於本文件的問題,請洽詢
<doc@FreeBSD.org>。