docs/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://samba.org/common">
   6 <description>
   7         <para>Samba 2.2.0 introduced the ability to dynamically
   8         add and delete shares via the Windows NT 4.0 Server Manager.  The
   9         <parameter moreinfo="none">delete share command</parameter> is used to define an
  10         external program or script which will remove an existing service
  11         definition from <filename moreinfo="none">smb.conf</filename>.  In order to successfully
  12         execute the <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command>
  13         requires that the administrator be connected using a root account (i.e.
  14         uid == 0).
  15         </para>
  16
  17         <para>
  18         When executed, <command moreinfo="none">smbd</command> will automatically invoke the
  19         <parameter moreinfo="none">delete share command</parameter> with two parameters.
  20         </para>
  21
  22         <itemizedlist>
  23                 <listitem>
  24                         <para><parameter moreinfo="none">configFile</parameter> - the location
  25                         of the global <filename moreinfo="none">smb.conf</filename> file.
  26                         </para>
  27                 </listitem>
  28
  29                 <listitem>
  30                         <para><parameter moreinfo="none">shareName</parameter> - the name of
  31                         the existing service.
  32                         </para>
  33                 </listitem>
  34         </itemizedlist>
  35
  36         <para>
  37         This parameter is only used to remove file shares.  To delete printer shares,
  38         see the <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none">deleteprinter
  39         command</parameter></link>.
  40         </para>
  41 </description>
  42
  43 <related>add share command</related>
  44 <related>delete share command</related>
  45 <value type="default"></value>
  46 <value type="example">/usr/local/bin/delshare</value>
  47 </samba:parameter>