| Current File : //usr/share/man/ja_JP.UTF-8/man1/ckitem.1 |
'\" te
.\" Copyright 1989 AT&T Copyright (c) 1992, Sun Microsystems, Inc. All Rights Reserved
.TH ckitem 1 "1992 年 9 月 14 日" "SunOS 5.11" "ユーザーコマンド"
.SH 名前
ckitem, erritem, helpitem \- メニューの作成、およびメニュー項目の入力要求とその検証
.SH 形式
.LP
.nf
\fBckitem\fR [\fB-Q\fR] [\fB-W\fR \fIwidth\fR] [\fB-uno\fR] [\fB-f\fR \fIfilename\fR] [\fB-l\fR \fIlabel\fR]
[ [\fB-i\fR \fIinvis\fR] [,]...] [\fB-m\fR \fImax\fR] [\fB-d\fR \fIdefault\fR] [\fB-h\fR \fIhelp\fR]
[\fB-e\fR \fI error\fR] [\fB-p\fR \fIprompt\fR] [\fB-k\fR \fIpid\fR [\fB-s\fR \fIsignal\fR]]
[\fIchoice\fR [...]]
.fi
.LP
.nf
\fB/usr/sadm/bin/erritem\fR [\fB-W\fR \fIwidth\fR] [\fB-e\fR \fIerror\fR] [\fIchoice\fR [..]]
.fi
.LP
.nf
\fB/usr/sadm/bin/helpitem\fR [\fB-W\fR \fIwidth\fR] [\fB-h\fR \fIhelp\fR] [\fIchoice\fR [..]]
.fi
.SH 機能説明
.sp
.LP
\fBckitem\fR ユーティリティーは、メニューを作成し、ユーザーにプロンプトを出力してメニュー項目から 1 つの項目を選択するように促します。さらに、ユーザーの応答入力を検証します。このコマンドのオプションでは、プロンプトメッセージ、ヘルプメッセージとエラーメッセージ、およびデフォルト値 (ユーザーがキャリッジリターンで応答した場合に返される値) を定義します。
.sp
.LP
デフォルトでは、メニューは書式化されており、各項目の前に番号が付けられ、端末上に複数の列で出力されます。列の長さは、選択した最大長の項目によって決まります。項目はアルファベット順に表示されます。
.sp
.LP
メッセージの長さはすべて最大 70 文字に制限され、自動的に書式化されます。定義で使用されるスペース (復帰改行を含む) はすべて削除されます。\fB-W\fR オプションは、自動書式化を取り消します。メッセージ定義の最初または最後にチルド文字がある場合は、そこにデフォルトテキストが挿入されて、指定したテキストとデフォルトテキストの両方を表示することができます。
.sp
.LP
プロンプトメッセージ、ヘルプメッセージ、またはエラーメッセージが定義されていない場合は、デフォルトメッセージ (\fB「注意事項」\fRの項を参照) が表示されます。
.sp
.LP
\fBckitem\fR コマンドには、2 つのビジュアルツールモジュールがリンクされています。これらのモジュールは、\fBerritem\fR (エラーメッセージを書式化して表示する) と \fBhelpitem\fR (ヘルプメッセージを書式化して表示する) です。これらのモジュールは、\fBFML\fR オブジェクトと組み合わせて使用する必要があります。この場合、\fBFML\fR オブジェクトはプロンプトを定義します。これらのモジュールに \fIchoice\fR が定義されている場合、メッセージには利用可能なメニューの選択項目が含まれます。
.SH オプション
.sp
.LP
サポートしているオプションは、次のとおりです。
.sp
.ne 2
.mk
.na
\fB\fB-d\fR\fI default\fR\fR
.ad
.RS 15n
.rt
\fIdefault\fR をデフォルト値として定義します。デフォルト値は検証されないため、どのような基準も満たす必要はありません。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-e\fR\fI error\fR\fR
.ad
.RS 15n
.rt
\fIerror\fR をエラーメッセージとして定義します。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-f\fR \fIfilename\fR\fR
.ad
.RS 15n
.rt
\fIfilename\fR を表示されるメニュー項目のリストを含むファイルとして定義します。(このファイルの書式は、\fBtoken<tab>description\fR です。ポンド記号 (#) で始まる行は注釈として指定され、無視されます。)
.RE
.sp
.ne 2
.mk
.na
\fB\fB-h\fR\fI help\fR\fR
.ad
.RS 15n
.rt
\fI help\fR をヘルプメッセージとして定義します。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-i\fR\fI invis\fR\fR
.ad
.RS 15n
.rt
非表示メニュー項目 (メニューに表示されない選択項目) を定義します。(たとえば、非表示項目として使用される "all" は、有効なオプションですが、メニューには表示されません。任意の数の非表示項目を定義できます。)非表示項目があることを、プロンプトメッセージまたはヘルプメッセージのどちらかで、ユーザーに知らせるようにします。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-k\fR\fI pid\fR\fR
.ad
.RS 15n
.rt
ユーザーが中断を選択した場合、プロセス \fBID\fR \fIpid\fR のプロセスにシグナルを送信するようにします。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-l\fR\fI label\fR\fR
.ad
.RS 15n
.rt
メニューの上に表示するラベル、\fIlabel\fR を定義します。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-m\fR\fI max\fR\fR
.ad
.RS 15n
.rt
ユーザーが選択できるメニュー項目の最大数を定義します。デフォルトは 1 です。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-n\fR\fR
.ad
.RS 15n
.rt
メニュー項目をアルファベット順で表示しないようにします。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-o\fR\fR
.ad
.RS 15n
.rt
1 つのメニュートークンだけが返されるようにします。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-p\fR\fI prompt\fR\fR
.ad
.RS 15n
.rt
\fIprompt\fR をプロンプトメッセージとして定義します。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-Q\fR\fR
.ad
.RS 15n
.rt
有効な応答として終了 (quit) を使用できないようにします。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-s\fR\fI signal\fR\fR
.ad
.RS 15n
.rt
終了が選択された場合、\fB-k\fR オプションで定義されたプロセス \fBID\fR \fIpid\fR のプロセスに、シグナル \fIsignal\fR を送信するようにします。シグナルを指定しないと、\fBSIGTERM\fR を送信します。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-u\fR\fR
.ad
.RS 15n
.rt
メニュー項目に番号を付けずに表示するようにします。
.RE
.sp
.ne 2
.mk
.na
\fB\fB-W\fR\fI width\fR\fR
.ad
.RS 15n
.rt
プロンプトメッセージ、ヘルプメッセージ、およびエラーメッセージを、\fIwidth\fR の行長に書式化します。
.RE
.SH オペランド
.sp
.LP
次のオペランドを指定できます。
.sp
.ne 2
.mk
.na
\fB\fIchoice\fR\fR
.ad
.RS 10n
.rt
メニュー項目を定義します。項目はスペースか復帰改行で区切ります。
.RE
.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 オプションで負の行長が指定された、\fB-f\fR オプションでファイルが開けない、あるいは使用法に誤りがあった。
.RE
.sp
.ne 2
.mk
.na
\fB\fB3\fR\fR
.ad
.RS 5n
.rt
ユーザー終了 (quit)。
.RE
.sp
.ne 2
.mk
.na
\fB\fB4\fR\fR
.ad
.RS 5n
.rt
選択すべき項目がありません。
.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
\fBattributes\fR(5)
.SH 注意事項
.sp
.LP
ユーザーは、メニュー項目に番号が付いている場合はその項目の番号を、あるいは、その項目を一意に識別するのに必要な長さの文字列を入力できます。長いメニューはページに分割され、各ページには 10 個の項目が表示されます。
.sp
.LP
メニュー項目が、\fB-f\fR オプションで指定したファイルとコマンド行の両方に定義されている場合、メニュー項目は通常、アルファベット順に表示されます。ただし、アルファベット順での表示を抑制する \fB-n\fR オプションが使用されている場合は、ファイルに定義された項目が最初に表示され、次にコマンド行に定義されたオプションが表示されます。
.sp
.LP
\fBckitem\fR のデフォルトのプロンプトは次のとおりです。
.sp
.in +2
.nf
Enter selection [?,??,q]:
.fi
.in -2
.sp
.sp
.LP
1 つの疑問符はヘルプメッセージを表示してから、プロンプトを再表示します。2 つの疑問符は、ヘルプメッセージを表示してから、メニューラベル、メニュー、およびプロンプトを再表示します。
.sp
.LP
番号を入力した場合のデフォルトのエラーメッセージは、次のとおりです。
.sp
.in +2
.nf
ERROR: Bad numeric choice specification
.fi
.in -2
.sp
.sp
.LP
文字列を入力した場合のデフォルトのエラーメッセージは、次のとおりです。
.sp
.in +2
.nf
ERROR: Entry does not match available menu selection. Enter the number
of the menu item you wish to select, the token which is associated
with the menu item, or a partial string which uniquely identifies the
token for the menu item. Enter ?? to reprint the menu.
.fi
.in -2
.sp
.sp
.LP
デフォルトのヘルプメッセージは、次のとおりです。
.sp
.in +2
.nf
Enter the number of the menu item you wish to select, the token
which is associated with the menu item, or a partial string which
uniquely identifies the token for the menu item. Enter ? to
reprint the menu.
.fi
.in -2
.sp
.sp
.LP
終了オプションを選択した場合 (かつ使用できる場合) は、リターンコード \fB3\fR と共に \fBq\fR が返されます。