_O_n_l_i_n_e _M_a_n_u_a_l             User Commands                ckkeywd(1)



NNNNAAAAMMMMEEEE
     ckkeywd - prompts for and validates a keyword

SSSSYYYYNNNNTTTTAAAAXXXX
     cccckkkkkkkkeeeeyyyywwwwdddd [----QQQQ] [----WWWW _w_i_d_t_h] [----dddd _d_e_f_a_u_l_t] [----hhhh _h_e_l_p] [----eeee _e_r_r_o_r]
     [----pppp _p_r_o_m_p_t]
     [----kkkk _p_i_d [----ssss _s_i_g_n_a_l]] [_k_e_y_w_o_r_d [...]]

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     _c_k_k_e_y_w_d 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 defin-
     ition (including newline) is stripped.  The ----WWWW option can-
     cels 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.

     ----QQQQ   Specifies that quit will not be allowed as a valid
          response.

     ----WWWW   Specifies that prompt, help and error messages will be
          formatted to a line length of _w_i_d_t_h.

     ----dddd   Defines the default value as _d_e_f_a_u_l_t.  The default is
          not validated and so does not have to meet any cri-
          teria.

     ----hhhh   Defines the help messages as _h_e_l_p.

     ----eeee   Defines the error message as _e_r_r_o_r.

     ----pppp   Defines the prompt message as _p_r_o_m_p_t.

     ----kkkk   Specifies that process ID _p_i_d is to be sent a signal if
          the user chooses to abort.

     ----ssss   Specifies that the process ID _p_i_d defined with the ----kkkk
          option is to be sent signal _s_i_g_n_a_l when quit is chosen.
          If no signal is specified, SIGTERM is used.

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

EEEEXXXXIIIITTTT CCCCOOOODDDDEEEESSSS
     0000 = Successful execution
     1111 = EOF on input
     2222 = Usage error






     3333 = User termination (quit)
     4444 = No keywords from which to choose

NNNNOOOOTTTTEEEESSSS
     The default prompt for _c_k_k_e_y_w_d is:
       EEEEnnnntttteeeerrrr sssseeeelllleeeeccccttttiiiioooonnnn [[[[_k_e_y_w_o_r_d,,,,[[[[............]]]],,,,????,,,,qqqq]]]]::::
    The default error message is:
      EEEERRRRRRRROOOORRRR ---- DDDDooooeeeessss nnnnooootttt mmmmaaaattttcccchhhh aaaannnnyyyy ooooffff tttthhhheeee vvvvaaaalllliiiidddd sssseeeelllleeeeccccttttiiiioooonnnnssss....
      PPPPlllleeeeaaaasssseeee eeeennnntttteeeerrrr oooonnnneeee ooooffff tttthhhheeee ffffoooolllllllloooowwwwiiiinnnngggg kkkkeeeeyyyywwwwoooorrrrddddssss::::
      _k_e_y_w_o_r_d[[[[,,,,............]]]]
   The default help message is:
     PPPPlllleeeeaaaasssseeee eeeennnntttteeeerrrr oooonnnneeee ooooffff tttthhhheeee ffffoooolllllllloooowwwwiiiinnnngggg kkkkeeeeyyyywwwwoooorrrrddddssss::::
     _k_e_y_w_o_r_d[[[[,,,,............]]]]
  When the quit option is chosen (and allowed), qqqq is returned
  along with the return code 3333.

August 1991                                   TX User's Reference