cktime(1)

cktime, errtime, helptime, valtime -- 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 width] [-e error] [-f format]

helptime [-W width] [-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 is returned if the user responds with a <Return>). The user response must match the defined format for the time of day.

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 -W option cancels the automatic formatting. When a tilde is placed at the beginning or end of a message definition, the default text is 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 ``Notices'') is 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 FMLI objects. In this instance, the FMLI object defines the prompt. When format is defined in the errtime and helptime modules, the messages describe the expected format.

The options and arguments for this command are:

-Q

Do not allow quit as a valid response.

-W

Use width as the line length for prompt, help, and error messages.

-f

Verify the input against format. 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)
%T: time as %H:%M:%S

-d

The default value is default. The default is not validated and so does not have to meet any criteria.

-h

The help message is help.

-e

The error message is error.

-p

The prompt message is prompt.

-k pid

Send process ID pid a signal if the user chooses to abort.

-s signal

When quit is chosen, send signal to the process whose pid is specified by the -k option. If no signal is specified, use SIGTERM.

input

Input to be verified against format criteria.

Exit codes

0: Successful execution
1: EOF on input
1: Usage error
3: User termination (quit)
4: Garbled format argument

Notices

The default prompt for cktime is:

Enter a time of day [?,q]

The default error message is:

ERROR - Please enter the time of day. Format is format.

The default help message is:

Please enter the time of day. Format is format.

When the quit option is chosen (and allowed), q is returned along with the return code 3. The valtime module does not produce any output. It returns zero for success and non-zero for failure.