1
0
mirror of https://github.com/samba-team/samba.git synced 2025-01-08 21:18:16 +03:00
samba-mirror/docs/smbdotconf/misc/addsharecommand.xml
Jelmer Vernooij acee25664c Update DTD location
(This used to be commit 889dfcc532)
2008-04-23 08:46:19 -05:00

60 lines
2.0 KiB
XML

<samba:parameter name="add share command"
context="G"
type="string"
advanced="1" developer="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
<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>
</description>
<related>change share command</related>
<related>delete share command</related>
<value type="default"></value>
<value type="example">/usr/local/bin/addshare</value>
</samba:parameter>