Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ ckuid(1) — NEWS-os 5.0.1

Media Vault

Software Library

Restoration Projects

Artifacts Sought



ckuid(1)                 USER COMMANDS                   ckuid(1)



NAME
     ckuid - prompts for and validates a user ID

SYNOPSIS
     ckuid [-Q] [-W width] [-m] [-d default] [-h help] [-e error]
     [-p prompt]
     [-k pid [-s signal]]

     erruid [-W] [-e error]
     helpuid [-W] [-m] [-h help]
     valuid input

DESCRIPTION
     ckuid  prompts  a  user  and  validates  the  response.   It
     defines, among other things, a prompt message whose response
     should be an existing user ID, text for help and error  mes-
     sages,  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  begin-
     ning  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 ckuid command.   They  are  erruid  (which
     formats  and displays an error message), helpuid (which for-
     mats and displays a help message), and valuid  (which  vali-
     dates a response).  These modules should be used in conjunc-
     tion with FML objects.  In this  instance,  the  FML  object
     defines the prompt.  The options and arguments for this com-
     mand 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.

     -m   Displays a list of all logins when help is requested or
          when the user makes an error.

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




                                                                1





ckuid(1)                 USER COMMANDS                   ckuid(1)



     -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 /etc/passwd.

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

NOTES
     The default prompt for ckuid is:

       Enter the login name of an existing user [?,q]:

    The default error message is:

      ERROR - Please enter the login name of an existing user.
      Select the help option (?) for a list of valid login names.
      (Last line appears only if the -m option of ckuid is used)

   The default help message is:

     Please enter the login name of an existing user.
     (If the -m option of ckuid is used, a list of  valid  groups
     is also displayed.)
  When the quit option is chosen (and  allowed),  q  is  returned
  along  with the return code 3.  The valuid module will not pro-
  duce any output.  It returns zero for success and non-zero  for
  failure.

















                                                                2



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