1ckuid(1)                         User Commands                        ckuid(1)
2
3
4

NAME

6       ckuid, erruid, helpuid, valuid - prompts for and validates a user ID
7

SYNOPSIS

9       ckuid [-Q] [-W width] [-m] [-d default] [-h help]
10            [-e error] [-p prompt] [-k pid [-s signal]]
11
12
13       /usr/sadm/bin/erruid [-W width] [-e error]
14
15
16       /usr/sadm/bin/helpuid [-W width] [-m] [-h help]
17
18
19       /usr/sadm/bin/valuid input
20
21

DESCRIPTION

23       The  ckuid  utility  prompts  a  user  and  validates  the response. It
24       defines, among other things, a prompt message whose response should  be
25       an  existing  user  ID, text for help and error messages, and a default
26       value (which are returned if the user responds with a RETURN).
27
28
29       All messages are limited in length to 70 characters and  are  formatted
30       automatically.  Any  white space used in the definition (including NEW‐
31       LINE) is stripped. The -W option cancels the automatic formatting. When
32       a  tilde is placed at the beginning or end of a message definition, the
33       default text is inserted at that point, allowing both custom  text  and
34       the default text to be displayed.
35
36
37       If  the  prompt, help or error message is not defined, the default mes‐
38       sage (as defined under NOTES) is displayed.
39
40
41       Three visual tool modules are linked to the  ckuid  command.  They  are
42       erruid  (which  formats  and displays an error message), helpuid (which
43       formats and displays a help message), and  valuid  (which  validates  a
44       response).  These  modules  should  be  used  in  conjunction with  FML
45       objects. In this instance, the  FML object defines the prompt.
46

OPTIONS

48       The following options are supported:
49
50       -d default    Defines the default value as default. The default is  not
51                     validated and so does not have to meet any criteria.
52
53
54       -e error      Defines the error message as error.
55
56
57       -h help       Defines the help messages as help.
58
59
60       -k pid        Specifies  that process  ID pid is to be sent a signal if
61                     the user chooses to abort.
62
63
64       -m            Displays a list of all logins when help is  requested  or
65                     when the user makes an error.
66
67
68       -p prompt     Defines the prompt message as prompt.
69
70
71       -Q            Specifies  that  quit  will  not  be  allowed  as a valid
72                     response.
73
74
75       -s signal     Specifies that the process  ID pid defined  with  the  -k
76                     option  is  to be sent signal signal when quit is chosen.
77                     If no signal is specified, SIGTERM is used.
78
79
80       -W width      Specifies that prompt, help and error  messages  will  be
81                     formatted to a line length of width.
82
83

OPERANDS

85       The following operand is supported:
86
87       input    Input to be verified against /etc/passwd.
88
89

EXIT STATUS

91       The following exit values are returned:
92
93       0    Successful execution.
94
95
96       1    EOF on input, or negative width on  -W option,  or usage error.
97
98
99       2    Usage error.
100
101
102       3    User termination (quit).
103
104

ATTRIBUTES

106       See attributes(5) for descriptions of the following attributes:
107
108
109
110
111       ┌─────────────────────────────┬─────────────────────────────┐
112       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
113       ├─────────────────────────────┼─────────────────────────────┤
114       │Availability                 │SUNWcsu                      │
115       └─────────────────────────────┴─────────────────────────────┘
116

SEE ALSO

118       attributes(5)
119

NOTES

121       The default prompt for ckuid is:
122
123         Enter the login name of an existing user [?,q]:
124
125
126
127
128       The default error message is:
129
130         ERROR - Please enter the login name of an existing user.
131
132
133
134
135       If the -m option is used, the default error message is:
136
137         ERROR:  Please enter one of the following login names:  <List>
138
139
140
141
142       The default help message is:
143
144         Please enter the login name of an existing user.
145
146
147
148
149       If the -m option is used, the default help message is:
150
151         Please enter one of the following login names:  <List>
152
153
154
155
156       When  the quit option is chosen (and allowed), q is returned along with
157       the return code 3. The valuid module will not produce  any  output.  It
158       returns  0 for success and non-zero for failure.
159
160
161
162SunOS 5.11                        14 Sep 1992                         ckuid(1)
Impressum