summaryrefslogtreecommitdiffstats
path: root/server/man/sss_useradd.8.xml
blob: 039c8487da23197429420d604a07dbfda154dc7f (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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />

    <refmeta>
        <refentrytitle>sss_useradd</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sss_useradd</refname>
        <refpurpose>create a new user</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sss_useradd</command>
            <arg choice='opt'>
                <replaceable>options</replaceable>
            </arg>
            <arg choice='plain'><replaceable>LOGIN</replaceable></arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            <command>sss_useradd</command> creates a new user account using
            the values specified on the command line plus the default values from
            the system.
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>-u</option>,<option>--uid</option>
                    <replaceable>UID</replaceable>
                </term>
                <listitem>
                    <para>
                        Set the UID of the user to the value of <replaceable>UID</replaceable>.
                        If not given, it is chosen automatically.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-g</option>,<option>--gid</option>
                    <replaceable>GID</replaceable>
                </term>
                <listitem>
                    <para>
                        Set the GID or group membership of the user to the value
                        of <replaceable>GID</replaceable>. If not given, it is
                        chosen automatically.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-c</option>,<option>--gecos</option>
                    <replaceable>COMMENT</replaceable>
                </term>
                <listitem>
                    <para>
                        Any text string describing the user. Often used as
                        the field for the user's full name.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-h</option>,<option>--home</option>
                    <replaceable>HOME_DIR</replaceable>
                </term>
                <listitem>
                    <para>
                        The home directory of the user account.
                        The default is to append the <replaceable>LOGIN</replaceable> name
                        to <filename>/home</filename> and use that as the home directory.
                        The base that is prepended before <replaceable>LOGIN</replaceable> is tunable
                        with <quote>user_defaults/baseDirectory</quote> setting in sssd.conf.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-s</option>,<option>--shell</option>
                    <replaceable>SHELL</replaceable>
                </term>
                <listitem>
                    <para>
                        The user's login shell. The default is currently <filename>/bin/bash</filename>.
                        The default can be changed with
                        <quote>user_defaults/defaultShell</quote> setting
                        in sssd.conf.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-G</option>,<option>--groups</option>
                    <replaceable>GROUPS</replaceable>
                </term>
                <listitem>
                    <para>
                        A list of existing groups this user is also a member of.
                    </para>
                </listitem>
            </varlistentry>
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
        </variablelist>
    </refsect1>

    <refsect1 id='see_also'>
        <title>SEE ALSO</title>
        <para>
            <citerefentry>
                <refentrytitle>sss_groupadd</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_groupdel</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_groupmod</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_userdel</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sss_usermod</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>.
        </para>
    </refsect1>
</refentry>
</reference>