summaryrefslogtreecommitdiff
path: root/usr.sbin/adduser/adduser.8
blob: f94d88d0b3e886f591725d98ebb4fde372c7e16f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
.\"	$OpenBSD: adduser.8,v 1.2 1997/05/29 04:26:55 gene Exp $
.\"
.\" Copyright (c) 1995-1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $From: adduser.8,v 1.12 1996/08/28 17:54:13 adam Exp $

.Dd Jan, 9, 1995
.Dt ADDUSER 8
.Os OpenBSD
.Sh NAME
.Nm adduser
.Nd command for adding new users

.Sh SYNOPSIS
.Nm adduser
    [-batch username [group[,group]...] [fullname] [password]]
    [-check_only] [-config_create] [-dotdir dotdir] 
    [-e|-encrypt method] [-group login_group] [-h|-help] 
    [-home home] [-message message_file] [-noconfig] 
    [-shell shell] [-s|-silent|-q|-quiet] [-uid uid_start] 
    [-v|-verbose]

.Sh DESCRIPTION
.Nm Adduser 
is a simple program for adding new users. Adduser first performs consistency
checks on the passwd, group, and shell databases. It creates passwd/group
entries, a HOME-directory, and dotfiles for a new user, and sends
him or her a welcome message at the discretion of the person creating
the account.

.Sh RESTRICTIONS
.Bl -tag -width Ds -compact
.It Sy username
Login names should contain only lowercase characters or digits. They should be
no longer than 8 characters (see 
.Xr setlogin 2
BUGS section). 
.\" The reasons for this limit are "Historical". 
.\" Given that people have traditionally wanted to break this
.\" limit for aesthetic reasons, it's never been of great importance to break
.\" such a basic fundamental parameter in UNIX.
.\" You can change UT_NAMESIZE in /usr/include/utmp.h and recompile the
.\" world; people have done this and it works, but you will have problems
.\" with any precompiled programs, or source that assumes the 8-character
.\" name limit and NIS. The NIS protocol mandates an 8-character username.
If you need a longer login name for e-mail addresses,
you can define an alias in
.Pa /etc/aliases .
.It Sy fullname
This should contain the user's firstname and surname.  The 
.Ql Pa \:
is not permitted..
.It Sy shell
Only valid entries from the 
.Xr shells 5
database or entries corresponding to sliplogin and pppd are permitted.
.It Sy uid
This value is automatically generated or assigend at the invoker's 
discretion; however, it must be less than 32000.
.It Sy gid/login group
This value is generated automatically, but it can be specified at the
discretion of the person invoking the program. 
.It Sy password
If not empty, the password is encrypted according to 
.Xr passwd.conf 5
If empty, the account will be automatically disabled to prevent spurious
access to it.
.
.El
.\" .Sh UNIQUE GROUP
.\" Perhaps you're missing what *can* be done with this scheme that falls apart
.\" with most other schemes.  With each user in his/her own group the user can
.\" safely run with a umask of 002 and have files created in their home directory
.\" and not worry about others being able to read them.
.\" 
.\" For a shared area you create a separate uid/gid (like cvs or ncvs on freefall),
.\" you place each person that should be able to access this area into that new
.\" group.
.\" 
.\" This model of uid/gid administration allows far greater flexibility than lumping
.\" users into groups and having to muck with the umask when working in a shared
.\" area.
.\" 
.\" I have been using this model for almost 10 years and found that it works
.\" for most situations, and has never gotten in the way.  (Rod Grimes)
.Sh CONFIGURATION
Adduser follows these steps to extract its configuration
information:
.Bl -tag -width Ds -compact
.It Sy 1.
Read internal variables.
.It Sy 2.
Read configuration file (/etc/adduser.conf)
.It Sy 3.
Parse command-line options
.El

The adduser.conf format is explained within that file and is quite
straightforward.

.Sh OPTIONS
.Bl -tag -width Ds
.It Sy -batch username [group[,group]...] [fullname] [password]
Enter batch mode in which multiple users are specified on the command line
in a compact format.

