'\"macro stdmacro
.if n .pH g1.cktime @(#)cktime	40.13 of 10/10/89
.\" Copyright 1989 AT&T
.nr X
.if \nX=0 .ds x} cktime 1 "Essential Utilities" "\&"
.if \nX=1 .ds x} cktime 1 "Essential Utilities"
.if \nX=2 .ds x} cktime 1 "Essential Utilities" "\&"
.if \nX=3 .ds x} cktime "Essential Utilities" "" "\&"
.TH \*(x}
.SH NAME
\f4cktime\f1 \- display a prompt; verify and return a time of day
.SH SYNOPSIS
\f4cktime\f1 [\f4\-Q\f1] [\f4\-W\f2 width\f1] [\f4\-f\f2 format\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]]
.sp
\f4errtime\f1 [\f4\-W\f1] [\f4\-e \f2error\f1] [\f4\-f \f2format\f1]
.br
\f4helptime\f1 [\f4\-W\f1] [\f4\-h \f2help\fP] [\f4\-f \f2format\f1]
.br
\f4valtime\f1 [\f4\-f \f2format] \f2input\f1
.SH DESCRIPTION
\f4cktime\f1 prompts a user and validates the response.
It defines, among other things,
a prompt message whose response should be a time, text for help and
error messages, and a default value
(which will be returned if the user responds with a carriage return).
The user response must match the defined format for
the time of day.
.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.
.P
Three visual tool modules are linked to the \f4cktime\f1 command.
They are
\%\f4errtime\f1 (which formats and displays an error message),
\f4helptime\f1 (which
formats and displays a help message), and \f4valtime\f1 (which validates a
response).
These modules should be used in conjunction with FML objects.
In this
instance, the FML object defines the prompt.
When \f2format\f1 is defined in
the \f4errtime\f1 and \f4helptime\f1 modules, the
messages will describe the
expected format.
.P
The options and arguments for this command are:
.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\-f\f1
Specifies the format against which the input will be verified.
Possible formats and their definitions are:
.sp .5
.nf
\f4%H\f1  =  hour (00 - 23)
.br
\f4%I\f1  =  hour (00 - 12)
.br
\f4%M\f1  =  minute (00 - 59)
.br
\f4%p\f1  =  ante meridian or post meridian
.br
\f4%r\f1  =  time as \f4%I:%M:%S %p\f1
.br
\f4%R\f1  =  time as \f4%H:%M\f1 (the default format)
.br
\f4%S\f1  =  seconds (00 - 59)
.br
\f4%T\f1  =  time as \f4%H:%M:%S\f1
.fi
.sp .5
.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, \f4SIGTERM\f1 is used.
.TP
.I input
Input to be verified against format criteria.
.PD
.SH EXIT CODES
.nf
\f40\f1 = Successful execution
\f41\f1 = EOF on input
\f42\f1 = Usage error
\f43\f1 = User termination (quit)
\f44\f1 = Garbled format argument
.fi
.SH NOTES
The default prompt for \f4cktime\f1 is:
.sp
.in +.25i
\f4Enter the time of day [?,q]:\f1
.in -.25i
.sp
The default error message is:
.sp
.in +.25i
\f4ERROR - Please enter the time of day, using the following format:
.br
\f2<format>\f1
.in -.25i
.sp
The default help message is:
.sp
.in +.25i
\f4Please enter the time of day, using the following format:
.br
\f2<format>\f1
.in -.25i
.P
When the quit option is chosen (and allowed), \f4q\f1 is
returned along with the return code \f43\f1.
The \f4valtime\f1 module will not produce any output.
It returns zero for success and non-zero for failure.
.\"	@(#)cktime.1	5.2 of 6/16/87
