doc: add samba-tool user rename command to samba-tool man page

Signed-off-by: Jule Anger <ja@sernet.de>
Reviewed-by: Björn Baumbach <bb@samba.org>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>

diff --git a/docs-xml/manpages/samba-tool.8.xml b/docs-xml/manpages/samba-tool.8.xml
index ef55d72e71424c5b369c2df63f2758bc94cc4497..9f58b98635a21e4473a42d09fc41ca535770dd6e 100644 (file)
--- a/docs-xml/manpages/samba-tool.8.xml
+++ b/docs-xml/manpages/samba-tool.8.xml
@@ -1232,6 +1232,87 @@
        authentication).</para>
 </refsect3>
 
+<refsect3>
+       <title>user rename <replaceable>username</replaceable> [options]</title>
+       <para>Rename a user and related attributes.</para>
+       <para>This command allows to set the user's name related attributes. The user's
+       CN will be renamed automatically.
+       The user's new CN will be made up by combining the given-name, initials
+       and surname. A dot ('.') will be appended to the initials automatically,
+       if required.
+       Use the --force-new-cn option to specify the new CN manually and --reset-cn
+       to reset this change.</para>
+       <para>Use an empty attribute value to remove the specified attribute.</para>
+       <para>The username specified on the command is the sAMAccountName.</para>
+
+       <variablelist>
+       <varlistentry>
+       <term>--surname=SURNAME</term>
+       <listitem><para>
+       New surname
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--given-name=GIVEN_NAME</term>
+       <listitem><para>
+       New given name
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--initials=INITIALS</term>
+       <listitem><para>
+       New initials
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--force-new-cn=NEW_CN</term>
+       <listitem><para>
+       Specify a new CN (RDN) instead of using a combination
+       of the given name, initials and surname.
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--reset-cn</term>
+       <listitem><para>
+       Set the CN to the default combination of given name,
+       initials and surname.
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--display-name=DISPLAY_NAME</term>
+       <listitem><para>
+       New display name
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--mail-address=MAIL_ADDRESS</term>
+       <listitem><para>
+       New email address
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--samaccountname=SAMACCOUNTNAME</term>
+       <listitem><para>
+       New account name (sAMAccountName/logon name)
+       </para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+       <term>--upn=UPN</term>
+       <listitem><para>
+       New user principal name
+       </para></listitem>
+       </varlistentry>
+       </variablelist>
+</refsect3>
+
 <refsect3>
        <title>user setexpiry <replaceable>username</replaceable> [options]</title>
        <para>Set the expiration of a user account.</para>