~ubuntu-branches/ubuntu/utopic/libuser/utopic-proposed

« back to all changes in this revision

Viewing changes to apps/luseradd.1

  • Committer: Bazaar Package Importer
  • Author(s): Ghe Rivero
  • Date: 2005-09-30 16:22:04 UTC
  • Revision ID: james.westby@ubuntu.com-20050930162204-qubxaa7e2lbovdgh
Tags: upstream-0.54.dfsg.1
ImportĀ upstreamĀ versionĀ 0.54.dfsg.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" A man page for luseradd
 
2
.\" Copyright (C) 2005 Red Hat, Inc.
 
3
.\"
 
4
.\" This is free software; you can redistribute it and/or modify it under
 
5
.\" the terms of the GNU Library General Public License as published by
 
6
.\" the Free Software Foundation; either version 2 of the License, or
 
7
.\" (at your option) any later version.
 
8
.\"
 
9
.\" This program is distributed in the hope that it will be useful, but
 
10
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
12
.\" General Public License for more details.
 
13
.\"
 
14
.\" You should have received a copy of the GNU Library General Public
 
15
.\" License along with this program; if not, write to the Free Software
 
16
.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
17
.\"
 
18
.\" Author: Miloslav Trmac <mitr@redhat.com>
 
19
.TH luseradd 1 "Jan 12 2005" libuser
 
20
 
 
21
.SH NAME
 
22
luser \- Add an user
 
23
 
 
24
.SH SYNOPSIS
 
25
luseradd [\fIOPTION\fR]... \fIuser\fR
 
26
 
 
27
.SH DESCRIPTION
 
28
Adds an user with name \fIuser\fR.
 
29
 
 
30
.SH OPTIONS
 
31
.TP
 
32
\fB\-c\fR, \fB\-\-gecos\fR=\fIgecos\fR
 
33
Set the \f[SM]GECOS\fR field to \fIgecos\fR.
 
34
The \f[SM]GECOS\fR field is traditionally used to store user's real name
 
35
and other information.
 
36
 
 
37
.TP
 
38
\fB\-d\fR, \fB\-\-directory\fR=\fIdirectory\fR
 
39
Set user's home directory to \fIdirectory\fR.
 
40
If this option is not present,
 
41
a default specified by
 
42
.B libuser
 
43
configuration is used.
 
44
 
 
45
.TP
 
46
\fB\-g\fR, \fB\-\-gid\fR=\fIgroup\fR
 
47
Set user's primary group to \fIgroup\fR.
 
48
\fIgroup\fR can either be a group ID of an existing group, or a group name;
 
49
if \fIgroup\fR is a group name and the group does not exist,
 
50
it is created.
 
51
If the \fB\-\-gid\fR option is not specified,
 
52
the default group name is \fIuser\fR.
 
53
 
 
54
.TP
 
55
\fB\-i\fR, \fB\-\-interactive\fR 
 
56
Ask all questions when connecting to the user database,
 
57
even if default answers are set up in
 
58
.B libuser
 
59
configuration.
 
60
 
 
61
.TP
 
62
\fB\-k\fR, \fB\-\-skeleton\fR=\fIdirectory\fR
 
63
Populate the newly created user's home directory with a copy of
 
64
\fIdirectory\fR.
 
65
If this option is not present,
 
66
a default directory specified by 
 
67
.B libuser
 
68
configuration,
 
69
or \fB/etc/skel\fR if
 
70
.B libuser
 
71
configuration does not specify a default,
 
72
is used.
 
73
 
 
74
.TP
 
75
\fB\-M\fR, \fB\-\-nocreatehome\fR
 
76
Don't create a home directory and a mail spool for the newly created user.
 
77
 
 
78
.TP
 
79
\fB\-n\fR, \fB\-\-nocreategroup\fR
 
80
If a group is not specified using \fB\-g\fR,
 
81
use group name "users" instead of \fIuser\fR.
 
82
Note that despite the name of the option,
 
83
the group will still be created if it does not exist.
 
84
 
 
85
.TP
 
86
\fB\-P\fR, \fB\-\-plainpassword\fR=\fIpassword\fR
 
87
Set \fIuser\fR's password to \fIpassword\fR.
 
88
Note that the password can be viewed while running
 
89
.BR luseradd
 
90
using tools such as
 
91
.BR ps (1)\fR.
 
92
 
 
93
.TP
 
94
\fB\-p\fR, \fB\-\-password\fR=\fIencrypted\fR
 
95
Set \fIuser\fR's password to the password represented by the hash
 
96
\fIencrypted\fR.
 
97
Note that the hash can be viewed while running
 
98
.BR luseradd
 
99
using tools such as
 
100
.BR ps (1)\fR.
 
101
 
 
102
.TP
 
103
\fB\-r\fR, \fB\-\-reserved\fR
 
104
The user is a system user.
 
105
Users that are not marked as system user
 
106
usually have automatically selected user IDs above a certain value
 
107
(500 by default).
 
108
This information is also passed to the
 
109
.B libuser
 
110
backends.
 
111
This option implies the \fB\-M\fR option.
 
112
 
 
113
.TP
 
114
\fB\-s\fR, \fB\-\-shell\fR=\fIshell\fR
 
115
Set user's login shell to \fIshell\fR.
 
116
If this option is not present,
 
117
a default specified by
 
118
.B libuser
 
119
configuration is used.
 
120
 
 
121
.TP
 
122
\fB\-u\fR, \fB\-\-uid\fR=\fIuid\fR
 
123
Use user ID \fIuid\fR for the newly created user.
 
124
An user ID is selected automatically if this option is not present.
 
125
 
 
126
.SH EXIT STATUS
 
127
The exit status is 0 on success, nonzero on error.