| blob | 1dc85fabf23662a363164c6056cdc77c4f771101 |
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 2007 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 PASSMGMT 8 "Feb 25, 2017"
7 .SH NAME
8 passmgmt \- password files management
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBpassmgmt\fR \fB-a\fR \fIoptions\fR \fIname\fR
13 .fi
15 .LP
16 .nf
17 \fBpassmgmt\fR \fB-m\fR \fIoptions\fR \fIname\fR
18 .fi
20 .LP
21 .nf
22 \fBpassmgmt\fR \fB-d\fR \fIname\fR
23 .fi
25 .SH DESCRIPTION
26 .LP
27 The \fBpassmgmt\fR command updates information in the password files. This
28 command works with both \fB/etc/passwd\fR and \fB/etc/shadow\fR.
29 .sp
30 .LP
31 \fBpassmgmt\fR \fB-a\fR adds an entry for user \fIname\fR to the password
32 files. This command does not create any directory for the new user and the new
33 login remains locked (with the string \fB*LK*\fR in the password field) until
34 the \fBpasswd\fR(1) command is executed to set the password.
35 .sp
36 .LP
37 \fBpassmgmt\fR \fB-m\fR modifies the entry for user \fIname\fR in the password
38 files. The name field in the \fB/etc/shadow\fR entry and all the fields (except
39 the password field) in the \fB/etc/passwd\fR entry can be modified by this
40 command. Only fields entered on the command line will be modified.
41 .sp
42 .LP
43 \fBpassmgmt\fR \fB-d\fR deletes the entry for user \fIname\fR from the password
44 files. It will not remove any files that the user owns on the system; they must
45 be removed manually.
46 .sp
47 .LP
48 \fBpassmgmt\fR can be used only by the super-user.
49 .SH OPTIONS
50 .ne 2
51 .na
52 \fB\fB\fR\fB-c\fR \fIcomment\fR\fR
53 .ad
54 .RS 16n
55 A short description of the login, enclosed in quotes. It is limited to a
56 maximum of 128 characters and defaults to an empty field.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB-e\fR \fIexpire\fR\fR
63 .ad
64 .RS 16n
65 Specify the expiration date for a login. After this date, no user will be able
66 to access this login. The expire option argument is a date entered using one of
67 the date formats included in the template file \fB/etc/datemsk\fR. See
68 \fBgetdate\fR(3C).
69 .RE
71 .sp
72 .ne 2
73 .na
74 \fB\fB-f\fR \fIinactive\fR\fR
75 .ad
76 .RS 16n
77 The maximum number of days allowed between uses of a login ID before that
78 \fBID\fR is declared invalid. Normal values are positive integers. A value of
79 \fB0\fR defeats the status.
80 .sp
81 Changing the password reactivates an account for the inactivity period.
82 .RE
84 .sp
85 .ne 2
86 .na
87 \fB\fB\fR\fB-g\fR \fIgid\fR\fR
88 .ad
89 .RS 16n
90 \fBGID\fR of \fIname\fR. This number must range from 0 to the maximum
91 non-negative value for the system. The default is 1.
92 .RE
94 .sp
95 .ne 2
96 .na
97 \fB\fB\fR\fB-h\fR \fIhomedir\fR\fR
98 .ad
99 .RS 16n
100 Home directory of \fIname\fR. It is limited to a maximum of 256 characters and
101 defaults to \fB/usr/\fR\fIname\fR.
102 .RE
104 .sp
105 .ne 2
106 .na
107 \fB\fB-K\fR \fIkey=value\fR\fR
108 .ad
109 .RS 16n
110 Set a \fIkey=value\fR pair. See \fBuser_attr\fR(4), \fBauth_attr\fR(4), and
111 \fBprof_attr\fR(4). The valid \fIkey=value\fR pairs are defined in
112 \fBuser_attr\fR(4), but the "type" key is subject to the \fBusermod\fR(8) and
113 \fBrolemod\fR(8) restrictions. Multiple \fIkey=value\fR pairs may be added
114 with multiple \fB-K\fR options.
115 .RE
117 .sp
118 .ne 2
119 .na
120 \fB\fB-k\fR \fIskel_dir\fR\fR
121 .ad
122 .RS 16n
123 A directory that contains skeleton information (such as \fB\&.profile\fR) that
124 can be copied into a new user's home directory. This directory must already
125 exist. The system provides the \fB/etc/skel\fR directory that can be used for
126 this purpose.
127 .RE
129 .sp
130 .ne 2
131 .na
132 \fB\fB-l\fR \fIlogname\fR\fR
133 .ad
134 .RS 16n
135 This option changes the \fIname\fR to \fIlogname\fR. It is used only with the
136 \fB-m\fR option. The total size of each login entry is limited to a maximum of
137 511 bytes in each of the password files.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fB-o\fR\fR
144 .ad
145 .RS 16n
146 This option allows a \fBUID\fR to be non-unique. It is used only with the
147 \fB-u\fR option.
148 .RE
150 .sp
151 .ne 2
152 .na
153 \fB\fB\fR\fB-s\fR \fIshell\fR\fR
154 .ad
155 .RS 16n
156 Login shell for \fIname\fR. It should be the full pathname of the program that
157 will be executed when the user logs in. The maximum size of \fIshell\fR is 256
158 characters. The default is for this field to be empty and to be interpreted as
159 \fB/usr/bin/sh\fR.
160 .RE
162 .sp
163 .ne 2
164 .na
165 \fB\fB\fR\fB-u\fR \fIuid\fR\fR
166 .ad
167 .RS 16n
168 \fBUID\fR of the \fIname\fR. This number must range from 0 to the maximum
169 non-negative value for the system. It defaults to the next available \fBUID\fR
170 greater than 99. Without the \fB-o\fR option, it enforces the uniqueness of a
171 \fBUID.\fR
172 .RE
174 .SH FILES
175 .in +2
176 .nf
177 \fB/etc/passwd\fR
178 \fB/etc/shadow\fR
179 \fB/etc/opasswd\fR
180 \fB/etc/oshadow\fR
181 .fi
182 .in -2
183 .sp
185 .SH ATTRIBUTES
186 .LP
187 See \fBattributes\fR(5) for descriptions of the following attributes:
188 .sp
190 .sp
191 .TS
192 box;
193 c | c
194 l | l .
195 ATTRIBUTE TYPE ATTRIBUTE VALUE
196 _
197 Interface Stability Evolving
198 .TE
200 .SH SEE ALSO
201 .LP
202 \fBpasswd\fR(1), \fBrolemod\fR(8), \fBuseradd\fR(8), \fBuserdel\fR(8),
203 \fBusermod\fR(8), \fBauth_attr\fR(4), \fBpasswd\fR(4), \fBprof_attr\fR(4),
204 \fBshadow\fR(4), \fBuser_attr\fR(4), \fBattributes\fR(5)
205 .SH EXIT STATUS
206 .LP
207 The \fBpassmgmt\fR command exits with one of the following values:
208 .sp
209 .ne 2
210 .na
211 \fB\fB0\fR\fR
212 .ad
213 .RS 5n
214 Success.
215 .RE
217 .sp
218 .ne 2
219 .na
220 \fB\fB1\fR\fR
221 .ad
222 .RS 5n
223 Permission denied.
224 .RE
226 .sp
227 .ne 2
228 .na
229 \fB\fB2\fR\fR
230 .ad
231 .RS 5n
232 Invalid command syntax. Usage message of the \fBpassmgmt\fR command is
233 displayed.
234 .RE
236 .sp
237 .ne 2
238 .na
239 \fB\fB3\fR\fR
240 .ad
241 .RS 5n
242 Invalid argument provided to option.
243 .RE
245 .sp
246 .ne 2
247 .na
248 \fB\fB4\fR\fR
249 .ad
250 .RS 5n
251 UID in use.
252 .RE
254 .sp
255 .ne 2
256 .na
257 \fB\fB5\fR\fR
258 .ad
259 .RS 5n
260 Inconsistent password files (for example, \fIname\fR is in the
261 \fB/etc/passwd\fR file and not in the \fB/etc/shadow\fR file, or vice versa).
262 .RE
264 .sp
265 .ne 2
266 .na
267 \fB\fB6\fR\fR
268 .ad
269 .RS 5n
270 Unexpected failure. Password files unchanged.
271 .RE
273 .sp
274 .ne 2
275 .na
276 \fB\fB7\fR\fR
277 .ad
278 .RS 5n
279 Unexpected failure. Password file(s) missing.
280 .RE
282 .sp
283 .ne 2
284 .na
285 \fB\fB8\fR\fR
286 .ad
287 .RS 5n
288 Password file(s) busy. Try again later.
289 .RE
291 .sp
292 .ne 2
293 .na
294 \fB\fB9\fR\fR
295 .ad
296 .RS 5n
297 \fIname\fR does not exist (if \fB-m\fR or \fB-d\fR is specified), already
298 exists (if \fB-a\fR is specified), or \fBlogname\fR already exists (if
299 \fB\fR\fB-m\fR \fB-l\fR is specified).
300 .RE
302 .SH NOTES
303 .LP
304 Do not use a colon (\fB:\fR) or \fBRETURN\fR as part of an argument. It is
305 interpreted as a field separator in the password file. The \fBpassmgmt\fR
306 command will be removed in a future release. Its functionality has been
307 replaced and enhanced by \fBuseradd\fR, \fBuserdel\fR, and \fBusermod\fR. These
308 commands are currently available.
309 .sp
310 .LP
311 This command only modifies password definitions in the local \fB/etc/passwd\fR
312 and \fB/etc/shadow\fR files. If a network nameservice
313 is being used to supplement the local files with additional entries,
314 \fBpassmgmt\fR cannot change information supplied by the network nameservice.