usr/src/man/man1/ckuid.1

   1 '\" te
   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"
   7 .SH NAME
   8 ckuid, erruid, helpuid, valuid \- prompts for and validates a user ID
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  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]]
  14 .fi
  15
  16 .LP
  17 .nf
  18 \fB/usr/sadm/bin/erruid\fR [\fB-W\fR \fIwidth\fR] [\fB-e\fR \fIerror\fR]
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fB/usr/sadm/bin/helpuid\fR [\fB-W\fR \fIwidth\fR] [\fB-m\fR] [\fB-h\fR \fIhelp\fR]
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fB/usr/sadm/bin/valuid\fR \fIinput\fR
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  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).
  38 .sp
  39 .LP
  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
  45 displayed.
  46 .sp
  47 .LP
  48 If the prompt, help or error message is not defined, the default message (as
  49 defined under \fBNOTES\fR) is displayed.
  50 .sp
  51 .LP
  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.
  57 .SH OPTIONS
  58 .sp
  59 .LP
  60 The following options are supported:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-d\fR\fI default\fR\fR
  65 .ad
  66 .RS 14n
  67 Defines the default value as \fIdefault\fR. The default is not validated and so
  68 does not have to meet any criteria.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-e\fR \fIerror\fR\fR
  75 .ad
  76 .RS 14n
  77 Defines the error message as \fIerror\fR.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-h\fR \fIhelp\fR\fR
  84 .ad
  85 .RS 14n
  86 Defines the help messages as \fIhelp\fR.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB-k\fR\fI pid\fR\fR
  93 .ad
  94 .RS 14n
  95 Specifies that process  \fBID\fR \fIpid\fR is to be sent a signal if the user
  96 chooses to abort.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB-m\fR\fR
 103 .ad
 104 .RS 14n
 105 Displays a list of all logins when help is requested or when the user makes an
 106 error.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB-p\fR\fI prompt\fR\fR
 113 .ad
 114 .RS 14n
 115 Defines the prompt message as \fIprompt\fR.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fB-Q\fR\fR
 122 .ad
 123 .RS 14n
 124 Specifies that quit will not be allowed as a valid response.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB-s\fR \fIsignal\fR\fR
 131 .ad
 132 .RS 14n
 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.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB-W\fR\fI width\fR\fR
 142 .ad
 143 .RS 14n
 144 Specifies that prompt, help and error messages will be formatted to a line
 145 length of \fIwidth\fR.
 146 .RE
 147
 148 .SH OPERANDS
 149 .sp
 150 .LP
 151 The following operand is supported:
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fIinput\fR\fR
 156 .ad
 157 .RS 9n
 158 Input to be verified against \fB/etc/passwd\fR.
 159 .RE
 160
 161 .SH EXIT STATUS
 162 .sp
 163 .LP
 164 The following exit values are returned:
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB0\fR\fR
 169 .ad
 170 .RS 5n
 171 Successful execution.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB1\fR\fR
 178 .ad
 179 .RS 5n
 180 \fBEOF\fR on input, or negative width on  \fB-W\fR option,  or usage error.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB2\fR\fR
 187 .ad
 188 .RS 5n
 189 Usage error.
 190 .RE
 191
 192 .sp
 193 .ne 2
 194 .na
 195 \fB\fB3\fR\fR
 196 .ad
 197 .RS 5n
 198 User termination (quit).
 199 .RE
 200
 201 .SH SEE ALSO
 202 .sp
 203 .LP
 204 \fBattributes\fR(5)
 205 .SH NOTES
 206 .sp
 207 .LP
 208 The default prompt for \fBckuid\fR is:
 209 .sp
 210 .in +2
 211 .nf
 212 Enter the login name of an existing user [?,q]:
 213 .fi
 214 .in -2
 215 .sp
 216
 217 .sp
 218 .LP
 219 The default error message is:
 220 .sp
 221 .in +2
 222 .nf
 223 ERROR - Please enter the login name of an existing user.
 224 .fi
 225 .in -2
 226 .sp
 227
 228 .sp
 229 .LP
 230 If the \fB-m\fR option is used, the default error message is:
 231 .sp
 232 .in +2
 233 .nf
 234 ERROR:  Please enter one of the following login names:  <List>
 235 .fi
 236 .in -2
 237 .sp
 238
 239 .sp
 240 .LP
 241 The default help message is:
 242 .sp
 243 .in +2
 244 .nf
 245 Please enter the login name of an existing user.
 246 .fi
 247 .in -2
 248 .sp
 249
 250 .sp
 251 .LP
 252 If the \fB-m\fR option is used, the default help message is:
 253 .sp
 254 .in +2
 255 .nf
 256 Please enter one of the following login names:  <List>
 257 .fi
 258 .in -2
 259 .sp
 260
 261 .sp
 262 .LP
 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.