MANLINT(1) | Linux Programmer's Manual | MANLINT(1) |
名前
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 ファイルにある多くの問題を見付けることができる。作者
manlint の原作者は David A. Wheeler (dwheeler@ida.org) である。現在のメンテナーは Federico Lucifredi <flucifredi@acm.org>である。関連項目
man(7), mdoc(7).14 July 1999 | Linux |