'\"macro stdmacro
.if n .pH g1.ckkeywd @(#)ckkeywd	40.13 of 10/10/89
.\" Copyright 1989 AT&T
.nr X
.if \nX=0 .ds x} ckkeywd 1 "Essential Utilities" "\&"
.if \nX=1 .ds x} ckkeywd 1 "Essential Utilities"
.if \nX=2 .ds x} ckkeywd 1 "Essential Utilities" "\&"
.if \nX=3 .ds x} ckkeywd "Essential Utilities" "" "\&"
.TH \*(x}
.SH NAME
\f4ckkeywd\f1 \- prompts for and validates a keyword
.SH SYNOPSIS
\f4ckkeywd\f1 [\f4\-Q\f1] [\f4\-W\f2 width\f1] [\f4\-d\f2 default\f1] [\f4\-h\f2 help\f1] [\f4\-e\f2 error\f1] [\f4\-p \f2prompt\f1]
.br
[\f4\-k\f2 pid\f1 [\f4\-s\f2 signal\f1]] [\f2keyword\f1 [...]]
.SH DESCRIPTION
\f4ckkeywd\f1 prompts a user and validates the response.
It defines, among other things,
a prompt message whose response should be one 
of a list of keywords, text for help and
error messages, and a default value
(which will be returned if the user responds with a carriage return).
The answer returned from this command must match one of the defined
list of keywords.
.P
All messages are limited in length to 70 characters and
are formatted automatically.
Any white space used in the definition (including newline) is stripped.
The \f4\-W\f1 option cancels the automatic formatting.
When a tilde is placed at the beginning or end of a message definition,
the default text will be
inserted at that point, allowing both custom text and the default text
to be displayed.
.P
If the prompt, help or error message is not defined, the default message
(as defined under NOTES) will be displayed.
.TP
\f4\-Q\f1
Specifies that quit will not be allowed as a valid response.
.TP
\f4\-W\f1
Specifies that prompt, help and error messages will be formatted to a
line length of \f2width\f1.
.TP
\f4\-d\f1
Defines the default value as \f2default\f1.
The default is not validated and so does not have to meet any criteria.
.TP
\f4\-h\f1
Defines the help messages as \f2help\fP.
.TP
\f4\-e\f1
Defines the error message as \f2error\f1.
.TP
\f4\-p\f1
Defines the prompt message as \f2prompt\f1.
.TP
\f4\-k\f1
Specifies that process ID \f2pid\f1 is to be sent a signal if the user chooses
to abort.
.TP
\f4\-s\f1
Specifies that the process ID \f2pid\f1 defined with
the \f4\-k\f1 option is to be
sent signal \f4signal\fP when quit is chosen.
If no signal is specified, SIGTERM is used.
.TP
.I "keyword"
Defines the keyword, or list of keywords, against
which the answer will be verified.
.SH EXIT CODES
.nf
\f40\f1 = Successful execution
\f41\f1 = EOF on input
\f42\f1 = Usage error
\f43\f1 = User termination (quit)
\f44\f1 = No keywords from which to choose
.fi
.SH NOTES
The default prompt for \f4ckkeywd\f1 is:
.sp
.in +.25i
\f4Enter selection [\f2keyword\f4,[...],?,q]:\f1
.in -.25i
.sp
The default error message is:
.sp
.in +.25i
\f4ERROR - Does not match any of the valid selections.
.br
Please enter one of the following keywords:
.br
\f2keyword\f4[,...]\f1
.in -.25i
.sp
The default help message is:
.sp
.in +.25i
\f4Please enter one of the following keywords:
.br
\f2keyword\f4[,...]\f1
.in -.25i
.sp
When the quit option is chosen (and allowed), \f4q\f1 is
returned along with the return code \f43\f1.
.\"	@(#)ckkeywd.1	5.2 of 6/16/87
