cktime(1) USER COMMANDS cktime(1)
NAME
cktime - display a prompt; verify and return a time of day
SYNOPSIS
cktime [-Q] [-W width] [-f format] [-d default] [-h help]
[-e error] [-p prompt]
[-k pid [-s signal]]
errtime [-W] [-e error] [-f format]
helptime [-W] [-h help] [-f format]
valtime [-f format] input
DESCRIPTION
cktime 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. All messages are lim-
ited in length to 70 characters and are formatted automati-
cally. Any white space used in the definition (including
newline) is stripped. The -W 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. If the prompt, help or error message
is not defined, the default message (as defined under NOTES)
will be displayed. Three visual tool modules are linked to
the cktime command. They are errtime (which formats and
displays an error message), helptime (which formats and
displays a help message), and valtime (which validates a
response). These modules should be used in conjunction with
FML objects. In this instance, the FML object defines the
prompt. When format is defined in the errtime and helptime
modules, the messages will describe the expected format.
The options and arguments for this command are:
-Q Specifies that quit will not be allowed as a valid
response.
-W Specifies that prompt, help and error messages will be
formatted to a line length of width.
-f Specifies the format against which the input will be
verified. Possible formats and their definitions are:
%H = hour (00 - 23)
%I = hour (00 - 12)
%M = minute (00 - 59)
%p = ante meridian or post meridian
%r = time as %I:%M:%S %p
%R = time as %H:%M (the default format)
%S = seconds (00 - 59)
1
cktime(1) USER COMMANDS cktime(1)
%T = time as %H:%M:%S
-d Defines the default value as default. The default is
not validated and so does not have to meet any cri-
teria.
-h Defines the help messages as help.
-e Defines the error message as error.
-p Defines the prompt message as prompt.
-k Specifies that process ID pid is to be sent a signal if
the user chooses to abort.
-s Specifies that the process ID pid defined with the -k
option is to be sent signal signal when quit is chosen.
If no signal is specified, SIGTERM is used.
input
Input to be verified against format criteria.
EXIT CODES
0 = Successful execution
1 = EOF on input
2 = Usage error
3 = User termination (quit)
4 = Garbled format argument
NOTES
The default prompt for cktime is:
Enter the time of day [?,q]:
The default error message is:
ERROR - Please enter the time of day, using the following
format:
<format>
The default help message is:
Please enter the time of day, using the following format:
<format>
When the quit option is chosen (and allowed), q is returned
along with the return code 3. The valtime module will not pro-
duce any output. It returns zero for success and non-zero for
failure.
2