1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-27 03:21:53 +03:00
samba-mirror/docs-xml/smbdotconf/misc/changesharecommand.xml
Karolin Seeger 8b7f66c548 docs: Improve description of the share commands in man smb.conf.
-Correct the parameter names.
-Fix typos.
-Fix related parameters.

This fixes bug #6008.
Thanks to TAKAHASHI Motonobu <monyo@samba.gr.jp> for reporting!

Karolin
2009-01-06 12:26:23 +01:00

75 lines
2.3 KiB
XML

<samba:parameter name="change 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">change share command</parameter> is used to define an external
program or script which will modify an existing service definition in <filename
moreinfo="none">smb.conf</filename>.
</para>
<para>
In order to successfully execute the
<parameter moreinfo="none">change share command</parameter>,
<command moreinfo="none">smbd</command> requires that the administrator
connects using a root account (i.e. uid == 0) or has the
<literal>SeDiskOperatorPrivilege</literal>.
Scripts defined in the <parameter moreinfo="none">change share command</parameter>
parameter are executed as root.
</para>
<para>
When executed, <command moreinfo="none">smbd</command> will automatically invoke the
<parameter moreinfo="none">change share command</parameter> with five 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>
<listitem>
<para><parameter moreinfo="none">max
connections</parameter>
Number of maximum simultaneous connections to this
share.
</para>
</listitem>
</itemizedlist>
<para>
This parameter is only used to modify existing file share definitions.
To modify printer shares, use the &quot;Printers...&quot; folder as seen
when browsing the Samba host.
</para>
</description>
<related>add share command</related>
<related>delete share command</related>
<value type="default"></value>
<value type="example">/usr/local/bin/changeshare</value>
</samba:parameter>