Penguin
Recent Changes
Annotated edit history of addgroup(8) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 ADDUSER
2 !!!ADDUSER
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 FILES
8 SEE ALSO
9 COPYRIGHT
10 ----
11 !!NAME
12
13
14 adduser, addgroup - add a user or group to the system
15 !!SYNOPSIS
16
17
18 __adduser__ [[options] [[--home DIR] [[--shell SHELL]
19 [[--no-create-home] [[--uid ID] [[--firstuid ID] [[--lastuid ID]
20 [[--ingroup GROUP | --gid ID] [[--disabled-password]
21 [[--disabled-login] [[--gecos GECOS] user
22
23
24 __adduser__ --system [[options] [[--home DIR] [[--shell
25 SHELL] [[--no-create-home] [[--uid ID] [[--group | --ingroup
26 GROUP | --gid ID] [[--disabled-password] [[--disabled-login]
27 [[--gecos GECOS] user
28
29
30 __adduser__ --group [[options] [[--gid ID] group__
31 addgroup__ [[options] [[--gid ID] group
32
33
34 __adduser__ [[options] user group
35
36
37 __COMMON OPTIONS__
38
39
40 [[--quiet] [[--force-badname] [[--help] [[--version] [[--conf
41 FILE]
42 !!DESCRIPTION
43
44
45 __adduser__ and __addgroup__ add users and groups to
46 the system according to command line options and
47 configuration information in ''/etc/adduser.conf''. They
48 are friendlier front ends to the __useradd__ and
49 __groupadd__ programs, choosing Debian policy conformant
50 UID and GID values, creating a home directory with skeletal
51 configuration, running a custom script, and other features.
52 __adduser__ and __addgroup__ can be run in one of four
53 modes:
54
55
56 __Add a normal user__
57
58
59 If called with one non-option argument and without the
60 __--system__ or __--group__ options, __adduser__
61 will add a normal user.
62
63
64 __adduser__ will choose the first available UID from the
65 range specified for normal users in the configuration file.
66 The UID can be overridden with the __--uid__
67 option.
68
69
70 The range specified in the configuration file may be
71 overridden with the __--firstuid__ and __--lastuid__
72 options.
73
74
75 By default, each user in Debian GNU/Linux is given a
76 corresponding group with the same name and id. Usergroups
77 allow group writable directories to be easily maintained by
78 placing the appropriate users in the new group, setting the
79 set-group-ID bit in the directory, and ensuring that all
80 users use a umask of 002. If this option is turned off by
81 setting __USERGROUPS__ to ''no'', all users' GIDs are
82 set to __USERS_GID__. Users' groups can also be
83 overridden from the command line with the __--gid__ or
84 __--ingroup__ options to set the group by id or name,
85 respectively.
86
87
88 __adduser__ will create a home directory subject to
89 __DHOME__, __GROUPHOMES__, and __LETTERHOMES__. The
90 home directory can be overridden from the command line with
91 the __--home__ option, and the shell with the
92 __--shell__ option. The home directory's set-group-ID bit
93 is set if __USERGROUPS__ is ''yes'' so that any files
94 created in the user's home directory will have the correct
95 group.
96
97
98 __adduser__ will copy files from __SKEL__ into the
99 home directory and prompt for finger (gecos) information and
100 a password. The gecos may also be set with the
101 __--gecos__ option. With the __--disabled-login__
102 option, the account will be created but will be disabled
103 until a password is set. The __--disabled-password__
104 option will not set a password, but login are still possible
105 for example through SSH RSA keys.
106
107
108 If the file __/usr/local/sbin/adduser.local__ exists, it
109 will be executed after the user account has been set up in
110 order to do any local setup. The arguments passed to
111 __adduser.local__ are:
112 username uid gid home-directory
113
114
115 __Add a system user__
116
117
118 If called with one non-option argument and the
119 __--system__ option, __adduser__ will add a system
120 user. If an user with an uid in the system range (or if the
121 uid is specified, with that) does already exist, adduser
122 will exit silently.
123
124
125 __adduser__ will choose the first available UID from the
126 range specified for system users in the configuration file.
127 The UID can be overridden with the __--uid__
128 option.
129
130
131 By default, system users are placed in the __nogroup__
132 group. To place the new system user in an already existing
133 group, use the __--gid__ or __--ingroup__ options. To
134 place the new system user in a new group with the same ID,
135 use the __--group__ option.
136
137
138 A home directory is created by the same rules as for normal
139 users. The new system user will have the shell
140 ''/bin/false'' (unless overridden with the __--shell__
141 option), and have a disabled password. Skeletal
142 configuration files are not copied.
143
144
145 __Add a system group__
146
147
148 If __adduser__ is called with the __--group__ option,
149 or __addgroup__ is called, a system group will be
150 added.
151
152
153 A GID will be chosen from the range specified for system
154 UIDS in the configuration file. The GID can be overridden
155 with the __--gid__ option.
156
157
158 The group is created with no users.
159
160
161 __Add an existing user to an existing
162 group__
163
164
165 If called with two non-option arguments, __adduser__ will
166 add an existing user to an existing group.
167 !!OPTIONS
168
169
170 __--conf FILE__
171
172
173 Use FILE instead of ''/etc/adduser.conf''.
174
175
176 __--disabled-login__
177
178
179 Do not run passwd to set the password. The user won't be
180 able to use her account until the password is
181 set.
182
183
184 __--disabled-password__
185
186
187 Like --disabled-login, but logins are still possible for
188 example through SSH RSA keys, but not using password
189 authentification.
190
191
192 __--force-badname__
193
194
195 By default, user and group names are required to consist of
196 a lowercase letter followed by zero or more lowercase
197 letters or numbers. Dashes in the username are accepted as
198 well. This option forces __adduser__ and __addgroup__
199 to be more lenient.
200
201
202 __--gecos GECOS__
203
204
205 Set the gecos field for the new entry generated. adduser
206 will not ask for finger information if this option is
207 given.
208
209
210 __--gid ID__
211
212
213 When creating a group, this option forces the new groupid to
214 be the given number. When creating a user, this option will
215 put the user in that group.
216
217
218 __--group__
219
220
221 When combined with __--system__, a group with the same
222 name and ID as the system user is created. If not combined
223 with __--system__, a group with the given name is
224 created. This is the default action if the program is
225 invoked as __addgroup__.
226
227
228 __--help__
229
230
231 Display brief instructions.
232
233
234 __--home DIR__
235
236
237 Use DIR as the user's home directory, rather than the
238 default specified by the configuration file. If the
239 directory does not exist, it is created and skeleton files
240 are copied.
241
242
243 __--shell SHELL__
244
245
246 Use SHELL as the user's login shell, rather than the default
247 specified by the configuration file.
248
249
250 __--ingroup GROUP__
251
252
253 Add the new user to GROUP instead of a usergroup or the
254 default group defined by USERS_GID in the adduser.conf
255 file.
256
257
258 __--no-create-home__
259
260
261 Do not create the home directory, even if it doesn't
262 exist.
263
264
265 __--quiet__
266
267
268 Suppress progress messages.
269
270
271 __--system__
272
273
274 Create a system user.
275
276
277 __--uid ID__
278
279
280 Force the new userid to be the given number. adduser will
281 fail if the userid is already taken.
282
283
284 __--firstuid ID__
285
286
287 Override the first uid in the range that the uid is chosen
288 from.
289
290
291 __--lastuid ID__
292
293
294 Override the last uid in the range that the uid is chosen
295 from.
296
297
298 __--version__
299
300
301 Display version and copyright information.
302 !!FILES
303
304
305 /etc/adduser.conf
306 !!SEE ALSO
307
308
309 adduser.conf(5), deluser(8), useradd(8),
310 groupadd(8)
311 !!COPYRIGHT
312
313
314 Copyright (C) 1997, 1998, 1999 Guy Maor.
315 Copyright (C) 1995 Ted Hajek, with a great deal borrowed
316 from the original Debian __adduser__
317 Copyright (C) 1994 Ian Murdock. __adduser__ is free
318 software; see the GNU General Public Licence version 2 or
319 later for copying conditions. There is ''no''
320 warranty.
321 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.