Current File : //usr/share/man/ja_JP.UTF-8/man1/checknr.1

'\" te
.\" Copyright (c) 1992, Sun Microsystems, Inc.
.TH checknr 1 "1992 年 9 月 14 日" "SunOS 5.11" "ユーザーコマンド"
.SH 名前
checknr \- nroff と troff 用の入力ファイルをチェックして誤りを報告
.SH 形式
.LP
.nf
\fBchecknr\fR [\fB-fs\fR] [\fB-a\fR . \fIx1\fR . \fIy1\fR . \fIx2\fR . \fIy2\fR ... .\fIxn\fR .\fIyn\fR] [\fB-c\fR . \fIx1\fR . \fIx2\fR . \fIx3\fR ... .\fIxn\fR] [\fIfilename\fR]...
.fi

.SH 機能説明
.sp
.LP
\fBchecknr\fR は \fBnroff\fR(1) または \fBtroff\fR(1) 用の入力ファイルの内容をチェックして、起こりうるエラーを見つけ出します。見つけられるエラーの種類は、区切り記号が対になっていない、未定義のコマンドが記述されている、などです。ファイル名を指定しないと、\fBchecknr\fR は標準入力の内容をチェックします。チェックされる区切り記号は次のとおりです。
.RS +4
.TP
.ie t \(bu
.el o
次の区切り記号で記述するフォント変更指定。\fB\f\fR\fIx \fR. . .\fB\fP\fR
.RE
.RS +4
.TP
.ie t \(bu
.el o
次の区切り記号で記述するサイズ変更指定。\fB\s\fR\fIx \fR. . .\fB\s0\fR
.RE
.RS +4
.TP
.ie t \(bu
.el o
マクロのうち、開始と . .終了とが常に対となって指定されるべきもの。たとえば、\fB\&.TS\fR と \fB\&.TE\fR マクロ
.RE
.sp
.LP
\fBchecknr\fR は、\fBms\fR(5) と \fBme\fR(5) マクロパッケージに対してもチェックできます。
.sp
.LP
\fBchecknr\fR コマンドは、作者が \fBchecknr\fR でのチェックを想定して記述したドキュメント の検査に適しています。特に \fB\f\fR と \fB\s\fR の両コマンドに関しては、特定のスタイルで記述されていなければなりません。具体的には、個々の \fB\f\fR\fIx\fR 指定は必ず対応する \fB\fP\fR 指定で終了し、同様に \fB\s\fR\fIx\fR 指定は必ず \fB\s0\fR 指定で終了していなければなりません。終了指定の代わりに 元のフォントまたはサイズ指定を明示的に記述しても、指定としては有効ですし、実際に多くのドキュメントはそのように書かれていることでしょう。しかしそのようなドキュメントを \fBchecknr\fR でチェックすると、大量のメッセージが出力されることになります。いずれにせよ、\fB\fP\fR や \fB\s0\fR を使った形式の方が優れていますので、checknr に処理させるかどうかに関わらず この形式を使うようお勧めします。
.SH オプション
.sp
.ne 2
.mk
.na
\fB\fB-f\fR\fR
.ad
.RS 22n
.rt  
\fB\f\fR によるフォント変更指定を無視します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-s\fR\fR
.ad
.RS 22n
.rt  
\fB\s\fR によるサイズ変更指定を無視します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB\fR\fB-a\fR\fB .\fR\fIx1 \fR\fB\&.\fR\fIy1. . .\fR \fR
.ad
.RS 22n
.rt  
マクロの対をリストに追加します。マクロは \fB\&.DS\fR と \fB\&.DE\fR のように対になっている必要があり、そのように対になっているかどうかが検査されます。\fB-a\fR の後には、6 文字一組でマクロの対を記述します。その 6 文字の内訳は、先頭がピリオド、次の 2 文字が開始マクロ名、次がピリオド、最後の 2 文字が終了マクロ名です。たとえば \fB\&.BS\fR と \fB\&.ES\fR の対を定義したければ、`\fB-a.BS.ES\fR' と指定します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB\fR\fB-c\fR\fB .\fR\fIx1 . . .\fR \fR
.ad
.RS 22n
.rt  
たとえ未定義であっても無視すべきコマンドを指定します。\fB\fR
.RE

.SH 属性
.sp
.LP
属性についての詳細は、マニュアルページの \fBattributes\fR(5) を参照してください。
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
属性タイプ属性値
_
使用条件text/doctools
.TE

.SH 関連項目
.sp
.LP
\fBeqn\fR(1), \fBnroff\fR(1), \fBtroff\fR(1), \fBattributes\fR(5), \fBme\fR(5), \fBms\fR(5) 
.SH 使用上の留意点
.sp
.LP
1 文字からなるマクロ名は、\fB-a\fR オプションを使って指定することができません。