summaryrefslogtreecommitdiffstats
path: root/ipa-admintools/man/ipa-adduser.1
diff options
context:
space:
mode:
Diffstat (limited to 'ipa-admintools/man/ipa-adduser.1')
-rw-r--r--ipa-admintools/man/ipa-adduser.180
1 files changed, 80 insertions, 0 deletions
diff --git a/ipa-admintools/man/ipa-adduser.1 b/ipa-admintools/man/ipa-adduser.1
new file mode 100644
index 000000000..514455c3c
--- /dev/null
+++ b/ipa-admintools/man/ipa-adduser.1
@@ -0,0 +1,80 @@
+.\" A man page for ipa-adduser
+.\" Copyright (C) 2007 Red Hat, Inc.
+.\"
+.\" This is free software; you can redistribute it and/or modify it under
+.\" the terms of the GNU Library General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU Library General Public
+.\" License along with this program; if not, write to the Free Software
+.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+.\"
+.\" Author: Rob Crittenden <rcritten@redhat.com>
+.\"
+.TH "ipa-adduser" "1" "Oct 10 2007" "freeipa" ""
+.SH "NAME"
+ipa\-adduser \- Add a user
+
+.SH "SYNOPSIS"
+ipa\-adduser [\fIOPTION\fR]... \fIuser\fR
+
+.SH "DESCRIPTION"
+Adds a user with username \fIuser\fR.
+
+.SH "OPTIONS"
+.TP
+\fB\-c\fR, \fB\-\-gecos\fR=\fIgecos\fR
+Set the \f[SM]GECOS\fR field to \fIgecos\fR.
+The \f[SM]GECOS\fR field is traditionally used to store user's real name and other information.
+
+.TP
+\fB\-d\fR, \fB\-\-directory\fR=\fIdirectory\fR
+Set user's home directory to \fIdirectory\fR.
+If this option is not present, a default specified by the
+.B freeIPA configuration is used.
+
+.TP
+\fB\-f\fR, \fB\-\-firstname\fR=\fIgivenName\fR
+Set user's first name to \fIgivenName\fR.
+
+.TP
+\fB\-l\fR, \fB\-\-lastname\fR=\fIfamilyName\fR
+Set user's last name to \fIfamilyName\fR.
+
+.TP
+\fB\-p\fR, \fB\-\-password\fR=\fIpassword\fR
+Set user's password to \fIpassword\fR.
+
+.TP
+\fB\-s\fR, \fB\-\-shell\fR=\fIshell\fR
+Set the user's login shell to \fIshell\fR.
+If this option is not present, a default specified by the
+.B freeIPA configuration is used.
+
+.TP
+\fB\-G\fR, \fB\-\-groups\fR=\fIgroups\fR
+Add this user to one or more groups in \fIgroups\fR.
+\fIgroups\fR is a comma\-separated list of groups.
+Each \fIgroup\fR must already exist.
+
+.TP
+\fB\-k\fR, \fB\-\-krb\-principal\fR=\fIprincipal\fR
+Set this user's principal to \fIprincipal\fR.
+By default the principal is set to \fBuser\fR.
+
+.TP
+\fB\-M\fR, \fB\-\-mailAddress\fR=\fImail\fR
+Set this user's e\-mail address to \fImail\fR.
+
+.PP
+The mandatory fields are: user, first name, last name and password. If any of these are not included on the command line you will be asked interactively.
+
+If no options are passed then all questions are asked.
+.SH "EXIT STATUS"
+The exit status is 0 on success, nonzero on error.