名前¶

manlint - man ページや mdoc ページのエラーを報告するプログラム

書式¶

manlint [ options ] [ list of files ]

説明¶

manlint は、通常のテキストのスペルチェッカのように、 man ページや mdoc ページのフォーマットの lint (エラー) を明らかにする。 manlint は許可されるマクロとエスケープシーケンスの一覧を持ち、 許可されるリストにないマクロやエスケープシーケンスが 使われているかを報告する。 許可されるリストには、 man(7) と mdoc(7) で定義される全てのマクロと、 man(7) で定義される troff の安全なサブセットが含まれる。 manlint はいろいろなルールが適合するかどうかもチェックする。

man ページが manlint を通れば、 troff の全てを実装しているわけではない man2html(1) のようなツールに対しても、広く移植可能である。

ファイルのリストを省略した場合は、標準入力を使う。 "-" という名前のファイルは標準入力として解釈される。

バグ¶

現在のところ、このプログラムは非常に不完全である。 オプションはなく、実際にはエスケープシーケンスをチェックしない。 また mdoc フォーマットを処理できない。 しかし、このプログラムが何をすべきかは明らかであり、 現在の状態でも既存の man ファイルにある多くの問題を見付けることができる。

著者¶

David A. Wheeler (dwheeler@ida.org)

関連項目¶

man(7), mdoc(7).