4. Man ページの書き方

この章では jlinuxdoc-sgml を使って、Man ページ を書 く方法について説明します。

4.1 全体の構成

Man ページは、以下の様に記述します。

<!doctype linuxdoc system>

<manpage title="名前">

<sect1>名前
<p>
名前 - 機能の簡単な説明

<sect1>形式
<p>
使用方法

<sect1>機能説明
<p>
詳細な説明

<sect1>オプション
<p>
コマンドのオプションの説明

<sect1>環境変数
<p>
関連する環境変数の説明

<sect1>ファイル
<p>
関連するファイルの説明

<sect1>関連項目
<p>
関連するマニュアルの紹介

<sect1>バグ
<p>
バグの説明

</manpage>

上記の内、名前(NAME)と形式(SYNOPSIS)と機能説明(DESCRIPTION)は必須です が、それ以外の章は省略可能ですし、他の章を追加することも可能です。例え ば「不具合＆改良案」という章を追加し、コマンドの作者名と連絡先(メール アドレス)を示したりすることはよくあります。

4.2 スタイル

スタイルには、<manpage>...</manpage>を指定しま す。また、<manpage> の部分で「名前」と「章番号」を指定します。な お、章番号のデフォルトが 1 に設定されていますので、章番号が 1 の場合に は省略できます。

名前が mh-alias、章番号が 5 の場合には以下のようになります。

<manpage title="MH-ALIAS" sectnum="5">

4.3 各章

各章は <sect1> を使用して書くことに注意する以外は、他の文書の書 き方と同じです。

man ページのサンプルとして、doc/kon.sgml が添付されています。 御参照下さい。