1 files changed, 54 insertions, 0 deletions
diff --git a/src/man/include/override_homedir.xml b/src/man/include/override_homedir.xml
new file mode 100644
index 00000000..773d0b66
--- /dev/null
+++ b/src/man/include/override_homedir.xml
@@ -0,0 +1,54 @@
+<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>%o</term>
+                <listitem><para>
+                    The original home directory retrieved
+                    from the identity provider.
+                    </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>
+</listitem>
+</varlistentry>