- Merge the following from the English version:

r44366 -> r44673	head/ja_JP.eucJP/books/handbook/cutting-edge/chapter.xml
This commit is contained in:
Ryusuke SUZUKI 2014-05-20 09:13:36 +00:00
parent 24e2ef5c5a
commit b60f464f3c
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=44881

View file

@ -3,7 +3,7 @@
The FreeBSD Documentation Project
The FreeBSD Japanese Documentation Project
Original revision: r44366
Original revision: r44673
$FreeBSD$
-->
<chapter xmlns="http://docbook.org/ns/docbook"
@ -725,92 +725,39 @@ before running "/usr/sbin/freebsd-update install"</screen>
</indexterm>
<para>ドキュメントは、&os; オペレーティングシステムの必須要素です。
&os; ドキュメントセットの最新バージョンは、
<link xlink:href="http://www.freebsd.org/doc/">&os; ウェブサイト</link>
&os; ドキュメントの最新バージョンは、&os; ウェブサイト
(<link xlink:href="&url.base;/doc/">http://www.freebsd.org/doc/</link>)
から入手できますが、
ネットワーク接続が遅い、もしくはまったく接続できないユーザもいます。
ローカルのドキュメントを最新の &os;
ドキュメントセットにアップデートする方法がいくつも用意されています。</para>
&os; ウェブサイト、ハンドブック、<acronym>FAQ</acronym>
および文書の最新版をローカルに用意しておくと便利です。</para>
<sect2 xml:id="dsvn-doc">
<title><application>Subversion</application>
を用いたドキュメントのアップデート方法</title>
<para>この章では、ソースまたは Ports Collection を使って、
ローカルの &os; ドキュメントを最新に保つ方法を説明します。</para>
<para>&os; のドキュメントのソースは、
<application>svn</application> を用いて入手できます。
この節では以下について説明します。</para>
<para>ドキュメントを編集したり、
ドキュメントの誤りを報告する方法については、
新しい貢献者のための &os; ドキュメンテーションプロジェクト入門
(<link xlink:href="&url.books.fdp-primer.en;">http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/</link>) をご覧ください。</para>
<itemizedlist>
<listitem>
<para>ドキュメントツールチェインのインストール方法。
このツールは、&os;
のドキュメントをソースから再構築するのに必要です。</para>
</listitem>
<sect2 xml:id="updating-installed-documentation">
<title>ソースから &os; ドキュメントをインストールする</title>
<listitem>
<para><application>svn</application> を用いて、
ドキュメントのソースを
<filename>/usr/doc</filename>
以下にダウンロードする方法。</para>
</listitem>
<para>ソースから &os; ドキュメントを構築するのに必要なツールは、
&os; のベースシステムには含まれてはいません。
<application>svn</application> などの必要なツールは、
&os; ドキュメンテーションプロジェクトが開発している
<package>textproc/docproj</package> package または port
からインストールできます。</para>
<listitem>
<para>&os; ドキュメントをソースから再構築し、
<filename>/usr/share/doc</filename>
以下にインストールする方法。</para>
</listitem>
<listitem>
<para>ドキュメントのビルドシステムにおいてサポートされているビルドオプションの説明。
たとえば、翻訳されたドキュメンテーションのみを構築するオプションや、
ある特定の出力フォーマットを指定するようなオプションについて説明します。</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 xml:id="installing-documentation-toolchain">
<title><application>svn</application>
およびドキュメントツールチェインのインストール</title>
<para>&os; のドキュメントをソースから再構築するには、
ツールのコレクションが必要です。
これらのツールは多くのディスク容量を使用するため、
&os; ベースシステムの一部ではありません。
また、すべての &os; ユーザにとって有用というわけではなく、&os;
のために新しいドキュメントを活発に執筆している方や、
頻繁にドキュメントをソースからアップデートする方に向けたものです。</para>
<para><application>svn</application> を含め必要なツールは、
<package>textproc/docproj</package> メタ port
からインストールできます。この port は、
&os; ドキュメンテーションプロジェクトにより開発されています。</para>
<note>
<para>ドキュメントの &postscript; や PDF 版が必要なければ、かわりに
<package>textproc/docproj-nojadetex</package>
をインストールすることも考えてよいでしょう。
このドキュメンテーションのツールチェインは、
<application>teTeX</application>
と呼ばれる組版エンジンを除いたすべてをインストールします。
<application>teTeX</application> は大きなツールのコレクションです。
そのため、もし PDF 出力を本当に必要としなければ、
このツールをインストールしないことはとても賢明です。</para>
</note>
</sect2>
<sect2 xml:id="updating-documentation-sources">
<title>ドキュメントのソースをアップデートする</title>
<para>以下の例では、<application>svn</application> を使って
western US ミラーから HTTPS プロトコルを用いて、
ドキュメントのソースをダウンロードします。</para>
<para>インストールしたら、<application>svn</application>
を使って、ドキュメントのソースをダウンロードしてください。
以下の例で、
<replaceable>https://svn0.us-west.FreeBSD.org</replaceable>
<xref linkend="svn-mirrors"/>
の中からもっとも近いミラーのアドレスに変更してください。</para>
<screen>&prompt.root; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org</replaceable>/doc/head /usr/doc</userinput></screen>
<para>利用可能な
<link linkend="svn-mirrors">Subversion ミラーサイト</link>
の中からもっとも近いミラーを使ってください。</para>
<para>最初にドキュメントのソースをダウンロードするには少し時間がかかります。
ダウンロードが終わるまでお待ちください。</para>
@ -819,22 +766,40 @@ before running "/usr/sbin/freebsd-update install"</screen>
<screen>&prompt.root; <userinput>svn update /usr/doc</userinput></screen>
<para>ソースを入手したら、
<filename>/usr/doc/Makefile</filename> を使い、
以下のようにドキュメントをアップデートすることもできます。</para>
<para>最新のドキュメントのソースのスナップショットを
<filename>/usr/doc</filename> に用意できたら、
インストールされているドキュメントをアップデートする準備はすべて整いました。</para>
<para>利用可能なすべての言語のドキュメントをアップデートするには、
以下のように入力してください。</para>
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
&prompt.root; <userinput>make update</userinput></screen>
</sect2>
&prompt.root; <userinput>make install clean</userinput></screen>
<sect2 xml:id="updating-documentation-options">
<title>ドキュメントのソースの調整可能なオプション</title>
<para>もし、ある特定の言語のみをアップデートしたいのであれば、
<filename>/usr/doc</filename>
の下にある各言語のサブディレクトリで <command>make</command>
を実行してください。</para>
<para>&os; のドキュメントセットのアップデートとビルドシステムは、
ドキュメンテーションの一部のアップデートを簡単にするオプションや、
特定の翻訳のビルドに対応しています。
<screen>&prompt.root; <userinput>cd /usr/doc/en_US.ISO8859-1</userinput>
&prompt.root; <userinput>make install clean</userinput></screen>
<para>ドキュメントをアップデートする別の方法は、
<filename>/usr/doc</filename>
または各言語のサブディレクトリで以下のコマンドを実行してください。</para>
<screen>&prompt.root; <userinput>make update</userinput></screen>
<para><varname>FORMATS</varname> を設定して、
以下のようにインストールする出力形式を指定できます。</para>
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
&prompt.root; <userinput>make FORMATS='html html-split' install clean</userinput></screen>
<para>ドキュメンテーションの一部のアップデートを簡単にするオプションや、
特定の翻訳のビルドを行うためのオプションが用意されています。
これらのオプションは、システム全般のオプションである
<filename>/etc/make.conf</filename> や、&man.make.1;
<filename>/etc/make.conf</filename> や、<command>make</command>
に与えるコマンドラインオプションで設定できます。</para>
<para>オプションには以下のようなものがあります。</para>
@ -857,8 +822,8 @@ before running "/usr/sbin/freebsd-update install"</screen>
<para>ビルドを行うフォーマット、または出力フォーマットの一覧。
現在は <literal>html</literal>,
<literal>html-split</literal>, <literal>txt</literal>,
<literal>ps</literal>, <literal>pdf</literal>,
そして <literal>rtf</literal> に対応しています。</para>
<literal>ps</literal> そして <literal>pdf</literal>
に対応しています。</para>
</listitem>
</varlistentry>
@ -875,47 +840,11 @@ before running "/usr/sbin/freebsd-update install"</screen>
<para>&os; のシステム全般のオプションに関連するもっと多くの
<command>make</command> 変数については、
&man.make.conf.5; をご覧ください。</para>
<para>&os; ドキュメントのビルドシステムで対応しているさらなる
<command>make</command> の変数に関しては、
<link xlink:href="&url.doc.langbase.en;/books/fdp-primer">新しい貢献者のための &os; ドキュメンテーションプロジェクト入門 </link> を参照してください。</para>
</sect2>
<sect2 xml:id="updating-installed-documentation">
<title>ソースから &os; ドキュメントをインストールする</title>
<para>ドキュメントのソースの最新スナップショットを
<filename>/usr/doc</filename> にダウンロードしたら、
インストールされているドキュメントをアップデートする準備がすべて整いました。</para>
<para><varname>DOC_LANG</varname>
で定義されているすべての言語を完全にアップデートするには、
以下のように入力してください。</para>
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
&prompt.root; <userinput>make install clean</userinput></screen>
<para>もし、ある特定の言語のみをアップデートしたいのであれば、
<filename>/usr/doc</filename>
サブディレクトリで以下のように &man.make.1; を実行してください。</para>
<screen>&prompt.root; <userinput>cd /usr/doc/en_US.ISO8859-1</userinput>
&prompt.root; <userinput>make update install clean</userinput></screen>
<para><varname>FORMATS</varname> を設定して、
以下のようにインストールする出力形式を指定できます。</para>
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
&prompt.root; <userinput>make FORMATS='html html-split' install clean</userinput></screen>
<para>ドキュメントを編集したり、訂正したものを提出する方法については、
<link xlink:href="&url.books.fdp-primer;">新しい貢献者のための &os;
ドキュメンテーションプロジェクト入門</link> をご覧ください。</para>
</sect2>
<sect2 xml:id="doc-ports">
<sect2 xml:id="doc-ports-install-package">
<info>
<title>ドキュメンテーション ports</title>
<title>ports を用いたドキュメンテーションのアップデート</title>
<authorgroup>
<author>
@ -939,17 +868,6 @@ before running "/usr/sbin/freebsd-update install"</screen>
<para>これまでのセクションでは、ソースコードを用いた &os;
ドキュメントのアップデート方法について説明してきました。
すべての &os; システムで、
ソースからドキュメントをアップデートすることは難しいかも知れませんし、
できたとしても現実的ではないこともあります。
ドキュメントをソースから構築するには、
かなり大きなツールとユーティリティから構成される
<emphasis>ドキュメンテーションツールチェイン</emphasis>
が必要なためです。
また、<application>svn</application>
リポジトリからソースをチェックアウトし、
チェックアウトしたソースからドキュメントを手動で構築する方法について、
それなりに熟知している必要もあります。
この節では、インストールされている
&os; のドキュメントをアップデートするもう一つの方法である、
Ports Collection を用いた方法について説明し、
@ -957,84 +875,81 @@ before running "/usr/sbin/freebsd-update install"</screen>
<itemizedlist>
<listitem>
<para>構築済のドキュメントのスナップショットをダウンロードしてインストールする方法。
<para>構築済のドキュメントの packages をインストールする方法。
ローカルでの構築作業やドキュメンテーションツールチェインをインストールする必要はありません。</para>
</listitem>
<listitem>
<para>ドキュメントのソースをダウンロードし、ports
フレームワークを使って構築する方法です。
<para>ports フレームワークを使ったドキュメントのソースの構築方法。
チェックアウトおよび構築作業が簡単になります。</para>
</listitem>
</itemizedlist>
<para>&os; のドキュメントをアップデートするこれらの方法は、
&a.doceng; が毎月アップデートしている
<emphasis>ドキュメンテーション ports</emphasis>
ドキュメンテーション ports および packages
によりサポートされています。
これらの ports は、&os; Ports&nbsp;Collection の <link
xlink:href="http://www.freshports.org/docs/">docs</link>
カテゴリにまとめられています。</para>
<sect3 xml:id="doc-ports-install-make">
<title>ドキュメンテーション ports の構築とインストール</title>
<para>ドキュメンテーション ports では、
ports の構築フレームワークが用いられるので、
ドキュメントを簡単に構築できます。
この ports は、ドキュメントのソースを自動的にチェックアウトし、
環境変数やコマンドラインオプションを適切に設定して &man.make.1;
を実行します。
また、他の &os; port, package のインストールと同様に簡単な方法で、
ドキュメントのインストールやアンインストールを行うことができます。</para>
<note>
<para>追加の機能として、この ports は
<emphasis>ドキュメンテーションツールチェイン</emphasis> ports
への依存を理解しているので、
構築時にはドキュメンテーションツールチェインも自動的にインストールされます。</para>
</note>
これらの ports は、&os; Ports&nbsp;Collection の
docs カテゴリ (<link
xlink:href="http://www.freshports.org/docs/">http://www.freshports.org/docs/</link>)
にまとめられています。</para>
<para>ドキュメンテーション ports の構成は以下の通りです。</para>
<itemizedlist>
<listitem>
<para><quote>マスタ port</quote>,
<package>misc/freebsd-doc-en</package>
すべての英語文書の ports をインストールします。</para>
<para><package>misc/freebsd-doc-en</package> package または portは、
すべての英語文書をインストールします。</para>
</listitem>
<listitem>
<para><quote>すべてのドキュメントの port</quote>,
<package>misc/freebsd-doc-all</package>。これは、
<para><package>misc/freebsd-doc-all</package> メタ package
もしくは port は、
すべての利用可能な言語のすべてのドキュメントを構築します。</para>
</listitem>
<listitem>
<para>各言語のために <quote>スレーブ port</quote>
<para>各言語のために package または port
が用意されています。たとえば、
<package>misc/freebsd-doc-hu</package>
はハンガリー語のドキュメンテーション port です。</para>
</listitem>
</itemizedlist>
<para>たとえば、<uri
xlink:href="http://www.FreeBSD.org">http://www.FreeBSD.org</uri>
と同じ形式である、
英語版の分割された <acronym>HTML</acronym> 形式を構築し、
<filename>/usr/local/share/doc/freebsd</filename>
にインストールするには以下の port をインストールしてください。</para>
<para>バイナリ package を使うと、
インストールする言語に用意されているすべての形式の
&os; ドキュメントがインストールされます。
たとえば、以下のコマンドを実行すると、
ハンガリー語のドキュメントの最新 package
がインストールされます。</para>
<screen>&prompt.root; <userinput>pkg install hu-freebsd-doc</userinput></screen>
<note>
<para>ドキュメントの package は、対応する port 名とは異なり、
<literal><replaceable>lang</replaceable>-freebsd-doc</literal>
の形式で名前がつけられています。
ここで、<replaceable>lang</replaceable> は言語コードの短縮形です。
ハンガリー語の場合は <literal>hu</literal>、簡体字の場合には
<literal>zh_cn</literal> です。</para>
</note>
<para>ドキュメントのフォーマットを指定する場合には、package ではなく
port から構築をしてください。
たとえば、英語のドキュメントを構築してインストールするには以下のようにして下さい。</para>
<screen>&prompt.root; <userinput>cd /usr/ports/misc/freebsd-doc-en</userinput>
&prompt.root; <userinput>make install clean</userinput></screen>
<sect4 xml:id="doc-ports-options">
<title>共通のオプション</title>
<para>この port には、
構築およびインストールするフォーマットを設定するメニューがあります。
デフォルトでは、<uri
xlink:href="http://www.FreeBSD.org">http://www.FreeBSD.org</uri>
と同じ形式である分割版の <acronym>HTML</acronym> 形式、
<acronym>PDF</acronym> が選択されています。</para>
<para>ドキュメンテーション ports
にはたくさんのオプションが用意されており、
以下のように
ports の振る舞いをデフォルトの設定から変更できます。</para>
<para>以下のように、ドキュメンテーション ports を構築する際の
<command>make</command> オプションが用意されています。</para>
<variablelist>
<varlistentry>
@ -1045,8 +960,8 @@ before running "/usr/sbin/freebsd-update install"</screen>
各ドキュメントに対し、単一版の HTML ファイルが構築されます。
整形されたドキュメントは、
<filename>article.html</filename>
<filename>book.html</filename> といった名前で、
必要に応じて画像とともにインストールされます。</para>
<filename>book.html</filename>
といった名前でインストールされます。</para>
</listitem>
</varlistentry>
@ -1054,8 +969,7 @@ before running "/usr/sbin/freebsd-update install"</screen>
<term><varname>WITH_PDF</varname></term>
<listitem>
<para>&adobe; Portable Document Format (PDF) を構築します。
整形されたドキュメントは、
<para>整形されたドキュメントは、
<filename>article.pdf</filename>
<filename>book.pdf</filename>
といった名前でインストールされます。</para>
@ -1070,78 +984,23 @@ before running "/usr/sbin/freebsd-update install"</screen>
デフォルトのインストール先は
<filename>/usr/local/share/doc/freebsd</filename>
です。</para>
<note>
<para>デフォルトのターゲットディレクトリは、
<application>svn</application>
を用いる方法とは異なります。
ports は通常 <filename>/usr/local</filename>
ディレクトリ以下にインストールされるためです。
<varname>PREFIX</varname> 変数を使うことで、
このディレクトリ以外にもインストールできます。</para>
</note>
</listitem>
</varlistentry>
</variablelist>
<para>以下は、上記の変数を用いてハンガリー語のドキュメントを
PDF 形式でインストールする方法です。</para>
<acronym>PDF</acronym> 形式でインストールする方法です。</para>
<screen>&prompt.root; cd /usr/ports/misc/freebsd-doc-hu
&prompt.root; make -DWITH_PDF DOCBASE=share/doc/freebsd/hu install clean</screen>
</sect4>
</sect3>
<sect3 xml:id="doc-ports-install-package">
<title>ドキュメンテーション package の利用</title>
<para>前節で説明した、
ソースからドキュメンテーション port を構築する方法では、
ドキュメンテーションツールチェインをローカルにインストールする必要があり、
また、ports の構築のためにディスク容量を必要とします。
ドキュメンテーションツールチェインをインストールするリソースがない場合や、
ソースから構築する場合には多くのディスク容量を必要とするため、
構築済みのドキュメンテーション ports
のスナップショットが用意されています。</para>
<para>&a.doceng; は、毎月 &os; ドキュメンテーション package
のスナップショットをアップデートしています。
これらのバイナリ package は、システムに用意されている
&man.pkg.add.1;, &man.pkg.delete.1; などの
package 管理ツールを用いて扱うことができます。</para>
<note>
<para>バイナリ package を使うと、
インストールする言語に用意されている
<emphasis>すべて</emphasis> の形式の
&os; ドキュメントがインストールされます。</para>
</note>
<para>たとえば、以下のコマンドを実行すると、
ハンガリー語のドキュメントの最新 package がインストールされます。</para>
<screen>&prompt.root; <userinput>pkg install hu-freebsd-doc</userinput></screen>
<note>
<para>ドキュメントの package は、対応する port 名とは異なり、
<literal><replaceable>lang</replaceable>-freebsd-doc</literal>
の形式で名前がつけられています。
ここで、<replaceable>lang</replaceable> は言語コードの短縮形です。
ハンガリー語の場合は <literal>hu</literal>、簡体字の場合には
<literal>zh_cn</literal> です。</para>
</note>
</sect3>
<sect3 xml:id="doc-ports-update">
<title>ドキュメンテーション ports のアップデート</title>
<para>他の port と同様に、ドキュメンテーション port
<para><xref linkend="ports"/> に書かれている手順を使って、
ドキュメンテーション package または port
をアップデートできます。
たとえば、以下のコマンドを実行すると、<package>ports-mgmt/portupgrade</package>
から、package だけを使ってインストールされているハンガリー語のドキュメントをアップデートします。</para>
<screen>&prompt.root; <userinput>portmaster -PP hu-freebsd-doc</userinput></screen>
</sect3>
</sect2>
</sect1>
@ -1687,7 +1546,7 @@ before running "/usr/sbin/freebsd-update install"</screen>
新しいグループや新しいシステムアカウント、
もしくはスタートアップスクリプトがシステムに追加されることがあります。</para>
<screen>&prompt.root; <userinput>mergemaster</userinput></screen>
<screen>&prompt.root; <userinput>mergemaster -iF</userinput></screen>
</step>
<step>