xref: /freebsd/usr.sbin/adduser/adduser.8 (revision a316b26e50bbed7cf655fbba726ab87d8ab7599d)
1.\"
2.\" (c) Copyright 1995 Wolfram Schneider. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"   This product includes software developed by Wolfram Schneider
15.\" 4. The name of the author may not be used to endorse or promote products
16.\"    derived from this software without specific prior written permission
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" /usr/sbin/adduser - add new user(s)
30.\"
31.\" Bugs: sure (my english!)
32.\"   Email: Wolfram Schneider <wosch@cs.tu-berlin.de>
33.\"
34.\" $Id: adduser.8,v 1.5 1995/01/09 11:26:30 jkh Exp $
35.\"
36
37.Dd Jan, 9, 1995
38.Dt ADDUSER 8
39.Os FreeBSD 2.1
40.Sh NAME
41.Nm adduser
42.Nd command for adding new users
43
44.Sh DESCRIPTION
45.Nm Adduser
46is a simple program for adding new users. Adduser checks
47the passwd, group and shell database files. It create a passwd/group entry,
48HOME directory, copies dotfiles and sends the new user a welcome message.
49
50.Sh RESTRICTIONS
51.Bl -tag -width Ds -compact
52.It Sy username
53Login name may be only lowercase characters or digits.
54.It Sy fullname
55First and last name.
56.Ql Pa \:
57not allowed.
58.It Sy shell
59Only valid shells from shell database.
60.It Sy uid
61Automatically generated.
62.It Sy gid
63Automatically generated. Gid and uid are equal (if possible). Groupname
64is the same as username.
65.El
66
67.Sh CONFIGURATION
68.Bl -tag -width Ds -compact
69.It Sy 1.
70Read intern variables.
71.It Sy 2.
72Read config file (/etc/adduser.conf)
73.It Sy 3.
74Parse command line options
75.El
76
77.Sh OPTIONS
78.Bl -tag -width Ds
79.It Fl help
80Print options and exit.
81.It Fl silent
82Few warnings, question, bug reports.
83.It Fl verbose
84Many warnings and questions.  Recommended for novice users.
85.It Fl debug
86Debuging.
87.It Fl noconfig
88Do not read config file.
89.It Fl home Ar partition
90Default home partition where all users located.
91.It Fl shell Ar shell
92Default shell for new users.
93.It Fl dotdir Ar directory
94Copy files from .Ar directory into the HOME directory of new users.
95.Ql Pa dot.foo
96files renamed to
97.Ql Pa .foo
98Don't copy files if
99.Ar directory
100equal with
101.Ar no
102.It Fl message Ar file
103Send new users a welcome message.
104Don't send message if
105.Ar file
106equal with
107.Ar no
108.It Fl create_conf
109Create new config and message file and exit.
110
111.Sh FORMATS
112.Bl -tag -width Ds -compact
113.Ql Pa #
114is a commemt.
115
116.P
117.It Sy config file
118.Nm Adduser
119read and write this file.
120See /etc/adduser.conf for more details.
121.It Sy message file
122Eval variables in this file. See /etc/adduser.message for more
123details.
124.El
125
126.Sh FILES
127.Bl -tag -width /etc/master.passwdxx -compact
128.It Pa /etc/master.passwd
129user database
130.It Pa /etc/group
131group database
132.It Pa /etc/shells
133shell database
134.It Pa /etc/adduser.conf
135config file for adduser
136.It Pa /etc/adduser.message
137message file for adduser
138.It Pa /usr/share/skel
139skeletal login directory
140.It Pa /var/log/adduser
141logfile for adduser
142.El
143
144.Sh SEE ALSO
145.Xr chpass 1 ,
146.Xr finger 1 ,
147.Xr passwd 1 ,
148.Xr aliases 5 ,
149.Xr passwd 5 ,
150.Xr group 5 ,
151.Xr shells 5 ,
152.Xr pwd_mkdb 8 ,
153.Xr vipw 8
154
155.\" .Sh BUGS
156
157.Sh HISTORY
158The
159.Nm
160command appeared in FreeBSD 2.1
161
162.\" .Sh AUTHOR
163.\" Wolfram Schneider, Berlin
164