docs: Improve description of the share commands in man smb.conf.

-Correct the parameter names.
-Fix typos.
-Fix related parameters.

This fixes bug #6008.
Thanks to TAKAHASHI Motonobu <monyo@samba.gr.jp> for reporting!

Karolin
(cherry picked from commit 8b7f66c548ed170d2dab0c91ccff4aca00f4b52d)
(cherry picked from commit 6f38786aa878bd1a7fc10069773c19b28437fbbb)
(cherry picked from commit f420b5c2af7d46e88269d9ec89c5dcd37f1f8f46)

diff --git a/docs-xml/smbdotconf/misc/addsharecommand.xml b/docs-xml/smbdotconf/misc/addsharecommand.xml
index 9eb50f3dc3b6a6d6de3ca342db2c7725ed7b7add..de8da7b5cad074d53b0909a0b079196d8bbaee62 100644 (file)
--- a/docs-xml/smbdotconf/misc/addsharecommand.xml
+++ b/docs-xml/smbdotconf/misc/addsharecommand.xml
@@ -7,15 +7,19 @@
        <para>
        Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
        Manager.  The <parameter moreinfo="none">add share command</parameter> is used to define an external program
-       or script which will add a new service definition to <filename moreinfo="none">smb.conf</filename>.  In order
-       to successfully execute the <parameter moreinfo="none">add share command</parameter>, <command
-       moreinfo="none">smbd</command> requires that the administrator be connected using a root account (i.e.  uid == 0).
+       or script which will add a new service definition to
+       <filename moreinfo="none">smb.conf</filename>.
        </para>
 
-    <para>
-    If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in
-    <parameter moreinfo="none">change share</parameter> parameter are executed as root.
-    </para>
+       <para>
+       In order to successfully execute the
+       <parameter moreinfo="none">add share command</parameter>,
+       <command moreinfo="none">smbd</command> requires that the administrator
+       connects using a root account (i.e.  uid == 0) or has the
+       <literal>SeDiskOperatorPrivilege</literal>.
+       Scripts defined in the <parameter moreinfo="none">add share command</parameter>
+       parameter are executed as root.
+       </para>
 
        <para>
        When executed, <command moreinfo="none">smbd</command> will automatically invoke the
@@ -56,7 +60,7 @@
        </itemizedlist>
 
        <para>
-       This parameter is only used for add file shares.  To add printer shares, see the <smbconfoption
+       This parameter is only used to add file shares. To add printer shares, see the <smbconfoption
        name="addprinter command"/>.
        </para>
 </description>

diff --git a/docs-xml/smbdotconf/misc/changesharecommand.xml b/docs-xml/smbdotconf/misc/changesharecommand.xml
index 5a42e225594436ddd0f059d9ecb9d11d5bf1c3f5..2033fcf46cdfd88aa90576fafdf4f38852568bca 100644 (file)
--- a/docs-xml/smbdotconf/misc/changesharecommand.xml
+++ b/docs-xml/smbdotconf/misc/changesharecommand.xml
@@ -8,14 +8,17 @@
        Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
 Manager.  The <parameter moreinfo="none">change share command</parameter> is used to define an external
 program or script which will modify an existing service definition in <filename
-moreinfo="none">smb.conf</filename>.  In order to successfully execute the <parameter moreinfo="none">change
-share command</parameter>, <command moreinfo="none">smbd</command> requires that the administrator be
-connected using a root account (i.e. uid == 0).
+moreinfo="none">smb.conf</filename>.
        </para>
 
        <para>
-       If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in
-       <parameter moreinfo="none">change share</parameter> parameter are executed as root.
+       In order to successfully execute the
+       <parameter moreinfo="none">change share command</parameter>,
+       <command moreinfo="none">smbd</command> requires that the administrator
+       connects using a root account (i.e. uid == 0) or has the
+       <literal>SeDiskOperatorPrivilege</literal>.
+       Scripts defined in the <parameter moreinfo="none">change share command</parameter>
+       parameter are executed as root.
        </para>
 
        <para>
@@ -58,13 +61,14 @@ connected using a root account (i.e. uid == 0).
        </itemizedlist>
 
        <para>
-       This parameter is only used modify existing file shares definitions.  To modify
-       printer shares, use the &quot;Printers...&quot; folder as seen when browsing the Samba host.
+       This parameter is only used to modify existing file share definitions.
+       To modify printer shares, use the &quot;Printers...&quot; folder as seen
+       when browsing the Samba host.
        </para>
 </description>
 
 <related>add share command</related>
 <related>delete share command</related>
 <value type="default"></value>
-<value type="example">/usr/local/bin/addshare</value>
+<value type="example">/usr/local/bin/changeshare</value>
 </samba:parameter>

diff --git a/docs-xml/smbdotconf/misc/deletesharecommand.xml b/docs-xml/smbdotconf/misc/deletesharecommand.xml
index 40eb6495dbf23e32b5a9be7053b6ded3f3adfed4..3def6b8013ddbd89d7ff58aa4642cefacab776df 100644 (file)
--- a/docs-xml/smbdotconf/misc/deletesharecommand.xml
+++ b/docs-xml/smbdotconf/misc/deletesharecommand.xml
@@ -8,15 +8,17 @@
        Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
        Manager.  The <parameter moreinfo="none">delete share command</parameter> is used to define an external
        program or script which will remove an existing service definition from
-       <filename moreinfo="none">smb.conf</filename>.  In order to successfully execute the
-       <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command>
-       requires that the administrator be connected using a root account (i.e.  uid == 0).
+       <filename moreinfo="none">smb.conf</filename>.
        </para>
 
-    <para>
-    If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in
-    <parameter moreinfo="none">change share</parameter> parameter are executed as root.
-    </para>
+       <para>In order to successfully execute the
+       <parameter moreinfo="none">delete share command</parameter>,
+       <command moreinfo="none">smbd</command> requires that the administrator
+       connects using a root account (i.e.  uid == 0) or has the
+       <literal>SeDiskOperatorPrivilege</literal>.
+       Scripts defined in the <parameter moreinfo="none">delete share command</parameter>
+       parameter are executed as root.
+       </para>
 
        <para>
        When executed, <command moreinfo="none">smbd</command> will automatically invoke the
@@ -44,7 +46,7 @@
 </description>
 
 <related>add share command</related>
-<related>delete share command</related>
+<related>change share command</related>
 <value type="default"></value>
 <value type="example">/usr/local/bin/delshare</value>
 </samba:parameter>