manを書く時のツール

質問

自分で書いたプログラムの説明を man で表示できるように記述したいと思っています。
手元のPCに、既にインストールされている他の man を見ると、
roff で書かれているようなのですが、マークアップの方法がよくわかりません。

できれば慣れている書式で書いて、roffへ変換できれば良いのですが、
そのような書式はどんなものがありますか？
私は reStructuredText を良く使用しているのですが、
これから roff へ変換するツールはまだリリースされていないようです。

または、roffでの man の書き方について丁寧に解説してあるページがあれば教えてください。

回答No.2

Lean

manマクロは下記ページのような感じですね。

groff_man(7)
http://www.linux.or.jp/JM/html/GNU_groff/man7/groff_man.7.html

以前、仕事の関係上roffデータを作成した事がありますが、それほど難しくはないですね。
まあ、慣れというのもあったかもしれませんが。
既にあるroffデータを参考にしてみるというのもありかと。

お礼

ありがとうございます。
既にある roff データを見てはいたのですが、.TH や .SH などの意味が分からず、また何処に説明があるかも分かっていませんでした。
groff_man(7) にあったのですね。勉強になります。

マクロの数も 30 程度で、思っていたより多くないのですね。
新しいマークアップ方式を覚えるのが嫌だったのですが、
これくらいなら覚えられそうです。

回答No.1

noname#39970

ちょっとだけ検索してみた
http://www.google.co.jp/search?q=man%20%E4%BD%9C%E6%88%90%E6%96%B9%E6%B3%95%20roff%20%E5%A4%89%E6%8F%9B&hl=ja&lr=lang_ja
良さそうなネタ　有りそう？

お礼

ありがとうございます。
最初の方しか見ていませんが、SGML で書いて、sgml2txt コマンドを使う方法があるようですね。
SGML はタグの書き方が煩雑なので、もう少し人間に読み書きしやすい形式で書けると、尚うれしいです。