← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs-xml/smbdotconf/misc/deletesharecommand.xml

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs-xml/smbdotconf/misc/deletesharecommand.xml
 
1
<samba:parameter name="delete share command"
 
2
                 context="G"
 
3
                                 type="string"
 
4
                 advanced="1" developer="1"
 
5
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 
6
<description>
 
7
        <para>
 
8
        Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
 
9
        Manager.  The <parameter moreinfo="none">delete share command</parameter> is used to define an external
 
10
        program or script which will remove an existing service definition from
 
11
        <filename moreinfo="none">smb.conf</filename>.
 
12
        </para>
 
13
 
 
14
        <para>In order to successfully execute the
 
15
        <parameter moreinfo="none">delete share command</parameter>,
 
16
        <command moreinfo="none">smbd</command> requires that the administrator
 
17
        connects using a root account (i.e.  uid == 0) or has the
 
18
        <literal>SeDiskOperatorPrivilege</literal>.
 
19
        Scripts defined in the <parameter moreinfo="none">delete share command</parameter>
 
20
        parameter are executed as root.
 
21
        </para>
 
22
 
 
23
        <para>
 
24
        When executed, <command moreinfo="none">smbd</command> will automatically invoke the
 
25
        <parameter moreinfo="none">delete share command</parameter> with two parameters.
 
26
        </para>
 
27
 
 
28
        <itemizedlist>
 
29
                <listitem>
 
30
                        <para><parameter moreinfo="none">configFile</parameter> - the location
 
31
                        of the global <filename moreinfo="none">smb.conf</filename> file.
 
32
                        </para>
 
33
                </listitem>
 
34
 
 
35
                <listitem>
 
36
                        <para><parameter moreinfo="none">shareName</parameter> - the name of
 
37
                        the existing service.
 
38
                        </para>
 
39
                </listitem>
 
40
        </itemizedlist>
 
41
 
 
42
        <para>
 
43
        This parameter is only used to remove file shares.  To delete printer shares,
 
44
        see the <smbconfoption name="deleteprinter command"/>.
 
45
        </para>
 
46
</description>
 
47
 
 
48
<related>add share command</related>
 
49
<related>change share command</related>
 
50
<value type="default"></value>
 
51
<value type="example">/usr/local/bin/delshare</value>
 
52
</samba:parameter>