macos - Unix コマンドのドキュメントを提供していますか?

Question

Word ファイルを Mac から Unix に変換する macmac2unix という Unix コマンドを作成しました。

コマンドのドキュメントを提供するにはどうすればよいですか? 私は自分のコマンドについて man と読みたい

$man macmac2unix

Answer 1

PerlのPOD形式をお勧めします。名前にもかかわらず、Perlスクリプトの外で使用でき、pod2manコマンドはOSXに付属しています。troffよりもはるかに賢明です。Markdownを思い出させます。

ポッドドキュメントと変換スクリプトの例を次に示します。

Answer 2

どうやらDocBookを使ってUnixコマンドのドキュメントを提供することもできます。