summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/misc/addsharecommand.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/smbdotconf/misc/addsharecommand.xml')
-rw-r--r--docs/docbook/smbdotconf/misc/addsharecommand.xml63
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/misc/addsharecommand.xml b/docs/docbook/smbdotconf/misc/addsharecommand.xml
new file mode 100644
index 0000000000..bd5f2101db
--- /dev/null
+++ b/docs/docbook/smbdotconf/misc/addsharecommand.xml
@@ -0,0 +1,63 @@
+<samba:parameter name="add share command"
+ context="G"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<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">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).
+ </para>
+
+ <para>
+ When executed, <command moreinfo="none">smbd</command> will automatically invoke the
+ <parameter moreinfo="none">add share command</parameter> with four 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 new
+ share.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
+ directory on disk.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para><parameter moreinfo="none">comment</parameter> - comment string to associate
+ with the new share.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ This parameter is only used for add file shares. To add printer shares,
+ see the <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter
+ command</parameter></link>.
+ </para>
+
+ <para>
+ See also <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change share
+ command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete share
+ command</parameter></link>.
+ </para>
+
+ <para>Default: <emphasis>none</emphasis></para>
+
+ <para>Example: <command moreinfo="none">add share command = /usr/local/bin/addshare</command></para>
+</listitem>
+</samba:parameter>