summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/misc/changesharecommand.xml
blob: 3fb494c51318e2d5a4ae792264fa509d1661a1c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<samba:parameter xmlns:samba="http://samba.org/common">
		<term><anchor id="CHANGESHARECOMMAND"/>change share command (G)</term>
		<listitem><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>.  In order to successfully 
		execute the <parameter moreinfo="none">change 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">change 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 modify existing file shares definitions.  To modify 
		printer shares, use the &quot;Printers...&quot; folder as seen when browsing the Samba host.
		</para>
		
		<para>
		See also <link linkend="ADDSHARECOMMAND"><parameter moreinfo="none">add share
		command</parameter></link>, <link linkend="DELETESHARECOMMAND"><parameter moreinfo="none">delete 
		share command</parameter></link>.
		</para>
		
		<para>Default: <emphasis>none</emphasis></para>
		<para>Example: <command moreinfo="none">change share command = /usr/local/bin/addshare</command></para>
		</listitem>
		</samba:parameter>