ckint(1) (Essential Utilities) ckint(1)
NAME
ckint - display a prompt; verify and return an integer value
SYNOPSIS
ckint [-Q] [-W width] [-b base] [-d default] [-h help] [-e error] [-p
prompt]
[-k pid [-s signal]]
errint [-W] [-b base] [-e error]
helpint [-W] [-b base] [-h help]
valint [-b base] input
DESCRIPTION
ckint prompts a user, then validates the response. It defines, among
other things, a prompt message whose response should be an integer,
text for help and error messages, and a default value (which will be
returned if the user responds with a carriage return).
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 ckint command. They are
errint (which formats and displays an error message), helpint (which
formats and displays a help message), and valint (which validates a
response). These modules should be used in conjunction with FML
objects. In this instance, the FML object defines the prompt. When
base is defined in the errint and helpint modules, the messages will
include the expected base of the input.
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.
-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.
8/91 Page 1
ckint(1) (Essential Utilities) ckint(1)
-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 base criterion.
EXIT CODES
0 = Successful execution
1 = EOF on input
2 = Usage error
3 = User termination (quit)
NOTES
The default base 10 prompt for ckint is:
Enter an integer [?,q]:
The default base 10 error message is:
ERROR - Please enter an integer.
The default base 10 help message is:
Please enter an integer.
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 valint module will not produce any output. It
returns zero for success and non-zero for failure.
Page 2 8/91