Go to the first, previous, next, last section, table of contents.


ドキュメントのビルド

現在Automakeは,Texinfoとman pageに対するサポートを提供します.

Texinfo

カレントディレクトリにTexinfoソースを含んでいる場合,`TEXINFOS'プラ イマリでそれを宣言する必要があります.通常,Texinfoファイルはinfoに変換 されるので,info_TEXINFOS変数が最も一般的に使用されます.すべての Texinfoソースファイルは,`.texi'`.txi',または `.texinfo'の拡張子で終える必要があります.新しいマニュアルには, `.texi'を推奨します.

Automakeは,`.info'`.dvi'`.ps',そして`.pdf'ファ イルを,Texinfoソースからビルドする規則を生成します.`.info'ファイ ルはmake allでビルドされ,make installでインストールされま す(no-installinfoを使用していない場合に限ります.以下を参照してく ださい).それ以外のファイルは,make dvimake ps,そして make pdfでビルドを要求することが可能です.

`.texi'ファイルが`version.texi'@includeしている場合, そのファイルが自動的に生成されます.ファイル`version.texi'は,四つ のTexinfoのフラグを定義し,それは@value{EDITION}@value{VERSION}@value{UPDATED},そして @value{UPDATED-MONTH}を使用することで参照可能です.

EDITION
VERSION
これらのフラグは両方とも,プログラムのバージョンナンバーです.それらは明 確さのために別々にしています.
UPDATED
これは,主要な`.texi'ファイルが最後に修正された日付を保持します.
UPDATED-MONTH
これは,主要な`.texi'ファイルが最後に修正された月名を保持します.

`version.texi'サポートには,mdate-shプログラムが必要です.こ のプログラムはAutomakeと一緒に供給されていて,automake--add-missingオプションで呼び出されるとき,自動的に含まれます.

複数のTexinfoファイルがあり,`version.texi'の機能を使用したい場合, それぞれのTexinfoファイルに対し個別のバージョンファイルを持たせる必要が あります.Automakeは`vers*.texi'に一致したTexinfoファイル内に含まれ るものを,単純に自動的に生成されたバージョンファイルとして扱います.

infoファイルが再びビルドされるとき,MAKEINFO変数で指名されたプロ グラムが,その呼び出しで使用されます.システムでmakeinfoが見つかっ た場合,それがデフォルトで使用されます.それ以外の場合,missingが 代わりに使用されます.変数MAKEINFOFLAGSAM_MAKEINFOFLAGS にあるフラグは,makeinfoの呼び出しに渡されます.最初のものは,ユー ザが使用する(see section ユーザに対して予約されている変数)目的で,二番目のもの `Makefile.am'の著者が使用する目的です.

infoファイルが,実際には一つ以上の`.texi'ファイルに依存する場合もあ ります.例えば,GNU Helloでは,`hello.texi'`gpl.texi'ファイ ルを含んでいます.texi_TEXINFOS変数を使用することでこれらの 依存性をAutomakeに伝えることが可能です.GNU Helloで用いた方法は,以下の ようになっています.

info_TEXINFOS = hello.texi
hello_TEXINFOS = gpl.texi

デフォルトでAutomakeは,ファイル`texinfo.tex'がTexinfoソースと同じ ディレクトリに存在することを要求します.しかし,`configure.in'AC_CONFIG_AUX_DIRを使用した場合(see section `Finding `configure' Input' in The Autoconf Manual),`texinfo.tex'は そこで探されます.Automakeは,`--add-missing'が与えられている場合, `texinfo.tex'を供給します.

多くのディレクトリにTexinfoファイルがあるパッケージの場合,パッケージに 対する標準的な`texinfo.tex'が見つかる場所をAutomakeに伝えるため,変 数TEXINFO_TEXを使用することが可能です.この変数の値は,現在の `Makefile.am'から`texinfo.tex'への相対的なパスにすべきです.

TEXINFO_TEX = ../doc/texinfo.tex

オプション`no-texinfo.tex'を,`texinfo.tex'を要求することを止 めるために使用することが可能です.しかし,変数TEXINFO_TEXの使用は 望ましく,それはdvips,そしてpdfターゲットを動作 させることが可能だからです.

Automakeはinstall-infoターゲットを生成します.これを明示的に使用 する人もいます.デフォルトで,infoページは`make install'でインストー ルされます.これはno-installinfoオプションによって止めることが可 能です.

manページ

パッケージにmanページを含めることも可能です(しかし,この件に関しては, section `Man Pages' in The GNU Coding Standardsを参照してくださ い).manページは`MANS'プライマリを使用して宣言します.一般に man_MANS変数を使用します.manページは,mandirの正しいサブ ディレクトリに,ファイル拡張子に基づいて自動的にインストールされます.

`.1c'のようなファイルの拡張子は,有効な拡張子を探すために処理され, mandirの正しいサブディレクトリを決定するために使用されます.有効 なセクション名は,10進数の`0'から`9'と,文字の`l'`n'です.

開発者によっては,ソースファイルで`foo.man'のようなファイル名でman ページを命名し,ファイルをインストールするときに,例えば`foo.1'のよ うな正しい接尾子を持つものに名前を変更したい時もあります.Automakeはこの モードもサポートします.有効なセクションに命名されたSECTIONに対し て,`manSECTIONdir'と命名されている対応するディレクトリと,対 応する`_MANS'変数があります.そのような変数でリストアップされている ファイルは,示されているセクションにインストールされます.ファイルに有効 な接尾子が既についている場合,それはそのままインストールされます.それ以 外の場合,ファイルの接尾子はセクションに一致するように変更されます.

例えば,以下のような例を考えます.

man1_MANS = rename.man thesame.1 alsothesame.1c

この場合は,`rename.man'はインストールする時に`rename.1'に名前 を変更され,他のファイルはその名前のままになります.

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

(Texinfoドキュメントとmanページの両方を含んでいる)GNUcpioでは,ド キュメントを以下のようにして処理しています.

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

manページは,現在ソースであると考慮されておらず,そのわけはmanページが自 動的に生成されることが珍しくないからです.このため,それらは自動的に配布 物に含められません.しかし,これは`dist_'接頭辞を使用することで変更 可能です.

`nobase_'接頭辞はmanページに対しては意味が無く利用できません.


Go to the first, previous, next, last section, table of contents.