Linux Tips

独自のmanページを作成するには

北浦訓行
2006/1/26

 manコマンドで表示されるドキュメント(manページ)は、テキスト内に制御コマンドを挿入することによってボールドやインデントなどの書式を実現している。

 制御コマンドは、使用例を参照すると分かりやすい。Fedora Core 4の場合、デフォルトの日本語manページが/usr/share/man/jaディレクトリ下にあるサブディレクトリ(man1〜man9)にセクション別に格納されている。ファイルはZIP形式で圧縮されているので、例えばmanコマンドのmanページをテキストファイルとして表示するには、zcatコマンドを使う。

$ zcat /usr/share/man/ja/man1/man.1.gz
(省略)
.\"
.TH man 1 "September 12, 1995"
.LO 1
.SH 名前
man \- オンラインマニュアルページを整形し表示する。
.br
manpath \- ユーザー個々のマニュアルページの検索パスを決める。
.SH 書式
man [\-adfhktwW] [\-m system] [\-p string] [\-C config_file] [\-M path]
[\-P pager] [\-S section_list] [section] name ...
(省略)

 Linuxのmanページでは、以下のような制御コマンドがよく使われている。

制御コマンド
意味
.B 文字をボールド(太字)にする
.br 段落と段落の間で改行する
.I 文字をイタリックにする(GNOME端末などでは下線付きで表示される)
.PP 段落の内部で改行する
.SH 段落名 段落を開始する
.TH タイトル セクション番号 出自 タイトル manコマンドの行頭に表示される情報。この行はmanページの先頭に配置する(コメント行は除く)
.TP 文字数 文字数分だけ字下げする。コマンドのmanページでは、オプションパラメータの記述に用いられる
\- ハイフンを表示する
.\" コメントを記述する。コメントは表示されない

 manページの記述に使用可能なコマンドは、man(7)で詳しく説明されている。man(7)は以下のコマンドで表示可能だ。

$ man 7 man

Linux Tips Index



 Linux Squareフォーラム Linux Tipsカテゴリ別インデックス
インストール/RPM ブート/ブートローダ
ファイル操作 環境設定
ユーザー管理 コンソール/ターミナル
X Window System セキュリティ
トラブルシューティング 他OS関係
ネットワーク ハードウェア
Webサーバ Samba
GNOME KDE
OpenOffice.org エミュレータ
ソフトウェア そのほか/FAQ
全Tips公開順インデックス Linux Tips月間ランキング
Linux Squareフォーラム全記事インデックス

MONOist組み込み開発フォーラムの中から、Linux関連記事を紹介します

@IT Special

- PR -

TechTargetジャパン

Linux & OSS フォーラム 新着記事
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)
- PR -

イベントカレンダー

PickUpイベント

- PR -

アクセスランキング

もっと見る

ホワイトペーパーTechTargetジャパン

注目のテーマ

Linux & OSS 記事ランキング

本日 月間
ソリューションFLASH