7.2 内部用ツール

この節では、ドキュメント処理の様々な段階を実装したり、ビルド手順全体を演出する様々なスクリプトについて説明します。これらのツールのほとんどは標準ドキュメントを構築するというコンテキストでのみ有用ですが、汎用的なものもあります。

mkhowto

サードパーティ製のドキュメントをフォーマットする際に最初に使うスクリプトです。このスクリプトには、 ``正しく作業を行う'' 上で必要なロジックが全て入っています。このスクリプトを正しく使うには、スクリプトに対するシンボリックリンクを張って、その場所で実行します; 実際のスクリプトファイルはドキュメントソースツリーの一部として収められていなければなりませんが、ツリーの外部にあるドキュメントのフォーマットにも利用できます。コマンドラインオプションのリストを見るには、 mkhowto --help を使ってください。

mkhowto は howto と manual クラスのどちらのドキュメントにも使えます。このツールは、古い Python のソースリリースに入っているバージョンではなく、常に最新のバージョンを使うようにするのがよいでしょう。これらのツールは、 DVI、HTML、PDF、 PostScript、およびプレインテキスト形式のドキュメント生成に利用できます。将来のバージョンでは、このスクリプトで GNU info および iSilo 形式も扱えるようにする予定です。

コマンドラインで--help オプションを使ってこれらのスクリプトを実行すれば、利用できるオプションをまとめたものを表示します。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。