summaryrefslogtreecommitdiffstats
path: root/src/man/sss_usermod.8.xml
blob: b9fef823736f88db77b48630c5fc2cfc6ff6635c (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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/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_usermod</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sss_usermod</refname>
        <refpurpose>modify a user account</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sss_usermod</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_usermod</command> modifies the
            account specified by <replaceable>LOGIN</replaceable>
            to reflect the changes that are specified on the command line.
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <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.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-s</option>,<option>--shell</option>
                    <replaceable>SHELL</replaceable>
                </term>
                <listitem>
                    <para>
                        The user's login shell.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-a</option>,<option>--append-group</option>
                    <replaceable>GROUPS</replaceable>
                </term>
                <listitem>
                    <para>
                        Append this user to groups specified by the
                        <replaceable>GROUPS</replaceable> parameter.
                        The <replaceable>GROUPS</replaceable> parameter
                        is a comma separated list of group names.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-r</option>,<option>--remove-group</option>
                    <replaceable>GROUPS</replaceable>
                </term>
                <listitem>
                    <para>
                        Remove this user from groups specified by the
                        <replaceable>GROUPS</replaceable> parameter.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-l</option>,<option>--lock</option>
                </term>
                <listitem>
                    <para>
                        Lock the user account. The user won't be able
                        to log in.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-u</option>,<option>--unlock</option>
                </term>
                <listitem>
                    <para>
                        Unlock the user account.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-Z</option>,<option>--selinux-user</option>
                    <replaceable>SELINUX_USER</replaceable>
                </term>
                <listitem>
                    <para>
                        The SELinux user for the user's login.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--addattr</option>
                    <replaceable>ATTR_NAME_VAL</replaceable>
                </term>
                <listitem>
                    <para>
                        Add an attribute/value pair. The format is
                        attrname=value.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--setattr</option>
                    <replaceable>ATTR_NAME_VAL</replaceable>
                </term>
                <listitem>
                    <para>
                        Set an attribute to a name/value pair. The format
                        is attrname=value. For multi-valued attributes,
                        the command replaces the values already present
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>--delattr</option>
                    <replaceable>ATTR_NAME_VAL</replaceable>
                </term>
                <listitem>
                    <para>
                        Delete an attribute/value pair. The format is attrname=value.
                    </para>
                </listitem>
            </varlistentry>
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
        </variablelist>
    </refsect1>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/local.xml" />

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />

</refentry>
</reference>