ckkeywd(1)

ckkeywd -- prompt for and validate a keyword

Synopsis

ckkeywd [-Q] [-W width] [-d default] [-h help] [-e error] [-p prompt] [-k pid [-s signal]] [keyword ...]

Description

ckkeywd prompts a user and validates the response. It defines, among other things, a prompt message whose response should be one of a list of keywords, text for help and error messages, and a default value (which is returned if the user responds with a <Return>). The answer returned from this command must match one of the defined list of keywords.

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.

-Q: Do not allow quit as a valid response.
-W: Use width as the line length for prompt, help, and error messages.
-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: Send process ID pid a signal if the user chooses to abort.
-s: When quit is chosen, send signal to the process whose pid is specified by the -k option. If no signal is specified, use SIGTERM.
keyword: The keyword, or list of keywords, against which the answer is to be verified is keyword.

Exit codes

0: Successful execution
1: EOF on input
1: Usage error
3: User termination (quit)
4: No keywords from which to choose

Notices

The default prompt for ckkeywd is:

Enter appropriate value [keyword[, . . . ],?,q]

The default error message is:

ERROR - Please enter one of the following keywords:
keyword[, . . . ]

The default help message is:

Please enter one of the following keywords:
keyword[, . . . ]

When the quit option is chosen (and allowed), q is returned along with the return code 3.