summaryrefslogtreecommitdiffstats
path: root/src/man/nl/include/override_homedir.xml
blob: 68a1c5ec7af5855af1d6e03353f2fa8f6acc8964 (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
<varlistentry>
<term>override_homedir (string)</term>
<listitem>
    <para>
        Override the user's home directory. You can either provide an absolute value
or a template. In the template, the following sequences are substituted:
<variablelist>
            <varlistentry>
                <term>%u</term>
                <listitem><para>login name</para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%U</term>
                <listitem><para>UID number</para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%d</term>
                <listitem><para>domain name</para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%f</term>
                <listitem><para>fully qualified user name (user@domain)</para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%l</term>
                <listitem><para>The first letter of the login name.</para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%P</term>
                <listitem><para>UPN - User Principal Name (name@REALM)</para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%o</term>
                <listitem><para>
                    The original home directory retrieved from the identity provider.
                    </para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%h</term>
                <listitem><para>
                    The original home directory retrieved from the identity provider, but in
lower case.
                    </para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%H</term>
                <listitem><para>
                    The value of configure option <emphasis>homedir_substring</emphasis>.
                    </para></listitem>
            </varlistentry>
            <varlistentry>
                <term>%%</term>
                <listitem><para>a literal '%'</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </para>
    <para>
        This option can also be set per-domain.
    </para>
    <para>
        example: <programlisting>
override_homedir = /home/%u
        </programlisting>
    </para>
    <para>
        Default: Not set (SSSD will use the value retrieved from LDAP)
    </para>
    <para>
        Please note, the home directory from a specific override for the user,
either locally (see
<citerefentry><refentrytitle>sss_override</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>) or centrally managed IPA
id-overrides, has a higher precedence and will be used instead of the value
given by override_homedir.
    </para>
</listitem>
</varlistentry>