'\" te
.\"  Copyright 1989 AT&T Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved
.TH ckstr 1 "1992 年 9 月 14 日" "SunOS 5.11" "ユーザーコマンド"
.SH 名前
ckstr, errstr, helpstr, valstr \- 文字列の入力要求とその検証
.SH 形式
.LP
.nf
\fBckstr\fR [\fB-Q\fR] [\fB-W\fR \fIwidth\fR] [ [\fB-r\fR \fIregexp\fR] [...]] [\fB-l\fR \fIlength\fR] [\fB-d\fR \fIdefault\fR] [\fB-h\fR \fIhelp\fR] [\fB-e\fR \fIerror\fR] [\fB-p\fR \fIprompt\fR] [\fB-k\fR \fIpid\fR [\fB- s\fR \fIsignal\fR]]
.fi

.LP
.nf
\fB/usr/sadm/bin/errstr\fR [\fB-W\fR \fIwidth\fR] [\fB-e\fR \fIerror\fR] [\fB-l\fR \fIlength\fR] [ [\fB-r\fR \fIregexp\fR] [...]]
.fi

.LP
.nf
\fB/usr/sadm/bin/helpstr\fR [\fB-W\fR \fIwidth\fR] [\fB-h\fR \fIhelp\fR] [\fB-l\fR \fIlength\fR] [ [\fB-r\fR \fIregexp\fR] [...]]
.fi

.LP
.nf
\fB/usr/sadm/bin/valstr\fR [\fB-l\fR \fIlength\fR] [ [\fB-r\fR \fIregexp\fR] [...]] \fIinput\fR
.fi

.SH 機能説明
.sp
.LP
\fBckstr\fR ユーティリティーは、ユーザーに入力を要求してその応答を検証します。このユーティリティーでは、文字列の入力を促すプロンプトメッセージ、ヘルプメッセージとエラーメッセージ、およびデフォルト値 (ユーザーが RETURN キーで応答した場合に返される値) をオプションにより定義できます。
.sp
.LP
このコマンドから返される応答は、定義済みの正規表現に一致していなければならず、指定された長さ以内でなければなりません。正規表現が指定されていない場合、有効な入力は、内部にスペースを含まず、また先行や後続するスペースがない、指定された長さ以内の文字列でなければなりません。長さが指定されていない場合、長さは検査されません。
.sp
.LP
メッセージの長さはすべて最大 79 文字に制限され、自動的に書式化されます。メッセージ定義内で 1 つのスペース文字の後にあるタブと復帰改行は削除されますが、スペースは削除されません。メッセージ定義の最初または最後にチルド文字がある場合は、そこにデフォルトテキストが挿入されて、指定したテキストとデフォルトテキストの両方を表示することができます。
.sp
.LP
プロンプトメッセージ、ヘルプメッセージ、またはエラーメッセージが定義されていない場合は、デフォルトメッセージ (「使用例」の項を参照) が表示されます。
.sp
.LP
\fBckstr\fR コマンドには、3 つのビジュアルツールモジュールがリンクされています。これらのモジュールは、\fBerrstr\fR (標準出力上にエラーメッセージを書式化して表示する)、\fBhelpstr\fR (標準出力上にヘルプメッセージを書式化して表示する)、および \fBvalstr\fR (応答を検証する) です。 
.SH オプション
.sp
.LP
サポートしているオプションは、次のとおりです。
.sp
.ne 2
.mk
.na
\fB\fB-d\fR\fI default\fR\fR
.ad
.RS 14n
.rt  
\fIdefault\fR をデフォルト値として定義します。デフォルト値は検証されないため、どのような基準も満たす必要はありません。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-e\fR \fIerror\fR\fR
.ad
.RS 14n
.rt  
\fIerror\fR をエラーメッセージとして定義します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-h\fR \fIhelp\fR\fR
.ad
.RS 14n
.rt  
\fIhelp\fR をヘルプメッセージとして定義します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-k\fR\fI pid\fR\fR
.ad
.RS 14n
.rt  
ユーザーが中断を選択した場合、プロセス \fBID\fR \fIpid\fR のプロセスにシグナルを送信するようにします。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-l\fR \fIlength\fR\fR
.ad
.RS 14n
.rt  
入力の最大長を指定します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-p\fR\fI prompt\fR\fR
.ad
.RS 14n
.rt  
\fIprompt\fR をプロンプトメッセージとして定義します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-Q\fR\fR
.ad
.RS 14n
.rt  
有効な応答として終了 (\fBquit\fR) を使用できないようにします。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-r\fR \fIregexp\fR\fR
.ad
.RS 14n
.rt  
入力を検証するときの基準となる正規表現、\fI regexp\fR を指定します。スペースを含めることができます。複数の式が定義されている場合、応答はその内のいずれかに一致しなければなりません。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-s\fR \fIsignal\fR\fR
.ad
.RS 14n
.rt  
終了が選択された場合、\fB-k\fR オプションで定義されたプロセス \fBID\fR \fIpid\fR のプロセスに、シグナル \fIsignal\fR を送信するようにします。シグナルを指定しないと、\fBSIGTERM\fR を送信します。
.RE

