Merge the following from the English version:
1.235 -> 1.236 doc/ja_JP.eucJP/books/handbook/cutting-edge/chapter.sgml
This commit is contained in:
Ryusuke SUZUKI
parent
09fa16e7fd
commit
d6b82014ca
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=38581
1 changed files with 332 additions and 1 deletions
|
|
@ -2,7 +2,7 @@
|
|||
The FreeBSD Documentation Project
|
||||
The FreeBSD Japanese Documentation Project
|
||||
|
||||
Original revision: 1.235
|
||||
Original revision: 1.236
|
||||
$FreeBSD$
|
||||
-->
|
||||
|
||||
|
|
@ -77,6 +77,12 @@
|
|||
<para>インストールされているシステムと、変更が行われていない状態との比較方法。</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><application>CVSup</application><!-- and
|
||||
<application>Docsnap</application>--> を使って、
|
||||
ドキュメンテーションを最新のものにアップデートする方法。</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>2 つの開発ブランチ、&os.stable; と &os.current; の違い</para>
|
||||
</listitem>
|
||||
|
|
@ -706,6 +712,331 @@ Fetching 133 new ports or files... done.</screen>
|
|||
<screen>&prompt.root; <userinput>portsnap fetch update</userinput></screen>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="updating-upgrading-documentation">
|
||||
<title>ドキュメントのアップデート</title>
|
||||
|
||||
<indexterm><primary>Updating and Upgrading</primary></indexterm>
|
||||
|
||||
<indexterm>
|
||||
<primary>Documentation</primary>
|
||||
<see>Updating and Upgrading</see>
|
||||
</indexterm>
|
||||
|
||||
<para>ベースシステム、Ports Collection に加え、ドキュメントは、&os; オペレーティングシステムの構成要素です。
|
||||
&os; ドキュメントセットの最新バージョンは、<ulink
|
||||
url="http://www.freebsd.org/doc/">&os; ウェブサイト</ulink>
|
||||
から入手できますが、
|
||||
ネットワーク接続が遅い、もしくはまったく接続できないユーザもいます。
|
||||
幸運にも、各リリースで提供されるドキュメントをアップデートして、
|
||||
最新の &os;
|
||||
ドキュメントセットをローカルで維持する方法が用意されています。</para>
|
||||
|
||||
<sect2 id="csup-doc">
|
||||
<title>CVSup を用いたドキュメントのアップデート方法</title>
|
||||
|
||||
<para>&os; のドキュメントのソースやインストールされたドキュメントは、
|
||||
ベースシステムのソースのアップデート
|
||||
(<xref linkend="makeworld"> を参照) と同様、
|
||||
<application>CVSup</application> を用いてアップデートできます。
|
||||
この節では以下について説明します。</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>ドキュメントツールチェインのインストール方法。
|
||||
このツールは、&os;
|
||||
のドキュメントをソースから再構築するのに必要です。</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><application>CVSup</application> を用いて
|
||||
<filename class="directory">/usr/doc</filename>
|
||||
にドキュメントのソースをダウンロードする方法。</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>&os; ドキュメントをソースから再構築し、
|
||||
<filename class="directory">/usr/share/doc</filename>
|
||||
以下にインストールする方法。</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>ドキュメントのビルドシステムにおいてサポートされているビルドオプションの説明。
|
||||
たとえば、翻訳されたドキュメンテーションのみを構築するオプションや、
|
||||
ある特定の出力フォーマットを指定するようなオプションについて説明します。</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="installing-documentation-toolchain">
|
||||
<title>CVSup およびドキュメントツールチェインのインストール</title>
|
||||
|
||||
<para>&os; のドキュメントをソースから再構築するには、
|
||||
かなり大きなツールのコレクションが必要です。
|
||||
これらのツールは多くのディスク容量を必要とし、また、
|
||||
すべての &os; ユーザにとって有用というわけではないため、
|
||||
&os; ベースシステムの一部ではありません。
|
||||
これらのツールは、&os;
|
||||
のために新しいドキュメントを活発に執筆している方や、
|
||||
頻繁にドキュメントをソースからアップデートする方に向けたものです。</para>
|
||||
|
||||
<para>必要なツールは、すべて Ports Collection で入手できます。<filename
|
||||
role="package">textproc/docproj</filename> は、
|
||||
&os; ドキュメンテーションプロジェクトにより開発されているマスター port で、
|
||||
これらのツールのインストールやアップデートを容易にします。</para>
|
||||
|
||||
<note>
|
||||
<para>ドキュメントの &postscript; や PDF 版が必要なければ、かわりに
|
||||
<filename
|
||||
role="package">textproc/docproj-nojadetex</filename>
|
||||
をインストールすることも考えてよいでしょう。
|
||||
このドキュメンテーションのツールチェインは、
|
||||
<application>teTeX</application>
|
||||
と呼ばれる組版エンジンを除いたすべてをインストールします。
|
||||
<application>teTeX</application> は大きなツールのコレクションです。
|
||||
そのため、もし PDF 出力を本当に必要としなければ、
|
||||
このツールをインストールしないことはとても賢明です。</para>
|
||||
</note>
|
||||
|
||||
<para><application>CVSup</application>
|
||||
のインストールおよび利用に関するさらなる情報は、<link
|
||||
linkend="cvsup">CVSup を使う</link> の章をご覧ください。</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="updating-documentation-sources">
|
||||
<title>ドキュメントのソースをアップデートする</title>
|
||||
|
||||
<para><application>CVSup</application> ユーティリティを使って、
|
||||
ドキュメントのソースをダウンロードできます。
|
||||
ここで <filename>/usr/share/examples/cvsup/doc-supfile</filename>
|
||||
ファイルが設定のテンプレートです。
|
||||
デフォルトのアップデートホストは <filename>doc-supfile</filename>
|
||||
のプレースホルダの値で設定されていますが、
|
||||
&man.cvsup.1; にコマンドラインでホスト名を指定することもできます。
|
||||
<application>CVSup</application> サーバの
|
||||
1 つからドキュメントのソースをダウンロードするには以下のように入力してください。</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cvsup -h <replaceable>cvsup.FreeBSD.org</replaceable> -g -L 2 <filename>/usr/share/examples/cvsup/doc-supfile</filename></userinput></screen>
|
||||
|
||||
<para>ここで <replaceable>cvsup.FreeBSD.org</replaceable> を最も近くの
|
||||
<application>CVSup</application> サーバに置き換えてください。
|
||||
ミラーサイトの完全な一覧については、<xref
|
||||
linkend="cvsup-mirrors"> をご覧ください。</para>
|
||||
|
||||
<para>最初にドキュメントのソースをダウンロードするには少し時間がかかります。
|
||||
ダウンロードが終わるまでお待ちください。</para>
|
||||
|
||||
<para>将来ドキュメントのソースをアップデートするには、
|
||||
同じコマンドを実行してください。<application>CVSup</application>
|
||||
ユーティリティは最後に実行した時からのアップデートのみをダウンロードするので、
|
||||
最初に <application>CVSup</application> を実行した後では、
|
||||
コマンドの実行時間はかなり短くなります</para>
|
||||
|
||||
<para>ソースを入手したら、ドキュメントのアップデートに、<filename
|
||||
class="directory">/usr/doc</filename> ディレクトリの
|
||||
<filename>Makefile</filename> を使うこともできます。
|
||||
<filename>/etc/make.conf</filename> ファイルの
|
||||
<makevar>SUP_UPDATE</makevar>, <makevar>SUPHOST</makevar> および
|
||||
<makevar>DOCSUPFILE</makevar> を設定すると、
|
||||
以下を実行できるようになります。</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make update</userinput></screen>
|
||||
|
||||
<para>以下は、<filename>/etc/make.conf</filename> の &man.make.1;
|
||||
オプションの典型的な例です。</para>
|
||||
|
||||
<programlisting>SUP_UPDATE= yes
|
||||
SUPHOST?= cvsup.freebsd.org
|
||||
DOCSUPFILE?= /usr/share/examples/cvsup/doc-supfile</programlisting>
|
||||
|
||||
<note>
|
||||
<para><makevar>SUPHOST</makevar> および
|
||||
<makevar>DOCSUPFILE</makevar> の値を
|
||||
<literal>?=</literal> にすると、
|
||||
make のコマンドラインからの上書きを許可します。
|
||||
これは、さまざまなオプションの値をテストする場合に、
|
||||
値ごとにファイルを編集することを避けられるため、
|
||||
<filename>make.conf</filename>
|
||||
にオプションを追加する方法として推奨されています。</para>
|
||||
</note>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="updating-documentation-options">
|
||||
<title>ドキュメントのソースの調整可能なオプション</title>
|
||||
|
||||
<para>&os; のドキュメントのアップデートとビルドシステムは、
|
||||
ドキュメンテーションの一部のアップデートを簡単にするオプションや、
|
||||
特定の翻訳のビルドに対応しています。
|
||||
これらのオプションは、システム全般のオプションである
|
||||
<filename>/etc/make.conf</filename> ファイルや、&man.make.1;
|
||||
ユーティリティに与えるコマンドラインオプションで設定できます。</para>
|
||||
|
||||
<para>以下がこれらのオプションの一部です。</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><makevar>DOC_LANG</makevar></term>
|
||||
|
||||
<listitem>
|
||||
<para>ビルドおよびインストールの言語およびエンコーディングの一覧。
|
||||
たとえば、<literal>en_US.ISO8859-1</literal> は、
|
||||
英語のドキュメントのみを指定します。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><makevar>FORMATS</makevar></term>
|
||||
|
||||
<listitem>
|
||||
<para>ビルドを行うフォーマット、または出力フォーマットの一覧。
|
||||
現在は <literal>html</literal>,
|
||||
<literal>html-split</literal>, <literal>txt</literal>,
|
||||
<literal>ps</literal>, <literal>pdf</literal>,
|
||||
そして <literal>rtf</literal> に対応しています。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><makevar>SUPHOST</makevar></term>
|
||||
|
||||
<listitem>
|
||||
<para>アップデート時に使う <application>CVSup</application>
|
||||
サーバのホストネーム。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><makevar>DOCDIR</makevar></term>
|
||||
|
||||
<listitem>
|
||||
<para>ドキュメントをインストールする場所。デフォルトは
|
||||
<filename
|
||||
class="directory">/usr/share/doc</filename> です。</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>&os; のシステム全般のオプションに関連するもっと多くの make 変数については、
|
||||
&man.make.conf.5; をご覧ください。</para>
|
||||
|
||||
<para>&os; ドキュメントのビルドシステムで対応しているさらなる make の変数に関しては、
|
||||
|
||||
<ulink url="&url.doc.langbase.en;/books/fdp-primer">新しい貢献者のための &os; ドキュメンテーションプロジェクト入門 </ulink> を参照してください。</para>
|
||||
</sect2>
|
||||
|
||||
<sect2 id="updating-installed-documentation">
|
||||
<title>ソースから &os; ドキュメントをインストールする</title>
|
||||
|
||||
<para>ドキュメントのソースの最新スナップショットを
|
||||
<filename class="directory">/usr/doc</filename> にダウンロードし終わったら、
|
||||
インストールされているドキュメントをアップデートする準備がすべて整いました。</para>
|
||||
|
||||
<para>makefile の <makevar>DOC_LANG</makevar>
|
||||
オプションで定義されているすべての言語を完全にアップデートするには、
|
||||
以下のように入力してください。</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make install clean</userinput></screen>
|
||||
|
||||
<para>もし、<filename>make.conf</filename> で
|
||||
<makevar>DOCSUPFILE</makevar>, <makevar>SUPHOST</makevar> および
|
||||
<makevar>SUP_UPDATE</makevar> オプションを適切に設定しているのであれば、
|
||||
インストールのステップは、
|
||||
以下のようにドキュメントのアップデート作業と統合できます。</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make update install clean</userinput></screen>
|
||||
|
||||
<para>もし、ある特定の言語のみをアップデートしたいのであれば、
|
||||
<filename class="directory">/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>make の <makevar>FORMATS</makevar> 変数を設定して、
|
||||
以下のようにインストールする出力形式を指定できます。</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/doc</userinput>
|
||||
&prompt.root; <userinput>make FORMATS='html html-split' install clean</userinput></screen>
|
||||
</sect2>
|
||||
|
||||
<!-- FIXME: Waiting for a working docsnap server... -->
|
||||
<![ IGNORE [
|
||||
<sect2 id="docsnap">
|
||||
<sect2info>
|
||||
<authorgroup>
|
||||
<author>
|
||||
<firstname>Pav</firstname>
|
||||
<surname>Lucistnik</surname>
|
||||
<contrib>Based on information provided by </contrib>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</sect2info>
|
||||
|
||||
<title>Using Docsnap</title>
|
||||
|
||||
<indexterm><primary>Updating and Upgrading</primary></indexterm>
|
||||
|
||||
<indexterm>
|
||||
<primary>Docsnap</primary>
|
||||
<see>Updating and Upgrading</see>
|
||||
</indexterm>
|
||||
|
||||
<para><application>Docsnap</application> is an &man.rsync.1;
|
||||
repository for updating installed &os; Documentation in a
|
||||
relatively easy and fast way. A
|
||||
<quote><application>Docsnap</application> server</quote> tracks
|
||||
the documentation sources, and builds them in HTML format every
|
||||
hour. The <filename role="package">textproc/docproj</filename>
|
||||
is unneeded with <application>Docsnap</application> as only
|
||||
patches to the built documentation exist.</para>
|
||||
|
||||
<para>The only requirement for using this technique is
|
||||
the <filename role="package">net/rsync</filename> port or
|
||||
package. To add it, use the following command:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>pkg_add -r rsync</userinput></screen>
|
||||
|
||||
<note>
|
||||
<para><application>Docsnap</application> has been originally
|
||||
developed for updating documentation installed
|
||||
to <filename class="directory">/usr/share/doc</filename>, but
|
||||
the following examples could be adapted for other directories
|
||||
as well. For user directories, it does not require
|
||||
<username>root</username> privileges.</para>
|
||||
</note>
|
||||
|
||||
<para>To update the documentation set, issue the following
|
||||
command:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>rsync -rltvz <replaceable>docsnap.sk.FreeBSD.org</replaceable>::docsnap <replaceable>/usr/share/doc</replaceable></userinput></screen>
|
||||
|
||||
<note>
|
||||
<para>There is only one <application>Docsnap</application>
|
||||
server at the moment;
|
||||
the <hostid>docsnap.sk.FreeBSD.org</hostid> shown
|
||||
above.</para>
|
||||
</note>
|
||||
|
||||
<para>Do not use the <option>--delete</option> flag here as there
|
||||
are some items installed
|
||||
into <filename class="directory">/usr/share/doc</filename>
|
||||
during <command>make installworld</command>, which would
|
||||
accidentally be removed. To clean up, use this command
|
||||
instead:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>rsync -rltvz --delete <replaceable>docsnap.sk.FreeBSD.org</replaceable>::docsnap/??_??\.\* <replaceable>/usr/share/doc</replaceable></userinput></screen>
|
||||
|
||||
<para>If a subset of documentation needs to be updated, for
|
||||
example, the English documentation only, the following command
|
||||
should be used:</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>rsync -rltvz <replaceable>docsnap.sk.FreeBSD.org</replaceable>::docsnap/en_US.ISO8859-1 <replaceable>/usr/share/doc</replaceable></userinput></screen>
|
||||
</sect2>
|
||||
]]>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="current-stable">
|
||||
<title>開発ブランチを追いかける</title>
|
||||
<indexterm><primary>-CURRENT</primary></indexterm>
|
||||
|
|
|
|||
Loading…
Reference in a new issue