Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ ckkeywd(1) — NEWS-os 5.0.1

Media Vault

Software Library

Restoration Projects

Artifacts Sought



ckkeywd(1)               USER COMMANDS                 ckkeywd(1)



NAME
     ckkeywd - prompts for and validates 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 will be returned if the
     user responds with a carriage return).  The answer  returned
     from this command must match one of the defined list of key-
     words.  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.

     -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.

     -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.

     keyword
          Defines the keyword, or list of keywords, against which
          the answer will be verified.




                                                                1





ckkeywd(1)               USER COMMANDS                 ckkeywd(1)



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

NOTES
     The default prompt for ckkeywd is:

       Enter selection [keyword,[...],?,q]:

    The default error message is:

      ERROR - Does not match any of the valid selections.
      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.






























                                                                2



Typewritten Software • bear@typewritten.org • Edmonds, WA 98026