checknr(1) FreeBSD 一般コマンドマニュアル

checknr

前のページ 上に戻る 次のページ

checknr




解説

     checknr は、 nroff(1)troff(1) の入力ファイルのリストに対して、デリミ
     タの開始および終了の不一致や間違ったコマンドを含む、ある種類のエラーを
     チェックします。ファイルが指定されなかった場合、 checknr は標準入力を
     チェックします。

     オプション

     -a      既知マクロのリストに追加のマクロペアを追加します。その後ろには 6
             文字のグループが続かなくてはなりません。各グループはマクロのペア
             を定義します。 6 文字はピリオドと最初のマクロ名、更にピリオドと2
             番目のマクロ名です。例えば、 .BS と .ES のペアを定義するために
             は、 `-a.BS.ES' を使ってください。

     -c      通常なら未定義であるといわれるコマンドを定義します。

     -f      checknr に `\f' のフォント変更を無視させます。

     -s      `\s' のサイズ変更を無視させます。

     デリミタのチェックは以下の通りです。

     1.   \fx ... \fP を使ったフォントの変更。

     2.   \sx ... \s0 を使ったサイズの変更。

     3.   .TS と .TEマクロのようにいつもペアで使われる、 ``開始...終了''形式の
          マクロ。

     checknr は、 lint(1) と同じように、 checknr によるチェックを念頭に置いて
     作成されたドキュメントをチェックするのに用いることを意図しています。コマ
     ンドは、記述形式が `\f' と `\s' コマンドに対して、各 `\fx' は `\fP' で終
     了されており、 `\sx' は `\s0' で終了されているようなものを期待していま
     す。直接次のフォントに切り替えたり、明示的にもとのフォントやポイントサイ
     ズを指定したりしても動作しますし、実際そのようにしているドキュメントは数
     多く存在しますが、 checknr はそのような使用法に対して警告を発します。おそ
     らく `\fP' と `\s0' 形式を使うほうがよいはずなので、このようなスタイルを
     用いることは、ドキュメント執筆スタイルの向上に寄与すると考えて下さい。

     checknr は、 ms(7)me(7) マクロパッケージを認識します。


関連項目

     nroff(1), troff(1), me(7), ms(7)


診断

     デリミタが一致しない時に、警告を出します。コマンドを認識できない時に、警
     告を出します。コマンドの文法について、さまざまな警告を出します。


バグ

     -a を用いて 1 文字のマクロ名を定義する方法がありません。


ABELNET VPSサービス