18.3. ドキュメントのアップデート

ドキュメントは、FreeBSD オペレーティングシステムの必須要素です。 FreeBSD ドキュメントの最新バージョンは、FreeBSD ウェブサイト (http://www.freebsd.org/doc/) から入手できますが、 FreeBSD ウェブサイト、ハンドブック、FAQ および文書の最新版をローカルに用意しておくと便利です。

この章では、ソースまたは Ports Collection を使って、 ローカルの FreeBSD ドキュメントを最新に保つ方法を説明します。

ドキュメントを編集したり、 ドキュメントの誤りを報告する方法については、 新しい貢献者のための FreeBSD ドキュメンテーションプロジェクト入門 (http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/) をご覧ください。

18.3.1. ソースから FreeBSD ドキュメントをインストールする

ソースから FreeBSD ドキュメントを構築するのに必要なツールは、 FreeBSD のベースシステムには含まれてはいません。 svn などの必要なツールは、 FreeBSD ドキュメンテーションプロジェクトが開発している textproc/docproj package または port からインストールできます。

インストールしたら、svn を使って、ドキュメントのソースをダウンロードしてください。 以下の例で、 https://svn0.us-west.FreeBSD.orgSubversion ミラーサイト」 の中からもっとも近いミラーのアドレスに変更してください。

# svn checkout https://svn0.us-west.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) をご覧ください。

18.3.2. ports を用いたドキュメンテーションのアップデート

ベースとなった作業:Fonvieille Marc [FAMILY Given].

これまでのセクションでは、ソースコードを用いた FreeBSD ドキュメントのアップデート方法について説明してきました。 この節では、インストールされている FreeBSD のドキュメントをアップデートするもう一つの方法である、 Ports Collection を用いた方法について説明し、 以下について説明します。

  • 構築済のドキュメントの packages をインストールする方法。 ローカルでの構築作業やドキュメンテーションツールチェインをインストールする必要はありません。

  • ports フレームワークを使ったドキュメントのソースの構築方法。 チェックアウトおよび構築作業が簡単になります。

FreeBSD のドキュメントをアップデートするこれらの方法は、 ドキュメンテーションエンジニアリングチーム が毎月アップデートしている ドキュメンテーション ports および packages によりサポートされています。 これらの ports は、FreeBSD Ports Collection の docs カテゴリ (http://www.freshports.org/docs/) にまとめられています。

ドキュメンテーション ports の構成は以下の通りです。

  • misc/freebsd-doc-en package または portは、 すべての英語文書をインストールします。

  • misc/freebsd-doc-all メタ package もしくは port は、 すべての利用可能な言語のすべてのドキュメントを構築します。

  • 各言語のために package または port が用意されています。たとえば、 misc/freebsd-doc-hu はハンガリー語のドキュメンテーション port です。

バイナリ package を使うと、 インストールする言語に用意されているすべての形式の FreeBSD ドキュメントがインストールされます。 たとえば、以下のコマンドを実行すると、 ハンガリー語のドキュメントの最新 package がインストールされます。

# pkg install hu-freebsd-doc

注記:

ドキュメントの package は、対応する port 名とは異なり、 lang-freebsd-doc の形式で名前がつけられています。 ここで、lang は言語コードの短縮形です。 ハンガリー語の場合は hu、簡体字の場合には zh_cn です。

ドキュメントのフォーマットを指定する場合には、package ではなく port から構築をしてください。たとえば、 英語のドキュメントを構築してインストールするには以下のようにして下さい。

# cd /usr/ports/misc/freebsd-doc-en
# make install clean

この port には、 構築およびインストールするフォーマットを設定するメニューがあります。 デフォルトでは、http://www.FreeBSD.org と同じ形式である分割版の HTML 形式、 PDF が選択されています。

以下のように、ドキュメンテーション ports を構築する際の make オプションが用意されています。

WITH_HTML

HTML 形式を構築します。 各ドキュメントに対し、単一版の HTML ファイルが構築されます。 整形されたドキュメントは、 article.htmlbook.html といった名前でインストールされます。

WITH_PDF

整形されたドキュメントは、 article.pdfbook.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

5章アプリケーションのインストール - packages と ports に書かれている手順を使って、 ドキュメンテーション package または port をアップデートできます。 たとえば、以下のコマンドを実行すると、 ports-mgmt/portupgrade から、package だけを使ってインストールされているハンガリー語のドキュメントをアップデートします。

# portmaster -PP hu-freebsd-doc

本文書、および他の文書は ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/ からダウンロードできます。

FreeBSD に関する質問がある場合には、 ドキュメント を読んだ上で <questions@FreeBSD.org> まで (英語で) 連絡してください。

本文書に関する質問については、 <doc@FreeBSD.org> まで電子メールを (英語で) 送ってください。