manページを作成するツール（コマンド）について

質問

こんにちわ，
今，Linux（Redhat9)でいろいろな個人のプログラムの整理をしているのですが,そのプログラムやコマンドのmanページを作成したいと思っています。

以前きいたところによるとman　???というように既存のlsやCの関数のように検索できるように，manを作成するツールがあると聞いたのですが,そのツールはどのような名前なのでしょうか。

また，コマンドのヘルプを作成するとき，なにか他にいい案，ツールがあれば,教えてください。

よろしくおねがいします。

回答No.1

shige_70 · ベストアンサー

nroff というのがそうです。

作成するツールというよりは、もともとmanページは最初はソースしかインストールされておらず、初めて参照されるときにnroffで表示するテキストイメージを作成するしくみになっています。

ですから、nroffはls等と同レベルに扱う基本コマンドで、ほとんどのunix系システムには必ずはじめからインストールされています。

/usr/man/man* というディレクトリ群の中に、manページのnroffソースが入っていますので、これを参考に書いてみてください。

ソースを表示用に整形するときには、
　nroff -man file
とします。

ソースの文法は、man(5)に書いてあります。

回答No.2

nightowl

こんばんは。shige_70 さんのお答えで完璧と思いますが、蛇足まで。

書籍では「UNIX プログラミング環境」(Brian W. Kernighan, Rob Pike 著、アスキー)
の「9.4 マニュアルページの書き方(p.447-)」および
「Linux プログラミング」(Neil Matthew, Richard Stones 著、ソフトバンク)
の「8.3 マニュアルページの記述(p.355-)」にそれぞれ
マニュアルページファイルの雛形が紹介されています。
両方ともいい本ですが、特に前者はこの分野の古典的名著として名高く、
また今では入手困難でしょうから、書店などで見かけたら即購入するのが吉です。
シェルスクリプトの小技など心憎いほど。

作成された新しいローカルなマニュアルページは
マニュアルセクション n として /usr/local/man/mann
ディレクトリに入れておくのがいいでしょう。

参考URL：

http://www.amazon.co.jp/exec/obidos/ASIN/4871483517/satorutakabay-22/ref%3Dnosim/249-5843540-3100361