docs/docbook/smbdotconf/misc/addsharecommand.xml

   1 <samba:parameter name="add share command"
   2                  context="G"
   3                  advanced="1" developer="1"
   4                  xmlns:samba="http://samba.org/common">
   5 <listitem>
   6         <para>Samba 2.2.0 introduced the ability to dynamically
   7         add and delete shares via the Windows NT 4.0 Server Manager.  The
   8         <parameter moreinfo="none">add share command</parameter> is used to define an
   9         external program or script which will add a new service definition
  10         to <filename moreinfo="none">smb.conf</filename>.  In order to successfully
  11         execute the <parameter moreinfo="none">add share command</parameter>, <command moreinfo="none">smbd</command>
  12         requires that the administrator be connected using a root account (i.e.
  13         uid == 0).
  14         </para>
  15
  16         <para>
  17         When executed, <command moreinfo="none">smbd</command> will automatically invoke the
  18         <parameter moreinfo="none">add share command</parameter> with four parameters.
  19         </para>
  20
  21         <itemizedlist>
  22                 <listitem>
  23                         <para><parameter moreinfo="none">configFile</parameter> - the location
  24                         of the global <filename moreinfo="none">smb.conf</filename> file.
  25                         </para>
  26                 </listitem>
  27
  28                 <listitem>
  29                         <para><parameter moreinfo="none">shareName</parameter> - the name of the new
  30                         share.
  31                         </para>
  32                 </listitem>
  33
  34                 <listitem>
  35                         <para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
  36                         directory on disk.
  37                         </para>
  38                 </listitem>
  39
  40                 <listitem>
  41                         <para><parameter moreinfo="none">comment</parameter> - comment string to associate
  42                         with the new share.
  43                         </para>
  44                 </listitem>
  45         </itemizedlist>
  46
  47         <para>
  48         This parameter is only used for add file shares.  To add printer shares,
  49         see the <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter
  50         command</parameter></link>.
  51         </para>
  52
  53         <para>
  54         See also <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change share
  55         command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete share
  56         command</parameter></link>.
  57         </para>
  58
  59         <para>Default: <emphasis>none</emphasis></para>
  60
  61         <para>Example: <command moreinfo="none">add share command = /usr/local/bin/addshare</command></para>
  62 </listitem>
  63 </samba:parameter>