docs/smbdotconf/misc/addsharecommand.xml

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