docs/docbook/smbdotconf/misc/deletesharecommand.xml

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