.It Sy -check_only
Check the passwd, group, shells databases for consistency and problems
then exit without performing any other operation.

.It Sy -create_config
Create or edit default configuration information and message file before 
proceeding with the normal interactive adduser procedure.

.It Sy -dotdir Ar directory
Copy files from 
.Ar directory 
into the HOME-directory of new users.  Files named in the fashion of
.Ql Pa dot.foo
will be renamed to 
.Ql Pa .foo .
By default, all files are made writable and readable by 
their owner.
.\" don't allow group or world to write files and allow only owner
.\" to read/execute/write .rhost, .Xauthority, .kermrc, .netrc, Mail,
.\" prv, iscreen, term.

.It Sy -encrypt,-e Ar method
Encrypt local passwords using
.Ar method
of encryption as described in 
.Xr passwd.conf 5 .

.It Sy -group Ar login_group
Specify the default login group.  A value of 
.Ar USER
means that the username is to be used as the login group.

.It Sy -help,-h,-?
Print a summary of options and exit.

.It Sy -home Ar partition
Specify the default home partition where all users home directories
are to be located.

.It Sy -message Ar file
Send new users a welcome message from
.Ar file .
Specifying a value of
.Ar no
for
.Ar file
causes no message to be sent to new users.

.It Sy -noconfig
Do not read the default configuration file.

.It Sy -shell Ar shell 
Specify the default shell for new users.

.It Sy -silent,-s,-quiet,-q
Causes the program to print fewer warnings, questions, and bug reports. 

.It Sy -uid Ar uid
Use uid's from 
.Ar uid
up when automatically generating uid's.

.It Sy -verbose,-v
Causes the program to print many warnings and question.
This option is recommended for novice users.

.\" .Sh FORMAT
.\" .Bl -tag -width Ds -compact
.\" .Ql Pa #
.\" is a comment.  

.\" .P
.\" .It Sy config file
.\" .Nm Adduser
.\" reads and writes this file. 
.\" See /etc/adduser.conf for more details.
.\" .It Sy message file
.\" Eval variables in this file. See /etc/adduser.message for more
.\" details.
.\" .El

.Sh EXAMPLES
.Pp
$ adduser
.Pp
Start adduser in interactive mode.

.Pp
$ adduser -batch falken guest,staff,beer 'Prof. Falken' joshua
.Pp
Create user 'falken' and  login group 'falken'. Invite user 
falken into groups guest, staff and beer. Realname (fullname) 
is 'Prof. Falken'. Password is 'joshua' (don't use such a password!). Create
the HOME directory '/home/falken' and copy all files and directories 
from /usr/share/skel to /home/falken. Send user falken 
a welcome message.

.Pp
$ adduser -uid 5000 -group guest -message no -batch vehlefanz
.Pp
Create user 'vehlefanz' in login group guest. Uid is up to
5000, for instance 5007. No other groups, no realname, no password.
Do not send a welcome message.

.Sh FILES
.Bl -tag -width /etc/master.passwdxx -compact
.It Pa /etc/master.passwd
user database
.It Pa /etc/group
group database
.It Pa /etc/shells
shell database
.It Pa /etc/adduser.conf
config file for adduser
.It Pa /etc/adduser.message
message file for adduser
.It Pa /usr/share/skel
skeletal login directory
.It Pa /var/log/adduser
logfile for adduser
.El

.Sh SEE ALSO
.Xr chpass 1 ,
.Xr finger 1 ,
.Xr passwd 1 ,
.Xr setlogin 2 ,
.Xr aliases 5 ,
.Xr passwd 5 ,
.Xr passwd.conf 5 ,
.Xr group 5 ,
.Xr shells 5 ,
.Xr adduser_proc 8 ,
.Xr pwd_mkdb 8 ,
.Xr vipw 8 ,
.Xr yp 8

.\" .Sh BUGS

.Sh HISTORY
This
.Nm
program appeared in FreeBSD 2.1.