summaryrefslogtreecommitdiff
path: root/src/man/sss_userdel.8.xml
blob: 3bff8c89e02b515b97dd80fe157874e0d2311661 (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
<?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_userdel</refentrytitle>
        <manvolnum>8</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sss_userdel</refname>
        <refpurpose>delete a user account</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sss_userdel</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_userdel</command> deletes a user
            identified by login name <replaceable>LOGIN</replaceable>
            from the system.
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
            <varlistentry>
                <term>
                    <option>-r</option>,<option>--remove</option>
                </term>
                <listitem>
                    <para>
                        Files in the user's home directory will be
                        removed along with the home directory itself and
                        the user's mail spool. Overrides the configuration.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-R</option>,<option>--no-remove</option>
                </term>
                <listitem>
                    <para>
                        Files in the user's home directory will NOT be
                        removed along with the home directory itself and
                        the user's mail spool. Overrides the configuration.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-f</option>,<option>--force</option>
                </term>
                <listitem>
                    <para>
                        This option forces <command>sss_userdel</command>
                        to remove the user's home directory and mail spool,
                        even if they are not owned by the specified user.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-k</option>,<option>--kick</option>
                </term>
                <listitem>
                    <para>
                        Before actually deleting the user, terminate all
                        his processes.
                    </para>
                </listitem>
            </varlistentry>
        </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>