2 .\" Copyright 1989 AT&T Copyright (c) 1992, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH CKUID 1 "Sep 14, 1992"
8 ckuid, erruid, helpuid, valuid \- prompts for and validates a user ID
12 \fBckuid\fR [\fB-Q\fR] [\fB-W\fR \fIwidth\fR] [\fB-m\fR] [\fB-d\fR \fIdefault\fR] [\fB-h\fR \fIhelp\fR]
13 [\fB-e\fR \fIerror\fR] [\fB-p\fR \fIprompt\fR] [\fB-k\fR \fIpid\fR [\fB-s\fR \fIsignal\fR]]
18 \fB/usr/sadm/bin/erruid\fR [\fB-W\fR \fIwidth\fR] [\fB-e\fR \fIerror\fR]
23 \fB/usr/sadm/bin/helpuid\fR [\fB-W\fR \fIwidth\fR] [\fB-m\fR] [\fB-h\fR \fIhelp\fR]
28 \fB/usr/sadm/bin/valuid\fR \fIinput\fR
34 The \fBckuid\fR utility prompts a user and validates the response. It defines,
35 among other things, a prompt message whose response should be an existing user
36 \fBID,\fR text for help and error messages, and a default value (which are
37 returned if the user responds with a RETURN).
40 All messages are limited in length to 70 characters and are formatted
41 automatically. Any white space used in the definition (including NEWLINE) is
42 stripped. The \fB-W\fR option cancels the automatic formatting. When a tilde is
43 placed at the beginning or end of a message definition, the default text is
44 inserted at that point, allowing both custom text and the default text to be
48 If the prompt, help or error message is not defined, the default message (as
49 defined under \fBNOTES\fR) is displayed.
52 Three visual tool modules are linked to the \fBckuid\fR command. They are
53 \fBerruid\fR (which formats and displays an error message), \fBhelpuid\fR
54 (which formats and displays a help message), and \fBvaluid\fR (which validates
55 a response). These modules should be used in conjunction with \fBFML\fR
56 objects. In this instance, the \fBFML\fR object defines the prompt.
60 The following options are supported:
64 \fB\fB-d\fR\fI default\fR\fR
67 Defines the default value as \fIdefault\fR. The default is not validated and so
68 does not have to meet any criteria.
74 \fB\fB-e\fR \fIerror\fR\fR
77 Defines the error message as \fIerror\fR.
83 \fB\fB-h\fR \fIhelp\fR\fR
86 Defines the help messages as \fIhelp\fR.
92 \fB\fB-k\fR\fI pid\fR\fR
95 Specifies that process \fBID\fR \fIpid\fR is to be sent a signal if the user
105 Displays a list of all logins when help is requested or when the user makes an
112 \fB\fB-p\fR\fI prompt\fR\fR
115 Defines the prompt message as \fIprompt\fR.
124 Specifies that quit will not be allowed as a valid response.
130 \fB\fB-s\fR \fIsignal\fR\fR
133 Specifies that the process \fBID\fR \fIpid\fR defined with the \fB-k\fR option
134 is to be sent signal \fIsignal\fR when quit is chosen. If no signal is
135 specified, \fBSIGTERM\fR is used.
141 \fB\fB-W\fR\fI width\fR\fR
144 Specifies that prompt, help and error messages will be formatted to a line
145 length of \fIwidth\fR.
151 The following operand is supported:
158 Input to be verified against \fB/etc/passwd\fR.
164 The following exit values are returned:
171 Successful execution.
180 \fBEOF\fR on input, or negative width on \fB-W\fR option, or usage error.
198 User termination (quit).
208 The default prompt for \fBckuid\fR is:
212 Enter the login name of an existing user [?,q]:
219 The default error message is:
223 ERROR - Please enter the login name of an existing user.
230 If the \fB-m\fR option is used, the default error message is:
234 ERROR: Please enter one of the following login names: <List>
241 The default help message is:
245 Please enter the login name of an existing user.
252 If the \fB-m\fR option is used, the default help message is:
256 Please enter one of the following login names: <List>
263 When the quit option is chosen (and allowed), \fBq\fR is returned along with
264 the return code \fB3\fR. The \fBvaluid\fR module will not produce any output.
265 It returns \fB0\fR for success and non-zero for failure.