ckrange(1) — USER COMMANDS

NAME

ckrange − prompts for and validates an integer

SYNOPSIS

ckrange [−Q] [−W width] [−l lower] [−u upper] [−b base] [−d default] [−h help]
[−e error] [−p prompt] [−k pid [−s signal]] errange [−W] [−l lower] [−u upper] [−e error]
helprange [−W] [−l lower] [−u upper] [−h help]
valrange [−l lower] [−u upper] [−b base] input

DESCRIPTION

ckrange prompts a user and validates the response. It defines, among other things, a prompt message whose response should be an integer in the range specified, text for help and error messages, and a default value (which will be returned if the user responds with a carriage return).

This command also defines a range for valid input. If either the lower or upper limit is left undefined, then the range is bounded on only one end.

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 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 ckrange command. They are errange (which formats and displays an error message), helprange (which formats and displays a help message), and valrange (which validates a response). These modules should be used in conjunction with FACE objects. In this instance, the FACE object defines the prompt.

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.

−l Defines the lower limit of the range as lower. Default is the machine’s largest negative integer or long.

−u Defines the upper limit of the range as upper. Default is the machine’s largest positive integer or long.

−b Defines the base for input. Must be 2 to 36, default is 10.

−d Defines the default value as default. The default is not validated and so does not have to meet any criteria.

−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 upper and lower limits and base.

EXIT CODES

0 = Successful execution
1 = EOF on input
2 = Usage error
3 = User termination (quit)

NOTES

The default base 10 prompt for ckrange is:

Enter an integer between lower_bound and upper_bound [q,?]:

The default base 10 error message is:

ERROR - Please enter an integer between lower_bound and upper_bound.

The default base 10 help message is:

Please enter an integer between lower_bound and upper_bound.

The messages are changed from "integer" to "base base integer" if the base is set to a number other than 10.

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