GNU/Linuxでmanページ書くときおすすめの形式はmanとmdocどっち？

GNU/Linuxでmanページ書くときおすすめの形式はmanとmdocどっち？

No.1 ベストアンサー 回答者： kantansi 回答日時： 2023/08/14 13:32

GNU/Linuxシステムでmanページを書く場合、一般的には「mdoc」形式よりも「man」形式が使われます。

なぜなら、「man」形式はGNUプロジェクトや多くのLinuxディストリビューションで標準的な形式であり、一般的なマニュアルページの形式として広く受け入れられているからです。

「man」形式は、タイトル、名前、概要、詳細な説明、オプション、環境変数、エラーメッセージなどのセクションが一般的に提供され、その他のセクションも適切に構成されています。GNUツールやLinuxのコアコンポーネントのドキュメントでは、主に「man」形式が使用されています。

一方で、「mdoc」形式は、特にBSD系のシステム（例: FreeBSD, OpenBSD）でよく使われますが、GNU/Linuxでは一般的ではありません。「mdoc」形式は、それ自体が一定のルールに従ってコマンドのマニュアルページを記述するためのフォーマットです。

総じて、GNU/Linuxシステムでmanページを書く際には「man」形式を使うことが一般的であり、一般的な慣習に従うことが推奨されます。ただし、特定のプロジェクトや組織が異なるガイドラインを持っている場合は、それに従うことが大切です。

この回答へのお礼

とはいえgroffにもmdocのマクロはあるしman-dbもある程度はmdoc対応なのでmdocでよくないですか。

お礼日時：2023/08/21 17:23