docs/docbook/smbdotconf/misc/addsharecommand.xml

   1 <samba:parameter xmlns:samba="http://samba.org/common">
   2                 <term><anchor id="ADDSHARECOMMAND"/>add 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">add share command</parameter> is used to define an
   6                 external program or script which will add a new service definition
   7                 to <filename moreinfo="none">smb.conf</filename>.  In order to successfully
   8                 execute the <parameter moreinfo="none">add 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">add share command</parameter> with four 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 the new
  24                         share.
  25                         </para></listitem>
  26
  27                         <listitem><para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
  28                         directory on disk.
  29                         </para></listitem>
  30
  31                         <listitem><para><parameter moreinfo="none">comment</parameter> - comment string to associate
  32                         with the new share.
  33                         </para></listitem>
  34                 </itemizedlist>
  35
  36                 <para>
  37                 This parameter is only used for add file shares.  To add printer shares,
  38                 see the <link linkend="ADDPRINTERCOMMAND"><parameter moreinfo="none">addprinter
  39                 command</parameter></link>.
  40                 </para>
  41
  42                 <para>
  43                 See also <link linkend="CHANGESHARECOMMAND"><parameter moreinfo="none">change share
  44                 command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete share
  45                 command</parameter></link>.
  46                 </para>
  47
  48                 <para>Default: <emphasis>none</emphasis></para>
  49                 <para>Example: <command moreinfo="none">add share command = /usr/local/bin/addshare</command></para>
  50                 </listitem>
  51                 </samba:parameter>