From: Jule Anger <ja@sernet.de>
Date: Thu, 6 Aug 2020 13:40:43 +0000 (+0200)
Subject: doc: add samba-tool group rename command to samba-tool man page
X-Git-Tag: talloc-2.3.2~362
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3ff79e81fb83cf466063ed3e8ac986a58430dafe;p=thirdparty%2Fsamba.git

doc: add samba-tool group 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 9f58b98635a..e268519f7bb 100644
--- a/docs-xml/manpages/samba-tool.8.xml
+++ b/docs-xml/manpages/samba-tool.8.xml
@@ -872,6 +872,48 @@
 	<para>Show statistics for overall groups and group memberships.</para>
 </refsect3>
 
+<refsect3>
+	<title>group rename <replaceable>groupname</replaceable> [options]</title>
+	<para>Rename a group and related attributes.</para>
+	<para>This command allows to set the group's name related attributes. The
+	group's CN will be renamed automatically.
+	The group's CN will be the sAMAccountName.
+	Use the --force-new-cn option to specify the new CN manually and the
+	--reset-cn to reset this change.</para>
+	<para>Use an empty attribute value to remove the specified attribute.</para>
+	<para>The groupname specified on the command is the sAMAccountName.</para>
+
+	<variablelist>
+	<varlistentry>
+	<term>--force-new-cn=NEW_CN</term>
+	<listitem><para>
+	Specify a new CN (RDN) instead of using the sAMAccountName.
+	</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>--reset-cn</term>
+	<listitem><para>
+	Set the CN to the sAMAccountName.
+	</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>--mail-address=MAIL_ADDRESS</term>
+	<listitem><para>
+	New mail address
+	</para></listitem>
+	</varlistentry>
+
+	<varlistentry>
+	<term>--samaccountname=SAMACCOUNTNAME</term>
+	<listitem><para>
+	New account name (sAMAccountName/logon name)
+	</para></listitem>
+	</varlistentry>
+	</variablelist>
+</refsect3>
+
 <refsect2>
 	<title>ldapcmp <replaceable>URL1</replaceable> <replaceable>URL2</replaceable> <replaceable>domain|configuration|schema|dnsdomain|dnsforest</replaceable> [options] </title>
 	<para>Compare two LDAP databases.</para>