.sp
.ne 2
.mk
.na
\fB\fB-W\fR\fI width\fR\fR
.ad
.RS 14n
.rt  
プロンプトメッセージ、ヘルプメッセージ、およびエラーメッセージを、\fIwidth\fR の行長に書式化します。
.RE

.SH オペランド
.sp
.LP
次のオペランドを指定できます。
.sp
.ne 2
.mk
.na
\fB\fIinput\fR\fR
.ad
.RS 9n
.rt  
書式の長さや正規表現の基準に対して検証される入力
.RE

.SH 使用例
.LP
\fB例 1 \fRデフォルトのプロンプト
.sp
.LP
\fBckstr\fR のデフォルトのプロンプトは、次のとおりです。

.sp
.in +2
.nf
example% \fBckstr\fR
Enter an appropriate value [?,q]:
.fi
.in -2
.sp

.LP
\fB例 2 \fRデフォルトのエラーメッセージ
.sp
.LP
デフォルトのエラーメッセージは、適用される妥当性検査のタイプによって異なります。ユーザーには、長さまたはパターン照合のいずれかが失敗したことが通知されます。デフォルトのエラーメッセージは、次のとおりです。

.sp
.in +2
.nf
example% \fB/usr/sadm/bin/errstr\fR
ERROR: Please enter a string which contains no embedded,
leading or trailing spaces or tabs.
.fi
.in -2
.sp

.LP
\fB例 3 \fRデフォルトのヘルプメッセージ
.sp
.LP
デフォルトのヘルプメッセージも、適用される妥当性検査のタイプによって異なります。正規表現が定義されている場合、メッセージは次のようになります。

.sp
.in +2
.nf
example% \fB/usr/sadm/bin/helpstr \fR\fB-r\fR\fB regexp\fR
Please enter a string which matches the following pattern:
regexp
.fi
.in -2
.sp

.sp
.LP
他のメッセージは、文字列の長さの要件と定義を指定します。

.LP
\fB例 4 \fR終了 (quit) オプションの使用
.sp
.LP
終了オプションを選択した場合 (かつ使用できる場合) は、リターンコード \fB3\fR と共に \fBq\fR が返されます。終了を入力すると、後に復帰改行が続きます。

.LP
\fB例 5 \fRvalstr モジュールの使用
.sp
.LP
\fBvalstr\fR モジュールは、標準エラー出力に使用法に関するメッセージを出力します。正常終了した場合は \fB0\fR、失敗した場合には 0 以外の値を返します。

.sp
.in +2
.nf
example% \fB/usr/sadm/bin/valstr\fR
usage: valstr [\fB-l\fR length] [[\fB-r\fR regexp] [\|.\|.\|.\|]] input
.fi
.in -2
.sp

.SH 終了ステータス
.sp
.LP
次の終了ステータスが返されます。
.sp
.ne 2
.mk
.na
\fB\fB0\fR\fR
.ad
.RS 5n
.rt  
正常終了。
.RE

.sp
.ne 2
.mk
.na
\fB\fB1\fR\fR
.ad
.RS 5n
.rt  
入力で \fBEOF\fR が検出された、\fB-W\fR オプションで負の行長が指定された、または使用法に誤りがあった。
.RE

.sp
.ne 2
.mk
.na
\fB\fB2\fR\fR
.ad
.RS 5n
.rt  
無効な正規表現。
.RE

.sp
.ne 2
.mk
.na
\fB\fB3\fR\fR
.ad
.RS 5n
.rt  
ユーザー終了 (quit)。
.RE

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

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

.SH 関連項目
.sp
.LP
\fBsignal.h\fR(3HEAD), \fBattributes\fR(5)