[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

10. 解説書の構築

現在AutomakeはTexinfoやmanページのサポートを提供している。

10.1 Texinfo  
10.2 manページ  

10.1 Texinfo

もし現在のディレクトリがTexinfoのソースを含むなら、それを`TEXINFOS' 主要変数で宣言しなければならない。一般的にTexinfoファイルはinfoに変換さ れるので、info_TEXINFOSマクロが最もありふれて使われている。 Texinfoのソース・ファイルは`.texi'か`.texinfo'拡張子で終端しな ければならないことに注意せよ。

もし`.texi'ファイルが`version.texi'を@includeするなら、 このファイルは自動的に生成されるだろう。`version.texi'ファイルは参照可能な 三つのTexinfoマクロを定義する。EDITION、VERSION、そして `UPDATED'である。最初の二つはあなたのパッケージのバージョン・ナンバー を保持する(が明瞭なように別々にされている)。最後のは主要なファイルが最後 に変更された日付である。`version.texi'サポートにはmdata-shプ ログラムが必要である。このプログラムはAutomakeと共に与えられており、 automakeが--add-missingオプション付きで実行されたときに 自動的に含まれる。

ときどきinfoファイルは実際には二つ以上の`.texi'ファイルに依存してい る。例えば、GNU Helloでは、`hello.texi'はファイル`gpl.texi'を 含む。Automakeにこれらの依存関係についてtexi_TEXINFOS変数を 使って教えることができる。ここにGNU Helloがそれをどうやっているかを示す。

 
info_TEXINFOS = hello.texi
hello_TEXINFOS = gpl.texi

デフォルトで、AutomakeはTexinfoのソースと同じディレクトリにファイル `texinfo.tex'があることを必要とする。しかしながら、もし `configure.in'でAC_CONFIG_AUX_DIR(see (autoconf)Input section `Finding `configure' Input' in The Autoconf Manual)を使ったなら、 `texinfo.tex'はそこで探される。Automakeはもし`--add-missing'が 与えられれば、`texinfo.tex'を与えてくれる。

もしあなたのパッケージが多くのディレクトリでTexinfoファイルを持っている なら、Automakeにあなたのパッケージの正しい`texinfo.tex'をどこで見付 けるかを教えるために変数TEXINFO_TEXを使用できる。この変数の値は現 在の`Makefile.am'から`texinfo.tex'への相対パスであるべきだ。

 
TEXINFO_TEX = ../doc/texinfo.tex

オプション`no-texinfo.tex'が`texinfo.tex'の必要性を失くすため に使われ得る。しかしながら、dviターゲットがそれでも働くようにする ので、変数TEXINFO_TEXの使用がより好ましい。

Automakeはinstall-infoターゲットを生成する。いくらかの人々は明ら かにこれを使う。デフォルトでは、infoページは`make install'でインス トールされる。これはno-installinfoオプションにより妨げられる。

10.2 manページ

パッケージはまたmanページを含むことができる。(だけどこの件についてGNU標 準を見なさい、(standards)Man Pages section `Man Pages' in The GNU Coding Standards。) manページは`MANS'主要変数を使って宣言される。一般的に man_MANSマクロが使用される。manページはファイルの拡張子に基いて、 自動的に正しいmandirのサブディレクトリにインストールされる。 それらは配布物に自動的には含まれない。

デフォルトでは、manページは`make install'によってインストールされる。 しかし、GNUプロジェクトはmanページを必要としないので、多くの管理者はman ページを最新状態にしようと努力しない。この場合には、no-installman オプションがmanページをデフォルトでインストールされないようにするだろう。 ユーザはそれでもなお`make install-man'によって明示的にそれらをイン ストールすることができる。

ここに解説書がGNU cpioでどう扱われるかを示す(それはTexinfo解説書 とmanページの両方を含む)。

 
info_TEXINFOS = cpio.texi
man_MANS = cpio.1 mt.1
EXTRA_DIST = $(man_MANS)

Texinfoのソースとinfoページは配布物を作るという目的には全てソースである と考えられる。

manページは現在のところソースであると考えられない、なぜならmanページが自 動的に生成されるのは珍しくないからだ。同じ理由のために、それらは配布物に 自動的には含まれない。

[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by Akihiro Sagawa on June, 15 2005 using texi2html 1.70.