summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/misc/deletesharecommand.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/smbdotconf/misc/deletesharecommand.xml')
-rw-r--r--docs/docbook/smbdotconf/misc/deletesharecommand.xml44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/misc/deletesharecommand.xml b/docs/docbook/smbdotconf/misc/deletesharecommand.xml
new file mode 100644
index 0000000000..c3481c86ec
--- /dev/null
+++ b/docs/docbook/smbdotconf/misc/deletesharecommand.xml
@@ -0,0 +1,44 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+ <term><anchor id="DELETESHARECOMMAND"/>delete share command (G)</term>
+ <listitem><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">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).
+ </para>
+
+ <para>
+ When executed, <command moreinfo="none">smbd</command> will automatically invoke the
+ <parameter moreinfo="none">delete share command</parameter> with two parameters.
+ </para>
+
+ <itemizedlist>
+ <listitem><para><parameter moreinfo="none">configFile</parameter> - the location
+ of the global <filename moreinfo="none">smb.conf</filename> file.
+ </para></listitem>
+
+ <listitem><para><parameter moreinfo="none">shareName</parameter> - the name of
+ the existing service.
+ </para></listitem>
+ </itemizedlist>
+
+ <para>
+ This parameter is only used to remove file shares. To delete printer shares,
+ see the <link linkend="DELETEPRINTERCOMMAND"><parameter moreinfo="none">deleteprinter
+ command</parameter></link>.
+ </para>
+
+ <para>
+ See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share
+ command</parameter></link>, <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change
+ share command</parameter></link>.
+ </para>
+
+ <para>Default: <emphasis>none</emphasis></para>
+ <para>Example: <command moreinfo="none">delete share command = /usr/local/bin/delshare</command></para>
+
+ </listitem>
+ </samba:parameter>